ii_interactor 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2fdfb2e93eb53ee2b70845fb78c285aae26c237681537ae59893675873974f1
-  data.tar.gz: b85095ca4396ccc3523fbe6f212ed335f057a77dc60e87b0969c14666a5e0d0f
+  metadata.gz: f27fe194dd295f5882f0533132588686a9fead26c638f86db95b8b66979553bf
+  data.tar.gz: '08c3c2fbd0687fb42077215abb8edd0e85a76eda538c418fa5f869f50957ed90'
 SHA512:
-  metadata.gz: 2b1321aee1be7d0c362315ef1020db0113d77445366617de0e0f9ff010c49d1118f7a26f5182102065efa60eb832616ded910f1e3bd222fc897d5fcaa0947236
-  data.tar.gz: a0d731eb5334b3846530e60858146c9b1f748d01b313917ee7e50153ab5f22f9fdb8a2cc53c24d08459ff7f074ee203579752c4d778bfad618e269c3361e318f
+  metadata.gz: ab6289235d21d6085ce7b20d123efd152d1e387f6d17a708a107e735f259036bb87be8533e9e7e5b07613cc9ca14fd0b699521bbb1c6f42c855054884f0e690e
+  data.tar.gz: 76c6d853fc4ef5b6103d9dda4cdac6ecb9179b0b21c6b35e72519dd2059bb1efb95a431ae23dca207f51a78e8a8e598c56028851842b98b6a4181221da725f76

data/.github/workflows/ci.yml

@@ -4,21 +4,29 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
-        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61']
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0']
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61', 'rails70']
         exclude:
           - ruby: 2.3
             gemfile: rails60
           - ruby: 2.3
             gemfile: rails61
+          - ruby: 2.3
+            gemfile: rails70
           - ruby: 2.4
             gemfile: rails60
           - ruby: 2.4
             gemfile: rails61
+          - ruby: 2.4
+            gemfile: rails70
+          - ruby: 2.5
+            gemfile: rails70
+          - ruby: 2.6
+            gemfile: rails70
           - ruby: 3.0
             gemfile: rails50
           - ruby: 3.0

data/.gitignore

@@ -2,6 +2,7 @@
 .project
 Gemfile.lock
 coverage/
+gemfiles/*.lock
 pkg/
 tmp/
 spec/dummy/db/*.sqlite3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 2.1.0
+
+* Add traversal config.
+* Add callbacks for `call_all`.
+* Add calling instrumentation.
+* Bump coactive version to 0.2.
+
 ## 2.0.0
 
 * Replace interaction feature with coactive.

data/README.md

@@ -27,6 +27,9 @@ Create interactor with `call` method and call it as follows:
 
 ```ruby
 class Interactor < IIInteractor::Base
+  context_in :message
+  context_out :result
+
   def call
     @context.result = "called by #{@context.message}"
   end
@@ -39,31 +42,13 @@ Interactor.call(message: 'something')
 The first argument of `Interactor.call` is set to `@context`.
 The return value of `Interactor.call` is the same as `@context`.
 
-### Context variables
-
 You can define context variables used in interactor explicitly.
-For example:
-
-```ruby
-class Interactor < IIInteractor::Base
-  context_in :input
-  context_out :result
-
-  def call
-    puts @input
-    @result = 'result value'
-  end
-end
-
-puts Interactor.call(input: 'input').result
-#=> input
-#   result value
-```
+`context_in` copies context to instance variables of interactor,
+while `context_out` copies instance variables of interactor to context.
 
-`context_in` copies context into instance variables of interactor,
-while `context_out` copies instance variables of interactor into context.
+### Context options
 
-You can also define required context as follows:
+You can define required context as follows:
 
 ```ruby
 class Interactor < IIInteractor::Base
@@ -104,31 +89,6 @@ Interactor.call.result
 #=> returned value
 ```
 
-### Callbacks
-
-Following callbacks are available:
-
-* `before_call`
-* `around_call`
-* `after_call`
-
-For example:
-
-```ruby
-class Interactor < IIInteractor::Base
-  before_call do
-    @message = @context.message
-  end
-
-  def call
-    puts @message
-  end
-end
-
-Interactor.call(message: 'something')
-#=> something
-```
-
 ### Coactions
 
 You can call other interactors in the same context using `coact`:
@@ -235,6 +195,38 @@ context.failure?
 #=> true
 ```
 
+### Callbacks
+
+Following callbacks are available:
+
+* `before_all`, `around_all`, `after_all`
+* `before_call`, `around_call`, `after_call`
+
+`*_all` wraps all coactors, and `*_call` wraps `call` method.
+That is, `before_all` is called before running all coactors, and `before_call` is called before running `call` method.
+For example:
+
+```ruby
+class Interactor < IIInteractor::Base
+  before_all do
+    puts "before_all"
+  end
+
+  before_call do
+    puts "before_call"
+  end
+
+  def call
+    puts @context.message
+  end
+end
+
+Interactor.call(message: 'something')
+#=> before_all
+#   before_call
+#   something
+```
+
 ### Pass a block
 
 You can pass a block to `call` method of a interactor.
@@ -277,7 +269,9 @@ IIInteractor::LogSubscriber.attach_to :ii_interactor
 This subscriber will write logs in debug mode as the following example:
 
 ```
-Called SimpleInteractor (Duration: 0.3ms, Allocations: 42)
+Calling BasicInteractor with #<IIInteractor::Context ...>
+...
+Called BasicInteractor (Duration: 0.1ms, Allocations: 4)
 ```
 
 ## Contributing

data/gemfiles/rails70.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/ii_interactor.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.0"
-  spec.add_dependency "coactive", ">= 0.1"
+  spec.add_dependency "coactive", ">= 0.2"
 
   spec.add_development_dependency "rails", ">= 5.0"
   spec.add_development_dependency "sqlite3"

data/lib/ii_interactor/base.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'context'
 require_relative 'core'
-require_relative 'variables'
 require_relative 'callbacks'
 require_relative 'instrumentation'
+require_relative 'context'
+require_relative 'contextualizer'
 require_relative 'coactors'
 
 module IIInteractor
@@ -12,7 +12,7 @@ module IIInteractor
     include Core
     include Callbacks
     include Instrumentation
-    include Variables
+    include Contextualizer
     include Coactors
   end
 end

data/lib/ii_interactor/callbacks.rb

@@ -6,9 +6,16 @@ module IIInteractor
     include ActiveSupport::Callbacks
 
     included do
+      define_callbacks :all
       define_callbacks :call
     end
 
+    def call_all
+      run_callbacks :all do
+        super
+      end
+    end
+
     def call_self
       run_callbacks :call do
         super
@@ -16,6 +23,18 @@ module IIInteractor
     end
 
     class_methods do
+      def before_all(*args, &block)
+        set_callback(:all, :before, *args, &block)
+      end
+
+      def after_all(*args, &block)
+        set_callback(:all, :after, *args, &block)
+      end
+
+      def around_all(*args, &block)
+        set_callback(:all, :around, *args, &block)
+      end
+
       def before_call(*args, &block)
         set_callback(:call, :before, *args, &block)
       end

data/lib/ii_interactor/config.rb

@@ -5,6 +5,7 @@ module IIInteractor
     class_attribute :data
 
     self.data = {
+      traversal: :postorder,
       lookup_cache: true
     }
 

data/lib/ii_interactor/context.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
 module IIInteractor
-  class Context < OpenStruct
-    def initialize(hash, &block)
+  class Context < Coactive::Context
+    def initialize(data = {}, &block)
       super
-      self[:_block] = block
-      self[:_failed] = false
-      self[:_stopped] = false
-      self[:_called] = []
+      @_data[:_block] ||= block
+      @_data[:_failed] ||= false
+      @_data[:_stopped] ||= false
+      @_data[:_called] ||= []
+    end
+
+    def to_s
+      attrs = @_data.reject { |k, _| k.to_s =~ /^_/ }.map { |k, v| "#{k}=#{v.to_s.truncate(300)}" }.join(', ')
+      "#<#{self.class} #{attrs}>"
+    end
+
+    def call_block!(*args)
+      @_data[:_block].call(*args) if @_data[:_block]
     end
 
     def success?
@@ -15,21 +24,27 @@ module IIInteractor
     end
 
     def failure?
-      self[:_failed] == true
+      @_data[:_failed] == true
     end
 
     def stopped?
-      self[:_stopped] == true
+      @_data[:_stopped] == true
     end
 
     def fail!(data = {})
-      self[:_failed] = true
-      data.each { |k, v| self[k] = v }
+      @_data[:_failed] = true
+      data.each { |k, v| @_data[k] = v }
+      define_accessors!(data.keys)
     end
 
     def stop!(data = {})
-      self[:_stopped] = true
-      data.each { |k, v| self[k] = v }
+      @_data[:_stopped] = true
+      data.each { |k, v| @_data[k] = v }
+      define_accessors!(data.keys)
+    end
+
+    def called!(interactor)
+      @_data[:_called] << interactor
     end
   end
 end

data/lib/ii_interactor/contextualizer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module IIInteractor
+  module Contextualizer
+    extend ActiveSupport::Concern
+    include Coactive::Contextualizer
+
+    def call_self
+      contextualize do
+        super
+      end
+    end
+
+    class_methods do
+      def context_in(*names, **options)
+        context(*names, **options)
+      end
+
+      def context_out(*names, **options)
+        options[:output] = true
+        if options.delete(:from_return)
+          options[:output] = :return
+        end
+        context(*names, **options)
+      end
+    end
+  end
+end

data/lib/ii_interactor/core.rb

@@ -3,26 +3,32 @@
 module IIInteractor
   module Core
     extend ActiveSupport::Concern
+    include Coactive::Initializer
 
     included do
-      attr_reader :context
+      self.context_class = IIInteractor::Context
     end
 
-    def initialize(context = {}, &block)
-      @context = if context.is_a?(IIInteractor::Context)
-          context
-        else
-          IIInteractor::Context.new(context, &block)
-        end
+    def initialize(*)
+      super
     end
 
     def call_all
-      planned = coactors.map { |interactor| interactor.new(@context) } + [self]
-      planned.each_with_index do |interactor, i|
-        if i == planned.size - 1
-          interactor.call_self
+      planned = case IIInteractor.config.traversal
+        when :preorder
+          [self] + coactors
+        when :postorder
+          coactors + [self]
+        when :inorder
+          planned = coactors.in_groups(2, false)
+          planned[0] + [self] + planned[1]
+        end
+
+      planned.each do |interactor|
+        if interactor == self
+          call_self
         else
-          interactor.call_all
+          interactor.new(@context).call_all
         end
         break if @context.stopped?
       end
@@ -30,7 +36,7 @@ module IIInteractor
 
     def call_self
       call.tap do
-        @context._called << self
+        @context.called!(self)
       end
     end
 
@@ -41,7 +47,7 @@ module IIInteractor
     end
 
     def inform(*args)
-      @context._block.call(*([self] + args)) if @context._block
+      @context.call_block!(*([self] + args))
     end
 
     def fail!(data = {})
@@ -54,12 +60,12 @@ module IIInteractor
     end
 
     class_methods do
-      def call(*args, &block)
-        interactor = new(*args, &block)
+      def call(args = {}, &block)
+        interactor = new(args, &block)
         interactor.call_all
         interactor.context
       rescue UnprogressableError
-        interactor.context._called.reverse.each do |called|
+        interactor.context[:_called].reverse.each do |called|
           called.rollback
         end
         interactor.context

data/lib/ii_interactor/instrumentation.rb

@@ -4,6 +4,11 @@ module IIInteractor
   module Instrumentation
     extend ActiveSupport::Concern
 
+    def call_all
+      ActiveSupport::Notifications.instrument 'calling.ii_interactor', interactor: self
+      super
+    end
+
     def call_self
       ActiveSupport::Notifications.instrument 'call.ii_interactor', interactor: self do
         super

data/lib/ii_interactor/log_subscriber.rb

@@ -2,6 +2,13 @@
 
 module IIInteractor
   class LogSubscriber < ActiveSupport::LogSubscriber
+    def calling(event)
+      debug do
+        interactor = event.payload[:interactor]
+        "Calling #{interactor.class} with #{interactor.context}"
+      end
+    end
+
     def call(event)
       debug do
         interactor = event.payload[:interactor]
@@ -9,6 +16,8 @@ module IIInteractor
       end
     end
 
+    private
+
     def additional_log(event)
       additions = ["Duration: %.1fms" % event.duration]
       additions << "Allocations: %d" % event.allocations if event.respond_to?(:allocations)

data/lib/ii_interactor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_interactor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - gemfiles/rails52.gemfile
 - gemfiles/rails60.gemfile
 - gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
 - ii_interactor.gemspec
 - lib/ii_interactor.rb
 - lib/ii_interactor/base.rb
@@ -137,11 +138,11 @@ files:
 - lib/ii_interactor/coactors.rb
 - lib/ii_interactor/config.rb
 - lib/ii_interactor/context.rb
+- lib/ii_interactor/contextualizer.rb
 - lib/ii_interactor/core.rb
 - lib/ii_interactor/errors.rb
 - lib/ii_interactor/instrumentation.rb
 - lib/ii_interactor/log_subscriber.rb
-- lib/ii_interactor/variables.rb
 - lib/ii_interactor/version.rb
 homepage: https://github.com/kanety/ii_interactor
 licenses: []
@@ -161,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A base interactor to support management of bussiness logic

data/lib/ii_interactor/variables.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module IIInteractor
-  class Variable < Struct.new(:name, :options)
-    def default
-      options[:default] if options
-    end
-
-    def required?
-      options[:required] if options
-    end
-
-    def from_return?
-      options[:from_return] if options
-    end
-  end
-
-  module Variables
-    extend ActiveSupport::Concern
-
-    def call_self
-      (self.class.context_ins + self.class.context_outs).each do |var|
-        if var.required? && !@context.respond_to?(var.name)
-          raise RequiredContextError.new("missing required context: #{var.name}")
-        end
-        if var.default && !@context.respond_to?(var.name)
-          @context[var.name] = Variables.resolve(self, var.default)
-        end
-        instance_variable_set("@#{var.name}", @context[var.name])
-      end
-
-      super.tap do |return_value|
-        self.class.context_outs.each do |var|
-          @context[var.name] =
-              if var.from_return?
-                return_value
-              else
-                instance_variable_get("@#{var.name}")
-              end
-        end
-      end
-    end
-
-    class << self
-      def resolve(interactor, value)
-        if value.respond_to?(:call)
-          interactor.instance_exec(&value)
-        elsif value.is_a?(Symbol) && interactor.respond_to?(value, true)
-          interactor.send(value)
-        else
-          value.deep_dup
-        end
-      end
-    end
-
-    included do
-      class_attribute :context_ins, :context_outs
-      self.context_ins = []
-      self.context_outs = []
-    end
-
-    class_methods do
-      def context_in(*names, **options)
-        self.context_ins = self.context_ins + names.map { |name| Variable.new(name, options) }
-      end
-
-      def context_out(*names, **options)
-        self.context_outs = self.context_outs + names.map { |name| Variable.new(name, options) }
-      end
-    end
-  end
-end