summaryrefslogtreecommitdiff
path: root/lib/Travel/Status/DE/DeutscheBahn
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Travel/Status/DE/DeutscheBahn')
-rw-r--r--lib/Travel/Status/DE/DeutscheBahn/Result.pm365
1 files changed, 0 insertions, 365 deletions
diff --git a/lib/Travel/Status/DE/DeutscheBahn/Result.pm b/lib/Travel/Status/DE/DeutscheBahn/Result.pm
deleted file mode 100644
index be9ec18..0000000
--- a/lib/Travel/Status/DE/DeutscheBahn/Result.pm
+++ /dev/null
@@ -1,365 +0,0 @@
-package Travel::Status::DE::DeutscheBahn::Result;
-
-use strict;
-use warnings;
-use 5.010;
-
-no if $] >= 5.018, warnings => "experimental::smartmatch";
-
-use parent 'Class::Accessor';
-
-our $VERSION = '1.05';
-
-Travel::Status::DE::DeutscheBahn::Result->mk_ro_accessors(
- qw(date time train route_end route_raw platform info_raw routeinfo_raw));
-
-sub new {
- my ( $obj, %conf ) = @_;
-
- my $ref = \%conf;
-
- return bless( $ref, $obj );
-}
-
-sub destination {
- my ($self) = @_;
-
- return $self->{route_end};
-}
-
-sub line {
- my ($self) = @_;
-
- return $self->{train};
-}
-
-sub info {
- my ($self) = @_;
-
- my $info = $self->info_raw;
-
- $info =~ s{ ,Grund }{}ox;
- $info =~ s{ ^ \s+ }{}ox;
- $info
- =~ s{ (?: ^ | , ) (?: p.nktlich | [nk] [.] [Aa] [.] | on \s time ) }{}ox;
- $info =~ s{ ^ , }{}ox;
-
- return $info;
-}
-
-sub delay {
- my ($self) = @_;
-
- my $info = $self->info_raw;
-
- if ( $info =~ m{ p.nktlich }ox ) {
- return 0;
- }
- if ( $info =~ m{ (?: ca \. \s* )? \+ (?<delay> \d+) :? \s* }ox ) {
- return $+{delay};
- }
-
- return;
-}
-
-sub is_cancelled {
- my ($self) = @_;
- my $info = $self->info_raw;
-
- if ( $info =~ m{ Fahrt \s f.llt \s aus }ox ) {
- return 1;
- }
- return 0;
-}
-
-sub origin {
- my ($self) = @_;
-
- return $self->{route_end};
-}
-
-sub route {
- my ($self) = @_;
-
- my @stops = map { $_->[1] } @{ $self->{route} };
- return @stops;
-}
-
-sub route_info {
- my ($self) = @_;
-
- my $route_info = $self->routeinfo_raw;
-
- $route_info =~ s{ ^ [\s\n]+ }{}x;
- $route_info =~ s{ [\s\n]+ $ }{}x;
-
- return $route_info;
-}
-
-sub route_interesting {
- my ( $self, $max_parts ) = @_;
-
- my @via = $self->route;
- my ( @via_main, @via_show, $last_stop );
- $max_parts //= 3;
-
- for my $stop (@via) {
- if ( $stop =~ m{ Hbf | Flughafen }ox ) {
- push( @via_main, $stop );
- }
- }
- $last_stop = pop(@via);
-
- if ( @via_main and $via_main[-1] eq $last_stop ) {
- pop(@via_main);
- }
-
- if ( @via_main and @via and $via[0] eq $via_main[0] ) {
- shift(@via_main);
- }
-
- if ( @via < $max_parts ) {
- @via_show = @via;
- }
- else {
- if ( @via_main >= $max_parts ) {
- @via_show = ( $via[0] );
- }
- else {
- @via_show = splice( @via, 0, $max_parts - @via_main );
- }
-
- while ( @via_show < $max_parts and @via_main ) {
- my $stop = shift(@via_main);
- if ( $stop ~~ \@via_show or $stop eq $last_stop ) {
- next;
- }
- push( @via_show, $stop );
- }
- }
-
- for (@via_show) {
- s{ ?Hbf}{};
- }
-
- return @via_show;
-
-}
-
-sub route_timetable {
- my ($self) = @_;
-
- return @{ $self->{route} };
-}
-
-sub TO_JSON {
- my ($self) = @_;
-
- return { %{$self} };
-}
-
-sub type {
- my ($self) = @_;
-
- # $self->{train} is either "TYPE 12345" or "TYPE12345"
- my ($type) = ( $self->{train} =~ m{ ^ ([A-Z]+) }x );
-
- return $type;
-}
-
-1;
-
-__END__
-
-=head1 NAME
-
-Travel::Status::DE::DeutscheBahn::Result - Information about a single
-arrival/departure received by Travel::Status::DE::DeutscheBahn
-
-=head1 SYNOPSIS
-
- for my $departure ($status->results) {
- printf(
- "At %s: %s to %s from platform %s\n",
- $departure->time,
- $departure->line,
- $departure->destination,
- $departure->platform,
- );
- }
-
- # or (depending on module setup)
- for my $arrival ($status->results) {
- printf(
- "At %s: %s from %s on platform %s\n",
- $arrival->time,
- $arrival->line,
- $arrival->origin,
- $arrival->platform,
- );
- }
-
-=head1 VERSION
-
-version 1.05
-
-=head1 DESCRIPTION
-
-Travel::Status::DE::DeutscheBahn::Result describes a single arrival/departure
-as obtained by Travel::Status::DE::DeutscheBahn. It contains information about
-the platform, time, route and more.
-
-=head1 METHODS
-
-=head2 ACCESSORS
-
-=over
-
-=item $result->date
-
-Arrival/Departure date in "dd.mm.yyyy" format.
-
-=item $result->delay
-
-Returns the train's delay in minutes, or undef if it is unknown.
-
-=item $result->info
-
-Returns additional information, for instance the reason why the train is
-delayed. May be an empty string if no (useful) information is available.
-
-=item $result->is_cancelled
-
-True if the train was cancelled, false otherwise.
-
-=item $result->line
-
-=item $result->train
-
-Returns the line name, either in a format like "S 1" (S-Bahn line 1)
-or "RE 10111" (RegionalExpress train 10111, no line information).
-
-=item $result->platform
-
-Returns the platform from which the train will depart / at which it will
-arrive.
-
-=item $result->route
-
-Returns a list of station names the train will pass between the selected
-station and its origin/destination.
-
-=item $result->route_end
-
-Returns the last element of the route. Depending on how you set up
-Travel::Status::DE::DeutscheBahn (arrival or departure listing), this is
-either the train's destination or its origin station.
-
-=item $result->destination
-
-=item $result->origin
-
-Convenience aliases for $result->route_end.
-
-=item $result->route_interesting([I<max>])
-
-Returns a list of up to I<max> (default: 3) interesting stations the train
-will pass on its journey. Since deciding whether a station is interesting or
-not is somewhat tricky, this feature should be considered experimental.
-
-The first element of the list is always the train's next stop. The following
-elements contain as many main stations as possible, but there may also be
-smaller stations if not enough main stations are available.
-
-In future versions, other factors may be taken into account as well. For
-example, right now airport stations are usually not included in this list,
-although they should be.
-
-Note that all main stations will be stripped of their "Hbf" suffix.
-
-=item $result->route_raw
-
-Returns the raw string used to create the route array.
-
-Note that cancelled stops are filtered from B<route>, but still present in
-B<route_raw>.
-
-=item $result->route_timetable
-
-Similar to B<route>. however, this function returns a list of array
-references of the form C<< [ arrival time, station name ] >>.
-
-=item $result->route_info
-
-Returns a string containing information related to the train's route, such as
-"landslide between X and Y, expect delays".
-
-=item $result->time
-
-Returns the arrival/departure time as string in "hh:mm" format.
-
-=item $result->type
-
-Returns the type of this train, e.g. "S" for S-Bahn, "RE" for Regional Express
-or "ICE" for InterCity-Express.
-
-=back
-
-=head2 INTERNAL
-
-=over
-
-=item $result = Travel::Status::DE::DeutscheBahn::Result->new(I<%data>)
-
-Returns a new Travel::Status::DE::DeutscheBahn::Result object.
-You usually do not need to call this.
-
-Required I<data>:
-
-=over
-
-=item B<time> => I<hh:mm>
-
-=item B<train> => I<string>
-
-=item B<route_raw> => I<string>
-
-=item B<route> => I<arrayref>
-
-=item B<route_end> => I<string>
-
-=item B<platform> => I<string>
-
-=item B<info_raw> => I<string>
-
-=back
-
-=back
-
-=head1 DIAGNOSTICS
-
-None.
-
-=head1 DEPENDENCIES
-
-=over
-
-=item Class::Accessor(3pm)
-
-=back
-
-=head1 BUGS AND LIMITATIONS
-
-None known.
-
-=head1 SEE ALSO
-
-Travel::Status::DE::DeutscheBahn(3pm).
-
-=head1 AUTHOR
-
-Copyright (C) 2011 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
-
-=head1 LICENSE
-
-This module is licensed under the same terms as Perl itself.