Class: GtfsDf::Reader

Inherits:
Object
  • Object
show all
Defined in:
lib/gtfs_df/reader.rb

Class Method Summary collapse

Class Method Details

.load_from_dir(dir_path, parse_times: false, relevant_files: nil) ⇒ Feed

Loads a GTFS dir and returns a Feed

Parameters:

  • dir_path (String) —

    Path to the GTFS directory

  • parse_times (Boolean) (defaults to: false) —

    Whether to parse time fields to seconds since midnight (default: false)

  • relevant_files (Array<String>) (defaults to: nil) —

    A list of file names, useful to avoid loading tables you don’t care about.

Returns:

  • (Feed) —

    The loaded GTFS feed



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/gtfs_df/reader.rb', line 52

def self.load_from_dir(dir_path, parse_times: false, relevant_files: nil)
  relevant_files ||= GtfsDf::Feed::GTFS_FILES.map { |name| "#{name}.txt" }
  relevant_files = relevant_files.to_set

  data = {}
  GtfsDf::Feed::GTFS_FILES.each do |gtfs_file|
    basename = "#{gtfs_file}.txt"
    path = File.join(dir_path, basename)
    next unless relevant_files.include?(basename) && File.exist?(path)

    data[gtfs_file] = data_frame(gtfs_file, path)
  end

  GtfsDf::Feed.new(data, parse_times: parse_times)
end

.load_from_zip(zip_path, parse_times: false, relevant_files: nil) ⇒ Feed

Loads a GTFS zip file and returns a Feed

Parameters:

  • zip_path (String) —

    Path to the GTFS zip file

  • parse_times (Boolean) (defaults to: false) —

    Whether to parse time fields to seconds since midnight (default: false)

  • relevant_files (Array<String>) (defaults to: nil) —

    A list of file names, useful to avoid loading tables you don’t care about.

Returns:

  • (Feed) —

    The loaded GTFS feed



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/gtfs_df/reader.rb', line 11

def self.load_from_zip(zip_path, parse_times: false, relevant_files: nil)
  data = nil

  relevant_files ||= GtfsDf::Feed::GTFS_FILES.map { |name| "#{name}.txt" }
  relevant_files = relevant_files.to_set

  seen = {}

  Dir.mktmpdir do |tmpdir|
    Zip::File.open(zip_path) do |zip_file|
      zip_file.each do |entry|
        # Extract files in nested directories into the root of the tmpdir
        file_name = File.basename(entry.name)

        if seen[file_name]
          raise GtfsDf::Error, "Found multiple instances of the same file: #{seen[file_name]} and #{entry.name}"
        end

        # We're skipping:
        # - unrelated files
        # - empty feed files
        next unless relevant_files.include?(file_name) && has_header?(entry)

        seen[file_name] = entry.name

        entry.extract(file_name, destination_directory: tmpdir)
      end
    end

    data = load_from_dir(tmpdir, parse_times:, relevant_files:)
  end

  data
end