atco 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ddb4c619b9d60d92fa99bc37e0df7f1181e5f42d6e001757284077eadbc597b
-  data.tar.gz: d5c8ebaa0bcec7f07a447a78e20d77727926de121616b700103fb06719cd2c1f
+  metadata.gz: 15e9812933c6ca6dcc275bd1f262a30c4b916a12feedf824ce9c4f55f7d24825
+  data.tar.gz: 36e55b87cdaa72cdd1601f87ab10e9937f7ba4d6ea8fdcf174bb5f20603978c2
 SHA512:
-  metadata.gz: bae3d2d4b0ace8e394497fba4457f76135940198b10fa05a630ff789efaec217d85cc87406dfca5e338c9aa1e16ee2dd4f62fd039c39066c9235c8b888e9368c
-  data.tar.gz: 44e57ff1c7f56a5b0e1930f2a1fbbd6ec22490fd25608d713f760194520639e509015d38d900587021854d8fbc9160233dbf852d0d1bb2df2d684b3915e18114
+  metadata.gz: 72580053068ad316cf22e9d262dbc8d0013a80aa5cde5de3160270fc9727850332df69ef94503f04a913e5f704f381558e361ddb5db857f0e9ae2d373a3fdbe5
+  data.tar.gz: e8450ac692fc998e2a1a735f243666abf7a82701a667b6569c307fc13869b30fabfa7ade64988feed77f30381f52d8972534436fcedeb987f1357c1decb71b44

data/README.md

@@ -5,34 +5,37 @@ ATCO-CIF is the format of choice for UK public transport authorities. This is a
 * ATCO (Association of Transport Coordinating Officers)
 * CIF (Common Interface File)
 
-* **Official spec:** [http://www.pti.org.uk/CIF/atco-cif-spec.pdf](http://www.pti.org.uk/CIF/atco-cif-spec.pdf)
+* **Official spec:** ~~[http://www.pti.org.uk/CIF/atco-cif-spec.pdf](http://www.pti.org.uk/CIF/atco-cif-spec.pdf)~~
+* **NOTE**: official spec is no-longer available from the above URL but can be found on archive.org
+* A copy of the [atco-cif-spec.pdf](http://github.com/davidjrice/atco/blob/master/docs/atco-cif-spec.pdf) is included in the `docs` folder in this repo
 
 ### USAGE
 
-Currently this library is under-development and has several things left to do before it is perfect (see the [todo.md](http://github.com/davidjrice/atco/blob/master/TODO.md) list ).
+Currently this library is under-development and has several things left to do before it is perfect (see the [TODO.md](http://github.com/davidjrice/atco/blob/master/TODO.md) list ).
 
-* clone this library
-* start an irb session
-* put the cif file in ./data (needs to change from being hardcoded)
+* clone this library `git clone git@github.com:davidjrice/atco.git`
+* or install the gem `gem install atco`
+* start an irb session (with the helper console command) `bin/console`
 
 Code example, for more detailed internal api usage see the spec files.
 
 
 ```ruby
-gem install atco
-irb
+require "rubygems"
+require "atco"
 
-
-require 'rubygems'
-require 'atco'
-
-result = Atco.parse('filename.cif')
-result = Atco.parse('SVRTMAO009A-20091005.cif) # an example data file in the repo
+result = Atco.parse("filename.cif")
+result = Atco.parse("data/SVRTMAO009A-20091005.cif")
 
 => {
-  header: {…},
-  locations: […],
-  journies: {…}
+  header: {…}, # Atco::Header
+  locations: […], # Atco::Location
+  journeys: {
+    "journey_identifier": {…} # Atco::Journey
+  },
+  unparsed: [
+    {line: "unparsed line", line_number:1234}
+  ]
 }
 ```
 

data/lib/atco/header.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Atco
+  # Atco::Header is a class to abstract ATCO-CIF Header data.
+  class Header
+    attr_accessor :file_type,
+                  :version,
+                  :file_originator,
+                  :source_product,
+                  :production_datetime
+
+    # Public: Parse a header line from an ATCO-CIF file.
+    # EXAMPLE:
+    # "ATCO-CIF0500Electronic Registration         MIA 4.20.18     20090915113809\r\n"
+    def self.parse(line)
+      data = {
+        file_type: line[0, 8],
+        version: "#{line[8, 2].to_i}.#{line[10, 2].to_i}",
+        file_originator: line[12, 32].strip!,
+        source_product: line[44, 16].strip!,
+        production_datetime: line[60, 14]
+      }
+      new(data)
+    end
+
+    def initialize(data)
+      @file_type = data[:file_type]
+      @version = data[:version]
+      @file_originator = data[:file_originator]
+      @source_product = data[:source_product]
+      @production_datetime = data[:production_datetime]
+    end
+
+    def attributes
+      {
+        file_type: @file_type,
+        version: @version,
+        file_originator: @file_originator,
+        source_product: @source_product,
+        production_datetime: @production_datetime
+      }
+    end
+
+    def to_json(*attrs)
+      attributes.to_json(*attrs)
+    end
+  end
+end

data/lib/atco/version.rb

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

data/lib/atco.rb

@@ -2,6 +2,7 @@
 
 require "open3"
 require "tempfile"
+require_relative "atco/header"
 require_relative "atco/location"
 require_relative "atco/journey"
 require_relative "atco/stop"
@@ -29,7 +30,6 @@ module Atco # rubocop:disable Metrics/ModuleLength
       @path = File.expand_path(file)
       data = File.readlines(@path)
 
-      objects = []
       current_journey = nil
       current_location = nil
       locations = []
@@ -39,7 +39,7 @@ module Atco # rubocop:disable Metrics/ModuleLength
 
       data.each_with_index do |line, line_number| # rubocop:disable Metrics/BlockLength
         if line_number.zero?
-          header = parse_header(line)
+          header = Header.parse(line)
           next
         end
 
@@ -68,26 +68,14 @@ module Atco # rubocop:disable Metrics/ModuleLength
               journeys[current_journey[:unique_journey_identifier]] = Journey.new(object)
             end
           end
-          objects << object
         rescue UnidentifiedRecordError
           unparsed << { line: line, line_number: line_number }
           next
         end
-        objects << object
       end
       { header: header, locations: locations, journeys: journeys, unparsed: unparsed }
     end
 
-    def parse_header(string)
-      {
-        file_type: string[0, 8],
-        version: "#{string[8, 2].to_i}.#{string[10, 2].to_i}",
-        file_originator: string[12, 32].strip!,
-        source_product: string[44, 16].strip!,
-        production_datetime: string[60, 14]
-      }
-    end
-
     def parse_bank_holiday(string)
       {
         record_identity: string[0, 2],

data/spec/atco_spec.rb

@@ -1,50 +1,10 @@
 # frozen_string_literal: true
 
-require "json"
-
 RSpec.describe Atco do # rubocop:disable Metrics/BlockLength
   it "has a version number" do
     expect(Atco::VERSION).not_to be nil
   end
 
-  it "should parse header from fixture" do
-    result = Atco.parse("spec/fixtures/example.cif")
-    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]).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")).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")).to eq(
       {
@@ -159,62 +119,4 @@ RSpec.describe Atco do # rubocop:disable Metrics/BlockLength
       }
     )
   end
-
-  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).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 journey 139748" do
-      expect(@atco[:journeys]["139748"].stops.size).to eq(6)
-    end
-
-    it "should parse 2 locations" do
-      expect(@atco[:locations].size).to eq(2)
-    end
-
-    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", # rubocop:disable Layout/LineLength
-          line_number: 4
-        }
-      )
-    end
-  end
 end

data/spec/integration/translink_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+RSpec.describe "with example.cif" do # rubocop:disable Metrics/BlockLength
+  before(:all) do
+    @atco = Atco.parse("spec/fixtures/translink-example.cif")
+  end
+
+  it "should parse header from fixture" do
+    expect(@atco[:header].attributes).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 1 journey" do
+    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 journey 139748" do
+    expect(@atco[:journeys]["139748"].stops.size).to eq(6)
+  end
+
+  it "should parse 2 locations" do
+    expect(@atco[:locations].size).to eq(2)
+  end
+
+  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", # rubocop:disable Layout/LineLength
+        line_number: 4
+      }
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "atco"
+require "json"
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

data/spec/unit/header_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.describe Atco::Header do
+  before(:all) do
+    line = "ATCO-CIF0500Electronic Registration         MIA 4.20.18     20090915113809\r\n"
+    @header = Atco::Header.parse(line)
+  end
+
+  it "should be a Header object" do
+    expect(@header).to be_a_kind_of(Atco::Header)
+  end
+
+  it "should parse header to attributes" do
+    expect(@header.attributes).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 header to json" do
+    expect(@header.to_json).to eq(
+      "{\"file_type\":\"ATCO-CIF\",\"version\":\"5.0\",\"file_originator\":\"Electronic Registration\",\"source_product\":\"MIA 4.20.18\",\"production_datetime\":\"20090915113809\"}" # rubocop:disable Metrics/LineLength
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atco
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.9
 platform: ruby
 authors:
 - David Rice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -49,14 +49,17 @@ files:
 - README.md
 - Rakefile
 - lib/atco.rb
+- lib/atco/header.rb
 - lib/atco/journey.rb
 - lib/atco/location.rb
 - lib/atco/stop.rb
 - lib/atco/version.rb
 - spec/atco_spec.rb
-- spec/fixtures/example.cif
 - spec/fixtures/example.json
+- spec/fixtures/translink-example.cif
+- spec/integration/translink_spec.rb
 - spec/spec_helper.rb
+- spec/unit/header_spec.rb
 homepage: http://github.com/davidjrice/atco
 licenses:
 - MIT