foobara 0.0.87 → 0.0.88

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45093221881afa7419b208493f3787403c664a149f77728ac64daaea00c7b083
-  data.tar.gz: 4103467f677825cd70e2d8d468cc9845511789c32e4a2f69c3cc4901fb9704c5
+  metadata.gz: 5abb6c21d367251512e93a28585ca52fbef92cbea5bd4b6f102f693ae7e42969
+  data.tar.gz: 2219f04cbb8cd7fa1b4f296fe229416cb344fd30bdd4fe529cb619b820a45f03
 SHA512:
-  metadata.gz: e655dc065c7b923be1d76742e9fc651f8d7581cdfd3ad9130cc20e474ca42bb15791ebc35238bc52d8b255cef440237234c01eda4189b850287ecd142141271e
-  data.tar.gz: 54893503e3dfed78a608590f44a9673aca2b8c208094a306c7b10634afea59380caee6a0998cd283c1ecb7097b227705b9a3644186d2f3afe561ee0676170717
+  metadata.gz: df26075b6ad2825133cd77b08e6c5813756fe130244b4d21ca0c312a734380c40668ce5a066e102a2b321a66f08ddf51a9a2499af1c243a603db40c3057aa60a
+  data.tar.gz: 8c4ef51ae4cb5fc93c31e3b739f0b919c91cad78944cbeeea25d324f607020aff47ff7ae8166e24fd17dc9aff61dab9962b29833d505e77f1833a8af40a56c1e

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.0.88] - 2025-03-28
+
+- Implement response mutator concept
+- Break up #request_to_response for easier overriding/extension
+- Add AttributesTransformers::Reject
+- Fix problem causing downcase/regex processors to explode on allows_nil types
+
 # [0.0.87] - 2025-03-26
 
 - TypedTransformer refactor to reduce confusion and bugs

data/projects/builtin_types/src/email/transformers/downcase.rb

@@ -5,9 +5,6 @@ module Foobara
         # Seems like it might be cleaner to just assemble these parts in one place instead of in different files?
         # Hard to say.
         class Downcase < BuiltinTypes::String::SupportedTransformers::Downcase
-          def always_applicable?
-            true
-          end
         end
       end
     end

data/projects/builtin_types/src/email/validator_base.rb

@@ -27,10 +27,6 @@ module Foobara
           end
         end
 
-        def always_applicable?
-          true
-        end
-
         def regex
           # :nocov:
           raise "subclass responsibility"
@@ -76,6 +72,11 @@ module Foobara
             class_name = "#{name}::#{Util.classify(symbol)}"
 
             Util.make_class(class_name, ValidatorBase) do
+              define_method :applicable? do |value|
+                # TODO: hmmm, I wonder how we can short-circuit these checks if :allows_nil matches??
+                value.is_a?(::String)
+              end
+
               define_method :regex do
                 regex
               end

data/projects/builtin_types/src/string/supported_transformers/downcase.rb

@@ -3,7 +3,11 @@ module Foobara
     # TODO: Rename to StringType to avoid needing to remember ::String elsewhere in the code
     module String
       module SupportedTransformers
-        class Downcase < Value::Transformer.subclass(transform: :downcase.to_proc, name: "Downcase")
+        class Downcase < Value::Transformer.subclass(
+          transform: :downcase.to_proc,
+          name: "Downcase",
+          applicable?: ->(value) { value.respond_to?(:downcase) }
+        )
         end
       end
     end

data/projects/command/src/transformed_command.rb

@@ -13,6 +13,10 @@ module Foobara
                     :pre_commit_transformers,
                     # TODO: get at least these serializers out of here...
                     :serializers,
+                    # TODO: probably should also get these mutators out of here. But where should they live?
+                    # On exposed command? On the command registry? On the command connector?
+                    # This is the easiest place to implement them but feels awkward.
+                    :response_mutators,
                     :allowed_rule,
                     :requires_authentication,
                     :authenticator
@@ -27,6 +31,7 @@ module Foobara
         errors_transformers:,
         pre_commit_transformers:,
         serializers:,
+        response_mutators:,
         allowed_rule:,
         requires_authentication:,
         authenticator:,
@@ -36,7 +41,6 @@ module Foobara
         result_type = command_class.result_type
 
         if result_type&.has_sensitive_types?
-
           remover_class = Foobara::TypeDeclarations.sensitive_value_remover_class_for_type(result_type)
 
           remover = Namespace.use scoped_namespace do
@@ -59,6 +63,7 @@ module Foobara
           klass.errors_transformers = Util.array(errors_transformers)
           klass.pre_commit_transformers = Util.array(pre_commit_transformers)
           klass.serializers = Util.array(serializers)
+          klass.response_mutators = Util.array(response_mutators)
           klass.allowed_rule = allowed_rule
           klass.requires_authentication = requires_authentication
           klass.authenticator = authenticator
@@ -109,6 +114,18 @@ module Foobara
         result_type_from_transformers(command_class.result_type, result_transformers)
       end
 
+      def result_type_for_manifest
+        return @result_type_for_manifest if defined?(@result_type_for_manifest)
+
+        mutated_result_type = result_type
+
+        response_mutators&.reverse&.each do |mutator|
+          mutated_result_type = mutator.instance.result_type_from(mutated_result_type)
+        end
+
+        @result_type_for_manifest = mutated_result_type
+      end
+
       def error_context_type_map
         @error_context_type_map ||= begin
           set = {}
@@ -208,12 +225,13 @@ module Foobara
           end
         end
 
+        response_mutators = self.response_mutators.map { |t| t.foobara_manifest(to_include:) }
+
         command_class.foobara_manifest(to_include:, remove_sensitive:).merge(
           Util.remove_blank(
             types_depended_on: types,
             inputs_type: inputs_type&.reference_or_declaration_data,
-            # TODO: we need a way to unmask values in the result type that we want to expose
-            result_type: result_type&.reference_or_declaration_data(remove_sensitive:),
+            result_type: result_type_for_manifest&.reference_or_declaration_data(remove_sensitive:),
             possible_errors: possible_errors_manifest(to_include:, remove_sensitive:),
             capture_unknown_error:,
             inputs_transformers:,
@@ -221,6 +239,7 @@ module Foobara
             errors_transformers:,
             pre_commit_transformers:,
             serializers:,
+            response_mutators:,
             requires_authentication:,
             authenticator: authenticator&.manifest
           )
@@ -247,6 +266,25 @@ module Foobara
         end
       end
 
+      def response_mutator
+        return @response_mutator if defined?(@response_mutator)
+
+        if response_mutators.empty?
+          @response_mutator = nil
+          return
+        end
+
+        @response_mutator = begin
+          transformers = transformers_to_processors(response_mutators, result_type, direction: :from)
+
+          if transformers.size == 1
+            transformers.first
+          else
+            Value::Processor::Pipeline.new(processors: transformers)
+          end
+        end
+      end
+
       def result_transformer
         return @result_transformer if defined?(@result_transformer)
 
@@ -344,6 +382,10 @@ module Foobara
       end
     end
 
+    def mutate_response(response)
+      self.class.response_mutator&.process_value!(response)
+    end
+
     def transform_errors
       if errors_transformer
         self.outcome = Outcome.errors(errors_transformer.process_value!(errors))
@@ -483,13 +525,7 @@ module Foobara
     end
 
     # TODO: kill this
-    def serialize_result
-      body = if outcome.success?
-               outcome.result
-             else
-               outcome.errors
-             end
-
+    def serialize_result(body)
       if serializer
         serializer.process_value!(body)
       else

data/projects/command_connectors/src/command_connector/response.rb

@@ -1,14 +1,14 @@
 module Foobara
   class CommandConnector
     class Response
-      attr_accessor :status,
-                    :body,
-                    :request
+      attr_accessor :request,
+                    :status,
+                    :body
 
-      def initialize(status:, body:, request:)
+      def initialize(request:, status: nil, body: nil)
+        self.request = request
         self.status = status
         self.body = body
-        self.request = request
       end
 
       foobara_delegate :command, :error, to: :request

data/projects/command_connectors/src/command_connector.rb

@@ -95,6 +95,7 @@ module Foobara
                      :add_default_errors_transformer,
                      :add_default_pre_commit_transformer,
                      :add_default_serializer,
+                     :add_default_response_mutator,
                      :allowed_rule,
                      :allowed_rules,
                      :transform_command_class,
@@ -232,16 +233,34 @@ module Foobara
     end
 
     def request_to_response(request)
-      command = request.command
-      outcome = command.outcome
+      self.class::Response.new(request:)
+    end
+
+    def set_response_status(response)
+      outcome = response.request.outcome
+      response.status = outcome.success? ? 0 : 1
+    end
 
-      status = outcome.success? ? 0 : 1
+    def set_response_body(response)
+      outcome = response.request.outcome
+      # response.body = outcome.success? ? outcome.result : outcome.error_collection
+      response.body = outcome.success? ? outcome.result : outcome.error_collection
+    end
 
-      # TODO: feels awkward to call this here... Maybe use result/errors transformers instead??
-      # Or call the serializer here??
-      body = command.respond_to?(:serialize_result) ? command.serialize_result : request.response_body
+    def mutate_response(response)
+      command = response.command
 
-      self.class::Response.new(request:, status:, body:)
+      if command.respond_to?(:mutate_response)
+        command.mutate_response(response)
+      end
+    end
+
+    def serialize_response_body(response)
+      command = response.command
+
+      if command.respond_to?(:serialize_result)
+        response.body = command.serialize_result(response.body)
+      end
     end
 
     def initialize(authenticator: nil, default_serializers: nil)
@@ -343,7 +362,12 @@ module Foobara
 
     def build_response(request)
       response = request_to_response(request)
-      response.request = request
+
+      set_response_status(response)
+      set_response_body(response)
+      mutate_response(response)
+      serialize_response_body(response)
+
       response
     end
 

data/projects/command_connectors/src/command_registry/exposed_command.rb

@@ -12,6 +12,7 @@ module Foobara
                     :errors_transformers,
                     :pre_commit_transformers,
                     :serializers,
+                    :response_mutators,
                     :allowed_rule,
                     :requires_authentication,
                     :authenticator,
@@ -27,6 +28,7 @@ module Foobara
         result_transformers: nil,
         errors_transformers: nil,
         pre_commit_transformers: nil,
+        response_mutators: nil,
         serializers: nil,
         allowed_rule: nil,
         requires_authentication: nil,
@@ -76,6 +78,7 @@ module Foobara
         self.result_transformers = result_transformers
         self.errors_transformers = errors_transformers
         self.pre_commit_transformers = pre_commit_transformers
+        self.response_mutators = response_mutators
         self.serializers = serializers
         self.allowed_rule = allowed_rule
         self.requires_authentication = requires_authentication
@@ -111,6 +114,7 @@ module Foobara
             result_transformers,
             errors_transformers,
             pre_commit_transformers,
+            response_mutators,
             serializers,
             allowed_rule,
             requires_authentication,
@@ -130,6 +134,7 @@ module Foobara
                                            result_transformers:,
                                            errors_transformers:,
                                            pre_commit_transformers:,
+                                           response_mutators:,
                                            serializers:,
                                            allowed_rule:,
                                            requires_authentication:,

data/projects/command_connectors/src/response_mutator.rb

@@ -0,0 +1,24 @@
+module Foobara
+  module CommandConnectors
+    class ResponseMutator < Foobara::Value::Mutator
+      def result_type_declaration_from(_result_type)
+        # :nocov:
+        raise "subclass responsibility"
+        # :nocov:
+      end
+
+      def result_type_from(result_type)
+        declaration = result_type_declaration_from(result_type)
+        Domain.current.foobara_type_from_declaration(declaration)
+      end
+
+      def mutate
+        # :nocov:
+        raise "subclass responsibility"
+        # :nocov:
+      end
+
+      alias response declaration_data
+    end
+  end
+end

data/projects/command_connectors/src/serializers/errors_serializer.rb

@@ -8,7 +8,8 @@ module Foobara
           !request.outcome.success?
         end
 
-        def serialize(errors)
+        def serialize(error_collection)
+          errors = error_collection.errors
           errors.map(&:to_h)
         end
       end

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

@@ -0,0 +1,32 @@
+module Foobara
+  class AttributesTransformers < TypeDeclarations::TypedTransformer
+    class << self
+      def only(*attribute_names)
+        transformer_class = Class.new(Only)
+        transformer_class.only_attributes = attribute_names
+
+        transformer_class
+      end
+    end
+
+    class Only < AttributesTransformers
+      class << self
+        attr_accessor :only_attributes
+      end
+
+      def to_type_declaration
+        from_declaration = from_type.declaration_data
+        TypeDeclarations::Attributes.only(from_declaration, *self.class.only_attributes)
+      end
+
+      def transform(inputs)
+        inputs = Util.symbolize_keys(inputs)
+        inputs.slice(*allowed_keys)
+      end
+
+      def allowed_keys
+        to_type.element_types.keys
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Foobara
+  class AttributesTransformers < TypeDeclarations::TypedTransformer
+    class << self
+      def reject(*attribute_names)
+        transformer_class = Class.new(Reject)
+        transformer_class.reject_attributes = attribute_names
+
+        transformer_class
+      end
+    end
+
+    class Reject < AttributesTransformers
+      class << self
+        attr_accessor :reject_attributes
+      end
+
+      def to_type_declaration
+        from_declaration = from_type.declaration_data
+        TypeDeclarations::Attributes.reject(from_declaration, *self.class.reject_attributes)
+      end
+
+      def transform(inputs)
+        inputs = Util.symbolize_keys(inputs)
+        inputs.slice(*allowed_keys)
+      end
+
+      def allowed_keys
+        to_type.element_types.keys
+      end
+    end
+  end
+end

data/projects/value/src/mutator.rb

@@ -0,0 +1,29 @@
+module Foobara
+  module Value
+    class Mutator < Processor
+      class << self
+        def foobara_manifest(to_include: Set.new, remove_sensitive: false)
+          super.merge(processor_type: :mutator)
+        end
+
+        def error_classes
+          []
+        end
+      end
+
+      def mutate(_value)
+        # :nocov:
+        raise "subclass responsibility"
+        # :nocov:
+      end
+
+      def process_value(value)
+        if applicable?(value)
+          mutate(value)
+        end
+
+        Outcome.success(value)
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.87
+  version: 0.0.88
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -27,30 +27,30 @@ dependencies:
   name: foobara-lru-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: foobara-util
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.11
 description: A command-centric and discoverable software framework with a focus on
   domain concepts and abstracting away integration code
 email:
@@ -179,6 +179,7 @@ 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/response_mutator.rb
 - projects/command_connectors/src/serializer.rb
 - projects/command_connectors/src/serializers/aggregate_serializer.rb
 - projects/command_connectors/src/serializers/atomic_serializer.rb
@@ -359,7 +360,8 @@ files:
 - projects/thread_parent/src/thread_parent.rb
 - projects/type_declarations/lib/foobara/type_declarations.rb
 - projects/type_declarations/src/attributes.rb
-- projects/type_declarations/src/attributes_transformer.rb
+- projects/type_declarations/src/attributes_transformers/only.rb
+- projects/type_declarations/src/attributes_transformers/reject.rb
 - projects/type_declarations/src/caster.rb
 - projects/type_declarations/src/desugarizer.rb
 - projects/type_declarations/src/dsl/attributes.rb
@@ -418,6 +420,7 @@ files:
 - projects/value/lib/foobara/value.rb
 - projects/value/src/caster.rb
 - projects/value/src/data_error.rb
+- projects/value/src/mutator.rb
 - projects/value/src/processor.rb
 - projects/value/src/processor/casting.rb
 - projects/value/src/processor/multi.rb

data/projects/type_declarations/src/attributes_transformer.rb

@@ -1,27 +0,0 @@
-module Foobara
-  class AttributesTransformer < TypeDeclarations::TypedTransformer
-    class << self
-      attr_accessor :only_attributes
-
-      def only(*attribute_names)
-        transformer_class = Class.new(self)
-        transformer_class.only_attributes = attribute_names
-
-        transformer_class
-      end
-    end
-
-    def to_type_declaration
-      from_declaration = from_type.declaration_data
-      TypeDeclarations::Attributes.only(from_declaration, *self.class.only_attributes)
-    end
-
-    def transform(inputs)
-      inputs.slice(*allowed_keys)
-    end
-
-    def allowed_keys
-      to_type.element_types.keys
-    end
-  end
-end