service_actor 3.9.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f34532a18ec537f1bfed394344d917b7692ae8b7c8711cf91e6f840c501cd9
-  data.tar.gz: e8b42b94b3f20c6fa671d9e3e36686f36c1961d505046c11df025648e1cd04c9
+  metadata.gz: 86aa1f5411838fa24961e50eff4138d414c86aa99c7bdc5907953f7643406431
+  data.tar.gz: 1e0c82c0ba0e3b3c8278fa7d286454f891266972d34144b2ee3aa18a2bddd20d
 SHA512:
-  metadata.gz: 39f81ccfa9ad2e5e6b493e7654b3a979cea9935ab11a8c333d8272e160df2e6463e14e5ccf5b6637b993feb4ff8b5bdcf262ddb8da3be9ca6ac7b712f4f92014
-  data.tar.gz: 12c34d599551e6260fbb84a4ebb9930dddc2c46d24e77eace106c652456c145256543000de36c613801acb3f8f3f6db44ab070b457db015fbd738a304cba649d
+  metadata.gz: ed8bfce6061647dee123bfdecc2a89f92cb7b4fc09664bef3671d722e59605787acfe3ceb9822b785a4a0ed651b315a9c27a38366516cbeadef9403d92c49709
+  data.tar.gz: 9dec2bb8b9d5815c1c8d39108432003575f2f5a9a9431c93c69228c2c13f776eea60794696328e2d9ebc6e13849e2fa3e6db3e6e3ac337c03a39d29b24c578ea

data/README.md

@@ -314,20 +314,20 @@ end
 
 ### Defaults
 
-Inputs can be optional by providing a `default` value or lambda.
+Inputs can be optional by providing a `default` value in a lambda.
 
 ```rb
 class BuildGreeting < Actor
   input :name
-  input :adjective, default: "wonderful"
+  input :adjective, default: -> { "wonderful" }
   input :length_of_time, default: -> { ["day", "week", "month"].sample }
   input :article,
-        default: -> context { context.adjective.match?(/^aeiou/) ? "an" : "a" }
+        default: -> actor { actor.adjective.match?(/^[aeiou]/) ? "an" : "a" }
 
   output :greeting
 
   def call
-    self.greeting = "Have #{article} #{length_of_time}, #{name}!"
+    self.greeting = "Have #{article} #{adjective} #{length_of_time}, #{name}!"
   end
 end
 
@@ -338,6 +338,33 @@ actor = BuildGreeting.call(name: "Siobhan", adjective: "elegant")
 actor.greeting # => "Have an elegant week, Siobhan!"
 ```
 
+While lambdas are the preferred way to specify defaults, you can also provide
+a default value without using lambdas by using an immutable object.
+
+```rb
+# frozen_string_literal: true
+
+class ExampleActor < Actor
+  input :options, default: {
+    names: {male: "Iaroslav", female: "Anna"}.freeze,
+    country_codes: %w[gb ru].freeze
+  }.freeze
+end
+```
+
+Note that default values might be mutated if the values returned by the lambda
+are references to mutable objects, e.g.
+
+```rb
+class ExampleActor < Actor
+  input :options, default: -> { Registry::DEFAULT_OPTIONS } # `Registry::DEFAULT_OPTIONS` is not frozen
+
+  def call
+    options[:names] = nil
+  end
+end
+```
+
 ### Allow nil
 
 By default inputs accept `nil` values. To raise an error instead:
@@ -471,20 +498,6 @@ end
   end
   ```
 
-  #### Default
-
-  ```ruby
-  class MultiplyThing < Actor
-    input :multiplier,
-          default: {
-            is: -> { rand(1..10) },
-            message: (lambda do |input_key:, **|
-              "Input \"#{input_key}\" is required"
-            end)
-          }
-  end
-  ```
-
   #### Type
 
   ```ruby

data/lib/service_actor/arguments_validator.rb

@@ -16,4 +16,13 @@ module ServiceActor::ArgumentsValidator
 
     raise ArgumentError, "Expected #{value} to be a subclass of Exception"
   end
+
+  def validate_default_value(value, origin_type:, origin_name:, actor:)
+    return if value.is_a?(Proc) || !defined?(Ractor.shareable?) || Ractor.shareable?(value)
+
+    ::Kernel.warn(
+      "DEPRECATED: Actor `#{actor}` has #{origin_type} `#{origin_name}` with default " \
+        "which is not a Proc or an immutable object.",
+    )
+  end
 end

data/lib/service_actor/attributable.rb

@@ -26,6 +26,10 @@ module ServiceActor::Attributable
         name, origin: :input
       )
 
+      ServiceActor::ArgumentsValidator.validate_default_value(
+        arguments[:default], actor: self, origin_type: :input, origin_name: name
+      )
+
       inputs[name] = arguments
 
       define_method(name) do
@@ -47,6 +51,10 @@ module ServiceActor::Attributable
         name, origin: :output
       )
 
+      ServiceActor::ArgumentsValidator.validate_default_value(
+        arguments[:default], actor: self, origin_type: :output, origin_name: name
+      )
+
       outputs[name] = arguments
 
       define_method(name) do

data/lib/service_actor/checkable.rb

@@ -31,10 +31,9 @@ module ServiceActor::Checkable
 
     # rubocop:disable Metrics/MethodLength
     def service_actor_checks_for(origin)
-      check_classes = CHECK_CLASSES.select { _1.applicable_to_origin?(origin) }
       self.class.public_send(:"#{origin}s").each do |input_key, input_options|
         input_options.each do |check_name, check_conditions|
-          check_classes.each do |check_class|
+          CHECK_CLASSES.each do |check_class|
             argument_errors = check_class.check(
               check_name: check_name,
               origin: origin,

data/lib/service_actor/checks/base.rb

@@ -1,12 +1,6 @@
 # frozen_string_literal: true
 
 class ServiceActor::Checks::Base
-  class << self
-    def applicable_to_origin?(_origin)
-      true
-    end
-  end
-
   def initialize
     @argument_errors = []
   end

data/lib/service_actor/checks/type_check.rb

@@ -72,14 +72,14 @@ class ServiceActor::Checks::TypeCheck < ServiceActor::Checks::Base
 
     types, message = define_types_and_message
 
-    return if types.any? { |type| @given_type.is_a?(type) }
+    return if types.any? { |type| type === @given_type }
 
     add_argument_error(
       message,
       origin: @origin,
       input_key: @input_key,
       actor: @actor,
-      expected_type: types.join(", "),
+      expected_type: types.map(&:name).join(", "),
       given_type: @given_type.class,
     )
   end

data/lib/service_actor/defaultable.rb

@@ -9,22 +9,6 @@
 #     input :counter, default: 1
 #     input :multiplier, default: -> { rand(1..10) }
 #   end
-#
-#   class MultiplyThing < Actor
-#     input :counter,
-#           default: {
-#             is: 1,
-#             message: "Counter is required"
-#           }
-#
-#     input :multiplier,
-#           default: {
-#             is: -> { rand(1..10) },
-#             message: (lambda do |input_key:, actor:|
-#               "Input \"#{input_key}\" is required"
-#             end)
-#           }
-#   end
 module ServiceActor::Defaultable
   class << self
     def included(base)
@@ -43,19 +27,13 @@ module ServiceActor::Defaultable
           )
         end
 
-        default = input[:default]
-
-        if default.is_a?(Hash) && default[:is]
-          default_for_advanced_mode_with(result, key, default)
-        else
-          default_for_normal_mode_with(result, key, default)
-        end
+        apply_default_for_origin(key, input)
       end
 
-      self.class.outputs.each do |key, options|
-        unless result.key?(key)
-          result.send(:"#{key}=", options[:default])
-        end
+      self.class.outputs.each do |key, output|
+        next if result.key?(key)
+
+        apply_default_for_origin(key, output)
       end
 
       super
@@ -63,26 +41,13 @@ module ServiceActor::Defaultable
 
     private
 
-    def default_for_normal_mode_with(result, key, default)
-      result[key] = reify_default(result, default)
-    end
-
-    def default_for_advanced_mode_with(result, key, content)
-      default, message = content.values_at(:is, :message)
+    def apply_default_for_origin(origin_name, origin_options)
+      default = origin_options[:default]
 
-      unless default
-        raise_error_with(message, input_key: key, actor: self.class)
-      end
-
-      result[key] = reify_default(result, default)
-
-      message.call(key, self.class)
+      result[origin_name] = reify_default(result, default)
     end
 
-    # Raises an error depending on the mode
-    def raise_error_with(message, **arguments)
-      message = message.call(**arguments) if message.is_a?(Proc)
-
+    def raise_error_with(message)
       raise self.class.argument_error_class, message
     end
 

data/lib/service_actor/failure.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Error raised when using `fail!` inside an actor.
+# Default error raised when using `fail!` inside an actor.
 class ServiceActor::Failure < ServiceActor::Error
   def initialize(result)
     @result = result

data/lib/service_actor/playable.rb

@@ -90,7 +90,15 @@ module ServiceActor::Playable
     end
 
     def play_actor(actor)
-      if actor.is_a?(Symbol)
+      actor_includes_kernel = begin
+        actor.respond_to?(:is_a?)
+      rescue NoMethodError
+        false
+      end
+
+      if !actor_includes_kernel
+        actor.call(result)
+      elsif actor.is_a?(Symbol)
         send(actor)
       elsif actor.is_a?(Class) && actor.ancestors.include?(ServiceActor::Core)
         play_service_actor(actor)

data/lib/service_actor/result.rb

@@ -14,9 +14,12 @@ class ServiceActor::Result < BasicObject
   %i[
     block_given?
     class
+    hash
+    instance_of?
     instance_variables
     is_a?
     kind_of?
+    methods
     nil?
     object_id
     private_methods
@@ -24,7 +27,6 @@ class ServiceActor::Result < BasicObject
     send
     tap
     then
-    methods
   ].each do |method_name|
     define_method(method_name, ::Kernel.instance_method(method_name))
   end
@@ -33,7 +35,7 @@ class ServiceActor::Result < BasicObject
   alias_method :blank?, :nil?
 
   def initialize(data = {})
-    @data = data.to_h
+    @data = data.to_h.transform_keys(&:to_sym)
   end
 
   def to_h
@@ -44,7 +46,11 @@ class ServiceActor::Result < BasicObject
     "<#{self.class.name} #{to_h}>"
   end
 
-  alias_method :pretty_print, :inspect
+  def pretty_print(pp)
+    pp.text "#<#{self.class.name} "
+    pp.pp to_h
+    pp.text ">"
+  end
 
   def fail!(failure_class = nil, result = {})
     if failure_class.nil? || failure_class.is_a?(::Hash)
@@ -71,24 +77,32 @@ class ServiceActor::Result < BasicObject
   end
 
   def merge!(result)
-    data.merge!(result)
+    data.merge!(result.transform_keys(&:to_sym))
 
     self
   end
 
   def key?(name)
+    name = name.to_sym
+
     to_h.key?(name)
   end
 
   def [](name)
+    name = name.to_sym
+
     data[name]
   end
 
   def []=(key, value)
+    key = key.to_sym
+
     data[key] = value
   end
 
   def delete!(key)
+    key = key.to_sym
+
     data.delete(key)
   end
 
@@ -110,9 +124,7 @@ class ServiceActor::Result < BasicObject
   # Key `_default_output` is an internal datum used by actor class
   # method `.valuable`. Don't expose it with the rest of the result.
   def filter_default_output(h)
-    # using `filter` instead of `except` to maintain Ruby 2.7 compatibility
-    # update once support for 2.7 is dropped
-    h.filter { |k| k != :_default_output }
+    h.except(:_default_output)
   end
 
   def respond_to_missing?(method_name, _include_private = false)

data/lib/service_actor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceActor
-  VERSION = "3.9.3"
+  VERSION = "4.0.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: service_actor
 version: !ruby/object:Gem::Version
-  version: 3.9.3
+  version: 4.0.0
 platform: ruby
 authors:
 - Sunny Ripert
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -150,6 +149,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: code-scanning-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +205,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
 description: Service objects for your application logic
 email:
 - sunny@sunfox.org
@@ -233,7 +260,6 @@ metadata:
   source_code_uri: https://github.com/sunny/actor
   changelog_uri: https://github.com/sunny/actor/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -241,15 +267,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Service objects for your application logic
 test_files: []