Class: GtfsReader::Config::FileDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/gtfs_reader/config/file_definition.rb

Overview

Describes a single file in a GTFS feed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, opts = {}) ⇒ FileDefinition

Returns a new instance of FileDefinition.

Parameters:

  • name (String) —

    The name of the file within the feed.

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :required (Boolean) — default: false —

    If this file is required to be in the feed.



12
13
14
15
16
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 12

def initialize(name, opts = {})
  @name = name
  @columns = {}
  @opts = { required: false }.merge(opts || {})
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 7

def name
  @name
end

Instance Method Details

#[](name) ⇒ Column

Returns The column with the given name.

Returns:

  • (Column) —

    The column with the given name



29
30
31
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 29

def [](name)
  @columns[name]
end

#col(name, *args, &block) {|input| ... } ⇒ Column

Creates a column with the given name.

Parameters:

  • name (String) —

    The name of the column to define.

  • args (Array) —

    The first element of this args list is used as a Hash of options to create the new column with.

  • block (Proc) —

    An optional block used to parse the values of this column on each row.

Yield Parameters:

  • input (String) —

    The value of this column for a particular row.

Yield Returns:

  • Any kind of object.

Returns:

  • (Column) —

    The newly created column.



63
64
65
66
67
68
69
70
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 63

def col(name, *args, &block)
  if @columns.key? name
    @columns[name].parser(&block) if block_given?
    return @columns[name]
  end

  @columns[name] = Column.new(name, args.first, &block)
end

#columns ⇒ Object 



33
34
35
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 33

def columns
  @columns.values
end

#filename ⇒ String

Returns The filename of this file within the GTFS feed.

Returns:

  • (String) —

    The filename of this file within the GTFS feed.



24
25
26
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 24

def filename
  "#{name}.txt"
end

#optional_columns ⇒ Array<Column>

Returns The columns not required to appear in this file.

Returns:

  • (Array<Column>) —

    The columns not required to appear in this file.



43
44
45
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 43

def optional_columns
  columns.reject(&:required?)
end

#output_map(reverse_map, default = nil) ⇒ Object

Creates an input-output proc to convert column values from one form to another.

Many parser procs simply map a set of known values to another set of known values. This helper creates such a proc from a given hash and optional default.

Parameters:

  • 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}

  • default (defaults to: nil) —

    The value to return if there is no mapping for a given

    input.



84
85
86
87
88
89
90
91
92
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 84

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
end

#required? ⇒ Boolean

Returns If this file is required to be in the feed.

Returns:

  • (Boolean) —

    If this file is required to be in the feed.



19
20
21
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 19

def required?
  @opts[:required]
end

#required_columns ⇒ Array<Column>

Returns The columns required to appear in this file.

Returns:

  • (Array<Column>) —

    The columns required to appear in this file.



38
39
40
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 38

def required_columns
  columns.select(&:required?)
end

#unique_columns ⇒ Array<Column>

Returns The columns which cannot have two rows with the same value.

Returns:

  • (Array<Column>) —

    The columns which cannot have two rows with the same value.



49
50
51
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 49

def unique_columns
  columns.select(&:unique?)
end