rsmp 0.37.0 → 0.38.0

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -4,24 +4,24 @@ module RSMP
     class TrafficControllerSite < Site
       attr_accessor :main, :signal_plans
 
-      def initialize options={}
+      def initialize(options = {})
         # setup options before calling super initializer,
         # since build of components depend on options
         @sxl = 'traffic_light_controller'
         @security_codes = options[:site_settings]['security_codes']
-        @interval = options[:site_settings].dig('intervals','timer') || 1
+        @interval = options[:site_settings].dig('intervals', 'timer') || 1
         @startup_sequence = options[:site_settings]['startup_sequence'] || 'efg'
-        build_plans options[:site_settings].dig('signal_plans')
+        build_plans options[:site_settings]['signal_plans']
 
-        super options
+        super
 
-        unless main
-          raise ConfigurationError.new "TLC must have a main component"
-        end
+        return if main
+
+        raise ConfigurationError, 'TLC must have a main component'
       end
 
       def site_type_name
-        "TLC"
+        'TLC'
       end
 
       def start
@@ -35,35 +35,36 @@ module RSMP
         super
       end
 
-      def build_plans signal_plans
+      def build_plans(signal_plans)
         @signal_plans = {}
         return unless signal_plans
-        signal_plans.each_pair do |id,settings|
+
+        signal_plans.each_pair do |id, settings|
           states = nil
-          bands = nil
           cycle_time = settings['cycle_time']
           states = settings['states'] if settings
           dynamic_bands = settings['dynamic_bands'] if settings
 
-          @signal_plans[id.to_i] = SignalPlan.new(nr: id.to_i, cycle_time: cycle_time, states: states, dynamic_bands: dynamic_bands)
+          @signal_plans[id.to_i] =
+            SignalPlan.new(number: id.to_i, cycle_time: cycle_time, states: states, dynamic_bands: dynamic_bands)
         end
       end
 
-      def get_plan group_id, plan_nr
+      def get_plan(_group_id, _plan_nr)
         'NN1BB1'
       end
 
-      def build_component id:, type:, settings:{}
-        component = case type
+      def build_component(id:, type:, settings: {})
+        case type
         when 'main'
           TrafficController.new node: self,
-            id: id,
-            ntsOId: settings['ntsOId'],
-            xNId: settings['xNId'],
-            startup_sequence: @startup_sequence,
-            signal_plans: @signal_plans,
-            live_output: @site_settings['live_output'],
-            inputs: @site_settings['inputs']
+                                id: id,
+                                ntsoid: settings['ntsOId'],
+                                xnid: settings['xNId'],
+                                startup_sequence: @startup_sequence,
+                                signal_plans: @signal_plans,
+                                live_output: @site_settings['live_output'],
+                                inputs: @site_settings['inputs']
         when 'signal_group'
           group = SignalGroup.new node: self, id: id
           main.add_signal_group group
@@ -76,62 +77,62 @@ module RSMP
       end
 
       def start_tlc_timer
-        task_name = "tlc timer"
+        task_name = 'tlc timer'
         log "Starting #{task_name} with interval #{@interval} seconds", level: :debug
 
         @timer = @task.async do |task|
-        task.annotate task_name
+          task.annotate task_name
           run_tlc_timer task
         end
       end
 
-      def run_tlc_timer task
+      def run_tlc_timer(task)
         next_time = Time.now.to_f
         loop do
-          begin
-            timer(@clock.now)
-          rescue StandardError => e
-            distribute_error e, level: :internal
-          ensure
-            # adjust sleep duration to avoid drift. so wake up always happens on the
-            # same fractional second.
-            # note that Time.now is not monotonic. If the clock is changed,
-            # either manaully or via NTP, the sleep interval might jump.
-            # an alternative is to use ::Process.clock_gettime(::Process::CLOCK_MONOTONIC),
-            # to get the current time. this ensures a constant interval, but
-            # if the clock is changed, the wake up would then happen on a different
-            # fractional second
-            next_time += @interval
-            duration = next_time - Time.now.to_f
-            task.sleep duration
-          end
+          timer(@clock.now)
+        rescue StandardError => e
+          distribute_error e, level: :internal
+        ensure
+          # adjust sleep duration to avoid drift. so wake up always happens on the
+          # same fractional second.
+          # note that Time.now is not monotonic. If the clock is changed,
+          # either manaully or via NTP, the sleep interval might jump.
+          # an alternative is to use ::Process.clock_gettime(::Process::CLOCK_MONOTONIC),
+          # to get the current time. this ensures a constant interval, but
+          # if the clock is changed, the wake up would then happen on a different
+          # fractional second
+          next_time += @interval
+          duration = next_time - Time.now.to_f
+          task.sleep duration
         end
       end
 
       def stop_tlc_timer
         return unless @timer
+
         @timer.stop
         @timer = nil
       end
 
-      def timer now
+      def timer(now)
         return unless main
+
         main.timer now
       end
 
-      def verify_security_code level, code
-        raise ArgumentError.new("Level must be 1-2, got #{level}") unless (1..2).include?(level)
-        if @security_codes[level] != code
-          raise MessageRejected.new("Wrong security code for level #{level}")
-        end
+      def verify_security_code(level, code)
+        raise ArgumentError, "Level must be 1-2, got #{level}" unless (1..2).include?(level)
+        return unless @security_codes[level] != code
+
+        raise MessageRejected, "Wrong security code for level #{level}"
       end
 
-      def change_security_code level, old_code, new_code
+      def change_security_code(level, old_code, new_code)
         verify_security_code level, old_code
         @security_codes[level] = new_code
       end
 
-      def self.to_rmsp_bool bool
+      def self.to_rmsp_bool(bool)
         if bool
           'True'
         else
@@ -139,26 +140,26 @@ module RSMP
         end
       end
 
-      def self.from_rsmp_bool str
+      def self.from_rsmp_bool?(str)
         str == 'True'
       end
 
-      def self.make_status value, q='recent'
+      def self.make_status(value, quality = 'recent')
         case value
         when true, false
-          return to_rmsp_bool(value), q
+          [to_rmsp_bool(value), quality]
         else
-          return value, q
+          [value, quality]
         end
       end
 
-      def do_deferred key, item=nil
+      def do_deferred(key, _item = nil)
         case key
         when :restart
-          log "Restarting TLC", level: :info
+          log 'Restarting TLC', level: :info
           restart
         end
       end
     end
   end
-end
+end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.37.0"
+  VERSION = '0.38.0'.freeze
 end

data/lib/rsmp.rb

@@ -10,52 +10,86 @@ require 'json'
 require 'securerandom'
 require 'json_schemer'
 require 'async/queue'
+require 'rsmp_schema'
 
-require 'rsmp/rsmp'
-require 'rsmp/task'
-require 'rsmp/deep_merge'
-require 'rsmp/inspect'
-require 'rsmp/logging'
-require 'rsmp/protocol'
-require 'rsmp/node'
-require 'rsmp/supervisor'
-require 'rsmp/components'
-require 'rsmp/collect/distributor'
-require 'rsmp/collect/receiver'
-require 'rsmp/collect/queue'
-require 'rsmp/collect/collector'
-require 'rsmp/collect/state_collector'
-require 'rsmp/collect/filter'
-require 'rsmp/collect/matcher'
-require 'rsmp/collect/status_matcher'
-require 'rsmp/collect/command_matcher'
-require 'rsmp/collect/alarm_matcher'
-require 'rsmp/collect/status_collector'
-require 'rsmp/collect/command_response_collector'
-require 'rsmp/collect/aggregated_status_collector'
-require 'rsmp/collect/alarm_collector'
-require 'rsmp/collect/ack_collector'
-require 'rsmp/alarm_state'
-require 'rsmp/component_base'
-require 'rsmp/component'
-require 'rsmp/component_proxy'
-require 'rsmp/site'
-require 'rsmp/proxy'
-require 'rsmp/supervisor_proxy'
-require 'rsmp/site_proxy'
-require 'rsmp/error'
-require 'rsmp/message'
-require 'rsmp/logger'
-require 'rsmp/archive'
-require 'rsmp/tlc/traffic_controller_site'
-require 'rsmp/tlc/traffic_controller'
-require 'rsmp/tlc/detector_logic'
-require 'rsmp/tlc/signal_group'
-require 'rsmp/tlc/signal_plan'
-require 'rsmp/tlc/inputs'
-require 'rsmp/tlc/signal_priority'
-
-require 'rsmp/convert/import/yaml'
-require 'rsmp/convert/export/json_schema'
-
-require 'rsmp/version'
+require_relative 'rsmp/helpers/clock'
+require_relative 'rsmp/helpers/deep_merge'
+require_relative 'rsmp/helpers/error'
+require_relative 'rsmp/helpers/inspect'
+require_relative 'rsmp/log/logging'
+require_relative 'rsmp/log/archive'
+require_relative 'rsmp/log/filtering'
+require_relative 'rsmp/log/colorization'
+require_relative 'rsmp/log/logger'
+require_relative 'rsmp/message'
+require_relative 'rsmp/component/components'
+require_relative 'rsmp/component/alarm_state'
+require_relative 'rsmp/component/component_base'
+require_relative 'rsmp/component/component'
+require_relative 'rsmp/component/component_proxy'
+require_relative 'rsmp/collect/distributor'
+require_relative 'rsmp/collect/receiver'
+require_relative 'rsmp/collect/queue'
+require_relative 'rsmp/collect/collector/status'
+require_relative 'rsmp/collect/collector/reporting'
+require_relative 'rsmp/collect/collector/logging'
+require_relative 'rsmp/collect/collector'
+require_relative 'rsmp/collect/state_collector'
+require_relative 'rsmp/collect/filter'
+require_relative 'rsmp/collect/matcher'
+require_relative 'rsmp/collect/status_matcher'
+require_relative 'rsmp/collect/command_matcher'
+require_relative 'rsmp/collect/alarm_matcher'
+require_relative 'rsmp/collect/status_collector'
+require_relative 'rsmp/collect/command_response_collector'
+require_relative 'rsmp/collect/aggregated_status_collector'
+require_relative 'rsmp/collect/alarm_collector'
+require_relative 'rsmp/collect/ack_collector'
+require_relative 'rsmp/node/protocol'
+require_relative 'rsmp/node/task'
+require_relative 'rsmp/node/node'
+require_relative 'rsmp/node/site/site'
+require_relative 'rsmp/node/supervisor/modules/configuration'
+require_relative 'rsmp/node/supervisor/modules/connection'
+require_relative 'rsmp/node/supervisor/modules/sites'
+require_relative 'rsmp/node/supervisor/supervisor'
+require_relative 'rsmp/proxy/modules/state'
+require_relative 'rsmp/proxy/modules/watchdogs'
+require_relative 'rsmp/proxy/modules/acknowledgements'
+require_relative 'rsmp/proxy/modules/send'
+require_relative 'rsmp/proxy/modules/receive'
+require_relative 'rsmp/proxy/modules/versions'
+require_relative 'rsmp/proxy/modules/tasks'
+require_relative 'rsmp/proxy/proxy'
+require_relative 'rsmp/proxy/supervisor/modules/status'
+require_relative 'rsmp/proxy/supervisor/modules/commands'
+require_relative 'rsmp/proxy/supervisor/modules/alarms'
+require_relative 'rsmp/proxy/supervisor/modules/aggregated_status'
+require_relative 'rsmp/proxy/supervisor/supervisor_proxy'
+require_relative 'rsmp/proxy/site/modules/status'
+require_relative 'rsmp/proxy/site/modules/aggregated_status'
+require_relative 'rsmp/proxy/site/modules/alarms'
+require_relative 'rsmp/proxy/site/modules/commands'
+require_relative 'rsmp/proxy/site/site_proxy'
+require_relative 'rsmp/tlc/modules/system'
+require_relative 'rsmp/tlc/modules/modes'
+require_relative 'rsmp/tlc/modules/plans'
+require_relative 'rsmp/tlc/modules/signal_groups'
+require_relative 'rsmp/tlc/modules/inputs'
+require_relative 'rsmp/tlc/modules/outputs'
+require_relative 'rsmp/tlc/modules/detector_logics'
+require_relative 'rsmp/tlc/modules/traffic_data'
+require_relative 'rsmp/tlc/modules/startup_sequence'
+require_relative 'rsmp/tlc/modules/display'
+require_relative 'rsmp/tlc/modules/helpers'
+require_relative 'rsmp/tlc/startup_sequence'
+require_relative 'rsmp/tlc/traffic_controller_site'
+require_relative 'rsmp/tlc/traffic_controller'
+require_relative 'rsmp/tlc/detector_logic'
+require_relative 'rsmp/tlc/signal_group'
+require_relative 'rsmp/tlc/signal_plan'
+require_relative 'rsmp/tlc/input_states'
+require_relative 'rsmp/tlc/signal_priority'
+require_relative 'rsmp/convert/import/yaml'
+require_relative 'rsmp/convert/export/json_schema'
+require_relative 'rsmp/version'

data/rsmp.gemspec

@@ -1,48 +1,41 @@
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rsmp/version"
+require 'rsmp/version'
 require 'pathname'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rsmp"
+  spec.name          = 'rsmp'
   spec.version       = RSMP::VERSION
-  spec.authors       = ["Emil Tin"]
-  spec.email         = ["zf0f@kk.dk"]
+  spec.authors       = ['Emil Tin']
+  spec.email         = ['zf0f@kk.dk']
 
-  spec.summary       = %q{RoadSide Message Protocol (RSMP) library.}
-  spec.description   = %q{Easy RSMP site and supervisor communication.}
-  spec.homepage      = "https://github.com/rsmp-nordic/rsmp"
+  spec.summary       = 'RoadSide Message Protocol (RSMP) library.'
+  spec.description   = 'Easy RSMP site and supervisor communication.'
+  spec.homepage      = 'https://github.com/rsmp-nordic/rsmp'
   spec.licenses      = ['MIT']
-  spec.required_ruby_version = '>= 3.2.0'
+  spec.required_ruby_version = '>= 3.4.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/rsmp-nordic/rsmp"
-  spec.metadata["changelog_uri"] = "https://github.com/rsmp-nordic/rsmp/blob/master/CHANGELOG.md"
-  spec.metadata["bug_tracker_uri"] = "https://github.com/rsmp-nordic/rsmp/issues"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rsmp-nordic/rsmp'
+  spec.metadata['changelog_uri'] = 'https://github.com/rsmp-nordic/rsmp/blob/master/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/rsmp-nordic/rsmp/issues'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "logger", "~> 1.6"
-  spec.add_dependency "ostruct", "~> 0.6"
-  spec.add_dependency "async", "~> 2.32"
-  spec.add_dependency "io-stream", "~> 0.10"
-  spec.add_dependency "io-endpoint", "~> 0.15"
-  spec.add_dependency "colorize", "~> 1.1"
-  spec.add_dependency "rsmp_schema", "~> 0.8"
-
-  spec.add_development_dependency "bundler", "~> 2.6"
-  spec.add_development_dependency "rake", "~> 13.2"
-  spec.add_development_dependency "rspec", "~> 3.13"
-  spec.add_development_dependency "rspec-expectations", "~> 3.13"
-  spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "cucumber", "~> 9.2"
-  spec.add_development_dependency "aruba" , "~> 2.3"
+  spec.add_dependency 'async', '~> 2.32'
+  spec.add_dependency 'colorize', '~> 1.1'
+  spec.add_dependency 'io-endpoint', '~> 0.15'
+  spec.add_dependency 'io-stream', '~> 0.10'
+  spec.add_dependency 'logger', '~> 1.6'
+  spec.add_dependency 'ostruct', '~> 0.6'
+  spec.add_dependency 'rsmp_schema', '~> 0.8'
 end