foobara-sh-cli-connector 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b95683633e9cd5d040607b37e7bfed49f2f3b0f8e7ff56dfe7d011a3df333a
-  data.tar.gz: c33d05e112fedd9af25c52892e03da6926e5f7100c0cd0af73f67fb2625e0f99
+  metadata.gz: 59a7b3a60573d7c637f5526e2a6d028c48906c7b5a865f2d204d64a48a25cf1f
+  data.tar.gz: dfc47f6db70767c09e9cab51c0c569d0ddc291f2d1abe3e29e5c7a4ecb7c9e11
 SHA512:
-  metadata.gz: c62ceb5b6ccc5facaaa96649a96ca1d70dc2fe3fe2a8cc2c0b38ca4d811adf0c0db092a2610155dd69d7ca05bfe40bedde44d07aae881239d0fcfdb1b85d91f0
-  data.tar.gz: c8ad6648b0e822b4660ad3393ad98ed08cc19c3d793e9b369916890220a83f3f212208b8e079067389ebc6ca27b564235b32e6249523a3d9abd25b35422179d8
+  metadata.gz: 6846e7d9362da9319f52d7c281feb802511199cdd0000aa6e7f40a161dc44fabc3a7676f66aee4e7795cccd6b29795efffaa2685db4e731d3f49777a9b1b91e6
+  data.tar.gz: 43c0b652981b6b113f92ebaaaa5f639e2915e02cb78a6e930e3e499b5524c1aa674eae9a5d7e99a603af08fff9e70c4cae1fe7c390d22db33f643acdee7cf412

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.0.17] - 2025-05-03
+
+- Deal with recent CommandConnector interface changes
+- Make ParseError a Foobara::Error
+
+## [0.0.16] - 2025-04-23
+
+- Give a way to force inputs to be fully prefixed even if they don't collide
+
 ## [0.0.15] - 2025-04-12
 
 - Default run args to ARGV

data/src/sh_cli_connector/action_parser.rb

@@ -14,11 +14,11 @@ module Foobara
           def action=(action)
             if @action
               # :nocov:
-              raise ParseError, "Action already set"
+              raise ParseError.new(message: "Action already set")
               # :nocov:
             elsif argument
               # :nocov:
-              raise ParseError, "Not expecting #{action} to appear after #{argument}"
+              raise ParseError.new(message: "Not expecting #{action} to appear after #{argument}")
               # :nocov:
             else
               @action = action
@@ -28,7 +28,7 @@ module Foobara
           def argument=(argument)
             if @argument
               # :nocov:
-              raise ParseError, "Argument already set"
+              raise ParseError.new(message: "Argument already set")
               # :nocov:
             end
 
@@ -37,17 +37,18 @@ module Foobara
 
           def validate!
             if action.nil?
-              raise ParseError,
-                    "Found invalid option #{remainder.first} but was expecting an action like 'run' or 'help'"
+              raise ParseError.new(
+                message: "Found invalid option #{remainder.first} but was expecting an action like 'run' or 'help'"
+              )
             end
 
             if action == "run"
               unless argument
-                raise ParseError, "Missing command to run"
+                raise ParseError.new(message: "Missing command to run")
               end
             elsif action == "describe"
               unless argument
-                raise ParseError, "Missing command or type to describe"
+                raise ParseError.new(message: "Missing command or type to describe")
               end
             end
           end

data/src/sh_cli_connector/globalish_parser.rb

@@ -93,7 +93,7 @@ module Foobara
           [result.parsed[:input_format], result.parsed[:output_format]].compact.uniq.each do |format|
             if format
               unless Serializer.serializer_from_symbol(format)
-                raise ParseError, "Unknown format: #{format}"
+                raise ParseError.new(message: "Unknown format: #{format}")
               end
             end
           end

data/src/sh_cli_connector/inputs_parser/option/attributes.rb

@@ -9,7 +9,14 @@ module Foobara
                 attribute_type.extends?(BuiltinTypes[:attributes])
               end
 
-              def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+              def attribute_to_options(
+                attribute_name,
+                attribute_type:,
+                prefix:,
+                is_required:,
+                default:,
+                always_prefix_inputs:
+              )
                 sub_required_attributes = if is_required
                                             attribute_type.declaration_data[:required] || []
                                           end || []
@@ -22,7 +29,8 @@ module Foobara
                     attribute_type: sub_attribute_type,
                     prefix: [*prefix, *attribute_name],
                     is_required: is_required && sub_required_attributes.include?(sub_attribute_name),
-                    default: defaults[sub_attribute_name]
+                    default: defaults[sub_attribute_name],
+                    always_prefix_inputs:
                   )
                 end.flatten
               end

data/src/sh_cli_connector/inputs_parser/option/flag.rb

@@ -9,7 +9,14 @@ module Foobara
                 attribute_type.extends?(BuiltinTypes[:boolean])
               end
 
-              def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+              def attribute_to_options(
+                attribute_name,
+                attribute_type:,
+                prefix:,
+                is_required:,
+                default:,
+                always_prefix_inputs:
+              )
                 klasses = []
 
                 klasses << OnFlag if default != true
@@ -21,7 +28,8 @@ module Foobara
                     attribute_type:,
                     is_required:,
                     default:,
-                    prefix:
+                    prefix:,
+                    always_prefix_inputs:
                   )
                 else
                   klasses.map do |klass|
@@ -30,7 +38,8 @@ module Foobara
                       attribute_type:,
                       is_required:,
                       default:,
-                      prefix:
+                      prefix:,
+                      always_prefix_inputs:
                     )
                   end
                 end

data/src/sh_cli_connector/inputs_parser/option/model.rb

@@ -9,13 +9,21 @@ module Foobara
                 attribute_type.extends?(BuiltinTypes[:model]) && !attribute_type.extends?(BuiltinTypes[:entity])
               end
 
-              def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+              def attribute_to_options(
+                attribute_name,
+                attribute_type:,
+                prefix:,
+                is_required:,
+                default:,
+                always_prefix_inputs:
+              )
                 Option.attribute_to_options(
                   attribute_name,
                   attribute_type: attribute_type.target_class.attributes_type,
                   prefix:,
                   is_required:,
-                  default:
+                  default:,
+                  always_prefix_inputs:
                 )
               end
             end

data/src/sh_cli_connector/inputs_parser/option.rb

@@ -4,7 +4,14 @@ module Foobara
       class InputsParser
         class Option
           class << self
-            def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+            def attribute_to_options(
+              attribute_name,
+              attribute_type:,
+              prefix:,
+              is_required:,
+              default:,
+              always_prefix_inputs:
+            )
               [Model, Attributes, Flag].each do |klass|
                 if klass.applicable?(attribute_type)
                   return klass.attribute_to_options(
@@ -12,23 +19,39 @@ module Foobara
                     attribute_type:,
                     prefix:,
                     is_required:,
-                    default:
+                    default:,
+                    always_prefix_inputs:
                   )
                 end
               end
 
-              new(attribute_name:, attribute_type:, prefix:, is_required:, default:)
+              new(
+                attribute_name:,
+                attribute_type:,
+                prefix:,
+                is_required:,
+                default:,
+                always_prefix_inputs:
+              )
             end
           end
 
-          attr_accessor :attribute_type, :attribute_name, :is_required, :prefix, :default
+          attr_accessor :attribute_type, :attribute_name, :is_required, :prefix, :default, :always_prefix_inputs
 
-          def initialize(attribute_name:, attribute_type:, prefix:, is_required:, default:)
+          def initialize(
+            attribute_name:,
+            attribute_type:,
+            prefix:,
+            is_required:,
+            default:,
+            always_prefix_inputs:
+          )
             self.attribute_type = attribute_type
             self.attribute_name = attribute_name
             self.prefix = prefix
             self.is_required = is_required
             self.default = default
+            self.always_prefix_inputs = always_prefix_inputs
 
             # TODO: support this
             # args << attributes_type.declaration_data[:one_of] if attributes_type.declaration_data.key?(:one_of)
@@ -96,7 +119,11 @@ module Foobara
           end
 
           def _prefixed_name(full_paths)
-            _non_colliding_path(full_paths).join("_")
+            if always_prefix_inputs
+              full_path.join("_")
+            else
+              _non_colliding_path(full_paths).join("_")
+            end
           end
 
           def _long_option_name(prefixed_name)

data/src/sh_cli_connector/inputs_parser.rb

@@ -13,15 +13,16 @@ module Foobara
             unless remainder.empty?
               # TODO: let's invert the order for single command mode: parse inputs first, then global from remainder,
               # and then raise if there's anything left
-              raise ParseError, "Unexpected argument: #{remainder.first}"
+              raise ParseError.new(message: "Unexpected argument: #{remainder.first}")
             end
           end
         end
 
-        attr_accessor :inputs_type, :parser, :current_array, :result
+        attr_accessor :inputs_type, :parser, :current_array, :result, :always_prefix_inputs
 
-        def initialize(inputs_type)
+        def initialize(inputs_type, always_prefix_inputs:)
           self.inputs_type = inputs_type
+          self.always_prefix_inputs = always_prefix_inputs
           self.parser = OptionParser.new
 
           setup_parser
@@ -53,7 +54,7 @@ module Foobara
           parser.set_summary_indent " "
 
           if inputs_type&.element_types&.any?
-            attribute_to_option
+            attribute_to_option(always_prefix_inputs:)
             # This feels wrong but the parser callback needs to access our result.
             # TODO: figure out this smell and fix it
             option_set.prepare_parser(self)
@@ -61,12 +62,12 @@ module Foobara
         end
 
         def option_set
-          # TODO: this feels wrong to pass self here...
           @option_set ||= OptionSet.new
         end
 
         def attribute_to_option(
           attribute_name = nil,
+          always_prefix_inputs:,
           attribute_type: inputs_type,
           is_required: true,
           default: nil,
@@ -77,7 +78,8 @@ module Foobara
             attribute_type:,
             prefix:,
             is_required:,
-            default:
+            default:,
+            always_prefix_inputs:
           )
 
           if options.is_a?(::Array)

data/src/sh_cli_connector/request.rb

@@ -1,7 +1,9 @@
 module Foobara
   module CommandConnectors
     class ShCliConnector < CommandConnector
-      class ParseError < StandardError; end
+      class ParseError < Foobara::Error
+        context({})
+      end
 
       class Request < CommandConnector::Request
         attr_accessor :argv,
@@ -51,7 +53,7 @@ module Foobara
 
             unless serializer_class
               # :nocov:
-              raise ParseError, "Unknown input format: #{input_format}"
+              raise ParseError.new(message: "Unknown input format: #{input_format}")
               # :nocov:
             end
 
@@ -79,7 +81,7 @@ module Foobara
         end
 
         def inputs_parser_for(command_class = self.command_class)
-          InputsParser.new(command_class.inputs_type)
+          InputsParser.new(command_class.inputs_type, always_prefix_inputs: command_connector.always_prefix_inputs)
         end
 
         def globalish_parser
@@ -151,7 +153,7 @@ module Foobara
 
             if result.remainder.any?
               # :nocov:
-              raise ParseError, "Found invalid options #{globalish_parser.remainder}"
+              raise ParseError.new(message: "Found invalid options #{globalish_parser.remainder}")
               # :nocov:
             end
 

data/src/sh_cli_connector.rb

@@ -3,10 +3,18 @@ module Foobara
     class AlreadyHasAConnectedCommand < StandardError; end
 
     class ShCliConnector < CommandConnector
-      attr_accessor :program_name, :single_command_mode
-
-      def initialize(*, program_name: File.basename($PROGRAM_NAME), single_command_mode: false, **, &)
+      attr_accessor :program_name, :single_command_mode, :always_prefix_inputs
+
+      def initialize(
+        *,
+        program_name: File.basename($PROGRAM_NAME),
+        single_command_mode: false,
+        always_prefix_inputs: false,
+        **,
+        &
+      )
         self.program_name = program_name
+        self.always_prefix_inputs = always_prefix_inputs
 
         connect_args = if single_command_mode
                          self.single_command_mode = true
@@ -62,7 +70,21 @@ module Foobara
         response
       end
 
-      def request_to_command(request)
+      def request_to_command_class(request)
+        super
+      rescue CommandConnector::NoCommandFoundError, ParseError => e
+        request.error = e
+        nil
+      end
+
+      def request_to_command_inputs(request)
+        super
+      rescue CommandConnector::NoCommandFoundError, ParseError => e
+        request.error = e
+        nil
+      end
+
+      def request_to_command_instance(request)
         super
       rescue CommandConnector::NoCommandFoundError, ParseError => e
         request.error = e

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara-sh-cli-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.17
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Command-line connector for Foobara
 test_files: []