map-tube 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54c19572c9c5bd8108363649f92204d97205aad5
+  data.tar.gz: 6275af06c1c3930f9e652a33d33c443285ca234c
+SHA512:
+  metadata.gz: e692f5fbc03013fc8cb4e17389237d46589fc806b2338d110321c81fe3df4b2244d8b6714f748616ec665a5815f71ba648c46a5546b0eee7940bb26caf7cc978
+  data.tar.gz: dc9b023db52dcb0d46eab9db473a9e5001b148b7fdb530d5569792e3e4abc678a771ccd76eaafc4562003456b170a284c5ca2136ecc8a440212e371b42ee8bab

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in map-tube.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Radu-Bogdan Croitoru
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,170 @@
+# Map::Tube
+
+The core module to process the map data. It provides the interface to find the shortest route in terms of stoppage between two nodes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'map-tube'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install map-tube
+
+## Usage
+
+**Load maps and read them**
+
+```ruby
+require 'map/tube'
+
+# Load from available cities
+bucharest = Map::Tube.new("Bucharest").read
+london = Map::Tube.new("London").read
+
+# Or load your xml
+mycity = Map::Tube.new_from_xml("My City", "path/to/xml").read
+```
+
+**Line/Station names**
+
+```ruby
+bucharest.lines.map(&:name) # => ["Linia M1", "Linia M2", "Linia M3", "Linia M4"]
+bucharest.stations.map(&:name)
+```
+
+**Get the shortest path between two stations**
+
+```ruby
+route = london.get_shortest_route("Paddington", "Monument")
+=> #<Map::Tube::Route:0x007fd81986b160
+ @arrival_station=#<Map::Tube::Station:0x007fd819168430 @id="M009", @line="Circle,District", @links=#<Set: {"T009", "C008", "B003"}>, @name="Monument">,
+ @departure_station=#<Map::Tube::Station:0x007fd818b953a0 @id="P001", @line="District,Circle,Hammersmith & City,Bakerloo", @links=#<Set: {"B008", "W007", "E011", "R010"}>, @name="Paddington">,
+ @intermediate_stations=
+  [#<Map::Tube::Station:0x007fd8191ba230 @id="E011", @line="Circle,District,Hammersmith & City,Bakerloo", @links=#<Set: {"P001", "M005", "B001"}>, @name="Edgware Road">,
+   #<Map::Tube::Station:0x007fd818c3c8f8
+    @id="B001",
+    @line="Circle,Hammersmith & City,Bakerloo,Metropolitan,Jubilee",
+    @links=#<Set: {"B018", "R004", "M005", "G008", "S023", "E011", "F004"}>,
+    @name="Baker Street">,
+   #<Map::Tube::Station:0x007fd818c1eb50 @id="B018", @line="Central,Jubilee", @links=#<Set: {"G009", "B001", "O005", "M004"}>, @name="Bond Street">,
+   #<Map::Tube::Station:0x007fd818bdf3d8 @id="G009", @line="Victoria,Jubilee,Piccadilly", @links=#<Set: {"V002", "O005", "B018", "W027", "H036", "P006"}>, @name="Green Park">,
+   #<Map::Tube::Station:0x007fd818af7bf0 @id="W027", @line="Circle,District,Jubilee", @links=#<Set: {"S022", "G009", "W008", "E015"}>, @name="Westminster">,
+   #<Map::Tube::Station:0x007fd8191486f8 @id="W008", @line="Northern,Bakerloo,Jubilee,Waterloo & City", @links=#<Set: {"E015", "L002", "W027", "S021", "B003", "K001"}>, @name="Waterloo">,
+   #<Map::Tube::Station:0x007fd818c37b28 @id="B003", @line="Central,DLR,Northern,Waterloo & City", @links=#<Set: {"S002", "S024", "L013", "M011", "L012", "W008", "M009"}>, @name="Bank">]>
+
+route.pretty
+# => "Paddington -> Edgware Road -> Baker Street -> Bond Street -> Green Park -> Westminster -> Waterloo -> Bank -> Monument"
+```
+
+```ruby
+route = bucharest.get_shortest_route("Dristor 1", "Pipera")
+
+# => #<Map::Tube::Route:0x007f9769c5a550
+ @arrival_station=#<Map::Tube::Station:0x007f976a08e310 @id="M2-01", @line="M2", @links=#<Set: {"M2-02"}>, @name="Pipera">,
+ @departure_station=#<Map::Tube::Station:0x007f976a08fa30 @id="M1-17", @line="M1", @links=#<Set: {"M1-16", "M1-18", "M3-11"}>, @name="Dristor 1">,
+ @intermediate_stations=
+  [#<Map::Tube::Station:0x007f976a08ff58 @id="M1-16", @line="M1", @links=#<Set: {"M1-15", "M1-17", "M3-10"}>, @name="Mihai Bravu">,
+   #<Map::Tube::Station:0x007f97698261f0 @id="M1-15", @line="M1", @links=#<Set: {"M1-14", "M1-16", "M3-09"}>, @name="Timpuri Noi">,
+   #<Map::Tube::Station:0x007f976982c208 @id="M1-14", @line="M1", @links=#<Set: {"M1-13", "M1-15", "M3-08", "M2-07"}>, @name="Piața Unirii 1">,
+   #<Map::Tube::Station:0x007f976a08cdd0 @id="M2-07", @line="M2", @links=#<Set: {"M2-06", "M2-08", "M3-08"}>, @name="Piața Unirii 2">,
+   #<Map::Tube::Station:0x007f976a08d118 @id="M2-06", @line="M2", @links=#<Set: {"M2-05", "M2-07"}>, @name="Universitate">,
+   #<Map::Tube::Station:0x007f976a08d460 @id="M2-05", @line="M2", @links=#<Set: {"M2-04", "M2-06"}>, @name="Piața Romană">,
+   #<Map::Tube::Station:0x007f976a08d988 @id="M2-04", @line="M2", @links=#<Set: {"M2-03", "M2-05", "M1-06"}>, @name="Piața Victoriei">,
+   #<Map::Tube::Station:0x007f976a08dcd0 @id="M2-03", @line="M2", @links=#<Set: {"M2-02", "M2-04"}>, @name="Aviatorilor">,
+   #<Map::Tube::Station:0x007f976a08e018 @id="M2-02", @line="M2", @links=#<Set: {"M2-01", "M2-03"}>, @name="Aurel Vlaicu">]>
+
+route.pretty
+# => "Dristor 1 -> Mihai Bravu -> Timpuri Noi -> Piața Unirii 1 -> Piața Unirii 2 -> Universitate -> Piața Romană -> Piața Victoriei -> Aviatorilor -> Aurel Vlaicu -> Pipera"
+```
+
+## Documentation
+
+**Map::Tube**
+  - `.new(city_name)` *-> Map::Tube::Loader*
+  - `.new_from_xml(city_name, path_to_xml)` *-> Map::Tube::Loader*
+
+**Map::Tube::Loader**
+  - `.new(city_name, map_path=nil)`
+    - *(mandatory)* city_name - String - It should match a city in data/ dir
+    - *(optional)* map_path - String - Path to local xml
+  - `#city`
+  - `#map_path`
+  - `#read` *-> Map::Tube::Graph*
+
+**Map::Tube::Graph**
+  - `#stations` *-> Array [ Map::Tube::Station ]*
+  - `#lines` *-> Array [ Map::Tube::Line ]*
+  - `#get_shortest_route(from_station_name, to_station_name)` *-> Map::Tube::Route*
+    - from_station_name - String - Name of departure station
+    - to_station_name - String - Name of arrival station
+  - `#get_station_by_id(station_id)` *-> Map::Tube::Station*
+    - station_id - String - Unique identifier of the station
+  - `#get_station_by_name(station_name)` *-> Map::Tube::Station*
+    - station_name - String - Name of the station
+  - `#get_line_by_id(line_id)` *-> Map::Tube::Line*
+    - line_id - String - Unique identifier of the line
+  - `#get_line_by_name(line_name)` *-> Map::Tube::Line*
+    - line_name - String - Name of the line
+  - `#add_line(line)` *-> Map::Tube::Graph*
+    - line - Map::Tube::Line object
+  - `#add_station(station)` *-> Map::Tube::Graph*
+    - station - Map::Tube::Station object
+
+**Map::Tube::Line**
+  - `.new(id, name, color)`
+    - id - String - unique identifier of the Line
+    - name - String - name of the line
+    - color - String - color of the line
+  - `#id`
+  - `#name`
+  - `#color`
+
+**Map::Tube::Station**
+  - `.new(id, name, line)`
+    - id - String - unique identifier of the Station
+    - name - String - name of the Station
+    - line - String - line that supports the Station
+  - `#id`
+  - `#name`
+  - `#line`
+  - `#links` *-> Set { String }*
+  - `#add_link(link)`
+    - link - String - unique identifier of the station
+
+**Map::Tube::Route**
+  - `.new(departure_station, arrival_station)`
+    - departure_station - Map::Tube::Station
+    - arrival_station - Map::Tube::Station
+  - `#departure_station` *-> Map::Tube::Station*
+  - `#arrival_station` *-> Map::Tube::Station*
+  - `#intermediate_stations` *-> Array [ Map::Tube::Station ]*
+  - `#pretty` *-> String*
+
+**Map::Tube::Parser**
+  - `.new(file_handle)`
+    - file_handle - File.open(path)
+      - path - String - path to xml
+  - `#parse` *-> Map::Tube::Graph*
+
+**Map::Tube::Exceptions**
+  - StationException
+  - LineException
+  - RouteException
+  - CityException
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [radubogdan/map-tube](https://github.com/radubogdan/map-tube).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "map/tube"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/barcelona-map.xml

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<tube name="Barcelona Metro">
+  <lines>
+      <line id="L1"  name="L1"  color="#8B0000" /><!-- Red    -->
+      <line id="L2"  name="L2"  color="#551A8B" /><!-- Purple -->
+      <line id="L3"  name="L3"  color="#006400" /><!-- Green  -->
+      <line id="L4"  name="L4"  color="#FFFF00" /><!-- Yellow -->
+      <line id="L5"  name="L5"  color="#000080" /><!-- Blue   -->
+      <line id="L6"  name="L6"  color="#551A8B" /><!-- Purple -->
+      <line id="L7"  name="L7"  color="#550000" /><!-- Brown  -->
+      <line id="L8"  name="L8"  color="#FF4F00" /><!-- Orange -->
+      <line id="L9"  name="L9"  color="#FF4F00" /><!-- Orange -->
+      <line id="L10" name="L10" color="#000080" /><!-- Blue   -->
+      <line id="L11" name="L11" color="#006400" /><!-- Green  -->
+  </lines>
+
+  <stations>
+    <station id="TRINITAT-NOVA"     name="Trinitat Nova"       line="L3,L4,L11" link="L04-02,L11-04,L03-25"/>
+    <station id="VALL-D'HEBRON"     name="Vall d'Hebron"       line="L3,L5"     link="L03-21,L03-19"/>
+    <station id="DIAGONAL"          name="Diagonal"            line="L5,L6,L3"  link="L03-16,PASSEIG-DE-GRACIA"/>
+    <station id="PASSEIG-DE-GRACIA" name="Passeig de Gràcia"   line="L2,L3,L4"  link="L04-09,URQUINAONA,DIAGONAL,CATALUNYA"/>
+    <station id="CATALUNYA"         name="Catalunya"           line="L1,L3,L7"  link="PASSEIG-DE-GRACIA,L03-12"/>
+    <station id="PARAL-LEL"         name="Paral-lel"           line="L2,L3"     link="L03-09,L03-11"/>
+    <station id="ESPANYA"           name="Espanya"             line="L1,L3,L8"  link="L03-07,L03-09,L08-10"/>
+    <station id="SANTS-ESTACIA"     name="Sants Estació"       line="L3,L5"     link="L03-05,L03-07"/>
+    <station id="VERDAGUER"         name="Verdaguer"           line="L4,L5"     link="L04-07,L04-09,DIAGONAL"/>
+    <station id="URQUINAONA"        name="Urquinaona"          line="L1,L4"     link="PASSEIG-DE-GRACIA,L04-12"/>
+
+    <station id="L03-01"  name="Zona Universitària"            line="L3"  link="L03-02"/>
+    <station id="L03-02"  name="Palau Reial"                   line="L3"  link="L03-03,L03-01"/>
+    <station id="L03-03"  name="Maria Cristina"                line="L3"  link="L03-04,L03-02"/>
+    <station id="L03-04"  name="Les Corts"                     line="L3"  link="L03-05,L03-03"/>
+    <station id="L03-05"  name="Plaça del Centre"              line="L3"  link="SANTS-ESTACIA,L03-04"/>
+    <station id="L03-07"  name="Tarragona"                     line="L3"  link="ESPANYA,SANTS-ESTACIA"/>
+    <station id="L03-09"  name="Poble Sec"                     line="L3"  link="PARAL-LEL,ESPANYA"/>
+    <station id="L03-11"  name="Drassenes"                     line="L3"  link="L03-12,PARAL-LEL"/>
+    <station id="L03-12"  name="Liceu"                         line="L3"  link="CATALUNYA,L03-11"/>
+    <station id="L03-16"  name="Fontana"                       line="L3"  link="DIAGONAL,L03-17"/>
+    <station id="L03-17"  name="Lesseps"                       line="L3"  link="L03-16,L03-18"/>
+    <station id="L03-18"  name="Vallcarca"                     line="L3"  link="L03-17,L03-19"/>
+    <station id="L03-19"  name="Penitents"                     line="L3"  link="L03-18,VALL-D'HEBRON"/>
+    <station id="L03-21"  name="Montbau"                       line="L3"  link="VALL-D'HEBRON,L03-22"/>
+    <station id="L03-22"  name="Mundet"                        line="L3"  link="L03-21,VALL-D'HEBRON"/>
+    <station id="L03-23"  name="Validaura"                     line="L3"  link="L03-22,L03-24"/>
+    <station id="L03-24"  name="Canyelles"                     line="L3"  link="L03-23,L03-25"/>
+    <station id="L03-25"  name="Roquetes"                      line="L3"  link="L03-24,TRINITAT-NOVA"/>
+
+    <station id="L04-02"  name="Via Júlia"                     line="L4"  link="TRINITAT-NOVA,L04-03"/>
+    <station id="L04-03"  name="Llucmajor"                     line="L4"  link="L04-02,L04-04"/>
+    <station id="L04-04"  name="Maragall"                      line="L4"  link="L04-03,L04-05"/>
+    <station id="L04-05"  name="Guinardó"                      line="L4"  link="L04-04,L04-06"/>
+    <station id="L04-06"  name="Alfons X"                      line="L4"  link="L04-05,L04-07"/>
+    <station id="L04-07"  name="Joanic"                        line="L4"  link="L04-06,VERDAGUER"/>
+    <station id="L04-09"  name="Girona"                        line="L4"  link="VERDAGUER,PASSEIG-DE-GRACIA"/>
+    <station id="L04-12"  name="Jaume I"                       line="L4"  link="URQUINAONA,L04-13"/>
+    <station id="L04-13"  name="Barceloneta"                   line="L4"  link="L04-12,L04-14"/>
+    <station id="L04-14"  name="Ciutadella-Vila Olimpica"      line="L4"  link="L04-13,L04-15"/>
+    <station id="L04-15"  name="Bogatell"                      line="L4"  link="L04-14,L04-16"/>
+    <station id="L04-16"  name="Llacuna"                       line="L4"  link="L04-15,L04-17"/>
+    <station id="L04-17"  name="Poble Nou"                     line="L4"  link="L04-16,L04-18"/>
+    <station id="L04-18"  name="Selva de Mar"                  line="L4"  link="L04-17,L04-19"/>
+    <station id="L04-19"  name="El Maresme-Fòrum"              line="L4"  link="L04-18,L04-20"/>
+    <station id="L04-20"  name="Besòs Mar"                     line="L4"  link="L04-19,L04-21"/>
+    <station id="L04-21"  name="La Pau"                        line="L4"  link="L04-20"/>
+
+    <station id="L08-01"  name="Moli Nou-ciutat Cooperativa"   line="L8"  link="L08-02"/>
+    <station id="L08-02"  name="Sant Boi"                      line="L8"  link="L08-01,L08-03"/>
+    <station id="L08-03"  name="Cornella-Riera"                line="L8"  link="L08-02,L08-04"/>
+    <station id="L08-04"  name="Almeda"                        line="L8"  link="L08-03,L08-05"/>
+    <station id="L08-05"  name="Av Carrilet"                   line="L8"  link="L08-04,L08-06"/>
+    <station id="L08-06"  name="St. Josep"                     line="L8"  link="L08-05,L08-07"/>
+    <station id="L08-07"  name="Gornal"                        line="L8"  link="L08-06,L08-08"/>
+    <station id="L08-08"  name="Europa Fira"                   line="L8"  link="L08-07,L08-09"/>
+    <station id="L08-09"  name="Ildefons Cerda"                line="L8"  link="L08-08,L08-10"/>
+    <station id="L08-10"  name="Magoria La Campana"            line="L8"  link="L08-09,ESPANYA"/>
+
+    <station id="L11-01"  name="Can Cuiàs"                     line="L11" link="L11-02"/>
+    <station id="L11-02"  name="Ciutat Meridiana"              line="L11" link="L11-03,L11-01"/>
+    <station id="L11-03"  name="Torre Baró-Vallbona"           line="L11" link="L11-04,L11-02"/>
+    <station id="L11-04"  name="Casa de l'Aigua"               line="L11" link="TRINITAT-NOVA,L11-03"/>
+  </stations>
+</tube>