gtfs 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8df8ca58b1e0d2b4855443d0d7825c59f7eabfaf8be6c89fff0da03cd69ce6b0
+  data.tar.gz: e38f08d1959b969400f80353d26ad1ee12965df92fc4c0ebe405ee39d81555ea
+SHA512:
+  metadata.gz: 689c542dead3e918da4d02dd6170ae31a134eeea4dfff6ba7bf1591fd71d297bcbd616b935790823a4247d8421aeb7fc9be9f8618ebd67f6a50388df57c27193
+  data.tar.gz: 4b09664e10ccd3c84dbdccbde25b66536395769dc3e789ce371c8f41ad6b77f68a2dbf70466ef88f508e717081eb7bfbf5be197d53a3fb80c6423d70d6495812

data/.travis.yml

@@ -1,4 +1,15 @@
+os: linux
+dist: bionic
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+
+before_install:
+  - gem install bundler
+
+install: bundle install --retry=3
+
+notifications:
+  email: false

data/Gemfile

@@ -1,10 +1,13 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'rake'
-gem 'rspec'
 gem 'multi_json', '1.0.4'
-gem 'simplecov', :require => false
-gem 'rubyzip'
-gem 'vcr'
-gem 'fakeweb'
-gem 'debugger'
+gem 'rubyzip', '~> 1.1'
+
+group :test, :development do
+  gem 'simplecov', :require => false
+  gem 'rake'
+  gem 'rspec-its'
+  gem 'rspec'
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -1,42 +1,54 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    columnize (0.3.6)
-    debugger (1.2.2)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.1.1)
-      debugger-ruby_core_source (~> 1.1.5)
-    debugger-linecache (1.1.2)
-      debugger-ruby_core_source (>= 1.1.1)
-    debugger-ruby_core_source (1.1.5)
-    diff-lcs (1.1.3)
-    fakeweb (1.3.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    hashdiff (1.0.1)
     multi_json (1.0.4)
-    rake (0.9.2.2)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    rubyzip (0.9.5)
-    simplecov (0.6.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    vcr (1.11.3)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubyzip (1.3.0)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    vcr (6.0.0)
+    webmock (3.9.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  debugger
-  fakeweb
   multi_json (= 1.0.4)
   rake
   rspec
-  rubyzip
+  rspec-its
+  rubyzip (~> 1.1)
   simplecov
   vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012 Ed Schmalzle
+
+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

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/nerdEd/gtfs.svg?branch=master)](https://travis-ci.org/nerdEd/gtfs)
+
 ### GTFS Ruby
 
 A Ruby wrapper for the [General Transit Feed Specification](https://developers.google.com/transit/gtfs/)
@@ -6,8 +8,12 @@ A Ruby wrapper for the [General Transit Feed Specification](https://developers.g
 
 Initialize a new GTFS source:
 
+    # Defaults to strict checking of required columns
     source = GTFS::Source.build(<URI or Path to GTFS zip file>)
-
+    
+    # Relax the column checks, useful for sources that don't conform to standard
+    source = GTFS::Source.build(<URI or Path to GTFS zip file>, {strict: false})
+    
 Accessing GTFS data from the source:
 
     source.agencies
@@ -22,24 +28,16 @@ Accessing GTFS data from the source:
     source.shapes
     source.frequencies        
     source.transfers          
+    
+Alternatively:
 
-### License
+    source.each_agency {|agency| puts agency}
+    ...
+    source.each_transfer {|transfer| puts transfer}
 
-Copyright (C) 2012 Ed Schmalzle
 
-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:
+### License
 
-The above copyright notice and this permission notice shall be included in 
-all copies or substantial portions of the Software.
+This project is licensed under the terms of the MIT license.
 
-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.
+See this license at [`LICENSE`](LICENSE).

data/Rakefile

@@ -4,3 +4,5 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new do |t|
   t.pattern = './spec/**/*_spec.rb'
 end
+
+task :default => [:spec]

data/gtfs.gemspec

@@ -5,7 +5,6 @@ require './lib/gtfs/version'
 Gem::Specification.new do |gem|
   gem.name    = 'gtfs'
   gem.version = GTFS::VERSION
-  gem.date    = Date.today.to_s
  
   gem.summary = 'Load and read GTFS data from zip bundles'
   gem.description = 'gtfs reads GTFS data from a google-compliant Zip bundle 
@@ -15,9 +14,13 @@ Gem::Specification.new do |gem|
   gem.email       = ['ed@nerded.net']
   gem.homepage    = 'https://github.com/nerdEd/gtfs'
 
+  gem.license = 'MIT'
+  
+  gem.required_ruby_version = '>= 1.9.2'
+
   gem.add_dependency 'rake'
   gem.add_dependency 'multi_json'
-  gem.add_dependency 'rubyzip'
+  gem.add_dependency 'rubyzip', ['~> 1.1']
 
   gem.add_development_dependency 'rspec', ['>= 2.0.0']
   gem.add_development_dependency 'simplecov'

data/lib/gtfs.rb

@@ -3,6 +3,7 @@ require 'gtfs/model'
 require 'gtfs/agency'
 require 'gtfs/calendar'
 require 'gtfs/calendar_date'
+require 'gtfs/feed_info'
 require 'gtfs/route'
 require 'gtfs/shape'
 require 'gtfs/stop'

data/lib/gtfs/agency.rb

@@ -3,7 +3,7 @@ module GTFS
     include GTFS::Model
 
     has_required_attrs :name, :url, :timezone
-    has_optional_attrs :id, :lang, :phone, :fare_url
+    has_optional_attrs :id, :lang, :phone, :fare_url, :email
     attr_accessor *attrs
 
     column_prefix :agency_
@@ -12,8 +12,8 @@ module GTFS
     required_file true
     uses_filename 'agency.txt'
 
-    def self.parse_agencies(data)
-      return parse_models(data)
+    def self.parse_agencies(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/calendar.rb

@@ -9,8 +9,8 @@ module GTFS
     required_file true
     uses_filename 'calendar.txt'
 
-    def self.parse_calendars(data)
-      return parse_models(data)
+    def self.parse_calendars(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/calendar_date.rb

@@ -9,8 +9,8 @@ module GTFS
     required_file true
     uses_filename 'calendar_dates.txt'
 
-    def self.parse_calendar_dates(data)
-      return parse_models(data)
+    def self.parse_calendar_dates(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/fare_attribute.rb

@@ -3,15 +3,15 @@ module GTFS
     include GTFS::Model
 
     has_required_attrs :fare_id, :price, :currency_type, :payment_method, :transfers
-    has_optional_attrs :transfer_duration
+    has_optional_attrs :transfer_duration 
     attr_accessor *attrs
 
     collection_name :fare_attributes
     required_file false
     uses_filename 'fare_attributes.txt'
 
-    def self.parse_fare_attributes(data)
-      return parse_models(data)
+    def self.parse_fare_attributes(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/fare_rule.rb

@@ -10,8 +10,8 @@ module GTFS
     required_file false
     uses_filename 'fare_rules.txt'
 
-    def self.parse_fare_rules(data)
-      return parse_models(data)
+    def self.parse_fare_rules(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/feed_info.rb

@@ -0,0 +1,19 @@
+module GTFS
+  class FeedInfo
+    include GTFS::Model
+
+    has_required_attrs :publisher_name, :publisher_url, :lang
+    has_optional_attrs :start_date, :end_date, :version
+    attr_accessor *attrs
+
+    column_prefix :feed_
+
+    collection_name :feed_infos
+    required_file false
+    uses_filename 'feed_info.txt'
+
+    def self.parse_feed_infos(data, options={})
+      return parse_models(data, options)
+    end
+  end
+end

data/lib/gtfs/frequency.rb

@@ -10,8 +10,8 @@ module GTFS
     required_file false
     uses_filename 'frequencies.txt'
 
-    def self.parse_frequencies(data)
-      return parse_models(data)
+    def self.parse_frequencies(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/model.rb

@@ -64,23 +64,42 @@ module GTFS
 
       def collection_name(collection_name)
         self.define_singleton_method(:name) {collection_name}
+
+        self.define_singleton_method(:singular_name) {
+          self.to_s.split('::').last.
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").downcase
+        }
       end
-      
-      def uses_filename(filename) 
+
+      def uses_filename(filename)
         self.define_singleton_method(:filename) {filename}
       end
 
-      def parse_models(data)
+      def each(filename)
+        CSV.foreach(filename, :headers => true) do |row|
+          yield parse_model(row.to_hash)
+        end
+      end
+
+      def parse_model(attr_hash, options={})
+        unprefixed_attr_hash = {}
+
+        attr_hash.each do |key, val|
+          unprefixed_attr_hash[key.gsub(/^#{prefix}/, '')] = val
+        end
+
+        model = self.new(unprefixed_attr_hash)
+      end
+
+      def parse_models(data, options={})
         return [] if data.nil? || data.empty?
 
         models = []
         CSV.parse(data, :headers => true) do |row|
-          attr_hash = {}
-          row.to_hash.each do |key, val|
-            attr_hash[key.gsub(/^#{prefix}/, '')] = val
-          end
-          model = self.new(attr_hash)
-          models << model if model.valid?
+          model = parse_model(row.to_hash, options)
+          models << model if options[:strict] == false || model.valid?
         end
         models
       end

data/lib/gtfs/route.rb

@@ -12,8 +12,8 @@ module GTFS
     required_file true
     uses_filename 'routes.txt'
 
-    def self.parse_routes(data)
-      return parse_models(data)
+    def self.parse_routes(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/shape.rb

@@ -12,8 +12,8 @@ module GTFS
 
     column_prefix :shape_
 
-    def self.parse_shapes(data)
-      return parse_models(data)
+    def self.parse_shapes(data, options={})
+      return parse_models(data, options)
     end
   end
 end

data/lib/gtfs/source.rb

@@ -1,21 +1,23 @@
 require 'tmpdir'
 require 'fileutils'
-require 'zip/zip'
+require 'zip'
 
 module GTFS
   class Source
 
-    ENTITIES = [GTFS::Agency, GTFS::Stop, GTFS::Route, GTFS::Trip, GTFS::StopTime, 
+    ENTITIES = [GTFS::Agency, GTFS::Stop, GTFS::Route, GTFS::Trip, GTFS::StopTime,
                 GTFS::Calendar, GTFS::CalendarDate, GTFS::Shape, GTFS::FareAttribute,
-                GTFS::FareRule, GTFS::Frequency, GTFS::Transfer]
+                GTFS::FareRule, GTFS::Frequency, GTFS::Transfer, GTFS::FeedInfo]
 
     REQUIRED_SOURCE_FILES = ENTITIES.select(&:required_file?).map(&:filename)
     OPTIONAL_SOURCE_FILES = ENTITIES.reject(&:required_file?).map(&:filename)
     SOURCE_FILES = ENTITIES.map(&:filename)
 
-    attr_accessor :source, :archive
+    DEFAULT_OPTIONS = {strict: true}
 
-    def initialize(source)
+    attr_accessor :source, :archive, :options
+
+    def initialize(source, opts={})
       raise 'Source cannot be nil' if source.nil?
 
       @tmp_dir = Dir.mktmpdir
@@ -23,6 +25,8 @@ module GTFS
 
       @source = source
       load_archive(@source)
+
+      @options = DEFAULT_OPTIONS.merge(opts)
     end
 
     def self.finalize(directory)
@@ -30,7 +34,7 @@ module GTFS
     end
 
     def extract_to_cache(source_path)
-      Zip::ZipFile.open(source_path) do |zip|
+      Zip::File.open(source_path) do |zip|
         zip.entries.each do |entry|
           zip.extract(entry.name, File.join(@tmp_dir, '/', entry.name))
         end
@@ -41,11 +45,11 @@ module GTFS
       raise 'Cannot directly instantiate base GTFS::Source'
     end
 
-    def self.build(data_root)
+    def self.build(data_root, opts={})
       if File.exists?(data_root)
-        LocalSource.new(data_root)
+        src = LocalSource.new(data_root, opts)
       else
-        URLSource.new(data_root) 
+        src = URLSource.new(data_root, opts)
       end
     end
 
@@ -61,9 +65,13 @@ module GTFS
     ENTITIES.each do |entity|
       define_method entity.name.to_sym do
         parse_file entity.filename do |f|
-          entity.send("parse_#{entity.name}".to_sym, f.read) 
+          entity.send("parse_#{entity.name}".to_sym, f.read, options)
         end
       end
+
+      define_method "each_#{entity.singular_name}".to_sym do |&block|
+        entity.each(File.join(@tmp_dir, entity.filename)) { |model| block.call model }
+      end
     end
 
     def files
@@ -72,7 +80,7 @@ module GTFS
 
     def parse_file(filename)
       raise_if_missing_source filename
-      open File.join(@tmp_dir, '/', filename) do |f|
+      open File.join(@tmp_dir, '/', filename), 'r:bom|utf-8' do |f|
         files[filename] ||= yield f
       end
     end