service_actor 1.0.0 → 3.1.1

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
@@ -60,11 +60,12 @@ class Actor
       private
 
       def play_actor(actor)
-        if actor.respond_to?(:new)
-          actor = actor.new(@context)
-          actor.run
+        if actor.is_a?(Class) && actor.ancestors.include?(Actor)
+          actor = actor.new(result)
+          actor._call
         else
-          actor.call(@context)
+          new_result = actor.call(result)
+          result.merge!(new_result.to_h) if new_result.respond_to?(:to_h)
         end
 
         (@played ||= []).unshift(actor)

data/lib/service_actor/result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module ServiceActor
+  # Represents the context of an actor, holding the data from both its inputs
+  # and outputs.
+  class Result < OpenStruct
+    def self.to_result(data)
+      return data if data.is_a?(self)
+
+      new(data.to_h)
+    end
+
+    def inspect
+      "<#{self.class.name} #{to_h}>"
+    end
+
+    def fail!(result = {})
+      merge!(result)
+      merge!(failure?: true)
+
+      raise Failure, self
+    end
+
+    def success?
+      !failure?
+    end
+
+    def failure?
+      self[:failure?] || false
+    end
+
+    def merge!(result)
+      result.each_pair do |key, value|
+        self[key] = value
+      end
+
+      self
+    end
+
+    def key?(name)
+      to_h.key?(name)
+    end
+
+    def [](name)
+      to_h[name]
+    end
+
+    # Redefined here to override the method on `Object`.
+    def display
+      to_h.fetch(:display)
+    end
+  end
+end

data/lib/service_actor/type_checkable.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ServiceActor
+  # Adds `type:` checking to inputs and outputs. Accepts class names or classes
+  # that should match an ancestor. Also accepts arrays.
+  #
+  # Example:
+  #
+  #   class ReduceOrderAmount < Actor
+  #     input :order, type: 'Order'
+  #     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 = '3.1.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_actor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,6 +66,62 @@ 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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'
+- !ruby/object:Gem::Dependency
+  name: code-scanning-rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: interactor
+  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,25 +133,29 @@ 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/collectionable.rb
+- lib/service_actor/conditionable.rb
+- lib/service_actor/core.rb
+- lib/service_actor/defaultable.rb
+- lib/service_actor/error.rb
+- lib/service_actor/failable.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/type_checkable.rb
+- lib/service_actor/version.rb
 homepage: https://github.com/sunny/actor
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sunny/actor
   source_code_uri: https://github.com/sunny/actor
-  changelog_uri: https://github.com/sunny/actor/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/sunny/actor/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,14 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Service objects for your application logic

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/context.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-class Actor
-  # Represents the result of an action.
-  class Context
-    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
-    end
-
-    def inspect
-      "<ActorContext #{data.inspect}>"
-    end
-
-    def fail!(context = {})
-      merge!(context)
-      data[:failure?] = true
-      raise Actor::Failure, self
-    end
-
-    def succeed!(context = {})
-      merge!(context)
-      data[:failure?] = false
-      raise Actor::Success, self
-    end
-
-    def success?
-      !failure?
-    end
-
-    def failure?
-      data.fetch(:failure?, false)
-    end
-
-    def merge!(context)
-      data.merge!(context)
-
-      self
-    end
-
-    def key?(name)
-      data.key?(name)
-    end
-
-    def [](name)
-      data[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
-    end
-  end
-end

data/lib/actor/defaultable.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-class Actor
-  # Adds the `default:` option to inputs. Accepts regular values and lambdas.
-  #
-  # 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 !input.key?(:default) || @context.key?(name)
-
-        default = input[:default]
-        default = default.call if default.respond_to?(:call)
-        @context.merge!(name => default)
-      end
-
-      super
-    end
-  end
-end