rail_feeds 0.0.1

data/lib/rail_feeds/network_rail/schedule/parser.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative 'parser/cif'
+require_relative 'parser/json'
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      # A parent class for parsing schedule data read from schedule file(s).
+      # Children need to implement a parse_line method.
+      class Parser
+        include Logging
+
+        # rubocop:disable Metrics/ParameterLists
+        # Initialize a new data.
+        # @param [Logger, nil] logger
+        #   The logger for outputting events, if nil the global logger will be used.
+        # @param [Proc, #call] on_header
+        #   The proc to call when the header is received.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::Header.
+        # @param [Proc, #call] on_tiploc_create
+        #   The proc to call when a tiploc insertion is received.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::Tiploc::Insert.
+        # @param [Proc, #call] on_tiploc_update
+        #   The proc to call when an amendment to an existing tiploc is received.
+        #   Passes self, tiploc_id and a RailFeeds::NetworkRail::Schedule::Tiploc::Ammend.
+        # @param [Proc, #call] on_tiploc_delete
+        #   The proc to call when an existing tiploc should be deleted.
+        #   Passes self and a tiploc_id.
+        # @param [Proc, #call] on_association_create
+        #   The proc to call when a new association is received.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::Association.
+        # @param [Proc, #call] on_association_update
+        #   The proc to call when a revision to an existing association is received.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::Association.
+        # @param [Proc, #call] on_association_delete
+        #   The proc to call when an existing association should be deleted.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::Association.
+        # @param [Proc, #call] on_train_schedule_create
+        #   The proc to call when a new train schedule is received.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::TrainSchedule::New.
+        # @param [Proc, #call] on_train_schedule_update
+        #   The proc to call when a revision to an existing train schedule is received.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::TrainSchedule::Revise.
+        # @param [Proc, #call] on_train_schedule_delete
+        #   The proc to call when an existing train schedule should be deleted.
+        #   Passes self and a RailFeeds::NetworkRail::Schedule::TrainSchedule::Delete.
+        # @param [Proc, #call] on_trailer
+        #   The proc to call when the trailer (end of file record) is received.
+        #   Passes self.
+        # @param [Proc, #call] on_comment
+        #   The proc to call when a comment is received.
+        #   Passes self and a String.
+        def initialize(
+          logger: nil,
+          on_header: nil, on_trailer: nil, on_comment: nil,
+          on_tiploc_create: nil, on_tiploc_update: nil, on_tiploc_delete: nil,
+          on_association_create: nil, on_association_update: nil,
+          on_association_delete: nil, on_train_schedule_create: nil,
+          on_train_schedule_update: nil, on_train_schedule_delete: nil
+        )
+          self.logger = logger unless logger.nil?
+          @on_header = on_header
+          @on_trailer = on_trailer
+          @on_tiploc_create = on_tiploc_create
+          @on_tiploc_update = on_tiploc_update
+          @on_tiploc_delete = on_tiploc_delete
+          @on_association_create = on_association_create
+          @on_association_update = on_association_update
+          @on_association_delete = on_association_delete
+          @on_train_schedule_create = on_train_schedule_create
+          @on_train_schedule_update = on_train_schedule_update
+          @on_train_schedule_delete = on_train_schedule_delete
+          @on_comment = on_comment
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        # Parse the data in CIF file.
+        # @param [IO] file
+        #   The file to load data from.
+        def parse_file(file)
+          @file_ended = false
+          @stop_parsing = false
+
+          file.each_line do |line|
+            parse_line line
+
+            if @stop_parsing
+              logger.debug "Parsing of file #{file} was stopped."
+              break
+            end
+          end
+
+          fail "File is incomplete. #{file}" unless @stop_parsing || @file_ended
+        end
+
+        def parse_line(_line)
+          fail 'parse_file MUST be implemented in the child class.'
+        end
+
+        # Stop parsing the current file.
+        def stop_parsing
+          @stop_parsing = true
+        end
+      end
+    end
+  end
+end

data/lib/rail_feeds/network_rail/schedule/stp_indicator.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      # A collection of methods for working with Short Term Planning indicators.
+      # Provides an stp_indicator attribute to the class.
+      module STPIndicator
+        STP_CIF_MAP = [
+          [:permanent, 'P'],
+          [:stp_new, 'N'],
+          [:stp_overlay, 'O'],
+          [:stp_cancellation, 'C']
+        ].freeze
+        private_constant :STP_CIF_MAP
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        # @return [Symbol, nil] Whether (and what kind) of STP record this is:
+        # * :permanent - This is a permanent (not STP) record
+        # * :stp_new - This is a new record (not an overlay)
+        # * :stp_overlay - This record should be overlayed on the permanent one
+        # * :stp_cancellation - This is an STP cancellation of the permanaent record
+        def stp_indicator
+          @stp_indicator ||= ' '
+        end
+
+        # @param [Symbol, #to_s] value Whether (and what kind) of STP record this is:
+        # * :permanent, 'P' - This is a permanent (not STP) record
+        # * :stp_new, 'N' - This is a new record (not an overlay)
+        # * :stp_overlay, 'O' - This record should be overlayed on the permanent one
+        # * :stp_cancellation, 'C' - This is an STP cancellation of the permanaent record
+        def stp_indicator=(value)
+          if STP_CIF_MAP.map(&:last).include?(value.to_s)
+            # Convert String / to_s value to relevant Symbol
+            value = stp_indicator_from_cif(value)
+          end
+
+          unless STP_CIF_MAP.map(&:first).include?(value)
+            fail ArgumentError, "value (#{value.inspect}) is invalid, must be any of: " +
+                                STP_CIF_MAP.flatten.map(&:inspect).join(', ')
+          end
+
+          @stp_indicator = value
+        end
+
+        protected
+
+        def stp_indicator_to_cif
+          self.class.stp_indicator_to_cif stp_indicator
+        end
+
+        def stp_indicator_from_cif(value)
+          self.class.stp_indicator_from_cif(value)
+        end
+
+        module ClassMethods # :nodoc:
+          def stp_indicator_to_cif(value)
+            STP_CIF_MAP.find { |i| i.first.eql?(value) }&.last
+          end
+
+          def stp_indicator_from_cif(value)
+            STP_CIF_MAP.find { |i| i.last.eql?(value) }&.first || ' '
+          end
+        end
+        private_constant :ClassMethods
+      end
+    end
+  end
+end

data/lib/rail_feeds/network_rail/schedule/tiploc.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      # A class for holding information about a particular tiploc record
+      class Tiploc
+        include Comparable
+
+        # @!attribute [rw] tiploc
+        #   @return [String] The timing point location code.
+        # @!attribute [rw] nlc
+        #   @return [String] The national location code.
+        # @!attribute [rw] nlc_description
+        #   @return [String] Description of location used in CAPRI.
+        # @!attribute [rw] tps_description
+        #   @return [String] Description of location.
+        # @!attribute [rw] stanox
+        #   @return [Integer] The TOPS location code.
+        # @!attribute [rw] crs
+        #   @return [String] The CRS / 3 Alpha code for the location.
+
+        attr_accessor :tiploc, :nlc, :nlc_description, :tps_description, :stanox, :crs
+
+        def initialize(**attributes)
+          attributes.each do |attribute, value|
+            send "#{attribute}=", value
+          end
+        end
+
+        # Initialize a new tiploc from a CIF file line
+        def self.from_cif(line)
+          unless %w[TI TA TD].include?(line[0..1])
+            fail ArgumentError, "Invalid line:\n#{line}"
+          end
+
+          new(
+            tiploc: line[2..8].strip,
+            nlc: Schedule.nil_or_i(line[11..16]),
+            nlc_description: line[56..71].strip,
+            tps_description: line[18..43].strip,
+            stanox: Schedule.nil_or_i(line[44..48]),
+            crs: line[53..55].strip
+          )
+        end
+
+        # Initialize a new tiploc from a JSON file line
+        def self.from_json(line)
+          data = ::JSON.parse(line)['TiplocV1']
+
+          new(
+            tiploc: data['tiploc_code'],
+            nlc: Schedule.nil_or_i(data['nalco']),
+            stanox: Schedule.nil_or_i(data['stanox']),
+            crs: data['crs_code'],
+            nlc_description: Schedule.nil_or_strip(data['description']),
+            tps_description: data['tps_description']
+          )
+        end
+
+        def <=>(other)
+          hash <=> other&.hash
+        end
+
+        def hash
+          tiploc.dup
+        end
+
+        def to_cif
+          format('%-80.80s', [
+            'TI',
+            format('%-7.7s', tiploc),
+            '  ',
+            format('%-6.6s', nlc),
+            ' ',
+            format('%-26.26s', tps_description),
+            format('%-5.5s', stanox),
+            '    ',
+            format('%-3.3s', crs),
+            format('%-16.16s', nlc_description)
+          ].join) + "\n"
+        end
+
+        def to_json
+          {
+            'TiplocV1' => {
+              'transaction_type' => 'Create',
+              'tiploc_code' => tiploc,
+              'nalco' => nlc.to_s,
+              'stanox' => stanox.to_s,
+              'crs_code' => crs,
+              'description' => nlc_description,
+              'tps_description' => tps_description
+            }
+          }.to_json
+        end
+      end
+    end
+  end
+end

data/lib/rail_feeds/network_rail/schedule/train_schedule/change_en_route.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      class TrainSchedule
+        # A class for holding information about a particular train's change en route
+        class ChangeEnRoute
+          # @!attribute [rw] tiploc
+          #   @return [String] The location where the change occurs.
+          # @!attribute [rw] tiploc_suffix
+          #   @return [String]
+          # @!attribute [rw] category
+          #   @return [String] The train's new category.
+          # @!attribute [rw] signalling_headcode
+          #   @return [String, nil] The train's new signalling_headcode.
+          # @!attribute [rw] reservation_headcode
+          #   @return [Integer, nil] The train's new reservation_headcode.
+          # @!attribute [rw] service_code
+          #   @return [String] The train's new service_code.
+          # @!attribute [rw] portion_id
+          #   @return [String, nil] The train's new portion_id.
+          # @!attribute [rw] power_type
+          #   @return [String] The train's new power_type.
+          # @!attribute [rw] timing_load
+          #   @return [String, nil] The train's new timing_load.
+          # @!attribute [rw] speed
+          #   @return [Integer] The train's new speed.
+          # @!attribute [rw] operating_characteristics
+          #   @return [String, nil] The train's new operating_characteristics.
+          # @!attribute [rw] seating_class
+          #   @return [String, nil] The train's new seating_class.
+          # @!attribute [rw] sleeping_class
+          #   @return [String, nil] The train's new sleeping_class.
+          # @!attribute [rw] reservations
+          #   @return [String, nil] The train's new reservations.
+          # @!attribute [rw] catering
+          #   @return [String, nil] The train's new catering.
+          # @!attribute [rw] branding
+          #   @return [String, nil] The train's new branding.
+          # @!attribute [rw] uic_code
+          #   @return [Integer, nil] The train's new uic_code.
+
+          attr_accessor :tiploc, :tiploc_suffix, :category, :signalling_headcode,
+                        :reservation_headcode, :service_code, :portion_id, :power_type,
+                        :timing_load, :speed, :operating_characteristics,
+                        :seating_class, :sleeping_class, :reservations, :catering,
+                        :branding, :uic_code
+
+          def initialize(**attributes)
+            attributes.each do |attribute, value|
+              send "#{attribute}=", value
+            end
+          end
+
+          # rubocop:disable Metrics/AbcSize
+          # rubocop:disable Metrics/MethodLength
+          # Initialize a new change en route from a CIF file line
+          def self.from_cif(line)
+            fail ArgumentError, "Invalid line:\n#{line}" unless line[0..1].eql?('CR')
+
+            new(
+              tiploc: line[2..8].strip,
+              tiploc_suffix: line[9].to_i,
+              category: line[10..11].strip,
+              signalling_headcode: line[12..15].strip,
+              reservation_headcode: Schedule.nil_or_i(line[16..19]),
+              service_code: Schedule.nil_or_i(line[21..28]),
+              portion_id: Schedule.nil_or_strip(line[29]),
+              power_type: line[30..32].strip,
+              timing_load: Schedule.nil_or_strip(line[33..36]),
+              speed: Schedule.nil_or_i(line[37..39]),
+              operating_characteristics: line[40..45].strip,
+              seating_class: Schedule.nil_or_strip(line[46]),
+              sleeping_class: Schedule.nil_or_strip(line[47]),
+              reservations: Schedule.nil_or_strip(line[48]),
+              catering: line[50..53].strip,
+              branding: Schedule.nil_or_strip(line[54..57]),
+              uic_code: Schedule.nil_or_strip(line[62..66])
+            )
+          end
+          # rubocop:enable Metrics/AbcSize
+          # rubocop:enable Metrics/MethodLength
+
+          # rubocop:disable Metrics/AbcSize
+          # rubocop:disable Metrics/MethodLength
+          # Apply these changes to a train.
+          # @param [RailFeeds::NetworkRail::Schedule::TrainSchedule] train
+          #   The train to apply the changes to.
+          # @return [RailFeeds::NetworkRail::Schedule::TrainSchedule]
+          #   The train the changes were applied to.
+          def apply_to(train)
+            train.category = category
+            train.signalling_headcode = signalling_headcode
+            train.reservation_headcode = reservation_headcode
+            train.service_code = service_code
+            train.portion_id = portion_id
+            train.power_type = power_type
+            train.timing_load = timing_load
+            train.speed = speed
+            train.operating_characteristics = operating_characteristics
+            train.seating_class = seating_class
+            train.sleeping_class = sleeping_class
+            train.reservations = reservations
+            train.catering = catering
+            train.branding = branding
+            train.uic_code = uic_code
+            train
+          end
+          # rubocop:enable Metrics/AbcSize
+          # rubocop:enable Metrics/MethodLength
+
+          def ==(other)
+            hash == other&.hash
+          end
+
+          # rubocop:disable Metrics/AbcSize
+          # rubocop:disable Metrics/MethodLength
+          def to_cif
+            format('%-80.80s', [
+              'CR',
+              format('%-7.7s', tiploc),
+              format('%-1.1s', tiploc_suffix),
+              format('%-2.2s', category),
+              format('%-4.4s', signalling_headcode),
+              format('%-4.4s', reservation_headcode),
+              ' ',
+              format('%-8.8s', service_code),
+              format('%-1.1s', portion_id),
+              format('%-3.3s', power_type),
+              format('%-4.4s', timing_load),
+              format('%-3.3s', speed),
+              format('%-6.6s', operating_characteristics),
+              format('%-1.1s', seating_class),
+              format('%-1.1s', sleeping_class),
+              format('%-1.1s', reservations),
+              ' ',
+              format('%-4.4s', catering),
+              format('%-4.4s', branding),
+              '    ',
+              format('%-5.5s', uic_code)
+            ].join) + "\n"
+          end
+          # rubocop:enable Metrics/AbcSize
+          # rubocop:enable Metrics/MethodLength
+
+          def hash
+            "#{tiploc}-#{tiploc_suffix}"
+          end
+
+          def to_hash_for_json
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rail_feeds/network_rail/schedule/train_schedule/location/intermediate.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      class TrainSchedule
+        class Location
+          # A class for holding information about a particular train's particular location
+          class Intermediate < Location
+            # @!attribute [rw] line
+            #   @return [String]
+            # @!attribute [rw] path
+            #   @return [String]
+            # @!attribute [rw] scheduled_arrival
+            #   @return [String] The scheduled time for arriving at the location.
+            # @!attribute [rw] scheduled_pass
+            #   @return [String] The scheduled time for passing the location.
+            # @!attribute [rw] scheduled_departure
+            #   @return [String] The sheduled time for departing from the location.
+            # @!attribute [rw] public_arrival
+            #   @return [String] The public arrival time (HHMM).
+            # @!attribute [rw] public_departure
+            #   @return [String] The public departure time (HHMM).
+            # @!attribute [rw] engineering_allowance
+            #   @return [Float] Number of minutes.
+            # @!attribute [rw] pathing_allowance
+            #   @return [Float] Number of minutes.
+            # @!attribute [rw] performance_allowance
+            #   @return [Float] Number of minutes.
+
+            attr_accessor :line, :path,
+                          :scheduled_arrival, :scheduled_departure, :scheduled_pass,
+                          :public_arrival, :public_departure,
+                          :engineering_allowance, :pathing_allowance,
+                          :performance_allowance
+
+            def initialize(**attributes)
+              attributes.each do |attribute, value|
+                send "#{attribute}=", value
+              end
+            end
+
+            # rubocop:disable Metrics/AbcSize
+            # rubocop:disable Metrics/MethodLength
+            # Initialize a new intermediate location from a CIF file line
+            def self.from_cif(line)
+              fail ArgumentError, "Invalid line:\n#{line}" unless line[0..1].eql?('LI')
+
+              new(
+                tiploc: line[2..8].strip,
+                tiploc_suffix: line[9].to_i,
+                scheduled_arrival: line[10..14].strip,
+                scheduled_departure: line[15..19].strip,
+                scheduled_pass: line[20..24].strip,
+                public_arrival: line[25..28].strip,
+                public_departure: line[29..32].strip,
+                platform: line[33..35].strip,
+                line: line[36..38].strip,
+                path: line[39..41].strip,
+                activity: line[42..53].strip,
+                engineering_allowance: parse_allowance(line[54..55].strip),
+                pathing_allowance: parse_allowance(line[56..57].strip),
+                performance_allowance: parse_allowance(line[58..59].strip)
+              )
+            end
+            # rubocop:enable Metrics/AbcSize
+            # rubocop:enable Metrics/MethodLength
+
+            # rubocop:disable Metrics/AbcSize
+            # rubocop:disable Metrics/MethodLength
+            def to_cif
+              format('%-80.80s', [
+                'LI',
+                format('%-7.7s', tiploc),
+                format('%-1.1s', tiploc_suffix),
+                format('%-5.5s', scheduled_arrival),
+                format('%-5.5s', scheduled_departure),
+                format('%-5.5s', scheduled_pass),
+                format('%-4.4s', public_arrival),
+                format('%-4.4s', public_departure),
+                format('%-3.3s', platform),
+                format('%-3.3s', line),
+                format('%-3.3s', path),
+                format('%-12.12s', activity),
+                format('%-2.2s', allowance_cif(engineering_allowance)),
+                format('%-2.2s', allowance_cif(pathing_allowance)),
+                format('%-2.2s', allowance_cif(performance_allowance))
+              ].join) + "\n"
+            end
+            # rubocop:enable Metrics/AbcSize
+            # rubocop:enable Metrics/MethodLength
+
+            # rubocop:disable Metrics/MethodLength
+            def to_hash_for_json
+              {
+                location_type: 'LI',
+                record_identity: 'LI',
+                tiploc_code: tiploc,
+                tiploc_instance: tiploc_suffix,
+                arrival: scheduled_arrival,
+                departure: scheduled_departure,
+                pass: scheduled_pass,
+                public_arrival: public_arrival,
+                public_departure: public_departure,
+                platform: platform,
+                line: line,
+                path: path,
+                engineering_allowance: allowance_json(engineering_allowance),
+                pathing_allowance: allowance_json(pathing_allowance),
+                performance_allowance: allowance_json(performance_allowance)
+              }
+            end
+            # rubocop:enable Metrics/MethodLength
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rail_feeds/network_rail/schedule/train_schedule/location/origin.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      class TrainSchedule
+        class Location
+          # A class for holding information about a particular train's origin location
+          class Origin < Location
+            # @!attribute [rw] line
+            #   @return [String]
+            # @!attribute [rw] scheduled_departure
+            #   @return [String] The sheduled time for departing from the location.
+            # @!attribute [rw] public_departure
+            #   @return [String] The public departure time (HHMM).
+            # @!attribute [rw] engineering_allowance
+            #   @return [Float] Number of minutes.
+            # @!attribute [rw] pathing_allowance
+            #   @return [Float] Number of minutes.
+            # @!attribute [rw] performance_allowance
+            #   @return [Float] Number of minutes.
+
+            attr_accessor :scheduled_departure, :public_departure, :line,
+                          :engineering_allowance, :pathing_allowance,
+                          :performance_allowance
+
+            def initialize(**attributes)
+              attributes.each do |attribute, value|
+                send "#{attribute}=", value
+              end
+            end
+
+            # rubocop:disable Metrics/AbcSize
+            # Initialize a new origin location from a CIF file line
+            def self.from_cif(line)
+              fail ArgumentError, "Invalid line:\n#{line}" unless line[0..1].eql?('LO')
+
+              new(
+                tiploc: line[2..8].strip,
+                tiploc_suffix: line[9].to_i,
+                scheduled_departure: line[10..14].strip,
+                public_departure: line[15..18].strip,
+                platform: line[19..21].strip,
+                line: line[22..24].strip,
+                activity: line[29..40].strip,
+                engineering_allowance: parse_allowance(line[25..26].strip),
+                pathing_allowance: parse_allowance(line[27..28].strip),
+                performance_allowance: parse_allowance(line[41..42].strip)
+              )
+            end
+            # rubocop:enable Metrics/AbcSize
+
+            # rubocop:disable Metrics/AbcSize
+            def to_cif
+              format('%-80.80s', [
+                'LO',
+                format('%-7.7s', tiploc),
+                format('%-1.1s', tiploc_suffix),
+                format('%-5.5s', scheduled_departure),
+                format('%-4.4s', public_departure),
+                format('%-3.3s', platform),
+                format('%-3.3s', line),
+                format('%-2.2s', allowance_cif(engineering_allowance)),
+                format('%-2.2s', allowance_cif(pathing_allowance)),
+                format('%-12.12s', activity),
+                format('%-2.2s', allowance_cif(performance_allowance))
+              ].join) + "\n"
+            end
+            # rubocop:enable Metrics/AbcSize
+
+            def to_hash_for_json
+              {
+                location_type: 'LO',
+                record_identity: 'LO',
+                tiploc_code: tiploc,
+                tiploc_instance: tiploc_suffix,
+                departure: scheduled_departure,
+                public_departure: public_departure,
+                platform: platform,
+                line: line,
+                engineering_allowance: allowance_json(engineering_allowance),
+                pathing_allowance: allowance_json(pathing_allowance),
+                performance_allowance: allowance_json(performance_allowance)
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end