atco 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91d4d697f6d487218aa3def133f0104257141ed8fb18b93be2c3f0c52ac92a6e
+  data.tar.gz: 213d51b686a0076c69f26b6d18173dd2b767eaf24db17f7e0cdc011406b94705
+SHA512:
+  metadata.gz: fb0ccef50c6a0490c9b87b0b01a7179bec8ca755d594f52193ef6220ef6733e2c8ed600f46043c3a0a38038f3290a8687f1828adfe893dac7dad5c7413b23c89
+  data.tar.gz: 6ba15c31b4cfb1873577af0fe50c62c6325780d9f9c3c6ddb124cfe91397dd2808382757f1198f492ea6fbbe2a21131e010b49ac80a757f33041a3ff57db1d9f

data/{README.mdown → README.md}

@@ -2,11 +2,14 @@
 
 ATCO-CIF is the format of choice for UK public transport authorities. This is a ruby library that reads **.cif** files and gives you JSON back.
 
+* 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)
 
 ### USAGE
 
-Currently this library is under-development and has several things left to do before it is perfect (see the [todo.mdown](http://github.com/davidjrice/atco/blob/master/todo.mdown) 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
@@ -14,14 +17,21 @@ Currently this library is under-development and has several things left to do be
 
 Code example, for more detailed internal api usage see the spec files.
 
-    require 'lib/atco'
-    
-    result = Atco.parse('filename.cif')
-    result = Atco.parse('SVRTMAO009A-20091005.cif) # an example data file
-
-    => {
-      :header => {...},
-      :locations => [...],
-      :journies => {...}
-    }
-    
+
+```ruby
+gem install atco
+irb
+
+
+require 'rubygems
+require 'atco'
+
+result = Atco.parse('filename.cif')
+result = Atco.parse('SVRTMAO009A-20091005.cif) # an example data file in the repo
+
+=> {
+  header: {…},
+  locations: […],
+  journies: {…}
+}
+```

data/Rakefile

@@ -1,14 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "atco"
-    s.summary = "Simple and opinionated library for parsing ATCO-CIF files with Ruby."
-    s.email = "me@davidjrice.co.uk"
-    s.homepage = "http://github.com/davidjrice/atco"
-    s.description = "Simple and opinionated library for parsing ATCO-CIF files with Ruby."
-    s.authors = ["David Rice"]
-    s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
-  end
+  RSpec::Core::RakeTask.new(:spec)
 rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
-end
+  puts 'RSpec, or one of its dependencies, is not available. Install it with: bundle install'
+end
+
+task default: :spec

data/VERSION

@@ -1 +1 @@
-0.0.1
+1.0.0

data/lib/atco/journey.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Atco
+  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)
+      @mondays = parse_boolean_int data[:operates_on_mondays]
+      @tuesdays = parse_boolean_int data[:operates_on_tuesdays]
+      @wednesdays = parse_boolean_int data[:operates_on_wednesdays]
+      @thursdays = parse_boolean_int data[:operates_on_thursdays]
+      @fridays = parse_boolean_int data[:operates_on_fridays]
+      @saturdays = parse_boolean_int data[:operates_on_saturdays]
+      @sundays = parse_boolean_int data[:operates_on_sundays]
+
+      @vehicle_type = data[:vehicle_type]
+      @registration_number = data[:registration_number]
+      @identifier = data[:unique_journey_identifier]
+      @operator = data[:operator]
+      @route_number = data[:route_number]
+      @route_direction = data[:route_direction]
+      @first_date_of_operation = data[:first_date_of_operation]
+      @last_date_of_operation = data[:last_date_of_operation]
+      @running_board = data[:running_board]
+      @school_term_time = data[:school_term_time]
+      @bank_holidays = data[:bank_holidays]
+
+      @stops = []
+      # stops.each do |s|
+      #  @stops << Stop.new(s)
+      # end
+    end
+
+    def mondays?
+      @mondays
+    end
+
+    def tuesdays?
+      @tuesdays
+    end
+
+    def wednesdays?
+      @wednesdays
+    end
+
+    def thursdays?
+      @thursdays
+    end
+
+    def fridays?
+      @fridays
+    end
+
+    def saturdays?
+      @saturdays
+    end
+
+    def sundays?
+      @sundays
+    end
+
+    def parse_boolean_int(string)
+      string && string == '1' ? true : false
+    end
+
+    def to_json(*args)
+      {
+        vehicle_type: @vehicle_type,
+        registration_number: @registration_number,
+        identifier: @identifier,
+        operator: @operator,
+        route_number: @route_number,
+        first_date_of_operation: @first_date_of_operation,
+        running_board: @running_board,
+        last_date_of_operation: @last_date_of_operation,
+        school_term_time: @school_term_time,
+        route_direction: @route_direction,
+        bank_holidays: @bank_holidays,
+        stops: @stops
+      }.to_json(*args)
+    end
+  end
+end

data/lib/atco/location.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Atco
+  class Location
+    attr_accessor :name, :identifier, :easting, :northing, :gazeteer_code
+
+    def initialize(location_header, additional_location_information)
+      @name = location_header[:full_location]
+      @identifier = location_header[:record_identity]
+      @easting = additional_location_information[:grid_reference_easting]
+      @northing = additional_location_information[:grid_reference_northing]
+      @gazeteer_code = location_header[:gazetteer_code]
+    end
+
+    def to_json(*a)
+      {
+        name: @name,
+        identifier: @identifier,
+        easting: @easting,
+        northing: @northing,
+        gazeteer_code: @gazeteer_code
+      }.to_json(*a)
+    end
+  end
+end

data/lib/atco/stop.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Atco
+  class Stop
+    attr_accessor :bay_number, :location, :timing_point_indicator, :fare_stage_indicator, :published_departure_time,
+                  :record_identity
+
+    def origin?
+      @record_identity == 'QO'
+    end
+
+    def intermediate?
+      @record_identity == 'QI'
+    end
+
+    def destination?
+      @record_identity == 'QT'
+    end
+
+    def initialize(data)
+      @bay_number = data[:bay_number]
+      @location = data[:location]
+      @timing_point_indicator = data[:timing_point_indicator]
+      @fare_stage_indicator = data[:fare_stage_indicator]
+      @published_departure_time = data[:published_departure_time]
+      @record_identity = data[:record_identity]
+    end
+
+    def to_json(*args)
+      {
+        record_identity: @record_identity,
+        location: @location,
+        published_departure_time: @published_departure_time,
+        timing_point_indicator: @timing_point_indicator,
+        fare_stage_indicator: @fare_stage_indicator,
+        bay_number: @bay_number
+      }.to_json(*args)
+    end
+  end
+end

data/lib/atco.rb

@@ -1,180 +1,182 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+# 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 'location'
+require 'tempfile'
+require 'atco/location'
+require 'atco/journey'
+require 'atco/stop'
 
 module Atco
   VERSION = '0.0.1'
-  
+
   class << self
-    
     @path = nil
     @@methods = {
-      :bank_holiday => 'QH',
-      :operator => 'QP',
-      :additional_location_info => 'QB',
-      :location => 'QL',
-      :destination => 'QT',
-      :intermediate => 'QI',
-      :origin => 'QO',
-      :journey_header => 'QS'
+      bank_holiday: 'QH',
+      operator: 'QP',
+      additional_location_info: 'QB',
+      location: 'QL',
+      destination: 'QT',
+      intermediate: 'QI',
+      origin: 'QO',
+      journey_header: 'QS'
     }
-    
+
     def parse(file)
       @path = File.expand_path(file)
       data = File.readlines(@path)
-      
+
       objects = []
       current_journey = nil
       current_location = nil
       locations = []
       journeys = {}
       header = nil
-      
+
       data.each do |line|
         if line == data.first
           header = parse_header(line)
           next
         end
-        @@methods.each do |method,identifier|
-          object = self.send("parse_#{method}", line)
-          if 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_location = object 
-              else
-                locations << Location.new(current_location, object)
-              end
+        @@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_location = object
+            else
+              locations << Location.new(current_location, object)
             end
+          end
 
-            if current_journey
-              if journeys[current_journey[:unique_journey_identifier]]
-                journeys[current_journey[:unique_journey_identifier]] << object
-              else
-                journeys[current_journey[:unique_journey_identifier]] = [object]
-              end
+          if current_journey
+            if journeys[current_journey[:unique_journey_identifier]]
+              journeys[current_journey[:unique_journey_identifier]].stops << Stop.new(object)
+            else
+              journeys[current_journey[:unique_journey_identifier]] = Journey.new(object)
             end
-            objects << object
           end
+          objects << object
         end
       end
-      return {:header => header, :locations => locations, :journeys => journeys}
+      { header: header, locations: locations, journeys: journeys }
     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]
-      } 
+        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],
-        :transaction_type => string[2,1],
-        :date_of_bank_holiday => string[3,8]
+        record_identity: string[0, 2],
+        transaction_type: string[2, 1],
+        date_of_bank_holiday: string[3, 8]
       }
     end
-    
+
     def parse_operator(string)
       {
-        :record_identity => string[0,2],
-        :transaction_type => string[2,1],
-        :operator => parse_value(string[3,4]),
-        :operator_short_form => parse_value(string[7,24]),
-        :operator_legal_name => parse_value(string[31,48])
+        record_identity: string[0, 2],
+        transaction_type: string[2, 1],
+        operator: parse_value(string[3, 4]),
+        operator_short_form: parse_value(string[7, 24]),
+        operator_legal_name: parse_value(string[31, 48])
       }
     end
 
     def parse_additional_location_info(string)
       {
-        :record_identity => string[0,2],
-        :transaction_type => string[2,1],
-        :location => string[3,12].strip,
-        :grid_reference_easting => parse_value(string[15,8]),
-        :grid_reference_northing => parse_value(string[23,8])
+        record_identity: string[0, 2],
+        transaction_type: string[2, 1],
+        location: string[3, 12].strip,
+        grid_reference_easting: parse_value(string[15, 8]),
+        grid_reference_northing: parse_value(string[23, 8])
       }
     end
 
     def parse_location(string)
       {
-        :record_identity => string[0,2],
-        :transaction_type => string[2,1],
-        :location => parse_value(string[3,12]),
-        :full_location => parse_value(string[15,48]),
-        :gazetteer_code => string[63,1]
+        record_identity: string[0, 2],
+        transaction_type: string[2, 1],
+        location: parse_value(string[3, 12]),
+        full_location: parse_value(string[15, 48]),
+        gazetteer_code: string[63, 1]
       }
     end
 
     def parse_destination(string)
       {
-        :record_identity => string[0,2],
-        :location => string[2,12],
-        :published_arrival_time => string[14,4],
-        :bay_number => parse_value(string[18,3]),
-        :timing_point_indicator => string[21,2],
-        :fare_stage_indicator => string[23,2]
+        record_identity: string[0, 2],
+        location: string[2, 12],
+        published_arrival_time: string[14, 4],
+        bay_number: parse_value(string[18, 3]),
+        timing_point_indicator: string[21, 2],
+        fare_stage_indicator: string[23, 2]
       }
     end
 
     def parse_intermediate(string)
       {
-        :record_identity => string[0,2],
-        :location => string[2,12],
-        :published_arrival_time => string[14,4],
-        :published_departure_time => string[18,4],
-        :activity_flag => string[22,1],
-        :bay_number => parse_value(string[23,3]),
-        :timing_point_indicator => string[26,2],
-        :fare_stage_indicator => string[28,2]
+        record_identity: string[0, 2],
+        location: string[2, 12],
+        published_arrival_time: string[14, 4],
+        published_departure_time: string[18, 4],
+        activity_flag: string[22, 1],
+        bay_number: parse_value(string[23, 3]),
+        timing_point_indicator: string[26, 2],
+        fare_stage_indicator: string[28, 2]
       }
     end
 
     def parse_origin(string)
       {
-        :record_identity => string[0,2],
-        :location => string[2,12],
-        :published_departure_time => string[14,4],
-        :bay_number => parse_value(string[18,3]),
-        :timing_point_indicator => string[21,2],
-        :fare_stage_indicator => string[23,2]
+        record_identity: string[0, 2],
+        location: string[2, 12],
+        published_departure_time: string[14, 4],
+        bay_number: parse_value(string[18, 3]),
+        timing_point_indicator: string[21, 2],
+        fare_stage_indicator: string[23, 2]
       }
     end
 
     def parse_journey_header(string)
       {
-        :record_identity => string[0,2],
-        :transaction_type => string[2,1],
-        :operator => string[3,4].strip,
-        :unique_journey_identifier => string[7,6],
-        :first_date_of_operation => parse_value(string[13,8]),
-        :last_date_of_operation => parse_value(string[21,8]),
-        :operates_on_mondays => string[29,1],
-        :operates_on_tuesdays => string[30,1],
-        :operates_on_wednesdays => string[31,1],
-        :operates_on_thursdays => string[32,1],
-        :operates_on_fridays => string[33,1],
-        :operates_on_saturdays => string[34,1],
-        :operates_on_sundays => string[35,1],
-        :school_term_time => parse_value(string[36,1]),
-        :bank_holidays => parse_value(string[37,1]),
-        :route_number => parse_value(string[38,4]),
-        :running_board => parse_value(string[42,6]),
-        :vehicle_type => parse_value(string[48,8]),
-        :registration_number => parse_value(string[56,8]),
-        :route_direction => string[64,1]
+        record_identity: string[0, 2],
+        transaction_type: string[2, 1],
+        operator: string[3, 4].strip,
+        unique_journey_identifier: string[7, 6],
+        first_date_of_operation: parse_value(string[13, 8]),
+        last_date_of_operation: parse_value(string[21, 8]),
+        operates_on_mondays: string[29, 1],
+        operates_on_tuesdays: string[30, 1],
+        operates_on_wednesdays: string[31, 1],
+        operates_on_thursdays: string[32, 1],
+        operates_on_fridays: string[33, 1],
+        operates_on_saturdays: string[34, 1],
+        operates_on_sundays: string[35, 1],
+        school_term_time: parse_value(string[36, 1]),
+        bank_holidays: parse_value(string[37, 1]),
+        route_number: parse_value(string[38, 4]),
+        running_board: parse_value(string[42, 6]),
+        vehicle_type: parse_value(string[48, 8]),
+        registration_number: parse_value(string[56, 8]),
+        route_direction: string[64, 1]
       }
     end
-    
+
     def parse_value(value)
-      return value.strip if value
+      value&.strip
     end
   end
-  
-end
+end

data/spec/atco_spec.rb

@@ -1,150 +1,174 @@
-require File.dirname(__FILE__) + '/spec_helper'
+# frozen_string_literal: true
+
+require "#{File.dirname(__FILE__)}/spec_helper"
 require 'json'
 
 describe Atco do
-  
   before(:all) do
-   
   end
-  
-  it "should output file for debugging!" do
+
+  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
-    #fixture = JSON.parse(File.read('spec/fixtures/example.json'))
   end
-  
-  it "should parse header from fixture" do
+
+  it 'should parse header from fixture' do
     result = Atco.parse('spec/fixtures/example.cif')
-    result[:header].should == {
-      :file_type => "ATCO-CIF",
-      :file_originator => "Electronic Registration",
-      :source_product => "MIA 4.20.18",
-      :version => "5.0",
-      :production_datetime => "20090915113809"
+    expect result[:header] == {
+      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
+
+  it 'should parse locations from fixture' do
     result = Atco.parse('spec/fixtures/example.cif')
-    result[:header].should == {
-      :file_type => "ATCO-CIF",
-      :file_originator => "Electronic Registration",
-      :source_product => "MIA 4.20.18",
-      :version => "5.0",
-      :production_datetime => "20090915113809"
+    expect result[:header] == {
+      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
-    Atco.parse_header("ATCO-CIF0500Electronic Registration         MIA 4.20.18     20090915113809\r\n").should == {
-      :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") == {
+      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
-    Atco.parse_bank_holiday("QHN20061225").should == {
-      :record_identity => 'QH',
-      :transaction_type => 'N',
-      :date_of_bank_holiday => '20061225'
+
+  it 'should parse bank holiday' do
+    expect Atco.parse_bank_holiday('QHN20061225') == {
+      record_identity: 'QH',
+      transaction_type: 'N',
+      date_of_bank_holiday: '20061225'
     }
   end
-  
-  it "should parse operator" do
-    Atco.parse_operator("QPNTM  Translink Metro         Translink Metro           \r\n").should == {
-      :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") == {
+      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
-    Atco.parse_additional_location_info("QBN700000001252  328622  367433      \r\n").should == {
-      :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") == {
+      record_identity: 'QB',
+      transaction_type: 'N',
+      location: '700000001252',
+      grid_reference_easting: '328622',
+      grid_reference_northing: '367433'
     }
   end
-  
-  it "should parse location" do
-    Atco.parse_location("QLN700000001252Conway (River Rd)                               1\r\n").should == {
-      :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") == {
+      record_identity: 'QL',
+      transaction_type: 'N',
+      location: '700000001252',
+      full_location: 'Conway (River Rd)',
+      gazetteer_code: '1'
     }
   end
 
   # QT7000000012520605   T1F0
-  it "should parse destination" do
-    Atco.parse_destination("QT7000000012520605   T1F0\r\n").should == {
-      :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") == {
+      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
-    Atco.parse_intermediate("QI70000000125607120712B   T1F0\r\n").should == {
-      :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") == {
+      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
-    Atco.parse_origin("QO7000000012520730   T1F0\r\n").should == {
-      :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") == {
+      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
-    Atco.parse_journey_header("QSNTM  13986520091005        1111100  9A  9018  0               I\r\n").should == {
-      :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") == {
+      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
 
-end
+  describe 'with example.cif' do
+    before(:all) do
+      @atco = Atco.parse('spec/fixtures/example.cif')
+    end
+
+    it 'should parse 1 journey' do
+      expect @atco[:journeys].size == 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
+    end
+
+    it 'should parse 6 stops for joureny 139748' do
+      expect @atco[:journeys]['139748'].stops.size == 6
+    end
+
+    it 'should parse 2 locations' do
+      expect @atco[:locations].size == 2
+    end
+  end
+end

data/spec/fixtures/example.cif

@@ -0,0 +1,30 @@
+ATCO-CIF0500Electronic Registration         MIA 4.20.18     20090915113809
+QLN700000001433Donegal Square East                             1 
+QBN700000001433  333935  373979                                                
+GS00001433 N                    Belfast Metro Ops                                 7000
+GR00001433Donegall Square East                                                                                7000
+QLN700000001627Great Northern Mall                             1 
+QBN700000001627  333575  373717                                                
+GS00001627 N                    Belfast Metro Ops                                 7000
+GR00001627Great Victoria Street                                                                               7000                                                                                      7000
+QPNTM  Translink Metro         Translink Metro                                                         
+QQ                                                                              
+ZLTMAO009AT05O
+ZD20091005        Monday to Friday                                                      FFFFF00
+ZSTMAO009A9A  City Centre - Conway                                                                                
+ZAN700000001433                                                P1W1T1
+ZAN700000001627                                                P1W1T1
+QSNTM  13974820091005        1111100  9A  9011  0               O
+ZJTMAO009A004  1 370     000CB   545     2237    C         FFFFF00L0
+QO7000000014330545   T1F0
+ZECH0      054500054500P0W0
+QI70000000162705460546B   T1F0
+ZECH0      054600054600P0W0
+QI70000000124806020602B   T1F0
+ZECH0      060200060200P0W0
+QI70000000125006030603B   T0F0
+ZECH0      060348060348P0W0
+QT7000000012520605   T1F0
+ZECH0      060500060500P0W0
+QVN0       Bus                     
+QHN20071226

data/spec/fixtures/example.json

@@ -0,0 +1,98 @@
+{
+  "header": {
+    "file_type": "ATCO-CIF",
+    "file_originator": "Electronic Registration",
+    "source_product": "MIA 4.20.18",
+    "version": "5.0",
+    "production_datetime": "20090915113809"
+  },
+  "locations": [
+    [
+      {
+        "record_identity": "QL",
+        "location": "700000001433",
+        "transaction_type": "N",
+        "full_location": "Donegal Square East",
+        "gazetteer_code": "1"
+      },
+      {
+        "record_identity": "QB",
+        "location": "700000001433",
+        "transaction_type": "N",
+        "grid_reference_easting": "333935",
+        "grid_reference_northing": "373979"
+      }
+    ],
+    [
+      {
+        "record_identity": "QL",
+        "location": "700000001627",
+        "transaction_type": "N",
+        "full_location": "Great Northern Mall",
+        "gazetteer_code": "1"
+      },
+      {
+        "record_identity": "QB",
+        "location": "700000001627",
+        "transaction_type": "N",
+        "grid_reference_easting": "333575",
+        "grid_reference_northing": "373717"
+      }
+    ]
+  ],
+  "journeys": {
+    "139748": [
+      {
+        "record_identity": "QO",
+        "published_departure_time": "0545",
+        "location": "700000001433",
+        "bay_number": "",
+        "timing_point_indicator": "T1",
+        "fare_stage_indicator": "F0"
+      },
+      {
+        "record_identity": "QI",
+        "published_departure_time": "0546",
+        "location": "700000001627",
+        "published_arrival_time": "0546",
+        "activity_flag": "B",
+        "bay_number": "",
+        "timing_point_indicator": "T1",
+        "fare_stage_indicator": "F0"
+      },
+      {
+        "record_identity": "QI",
+        "published_departure_time": "0602",
+        "location": "700000001248",
+        "published_arrival_time": "0602",
+        "activity_flag": "B",
+        "bay_number": "",
+        "timing_point_indicator": "T1",
+        "fare_stage_indicator": "F0"
+      },
+      {
+        "record_identity": "QI",
+        "published_departure_time": "0603",
+        "location": "700000001250",
+        "published_arrival_time": "0603",
+        "activity_flag": "B",
+        "bay_number": "",
+        "timing_point_indicator": "T0",
+        "fare_stage_indicator": "F0"
+      },
+      {
+        "record_identity": "QT",
+        "location": "700000001252",
+        "published_arrival_time": "0605",
+        "bay_number": "",
+        "timing_point_indicator": "T1",
+        "fare_stage_indicator": "F0"
+      },
+      {
+        "record_identity": "QH",
+        "transaction_type": "N",
+        "date_of_bank_holiday": "20071226"
+      }
+    ]
+  }
+}

data/spec/spec_helper.rb

@@ -1,2 +1,6 @@
+# frozen_string_literal: true
+
 require 'rubygems'
-require File.dirname(__FILE__) + '/../lib/atco'
+require 'rspec'
+
+require "#{File.dirname(__FILE__)}/../lib/atco"

metadata

@@ -1,67 +1,84 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: atco
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - David Rice
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-02-22 00:00:00 +00:00
-default_executable: 
-dependencies: []
-
-description: Simple and opinionated library for parsing ATCO-CIF files with Ruby.
+date: 2024-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple and opinionated library for parsing ATCO .cif files to JSON with
+  Ruby
 email: me@davidjrice.co.uk
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.mdown
-files: 
-- README.mdown
+extra_rdoc_files:
+- README.md
+files:
+- README.md
 - Rakefile
 - VERSION
 - lib/atco.rb
-- lib/location.rb
-has_rdoc: true
+- lib/atco/journey.rb
+- lib/atco/location.rb
+- lib/atco/stop.rb
+- spec/atco_spec.rb
+- spec/fixtures/example.cif
+- spec/fixtures/example.json
+- spec/spec_helper.rb
 homepage: http://github.com/davidjrice/atco
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 3.5.3
 signing_key: 
-specification_version: 3
-summary: Simple and opinionated library for parsing ATCO-CIF files with Ruby.
-test_files: 
-- spec/atco_spec.rb
-- spec/spec_helper.rb
+specification_version: 4
+summary: Parse ATCO .cif files to JSON with Ruby
+test_files: []

data/lib/location.rb

@@ -1,23 +0,0 @@
-class Location
-
-  attr_accessor :name, :identifier, :easting, :northing, :gazeteer_code
-
-  def initialize(location_header, additional_location_information)
-    @name = location_header[:full_location]
-    @identifier = location_header[:record_identity]
-    @easting = additional_location_information[:grid_reference_easting]
-    @northing = additional_location_information[:grid_reference_northing]
-    @gazeteer_code = location_header[:gazetteer_code]
-  end
-
-  def to_json(*a)
-    { 
-      :name => @name,
-      :identifier => @identifier,
-      :easting => @easting,
-      :northing => @northing,
-      :gazeteer_code => @gazeteer_code 
-    }.to_json(*a)
-  end
-  
-end