service_actor 1.1.0 → 2.0.0

data/lib/{actor → service_actor}/playable.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-class Actor
-  # DSL to call a series of actors with the same context. On failure, calls
-  # rollback on any actor that succeeded.
+module ServiceActor
+  # Play class method to call a series of actors with the same result. On
+  # failure, calls rollback on any actor that succeeded.
   #
   #   class CreateUser < Actor
   #     play SaveUser,
@@ -38,11 +38,11 @@ class Actor
     module PrependedMethods
       def call
         self.class.play_actors.each do |options|
-          next if options[:if] && !options[:if].call(@context)
+          next if options[:if] && !options[:if].call(result)
 
           play_actor(options[:actor])
         end
-      rescue Actor::Failure
+      rescue Failure
         rollback
         raise
       end
@@ -61,10 +61,10 @@ class Actor
 
       def play_actor(actor)
         if actor.is_a?(Class) && actor.ancestors.include?(Actor)
-          actor = actor.new(@context)
-          actor.run
+          actor = actor.new(result)
+          actor._call
         else
-          actor.call(@context)
+          actor.call(result)
         end
 
         (@played ||= []).unshift(actor)

data/lib/{actor/context.rb → service_actor/result.rb}

@@ -1,30 +1,35 @@
 # frozen_string_literal: true
 
-class Actor
-  # Represents the result of an action.
-  class Context < OpenStruct
-    def self.to_context(data)
+require 'ostruct'
+
+module ServiceActor
+  # Represents the result of an actor.
+  class Result < OpenStruct
+    def self.to_result(data)
       return data if data.is_a?(self)
 
       new(data.to_h)
     end
 
     def inspect
-      "<ActorContext #{to_h}>"
+      "<#{self.class.name} #{to_h}>"
     end
 
-    def fail!(context = {})
-      merge!(context)
+    def fail!(result = {})
+      merge!(result)
       merge!(failure?: true)
 
-      raise Actor::Failure, self
+      raise Failure, self
     end
 
-    def succeed!(context = {})
-      merge!(context)
+    def succeed!(result = {})
+      warn 'DEPRECATED: Early success with `succeed!` is deprecated in favor ' \
+           'of adding conditions to `play` calls.'
+
+      merge!(result)
       merge!(failure?: false)
 
-      raise Actor::Success, self
+      raise Success, self
     end
 
     def success?
@@ -35,8 +40,8 @@ class Actor
       super || false
     end
 
-    def merge!(context)
-      context.each_pair do |key, value|
+    def merge!(result)
+      result.each_pair do |key, value|
         self[key] = value
       end
 

data/lib/{actor → service_actor}/success.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-class Actor
+module ServiceActor
   # Raised when using `succeed!` to halt the progression of an organizer.
-  class Success < StandardError; end
+  # DEPRECATED in favor of adding conditions to your play.
+  class Success < Error; end
 end

data/lib/service_actor/type_checkable.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ServiceActor
+  # Adds `type:` checking to inputs and outputs. Accepts classes or class names
+  # that should match an ancestor. Also accepts arrays.
+  #
+  # Example:
+  #
+  #   class ReduceOrderAmount < Actor
+  #     input :order, type: Order
+  #     input :coupon, type: 'Coupon'
+  #     input :amount, type: [Integer, Float]
+  #     input :bonus_applied, type: [TrueClass FalseClass]
+  #   end
+  module TypeCheckable
+    def self.included(base)
+      base.prepend(PrependedMethods)
+    end
+
+    module PrependedMethods
+      def _call
+        check_type_definitions(self.class.inputs, kind: 'Input')
+
+        super
+
+        check_type_definitions(self.class.outputs, kind: 'Output')
+      end
+
+      private
+
+      def check_type_definitions(definitions, kind:)
+        definitions.each do |key, options|
+          type_definition = options[:type] || next
+          value = result[key] || next
+
+          types = types_for_definition(type_definition)
+          next if types.any? { |type| value.is_a?(type) }
+
+          raise ArgumentError,
+                "#{kind} #{key} on #{self.class} must be of type " \
+                "#{types.join(', ')} but was #{value.class}"
+        end
+      end
+
+      def types_for_definition(type_definition)
+        Array(type_definition).map do |name|
+          name.is_a?(String) ? Object.const_get(name) : name
+        end
+      end
+    end
+  end
+end

data/lib/service_actor/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ServiceActor
+  VERSION = '2.0.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_actor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Service objects for your application logic
 email:
 - sunny@sunfox.org
@@ -77,18 +91,21 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
-- lib/actor/attributable.rb
-- lib/actor/conditionable.rb
-- lib/actor/context.rb
-- lib/actor/defaultable.rb
-- lib/actor/failure.rb
-- lib/actor/filtered_context.rb
-- lib/actor/playable.rb
-- lib/actor/requireable.rb
-- lib/actor/success.rb
-- lib/actor/type_checkable.rb
-- lib/actor/version.rb
 - lib/service_actor.rb
+- lib/service_actor/argument_error.rb
+- lib/service_actor/attributable.rb
+- lib/service_actor/base.rb
+- lib/service_actor/conditionable.rb
+- lib/service_actor/core.rb
+- lib/service_actor/defaultable.rb
+- lib/service_actor/error.rb
+- lib/service_actor/failure.rb
+- lib/service_actor/nil_checkable.rb
+- lib/service_actor/playable.rb
+- lib/service_actor/result.rb
+- lib/service_actor/success.rb
+- lib/service_actor/type_checkable.rb
+- lib/service_actor/version.rb
 homepage: https://github.com/sunny/actor
 licenses:
 - MIT

data/lib/actor/conditionable.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-class Actor
-  # Add boolean checks to inputs, by calling lambdas starting with `must*`.
-  #
-  # Example:
-  #
-  #   class Pay < Actor
-  #     input :provider,
-  #           must: {
-  #             exist: ->(provider) { PROVIDERS.include?(provider) }
-  #           }
-  #
-  #     output :user, required: true
-  #   end
-  module Conditionable
-    def before
-      super
-
-      self.class.inputs.each do |key, options|
-        next unless options[:must]
-
-        options[:must].each do |name, check|
-          value = @context[key]
-          next if check.call(value)
-
-          name = name.to_s.sub(/^must_/, '')
-          raise ArgumentError,
-                "Input #{key} must #{name} but was #{value.inspect}."
-        end
-      end
-    end
-  end
-end

data/lib/actor/defaultable.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-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:
-  #
-  #   class MultiplyThing < Actor
-  #     input :counter, default: 1
-  #     input :multiplier, default: -> { rand(1..10) }
-  #   end
-  module Defaultable
-    def before
-      self.class.inputs.each do |name, input|
-        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)
-        @context.merge!(name => default)
-      end
-
-      super
-    end
-  end
-end

data/lib/actor/failure.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-class Actor
-  # Error raised when using `fail!` inside an actor.
-  class Failure < StandardError
-    def initialize(context)
-      @context = context
-
-      error = context.respond_to?(:error) ? context.error : nil
-
-      super(error)
-    end
-
-    attr_reader :context
-  end
-end

data/lib/actor/filtered_context.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-class Actor
-  # Represents the result of an action, tied to inputs and outputs.
-  class FilteredContext
-    def initialize(context, readers:, setters:)
-      @context = context
-      @readers = readers
-      @setters = setters
-    end
-
-    def inspect
-      "<#{self.class.name} #{context.inspect} " \
-        "readers: #{readers.inspect} " \
-        "setters: #{setters.inspect}>"
-    end
-
-    def fail!(**arguments)
-      context.fail!(**arguments)
-    end
-
-    def succeed!(**arguments)
-      context.fail!(**arguments)
-    end
-
-    private
-
-    attr_reader :context, :readers, :setters
-
-    # 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, &block)
-    end
-    # rubocop:enable Style/MethodMissingSuper
-
-    def respond_to_missing?(name, _include_private = false)
-      available_methods.include?(name)
-    end
-
-    def available_methods
-      @available_methods ||=
-        readers + setters.map { |key| "#{key}=".to_sym }
-    end
-  end
-end

data/lib/actor/requireable.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-class Actor
-  # Ensure your inputs and outputs are not nil by adding `required: true`.
-  #
-  # Example:
-  #
-  #   class CreateUser < Actor
-  #     input :name, required: true
-  #     output :user, required: true
-  #   end
-  module Requireable
-    def before
-      super
-
-      check_required_definitions(self.class.inputs, kind: 'Input')
-    end
-
-    def after
-      super
-
-      check_required_definitions(self.class.outputs, kind: 'Output')
-    end
-
-    private
-
-    def check_required_definitions(definitions, kind:)
-      definitions.each do |key, options|
-        next unless options[:required] && @context[key].nil?
-
-        raise ArgumentError,
-              "#{kind} #{key} on #{self.class} is required but was nil."
-      end
-    end
-  end
-end

data/lib/actor/type_checkable.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-class Actor
-  # Adds `type:` checking to inputs and outputs. Accepts strings that should
-  # match an ancestor. Also accepts arrays.
-  #
-  # Example:
-  #
-  #   class ReduceOrderAmount < Actor
-  #     input :order, type: 'Order'
-  #     input :amount, type: %w[Integer Float]
-  #     input :bonus_applied, type: %w[TrueClass FalseClass]
-  #   end
-  module TypeCheckable
-    def before
-      super
-
-      check_type_definitions(self.class.inputs, kind: 'Input')
-    end
-
-    def after
-      super
-
-      check_type_definitions(self.class.outputs, kind: 'Output')
-    end
-
-    private
-
-    def check_type_definitions(definitions, kind:)
-      definitions.each do |key, options|
-        type_definition = options[:type] || next
-        value = @context[key] || next
-
-        types = Array(type_definition).map { |name| Object.const_get(name) }
-        next if types.any? { |type| value.is_a?(type) }
-
-        error = "#{kind} #{key} on #{self.class} must be of type " \
-                "#{types.join(', ')} but was #{value.class}"
-        raise ArgumentError, error
-      end
-    end
-  end
-end