atco 0.0.1

data/README.mdown

@@ -0,0 +1,27 @@
+## ATCO-CIF
+
+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.
+
+* **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 ).
+
+* clone this library
+* start an irb session
+* put the cif file in ./data (needs to change from being hardcoded)
+
+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 => {...}
+    }
+    

data/Rakefile

@@ -0,0 +1,14 @@
+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
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/atco.rb

@@ -0,0 +1,180 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'open3'
+require 'tempfile'  
+require 'location'
+
+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'
+    }
+    
+    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
+            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
+            end
+            objects << object
+          end
+        end
+      end
+      return {: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]
+      } 
+    end
+    
+    def parse_bank_holiday(string)
+      {
+        :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])
+      }
+    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])
+      }
+    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]
+      }
+    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]
+      }
+    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]
+      }
+    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]
+      }
+    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]
+      }
+    end
+    
+    def parse_value(value)
+      return value.strip if value
+    end
+  end
+  
+end

data/lib/location.rb

@@ -0,0 +1,23 @@
+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

data/spec/atco_spec.rb

@@ -0,0 +1,150 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'json'
+
+describe Atco do
+  
+  before(:all) do
+   
+  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
+    #fixture = JSON.parse(File.read('spec/fixtures/example.json'))
+  end
+  
+  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"
+    }
+  end
+  
+  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"
+    }
+  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'
+    }
+  end
+  
+  it "should parse bank holiday" do
+    Atco.parse_bank_holiday("QHN20061225").should == {
+      :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'
+    }
+  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'
+    }
+  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'
+    }
+  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'
+    }
+  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'
+    }
+  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'
+    }
+  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'
+    }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/atco'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: atco
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+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.
+email: me@davidjrice.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mdown
+files: 
+- README.mdown
+- Rakefile
+- VERSION
+- lib/atco.rb
+- lib/location.rb
+has_rdoc: true
+homepage: http://github.com/davidjrice/atco
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+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