gtfs_reader 1.2.0 → 3.1.0

data/lib/gtfs_reader/config/feed_definition.rb

@@ -9,46 +9,46 @@ module GtfsReader
         @file_definition = {}
       end
 
-      #@return [Array<FileDefinition>] All of the defined files.
+      # @return [Array<FileDefinition>] All of the defined files.
       def files
         @file_definition.values
       end
 
       def required_files
-        files.select &:required?
+        files.select(&:required?)
       end
 
       def optional_files
-        files.reject &:required?
+        files.reject(&:required?)
       end
 
-      #@overload file(name, *args, &block)
-      #  Defines a new file in the feed.
+      # @overload file(name, *args, &block)
+      #   Defines a new file in the feed.
       #
-      #  @param name [String] the name of this file within the feed. This name
-      #    should not include a file extension (like +.txt+)
-      #  @param args [Array] the first argument is used as a +Hash+ of options
-      #    to create the new file definition
-      #  @param block [Proc] this block is +instance_eval+ed on the new
-      #    {FileDefinition file}
-      #  @return [FileDefinition] the newly created file
+      #   @param name [String] the name of this file within the feed. This name
+      #     should not include a file extension (like +.txt+)
+      #   @param args [Array] the first argument is used as a +Hash+ of options
+      #     to create the new file definition
+      #   @param block [Proc] this block is +instance_eval+ed on the new
+      #     {FileDefinition file}
+      #   @return [FileDefinition] the newly created file
       #
-      #@overload file(name)
-      #  @param name [String] the name of the file to return
-      #  @return [FileDefinition] the previously created file with the given name
-      #@see FileDefinition
+      # @overload file(name)
+      #   @param name [String] the name of the file to return
+      #   @return [FileDefinition] the previously created file with +name+
+      # @see FileDefinition
       def file(name, *args, &block)
         return @file_definition[name] unless block_given?
 
-        definition_for!( name, args.first ).tap do |d|
-          d.instance_exec &block if block
+        definition_for!(name, args.first).tap do |definition|
+          definition.instance_exec(&block) if block
         end
       end
 
       private
 
       def definition_for!(name, opts)
-        @file_definition[name] ||= FileDefinition.new( name, opts )
+        @file_definition[name] ||= FileDefinition.new(name, opts)
       end
     end
   end

data/lib/gtfs_reader/config/file_definition.rb

@@ -6,25 +6,26 @@ module GtfsReader
     class FileDefinition
       attr_reader :name
 
-      #@param name [String] The name of the file within the feed.
-      #@option opts [Boolean] :required (false)
-      #  If this file is required to be in the feed.
-      def initialize(name, opts={})
-        @name, @columns = name, {}
-        @opts = { required: false }.merge (opts || {})
+      # @param name [String] The name of the file within the feed.
+      # @option opts [Boolean] :required (false)
+      #   If this file is required to be in the feed.
+      def initialize(name, opts = {})
+        @name = name
+        @columns = {}
+        @opts = { required: false }.merge(opts || {})
       end
 
-      #@return [Boolean] If this file is required to be in the feed.
+      # @return [Boolean] If this file is required to be in the feed.
       def required?
         @opts[:required]
       end
 
-      #@return [String] The filename of this file within the GTFS feed.
+      # @return [String] The filename of this file within the GTFS feed.
       def filename
         "#{name}.txt"
       end
 
-      #@return [Column] The column with the given name
+      # @return [Column] The column with the given name
       def [](name)
         @columns[name]
       end
@@ -33,39 +34,39 @@ module GtfsReader
         @columns.values
       end
 
-      #@return [Array<Column>] The columns required to appear in this file.
+      # @return [Array<Column>] The columns required to appear in this file.
       def required_columns
-        columns.select &:required?
+        columns.select(&:required?)
       end
 
-      #@return [Array<Column>] The columns not required to appear in this file.
+      # @return [Array<Column>] The columns not required to appear in this file.
       def optional_columns
-        columns.reject &:required?
+        columns.reject(&:required?)
       end
 
-      #@return [Array<Column>] The columns which cannot have two rows with the
-      #  same value.
+      # @return [Array<Column>] The columns which cannot have two rows with the
+      #   same value.
       def unique_columns
-        columns.select &:unique?
+        columns.select(&:unique?)
       end
 
       # Creates a column with the given name.
       #
-      #@param name [String] The name of the column to define.
-      #@param args [Array] The first element of this args list is used as a
-      #  +Hash+ of options to create the new column with.
-      #@param block [Proc] An optional block used to parse the values of this
-      #  column on each row.
-      #@yieldparam input [String] The value of this column for a particular row.
-      #@yieldreturn Any kind of object.
-      #@return [Column] The newly created column.
+      # @param name [String] The name of the column to define.
+      # @param args [Array] The first element of this args list is used as a
+      #   +Hash+ of options to create the new column with.
+      # @param block [Proc] An optional block used to parse the values of this
+      #   column on each row.
+      # @yieldparam input [String] The value of this column for a particular row.
+      # @yieldreturn Any kind of object.
+      # @return [Column] The newly created column.
       def col(name, *args, &block)
         if @columns.key? name
-          @columns[name].parser &block if block_given?
+          @columns[name].parser(&block) if block_given?
           return @columns[name]
         end
 
-        @columns[name] = Column.new name, args.first, &block
+        @columns[name] = Column.new(name, args.first, &block)
       end
 
       # Creates an input-output proc to convert column values from one form to
@@ -75,19 +76,19 @@ module GtfsReader
       # known values. This helper creates such a proc from a given hash and
       # optional default.
       #
-      #@param default [] The value to return if there is no mapping for a given
-      #  input.
-      #@param reverse_map [Hash] A map of returns values to their input values.
+      # @param reverse_map [Hash] A map of returns values to their input values.
       #  This is in reverse because it looks better, like a list of labels:
       #  +{bus: 3, ferry: 4}+
-      def output_map(default=nil, reverse_map)
+      # @param default [] The value to return if there is no mapping for a given
+      #    input.
+      def output_map(reverse_map, default = nil)
         if reverse_map.values.uniq.length != reverse_map.values.length
           raise FileDefinitionError, "Duplicate values given: #{reverse_map}"
         end
 
-        map = default.nil? ? {} : Hash.new( default )
-        reverse_map.each { |k,v| map[v] = k }
-        map.method( :[] ).to_proc
+        map = default.nil? ? {} : Hash.new(default)
+        reverse_map.each { |k, v| map[v] = k }
+        map.method(:[]).to_proc
       end
     end
   end

data/lib/gtfs_reader/config/source.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/object/try'
 
 require_relative 'feed_definition'
 require_relative 'defaults/gtfs_feed_definition'
@@ -15,35 +16,35 @@ module GtfsReader
         @name = name
         @feed_definition = Config::Defaults::FEED_DEFINITION
         @feed_handler = FeedHandler.new {}
+        @url = nil
+        @before = nil
       end
 
-      #@param t [String] if given, will be used as the title of this source
-      #@return [String] the title of this source
-      def title(t=nil)
-        @title = t if t.present?
+      # @param title [String] if given, will be used as the title of this source
+      # @return [String] the title of this source
+      def title(title = nil)
+        @title = title if title.present?
         @title
       end
 
-      #@param u [String] if given, will be used as the URL for this source
-      #@return [String] the URL this source's ZIP file
-      def url(u=nil)
-        @url = u if u.present?
+      # @param url [String] if given, will be used as the URL for this source
+      # @return [String] the URL this source's ZIP file
+      def url(url = nil)
+        @url = url if url.present?
         @url
       end
 
       # Define a block to call before the source is read. If this block
       # returns +false+, cancel processing the source
       def before(&block)
-        if block_given?
-          @before = block
-        end
+        @before = block if block_given?
         @before
       end
 
       def feed_definition(&block)
         if block_given?
           @feed_definition = FeedDefinition.new.tap do |feed|
-            feed.instance_exec feed, &block
+            feed.instance_exec(feed, &block)
           end
         end
 
@@ -52,15 +53,16 @@ module GtfsReader
 
       def handlers(*args, &block)
         if block_given?
-          opts = Hash === args.last ? args.pop : {}
+          opts = args.last.try(:is_a?, Hash) ? args.pop : {}
           opts = opts.reverse_merge bulk: nil
           @feed_handler =
             if opts[:bulk]
-              BulkFeedHandler.new opts[:bulk], args, &block
+              BulkFeedHandler.new(opts[:bulk], args, &block)
             else
-              FeedHandler.new args, &block
+              FeedHandler.new(args, &block)
             end
         end
+
         @feed_handler
       end
     end

data/lib/gtfs_reader/config/sources.rb

@@ -8,18 +8,22 @@ module GtfsReader
       end
 
       def each(&block)
-        @sources.each &block
+        @sources.each(&block)
       end
 
       def [](key)
         @sources[key]
       end
 
-      def method_missing(name, *args, &block)
+      def method_missing(name, *_args, &block)
         (@sources[name] ||= Source.new name).tap do |src|
-          src.instance_exec src, &block if ::Kernel.block_given?
+          src.instance_exec(src, &block) if ::Kernel.block_given?
         end
       end
+
+      def respond_to_missing?(_name, _include_private = false)
+        true
+      end
     end
   end
 end

data/lib/gtfs_reader/configuration.rb

@@ -1,15 +1,14 @@
 module GtfsReader
   class Configuration
-
     # Creates simple configuration parameters which may be set by the user
-    #@param names [Array<Symbol>] the names of the parameters to create
+    # @param names [Array<Symbol>] the names of the parameters to create
     def parameter(*names)
       names.each do |name|
-        define_singleton_method name do |*values|
-          if value = values.first
-            instance_variable_set "@#{name}", value
+        define_singleton_method(name) do |*values|
+          if (value = values.first)
+            instance_variable_set("@#{name}", value)
           else
-            instance_variable_get "@#{name}"
+            instance_variable_get("@#{name}")
           end
         end
       end
@@ -17,9 +16,9 @@ module GtfsReader
 
     def block_parameter(name, obj_class, *init_args)
       obj = nil
-      define_singleton_method name do |*args, &block|
-        obj ||= obj_class.new *init_args
-        obj.instance_exec( obj, *args, &block ) if block
+      define_singleton_method(name) do |*args, &block|
+        obj ||= obj_class.new(*init_args)
+        obj.instance_exec(obj, *args, &block) if block
         obj
       end
     end

data/lib/gtfs_reader/core.rb

@@ -4,21 +4,22 @@ require_relative 'config/sources'
 require_relative 'source_updater'
 
 module GtfsReader
-  extend self
+  module_function
 
-  #@override config(*args, &blk)
+  # @override config(*args, &blk)
   #  @param args [Array] an array or arguments to pass to the given block
   #  @param blk [Proc] a block to to call in the context of the configuration
   #    object. Subsequent calls will use the same configuration for additional
   #    modification.
   #  @return [Configuration] the configuration object
   #
-  #@override config
+  # @override config
   #  @return [Configuration] the configuration object
   def config(*args, &blk)
     @cfg ||= create_config
+
     if block_given?
-      @cfg.instance_exec *args.unshift(@cfg), &blk
+      @cfg.instance_exec(*args.unshift(@cfg), &blk)
     elsif args.any?
       raise ArgumentError, 'arguments given without a block'
     end
@@ -26,24 +27,22 @@ module GtfsReader
   end
 
   def update_all!
-    config.sources.each {|name, _| update name }
+    config.sources.each { |name, _| update(name) }
   end
 
   def update(name)
     if config.verbose
-      update_verbosely name
+      update_verbosely(name)
     else
-      Log.quiet { update_verbosely name }
+      Log.quiet { update_verbosely(name) }
     end
   end
 
-  private
-
   def update_verbosely(name)
     source = config.sources[name]
     raise UnknownSourceError, "No source named '#{name}'" if source.nil?
 
-    updater = SourceUpdater.new name, source
+    updater = SourceUpdater.new(name, source)
     begin
       updater.instance_exec do
         Log.info { "Updating #{name.to_s.green}".underline }
@@ -67,11 +66,11 @@ module GtfsReader
   def create_config
     Configuration.new.tap do |cfg|
       cfg.instance_exec do
-        parameter :verbose
-        parameter :skip_parsing
-        parameter :return_hashes
-        block_parameter :sources, Config::Sources
-        block_parameter :feed_definition, Config::FeedDefinition
+        parameter(:verbose)
+        parameter(:skip_parsing)
+        parameter(:return_hashes)
+        block_parameter(:sources, Config::Sources)
+        block_parameter(:feed_definition, Config::FeedDefinition)
       end
     end
   end

data/lib/gtfs_reader/exceptions.rb

@@ -1,5 +1,4 @@
 module GtfsReader
-
   class FileReaderError < StandardError; end
 
   class RequiredColumnsMissing < FileReaderError

data/lib/gtfs_reader/feed_handler.rb

@@ -1,22 +1,22 @@
 module GtfsReader
   # This handler returns each row individually as it is read in from the source.
   class FeedHandler
-    def initialize(args=[], &block)
+    def initialize(args = [], &block)
       @read_callbacks = {}
-      FeedHandlerDsl.new(self).instance_exec *args, &block
+      FeedHandlerDsl.new(self).instance_exec(*args, &block)
     end
 
-    #@param filename [String] the name of the file to handle
-    #@return [Boolean] if this handler can handle the given filename
+    # @param filename [String] the name of the file to handle
+    # @return [Boolean] if this handler can handle the given filename
     def handler?(filename)
-      @read_callbacks.key? filename
+      @read_callbacks.key?(filename)
     end
 
     def handle_file(filename, enumerator)
-      enumerator.each &@read_callbacks[filename]
+      enumerator.each(&@read_callbacks[filename])
     end
 
-    def create_read_handler(filename, *args, &block)
+    def create_read_handler(filename, *_args, &block)
       @read_callbacks[filename] = block
     end
   end
@@ -27,7 +27,11 @@ module GtfsReader
     end
 
     def method_missing(filename, *args, &block)
-      @feed_handler.create_read_handler filename, *args, &block
+      @feed_handler.create_read_handler(filename, *args, &block)
+    end
+
+    def respond_to_missing?(_name, _include_private = false)
+      true
     end
   end
 end

data/lib/gtfs_reader/file_reader.rb

@@ -5,59 +5,59 @@ require_relative 'file_row'
 module GtfsReader
   CSV_OPTIONS = { headers: :first_row,
                   return_headers: true,
-                  header_converters: :symbol }
+                  header_converters: :symbol }.freeze
 
   # Iterates over the rows in a single file using a provided definition.
-  #@see #each
+  # @see #each
   class FileReader
     include Enumerable
 
     attr_reader :definition, :columns, :col_names
 
-    #@param data [IO,String] CSV data
-    #@param definition [FileDefinition] describes the expected columns in this
-    #  file
-    def initialize(data, definition, opts={})
-      opts = { parse: true, validate: false, hash: true }.merge opts
+    # @param data [IO,String] CSV data
+    # @param definition [FileDefinition] describes the expected columns in this
+    #   file
+    def initialize(data, definition, opts = {})
+      opts = { parse: true, validate: false, hash: true }.merge(opts)
 
-      @csv = CSV.new data, CSV_OPTIONS
-      @definition, @do_parse, @return_hash =
-        definition, opts[:parse], opts[:hash]
+      @csv = CSV.new(data, CSV_OPTIONS)
+      @definition = definition
+      @do_parse = opts[:parse]
+      @return_hash = opts[:hash]
       @index = 0
       @csv_headers = @csv.shift.headers
-      @columns = find_columns opts[:validate]
+      @columns = find_columns(opts[:validate])
     end
 
     def filename
       @definition.filename
     end
 
-    #@overload each(&blk)
-    #  @yieldparam hash [Hash] a hash of columns to their values in this row
-    #@overload each
-    #  @return [Enumerator] an {::Enumerator} that iterates of the rows in the
-    #    file
-    #@see FileRow#to_hash
+    # @overload each(&blk)
+    #   @yieldparam hash [Hash] a hash of columns to their values in this row
+    # @overload each
+    #   @return [Enumerator] an {::Enumerator} that iterates of the rows in the
+    #     file
+    # @see FileRow#to_hash
     def each
-      return to_enum :each unless block_given?
+      return to_enum(:each) unless block_given?
 
-      while row = shift
+      while (row = shift)
         yield(@return_hash ? row.to_hash : row.to_a)
       end
     end
 
-    #@return [FileRow,nil] the next row from the file, or +nil+ if the end of
+    # @return [FileRow,nil] the next row from the file, or +nil+ if the end of
     #  the file has been reached.
     def shift
-      if row = @csv.shift
-        file_row(row).tap { @index += 1 }
-      end
+      row = @csv.shift
+      file_row(row).tap { @index += 1 } if row
     end
 
     private
 
     def file_row(row)
-      FileRow.new @index, @col_names, row, @definition, @do_parse
+      FileRow.new(@index, @col_names, row, @definition, @do_parse)
     end
 
     # Check the list of headers in the file against the expected columns in
@@ -70,31 +70,31 @@ module GtfsReader
       unless required.empty?
         Log.info { "#{prefix} #{'required columns'.magenta}" } if validate
 
-        missing = check_columns validate, prefix, required, :green, :red
+        missing = check_columns(validate, prefix, required, :green, :red)
         raise RequiredColumnsMissing, missing if validate && missing.present?
       end
 
       optional = @definition.optional_columns
       unless optional.empty?
         Log.info { "#{prefix} #{'optional columns'.cyan}" } if validate
-        check_columns validate, prefix, optional, :cyan, :light_yellow
+        check_columns(validate, prefix, optional, :cyan, :light_yellow)
       end
 
-      cols = @definition.columns.collect( &:name )
-      headers = @csv_headers.select {|h| cols.include? h }
+      cols = @definition.columns.collect(&:name)
+      headers = @csv_headers.select { |h| cols.include?(h) }
 
-      @col_names ||= @found_columns.map &:name
-      ::Hash[ *headers.inject([]) {|list,c| list << c << @definition[c] } ]
+      @col_names ||= @found_columns.map(&:name)
+      ::Hash[*headers.inject([]) { |list, c| list << c << @definition[c] }]
     end
 
     def check_columns(validate, prefix, expected, found_color, missing_color)
-      check = '✔'.colorize found_color
-      cross = '✘'.colorize missing_color
+      check = '✔'.colorize(found_color)
+      cross = '✘'.colorize(missing_color)
 
       expected.map do |col|
         name = col.name
         missing =
-          if @csv_headers.include? name
+          if @csv_headers.include?(name)
             @found_columns << col
             nil
           else
@@ -112,9 +112,7 @@ module GtfsReader
     end
 
     def column_width
-      @column_width ||= @definition.columns.collect( &:name ).max do |a, b|
-        a.length <=> b.length
-      end.length
+      @column_width ||= @definition.columns.collect(&:name).max_by(&:length).length
     end
   end
 end