foobara-sh-cli-connector 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b1018788f796d0bfc6ae3756d69ad14784d53f5e71a8a9858fe7b6911c79b9b
-  data.tar.gz: a629294b8364e4ba86fa1031f52e11266c835e2cfb371ecc479082d8f832afd9
+  metadata.gz: cf42373692dbe6435042ec12f9b7012eafcf597ca432d96e9f17029b38c29926
+  data.tar.gz: c31a1cc16a6beea651e161ebfcd2fb096f2ad32ff7608c78826047097e72fafd
 SHA512:
-  metadata.gz: 983515e65dcdbdc13c2a63c64fda3524bfc383275b80a7a3950f94acd84cd84bb52a2e2e073b688fc6410f3e6d5f7f11d7fae843b7503c32e7935872c4cd8ca8
-  data.tar.gz: 186305f0c99bc81f8093ca8cb987defe85afd879a29ec9eb653804e96498301b02a2e59cc388512f742d7363c103bbd958b6dca02d0ba48ac9f78f67fe59b1c0
+  metadata.gz: 8ad89d0a1eba1455cf58c82664a6046fc6c9145733f84296a4561c5ce8f9a551cc05fadc22b7033c023290852265e3f1a1d1de5c957786ece24e05ca475c29b8
+  data.tar.gz: e7117b39c7502619545eaa824667ad3adef557606abe1da98a68c6307a97bd8aa805f238e1b9b3c32102ad2a7131e69a8f05eb92f8fd0482a2937922f68a46f9

data/CHANGELOG.md

@@ -1,6 +1,14 @@
+## [0.0.4] - 2024-10-07
+
+* Introduce --no- options to negate boolean flags
+
+## [0.0.3]
+
+* Make use of single-command mode in Help command
+
 ## [0.0.2]
 
-* Add single command mode
+* Add single-command mode
 
 ## [0.0.1]
 

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/inputs_parser/option/attributes.rb

@@ -0,0 +1,35 @@
+module Foobara
+  module CommandConnectors
+    class ShCliConnector < CommandConnector
+      class InputsParser
+        class Option
+          class Attributes < Option
+            class << self
+              def applicable?(attribute_type)
+                attribute_type.extends?(BuiltinTypes[:attributes])
+              end
+
+              def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+                sub_required_attributes = if is_required
+                                            attribute_type.declaration_data[:required] || []
+                                          end || []
+
+                defaults = attribute_type.declaration_data[:defaults] || {}
+
+                attribute_type.element_types.map do |sub_attribute_name, sub_attribute_type|
+                  Option.attribute_to_options(
+                    sub_attribute_name,
+                    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]
+                  )
+                end.flatten
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Foobara
+  module CommandConnectors
+    class ShCliConnector < CommandConnector
+      class InputsParser
+        class Option
+          class Flag < Option
+            class << self
+              def applicable?(attribute_type)
+                attribute_type.extends?(BuiltinTypes[:boolean])
+              end
+
+              def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+                klasses = []
+
+                klasses << OnFlag if default != true
+                klasses << OffFlag if default != false
+
+                if klasses.size == 1
+                  klasses.first.new(
+                    attribute_name:,
+                    attribute_type:,
+                    is_required:,
+                    default:,
+                    prefix:
+                  )
+                else
+                  klasses.map do |klass|
+                    klass.new(
+                      attribute_name:,
+                      attribute_type:,
+                      is_required:,
+                      default:,
+                      prefix:
+                    )
+                  end
+                end
+              end
+            end
+
+            def _argument_text(_prefixed_name)
+              nil
+            end
+
+            def array?
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Foobara
+  module CommandConnectors
+    class ShCliConnector < CommandConnector
+      class InputsParser
+        class Option
+          class Model < Option
+            class << self
+              def applicable?(attribute_type)
+                attribute_type.extends?(BuiltinTypes[:model]) && !attribute_type.extends?(BuiltinTypes[:entity])
+              end
+
+              def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+                Option.attribute_to_options(
+                  attribute_name,
+                  attribute_type: attribute_type.target_class.attributes_type,
+                  prefix:,
+                  is_required:,
+                  default:
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "flag"
+
+module Foobara
+  module CommandConnectors
+    class ShCliConnector < CommandConnector
+      class InputsParser
+        class Option
+          class OffFlag < Flag
+            def supports_short_option?
+              false
+            end
+
+            def _long_option_name(prefixed_name)
+              "no-#{Util.kebab_case(prefixed_name)}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Foobara
+  module CommandConnectors
+    class ShCliConnector < CommandConnector
+      class InputsParser
+        class Option
+          class OnFlag < Flag
+          end
+        end
+      end
+    end
+  end
+end

data/src/sh_cli_connector/inputs_parser/option.rb

@@ -3,6 +3,24 @@ module Foobara
     class ShCliConnector < CommandConnector
       class InputsParser
         class Option
+          class << self
+            def attribute_to_options(attribute_name, attribute_type:, prefix:, is_required:, default:)
+              [Model, Attributes, Flag].each do |klass|
+                if klass.applicable?(attribute_type)
+                  return klass.attribute_to_options(
+                    attribute_name,
+                    attribute_type:,
+                    prefix:,
+                    is_required:,
+                    default:
+                  )
+                end
+              end
+
+              new(attribute_name:, attribute_type:, prefix:, is_required:, default:)
+            end
+          end
+
           attr_accessor :attribute_type, :attribute_name, :is_required, :prefix, :default
 
           def initialize(attribute_name:, attribute_type:, prefix:, is_required:, default:)
@@ -44,20 +62,28 @@ module Foobara
           end
 
           def to_args(short_options_used, full_paths)
-            path = _non_colliding_path(full_paths)
-            prefixed_name = path.join("_")
-            long_option_name = Util.kebab_case(prefixed_name)
-            short_option = attribute_name[0]
-
-            argument_text = Util.constantify(prefixed_name)
-            argument_text = "[#{argument_text}]" if boolean?
-
-            args = ["--#{long_option_name} #{argument_text}"]
-
-            # TODO: we should prioritize required options to get the short name in case of collision?
-            unless short_options_used.include?(short_option)
-              short_options_used << short_option
-              args << "-#{short_option} #{argument_text}"
+            prefixed_name = _prefixed_name(full_paths)
+            long_option_name = _long_option_name(prefixed_name)
+
+            argument_text = _argument_text(prefixed_name)
+
+            args = if argument_text
+                     ["--#{long_option_name} #{argument_text}"]
+                   else
+                     ["--#{long_option_name}"]
+                   end
+
+            if supports_short_option?
+              short_option = attribute_name[0]
+              # TODO: we should prioritize required options to get the short name in case of collision?
+              unless short_options_used.include?(short_option)
+                short_options_used << short_option
+                args << if argument_text
+                          "-#{short_option} #{argument_text}"
+                        else
+                          "-#{short_option}"
+                        end
+              end
             end
 
             args << description if description
@@ -65,6 +91,22 @@ module Foobara
             args
           end
 
+          def supports_short_option?
+            true
+          end
+
+          def _prefixed_name(full_paths)
+            _non_colliding_path(full_paths).join("_")
+          end
+
+          def _long_option_name(prefixed_name)
+            Util.kebab_case(prefixed_name)
+          end
+
+          def _argument_text(prefixed_name)
+            Util.constantify(prefixed_name)
+          end
+
           def full_path
             [*prefix, attribute_name]
           end
@@ -73,14 +115,14 @@ module Foobara
             is_required
           end
 
-          def boolean?
-            attribute_type.extends?(BuiltinTypes[:boolean])
-          end
-
           def array?
             attribute_type.extends?(BuiltinTypes[:array])
           end
 
+          def has_default?
+            !default.nil?
+          end
+
           def description
             desc = []
             attributes_description = attribute_type.description
@@ -99,7 +141,7 @@ module Foobara
               desc << "One of: #{one_of.join(", ")}"
             end
 
-            if default
+            if has_default?
               desc << "Default: #{default.inspect}"
             end
 

data/src/sh_cli_connector/inputs_parser/option_set.rb

@@ -28,10 +28,6 @@ module Foobara
               end
 
               parser.on(*args) do |value|
-                if value.nil? && option.boolean?
-                  value = true
-                end
-
                 h = result_source.result.parsed
 
                 option.prefix.each do |key|

data/src/sh_cli_connector/inputs_parser.rb

@@ -70,41 +70,23 @@ module Foobara
           default: nil,
           prefix: []
         )
-          if attribute_type.extends?(BuiltinTypes[:model]) && !attribute_type.extends?(BuiltinTypes[:entity])
-            attribute_to_option(
-              attribute_name,
-              attribute_type: attribute_type.target_class.attributes_type,
-              prefix:,
-              is_required:,
-              default:
-            )
-          elsif attribute_type.extends?(BuiltinTypes[:attributes])
-            sub_required_attributes = if is_required
-                                        attribute_type.declaration_data[:required] || []
-                                      end || []
-
-            defaults = attribute_type.declaration_data[:defaults] || {}
-
-            attribute_type.element_types.each_pair do |sub_attribute_name, sub_attribute_type|
-              attribute_to_option(
-                sub_attribute_name,
-                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]
-              )
+          options = InputsParser::Option.attribute_to_options(
+            attribute_name,
+            attribute_type:,
+            prefix:,
+            is_required:,
+            default:
+          )
+
+          if options.is_a?(::Array)
+            options.each do |option|
+              option_set << option
             end
           else
-            option = InputsParser::Option.new(
-              attribute_name:,
-              attribute_type:,
-              prefix:,
-              is_required:,
-              default:
-            )
-
-            option_set << option
-
+            # Unreachable but would be reachable if we didn't require inputs to be attributes
+            # :nocov:
+            option_set << options
+            # :nocov:
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foobara-sh-cli-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Miles Georgi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
@@ -45,6 +45,11 @@ files:
 - src/sh_cli_connector/globalish_parser.rb
 - src/sh_cli_connector/inputs_parser.rb
 - src/sh_cli_connector/inputs_parser/option.rb
+- src/sh_cli_connector/inputs_parser/option/attributes.rb
+- src/sh_cli_connector/inputs_parser/option/flag.rb
+- src/sh_cli_connector/inputs_parser/option/model.rb
+- src/sh_cli_connector/inputs_parser/option/off_flag.rb
+- src/sh_cli_connector/inputs_parser/option/on_flag.rb
 - src/sh_cli_connector/inputs_parser/option_set.rb
 - src/sh_cli_connector/request.rb
 - src/sh_cli_connector/serializers/cli_errors_serializer.rb
@@ -74,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Command-line connector for Foobara