sg_mrt 0.1.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in singapore_mrt_stations.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,36 @@
+# SgMRT 
+
+**SgMRT** is a collection of Singapore's MRT Lines and Stations for use in Ruby. This tiny gem's data is taken from [List of Singapore MRT stations](http://en.wikipedia.org/wiki/List_of_Singapore_MRT_stations)
+
+### Usage:
+
+    # Get all MRT Lines
+    SgMRT::Line.all                           # => [<SgMRT::Line @name='North East Line' @code='nsl' @stations=[...]>]
+
+    # Get all MRT Stations
+    SgMRT::Station.all                        # => [<SgMRT::Station @name='Paya Lebar' @codes=[...]>]
+
+    # Find a station by name
+    SgMRT::Station.find_by_name('City Hall')  # => <SgMRT::Station @name='City Hall', @codes=[...]>
+
+    # Find station by code
+    SgMRT::Station.find_by_code('EW13')       # => <SgMRT::Station @name='City Hall', @codes=[...]>
+
+See specs for more usage examples.
+
+### Todos:
+
+* Provide support for rails
+  
+## License
+(The MIT License)
+
+Copyright © 2012 Tors Dalid
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end
+

data/data/ccl.yml

@@ -0,0 +1,65 @@
+---
+name: Circle Line
+code: CCL
+stations:
+  - - Dhoby Ghaut
+    - CC2
+  - - Esplanade
+    - CC3
+  - - Promenade
+    - CC4   
+  - - Nicoll Highway
+    - CC5
+  - - Stadium
+    - CC6
+  - - Mountbatten
+    - CC7
+  - - Dakota
+    - CC8
+  - - Paya Lebar
+    - CC9
+  - - MacPherson
+    - CC10
+  - - Tai Seng
+    - CC11
+  - - Bartley
+    - CC12
+  - - Serangoon
+    - CC13
+  - - Lorong Chuan
+    - CC14
+  - - Bishan
+    - CC15
+  - - Marymount
+    - CC16
+  - - Caldecott 
+    - CC17 
+  - - Bukit Brown
+    - CC18
+  - - Botanic Gardens
+    - CC19
+  - - Farrer Road
+    - CC20
+  - - Holland Village
+    - CC21
+  - - Buona Vista
+    - CC22
+  - - One-north
+    - CC23
+  - - Kent Ridge
+    - CC24
+  - - Haw Par Villa
+    - CC25
+  - - Pasir Panjang
+    - CC26
+  - - Labrador Park
+    - CC27
+  - - Telok Blangah 
+    - CC28
+  - - HarbourFront
+    - CC29
+  # CCLe
+  - - Bayfront
+    - CE1
+  - - Marina Bay
+    - CE2

data/data/ewl.yml

@@ -0,0 +1,67 @@
+---
+name: East West Line
+code: EWL
+stations:
+  - - Pasir Ris
+    - EW1
+  - - Tampines
+    - EW2
+  - - Simei
+    - EW3 
+  - - Tanah Merah 
+    - EW4[8] 
+  - - Bedok 
+    - EW5
+  - - Kembangan
+    - EW6 
+  - - Eunos 
+    - EW7
+  - - Paya Lebar
+    - EW8
+  - - Aljunied
+    - EW9
+  - - Kallang 
+    - EW10
+  - - Lavender
+    - EW11 
+  - - Bugis
+    - EW12  
+  - - City Hall 
+    - EW13 
+  - - Raffles Place 
+    - EW14 
+  - - Tanjong Pagar
+    - EW15 
+  - - Outram Park 
+    - EW16 
+  - - Tiong Bahru 
+    - EW17
+  - - Redhill 
+    - EW18
+  - - Queenstown
+    - EW19 
+  - - Commonwealth
+    - EW20
+  - - Buona Vista
+    - EW21 
+  - -  Dover
+    - EW22
+  - - Clementi
+    - EW23
+  - - Jurong East 
+    - EW24 
+  - - Chinese Garden
+    - EW25 
+  - - Lakeside
+    - EW26
+  - - Boon Lay
+    - EW27
+  - - Pioneer
+    - EW28 
+  - - Joo Koon
+    - EW29
+  # CGL
+  - - Expo
+    - CG1
+  - - Changi Airport
+    - CG2 

data/data/nel.yml

@@ -0,0 +1,36 @@
+---
+name: North East Line
+code: NEL
+stations:
+  - - HarbourFront 
+    - NE1 
+  - - Outram Park
+    - NE3 
+  - - Chinatown
+    - NE4 
+  - - Clarke Quay
+    - NE5 
+  - - Dhoby Ghaut
+    - NE6 
+  - - Little India 
+    - NE7 
+  - - Farrer Park
+    - NE8 
+  - - Boon Keng
+    - NE9 
+  - - Potong Pasir
+    - NE10 
+  - - Woodleigh 
+    - NE11 
+  - - Serangoon
+    - NE12 
+  - - Kovan
+    - NE13 
+  - - Hougang
+    - NE14
+  - - Buangkok
+    - NE15 
+  - - Sengkang 
+    - NE16 
+  - - Punggol
+    - NE17 

data/data/nsl.yml

@@ -0,0 +1,55 @@
+---
+name: North East Line
+code: NSL
+stations:
+  - - Jurong East
+    - NS1
+  - - Bukit Batok
+    - NS2
+  - - Bukit Gombak
+    - NS3
+  - - Choa Chu Kang
+    - NS4
+  - - Yew Tee
+    - NS5
+  - - Kranji
+    - NS7
+  - - Marsiling
+    - NS8
+  - - Woodlands 
+    - NS9
+  - - Admiralty
+    - NS10
+  - - Sembawang
+    - NS11
+  - - Yishun
+    - NS13
+  - - Khatib
+    - NS14
+  - - Yio Chu Kang
+    - NS15
+  - - Ang Mo Kio
+    - NS16
+  - - Bishan
+    - NS17
+  - - Braddell
+    - NS18
+  - - Toa Payoh
+    - NS19
+  - - Novena
+    - NS20
+  - - Newton
+    - NS21
+  - - Orchard
+    - NS22
+  - - Somerset
+    - NS23
+  - - Dhoby Ghaut
+    - NS24
+  - - City Hall
+    - NS25
+  - - Raffles Place
+    - NS26
+  - - Marina Bay
+    - NS27
+

data/lib/sg_mrt.rb

@@ -0,0 +1,163 @@
+require 'yaml'
+require 'json'
+
+##
+# SgMRT is a collection of Singapore's MRT Lines and Stations for use in Ruby.
+# The list of Singapore MRT Stations is taken from:
+#
+# http://en.wikipedia.org/wiki/List_of_Singapore_MRT_stations
+#
+# Usage:
+#
+#   # Get all MRT Lines
+#   SgMRT::Line.all               # => [<SgMRT::Line @name='North East Line' @code='nsl' @stations=[...]>]
+#
+#   # Get all MRT Stations
+#   SgMRT::Station.all            # => [<SgMRT::Station @name='Paya Lebar' @codes=[...]>]
+# 
+#   # Find a station by name
+#   SgMRT::Station.find_by_name('City Hall') # => <SgMRT::Station @name='City Hall', @codes=[...]>
+#
+#   # Find station by code
+#   SgMRT::Station.find_by_code('EW13')      # => <SgMRT::Station @name='City Hall', @codes=[...]>
+#
+module SgMRT
+   
+  DATA_PATH = File.join(File.dirname(__FILE__), '..', 'data')
+
+  @@data = {}
+  
+  class << self
+
+    ##
+    # Load all files from the data path  
+    #
+    def load_data
+
+      @@data[:stations] = []
+      @@data[:lines] = []
+
+      find_station = lambda do |name|
+        @@data[:stations].find{|x| x.name == name} || Station.new(name)
+      end
+
+      Dir[File.join(DATA_PATH, '*.yml')].each do |file_name|
+        if mrt = YAML.load_file(file_name)
+          mrt_name = mrt['name']
+          mrt_code = mrt['code']
+          mrt_stations = mrt['stations']
+          line = Line.new(mrt_code)
+          line.name = mrt_name
+          mrt_stations.each do |station|
+            station_name, station_code = station
+            new_station = find_station.call(station_name)
+            new_station.codes << station_code
+            new_station.lines << line.code
+            line.stations << new_station 
+            @@data[:stations] << new_station
+          end
+          @@data[:lines] << line
+        end
+      end
+
+      Station.define_helpers(@@data[:lines].collect(&:code))
+      
+    end
+
+    def lines
+      load_data if @@data.empty?
+      @@data[:lines]
+    end
+
+    def stations
+      load_data if @@data.empty?
+      @@data[:stations]
+    end
+
+  end
+
+  class Line
+    attr_accessor :stations, :code, :name
+
+    def initialize(code = nil)
+      @code = code 
+      @stations = []
+    end
+
+    def to_json
+      hash = {}
+      hash[:code] = @code
+      hash[:name] = @name
+      hash[:stations] = @stations.inject([]) do |ret_station_array, station|
+        station_hash = {}
+        station_hash[:name] = station.name
+        station_hash[:codes] = station.codes
+        ret_station_array << station_hash
+      end 
+      hash.to_json
+    end
+
+    class << self
+
+      def all
+        SgMRT.lines
+      end
+
+      def find_by_code(code)
+        all.find{ |x| x.code == code}
+      end
+    end
+
+  end
+
+  class Station
+    attr_accessor :name, :lines, :codes
+    @@cache = {}
+
+    def initialize(name, code = nil)
+      @name = name
+      @lines = []
+      @codes = []
+      @codes << code if code
+    end
+
+    class << self
+
+      def all
+        SgMRT.stations
+      end
+
+      def find_by_name(name)
+        @@cache[name] ||= all.find{|x| x.name == name}
+      end
+
+      def find_by_code(code)
+        @@cache[code] ||= all.find{|x| x.codes.include?(code)}
+      end
+
+      def cached
+        @@cache
+      end
+
+      ##
+      # Defines line helpers
+      #
+      # Example:
+      #
+      #   station = Station.find_by_code('EW13')
+      #   station.ewl?     # => true
+      #
+      def define_helpers(meths)
+        meths.each do |code|
+          define_method("#{code.downcase}?") do 
+            @lines.include?(code.upcase) 
+          end
+
+          define_method("#{code}?") do
+            @lines.include?(code.upcase)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sg_mrt/version.rb

@@ -0,0 +1,3 @@
+module SgMRT 
+  VERSION = "0.1.1"
+end

data/sg_mrt.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sg_mrt/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sg_mrt"
+  s.version     = SgMRT::VERSION
+  s.authors     = ["Tors Dalid"]
+  s.email       = ["cletedalid@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Singapore MRT Stations for Ruby}
+  s.description = %q{Collection of Singapore MRT Stations for use in Ruby}
+
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('minitest', ["= 2.10.1"])
+
+end

data/spec/sg_mrt_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe SgMRT do
+  
+  describe SgMRT::Line do
+
+    describe 'class methods' do
+      it 'should get all MRT Lines' do
+        SgMRT::Line.all.size.must_equal 4
+      end
+
+      it 'should be able to find an MRT line by code' do
+        SgMRT::Line.find_by_code('NSL').instance_of?(SgMRT::Line)
+      end
+
+      it 'should return nil for searching non existing MRT code' do
+        SgMRT::Line.find_by_code('ABC').must_equal nil
+      end
+    end
+
+    describe 'attributes' do
+
+      before do
+        @line = SgMRT::Line.find_by_code('EWL')
+      end
+
+      it 'should have a name' do
+        @line.name.must_equal 'East West Line'
+      end
+
+      it 'should have a code' do
+        @line.code.must_equal 'EWL'
+      end
+
+      it 'should have stations' do
+        @line.stations.any?.must_equal true
+      end
+
+      # it 'should be json serializable' do
+      #   begin
+      #     @line.to_json == "{\"code\":\"EWL\",\"name\":\"East West Line\",\"stations\":[{\"name\":\"Pasir Ris\",\"codes\":[\"EW1\"]},{\"name\":\"Tampines\",\"codes\":[\"EW2\"]},{\"name\":\"Simei\",\"codes\":[\"EW3\"]},{\"name\":\"Tanah Merah\",\"codes\":[\"EW4[8]\"]},{\"name\":\"Bedok\",\"codes\":[\"EW5\"]},{\"name\":\"Kembangan\",\"codes\":[\"EW6\"]},{\"name\":\"Eunos\",\"codes\":[\"EW7\"]},{\"name\":\"Paya Lebar\",\"codes\":[\"EW8\"]},{\"name\":\"Aljunied\",\"codes\":[\"EW9\"]},{\"name\":\"Kallang\",\"codes\":[\"EW10\"]},{\"name\":\"Lavender\",\"codes\":[\"EW11\"]},{\"name\":\"Bugis\",\"codes\":[\"EW12\"]},{\"name\":\"City Hall\",\"codes\":[\"EW13\",\"NS25\"]},{\"name\":\"Raffles Place\",\"codes\":[\"EW14\",\"NS26\"]},{\"name\":\"Tanjong Pagar\",\"codes\":[\"EW15\"]},{\"name\":\"Outram Park\",\"codes\":[\"EW16\"]},{\"name\":\"Tiong Bahru\",\"codes\":[\"EW17\"]},{\"name\":\"Redhill\",\"codes\":[\"EW18\"]},{\"name\":\"Queenstown\",\"codes\":[\"EW19\"]},{\"name\":\"Commonwealth\",\"codes\":[\"EW20\"]},{\"name\":\"Buona Vista\",\"codes\":[\"EW21\"]},{\"name\":\"Dover\",\"codes\":[\"EW22\"]},{\"name\":\"Clementi\",\"codes\":[\"EW23\"]},{\"name\":\"Jurong East\",\"codes\":[\"EW24\",\"NS1\"]},{\"name\":\"Chinese Garden\",\"codes\":[\"EW25\"]},{\"name\":\"Lakeside\",\"codes\":[\"EW26\"]},{\"name\":\"Boon Lay\",\"codes\":[\"EW27\"]},{\"name\":\"Pioneer\",\"codes\":[\"EW28\"]},{\"name\":\"Joo Koon\",\"codes\":[\"EW29\"]}]}"
+      #   end.must_equal true
+      # end
+    end
+
+  end
+
+  describe SgMRT::Station do
+    
+    describe 'class methods' do
+      it 'should be able to get all stations' do
+        SgMRT::Station.all.any?.must_equal true
+      end
+
+      it 'should be able to find a station by code' do
+        SgMRT::Station.find_by_code('EW12').name.must_equal 'Bugis'
+      end
+
+      it 'should be able to find a station by name' do
+        SgMRT::Station.find_by_name('Bugis').codes.include?('EW12').must_equal true
+      end
+    end
+
+    describe 'attributes' do
+      before do
+        @station = SgMRT::Station.find_by_code('EW13')
+      end
+
+      it 'should have a name' do
+        @station.name.eql?('City Hall').must_equal true
+      end
+
+      it 'should have the correct code' do
+        @station.codes.include?('EW13').must_equal true
+      end
+
+      it 'should check for the correct code' do
+        @station.ewl?.must_equal true
+        @station.EWL?.must_equal true
+      end
+
+      it 'could have multiple codes' do
+        @station.ewl?.must_equal true
+        @station.nsl?.must_equal true
+      end
+
+    end
+
+    it 'should be cached when performing lookups' do
+      station = SgMRT::Station.find_by_code('EW11')
+      assert_equal SgMRT::Station.cached['EW11'], station
+      station = SgMRT::Station.find_by_name('Paya Lebar')
+      assert_equal SgMRT::Station.cached['Paya Lebar'], station
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+lib_path = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib_path)
+
+require 'sg_mrt'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: sg_mrt
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Tors Dalid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-08 00:00:00.000000000 +08:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2154804880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :development
+  prerelease: false
+  version_requirements: *2154804880
+description: Collection of Singapore MRT Stations for use in Ruby
+email:
+- cletedalid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- data/ccl.yml
+- data/ewl.yml
+- data/nel.yml
+- data/nsl.yml
+- lib/sg_mrt.rb
+- lib/sg_mrt/version.rb
+- sg_mrt.gemspec
+- spec/sg_mrt_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Singapore MRT Stations for Ruby
+test_files:
+- spec/sg_mrt_spec.rb
+- spec/spec_helper.rb