rail_feeds 0.0.1

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      class TrainSchedule
+        class Location
+          # A class for holding info about a particular train's terminating location
+          class Terminating < Location
+            # @!attribute [rw] path
+            #   @return [String]
+            # @!attribute [rw] scheduled_arrival
+            #   @return [String] The scheduled time for arriving at the location.
+            # @!attribute [rw] public_arrival
+            #   @return [String] The public arrival time (HHMM).
+
+            attr_accessor :scheduled_arrival, :public_arrival, :path
+
+            def initialize(**attributes)
+              attributes.each do |attribute, value|
+                send "#{attribute}=", value
+              end
+            end
+
+            # rubocop:disable Metrics/AbcSize
+            # Initialize a new terminating from a CIF file line
+            def self.from_cif(line)
+              fail ArgumentError, "Invalid line:\n#{line}" unless line[0..1].eql?('LT')
+
+              new(
+                tiploc: line[2..8].strip,
+                tiploc_suffix: line[9].to_i,
+                scheduled_arrival: line[10..14].strip,
+                public_arrival: line[15..18].strip,
+                platform: line[19..21].strip,
+                path: line[22..24].strip,
+                activity: line[25..36].strip
+              )
+            end
+            # rubocop:enable Metrics/AbcSize
+
+            def to_cif
+              format('%-80.80s', [
+                'LT',
+                format('%-7.7s', tiploc),
+                format('%-1.1s', tiploc_suffix),
+                format('%-5.5s', scheduled_arrival),
+                format('%-4.4s', public_arrival),
+                format('%-3.3s', platform),
+                format('%-3.3s', path),
+                format('%-12.12s', activity)
+              ].join) + "\n"
+            end
+
+            def to_hash_for_json
+              {
+                location_type: 'LT',
+                record_identity: 'LT',
+                tiploc_code: tiploc,
+                tiploc_instance: tiploc_suffix,
+                arrival: scheduled_arrival,
+                public_arrival: public_arrival,
+                platform: platform,
+                path: path
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'location/intermediate'
+require_relative 'location/origin'
+require_relative 'location/terminating'
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      class TrainSchedule
+        # A class for holding information about a particular train's particular location.
+        class Location
+          # @!attribute [rw] tiploc
+          #   @return [String] The location where the change occurs.
+          # @!attribute [rw] tiploc_suffix
+          #   @return [String]
+          # @!attribute [rw] platform
+          #   @return [String]
+          # @!attribute [rw] activity
+          #   @return [String]
+
+          attr_accessor :tiploc, :tiploc_suffix, :platform, :activity
+
+          def initialize
+            fail 'This class should never be instantiated'
+          end
+
+          # Initialize a new location from a CIF file line
+          # (will be of the appropriate sub class)
+          def self.from_cif(line)
+            case line[0..1]
+            when 'LO'
+              Origin.from_cif line
+            when 'LI'
+              Intermediate.from_cif line
+            when 'LT'
+              Terminating.from_cif line
+            else
+              fail ArgumentError, "Improper line type #{line[0..1]}: #{line}"
+            end
+          end
+
+          def ==(other)
+            hash == other&.hash
+          end
+
+          def hash
+            "#{tiploc}-#{tiploc_suffix}"
+          end
+
+          private
+
+          def self.parse_allowance(value)
+            half = value[-1].eql?('H')
+            value = value.to_f
+            half ? value + 0.5 : value
+          end
+          private_class_method :parse_allowance
+
+          def allowance_cif(value)
+            i = value.to_i
+            f = value.to_f - i
+            f.eql?(0.5) ? "#{i}H" : i.to_s
+          end
+
+          def allowance_json(value)
+            return nil if value.nil?
+            i = value.to_i
+            f = value.to_f - i
+            f.eql?(0.5) ? "#{i}H" : i.to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,392 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'time'
+
+require_relative 'train_schedule/change_en_route'
+require_relative 'train_schedule/location'
+
+module RailFeeds
+  module NetworkRail
+    module Schedule
+      # rubocop:disable Metrics/ClassLength
+      # A class for holding information about a particular train
+      class TrainSchedule
+        include Comparable
+        include Schedule::Days
+        include Schedule::STPIndicator
+
+        # @!attribute [rw] uid
+        #   @return [String] The unique train identifier (letter then 5 numbers).
+        #   Along with start_date uniquely identifies a schedule.
+        # @!attribute [rw] category
+        #   @return [String]
+        # @!attribute [rw] status
+        #   @return [String]
+        # @!attribute [rw] stp_indicator
+        #   @return [String]
+        #   * C - cancellation of permanent schedule
+        #   * N - new STP schedule
+        #   * O - STP overlay of permanent schedule
+        #   * P - permanent
+        # @!attribute [rw] reservation_headcode
+        #   @return [Integer, nil] The train's headcode in the NRS
+        #   (National Reservation System).
+        # @!attribute [rw] signalling_headcode
+        #   @return [String, nil] The headcode used in signalling the service.
+        #   Will be nil for annonymous freight services.
+        # @!attribute [rw] service_code
+        #   @return [Integer] Used for attribution of revenue.
+        # @!attribute [rw] start_date
+        #   @return [Date] When the schedule starts.
+        # @!attribute [rw] end_date
+        #   @return [Date] When the schedule ends.
+        # @!attribute [rw] days
+        #   @return [Array<Boolean>] The days on which the service runs.
+        #   [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
+        # @!attribute [rw] bank_holiday_running
+        #   @return [String, nil] Whether the service runs on bank holidays.
+        #   * X - does not run on specified bank holiday Mondays.
+        #   * G - does not run on Glasgow bank holidays.
+        # @!attribute [rw] power_type
+        #   @return [String]
+        # @!attribute [rw] timing_load
+        #   @return [String, nil]
+        # @!attribute [rw] speed
+        #   @return [Integer] The planned speed (miles per hour).
+        # @!attribute [rw] operating_characteristics
+        #   @return [String, nil]
+        # @!attribute [rw] seating_class
+        #   @return [String, nil] The seating classes available.
+        #   * B or blank - First and Standard
+        #   * S - Standard only
+        # @!attribute [rw] sleeping_class
+        #   @return [String, nil] The sleeping classes available.
+        #   * B - First and Standard
+        #   * F - First only
+        #   * S - Standard only
+        # @!attribute [rw] reservations
+        #   @return [String, nil] The reservation recommendations.
+        #   * A - Reservations Compulsory
+        #   * E - Reservations for bicycles essential
+        #   * R - Reservations recommended
+        #   * S - Reservations possible from any station
+        #   * W - Wheelchair only reservations
+        # @!attribute [rw] catering
+        #   @return [String, nil] The catering available, any 2 of:
+        #   * H - Hot food available
+        #   * C - Buffet service
+        #   * R - Restaurant
+        #   * F - Restaurant for first class passengers
+        #   * M - Meal included for first class passengers
+        #   * T - Trolly service
+        # @!attribute [rw] branding
+        #   @return [String, nil] The service brand.
+        #   * E - Eurostar
+        # @!attribute [rw] uic
+        #   @return [Integer, nil] For train services running to/from continental Europe.
+        # @!attribute [rw] atoc
+        # @!attribute [rw] applicable_timetable
+        #   @return [Boolean, nil] Whether the service is subject to
+        #   performance monitoring (Applicable Timetable Service).
+        # @!attribute [rw] journey
+        #   @return [Array<Location, ChangeEnRoute>] The combined locations and changes.
+        #   change will precede location.
+
+        attr_accessor :uid, :category, :status,
+                      :reservation_headcode, :signalling_headcode, :service_code,
+                      :start_date, :end_date, :bank_holiday_running,
+                      :power_type, :timing_load, :speed, :operating_characteristics,
+                      :seating_class, :sleeping_class, :reservations, :catering,
+                      :branding, :uic, :atoc, :applicable_timetable, :journey
+        # Attributes from modules :days, :stp_indicator
+
+        # Initialize a new train
+        def initialize(**attributes)
+          @journey = []
+          attributes.each do |attribute, value|
+            send "#{attribute}=", value
+          end
+        end
+
+        # Add details from a CIF schedule file line to this train schedule
+        def update_from_cif(line)
+          type = line[0..1]
+
+          if type.eql?('BS')
+            update_basic_information line
+          elsif type.eql?('BX')
+            update_extra_information line
+
+          elsif %w[LO LI LT].include?(type)
+            journey.push Location.from_cif(line)
+
+          elsif type.eql?('CR')
+            journey.push ChangeEnRoute.from_cif(line)
+
+          else
+            fail ArgumentError, "Improper line type #{line[0..1]}: #{line}"
+          end
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Metrics/MethodLength
+        # Create a new train schedule from json data.
+        def self.from_json(json)
+          data = ::JSON.parse(json)['JsonScheduleV1']
+
+          locations = data.dig('schedule_segment', 'schedule_location')&.map do |location|
+            location_from_json location
+          end
+
+          new(
+            uid: data['CIF_train_uid'],
+            category: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_train_category')),
+            status: Schedule.nil_or_strip(data['train_status']),
+            reservation_headcode: Schedule.nil_or_i(data.dig('schedule_segment', 'CIF_headcode')),
+            signalling_headcode: Schedule.nil_or_strip(data.dig('schedule_segment', 'signalling_id')),
+            service_code: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_train_service_code')),
+            start_date: Date.parse(data['schedule_start_date']),
+            end_date: data['schedule_end_date'] ? Date.parse(data['schedule_end_date']) : nil,
+            days: days_from_cif(data['schedule_days_runs']),
+            bank_holiday_running: Schedule.nil_or_strip(data['CIF_bank_holiday_running']),
+            power_type: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_power_type')),
+            timing_load: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_timing_load')),
+            speed: Schedule.nil_or_i(data.dig('schedule_segment', 'CIF_speed')),
+            operating_characteristics: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_operating_characteristics')),
+            seating_class: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_train_class')),
+            sleeping_class: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_sleepers')),
+            reservations: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_reservations')),
+            catering: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_catering_code')),
+            branding: Schedule.nil_or_strip(data.dig('schedule_segment', 'CIF_service_branding')),
+            uic: Schedule.nil_or_i(data.dig('new_schedule_segment', 'uic_code')),
+            atoc: data['atoc_code'],
+            applicable_timetable: data['applicable_timetable'].eql?('Y'),
+            stp_indicator: stp_indicator_from_cif(data['CIF_stp_indicator']),
+            journey: locations
+          )
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Metrics/MethodLength
+
+        def to_cif
+          [
+            basic_to_cif,
+            extra_to_cif,
+            *journey.map(&:to_cif)
+          ].join
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
+        def to_json
+          {
+            'JsonScheduleV1' => {
+              'CIF_bank_holiday_running' => bank_holiday_running,
+              'CIF_stp_indicator' => stp_indicator_to_cif,
+              'CIF_train_uid' => uid,
+              'applicable_timetable' => (applicable_timetable ? 'Y' : 'N'),
+              'atoc_code' => atoc,
+              'schedule_start_date' => start_date.strftime('%Y-%m-%d'),
+              'train_status' => status,
+              'transaction_type' => 'Create',
+              'schedule_days_runs' => days_to_cif,
+              'schedule_end_date' => end_date.strftime('%Y-%m-%d'),
+              'new_schedule_segment' => {
+                'traction_class' => '',
+                'uic_code' => uic.to_s
+              },
+              'schedule_segment' => {
+                'signalling_id' => signalling_headcode,
+                'CIF_train_category' => category,
+                'CIF_headcode' => reservation_headcode.to_s,
+                'CIF_course_indicator' => nil,
+                'CIF_train_service_code' => service_code,
+                'CIF_business_sector' => '??',
+                'CIF_power_type' => power_type,
+                'CIF_timing_load' => timing_load,
+                'CIF_speed' => speed.to_s.rjust(3, '0'),
+                'CIF_operating_characteristics' => operating_characteristics,
+                'CIF_train_class' => seating_class,
+                'CIF_sleepers' => sleeping_class,
+                'CIF_reservations' => reservations,
+                'CIF_connection_indicator' => nil,
+                'CIF_catering_code' => catering,
+                'CIF_service_branding' => branding,
+                'schedule_location' => journey.map(&:to_hash_for_json).reject(&:nil?)
+              }
+            }
+          }.to_json
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
+
+        def hash
+          "#{uid}-#{start_date&.strftime('%Y%m%d')}"
+        end
+
+        def ==(other)
+          hash == other&.hash
+        end
+
+        def <=>(other)
+          values = [start_date, uid]
+          other_values = [other&.start_date, other&.uid]
+          values <=> other_values
+        end
+
+        private
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
+        def update_basic_information(line)
+          self.uid = line[3..8].strip
+          self.start_date = Schedule.make_date line[9..14]
+          self.end_date = Schedule.make_date line[15..20], allow_nil: line[2].eql?('D')
+          self.days = days_from_cif line[21..27]
+          self.bank_holiday_running = Schedule.nil_or_strip line[28]
+          self.status = Schedule.nil_or_strip(line[29])
+          self.category = Schedule.nil_or_strip(line[30..31])
+          self.signalling_headcode = Schedule.nil_or_strip line[32..35]
+          self.reservation_headcode = Schedule.nil_or_i line[36..39]
+          self.service_code = Schedule.nil_or_i line[41..48]
+          self.power_type = Schedule.nil_or_strip(line[50..52])
+          self.timing_load = Schedule.nil_or_strip line[53..56].strip
+          self.speed = Schedule.nil_or_i(line[57..59])
+          self.operating_characteristics = Schedule.nil_or_strip line[60..65].strip
+          self.seating_class = Schedule.nil_or_strip line[66]
+          self.sleeping_class = Schedule.nil_or_strip line[67]
+          self.reservations = Schedule.nil_or_strip line[68]
+          self.catering = Schedule.nil_or_strip(line[70..73])
+          self.branding = Schedule.nil_or_strip line[74..77].strip
+          self.stp_indicator = stp_indicator_from_cif line[79]
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
+
+        def update_extra_information(line)
+          self.uic = Schedule.nil_or_i line[6..10]
+          self.atoc = line[11..12]
+          self.applicable_timetable = line[13].eql?('Y')
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
+        def basic_to_cif
+          format('%-80.80s', [
+            'BSN',
+            format('%-6.6s', uid),
+            # rubocop:disable Style/FormatStringToken
+            format('%-6.6s', start_date&.strftime('%y%m%d')),
+            format('%-6.6s', end_date&.strftime('%y%m%d')),
+            # rubocop:enable Style/FormatStringToken
+            days_to_cif,
+            format('%-1.1s', bank_holiday_running),
+            format('%-1.1s', status),
+            format('%-2.2s', category),
+            format('%-4.4s', signalling_headcode),
+            format('%-4.4s', reservation_headcode),
+            '1',
+            format('%-8.8s', service_code),
+            ' ',
+            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),
+            ' ',
+            stp_indicator_to_cif
+          ].join) + "\n"
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
+
+        def extra_to_cif
+          format('%-80.80s', [
+            'BX    ',
+            format('%-5.5s', uic),
+            format('%-2.2s', atoc),
+            format('%-1.1s', (applicable_timetable ? 'Y' : 'N'))
+          ].join) + "\n"
+        end
+
+        def self.location_from_json(hash)
+          return lo_from_json(hash) if hash['record_identity'].eql?('LO')
+          return li_from_json(hash) if hash['record_identity'].eql?('LI')
+          return lt_from_json(hash) if hash['record_identity'].eql?('LT')
+          nil
+        end
+        private_class_method :location_from_json
+
+        def self.lo_from_json(hash)
+          Location::Origin.new(
+            tiploc: hash['tiploc_code'],
+            tiploc_suffix: hash['tiploc_instance'],
+            platform: Schedule.nil_or_strip(hash['platform']),
+            activity: :unknown,
+            scheduled_departure: hash['departure'],
+            public_departure: hash['public_departure'],
+            line: Schedule.nil_or_strip(hash['line']),
+            engineering_allowance: parse_allowance(hash['engineering_allowance']),
+            pathing_allowance: parse_allowance(hash['pathing_allowance']),
+            performance_allowance: parse_allowance(hash['performance_allowance'])
+          )
+        end
+        private_class_method :lo_from_json
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
+        def self.li_from_json(hash)
+          Location::Intermediate.new(
+            tiploc: hash['tiploc_code'],
+            tiploc_suffix: hash['tiploc_instance'],
+            platform: Schedule.nil_or_strip(hash['platform']),
+            activity: :unknown,
+            scheduled_arrival: hash['arrival'],
+            public_arrival: hash['public_arrival'],
+            scheduled_departure: hash['departure'],
+            public_departure: hash['public_departure'],
+            scheduled_pass: hash['pass'],
+            line: Schedule.nil_or_strip(hash['line']),
+            path: Schedule.nil_or_strip(hash['path']),
+            engineering_allowance: parse_allowance(hash['engineering_allowance']),
+            pathing_allowance: parse_allowance(hash['pathing_allowance']),
+            performance_allowance: parse_allowance(hash['performance_allowance'])
+          )
+        end
+        private_class_method :li_from_json
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/AbcSize
+
+        def self.lt_from_json(hash)
+          Location::Terminating.new(
+            tiploc: hash['tiploc_code'],
+            tiploc_suffix: hash['tiploc_instance'],
+            platform: Schedule.nil_or_strip(hash['platform']),
+            activity: :unknown,
+            scheduled_arrival: hash['arrival'],
+            public_arrival: hash['public_arrival'],
+            path: Schedule.nil_or_strip(hash['path'])
+          )
+        end
+        private_class_method :lt_from_json
+
+        def self.parse_allowance(value)
+          return nil if value.nil? || value.empty?
+          half = value[-1].eql?('H')
+          value = value.to_f
+          half ? value + 0.5 : value
+        end
+        private_class_method :parse_allowance
+      end
+      # rubocop:enable Metrics/ClassLength
+    end
+  end
+end

data/lib/rail_feeds/network_rail/schedule.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'schedule/days'
+require_relative 'schedule/stp_indicator'
+require_relative 'schedule/association'
+require_relative 'schedule/header'
+require_relative 'schedule/tiploc'
+require_relative 'schedule/train_schedule'
+require_relative 'schedule/fetcher'
+require_relative 'schedule/parser'
+require_relative 'schedule/data'
+
+module RailFeeds
+  module NetworkRail
+    module Schedule # :nodoc:
+      def self.nil_or_i(value)
+        return nil if value.to_s.strip.empty?
+        value.to_i
+      end
+
+      def self.nil_or_strip(value)
+        return nil if value.to_s.strip.empty?
+        value.strip
+      end
+
+      def self.make_date(value, allow_nil: false)
+        return nil if allow_nil && value.strip.empty?
+        return Date.new(9999, 12, 31) if value.eql?('999999')
+        Date.strptime(value, '%y%m%d')
+      end
+    end
+  end
+end