atco 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 215cf54f3257e776c20d54d0177731f06cf62eda409e7763457c709757aa1a52
-  data.tar.gz: 97ebd8cf82c779b872f23204079a230aae0d9b159bacdf3db5042cada877a197
+  metadata.gz: 59b747dbf14f2f4ab07ca86c8344fda6294efbf4d7b83cdd11fcfa45a9e4961b
+  data.tar.gz: 276916993eae21683270e35ba8d4d167820eb2ae65dd410ab535f94a7ba50134
 SHA512:
-  metadata.gz: 69b1de96881df1044138cbebe82ea3e22053c47d36aa38dbb39c1018683675eb44e27619be1d29346d5ef156f924c3ee8e408808aec11b7940ad2ca4877dfc25
-  data.tar.gz: d14f0b410610dbaf1d2e4e80ce41703becb6fddc99c06bbe3a88500d65bde6b3b44bdfa7768405682c654abf8cb0ecb5470a7589b7f6b978f0933db2e230736e
+  metadata.gz: 54cf093ae098cc2fbc2b38067ffeeec9fa7a513107b00a4cb7822b8c0b65e273b016be3465dffed59403a9f88ce9f4cfb3c750236fb8c1354ffa9347511b26ca
+  data.tar.gz: 92c5635e38a717f4ba9f0e036d081463b4d84bb5bd3d1788d99b191b54e8bcd09f6a44bc114f5495302a191fc47b8887f8c97934696c7a5b6f3ad9d6217fc544

data/lib/atco/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Atco
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

data/lib/atco.rb

@@ -9,6 +9,8 @@ require_relative "atco/version"
 
 # Public: Atco is a module that provides a parser for the ATCO-CIF data format.
 module Atco # rubocop:disable Metrics/ModuleLength
+  class UnidentifiedRecordError < StandardError; end
+
   class << self # rubocop:disable Metrics/ClassLength
     @path = nil
     METHODS = {
@@ -21,6 +23,7 @@ module Atco # rubocop:disable Metrics/ModuleLength
       origin: "QO",
       journey_header: "QS"
     }.freeze
+    METHODS_BY_RECORD_IDENTITY = METHODS.invert.freeze
 
     def parse(file) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       @path = File.expand_path(file)
@@ -32,13 +35,20 @@ module Atco # rubocop:disable Metrics/ModuleLength
       locations = []
       journeys = {}
       header = nil
+      unparsed = []
 
-      data.each do |line|
+      data.each_with_index do |line, line_number| # rubocop:disable Metrics/BlockLength
         if line == data.first
           header = parse_header(line)
           next
         end
-        METHODS.each do |method, identifier|
+
+        identifier = line[0, 2]
+        method = METHODS_BY_RECORD_IDENTITY[identifier]
+
+        begin
+          raise UnidentifiedRecordError, "Unidentified record: #{identifier}" unless method
+
           object = send("parse_#{method}", line)
           next unless object[:record_identity] && object[:record_identity] == identifier
 
@@ -59,9 +69,12 @@ module Atco # rubocop:disable Metrics/ModuleLength
             end
           end
           objects << object
+        rescue UnidentifiedRecordError
+          unparsed << {line: line, line_number: line_number}
+          next
         end
       end
-      { header: header, locations: locations, journeys: journeys }
+      { header: header, locations: locations, journeys: journeys, unparsed: unparsed }
     end
 
     def parse_header(string)

data/spec/atco_spec.rb

@@ -1,175 +1,217 @@
 # frozen_string_literal: true
 
-require "#{File.dirname(__FILE__)}/spec_helper"
 require "json"
 
-describe Atco do # rubocop:disable Metrics/BlockLength
+RSpec.describe Atco do # rubocop:disable Metrics/BlockLength
   it "has a version number" do
     expect(Atco::VERSION).not_to be nil
   end
 
-  it "should output file for debugging!" do
-    result = Atco.parse("spec/fixtures/example.cif")
-    File.open("test.output", "w+") do |f|
-      f.flush
-      f.write(JSON.pretty_generate(result))
-    end
-  end
-
   it "should parse header from fixture" do
     result = Atco.parse("spec/fixtures/example.cif")
-    expect result[:header] == {
-      file_type: "ATCO-CIF",
-      file_originator: "Electronic Registration",
-      source_product: "MIA 4.20.18",
-      version: "5.0",
-      production_datetime: "20090915113809"
-    }
+    expect(result[:header]).to eq(
+      {
+        file_type: "ATCO-CIF",
+        file_originator: "Electronic Registration",
+        source_product: "MIA 4.20.18",
+        version: "5.0",
+        production_datetime: "20090915113809"
+      }
+    )
   end
 
   it "should parse locations from fixture" do
     result = Atco.parse("spec/fixtures/example.cif")
-    expect result[:header] == {
-      file_type: "ATCO-CIF",
-      file_originator: "Electronic Registration",
-      source_product: "MIA 4.20.18",
-      version: "5.0",
-      production_datetime: "20090915113809"
-    }
+    expect(result[:header]).to eq(
+      {
+        file_type: "ATCO-CIF",
+        file_originator: "Electronic Registration",
+        source_product: "MIA 4.20.18",
+        version: "5.0",
+        production_datetime: "20090915113809"
+      }
+    )
   end
 
   it "should parse header" do
-    expect Atco.parse_header("ATCO-CIF0500Electronic Registration         MIA 4.20.18     20090915113809\r\n") == {
-      file_type: "ATCO-CIF",
-      version: "5.0",
-      file_originator: "Electronic Registration",
-      source_product: "MIA 4.20.18",
-      production_datetime: "20090915113809"
-    }
+    expect(Atco.parse_header("ATCO-CIF0500Electronic Registration         MIA 4.20.18     20090915113809\r\n")).to eq(
+      {
+        file_type: "ATCO-CIF",
+        version: "5.0",
+        file_originator: "Electronic Registration",
+        source_product: "MIA 4.20.18",
+        production_datetime: "20090915113809"
+      }
+    )
   end
 
   it "should parse bank holiday" do
-    expect Atco.parse_bank_holiday("QHN20061225") == {
-      record_identity: "QH",
-      transaction_type: "N",
-      date_of_bank_holiday: "20061225"
-    }
+    expect(Atco.parse_bank_holiday("QHN20061225")).to eq(
+      {
+        record_identity: "QH",
+        transaction_type: "N",
+        date_of_bank_holiday: "20061225"
+      }
+    )
   end
 
   it "should parse operator" do
-    expect Atco.parse_operator("QPNTM  Translink Metro         Translink Metro           \r\n") == {
-      record_identity: "QP",
-      transaction_type: "N",
-      operator: "TM",
-      operator_short_form: "Translink Metro",
-      operator_legal_name: "Translink Metro"
-    }
+    expect(Atco.parse_operator("QPNTM  Translink Metro         Translink Metro           \r\n")).to eq(
+      {
+        record_identity: "QP",
+        transaction_type: "N",
+        operator: "TM",
+        operator_short_form: "Translink Metro",
+        operator_legal_name: "Translink Metro"
+      }
+    )
   end
 
   it "should parse additional location information" do
-    expect Atco.parse_additional_location_info("QBN700000001252  328622  367433      \r\n") == {
-      record_identity: "QB",
-      transaction_type: "N",
-      location: "700000001252",
-      grid_reference_easting: "328622",
-      grid_reference_northing: "367433"
-    }
+    expect(Atco.parse_additional_location_info("QBN700000001252  328622  367433      \r\n")).to eq(
+      {
+        record_identity: "QB",
+        transaction_type: "N",
+        location: "700000001252",
+        grid_reference_easting: "328622",
+        grid_reference_northing: "367433"
+      }
+    )
   end
 
   it "should parse location" do
-    expect Atco.parse_location("QLN700000001252Conway (River Rd)                               1\r\n") == {
-      record_identity: "QL",
-      transaction_type: "N",
-      location: "700000001252",
-      full_location: "Conway (River Rd)",
-      gazetteer_code: "1"
-    }
+    expect(Atco.parse_location("QLN700000001252Conway (River Rd)                               1\r\n")).to eq(
+      {
+        record_identity: "QL",
+        transaction_type: "N",
+        location: "700000001252",
+        full_location: "Conway (River Rd)",
+        gazetteer_code: "1"
+      }
+    )
   end
 
   # QT7000000012520605   T1F0
   it "should parse destination" do
-    expect Atco.parse_destination("QT7000000012520605   T1F0\r\n") == {
-      record_identity: "QT",
-      location: "700000001252",
-      published_arrival_time: "0605",
-      bay_number: "",
-      timing_point_indicator: "T1",
-      fare_stage_indicator: "F0"
-    }
+    expect(Atco.parse_destination("QT7000000012520605   T1F0\r\n")).to eq(
+      {
+        record_identity: "QT",
+        location: "700000001252",
+        published_arrival_time: "0605",
+        bay_number: "",
+        timing_point_indicator: "T1",
+        fare_stage_indicator: "F0"
+      }
+    )
   end
 
   it "should parse intermediate" do
-    expect Atco.parse_intermediate("QI70000000125607120712B   T1F0\r\n") == {
-      record_identity: "QI",
-      location: "700000001256",
-      published_arrival_time: "0712",
-      published_departure_time: "0712",
-      activity_flag: "B",
-      bay_number: "",
-      timing_point_indicator: "T1",
-      fare_stage_indicator: "F0"
-    }
+    expect(Atco.parse_intermediate("QI70000000125607120712B   T1F0\r\n")).to eq(
+      {
+        record_identity: "QI",
+        location: "700000001256",
+        published_arrival_time: "0712",
+        published_departure_time: "0712",
+        activity_flag: "B",
+        bay_number: "",
+        timing_point_indicator: "T1",
+        fare_stage_indicator: "F0"
+      }
+    )
   end
 
   it "should parse origin" do
-    expect Atco.parse_origin("QO7000000012520730   T1F0\r\n") == {
-      record_identity: "QO",
-      location: "700000001252",
-      published_departure_time: "0730",
-      bay_number: "",
-      timing_point_indicator: "T1",
-      fare_stage_indicator: "F0"
-    }
+    expect(Atco.parse_origin("QO7000000012520730   T1F0\r\n")).to eq(
+      {
+        record_identity: "QO",
+        location: "700000001252",
+        published_departure_time: "0730",
+        bay_number: "",
+        timing_point_indicator: "T1",
+        fare_stage_indicator: "F0"
+      }
+    )
   end
 
   it "should parse journey header" do
-    expect Atco.parse_journey_header("QSNTM  13986520091005        1111100  9A  9018  0               I\r\n") == {
-      record_identity: "QS",
-      transaction_type: "N",
-      operator: "TM",
-      unique_journey_identifier: "139865",
-      first_date_of_operation: "20091005",
-      last_date_of_operation: "",
-      operates_on_mondays: "1",
-      operates_on_tuesdays: "1",
-      operates_on_wednesdays: "1",
-      operates_on_thursdays: "1",
-      operates_on_fridays: "1",
-      operates_on_saturdays: "0",
-      operates_on_sundays: "0",
-      school_term_time: "",
-      bank_holidays: "",
-      route_number: "9A",
-      running_board: "9018",
-      vehicle_type: "0",
-      registration_number: "",
-      route_direction: "I"
-    }
+    expect(Atco.parse_journey_header("QSNTM  13986520091005        1111100  9A  9018  0               I\r\n")).to eq(
+      {
+        record_identity: "QS",
+        transaction_type: "N",
+        operator: "TM",
+        unique_journey_identifier: "139865",
+        first_date_of_operation: "20091005",
+        last_date_of_operation: "",
+        operates_on_mondays: "1",
+        operates_on_tuesdays: "1",
+        operates_on_wednesdays: "1",
+        operates_on_thursdays: "1",
+        operates_on_fridays: "1",
+        operates_on_saturdays: "0",
+        operates_on_sundays: "0",
+        school_term_time: "",
+        bank_holidays: "",
+        route_number: "9A",
+        running_board: "9018",
+        vehicle_type: "0",
+        registration_number: "",
+        route_direction: "I"
+      }
+    )
   end
 
-  describe "with example.cif" do
+  describe "with example.cif" do # rubocop:disable Metrics/BlockLength
     before(:all) do
       @atco = Atco.parse("spec/fixtures/example.cif")
     end
 
     it "should parse 1 journey" do
-      expect @atco[:journeys].size == 1
+      expect(@atco[:journeys].size).to eq(1)
     end
 
     it "should parse journeys into Atco::Joruney objects" do
       expect(@atco[:journeys]["139748"]).to be_a_kind_of(Atco::Journey)
     end
 
-    it "should parse 6 stops for joureny 139748" do
-      expect @atco[:journeys]["139748"].stops.size == 6
+    it "should parse 6 stops for journey 139748" do
+      expect(@atco[:journeys]["139748"].stops.size).to eq(6)
     end
 
-    it "should parse 6 stops for joureny 139748" do
-      expect @atco[:journeys]["139748"].stops.size == 6
+    it "should parse 2 locations" do
+      expect(@atco[:locations].size).to eq(2)
     end
 
-    it "should parse 2 locations" do
-      expect @atco[:locations].size == 2
+    it "should output file as JSON" do
+      output = File.join(File.dirname(__FILE__), "artefacts", "test.json")
+      File.open(output, "w+") do |f|
+        f.flush
+        f.write(JSON.pretty_generate(@atco))
+      end
+
+      expect(File.exist?(output)).to be true
+
+      data = File.read(output)
+      json = JSON.parse(data)
+      expect(json).to be_a(Hash)
     end
+
+    it "should return 17 unparsed lines" do
+      expect(@atco[:unparsed].size).to eq(17)
+    end
+
+    it "should not parse GS records" do
+      expect(@atco[:unparsed][0]).to eq({
+        line: "GS00001433 N                    Belfast Metro Ops                                 7000\n",
+        line_number: 3
+      })
+    end
+
+    it "should not parse GR records" do
+      expect(@atco[:unparsed][1]).to eq({
+        line: "GR00001433Donegall Square East                                                                                7000\n",
+        line_number: 4
+      })
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
-require "rubygems"
-require "rspec"
+require "atco"
 
-require "#{File.dirname(__FILE__)}/../lib/atco"
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atco
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - David Rice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake