ii_interactor 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca26ce09ce20cc37d4e35337c05a5f49abf260a648752efeb1ac0e887f85dd8c
-  data.tar.gz: 0b6f575ef339301f4501b5abd0104dc8a4ce083fba0fe9e0fae4f8cc09b0d023
+  metadata.gz: 3d08217ca0d49ae98a2c034ed00bb785aca82359dd90a2d06285a6b6e850b5ac
+  data.tar.gz: 85d61cde0ae2f9e828637fcf5cd7144aabf9ba42d9842c582f9a86d06e7328d2
 SHA512:
-  metadata.gz: cc4b8a3cfa9b100299f91c17e04efa110c8c482dd9a2d1365003f962bf27fc3682822b5970453bbf9e6d19b6a4267639052aa7acdf23a9c38a24245cdabeb323
-  data.tar.gz: a882894b2f36b99e1aed993ae7bf888c8fc9261ec8f1c9f1a8f15ce39a67e374476dff2baa6c4a643e3d946a0fa7d8956aa91dcfcf26a1af4395cde0da466fd1
+  metadata.gz: 148a1e202624098aef8cbe7fcbededf1cd86a03d33c070768e1d75f0aa848363b45e4a9b349e6b614e1f753710d8256a4ac3aed9a39d2bf91a7444a9eb0140fd
+  data.tar.gz: daf5475ab67cae1eb42043c5b0cc20334683f94e4fdf908e222bcb67e323f81606b8b888a5e14c07b3d31c4a7ee1f68c285fa692f784fe575098f51ed6f20c89

data/.github/workflows/ci.yml

@@ -39,4 +39,4 @@ jobs:
         bundler-cache: true
     - name: Run test
       run: |
-        bundle exec rspec
+        DEBUG=1 bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## 1.1.0
+
+* Add log subscriber.
+
+## 1.0.0
+
+* First release.

data/README.md

@@ -359,6 +359,21 @@ end
 #   BInteractor: called B
 ```
 
+### Logging
+
+Interactor supports instrumentation hook supplied by `ActiveSupport::Notifications`.
+You can enable log subscriber as follows:
+
+```ruby
+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)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome at https://github.com/kanety/ii_interactor.

data/lib/ii_interactor.rb

@@ -5,6 +5,7 @@ require 'ii_interactor/errors'
 require 'ii_interactor/config'
 require 'ii_interactor/base'
 require 'ii_interactor/loader'
+require 'ii_interactor/log_subscriber'
 
 module IIInteractor
   class << self

data/lib/ii_interactor/base.rb

@@ -1,76 +1,18 @@
 # frozen_string_literal: true
 
 require_relative 'context'
+require_relative 'core'
 require_relative 'callbacks'
+require_relative 'instrumentation'
 require_relative 'interaction'
 require_relative 'lookup'
 
 module IIInteractor
   class Base
+    include Core
     include Callbacks
+    include Instrumentation
     include Interaction
     include Lookup
-
-    attr_reader :context
-
-    def initialize(context = {}, &block)
-      @context = if context.is_a?(IIInteractor::Context)
-          context
-        else
-          IIInteractor::Context.new(context, &block)
-        end
-    end
-
-    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
-        else
-          interactor.call_all
-        end
-        break if @context.stopped?
-      end
-    end
-
-    def call_self
-      run_callbacks :call do
-        call
-      end
-      @context._called << self
-    end
-
-    def call
-    end
-
-    def rollback
-    end
-
-    def inform(*args)
-      @context._block.call(*([self] + args)) if @context._block
-    end
-
-    def fail!(data = {})
-      @context.fail!(data)
-      raise UnprogressableError.new(@context)
-    end
-
-    def stop!(data = {})
-      @context.stop!(data)
-    end
-
-    class << self
-      def call(context = {}, &block)
-        interactor = new(context, &block)
-        interactor.call_all
-        interactor.context
-      rescue UnprogressableError
-        interactor.context._called.reverse.each do |called|
-          called.rollback
-        end
-        interactor.context
-      end
-    end
   end
 end

data/lib/ii_interactor/callbacks.rb

@@ -9,6 +9,12 @@ module IIInteractor
       define_callbacks :call
     end
 
+    def call_self
+      run_callbacks :call do
+        super
+      end
+    end
+
     class_methods do
       def before_call(*args, &block)
         set_callback(:call, :before, *args, &block)

data/lib/ii_interactor/core.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module IIInteractor
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :context
+    end
+
+    def initialize(context = {}, &block)
+      @context = if context.is_a?(IIInteractor::Context)
+          context
+        else
+          IIInteractor::Context.new(context, &block)
+        end
+    end
+
+    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
+        else
+          interactor.call_all
+        end
+        break if @context.stopped?
+      end
+    end
+
+    def call_self
+      call
+      @context._called << self
+    end
+
+    def call
+    end
+
+    def rollback
+    end
+
+    def inform(*args)
+      @context._block.call(*([self] + args)) if @context._block
+    end
+
+    def fail!(data = {})
+      @context.fail!(data)
+      raise UnprogressableError.new(@context)
+    end
+
+    def stop!(data = {})
+      @context.stop!(data)
+    end
+
+    class_methods do
+      def call(context = {}, &block)
+        interactor = new(context, &block)
+        interactor.call_all
+        interactor.context
+      rescue UnprogressableError
+        interactor.context._called.reverse.each do |called|
+          called.rollback
+        end
+        interactor.context
+      end
+    end
+  end
+end

data/lib/ii_interactor/instrumentation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IIInteractor
+  module Instrumentation
+    extend ActiveSupport::Concern
+
+    def call_self
+      ActiveSupport::Notifications.instrument 'call.ii_interactor', interactor: self do
+        super
+      end
+    end
+  end
+end

data/lib/ii_interactor/log_subscriber.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module IIInteractor
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def call(event)
+      debug do
+        interactor = event.payload[:interactor]
+        "Called #{interactor.class} (#{additional_log(event)})"
+      end
+    end
+
+    def additional_log(event)
+      additions = ["Duration: %.1fms" % event.duration]
+      additions << "Allocations: %d" % event.allocations if event.respond_to?(:allocations)
+      additions.join(', ')
+    end
+  end
+end

data/lib/ii_interactor/lookup.rb

@@ -41,11 +41,11 @@ module IIInteractor
       class_attribute :lookups
       self.lookups = [Lookups::Name, Lookups::Object]
 
-      class_attribute :_cache
-      self._cache = {}
+      class_attribute :cache
+      self.cache = {}
 
       def call(klass, interaction)
-        cache(klass, interaction) do
+        with_cache(klass, interaction) do
           lookup = lookups.detect { |lookup| lookup.call?(interaction) }
           lookup.new(klass, interaction).call if lookup
         end
@@ -53,10 +53,10 @@ module IIInteractor
 
       private
 
-      def cache(klass, interaction)
+      def with_cache(klass, interaction)
         if Config.lookup_cache
-          self._cache[klass] ||= {}
-          self._cache[klass][interaction] ||= yield
+          self.cache[klass] ||= {}
+          self.cache[klass][interaction] ||= yield
         else
           yield
         end

data/lib/ii_interactor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_interactor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,6 +104,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -121,9 +122,12 @@ files:
 - lib/ii_interactor/callbacks.rb
 - lib/ii_interactor/config.rb
 - lib/ii_interactor/context.rb
+- lib/ii_interactor/core.rb
 - lib/ii_interactor/errors.rb
+- lib/ii_interactor/instrumentation.rb
 - lib/ii_interactor/interaction.rb
 - lib/ii_interactor/loader.rb
+- lib/ii_interactor/log_subscriber.rb
 - lib/ii_interactor/lookup.rb
 - lib/ii_interactor/lookups/base.rb
 - lib/ii_interactor/lookups/name.rb