Move messages to Travel::Routing::DE::EFA::Route::Message objects (b32bf2d4) · Commits · derf / Travel-Routing-DE-EFA

bin/efa

+7 −6

Original line number	Diff line number	Diff line
		@@ -145,18 +145,19 @@ sub display_connection {
		$c->delay, $c->departure_stime, $c->arrival_stime );
		}

		for my $extra ( $c->regular_notes ) {
		if ( not( length $ignore_info and $extra =~ /$ignore_info/i ) ) {
		say "# $extra";
		for my $note ( $c->regular_notes ) {
		my $text = $note->summary;
		if ( not( length $ignore_info and $text =~ /$ignore_info/i ) ) {
		say "# $text";
		}
		}

		for my $notice ( $c->current_notes ) {
		if ( $notice->{subtitle} ne $notice->{subject} ) {
		printf( "# %s - %s\n", $notice->{subtitle}, $notice->{subject} );
		if ( $notice->subtitle ne $notice->subject ) {
		printf( "# %s - %s\n", $notice->subtitle, $notice->subject );
		}
		else {
		printf( "# %s\n", $notice->{subtitle} );
		printf( "# %s\n", $notice->subtitle );
		}
		}

lib/Travel/Routing/DE/EFA.pm

+21 −10

Original line number	Diff line number	Diff line
		@@ -9,6 +9,7 @@ no if $] >= 5.018, warnings => "experimental::smartmatch";
		use Carp qw(cluck);
		use Encode qw(decode encode);
		use Travel::Routing::DE::EFA::Route;
		use Travel::Routing::DE::EFA::Route::Message;
		use LWP::UserAgent;
		use XML::LibXML;

		@@ -510,16 +511,26 @@ sub parse_cur_info {
		my $e_subtitle = ( $node->findnodes($xp_subtitle) )[0];
		my $e_content = ( $node->findnodes($xp_content) )[0];

		my $ret = {
		my %msg = (
		summary => $e_text->textContent,
		subject => $e_subject->textContent,
		subtitle => $e_subtitle->textContent,
		content => $e_content->textContent,
		};
		for my $key ( keys %{$ret} ) {
		$ret->{$key} = decode( 'UTF-8', $ret->{$key} );
		raw_content => $e_content->textContent,
		);
		for my $key ( keys %msg ) {
		$msg{$key} = decode( 'UTF-8', $msg{$key} );
		}
		return $ret;
		return Travel::Routing::DE::EFA::Route::Message->new(%msg);
		}

		sub parse_reg_info {
		my ( $self, $node ) = @_;

		my %msg = (
		summary => decode( 'UTF-8', $node->textContent ),
		);

		return Travel::Routing::DE::EFA::Route::Message->new(%msg);
		}

		sub parse_xml_part {
		@@ -691,7 +702,7 @@ sub parse_xml_part {
		}

		$hash->{regular_notes}
		= [ map { decode( 'UTF-8', $_->textContent ) } @e_sinfo ];
		= [ map { $self->parse_reg_info($_) } @e_sinfo ];
		$hash->{current_notes} = [ map { $self->parse_cur_info($_) } @e_cinfo ];

		push( @route_parts, $hash );

lib/Travel/Routing/DE/EFA/Route/Message.pm

0 → 100644

+136 −0

Original line number	Diff line number	Diff line
		package Travel::Routing::DE::EFA::Route::Message;

		use strict;
		use warnings;
		use 5.010;

		use parent 'Class::Accessor';

		our $VERSION = '2.11';

		Travel::Routing::DE::EFA::Route::Message->mk_ro_accessors(
		qw(is_detailed summary subject subtitle raw_content));

		sub new {
		my ( $obj, %conf ) = @_;

		my $ref = \%conf;

		if ( not defined $ref->{subject} ) {
		$ref->{subject} = $ref->{summary};
		}

		if ( defined $ref->{raw_content} ) {
		$ref->{is_detailed} = 1;
		}
		else {
		$ref->{is_detailed} = 0;
		}

		return bless( $ref, $obj );
		}

		sub TO_JSON {
		my ($self) = @_;

		return { %{$self} };
		}

		1;

		__END__

		=head1 NAME

		Travel::Routing::DE::EFA::Route::Message - contains a message related to a
		route or route part.

		=head1 SYNOPSIS

		for my $m ($routepart->regular_notes, $routepart->current_notes) {
		if ($m->is_detailed) {
		printf("%s: %s\n", $m->subtitle, $m->subject);
		}
		else {
		say $m->summary;
		}
		}

		=head1 VERSION

		version 2.11

		=head1 DESCRIPTION

		B<Travel::Routing::DE::EFA::Route::Message> contains information about a
		specific route or route part, such as wheelchair accessibility, unscheduled
		route diversions and cancelled stops. Often, this information is not used in
		the backend's route calculation, so a message may invalidate a certain route or
		route part.

		There are two types of messages provided by the backend: oneliners and detailed
		messages. There is no known distinction regarding their type or content.
		Also, there are some other backend-provided fields not yet covered by this
		module, so expect changes in future releases.

		A oneline message consists of a single string which can be accesed using
		B<subject> or B<summary> and its B<is_detailed> accessor returns false.

		A detailed message has a subject, subtitle, summary and detailed HTML
		content.

		=head1 METHODS

		=head2 ACCESSORS

		=over

		=item $message->is_detailed

		True if all accessors (fields) are set, false otherwise. When this field
		is false, only B<summary> and B<subject> are set (and they will return the
		same string).

		=item $message->summary

		Message summary.

		=item $message->subject

		Message subject. May be the same string as the subtitle.

		=item $message->subtitle

		Message subtitle. May be the same string as the summary.

		=item $message->raw_content

		Raw HTML content. May contain information not available via any other
		accessor.

		=back

		=head1 DIAGNOSTICS

		None.

		=head1 DEPENDENCIES

		None.

		=head1 BUGS AND LIMITATIONS

		This module does not yet provide access to all data provided by the backend.
		Most notably, B<raw_content> is not properly parsed yet.

		=head1 SEE ALSO

		Travel::Routing::DE::EFA(3pm), Travel::Routing::DE::EFA::Route::Part(3pm).

		=head1 AUTHOR

		Copyright (C) 2015 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>

		=head1 LICENSE

		0. You just DO WHAT THE FUCK YOU WANT TO.

lib/Travel/Routing/DE/EFA/Route/Part.pm

+3 −1

Original line number	Diff line number	Diff line
		@@ -86,7 +86,9 @@ sub footpath_parts {
		sub extra {
		my ($self) = @_;

		return @{ $self->{regular_notes} // [] };
		my @ret = map { $_->summary } @{ $self->{regular_notes} // [] };

		return @ret;
		}

		sub regular_notes {

Admin message