rsmp_schema 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4af83efed00aedf5d2a9b23ac6c35196410e675b027e031458c1bce89a1cb95c
-  data.tar.gz: 36d01a93675359c7c0765d1b2074ddda784bbf72103966c3225e92e3b98c274a
+  metadata.gz: b0579ab443900805112f5375443998cee0bb6e2519d0ac14240fd596b0662d37
+  data.tar.gz: 23f4c0411c5b3a823af27c1ff4ac4b9228cb41dd57c31e6bcac13a3ef5580941
 SHA512:
-  metadata.gz: 73ae42bfcaa494b84d81033bdee27afbe9ccab2ffd6e804f5d870f48b69250d0f2261f106934d6082d3bf386a7b7eb4d8e06572e726d8eb252302c0003e50b13
-  data.tar.gz: 59ec0746df9e384d242fa853db34a0dd8670c097a9494c75daac46efe7a4d560173e809158e29977a94170d3261320891860097b9763f71e2a47f2f446129acf
+  metadata.gz: a33b36f1c75147d6d222e4d519ad0952f96cb20ddc8cae33106bfd6959c952bc541148d5e61215fe706e0c5461dc8fceb2699c8e61e9c31dcfb7da2e2402c508
+  data.tar.gz: 5d238fe7f584fe68c4282fce2dfc11c68a04171828239c1828f622314f7ee0aa1604b1a4526d056f8d9346141e0173429b145da9887a77f6800cab1dccf267cb

data/.rubocop.yml

@@ -0,0 +1,55 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+
+# Allow longer line lengths for tests with long JSON strings
+Layout/LineLength:
+  Exclude:
+    - 'spec/**/*'
+
+# Allow some reasonable flexibility for domain-specific code
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# These specs often have multiple expectations to verify the behavior of a feature end-to-end.
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 40
+
+# Integration/schema specs describe features, not a specific class
+RSpec/DescribeClass:
+  Enabled: false
+
+# RSMP signal IDs use uppercase (M0001, A0303, S0007, etc.)
+Naming/FileName:
+  Enabled: false
+
+# Version strings in let names are meaningful (message_v3_1_2 etc.)
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+# frozen string literals is on by default from Ruby 3.4
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

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

data/Gemfile.lock

@@ -1,21 +1,63 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.10.0)
+    rsmp_schema (0.10.1)
       json_schemer (~> 2.5)
       thor (~> 1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.3)
     bigdecimal (4.0.1)
+    builder (3.3.0)
+    cucumber (9.2.1)
+      builder (~> 3.2)
+      cucumber-ci-environment (> 9, < 11)
+      cucumber-core (> 13, < 14)
+      cucumber-cucumber-expressions (~> 17.0)
+      cucumber-gherkin (> 24, < 28)
+      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-messages (> 19, < 25)
+      diff-lcs (~> 1.5)
+      mini_mime (~> 1.1)
+      multi_test (~> 1.1)
+      sys-uname (~> 1.2)
+    cucumber-ci-environment (10.0.1)
+    cucumber-core (13.0.3)
+      cucumber-gherkin (>= 27, < 28)
+      cucumber-messages (>= 20, < 23)
+      cucumber-tag-expressions (> 5, < 7)
+    cucumber-cucumber-expressions (17.1.0)
+      bigdecimal
+    cucumber-gherkin (27.0.0)
+      cucumber-messages (>= 19.1.4, < 23)
+    cucumber-html-formatter (21.15.1)
+      cucumber-messages (> 19, < 28)
+    cucumber-messages (22.0.0)
+    cucumber-tag-expressions (6.1.2)
     diff-lcs (1.6.2)
+    ffi (1.17.4)
+    ffi (1.17.4-x86_64-darwin)
     hana (1.3.7)
+    json (2.19.3)
     json_schemer (2.5.0)
       bigdecimal
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    memoist3 (1.0.0)
+    mini_mime (1.1.5)
+    multi_test (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.11.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.3.1)
     regexp_parser (2.11.3)
     rspec (3.13.2)
@@ -31,17 +73,52 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
+    rubocop (1.86.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.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    ruby-progressbar (1.13.0)
     simpleidn (0.2.3)
+    sys-uname (1.5.1)
+      ffi (~> 1.1)
+      memoist3 (~> 1.0.0)
     thor (1.5.0)
+    timecop (0.9.10)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   ruby
+  x86_64-darwin-22
 
 DEPENDENCIES
-  rake (~> 13.3)
+  bundler (~> 4.0)
+  cucumber (~> 9.2)
+  rake (~> 13.2)
   rsmp_schema!
   rspec (~> 3.13)
   rspec-expectations (~> 3.13)
+  rubocop (~> 1.65)
+  rubocop-rake
+  rubocop-rspec
+  timecop (~> 0.9)
 
 BUNDLED WITH
-   2.7.2
+  4.0.9

data/Rakefile

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require "bundler/gem_tasks"
-require "bundler/setup"
-require "rsmp_schema"
 
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rsmp_schema'
 
 task default: %i[]
 
 # Regenerate all SXL JSON Schemas.
 # Warning: This will destructively override all relevant files. Any changes will be lost!
 task :regenerate do
-  puts "Regenerating SXL JSON Schemas:"
+  puts 'Regenerating SXL JSON Schemas:'
   Dir.glob('schemas/tlc/*/sxl.yaml').each do |path|
     puts "  #{File.dirname(path)}"
     sxl = RSMP::Convert::Import::YAML.read path

data/examples/validate.rb

@@ -1,19 +1,19 @@
 require 'rsmp_schema'
 
 message = {
-  "mType" => "rSMsg",
-  "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
-  "type" => "CommandRequest",
-  "siteId" => [
-    { "sId" => "RN+SI0001" }
+  'mType' => 'rSMsg',
+  'mId' => '4173c2c8-a933-43cb-9425-66d4613731ed',
+  'type' => 'CommandRequest',
+  'siteId' => [
+    { 'sId' => 'RN+SI0001' }
   ],
-  "cId" => "O+14439=481WA001",
-  "arg" => [
+  'cId' => 'O+14439=481WA001',
+  'arg' => [
     {
-      "cCI" => "M0002",
-      "n" => "timeplan",
-      "cO" => "setPlan",
-      "v" => "1"
+      'cCI' => 'M0002',
+      'n' => 'timeplan',
+      'cO' => 'setPlan',
+      'v' => '1'
     }
   ]
 }
@@ -21,9 +21,9 @@ message = {
 # load schemas
 RSMP::Schema.setup
 
-# validating a message against core and tlc schemas 
-result = RSMP::Schema.validate( message, core: "3.2.1", tlc: "1.2.1" )
-if result == nil
+# validating a message against core and tlc schemas
+result = RSMP::Schema.validate(message, core: '3.2.1', tlc: '1.2.1')
+if result.nil?
   puts 'ok'
 else
   puts "failed: #{result.inspect}"

data/lib/rsmp_schema/cli.rb

@@ -1,35 +1,43 @@
 require 'thor'
 require 'rsmp_schema'
 
-module RSMP::Schema
-  class CLI < Thor
-    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
-      unless options[:in]
-        puts "Error: Input option missing"
-        exit
+module RSMP
+  module Schema
+    # Command-line interface for rsmp_schema tools.
+    class CLI < Thor
+      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!
+        sxl = RSMP::Convert::Import::YAML.read options[:in]
+        RSMP::Convert::Export::JSONSchema.write sxl, options[:out]
       end
 
-      unless options[:out]
-        puts "Error: Output option missing"
-        exit
+      # avoid Thor returnin 0 on failures, see
+      # https://github.com/coinbase/salus/pull/380/files
+      def self.exit_on_failure?
+        true
       end
 
-      unless File.exist? options[:in]
+      private
+
+      def validate_convert_options!
+        unless options[:in]
+          puts 'Error: Input option missing'
+          exit
+        end
+
+        unless options[:out]
+          puts 'Error: Output option missing'
+          exit
+        end
+
+        return if File.exist? options[:in]
+
         puts "Error: Input path file #{options[:in]} not found"
         exit
       end
-
-      sxl = RSMP::Convert::Import::YAML.read options[:in]
-      RSMP::Convert::Export::JSONSchema.write sxl, options[:out]
-    end
-
-    # avoid Thor returnin 0 on failures, see
-    # https://github.com/coinbase/salus/pull/380/files
-    def self.exit_on_failure?
-      true
     end
   end
-end
+end