atco 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d4d697f6d487218aa3def133f0104257141ed8fb18b93be2c3f0c52ac92a6e
-  data.tar.gz: 213d51b686a0076c69f26b6d18173dd2b767eaf24db17f7e0cdc011406b94705
+  metadata.gz: 82cd5858676f7202932ecbe6d68846066019bd75c5637c33a44ec3eaf83fe599
+  data.tar.gz: 144dad716574ca9f45f63170193de8c1115edc6a4ece1557516c57e9d1d250a3
 SHA512:
-  metadata.gz: fb0ccef50c6a0490c9b87b0b01a7179bec8ca755d594f52193ef6220ef6733e2c8ed600f46043c3a0a38038f3290a8687f1828adfe893dac7dad5c7413b23c89
-  data.tar.gz: 6ba15c31b4cfb1873577af0fe50c62c6325780d9f9c3c6ddb124cfe91397dd2808382757f1198f492ea6fbbe2a21131e010b49ac80a757f33041a3ff57db1d9f
+  metadata.gz: 947c0a1bbfa755bacb1d907c50f90720e98dcebfef88d500b6e418c652827846ea2c32372e8aed4fdd8e1e4aad71ce9f61acd1f0c51b0dd68bd696d1e9774a98
+  data.tar.gz: 9556d7e0bc6cd268b326475c03c3136a59f5f0066db0d1a84fa7510ee9e4eeb0a0f8cc1a63cb1869bd7165184eb54481afdb984d0cd2bb79bc7c6dcfe21a1e32

data/README.md

@@ -23,7 +23,7 @@ gem install atco
 irb
 
 
-require 'rubygems
+require 'rubygems'
 require 'atco'
 
 result = Atco.parse('filename.cif')
@@ -34,4 +34,4 @@ result = Atco.parse('SVRTMAO009A-20091005.cif) # an example data file in the rep
   locations: […],
   journies: {…}
 }
-```
+```

data/Rakefile

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
 
 begin
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)
 rescue LoadError
-  puts 'RSpec, or one of its dependencies, is not available. Install it with: bundle install'
+  puts "RSpec, or one of its dependencies, is not available. Install it with: bundle install"
 end
 
-task default: :spec
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  puts "rubocop, or one of its dependencies, is not available. Install it with: bundle install"
+end
+
+task default: %i[spec rubocop]

data/lib/atco/journey.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 module Atco
+  # Atco::Journey is a data class to abstract ATCO-CIF Journey records.
   class Journey
     attr_accessor :vehicle_type, :registration_number, :identifier, :operator, :route_number, :first_date_of_operation,
                   :running_board, :last_date_of_operation, :school_term_time, :route_direction, :bank_holidays, :stops
 
-    def initialize(data)
+    def initialize(data) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       @mondays = parse_boolean_int data[:operates_on_mondays]
       @tuesdays = parse_boolean_int data[:operates_on_tuesdays]
       @wednesdays = parse_boolean_int data[:operates_on_wednesdays]
@@ -61,10 +62,10 @@ module Atco
     end
 
     def parse_boolean_int(string)
-      string && string == '1' ? true : false
+      string && string == "1"
     end
 
-    def to_json(*args)
+    def to_json(*attrs) # rubocop:disable Metrics/MethodLength
       {
         vehicle_type: @vehicle_type,
         registration_number: @registration_number,
@@ -78,7 +79,7 @@ module Atco
         route_direction: @route_direction,
         bank_holidays: @bank_holidays,
         stops: @stops
-      }.to_json(*args)
+      }.to_json(*attrs)
     end
   end
 end

data/lib/atco/location.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Atco
+  # Atco::Location is a data class to abstract ATCO-CIF Location records.
   class Location
     attr_accessor :name, :identifier, :easting, :northing, :gazeteer_code
 
@@ -12,14 +13,14 @@ module Atco
       @gazeteer_code = location_header[:gazetteer_code]
     end
 
-    def to_json(*a)
+    def to_json(*attrs)
       {
         name: @name,
         identifier: @identifier,
         easting: @easting,
         northing: @northing,
         gazeteer_code: @gazeteer_code
-      }.to_json(*a)
+      }.to_json(*attrs)
     end
   end
 end

data/lib/atco/stop.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
 module Atco
+  # Atco::Stop is a class to abstract ATCO-CIF Origin, Intermediate and Destination (Stop) records.
   class Stop
     attr_accessor :bay_number, :location, :timing_point_indicator, :fare_stage_indicator, :published_departure_time,
                   :record_identity
 
     def origin?
-      @record_identity == 'QO'
+      @record_identity == "QO"
     end
 
     def intermediate?
-      @record_identity == 'QI'
+      @record_identity == "QI"
     end
 
     def destination?
-      @record_identity == 'QT'
+      @record_identity == "QT"
     end
 
     def initialize(data)
@@ -26,7 +27,7 @@ module Atco
       @record_identity = data[:record_identity]
     end
 
-    def to_json(*args)
+    def to_json(*attrs)
       {
         record_identity: @record_identity,
         location: @location,
@@ -34,7 +35,7 @@ module Atco
         timing_point_indicator: @timing_point_indicator,
         fare_stage_indicator: @fare_stage_indicator,
         bay_number: @bay_number
-      }.to_json(*args)
+      }.to_json(*attrs)
     end
   end
 end

data/lib/atco/version.rb

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

data/lib/atco.rb

@@ -1,31 +1,28 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.dirname(__FILE__)) unless
-  $LOAD_PATH.include?(File.dirname(__FILE__)) || $LOAD_PATH.include?(__dir__)
-
-require 'open3'
-require 'tempfile'
-require 'atco/location'
-require 'atco/journey'
-require 'atco/stop'
-
-module Atco
-  VERSION = '0.0.1'
-
-  class << self
+require "open3"
+require "tempfile"
+require_relative "atco/location"
+require_relative "atco/journey"
+require_relative "atco/stop"
+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 << self # rubocop:disable Metrics/ClassLength
     @path = nil
-    @@methods = {
-      bank_holiday: 'QH',
-      operator: 'QP',
-      additional_location_info: 'QB',
-      location: 'QL',
-      destination: 'QT',
-      intermediate: 'QI',
-      origin: 'QO',
-      journey_header: 'QS'
-    }
-
-    def parse(file)
+    METHODS = {
+      bank_holiday: "QH",
+      operator: "QP",
+      additional_location_info: "QB",
+      location: "QL",
+      destination: "QT",
+      intermediate: "QI",
+      origin: "QO",
+      journey_header: "QS"
+    }.freeze
+
+    def parse(file) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       @path = File.expand_path(file)
       data = File.readlines(@path)
 
@@ -41,13 +38,13 @@ module Atco
           header = parse_header(line)
           next
         end
-        @@methods.each do |method, identifier|
+        METHODS.each do |method, identifier|
           object = send("parse_#{method}", line)
           next unless object[:record_identity] && object[:record_identity] == identifier
 
-          current_journey = object if object[:record_identity] && object[:record_identity] == @@methods[:journey_header]
-          if object[:record_identity] && (object[:record_identity] == @@methods[:location] || object[:record_identity] == @@methods[:additional_location_info])
-            if object[:record_identity] == @@methods[:location]
+          current_journey = object if object[:record_identity] && object[:record_identity] == METHODS[:journey_header]
+          if object[:record_identity] && (object[:record_identity] == METHODS[:location] || object[:record_identity] == METHODS[:additional_location_info]) # rubocop:disable Layout/LineLength
+            if object[:record_identity] == METHODS[:location]
               current_location = object
             else
               locations << Location.new(current_location, object)
@@ -150,7 +147,7 @@ module Atco
       }
     end
 
-    def parse_journey_header(string)
+    def parse_journey_header(string) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       {
         record_identity: string[0, 2],
         transaction_type: string[2, 1],

data/spec/atco_spec.rb

@@ -1,174 +1,198 @@
 # frozen_string_literal: true
 
-require "#{File.dirname(__FILE__)}/spec_helper"
-require 'json'
+require "json"
 
-describe Atco do
-  before(:all) do
+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'
-    }
+  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] == {
-      file_type: 'ATCO-CIF',
-      file_originator: 'Electronic Registration',
-      source_product: 'MIA 4.20.18',
-      version: '5.0',
-      production_datetime: '20090915113809'
-    }
+  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") == {
-      file_type: 'ATCO-CIF',
-      version: '5.0',
-      file_originator: 'Electronic Registration',
-      source_product: 'MIA 4.20.18',
-      production_datetime: '20090915113809'
-    }
+  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') == {
-      record_identity: 'QH',
-      transaction_type: 'N',
-      date_of_bank_holiday: '20061225'
-    }
+  it "should parse bank holiday" do
+    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'
-    }
+  it "should parse operator" do
+    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'
-    }
+  it "should parse additional location information" do
+    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'
-    }
+  it "should parse location" do
+    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'
-    }
+  it "should parse destination" do
+    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'
-    }
+  it "should parse intermediate" do
+    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'
-    }
+  it "should parse origin" do
+    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'
-    }
+  it "should parse journey header" do
+    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')
+      @atco = Atco.parse("spec/fixtures/example.cif")
     end
 
-    it 'should parse 1 journey' do
-      expect @atco[:journeys].size == 1
+    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)
+    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
   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,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: atco
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - David Rice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 description: Simple and opinionated library for parsing ATCO .cif files to JSON with
   Ruby
 email: me@davidjrice.co.uk
@@ -48,11 +48,11 @@ extra_rdoc_files:
 files:
 - README.md
 - Rakefile
-- VERSION
 - lib/atco.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
@@ -70,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/VERSION

@@ -1 +0,0 @@
-1.0.0