foobara-sh-cli-connector 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d178ae7c8cb4da43e12cd56a3c3fac65dd337f43a99769312aa65db91c1383a
-  data.tar.gz: d49bc4d7519b53c994ded1a8a25159e2a81253da5f53fa752b49e429d663d490
+  metadata.gz: 49472f1f26b8949b20ca528c5c31222114081776021ae2136f4ce869192c53df
+  data.tar.gz: c663144dbd5aa9398d86d2d52593485e3bece7bdd10f18fbec1e3a4bb5c3e18d
 SHA512:
-  metadata.gz: 9f0e8c3f9d4502411f16040ed9aa0ce1973c1cdaa9b1c35d4924ef9300369b594517ef01d14343c4d68577fb2b9f7add74993fcbb467ab4d5bdb0d6c8da80d80
-  data.tar.gz: ce1ff601a3485f1e727a530bfe7463086bfbd5d30e355ff2fd1ffa092caeb45493d6cc21b39aeb2fa1ff4cde4348d3c1e95974645b775362cc5952e19ef1a6cd
+  metadata.gz: 2b6cb7dbb901da3888895fc2b01b036c9e3bfe10bc295d4adaed6fcf76748d3223b94933d9f71785cfb5766b0fd0788734076d2c36749117a7cea022ebbc1d94
+  data.tar.gz: da9ef8d6866ae4eaa8422932186fd061a1da733983664104629c959b198d136cff80e9488f804a59c54942629beb65919858ce4114a31fbcff47596ac7ca37c9

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.0.3]
+
+* Make use of single-command mode in Help command
+
+## [0.0.2]
+
+* Add single-command mode
+
 ## [0.0.1]
 
 * Add Apache-2.0 license, resulting in a dual-licensed project

data/src/sh_cli_connector/commands/help.rb

@@ -12,21 +12,34 @@ module Foobara
           def execute
             print_usage
 
-            if valid_argument?
-              if argument_is_command?
-                print_command_description
-                print_command_input_options
-              end
+            if single_command_mode?
+              print_command_description
+              print_command_input_options
             else
-              print_available_actions
-              print_available_commands
-            end
+              if valid_argument?
+                if argument_is_command?
+                  print_command_description
+                  print_command_input_options
+                end
+              else
+                print_available_actions
+                print_available_commands
+              end
 
-            print_global_options
+              print_global_options
+            end
 
             output_string
           end
 
+          def single_command_mode?
+            command_connector.single_command_mode
+          end
+
+          def command_connector
+            request.command_connector
+          end
+
           def print_usage
             if argument
               if valid_argument?
@@ -48,7 +61,13 @@ module Foobara
           end
 
           def print_usage_without_argument
-            output.puts "Usage: #{program_name} [GLOBAL_OPTIONS] [ACTION] [COMMAND_OR_TYPE] [COMMAND_INPUTS]"
+            usage = if single_command_mode?
+                      "[INPUTS]"
+                    else
+                      "[GLOBAL_OPTIONS] [ACTION] [COMMAND_OR_TYPE] [COMMAND_INPUTS]"
+                    end
+
+            output.puts "Usage: #{program_name} #{usage}"
           end
 
           def print_usage_for_argument
@@ -78,10 +97,6 @@ module Foobara
             command_connector.program_name
           end
 
-          def command_connector
-            request.command_connector
-          end
-
           def command_registry
             command_connector.command_registry
           end
@@ -101,7 +116,11 @@ module Foobara
           def command_class
             return @command_class if defined?(@command_class)
 
-            @command_class = argument && command_registry.transformed_command_from_name(argument)
+            @command_class = if single_command_mode?
+                               command_registry.all_transformed_command_classes.first
+                             else
+                               argument && command_registry.transformed_command_from_name(argument)
+                             end
           end
 
           def argument_is_action?
@@ -156,7 +175,7 @@ module Foobara
 
           def print_command_input_options
             output.puts
-            output.puts "Command inputs:"
+            output.puts single_command_mode? ? "Inputs:" : "Command inputs:"
             output.puts
             output.puts request.inputs_parser_for(command_class).parser.summarize
           end

data/src/sh_cli_connector/request.rb

@@ -5,6 +5,8 @@ module Foobara
 
       class Request < CommandConnectors::Request
         attr_accessor :argv,
+                      :single_command_mode,
+                      :command,
                       :globalish_options,
                       :inputs_argv,
                       :action,
@@ -15,7 +17,8 @@ module Foobara
                       :stderr,
                       :exit
 
-        def initialize(argv, exit: true, stdout: $stdout, stderr: $stderr, stdin: $stdin)
+        def initialize(argv, command:, exit: true, stdout: $stdout, stderr: $stderr, stdin: $stdin)
+          self.command = command
           self.argv = argv
           self.exit = exit
           self.stdin = stdin
@@ -31,6 +34,10 @@ module Foobara
           super()
         end
 
+        def single_command_mode?
+          !!command
+        end
+
         def input_serializer
           @input_serializer ||= begin
             input_format = globalish_options[:input_format]
@@ -86,6 +93,37 @@ module Foobara
         private
 
         def parse!
+          if single_command_mode?
+            parse_single_command!
+          else
+            parse_multi_command!
+          end
+
+          if action == "help"
+            globalish_options[:output_format] = "noop"
+          elsif action == "list"
+            globalish_options[:output_format] = "cli_tabular"
+          end
+
+          validate_parse_result!
+
+          set_serializers
+        end
+
+        def parse_single_command!
+          self.globalish_options = {}
+
+          if argv == ["--help"]
+            self.action = "help"
+          else
+            self.action = "run"
+            # TODO: needs to be the only registered command
+            self.argument = command
+            self.inputs_argv = argv
+          end
+        end
+
+        def parse_multi_command!
           if argv.empty?
             self.action = "help"
             self.globalish_options = {}
@@ -103,16 +141,6 @@ module Foobara
             self.action_options = result.parsed
             self.inputs_argv = result.remainder
           end
-
-          if action == "help"
-            globalish_options[:output_format] = "noop"
-          elsif action == "list"
-            globalish_options[:output_format] = "cli_tabular"
-          end
-
-          validate_parse_result!
-
-          set_serializers
         end
 
         def validate_parse_result!

data/src/sh_cli_connector.rb

@@ -1,15 +1,36 @@
 module Foobara
   module CommandConnectors
+    class AlreadyHasAConnectedCommand < StandardError; end
+
     class ShCliConnector < CommandConnector
-      attr_accessor :program_name
+      attr_accessor :program_name, :single_command_mode
 
-      def initialize(*, program_name: File.basename($PROGRAM_NAME), **, &)
+      def initialize(*, program_name: File.basename($PROGRAM_NAME), single_command_mode: false, **, &)
         self.program_name = program_name
+        self.single_command_mode = single_command_mode
         super(*, **, &)
 
         #        add_default_inputs_transformer ModelsToAttributesInputsTransformer
       end
 
+      def connect(...)
+        super.tap do
+          if single_command_mode
+            if command_registry.size > 1
+              raise AlreadyHasAConnectedCommand, "Can't have more than one command in single command mode"
+            end
+          end
+        end
+      end
+
+      def build_request(*, **, &)
+        command = if single_command_mode
+                    command_registry.foobara_all_command.first
+                  end
+
+        self.class::Request.new(*, **, command:, &)
+      end
+
       # TODO: this needs a better name... it's doing more than building.
       def build_response(request)
         response = super

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foobara-sh-cli-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Miles Georgi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-16 00:00:00.000000000 Z
+date: 2024-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - azimux@gmail.com
 executables: []
@@ -59,7 +59,7 @@ metadata:
   source_code_uri: https://github.com/foobara/sh-cli-connector
   changelog_uri: https://github.com/foobara/sh-cli-connector/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.5.18
+signing_key:
 specification_version: 4
 summary: Command-line connector for Foobara
 test_files: []