File Coverage

blib/lib/Date/ManipX/Almanac/Lang/english.pm

Criterion	Covered	Total	%
statement	23	23	100.0
branch			n/a
condition			n/a
subroutine	9	9	100.0
pod			n/a
total	32	32	100.0

package Date::ManipX::Almanac::Lang::english;

use 5.010;

use strict;
use warnings;

use parent qw{ Date::ManipX::Almanac::Lang };

use Carp;

our $VERSION = '0.003';

our $LangName = 'English';

# See the Date::ManipX::Almanac::Lang POD for __body_data
sub __body_data {
    my ( $self ) = @_;
    my @season = $self->__season_to_detail();
    return [
	[ 'Astro::Coord::ECI::Sun'	=>
	    qr/ (?: (?: when | at ) \s* )? (?: the \s* )? sun /smxi,
	    qr/ (?: at \s* )? (?: the \s* )? (?:
		(? beginn? | end ) (?: ing )? (?: \s* of )? \s*
		    (? astronomical | civil | nautical )? \s*
		    (? twilight ) |
		(? astronomical | civil | nautical )? \s*
		    (? twilight ) \s* (? begin | end ) s? |
		(? morning | evening ) \s*
		    (? astronomical | civil | nautical )? \s*
		    (? twilight ) |
		(? local ) \s* (? noon | midnight ) |
		(? spring | vernal | march | september ) \s*
		    (? equinox ) |
		(? autumn ) (?: al )? \s* (? equinox ) |
		(? summer | winter | june | december ) \s*
		    (? solstice )
	    ) /smxi,
	    {	# Iterpret (? ... )
		#
		# The required data are described in the
		# Date::ManipX::Almanac::Lang POD, under __body_re().
		#
		equinox		=> [ quarter => {
			autumn		=> $season[ 2 ],
			march		=> 0,
			september	=> 2,
			spring		=> $season[ 0 ],
			vernal		=> $season[ 0 ],
		    },
		],
		solstice	=> [ quarter => {
			december	=> 3,
			june		=> 1,
			summer		=> $season[ 1 ],
			winter		=> $season[ 3 ],
		    },
		],
		local		=> [ meridian => {
			noon		=> 1,
			midnight	=> 0,
		    },
		],
		twilight	=> [ twilight => {
			begin	=> 1,
			beginn	=> 1,
			end	=> 0,
			evening	=> 0,
			morning	=> 1,
		    },
		    {
			astronomical	=> 'astronomical',
			civil		=> 'civil',
			nautical	=> 'nautical',
		    },
		],
	    },
	],
	[ 'Astro::Coord::ECI::Moon'	=>
	    qr/ (?: (?: when | at ) \s* )? (?: the \s* )? moon /smxi,
	    qr/ (?: at \s* )? (?: the \s* )? (?:
		(? first | last ) \s* \s* quarter (?: \s* moon )? |
		(? full | new ) (?: \s* moon )?
	    ) /smxi,
	    {	# Iterpret (? ... )
		#
		# The required data are described in the
		# Date::ManipX::Almanac::Lang POD, under __body_re().
		#
		new	=> [ quarter	=> 0 ],
		first	=> [ quarter	=> 1 ],
		full	=> [ quarter	=> 2 ],
		last	=> [ quarter	=> 3 ],
	    }
	],
	# A map {} makes sense in English, but not in any other
	# language.
	# NOTE we don't need the Sun here, because ::VSOP87D::Sun is a
	# subclass of ::Sun.
	[ 'Astro::Coord::ECI::VSOP87D::Mercury'	=>
	    qr/ (?: when \s* )? mercury /smxi ],
	[ 'Astro::Coord::ECI::VSOP87D::Venus'	=>
	    qr/ (?: when \s* )? venus /smxi ],
	[ 'Astro::Coord::ECI::VSOP87D::Mars'	=>
	    qr/ (?: when \s* )? mars /smxi ],
	[ 'Astro::Coord::ECI::VSOP87D::Jupiter'	=>
	    qr/ (?: when \s* )? jupiter /smxi ],
	[ 'Astro::Coord::ECI::VSOP87D::Saturn'	=>
	    qr/ (?: when \s* )? saturn /smxi ],
	[ 'Astro::Coord::ECI::VSOP87D::Uranus'	=>
	    qr/ (?: when \s* )? uranus /smxi ],
	[ 'Astro::Coord::ECI::VSOP87D::Neptune'	=>
	    qr/ (?: when \s* )? neptune /smxi ],
    ];
}

# See the Date::ManipX::Almanac::Lang POD for __general_event_re
#
# Return a regular expression that matches any event that must be paired
# with the name of a body. The internal name of the event must be
# captured by named capture (? ... )
sub __general_event_re {
    return qr/
	(?: the \s* )? (? culminat ) (?: es? | ion ) (?: \s* of )? |
	(?: is \s* )? (?: the \s* )? (? highest ) |
	(? rise | set ) s? |
	(?: the \s* )? (? rising ) (?: \s* of )? |
	(?: the \s* )? (? setting ) (?: \s* of )? |
	(?: is \s* )? (? up | down )
    /smxi;
}

# See the Date::ManipX::Almanac::Lang POD for __general_event_interp
#
# The interpretation of the events captured in (? ... ) above.
sub __general_event_interp {
    state $rise		= [ horizon	=> 1 ];
    state $set		= [ horizon	=> 0 ];
    state $highest	= [ meridian	=> 1 ];
    return [
	{
	    culminat	=> $highest,
	    down	=> $set,
	    highest	=> $highest,
	    rise	=> $rise,
	    rising	=> $rise,
	    set		=> $set,
	    setting	=> $set,
	    up		=> $rise,
	},
    ];
}

sub __ignore_after_re {
    return qr< \s* (?: (?: on | at ) \s+ or \s+ )? after >smxi;
}

1;

__END__