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.



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

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

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

Instance Method Details

#[](name) ⇒ Column

Returns The column with the given name.

Returns:

  • (Column) —

    The column with the given name



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

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.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 64

def col(name, *args, &block)
  name = @aliases[name] if @aliases.key? name

  if @columns.key? name
    @columns[name].parser &block if block_given?
    return @columns[name]
  end

  (@columns[name] = Column.new name, args.first, &block).tap do |col|
    @aliases[col.alias] = name if col.alias
  end
end

#columns ⇒ Object 



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

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.



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

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.



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

def optional_columns
  columns.reject &:required?
end

#output_map(default = nil, reverse_map) ⇒ 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:

  • default (defaults to: nil) —

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

    input.

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



100
101
102
103
104
105
106
107
108
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 100

def output_map(default=nil, reverse_map)
  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

#prefix(sym, &blk) ⇒ Object

Starts a new block within which any defined columns will have the given sym prefixed to its name (joined with an underscore). Also, the defined name given within the block will be aliased to the column.

Examples:

Create a column route_name with the alias name

prefix( :route ) { name }

Parameters:

  • sym —

    the prefix to prefixed to each column within the block



84
85
86
 
# File 'lib/gtfs_reader/config/file_definition.rb', line 84

def prefix(sym, &blk)
  PrefixedColumnSetter.new(self, sym.to_s).instance_exec &blk
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.



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

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.



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

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.



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

def unique_columns
  columns.select &:unique?
end