blib/lib/Map/Tube/Paris.pm

filter: Statementstmt 100% 20 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 7 / 7 Podpod n/a totaltotal 100% 27 / 27 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
↑ Summary
1 # -*- perl -*-
2 #
3 # Author: Gisbert W. Selke, TapirSoft Selke & Selke GbR.
4 #
5 # Copyright (C) 2025--2026 Gisbert W. Selke. All rights reserved.
6 # This package is free software; you can redistribute it and/or
7 # modify it under the same terms as Perl itself.
8 #
9 # Mail: gws@cpan.org
10 #
11 package Map::Tube::Paris;
12 1 ▶use 5.14.0;
Subroutine BEGIN: called CC=1 SCAR=0.0
13 1 ▶use version 0.77 ( );
Subroutine BEGIN: called CC=1 SCAR=0.0
14 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
15 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
16
17 our $VERSION = version->declare('v0.2.2');
18
19 =encoding utf8
20
21 =head1 NAME
22
23 Map::Tube::Paris - Interface to the Paris metro, RER, Transiliens, and tram lines map
24
25 =cut
26
27 1 ▶use File::Share ':all';
Subroutine BEGIN: called CC=1 SCAR=0.0
28 1 ▶use Moo;
Subroutine BEGIN: called CC=1 SCAR=0.0
29 1 ▶use namespace::clean;
Subroutine BEGIN: called CC=1 SCAR=0.0
30
31 has xml => ( is => 'ro', default => sub { return dist_file('Map-Tube-Paris', 'paris-map.xml') } );
32
33 with 'Map::Tube';
34
35 =head1 SYNOPSIS
36
37 use Map::Tube::Paris;
38 my $tube = Map::Tube::Paris->new( );
39
40 my $route = $tube->get_shortest_route( 'Bobigny-Pantin - Raymond Queneau', 'Miromesnil');
41
42 print "Route: $route\n";
43
44 =head1 DESCRIPTION
45
46 This module allows to find the shortest route between any two given local or regional transport
47 stations in Paris. All interesting methods are provided by the role L<Map::Tube>.
48
49 =head1 METHODS
50
51 =head2 CONSTRUCTOR
52
53 use Map::Tube::Paris;
54 my $tube = Map::Tube::Paris->new( );
55
56 The only argument, C<xml>, is optional; if specified, it should be a code ref
57 to a function that returns either the path the XML map file, or a string
58 containing this XML content. The default is the path to F<paris-map.xml>
59 that is a part of this distribution. For further information see L<Map::Tube>.
60
61 =head2 xml()
62
63 This read-only accessor returns whatever was specified as the XML source at
64 construction.
65
66 =head1 ERRORS
67
68 If something goes wrong, maybe because the map information file was corrupted,
69 the constructor will die.
70
71 =head1 BUGS
72
73 Please report any bugs or feature requests through the web interface at
74 L<https://github.com/gwselke/Map-Tube-Paris/issues>. I will be
75 notified and then you'll automatically be notified of progress on your
76 bug when (and if) I make changes.
77
78 =head1 AUTHOR
79
80 Gisbert W. Selke, TapirSoft Selke & Selke GbR.
81
82 =head1 COPYRIGHT AND LICENCE
83
84 The data for the XML file were taken from the relevant Wikipedia articles.
85 A sample of data was verified using OpenStreetMap and https://www.ratp.fr.
86 The module itself is free software; you may redistribute and/or modify
87 it under the same terms as Perl itself.
88
89 L<Map::Tube>, L<Map::Tube::GraphViz>.
90
91 =cut
92
93 1;
↑ Summary