rsmp 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f2687b5748524376a9316cadcf6776a6d9a9ccddbb8b763ea222246f7efb602
-  data.tar.gz: 942347899e8f26aae13eb6ead6dce7c2b2d17020c0e11b04af530a5e91904ed5
+  metadata.gz: 3f1f32aacd75ffad7d36662c3e7abd0b0a851b35b287f444dd63cdebc9db1c00
+  data.tar.gz: 32d9db803bc5ef274c1838cb961f677863745bb2e2eca105eb17b8ee4f39cea1
 SHA512:
-  metadata.gz: 77ba8af9b9be03e22bef3fa9a83c28f407c2371f7b6c3064e00396f8f9e2a1e088d52afb9c06270352c602cea91b88468e8674a5555b6a7383cd8b389f5a2567
-  data.tar.gz: 1f17f3055a0c88a2848fc5ef0b1fe93fd7ad02e321cdfbe90824f418c61054c6085940e5c3c87a186ab46ed7e6c5e8bceb0dc905e0109d055d484519cb030659
+  metadata.gz: a655dab4868d9544a0242303da7d26254f3d953ecc5d789c78f7e4553e946b98eebab7f59fa4ee69c736123dfa198417885595db490724b6238fa051b1fb2a87
+  data.tar.gz: f24fe238a17439e6e0b91e75f816733da49f9e348dd22cc00f3c68938505ca68ba7ed32575a71e9dfc18330a10f2b92fe23ade7679bdb3f0878b37e894fd55aa

data/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:3.4",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// A command to run when creating the container and rerun when the workspace content was updated while creating the container
+	   "updateContentCommand": "bundle install"
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.github/workflows/rubocop.yaml

@@ -0,0 +1,17 @@
+# This workflow runs RSpec tests
+
+name: Rubocop
+on: [push]
+jobs:
+  test:
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - run: bundle exec rubocop
+

data/.gitignore

@@ -1,10 +1,9 @@
-ignore
-log
-.DS_Store
-.rspec_status
-
+/.DS_Store
+/.rspec_status
+/ignore/
+/log/
 /.bundle/
-/.yardoc
+/.yardoc/
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -0,0 +1,80 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.4
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - '.bundle/**/*'
+    - 'ignore/**/*'
+    - 'config/private/**/*'
+
+# Allow longer line lengths for tests with long JSON strings
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Allow some reasonable flexibility for domain-specific code
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/ParameterLists:
+  Max: 5
+
+# Allow some blocks to be longer for complex configurations and tests
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'features/**/*'
+    - '*.gemspec'
+
+# Keep some reasonable exceptions
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Allow double negation for boolean coercion - common Ruby pattern
+Style/DoubleNegation:
+  Enabled: false
+
+# Allow mix-in usage at top level in test files
+Style/MixinUsage:
+  Exclude:
+    - 'spec/**/*'
+    - 'features/**/*'
+
+# Allow constant definition in blocks for test helpers
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*'
+
+# Keep critical domain-specific logic intact
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: false
+
+
+plugins:
+  - rubocop-rspec
+
+RSpec/MultipleExpectations:
+  Max: 20
+
+RSpec/ExampleLength:
+  Max: 50

data/Gemfile

@@ -1,5 +1,17 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rsmp.gemspec
 
 gemspec
+
+group :development do
+  gem 'aruba', '~> 2.3'
+  gem 'bundler', '~> 2.6'
+  gem 'cucumber', '~> 9.2'
+  gem 'rake', '~> 13.2'
+  gem 'rspec', '~> 3.13'
+  gem 'rspec-expectations', '~> 3.13'
+  gem 'rubocop', '~> 1.65'
+  gem 'rubocop-rspec', require: false
+  gem 'timecop', '~> 0.9'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.37.0)
+    rsmp (0.38.0)
       async (~> 2.32)
       colorize (~> 1.1)
       io-endpoint (~> 0.15)
@@ -19,6 +19,7 @@ GEM
       cucumber (>= 8.0, < 11.0)
       rspec-expectations (~> 3.4)
       thor (~> 1.0)
+    ast (2.4.3)
     async (2.32.0)
       console (~> 1.29)
       fiber-annotation
@@ -75,12 +76,21 @@ GEM
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     logger (1.7.0)
     memoist3 (1.0.0)
     metrics (0.15.0)
     mini_mime (1.1.5)
     multi_test (1.1.0)
     ostruct (0.6.3)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.5.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.3.0)
     regexp_parser (2.11.2)
     rsmp_schema (0.8.9)
@@ -99,6 +109,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.5)
+    rubocop (1.81.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rspec (3.7.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
     simpleidn (0.2.3)
     sys-uname (1.4.1)
       ffi (~> 1.1)
@@ -106,6 +134,9 @@ GEM
     thor (1.4.0)
     timecop (0.9.10)
     traces (0.18.2)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
 
 PLATFORMS
   arm64-darwin-22
@@ -127,6 +158,8 @@ DEPENDENCIES
   rsmp!
   rspec (~> 3.13)
   rspec-expectations (~> 3.13)
+  rubocop (~> 1.65)
+  rubocop-rspec
   timecop (~> 0.9)
 
 BUNDLED WITH

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/rsmp/cli.rb

@@ -1,186 +1,208 @@
 require 'thor'
-require 'rsmp'
+require_relative '../rsmp'
 
 module RSMP
   class CLI < Thor
-    desc "version", "Show version"
+    desc 'version', 'Show version'
     def version
       puts RSMP::VERSION
     end
 
-    desc "site", "Run RSMP site"
-    method_option :config, :type => :string, :aliases => "-c", banner: 'Path to .yaml config file'
-    method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
-    method_option :supervisors, :type => :string, :aliases => "-s", banner: 'ip:port,... list of supervisor to connect to'
-    method_option :core, :string => :string, banner: "Core version: [#{RSMP::Schema.core_versions.join(' ')}]", enum: RSMP::Schema.core_versions
-    method_option :type, :type => :string, :aliases => "-t", banner: 'Type of site: [tlc]', enum: ['tlc'], default: 'tlc'
-    method_option :log, :type => :string, :aliases => "-l", banner: 'Path to log file'
-    method_option :json, :type => :boolean, :aliases => "-j", banner: 'Show JSON messages in log'
+    desc 'site', 'Run RSMP site'
+    method_option :config, type: :string, aliases: '-c', banner: 'Path to .yaml config file'
+    method_option :id, type: :string, aliases: '-i', banner: 'RSMP site id'
+    method_option :supervisors, type: :string, aliases: '-s',
+                                banner: 'ip:port,... list of supervisor to connect to'
+    method_option :core, type: :string, banner: "Core version: [#{RSMP::Schema.core_versions.join(' ')}]", enum: RSMP::Schema.core_versions
+    method_option :type, type: :string, aliases: '-t', banner: 'Type of site: [tlc]', enum: ['tlc'],
+                         default: 'tlc'
+    method_option :log, type: :string, aliases: '-l', banner: 'Path to log file'
+    method_option :json, type: :boolean, aliases: '-j', banner: 'Show JSON messages in log'
     def site
-      settings = {}
-      log_settings = { 'active' => true }
+      settings, log_settings = load_site_configuration
+      apply_site_options(settings, log_settings)
+      site_class = determine_site_class(settings)
+      run_site(site_class, settings, log_settings)
+    rescue Interrupt
+      # ctrl-c
+    rescue StandardError => e
+      puts "Uncaught error: #{e}"
+      puts caller.join("\n")
+    end
+
+    desc 'supervisor', 'Run RSMP supervisor'
+    method_option :config, type: :string, aliases: '-c', banner: 'Path to .yaml config file'
+    method_option :id, type: :string, aliases: '-i', banner: 'RSMP site id'
+    method_option :ip, type: :string, banner: 'IP address to listen on'
+    method_option :port, type: :string, aliases: '-p', banner: 'Port to listen on'
+    method_option :core, type: :string, banner: "Core version: [#{RSMP::Schema.core_versions.join(' ')}]", enum: RSMP::Schema.core_versions
+    method_option :log, type: :string, aliases: '-l', banner: 'Path to log file'
+    method_option :json, type: :boolean, aliases: '-j', banner: 'Show JSON messages in log'
+    def supervisor
+      settings, log_settings = load_supervisor_configuration
+      apply_supervisor_options(settings, log_settings)
+      run_supervisor(settings, log_settings)
+    rescue Interrupt
+      # ctrl-c
+    end
+
+    desc 'convert', 'Convert SXL from YAML to JSON Schema'
+    method_option :in, type: :string, aliases: '-i', banner: 'Path to YAML input file'
+    method_option :out, type: :string, aliases: '-o', banner: 'Path to JSON Schema output file'
+    def convert
+      validate_convert_options
+      validate_input_file_exists
+      perform_conversion
+    end
+
+    no_commands do
+      def load_site_configuration
+        settings = {}
+        log_settings = { 'active' => true }
+
+        return [settings, log_settings] unless options[:config]
 
-      if options[:config]
         if File.exist? options[:config]
           settings = YAML.load_file options[:config]
-          log_settings = settings.delete('log') || {}
+          log_settings = settings.delete('log') || log_settings
         else
           puts "Error: Config #{options[:config]} not found"
           exit
         end
-      end
 
-      if options[:id]
-        settings['site_id'] = options[:id]
+        [settings, log_settings]
       end
+    end
 
-      if options[:supervisors]
-        settings['supervisors'] = []
-        options[:supervisors].split(',').each do |supervisor|
-          ip, port = supervisor.split ':'
-          ip = '127.0.0.1' if ip.empty?
-          port = '12111' if port.empty?
-          settings['supervisors'] << {"ip"=>ip, "port"=>port}
-        end
-      end
+    private
 
-      if options[:core]
-        settings['core_version'] = options[:core]
-      end
+    def apply_site_options(settings, log_settings)
+      apply_basic_site_options(settings)
+      parse_supervisors(settings) if options[:supervisors]
+      apply_log_options(log_settings)
+    end
 
-      site_class = RSMP::Site
-      site_type = options[:type] || settings['type']
-      case site_type
-        when 'tlc'
-          site_class = RSMP::TLC::TrafficControllerSite
-        else
-          puts "Error: Unknown site type #{site_type}"
-          exit
-      end
+    def apply_basic_site_options(settings)
+      settings['site_id'] = options[:id] if options[:id]
+      settings['core_version'] = options[:core] if options[:core]
+    end
 
-      if options[:log]
-        log_settings['path'] = options[:log]
+    def parse_supervisors(settings)
+      settings['supervisors'] = []
+      options[:supervisors].split(',').each do |supervisor|
+        ip, port = supervisor.split ':'
+        ip = '127.0.0.1' if ip.empty?
+        port = '12111' if port.empty?
+        settings['supervisors'] << { 'ip' => ip, 'port' => port }
       end
+    end
 
-      if options[:json]
-        log_settings['json'] = options[:json]
+    def determine_site_class(settings)
+      site_type = options[:type] || settings['type']
+      case site_type
+      when 'tlc'
+        RSMP::TLC::TrafficControllerSite
+      else
+        puts "Error: Unknown site type #{site_type}"
+        exit
       end
+    end
 
+    def run_site(site_class, settings, log_settings)
       Async do |task|
         task.annotate 'cli'
         loop do
-          begin
-            site = site_class.new(site_settings: settings, log_settings: log_settings)
-            site.start
-            site.wait
-          rescue Psych::SyntaxError => e
-            puts "Cannot read config file #{e}"
-            break
-          rescue RSMP::Schema::UnknownSchemaTypeError => e
-            puts "Cannot start site: #{e}"
-            break
-          rescue RSMP::Schema::UnknownSchemaVersionError => e
-            puts "Cannot start site: #{e}"
-            break
-          rescue RSMP::ConfigurationError => e
-            puts "Cannot start site: #{e}"
-            break
-          rescue RSMP::Restart
-            site.stop
-          end
+          site = site_class.new(site_settings: settings, log_settings: log_settings)
+          site.start
+          site.wait
+        rescue Psych::SyntaxError => e
+          puts "Cannot read config file #{e}"
+          break
+        rescue RSMP::Schema::UnknownSchemaTypeError, RSMP::Schema::UnknownSchemaVersionError,
+               RSMP::ConfigurationError => e
+          puts "Cannot start site: #{e}"
+          break
+        rescue RSMP::Restart
+          site.stop
         end
       end
-    rescue Interrupt
-      # cntr-c
-    rescue Exception => e
-      puts "Uncaught error: #{e}"
-      puts caller.join("\n")
     end
 
-    desc "supervisor", "Run RSMP supervisor"
-    method_option :config, :type => :string, :aliases => "-c", banner: 'Path to .yaml config file'
-    method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
-    method_option :ip, :type => :numeric, banner: 'IP address to listen on'
-    method_option :port, :type => :string, :aliases => "-p", banner: 'Port to listen on'
-    method_option :core, :string => :string, banner: "Core version: [#{RSMP::Schema.core_versions.join(' ')}]", enum: RSMP::Schema.core_versions
-    method_option :log, :type => :string, :aliases => "-l", banner: 'Path to log file'
-    method_option :json, :type => :boolean, :aliases => "-j", banner: 'Show JSON messages in log'
-    def supervisor
+    def load_supervisor_configuration
       settings = {}
       log_settings = { 'active' => true }
 
-      if options[:config]
-        if File.exist? options[:config]
-          settings = YAML.load_file options[:config]
-          log_settings = settings.delete 'log'
-        else
-          puts "Error: Config #{options[:config]} not found"
-          exit
-        end
-      end
+      return [settings, log_settings] unless options[:config]
 
-      if options[:id]
-        settings['site_id'] = options[:id]
+      if File.exist? options[:config]
+        settings = YAML.load_file options[:config]
+        log_settings = settings.delete('log') || log_settings
+      else
+        puts "Error: Config #{options[:config]} not found"
+        exit
       end
 
-      if options[:ip]
-        settings['ip'] = options[:ip]
-      end
+      [settings, log_settings]
+    end
 
-      if options[:port]
-        settings['port'] = options[:port]
-      end
+    def apply_supervisor_options(settings, log_settings)
+      apply_basic_supervisor_options(settings)
+      apply_core_version_option(settings)
+      apply_log_options(log_settings)
+    end
 
-      if options[:core]
-        settings['guest'] = {}
-        settings['guest']['core_version'] = options[:core]
-      end
+    def apply_basic_supervisor_options(settings)
+      settings['site_id'] = options[:id] if options[:id]
+      settings['ip'] = options[:ip] if options[:ip]
+      settings['port'] = options[:port] if options[:port]
+    end
 
-      if options[:log]
-        log_settings['path'] = options[:log]
-      end
+    def apply_core_version_option(settings)
+      return unless options[:core]
 
-      if options[:json]
-        log_settings['json'] = options[:json]
-      end
+      settings['guest'] ||= {}
+      settings['guest']['core_version'] = options[:core]
+    end
 
+    def apply_log_options(log_settings)
+      log_settings['path'] = options[:log] if options[:log]
+      log_settings['json'] = options[:json] if options[:json]
+    end
+
+    def run_supervisor(settings, log_settings)
       Async do |task|
         task.annotate 'cli'
-        supervisor = RSMP::Supervisor.new(supervisor_settings:settings,log_settings:log_settings)
+        supervisor = RSMP::Supervisor.new(supervisor_settings: settings, log_settings: log_settings)
         supervisor.start
         supervisor.wait
       rescue Psych::SyntaxError => e
         puts "Cannot read config file #{e}"
-      rescue RSMP::Schema::UnknownSchemaTypeError => e
-        puts "Cannot start supervisor: #{e}"
-      rescue RSMP::Schema::UnknownSchemaVersionError => e
-        puts "Cannot start supervisor: #{e}"
-      rescue RSMP::ConfigurationError => e
+      rescue RSMP::Schema::UnknownSchemaTypeError, RSMP::Schema::UnknownSchemaVersionError,
+             RSMP::ConfigurationError => e
         puts "Cannot start supervisor: #{e}"
       end
-    rescue Interrupt
-      # ctrl-c
     end
 
-    desc "convert", "Convert SXL from YAML to JSON Schema"
-    method_option :in, :type => :string, :aliases => "-i", banner: 'Path to YAML input file'
-    method_option :out, :type => :string, :aliases => "-o", banner: 'Path to JSON Schema output file'
-    def convert
+    def validate_convert_options
       unless options[:in]
-        puts "Error: Input option missing"
+        puts 'Error: Input option missing'
         exit
       end
 
-      unless options[:out]
-        puts "Error: Output option missing"
-        exit
-      end
+      return if options[:out]
 
-      unless File.exist? options[:in]
-        puts "Error: Input path file #{options[:in]} not found"
-        exit
-      end
+      puts 'Error: Output option missing'
+      exit
+    end
+
+    def validate_input_file_exists
+      return if File.exist? options[:in]
+
+      puts "Error: Input path file #{options[:in]} not found"
+      exit
+    end
 
+    def perform_conversion
       sxl = RSMP::Convert::Import::YAML.read options[:in]
       RSMP::Convert::Export::JSONSchema.write sxl, options[:out]
     end
@@ -190,5 +212,6 @@ module RSMP
     def self.exit_on_failure?
       true
     end
+    private_class_method :exit_on_failure?
   end
-end
+end

data/lib/rsmp/collect/ack_collector.rb

@@ -1,18 +1,19 @@
 module RSMP
   # Class for waiting for a message acknowledgement
   class AckCollector < Collector
-    def initialize proxy, options={}
-      raise ArgumentError.new("m_id must be provided") unless options[:m_id]
-      super proxy, options.merge(
+    def initialize(proxy, options = {})
+      raise ArgumentError, 'm_id must be provided' unless options[:m_id]
+
+      super(proxy, options.merge(
         filter: RSMP::Filter.new(ingoing: true, outgoing: false, type: 'MessageAck'),
         num: 1,
         title: 'message acknowledgement'
-      )
+      ))
     end
 
     # Check if we the MessageAck related to initiating request, identified by @m_id.
-    def acceptable? message
-      super(message) && message.attribute('oMId') == @m_id
+    def acceptable?(message)
+      super && message.attribute('oMId') == @m_id
     end
   end
-end
+end

data/lib/rsmp/collect/aggregated_status_collector.rb

@@ -1,11 +1,11 @@
 module RSMP
   # Class for waiting for an aggregated status response
   class AggregatedStatusCollector < Collector
-    def initialize proxy, options={}
-      super proxy, options.merge(
+    def initialize(proxy, options = {})
+      super(proxy, options.merge(
         filter: RSMP::Filter.new(ingoing: true, outgoing: false, type: 'AggregatedStatus'),
         title: 'aggregated status'
-      )
+      ))
     end
   end
-end
+end