activeinteractor 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e933d8615e2b55bf47049e291b801193e2341b03e3c0a29bb8d8f7c8166adee3
-  data.tar.gz: afc759ee08f37bbbba50e2ac6c1508afb0d303c0f37ca5cdfcf75d6347e210b0
+  metadata.gz: 5ce2748cbf2a6f2584dbcb73cfce3347d2bd9447e7f02af34bb99d488c50e117
+  data.tar.gz: c5c088b60da0c26ddab97fa8f9c033375e6ef95e2aff17363c3f828b2df433dc
 SHA512:
-  metadata.gz: 8edc74485608e067bb6e9e9df3a19d9c0651df4351c9e56239b41ce1fb39fa4d7595e08366799fcbcfa79390e0fe1a1f1b0a652e01f8855905d93dcc53d05b69
-  data.tar.gz: 0d8b82c2ebfce20b413a4563eb0244081b1ca3910186de9ad9880cc246408df68e282ef0ec21adb4f89eda7947fe79c62555f1c24c8795a08dff15bd7dec621d
+  metadata.gz: aa6e94e75c3470d0e3807c0caf4802ec543613d731bde0c8d693943ebe594ec91538a28bc29fbb43ed738da9d6705c97211301bb4294e902e2c43fa50f543d05
+  data.tar.gz: 437b0c0e527018c101610d2f7731130cfd8f2df62627242a6ec6ed24430427473501c72429ef53378892ce6155704bc7b0665d243c8fe4a49d1d3dad27fb0c13

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [v0.1.3] - 2019-04-01
+
+### Added
+
+- #25: Implement `each_perform` callbacks on organizers
+
 ## [v0.1.2] - 2019-04-01
 
 ### Added
@@ -27,6 +33,7 @@ and this project adheres to [Semantic Versioning].
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
 
-[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.3..HEAD
+[v0.1.3]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.2...v0.1.3
 [v0.1.2]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.1...v0.1.2
 [v0.1.1]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.0...v0.1.1

data/README.md

@@ -460,6 +460,127 @@ context.rollback!
 "Done"
 ```
 
+We can do worker before `perform` is invoked on each interactor in an [Organizer](#organizers) with the `before_each_perform` method:
+
+```ruby
+ class MyInteractor1 < ActiveInteractor::Base
+  before_perform :print_name
+
+  def perform
+    puts 'MyInteractor1'
+  end
+end
+
+class MyInteractor2 < ActiveInteractor::Base
+  before_perform :print_name
+
+  def perform
+    puts 'MyInteractor2'
+  end
+end
+
+class MyOrganizer < ActiveInteractor::Organizer
+  before_each_perform :print_start
+
+  organized MyInteractor1, MyInteractor2
+
+  private
+
+  def print_start
+    puts "Start"
+  end
+end
+
+MyOrganizer.perform(name: 'Aaron')
+"Start"
+"MyInteractor1"
+"Start"
+"MyInteractor2"
+#=> <MyOrganizer::Context name='Aaron'>
+```
+
+We can do worker around `perform` is invokation on each interactor in an [Organizer](#organizers) with the `around_each_perform` method:
+
+```ruby
+ class MyInteractor1 < ActiveInteractor::Base
+  before_perform :print_name
+
+  def perform
+    puts 'MyInteractor1'
+  end
+end
+
+class MyInteractor2 < ActiveInteractor::Base
+  before_perform :print_name
+
+  def perform
+    puts 'MyInteractor2'
+  end
+end
+
+class MyOrganizer < ActiveInteractor::Organizer
+  around_each_perform :print_time
+
+  organized MyInteractor1, MyInteractor2
+
+  private
+
+  def print_time
+    puts Time.now.utc
+    yield
+    puts Time.now.utc
+  end
+end
+
+MyOrganizer.perform(name: 'Aaron')
+"2019-04-01 00:00:00 UTC"
+"MyInteractor1"
+"2019-04-01 00:00:01 UTC"
+"2019-04-01 00:00:02 UTC"
+"MyInteractor2"
+"2019-04-01 00:00:03 UTC"
+#=> <MyOrganizer::Context name='Aaron'>
+```
+
+We can do worker after `perform` is invoked on each interactor in an [Organizer](#organizers) with the `after_each_perform` method:
+
+```ruby
+class MyInteractor1 < ActiveInteractor::Base
+  before_perform :print_name
+
+  def perform
+    puts 'MyInteractor1'
+  end
+end
+
+class MyInteractor2 < ActiveInteractor::Base
+  before_perform :print_name
+
+  def perform
+    puts 'MyInteractor2'
+  end
+end
+
+class MyOrganizer < ActiveInteractor::Organizer
+  after_each_perform :print_done
+
+  organized MyInteractor1, MyInteractor2
+
+  private
+
+  def print_done
+    puts "done"
+  end
+end
+
+MyOrganizer.perform(name: 'Aaron')
+"MyInteractor1"
+"Done"
+"MyInteractor2"
+"Done"
+#=> <MyOrganizer::Context name='Aaron'>
+```
+
 ### Using Interactors
 
 Most of the time, your application will use its interactors from its controllers. The following controller:

data/lib/active_interactor/configuration.rb

@@ -5,15 +5,15 @@ module ActiveInteractor
   #
   # @author Aaron Allen <hello@aaronmallen.me>
   # @since 0.0.1
-  # @version 0.1
+  # @version 0.2
   #
   # @!attribute [rw] logger
   #  @return [Logger] an instance of Logger
+  # @!attribute [rw] dir_name
+  #  @return [String] The directory name interactors are generated in
   class Configuration
     # The default configuration options for {Configuration}
     # @return [Hash{Symbol => *}]
-    #  * :logger - The Logger instance to use for logging
-    #  * :dir_name - The directory interactors are generated in
     DEFAULTS = {
       logger: Logger.new(STDOUT),
       dir_name: 'interactors'
@@ -26,6 +26,7 @@ module ActiveInteractor
     #  configuration with.
     # @option options [Logger] :logger the logger ActiveInteractor should
     #  use for logging
+    # @option options [String] :dir_name he directory name interactors are generated in
     # @return [ActiveInteractor::Configuration] a new instance of {Configuration}
     def initialize(options = {})
       options = DEFAULTS.merge(options.dup || {}).slice(*DEFAULTS.keys)

data/lib/active_interactor/interactor/callbacks.rb

@@ -39,7 +39,7 @@ module ActiveInteractor
         #    end
         #  end
         #
-        #  context = MyInteractor.new(name: 'Bob').context
+        #  context = MyInteractor.perform(name: 'Bob')
         #  #=> <MyInteractor::Context name='Bob'>
         #
         #  context.valid?
@@ -186,7 +186,7 @@ module ActiveInteractor
         #    end
         #  end
         #
-        #  context = MyInteractor.new(name: 'Bob').context
+        #  context = MyInteractor.perform(name: 'Bob')
         #  #=> <MyInteractor::Context name='Bob'>
         #
         #  context.valid?

data/lib/active_interactor/interactor/execution.rb

@@ -2,6 +2,11 @@
 
 module ActiveInteractor
   module Interactor
+    # Provides worker methods to included classes
+    #
+    # @author Aaron Allen <hello@aaronmallen.me>
+    # @since 0.0.2
+    # @version 0.2
     module Execution
       extend ActiveSupport::Concern
 

data/lib/active_interactor/interactor/worker.rb

@@ -2,6 +2,12 @@
 
 module ActiveInteractor
   module Interactor
+    # A worker class responsible for thread safe execution
+    #  of interactor {.perform} methods.
+    #
+    # @author Aaron Allen <hello@aaronmallen.me>
+    # @since 0.0.2
+    # @version 0.1
     class Worker
       delegate :run_callbacks, to: :interactor
 
@@ -36,6 +42,8 @@ module ActiveInteractor
       end
 
       # Calls {Interactor#rollback} with callbacks
+      # @return [Boolean] `true` if rolled back successfully or `false` if already
+      #  rolled back
       def execute_rollback
         run_callbacks :rollback do
           interactor.rollback

data/lib/active_interactor/organizer.rb

@@ -5,12 +5,144 @@ module ActiveInteractor
   #
   # @author Aaron Allen <hello@aaronmallen.me>
   # @since 0.0.1
-  # @version 0.1
+  # @version 0.3
   class Organizer < ActiveInteractor::Base
+    define_callbacks :each_perform
+
     class << self
+      # Define a callback to call after each organized interactor's
+      #  {ActiveInteractor::Base.perform} has been invoked
+      #
+      # @example
+      #  class MyInteractor1 < ActiveInteractor::Base
+      #    before_perform :print_name
+      #
+      #    def perform
+      #      puts 'MyInteractor1'
+      #    end
+      #  end
+      #
+      #  class MyInteractor2 < ActiveInteractor::Base
+      #    before_perform :print_name
+      #
+      #    def perform
+      #      puts 'MyInteractor2'
+      #    end
+      #  end
+      #
+      #  class MyOrganizer < ActiveInteractor::Organizer
+      #    after_each_perform :print_done
+      #
+      #    organized MyInteractor1, MyInteractor2
+      #
+      #    private
+      #
+      #    def print_done
+      #      puts "done"
+      #    end
+      #  end
+      #
+      #  MyOrganizer.perform(name: 'Aaron')
+      #  "MyInteractor1"
+      #  "Done"
+      #  "MyInteractor2"
+      #  "Done"
+      #  #=> <MyOrganizer::Context name='Aaron'>
+      def after_each_perform(*filters, &block)
+        set_callback(:each_perform, :after, *filters, &block)
+      end
+
+      # Define a callback to call around each organized interactor's
+      #  {ActiveInteractor::Base.perform} has been invokation
+      #
+      # @example
+      #  class MyInteractor1 < ActiveInteractor::Base
+      #    before_perform :print_name
+      #
+      #    def perform
+      #      puts 'MyInteractor1'
+      #    end
+      #  end
+      #
+      #  class MyInteractor2 < ActiveInteractor::Base
+      #    before_perform :print_name
+      #
+      #    def perform
+      #      puts 'MyInteractor2'
+      #    end
+      #  end
+      #
+      #  class MyOrganizer < ActiveInteractor::Organizer
+      #    around_each_perform :print_time
+      #
+      #    organized MyInteractor1, MyInteractor2
+      #
+      #    private
+      #
+      #    def print_time
+      #      puts Time.now.utc
+      #      yield
+      #      puts Time.now.utc
+      #    end
+      #  end
+      #
+      #  MyOrganizer.perform(name: 'Aaron')
+      #  "2019-04-01 00:00:00 UTC"
+      #  "MyInteractor1"
+      #  "2019-04-01 00:00:01 UTC"
+      #  "2019-04-01 00:00:02 UTC"
+      #  "MyInteractor2"
+      #  "2019-04-01 00:00:03 UTC"
+      #  #=> <MyOrganizer::Context name='Aaron'>
+      def around_each_perform(*filters, &block)
+        set_callback(:each_perform, :around, *filters, &block)
+      end
+
+      # Define a callback to call before each organized interactor's
+      #  {ActiveInteractor::Base.perform} has been invoked
+      #
+      # @example
+      #  class MyInteractor1 < ActiveInteractor::Base
+      #    before_perform :print_name
+      #
+      #    def perform
+      #      puts 'MyInteractor1'
+      #    end
+      #  end
+      #
+      #  class MyInteractor2 < ActiveInteractor::Base
+      #    before_perform :print_name
+      #
+      #    def perform
+      #      puts 'MyInteractor2'
+      #    end
+      #  end
+      #
+      #  class MyOrganizer < ActiveInteractor::Organizer
+      #    before_each_perform :print_start
+      #
+      #    organized MyInteractor1, MyInteractor2
+      #
+      #    private
+      #
+      #    def print_start
+      #      puts "Start"
+      #    end
+      #  end
+      #
+      #  MyOrganizer.perform(name: 'Aaron')
+      #  "Start"
+      #  "MyInteractor1"
+      #  "Start"
+      #  "MyInteractor2"
+      #  #=> <MyOrganizer::Context name='Aaron'>
+      def before_each_perform(*filters, &block)
+        set_callback(:each_perform, :before, *filters, &block)
+      end
+
       # Declare Interactors to be invoked as part of the
       #  organizer's invocation. These interactors are invoked in
-      #  the order in which they are declared.
+      #  the order in which they are declared
       #
       # @example
       #   class MyFirstOrganizer < ActiveInteractor::Organizer
@@ -26,8 +158,8 @@ module ActiveInteractor
         @organized = interactors.flatten
       end
 
-      # An Array of declared Interactors to be invoked.
-      # @private
+      # An Array of declared Interactors to be invoked
+      # @return [Array<ActiveInteractor::Base] the organized interactors
       def organized
         @organized ||= []
       end
@@ -38,9 +170,11 @@ module ActiveInteractor
     #  in favor of this default implementation.
     def perform
       self.class.organized.each do |interactor|
-        self.context = interactor.new(context)
-                                 .tap(&:skip_clean_context!)
-                                 .execute_perform!
+        run_callbacks :each_perform do
+          self.context = interactor.new(context)
+                                   .tap(&:skip_clean_context!)
+                                   .execute_perform!
+        end
       end
     end
   end

data/lib/active_interactor/version.rb

@@ -3,5 +3,5 @@
 module ActiveInteractor
   # The ActiveInteractor gem version
   # @return [String] the gem version
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/active_interactor.rb

@@ -26,7 +26,7 @@ require 'active_interactor/version'
 #
 # @author Aaron Allen <hello@aaronmallen.me>
 # @since 0.0.1
-# @version 0.1
+# @version 0.2
 module ActiveInteractor
   extend ActiveSupport::Autoload
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activeinteractor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Aaron Allen
@@ -244,10 +244,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/aaronmallen/activeinteractor/issues
-  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v0.1.2/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/0.1.2
+  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v0.1.3/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/0.1.3
   hompage_uri: https://github.com/aaronmallen/activeinteractor
-  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v0.1.2
+  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v0.1.3
   wiki_uri: https://github.com/aaronmallen/activeinteractor/wiki
 post_install_message: 
 rdoc_options: []