ii_interactor 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98e0554614d026c2bfae6957324c4865bcc5b42accda1722c597415de801b222
-  data.tar.gz: 53cdc0666633a1ab0f04b0ed7200a3e3444ca846f7e78ba1f05106fc9bfe021b
+  metadata.gz: 9e2c11382c90fb3533448d1ddc3ed2f1ca922abb204570beba2eed4ad264fbef
+  data.tar.gz: dd2cd0bab63421c2c45b595438e2b4ef2f914abc041ce1cb1a655cd6ac98575c
 SHA512:
-  metadata.gz: 7b82959dadcc853ad7b1123f8282a23a25704bee0c462923cd41da6de357fa64f8d929139c37a5a94d21d49c5a2750eb265af046f76bb2ef8e5383592c0b4259
-  data.tar.gz: 790eb7bfc8de896dd22b9af3b8546721022a45c2fb3a86b3d6c6241a5aab269eb7c76c29491ee4c11a359486b7e13f858e5813f2aa639a72a03b28e233b90508
+  metadata.gz: e4ba848c2b8582434360c1f9f47b646fcea0e1954ec64419d8beb1b46b8bedd73876cc49de3f0a2f6258dc49db034e468b34bb90794a00c8807060cc2304ddb3
+  data.tar.gz: e765a8adb58f62202ca6e35e302846185d575776805aaed73bc9495de7ebd6bca800f864d47bb176da5731b012af6897272e9810efee7f22af56b3807019d7a2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.2.0
+
+* Add variable setting feature.
+
 ## 1.1.1
 
 * Check `config.eager_load` instead of `Rails.env` before file loading.

data/README.md

@@ -36,8 +36,73 @@ Interactor.call(message: 'something')
 #=> #<IIInteractor::Context message="something", result="called by something">
 ```
 
-The first argument of `call` is set to `@context`.
-The return value of `call` is the same as `@context`.
+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 into instance variables of interactor,
+while `context_out` copies instance variables of interactor into context.
+
+You can also define required context as follows:
+
+```ruby
+class Interactor < IIInteractor::Base
+  context_in :input, required: true
+end
+
+Interactor.call
+#=> IIInteractor::RequiredContextError (missing required context: input2)
+```
+
+You can also define default value as follows:
+
+```ruby
+class Interactor < IIInteractor::Base
+  context_in :input, default: 'input'
+
+  def call
+    puts @input
+  end
+end
+
+Interactor.call
+#=> input
+```
+
+You can also set context from return value of `call` method:
+
+```ruby
+class Interactor < IIInteractor::Base
+  context_out :result, from_return: true
+
+  def call
+    'returned value'
+  end
+end
+
+Interactor.call.result
+#=> returned value
+```
 
 ### Callbacks
 

data/lib/ii_interactor/base.rb

@@ -2,6 +2,7 @@
 
 require_relative 'context'
 require_relative 'core'
+require_relative 'variables'
 require_relative 'callbacks'
 require_relative 'instrumentation'
 require_relative 'interaction'
@@ -12,6 +13,7 @@ module IIInteractor
     include Core
     include Callbacks
     include Instrumentation
+    include Variables
     include Interaction
     include Lookup
   end

data/lib/ii_interactor/context.rb

@@ -7,7 +7,6 @@ module IIInteractor
       self[:_block] = block
       self[:_failed] = false
       self[:_stopped] = false
-      self[:_planned] = []
       self[:_called] = []
     end
 

data/lib/ii_interactor/core.rb

@@ -18,7 +18,6 @@ module IIInteractor
 
     def call_all
       planned = lookup.map { |interactor| interactor.new(@context) } + [self]
-      @context._planned += planned
       planned.each_with_index do |interactor, i|
         if i == planned.size - 1
           interactor.call_self
@@ -30,8 +29,9 @@ module IIInteractor
     end
 
     def call_self
-      call
-      @context._called << self
+      call.tap do
+        @context._called << self
+      end
     end
 
     def call
@@ -54,8 +54,8 @@ module IIInteractor
     end
 
     class_methods do
-      def call(context = {}, &block)
-        interactor = new(context, &block)
+      def call(*args, &block)
+        interactor = new(*args, &block)
         interactor.call_all
         interactor.context
       rescue UnprogressableError

data/lib/ii_interactor/errors.rb

@@ -3,4 +3,7 @@
 module IIInteractor
   class UnprogressableError < StandardError
   end
+
+  class RequiredContextError < StandardError
+  end
 end

data/lib/ii_interactor/variables.rb

@@ -0,0 +1,72 @@
+# 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

data/lib/ii_interactor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_interactor
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -132,6 +132,7 @@ files:
 - lib/ii_interactor/lookups/base.rb
 - lib/ii_interactor/lookups/name.rb
 - lib/ii_interactor/lookups/object.rb
+- lib/ii_interactor/variables.rb
 - lib/ii_interactor/version.rb
 homepage: https://github.com/kanety/ii_interactor
 licenses: []