service_actor 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a16f2ccd8bf0d2e83d5cb9ec163c81b9df3be06515cb716138049f9d33420759
-  data.tar.gz: bfb6c4dca34cb64fa3c8ce84b085faa85547c1a554f241ccf49d92a7a67d012b
+  metadata.gz: 1f46ecd0093a05e45fe0bc3ba11a69a8b282b82f4945ab05ff9f5cd1cd32e35e
+  data.tar.gz: 91f2c49e081eba4abbebceaef9abc131c3e8ad1c84a723846d144e2c8a890dff
 SHA512:
-  metadata.gz: 18df62d093865eefd2acd8a9d3567c1379be5c097c087b6c2d2eee1dc8cf0485e5b0b6f712b11a19492eca3465b48ba0281de7b88130e170681923ec3cc2086c
-  data.tar.gz: 80df1b4cc8269802cfe217663fa16ed907103a1b3e4b8ee42d1d01ac08c47a571f4993439f27d1065fbbb38738132be459b042aadfd04bdfe229bb6a2a4dbc27
+  metadata.gz: bee18ffff2ffbf4eb185b28ab16c519ca30e09af6ba61773009d553c563e9dbdf903aa7c5d6a66b3a4c8a49886f00337b474e1e1376f207f81d1cbe268f3f29b
+  data.tar.gz: 68e99c61d126b23877cfc4497a4c830b343e1170f49b027013da7a68062d85f644f689ad389d4c584e5b39206cac66a4cb6ab9e359ac9f65a309832c14dab060

data/README.md

@@ -83,19 +83,24 @@ result.greeting # => "Have a wonderful day!"
 Inputs can have defaults:
 
 ```rb
-class PrintWelcome < Actor
-  input :user
+class BuildGreeting < Actor
   input :adjective, default: "wonderful"
   input :length_of_time, default: -> { ["day", "week", "month"].sample }
 
   output :greeting
 
   def call
-    context.greeting = "Hello #{name}! Have a #{adjective} #{length_of_time}!"
+    context.greeting = "Have a #{adjective} #{length_of_time}!"
   end
 end
 ```
 
+This lets you call the actor without specifying those keys:
+
+```rb
+BuildGreeting.call.greeting # => "Have a wonderful week!"
+```
+
 ### Types
 
 Inputs can define a type, or an array of possible types it must match:
@@ -109,10 +114,22 @@ class UpdateUser < Actor
 end
 ```
 
+### Required
+
+To check that an input must not be `nil`, flag it as required.
+
+```rb
+class UpdateUser < Actor
+  input :user, required: true
+
+  # …
+end
+```
+
 ### Conditions
 
-If types don't cut it, you can add small conditions with the name of your choice
-under `must`:
+You can also add conditions that the inputs must verify, with the name of your
+choice under `must`:
 
 ```rb
 class UpdateAdminUser < Actor
@@ -125,7 +142,7 @@ end
 
 ### Result
 
-All actors are successful by default. To stop its execution and mark is as
+All actors are successful by default. To stop the execution and mark an actor as
 having failed, use `fail!`:
 
 ```rb
@@ -143,11 +160,10 @@ class UpdateUser
 end
 ```
 
-You can then test for the success by calling your actor with `.result` instead
-of `.call`. This will let you test for `success?` or `failure?` on the context
-instead of raising an exception.
+This will raise an error in your app.
 
-For example in a Rails controller:
+To test for the success instead of raising, you can use `.result` instead of
+`.call`. For example in a Rails controller:
 
 ```rb
 # app/controllers/users_controller.rb
@@ -166,7 +182,7 @@ end
 ### Play
 
 An actor can call actors in sequence by using `play`. Each actor will hand over
-the context to the next actor.
+the same context to the next actor.
 
 ```rb
 class PlaceOrder < Actor
@@ -182,8 +198,8 @@ end
 When using `play`, if one of the actors calls `fail!`, the following actors will
 not be called.
 
-Also, any _previous_ actor that succeeded will call the `rollback` method, if
-you defined one.
+Also, all the _previous_ actors that succeeded will have their `rollback`
+method triggered. For example:
 
 ```rb
 class CreateOrder < Actor
@@ -199,12 +215,12 @@ end
 
 ### Early success
 
-When using `play` you can use `succeed!` so that the following actors will not
-be called, but still consider the actor to be successful.
+When using `play` you can use `succeed!` to stop the execution of the following
+actors, but still consider the actor to be successful.
 
 ### Lambdas
 
-You can call inline actions using lambdas:
+You can use inline actions using lambdas:
 
 ```rb
 class Pay
@@ -264,9 +280,7 @@ However there a a few key differences which make `actor` unique:
 - Multiple organizers.
 - Conditions inside organizers.
 - No `before`, `after` and `around` hooks. Prefer simply overriding `call` with `super` which allows wrapping the whole method.
-- [Does not rely on `OpenStruct`](https://github.com/collectiveidea/interactor/issues/183)
-- Does not print warnings on Ruby 2.7.
-
+- [Fixes issues with `OpenStruct`](https://github.com/collectiveidea/interactor/issues/183)
 
 ## Development
 

data/lib/actor/context.rb

@@ -2,34 +2,28 @@
 
 class Actor
   # Represents the result of an action.
-  class Context
+  class Context < OpenStruct
     def self.to_context(data)
       return data if data.is_a?(self)
 
-      new(data)
-    end
-
-    def initialize(data = {})
-      @data = data.dup
-    end
-
-    def ==(other)
-      other.class == self.class && data == other.data
+      new(data.to_h)
     end
 
     def inspect
-      "<ActorContext #{data.inspect}>"
+      "<ActorContext #{to_h}>"
     end
 
     def fail!(context = {})
       merge!(context)
-      data[:failure?] = true
+      merge!(failure?: true)
+
       raise Actor::Failure, self
     end
 
     def succeed!(context = {})
       merge!(context)
-      data[:failure?] = false
+      merge!(failure?: false)
+
       raise Actor::Success, self
     end
 
@@ -38,55 +32,28 @@ class Actor
     end
 
     def failure?
-      data.fetch(:failure?, false)
+      super || false
     end
 
     def merge!(context)
-      data.merge!(context)
+      context.each_pair do |key, value|
+        self[key] = value
+      end
 
       self
     end
 
     def key?(name)
-      data.key?(name)
+      to_h.key?(name)
     end
 
     def [](name)
-      data[name]
+      to_h[name]
     end
 
     # Redefined here to override the method on `Object`.
     def display
-      data.fetch(:display)
-    end
-
-    protected
-
-    attr_reader :data
-
-    private
-
-    # rubocop:disable Style/MethodMissingSuper
-    def method_missing(name, *arguments, **)
-      if name =~ /=$/
-        key = name.to_s.sub('=', '').to_sym
-        data[key] = arguments.first
-      else
-        data[name]
-      end
-    end
-    # rubocop:enable Style/MethodMissingSuper
-
-    def respond_to_missing?(*_arguments)
-      true
-    end
-
-    def context_get(key)
-      data[key]
-    end
-
-    def context_set(key, value)
-      data[key] = value
+      to_h.fetch(:display)
     end
   end
 end

data/lib/actor/defaultable.rb

@@ -2,6 +2,7 @@
 
 class Actor
   # Adds the `default:` option to inputs. Accepts regular values and lambdas.
+  # If no default is set and the value has not been given, raises an error.
   #
   # Example:
   #
@@ -12,7 +13,11 @@ class Actor
   module Defaultable
     def before
       self.class.inputs.each do |name, input|
-        next if !input.key?(:default) || @context.key?(name)
+        next if @context.key?(name)
+
+        unless input.key?(:default)
+          raise ArgumentError, "Input #{name} on #{self.class} is missing."
+        end
 
         default = input[:default]
         default = default.call if default.respond_to?(:call)

data/lib/actor/filtered_context.rb

@@ -27,17 +27,17 @@ class Actor
 
     attr_reader :context, :readers, :setters
 
-    def method_missing(name, *arguments, **options)
-      return super unless context.respond_to?(name)
-
+    # rubocop:disable Style/MethodMissingSuper
+    def method_missing(name, *arguments, &block)
       unless available_methods.include?(name)
         raise ArgumentError, "Cannot call #{name} on #{inspect}"
       end
 
-      context.public_send(name, *arguments)
+      context.public_send(name, *arguments, &block)
     end
+    # rubocop:enable Style/MethodMissingSuper
 
-    def respond_to_missing?(name, *_arguments)
+    def respond_to_missing?(name, _include_private = false)
       available_methods.include?(name)
     end
 

data/lib/actor/playable.rb

@@ -60,7 +60,7 @@ class Actor
       private
 
       def play_actor(actor)
-        if actor.respond_to?(:new)
+        if actor.is_a?(Class) && actor.ancestors.include?(Actor)
           actor = actor.new(@context)
           actor.run
         else

data/lib/actor/requireable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Actor
-  # Adds `required:` checking to inputs and outputs.
+  # Ensure your inputs and outputs are not nil by adding `required: true`.
   #
   # Example:
   #

data/lib/actor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Actor
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/service_actor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'ostruct'
+
 require 'actor/failure'
 require 'actor/success'
 require 'actor/context'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_actor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec