foobara 0.0.56 → 0.0.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc60d4f3abb03f4cb398aca513da228aaaf2359941a9d6873d970004b8faf1a8
-  data.tar.gz: d94f3b0f676dcf2a69ae1acdbad58efa0dc0ff8626f77de6219ca55b23ac7e41
+  metadata.gz: 73dea1ae2bd36b295db67678c8d5717458a386b0a1bd11fbf5fffd4adf117a6a
+  data.tar.gz: 1b99f0f9e5294302d13061240696c05d7c6542291aaaec8f6049c8f5eef69800
 SHA512:
-  metadata.gz: 6348c488613dfb77695af95e1951a0e373787a8277bcee39e26495ee5b1c66f46e8f30a46c24ae7db4050bade755a0fbf181a2618de0f149308c752660fe7352
-  data.tar.gz: 6fe896d06734768e017dfc21753d7de90da00fdde88a5822900876f2030e84c04539fddc0ecc9bf7eb638b4ef9e745c9aafd8afa0826c97dc115ce9029cce46b
+  metadata.gz: b03089aee29a4d85bebc9dccbe8bfe32b3891fa81689fda604f28ab0d3c9909f516b34f73c6370bea9c3b4da3a49569cd9da57319245b482ada56142b0b8bf05
+  data.tar.gz: 931145ba8982bb71388135b95262b321f9b0ac3f1b9dc77ee8cd64e5f701083e0f46fb0332bb5844fb642ddfcebe268c3e6e12888a67f08f82fa574788b00a18

data/CHANGELOG.md

@@ -1,7 +1,15 @@
+## [0.0.58] - 2025-02-20
+
+- DomainMapper no longer inherits from Command. Instead, both include CommandPatternImplementation mixin
+
+## [0.0.57] - 2025-02-18
+
+- Add Enumerated.make_module helper
+
 ## [0.0.56] - 2025-02-16
 
 - Bump Ruby to 3.4.2
-- Add a ignore_unexpected_attributes option to Model#initialize
+- Add an ignore_unexpected_attributes option to Model#initialize
 
 ## [0.0.55] - 2025-02-01
 

data/projects/command/lib/foobara/command.rb

@@ -1,4 +1,7 @@
 module Foobara
+  # TODO: Make some kind of module to house these methods instead of the Command class
+  class Service; end
+
   class Command
     class << self
       def install!

data/projects/command/src/command/concerns/shortcut_for_run.rb

@@ -0,0 +1,62 @@
+module Foobara
+  class Command
+    module Concerns
+      module ShortcutForRun
+        include Concern
+
+        on_include do
+          Command.after_subclass_defined do |subclass|
+            Command.all << subclass
+            # This results in being able to use the command class name instead of .run! if you want.
+            # So instead of DoIt.run!(inputs) you can just do DoIt(inputs)
+            # TODO: can we kill this? I don't think anything uses this nor would really need to.
+            # Calling code could define such helper methods if desired but could be a bad idea since it is nice for
+            # command calls to stick out as command calls which would be less obvious if they just looked like random
+            # method calls (except that they are class case instead of underscore case)
+            subclass.define_command_named_function
+          end
+        end
+
+        module ClassMethods
+          def define_command_named_function
+            command_class = self
+            convenience_method_name = Foobara::Util.non_full_name(command_class)
+            containing_module = Foobara::Util.module_for(command_class) || Object
+
+            if containing_module.is_a?(::Class)
+              containing_module.singleton_class.define_method convenience_method_name do |*args, **opts, &block|
+                command_class.run!(*args, **opts, &block)
+              end
+
+              containing_module.define_method convenience_method_name do |*args, **opts, &block|
+                command_class.run!(*args, **opts, &block)
+              end
+            else
+              containing_module.module_eval do
+                module_function
+
+                define_method convenience_method_name do |*args, **opts, &block|
+                  command_class.run!(*args, **opts, &block)
+                end
+              end
+            end
+          end
+
+          def undefine_command_named_function
+            command_class = self
+            convenience_method_name = Foobara::Util.non_full_name(command_class)
+            containing_module = Foobara::Util.module_for(command_class) || Object
+
+            return unless containing_module.respond_to?(convenience_method_name)
+
+            containing_module.singleton_class.undef_method convenience_method_name
+
+            if containing_module.is_a?(::Class)
+              containing_module.undef_method convenience_method_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/projects/command/src/command.rb

@@ -1,40 +1,7 @@
 module Foobara
   class Command
-    include TruncatedInspect
-
-    include Concerns::Description
-    include Concerns::Namespace
-
-    include Concerns::InputsType
-    include Concerns::ErrorsType
-    include Concerns::ResultType
-
-    include Concerns::Inputs
-    include Concerns::Errors
-    include Concerns::Result
-
-    include Concerns::Runtime
-    include Concerns::Callbacks
-    include Concerns::StateMachine
-    include Concerns::Transactions
-    include Concerns::Entities
-    include Concerns::Subcommands
-    include Concerns::DomainMappers
-    include Concerns::Reflection
-
-    # TODO: this feels like a hack and shouldn't be necessary. Let's try to fix Concern class inheritance, instead.
-    self.subclass_defined_callbacks ||= Foobara::Callback::Registry::SingleAction.new
-
-    attr_reader :raw_inputs
-
-    def initialize(inputs = {})
-      @raw_inputs = inputs
-      super()
-    end
-  end
-
-  Command.after_subclass_defined do |subclass|
-    Command.all << subclass
-    subclass.define_command_named_function
+    include CommandPatternImplementation
+    # Maybe make ShortcutForRun optional and maybe even move it to a different repository?
+    include Concerns::ShortcutForRun
   end
 end

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/callbacks.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Callbacks
         include Concern
@@ -25,6 +25,8 @@ module Foobara
         end
 
         on_include do
+          self.subclass_defined_callbacks ||= Foobara::Callback::Registry::SingleAction.new
+
           [self, singleton_class].each do |target|
             %i[before after].each do |type|
               target.define_method "#{type}_any_transition" do |&block|

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/description.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Description
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/domain_mappers.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module DomainMappers
         class ForgotToDependOnDomainMapperError < Foobara::RuntimeError

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/entities.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Entities
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/errors.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Errors
         include Concern
@@ -46,8 +46,9 @@ module Foobara
 
         attr_reader :error_collection
 
-        def initialize
+        def initialize(...)
           @error_collection = ErrorCollection.new
+          super
         end
 
         foobara_delegate :has_errors?, to: :error_collection

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/errors_type.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module ErrorsType
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/inputs.rb

@@ -1,12 +1,17 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Inputs
         class UnexpectedInputValidationError < StandardError; end
 
         include Concern
 
-        attr_reader :inputs
+        attr_reader :inputs, :raw_inputs
+
+        def initialize(inputs = {})
+          @raw_inputs = inputs
+          super()
+        end
 
         def method_missing(method_name, *args, &)
           if respond_to_missing_for_inputs?(method_name)

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/inputs_type.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module InputsType
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/namespace.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Namespace
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/reflection.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Reflection
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/result.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Result
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/result_type.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module ResultType
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/runtime.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Runtime
         include Concern
@@ -15,44 +15,6 @@ module Foobara
           def run!(...)
             new(...).run!
           end
-
-          def define_command_named_function
-            command_class = self
-            convenience_method_name = Foobara::Util.non_full_name(command_class)
-            containing_module = Foobara::Util.module_for(command_class) || Object
-
-            if containing_module.is_a?(::Class)
-              containing_module.singleton_class.define_method convenience_method_name do |*args, **opts, &block|
-                command_class.run!(*args, **opts, &block)
-              end
-
-              containing_module.define_method convenience_method_name do |*args, **opts, &block|
-                command_class.run!(*args, **opts, &block)
-              end
-            else
-              containing_module.module_eval do
-                module_function
-
-                define_method convenience_method_name do |*args, **opts, &block|
-                  command_class.run!(*args, **opts, &block)
-                end
-              end
-            end
-          end
-
-          def undefine_command_named_function
-            command_class = self
-            convenience_method_name = Foobara::Util.non_full_name(command_class)
-            containing_module = Foobara::Util.module_for(command_class) || Object
-
-            return unless containing_module.respond_to?(convenience_method_name)
-
-            containing_module.singleton_class.undef_method convenience_method_name
-
-            if containing_module.is_a?(::Class)
-              containing_module.undef_method convenience_method_name
-            end
-          end
         end
 
         attr_reader :outcome, :exception

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/state_machine.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module StateMachine
         def state_machine

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/subcommands.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Subcommands
         include Concern

data/projects/command/src/{concerns → command_pattern_implementation/concerns}/transactions.rb

@@ -1,5 +1,5 @@
 module Foobara
-  class Command
+  module CommandPatternImplementation
     module Concerns
       module Transactions
         include Concern

data/projects/command/src/command_pattern_implementation.rb

@@ -0,0 +1,38 @@
+module Foobara
+  # We distinguish between "Foobara Command" and the "command pattern".
+  #
+  # A "Foobara Command" encapsulates a high-level business operation and serves as the public interface to its domain.
+  #
+  # The "command pattern" encapsulates an operation behind an interface that supports .new(inputs), #run which returns
+  # an outcome which implements #success?, #result, and #errors.
+  #
+  # All "Foobara Command"s implement the "command pattern" but not all implementations of the "command pattern"
+  # are "Foobara Command"s.  An example is DomainMappers.  They happen to use the "command pattern" since it is a good
+  # fit but has nothing to do with a public interface high-level business operation encapsulation like a
+  # "Foobara Command" does.
+  module CommandPatternImplementation
+    include Concern
+
+    include TruncatedInspect
+
+    include CommandPatternImplementation::Concerns::Description
+    include CommandPatternImplementation::Concerns::Namespace
+
+    include CommandPatternImplementation::Concerns::InputsType
+    include CommandPatternImplementation::Concerns::ErrorsType
+    include CommandPatternImplementation::Concerns::ResultType
+
+    include CommandPatternImplementation::Concerns::Inputs
+    include CommandPatternImplementation::Concerns::Errors
+    include CommandPatternImplementation::Concerns::Result
+
+    include CommandPatternImplementation::Concerns::Runtime
+    include CommandPatternImplementation::Concerns::Callbacks
+    include CommandPatternImplementation::Concerns::StateMachine
+    include CommandPatternImplementation::Concerns::Transactions
+    include CommandPatternImplementation::Concerns::Entities
+    include CommandPatternImplementation::Concerns::Subcommands
+    include CommandPatternImplementation::Concerns::DomainMappers
+    include CommandPatternImplementation::Concerns::Reflection
+  end
+end

data/projects/domain_mapper/src/domain_mapper.rb

@@ -1,7 +1,7 @@
 module Foobara
-  # TODO: would be nice to inherit from something other than Command. Can we hoist a bunch of common behavior up
-  # out of Command into some other class maybe called Service or Runnable or something?
-  class DomainMapper < Foobara::Command
+  class DomainMapper
+    include CommandPatternImplementation
+
     class << self
       def map(value)
         new(from: value).run

data/projects/enumerated/src/enumerated.rb

@@ -0,0 +1,9 @@
+module Foobara
+  module Enumerated
+    class << self
+      def make_module(...)
+        Values.new(...).make_module
+      end
+    end
+  end
+end

data/projects/enumerated/src/values.rb

@@ -116,6 +116,27 @@ module Foobara
       def respond_to_missing?(name, _include_private = false)
         @symbol_map.key?(name)
       end
+
+      def value?(value)
+        @symbol_map.values.include?(value.to_sym)
+      end
+
+      def make_module
+        mod = Module.new
+        enumerated = self
+
+        %i[all all_names all_values].each do |method_name|
+          mod.singleton_class.define_method method_name do |*args, **opts, &block|
+            enumerated.send(method_name, *args, **opts, &block)
+          end
+        end
+
+        @symbol_map.each_pair do |name, value|
+          mod.const_set(name, value)
+        end
+
+        mod
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.56
+  version: 0.0.58
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -131,22 +131,24 @@ files:
 - projects/callback/src/set.rb
 - projects/command/lib/foobara/command.rb
 - projects/command/src/command.rb
-- projects/command/src/concerns/callbacks.rb
-- projects/command/src/concerns/description.rb
-- projects/command/src/concerns/domain_mappers.rb
-- projects/command/src/concerns/entities.rb
-- projects/command/src/concerns/errors.rb
-- projects/command/src/concerns/errors_type.rb
-- projects/command/src/concerns/inputs.rb
-- projects/command/src/concerns/inputs_type.rb
-- projects/command/src/concerns/namespace.rb
-- projects/command/src/concerns/reflection.rb
-- projects/command/src/concerns/result.rb
-- projects/command/src/concerns/result_type.rb
-- projects/command/src/concerns/runtime.rb
-- projects/command/src/concerns/state_machine.rb
-- projects/command/src/concerns/subcommands.rb
-- projects/command/src/concerns/transactions.rb
+- projects/command/src/command/concerns/shortcut_for_run.rb
+- projects/command/src/command_pattern_implementation.rb
+- projects/command/src/command_pattern_implementation/concerns/callbacks.rb
+- projects/command/src/command_pattern_implementation/concerns/description.rb
+- projects/command/src/command_pattern_implementation/concerns/domain_mappers.rb
+- projects/command/src/command_pattern_implementation/concerns/entities.rb
+- projects/command/src/command_pattern_implementation/concerns/errors.rb
+- projects/command/src/command_pattern_implementation/concerns/errors_type.rb
+- projects/command/src/command_pattern_implementation/concerns/inputs.rb
+- projects/command/src/command_pattern_implementation/concerns/inputs_type.rb
+- projects/command/src/command_pattern_implementation/concerns/namespace.rb
+- projects/command/src/command_pattern_implementation/concerns/reflection.rb
+- projects/command/src/command_pattern_implementation/concerns/result.rb
+- projects/command/src/command_pattern_implementation/concerns/result_type.rb
+- projects/command/src/command_pattern_implementation/concerns/runtime.rb
+- projects/command/src/command_pattern_implementation/concerns/state_machine.rb
+- projects/command/src/command_pattern_implementation/concerns/subcommands.rb
+- projects/command/src/command_pattern_implementation/concerns/transactions.rb
 - projects/command/src/state_machine.rb
 - projects/command/src/transformed_command.rb
 - projects/command_connectors/lib/foobara/command_connectors.rb
@@ -249,6 +251,7 @@ files:
 - projects/entity/src/not_found_error.rb
 - projects/enumerated/lib/foobara/enumerated.rb
 - projects/enumerated/src/accessors.rb
+- projects/enumerated/src/enumerated.rb
 - projects/enumerated/src/values.rb
 - projects/foobara/lib/foobara.rb
 - projects/foobara/lib/foobara/all.rb