atco 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9b77a9ff8bc2044b0985cdc1cf6b9f9f997e6884c72ce88e713cc807c04aa40
-  data.tar.gz: 8c09fd9b592ce9c1c8eae5b2bf4b36e9b1f1e8a98aff075773285f4a2da28e92
+  metadata.gz: 15e9812933c6ca6dcc275bd1f262a30c4b916a12feedf824ce9c4f55f7d24825
+  data.tar.gz: 36e55b87cdaa72cdd1601f87ab10e9937f7ba4d6ea8fdcf174bb5f20603978c2
 SHA512:
-  metadata.gz: 7962c7bd938e9ec5d406b72994148b01368651b49ae4b023088dda40e8317895999805f1d6d8e5cc58d23caf5eb7d05da71fc64251cab7e666c30ba38302929b
-  data.tar.gz: 4b1469dce23b861431b42cbdc1aeaf0f731388c648fb5bd4951b72e1fe889ce567cf0ff451c633737c6879a6cf950752409f79675e83234dee47c60dc03494bf
+  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/version.rb

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

data/lib/atco.rb

@@ -30,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 = []
@@ -69,12 +68,10 @@ 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

data/spec/atco_spec.rb

@@ -1,7 +1,5 @@
 # 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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atco
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - David Rice