foobara 0.0.121 → 0.0.122

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f2fbb04c10d91d28ece159f2a3c229ba4698579acac813e19625380564928b
-  data.tar.gz: acbe6117c76fc36741583db4bffdf26db37f8f54f75d74b2c810b7f44a37a8f4
+  metadata.gz: 58d1193f368aef3f0903e67152b0b7a3a1a84370a319a0f046d2d328249897be
+  data.tar.gz: 27617857c8d1ce1fd392fdfdad9348206fea4dad29f2ca8f68fa712abc52c048
 SHA512:
-  metadata.gz: 70b1abede851dcafe1209e13c2d725e39240ab4746666a3b5683274f19051f6dfc84d188a05aac77b3ca7642c0c86661bcf040b5d444109a1a9884ff3f668071
-  data.tar.gz: ca9b9cdeca157bc2595f9de3888f88eb4ef358036591bfd74793306fb5ff20912bde4570ea97c13bfc396c8e025f2d41051815d02fe1c77f1c4761ef624c2c69
+  metadata.gz: daf5f6327e44917051a5c00a53d2e875dc744b20af07b84801c1fea3f3b581e0afa3d38636b77b2e044ee85b25c280461fb78e1f9d0150a2e7023f39749d91e4
+  data.tar.gz: 5cdc61d92d02180c083bb764ae52b6ae903f08bb186b6a60f66af4b47e8c32b90b950ba50a613409eda941ed1fb95d66b6751a9b580841102cffcf3b99e7d34e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# [0.0.122] - 2025-05-13
+
+- Add command connector sugar features and implement several command connector sugars
+
 # [0.0.121] - 2025-05-11
 
 - Handle gnarly bugs that arise when creating a custom type named model (or entity or detached_entity)

data/projects/command_connectors/lib/foobara/command_connectors.rb

@@ -6,6 +6,27 @@ require "json"
 module Foobara
   module CommandConnectors
     foobara_domain!
+
+    class << self
+      def install!
+        CommandConnector.add_desugarizer Desugarizers::SymbolsToTrue
+        CommandConnector.add_desugarizer Desugarizers.rename :allow_if, :allowed_rule
+        CommandConnector.add_desugarizer Desugarizers.rename :inputs, :inputs_transformers
+        CommandConnector.add_desugarizer Desugarizers.rename :result, :result_transformers
+        CommandConnector.add_desugarizer Desugarizers.rename :request, :request_mutators
+        CommandConnector.add_desugarizer Desugarizers.rename :response, :response_mutators
+        CommandConnector.add_desugarizer Desugarizers::Attributes::OnlyInputs
+        CommandConnector.add_desugarizer Desugarizers::Attributes::RejectInputs
+        CommandConnector.add_desugarizer Desugarizers::Attributes::OnlyResult
+        CommandConnector.add_desugarizer Desugarizers::Attributes::RejectResult
+        CommandConnector.add_desugarizer Desugarizers::Auth
+      end
+
+      def reset_all
+        remove_instance_variable("@desugarizer") if defined?(@desugarizer)
+        remove_instance_variable("@desugarizers") if defined?(@desugarizers)
+      end
+    end
   end
 
   Monorepo.project "command_connectors"

data/projects/command_connectors/src/command_connector/concerns/desugarizers.rb

@@ -0,0 +1,51 @@
+module Foobara
+  class CommandConnector
+    module Concerns
+      module Desugarizers
+        include Concern
+
+        module ClassMethods
+          def add_desugarizer(desugarizer)
+            if desugarizer.is_a?(::Class)
+              desugarizer = desugarizer.new
+            end
+
+            desugarizers << desugarizer
+            remove_instance_variable("@desugarizer") if defined?(@desugarizer)
+          end
+
+          def desugarizer
+            return @desugarizer if defined?(@desugarizer)
+
+            processors = desugarizers
+
+            case processors.size
+            when 0
+              # TODO: test this code path by removing all desugarizers in a spec.
+              # :nocov:
+              nil
+              # :nocov:
+            when 1
+              # TODO: test this code path by removing all desugarizers in a spec.
+              # :nocov:
+              processors.first
+              # :nocov:
+            else
+              Value::Processor::Pipeline.new(processors:)
+            end
+          end
+
+          def desugarizers
+            @desugarizers ||= []
+
+            if superclass == Object
+              @desugarizers
+            else
+              @desugarizers + superclass.desugarizers
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/command_connector.rb

@@ -2,6 +2,8 @@ module Foobara
   class CommandConnector
     class UnexpectedSensitiveTypeInManifestError < StandardError; end
 
+    include Concerns::Desugarizers
+
     class << self
       def find_builtin_command_class(command_class_name)
         Util.find_constant_through_class_hierarchy(self, "Commands::#{command_class_name}")
@@ -313,9 +315,15 @@ module Foobara
       delayed_connections.clear
     end
 
-    def connect(registerable, *, authenticator: nil, **)
-      if authenticator
+    def connect(*args, **opts)
+      args, opts = desugarize_connect_args(args, opts)
+
+      registerable = args.first
+
+      if opts.key?(:authenticator)
+        authenticator = opts[:authenticator]
         authenticator = self.class.to_authenticator(authenticator)
+        opts = opts.merge(authenticator:)
       end
 
       case registerable
@@ -326,15 +334,15 @@ module Foobara
           # :nocov:
         end
 
-        command_registry.register(registerable, *, authenticator:, **)
+        command_registry.register(*args, **opts)
       when Module
         if registerable.foobara_organization?
           registerable.foobara_domains.map do |domain|
-            connect(domain, *, authenticator:, **)
+            connect(domain, *args[1..], **opts)
           end.flatten
         elsif registerable.foobara_domain?
           registerable.foobara_all_command(mode: Namespace::LookupMode::DIRECT).map do |command_class|
-            Util.array(connect(command_class, *, authenticator:, **))
+            Util.array(connect(command_class, *args[1..], **opts))
           end.flatten
         else
           # :nocov:
@@ -342,7 +350,7 @@ module Foobara
           # :nocov:
         end
       when Symbol, String
-        connect_delayed(registerable, *, authenticator:, **)
+        connect_delayed(*args, **opts)
       else
         # :nocov:
         raise "Don't know how to register #{registerable} (#{registerable.class})"
@@ -350,6 +358,17 @@ module Foobara
       end
     end
 
+    def desugarize_connect_args(args, opts)
+      if self.class.desugarizer
+        self.class.desugarizer.process_value!([args, opts])
+      else
+        # TODO: test this code path by removing all desugarizers in a spec.
+        # :nocov:
+        [args, opts]
+        # :nocov:
+      end
+    end
+
     def build_request(...)
       self.class::Request.new(...).tap do |request|
         # TODO: feels like a smell

data/projects/command_connectors/src/desugarizer.rb

@@ -0,0 +1,44 @@
+module Foobara
+  module CommandConnectors
+    class Desugarizer < Value::Transformer
+      class << self
+        def requires_declaration_data?
+          false
+        end
+      end
+
+      def transform(value)
+        desugarize(value)
+      end
+
+      # in case of tie, right wins, like with Hash#merge
+      def merge(left, right)
+        return left if right.nil?
+        return right if left.nil?
+
+        if left.is_a?(::Hash) && right.is_a?(::Hash)
+          # TODO: remove :nocov: once we have an only: and/or reject: desugarizer with a test that
+          # merges them together.
+          # :nocov:
+          left.merge(right)
+          # :nocov:
+        else
+          Util.array(left) + Util.array(right)
+        end
+      end
+
+      def rename(args_and_opts, sugar_name, official_name)
+        args, opts = args_and_opts
+
+        opts = opts.dup
+        sugar = opts.delete(sugar_name)
+        official = opts.delete(official_name)
+
+        [
+          args,
+          opts.merge(official_name => merge(sugar, official))
+        ]
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/attributes/only_inputs.rb

@@ -0,0 +1,19 @@
+require_relative "../attributes"
+
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class Attributes < Desugarizer
+        class OnlyInputs < Attributes
+          def desugarizer_symbol
+            :only
+          end
+
+          def opts_key
+            :inputs_transformers
+          end
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/attributes/only_result.rb

@@ -0,0 +1,19 @@
+require_relative "../attributes"
+
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class Attributes < Desugarizer
+        class OnlyResult < Attributes
+          def desugarizer_symbol
+            :only
+          end
+
+          def opts_key
+            :result_transformers
+          end
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/attributes/reject_inputs.rb

@@ -0,0 +1,19 @@
+require_relative "../attributes"
+
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class Attributes < Desugarizer
+        class RejectInputs < Attributes
+          def desugarizer_symbol
+            :reject
+          end
+
+          def opts_key
+            :inputs_transformers
+          end
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/attributes/reject_result.rb

@@ -0,0 +1,19 @@
+require_relative "../attributes"
+
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class Attributes < Desugarizer
+        class RejectResult < Attributes
+          def desugarizer_symbol
+            :reject
+          end
+
+          def opts_key
+            :result_transformers
+          end
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/attributes.rb

@@ -0,0 +1,58 @@
+require_relative "../desugarizer"
+
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class Attributes < Desugarizer
+        def desugarizer_symbol
+          # :nocov:
+          raise "subclass responsibility"
+          # :nocov:
+        end
+
+        def opts_key
+          # :nocov:
+          raise "subclass responsibility"
+          # :nocov:
+        end
+
+        def applicable?(args_and_opts)
+          _args, opts = args_and_opts
+
+          return false unless opts.key?(opts_key)
+
+          transformers = opts[opts_key]
+          transformers = Util.array(transformers)
+
+          transformers.any? do |transformer|
+            transformer.is_a?(::Hash) && transformer.key?(desugarizer_symbol)
+          end
+        end
+
+        def desugarize(args_and_opts)
+          args, opts = args_and_opts
+
+          transformers = opts[opts_key]
+          is_array = transformers.is_a?(::Array)
+
+          transformers = Util.array(transformers)
+
+          transformers = transformers.map do |transformer|
+            if transformer.is_a?(::Hash) && transformer.key?(desugarizer_symbol)
+              params = transformer[desugarizer_symbol]
+              AttributesTransformers.send(desugarizer_symbol, *params)
+            else
+              transformer
+            end
+          end
+
+          transformers = transformers.first unless is_array
+
+          opts = opts.merge(opts_key => transformers)
+
+          [args, opts]
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/auth.rb

@@ -0,0 +1,20 @@
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class Auth < Desugarizer
+        def applicable?(args_and_opts)
+          args_and_opts.last.key?(:auth)
+        end
+
+        def desugarize(args_and_opts)
+          args, opts = args_and_opts
+
+          opts = opts.dup
+          auth = opts.delete(:auth)
+
+          [args, opts.merge(requires_authentication: auth)]
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/rename_key.rb

@@ -0,0 +1,45 @@
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class << self
+        def rename(sugar_name, official_name)
+          class_name = [name, Util.classify(sugar_name)].join("::")
+
+          Util.make_class(class_name, RenameKey).tap do |klass|
+            klass.singleton_class.attr_accessor :sugar_name, :official_name
+            klass.sugar_name = sugar_name
+            klass.official_name = official_name
+          end
+        end
+      end
+
+      # TODO: Make this the default. Deprecate :inputs_transformers
+      class RenameKey < Desugarizer
+        class << self
+          attr_accessor :sugar_name, :official_name
+        end
+
+        def applicable?(args_and_opts)
+          _args, opts = args_and_opts
+          opts.key?(sugar_name)
+        end
+
+        def sugar_name
+          self.class.sugar_name
+        end
+
+        def official_name
+          self.class.official_name
+        end
+
+        def desugarize(args_and_opts)
+          rename(args_and_opts, sugar_name, official_name)
+        end
+
+        def priority
+          Priority::HIGH
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/desugarizers/symbols_to_true.rb

@@ -0,0 +1,38 @@
+require_relative "../desugarizer"
+
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class SymbolsToTrue < Desugarizer
+        def applicable?(args_and_opts)
+          args, _opts = args_and_opts
+          args.size > 1
+        end
+
+        def desugarize(args_and_opts)
+          args, opts = args_and_opts
+
+          command_class, *symbols = args
+
+          new_opts = {}
+
+          symbols.each do |arg|
+            if arg.is_a?(::Symbol)
+              new_opts[arg] = true
+            else
+              # :nocov:
+              raise "Was not expecting non-symbol arg: #{arg}"
+              # :nocov:
+            end
+          end
+
+          [[command_class], opts.merge(new_opts)]
+        end
+
+        def priority
+          Priority::FIRST
+        end
+      end
+    end
+  end
+end

data/projects/type_declarations/src/attributes_transformers/only.rb

@@ -2,6 +2,11 @@ module Foobara
   class AttributesTransformers < TypeDeclarations::TypedTransformer
     class << self
       def only(*attribute_names)
+        symbol = symbol_for_attribute_names(attribute_names)
+        existing = Only.foobara_lookup(symbol, mode: Namespace::LookupMode::DIRECT)
+
+        return existing if existing
+
         transformer_class = Class.new(Only)
         transformer_class.only_attributes = attribute_names
 
@@ -18,7 +23,9 @@ module Foobara
         attr_accessor :only_attributes
 
         def symbol
-          only_attributes&.sort&.join("_")&.to_sym
+          if only_attributes
+            symbol_for_attribute_names(only_attributes)
+          end
         end
 
         def will_set_scoped_path?

data/projects/type_declarations/src/attributes_transformers/reject.rb

@@ -18,7 +18,9 @@ module Foobara
         attr_accessor :reject_attributes
 
         def symbol
-          reject_attributes&.sort&.join("_")&.to_sym
+          if reject_attributes
+            symbol_for_attribute_names(reject_attributes)
+          end
         end
 
         def will_set_scoped_path?

data/projects/type_declarations/src/attributes_transformers.rb

@@ -1,5 +1,11 @@
 module Foobara
   class AttributesTransformers < TypeDeclarations::TypedTransformer
+    class << self
+      def symbol_for_attribute_names(attribute_names)
+        attribute_names.sort.join("__")&.to_sym
+      end
+    end
+
     def initialize(...)
       super
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.121
+  version: 0.0.122
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-05-11 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -188,6 +188,7 @@ files:
 - projects/command_connectors/src/command_connector/commands/list_commands.rb
 - projects/command_connectors/src/command_connector/commands/ping.rb
 - projects/command_connectors/src/command_connector/commands/query_git_commit_info.rb
+- projects/command_connectors/src/command_connector/concerns/desugarizers.rb
 - projects/command_connectors/src/command_connector/invalid_context_error.rb
 - projects/command_connectors/src/command_connector/no_command_found_error.rb
 - projects/command_connectors/src/command_connector/no_command_or_type_found_error.rb
@@ -203,6 +204,15 @@ files:
 - projects/command_connectors/src/command_registry/exposed_command.rb
 - projects/command_connectors/src/command_registry/exposed_domain.rb
 - projects/command_connectors/src/command_registry/exposed_organization.rb
+- projects/command_connectors/src/desugarizer.rb
+- projects/command_connectors/src/desugarizers/attributes.rb
+- projects/command_connectors/src/desugarizers/attributes/only_inputs.rb
+- projects/command_connectors/src/desugarizers/attributes/only_result.rb
+- projects/command_connectors/src/desugarizers/attributes/reject_inputs.rb
+- projects/command_connectors/src/desugarizers/attributes/reject_result.rb
+- projects/command_connectors/src/desugarizers/auth.rb
+- projects/command_connectors/src/desugarizers/rename_key.rb
+- projects/command_connectors/src/desugarizers/symbols_to_true.rb
 - projects/command_connectors/src/request_mutator.rb
 - projects/command_connectors/src/response_mutator.rb
 - projects/command_connectors/src/serializer.rb