direct 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b177e702ac1b7caafa4430f8e552336d07997d7ecdb0cc7eb21eda814c5b10a1
-  data.tar.gz: 8236f43a4a784720af82eab4b5cbaea76182373cf329a2162001086fa3c8fc64
+  metadata.gz: 20440d5b3580056507598e8506d9a6e8e26623601dc07ed6cfc443ee2e4dee04
+  data.tar.gz: 981844bd5ede5b4b889ed19ee5ca16cc2c6cdcaa898f166bc3e3132d8034e962
 SHA512:
-  metadata.gz: a065bf3c181084b8fe3418af13dd9b7ea096bd7cb8e6b717e3264457271021591d4bff17eae4e9bb3bb69a4acc4f2304c262a670b77cf69b08d16834ba458e39
-  data.tar.gz: 4fe6b632e7c6d6b7204af70efd1cd5e00b53d86a19d5e0cc03f59023bbb9b1c52205693ade062cd3e5a51d2a1eb28c0776d5bb20f77da2d9115f58d74201c63d
+  metadata.gz: d7207fd5bd4c1447f4686deff93bddd8d9802722accaa37118979afd0fc46afe75f616a73ffa24628ccfb111c3121ff92319346484c914931f753cce4102059f
+  data.tar.gz: 628cd5d0416be38cdfe79a7a50473c0b59944af35d3b6c01264562dfc0d7f11287d13908ef1c63d9ddc30f870aefdf1a8327c38765c3e246aea7db9d8c28aa8c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 1.2.1
+
+Provide an 'object:' to a Direct.defer or Direct.strict_defer to be sent as the third parameter in the executed blocks.
+
 ## Version 1.2.0
 
 Provide a Direct.defer and Direct.strict_defer to allow deferring blocks without success and failure procedures.

data/lib/direct.rb

@@ -68,8 +68,8 @@ module Direct
   #   end
   #   do_it.value
   #
-  def self.defer(&block)
-    Executable.new(&block)
+  def self.defer(*args, object: nil, &block)
+    Executable.new(*args, object: object, &block)
   end
 
   # Tell the object what to do in a given scenario.

data/lib/direct/executable.rb

@@ -16,11 +16,36 @@ module Direct
     #
     #   Direct.defer(->{ "call me, maybe" })
     #
-    def initialize(callable=nil, &block)
+    # You may also provide an 'object:' parameter which will be
+    # passed to the provided blocks when they are ultimately executed
+    #
+    # Example:
+    #
+    #   Direct.defer(object: self) do
+    #     # do work here
+    #   end.success {|deferred, deferred_block_result, object|
+    #     # you have access to the provided object here
+    #   }
+    #
+    # The object is a useful reference because the Executable instance
+    # is the deferred object, instead of the object using Direct.defer
+    #
+    #   class Thing
+    #     def do_something
+    #       Direct.defer(object: self){ do_the_work }
+    #     end
+    #   end
+    #
+    #   Thing.new.do_something.success {|deferred, result, thing|
+    #      puts "The #{thing} did something!"
+    #   }.execute
+    #
+    def initialize(callable=nil, object: nil, &block)
+      @object = object
       @execution = callable || block
       @exception_classes = [StandardError]
     end
-    attr_reader :execution, :exception_classes
+    attr_reader :execution, :exception_classes, :object
 
     # Tell the object what to do for a success path
     #
@@ -51,7 +76,7 @@ module Direct
     #
     #   Direct.defer {
     #      # something...
-    #   }.exception(NoMethodError) { |deferred, exception|
+    #   }.exception(NoMethodError) { |deferred, exception, object|
     #      ExceptionNotifier.notify(exception)
     #   }
     #
@@ -65,9 +90,9 @@ module Direct
 
     def run_exception_block(exception)
       if __directions.key?(:exception)
-        as_directed(:exception, exception)
+        as_directed(:exception, exception, object)
       else
-        as_directed(:failure, exception)
+        as_directed(:failure, exception, object)
       end
     end
     private :run_exception_block
@@ -79,9 +104,9 @@ module Direct
     def value
       result = execution.()
       if result
-        as_directed(:success, result)
+        as_directed(:success, result, object)
       else
-        as_directed(:failure, result)
+        as_directed(:failure, result, object)
       end
     rescue *exception_classes => exception
       run_exception_block(exception)

data/lib/direct/strict_executable.rb

@@ -16,11 +16,38 @@ module Direct
     #
     #   Direct.strict_defer(->{ "call me, maybe" })
     #
-    def initialize(callable=nil, &block)
+    # You may also provide an 'object:' parameter which will be
+    # passed to the provided blocks when they are ultimately executed
+    #
+    # Example:
+    #
+    #   Direct.strict_defer(object: self) do
+    #     # do work here
+    #   end.success {|deferred, deferred_block_result, object|
+    #     # you have access to the provided object here
+    #   }
+    #
+    # The object is a useful reference because the Executable instance
+    # is the deferred object, instead of the object using Direct.strict_defer
+    #
+    #   class Thing
+    #     def do_something
+    #       Direct.strict_defer(object: self){ do_the_work }
+    #     end
+    #   end
+    #
+    #   Thing.new.do_something.success {|deferred, result, thing|
+    #      puts "The #{thing} did something!"
+    #   }.failure{|_,_,thing|
+    #      puts "#{thing} failed!"
+    #   }.execute
+    #
+    def initialize(callable=nil, object: nil, &block)
+      @object = object
       @execution = callable || block
       @exception_classes = [StandardError]
     end
-    attr_reader :execution, :exception_classes
+    attr_reader :execution, :exception_classes, :object
 
     # Tell the object what to do for a success path
     #
@@ -51,7 +78,7 @@ module Direct
     #
     #   Direct.strict_defer {
     #      # something...
-    #   }.exception(NoMethodError) { |deferred, exception|
+    #   }.exception(NoMethodError) { |deferred, exception, object|
     #      ExceptionNotifier.notify(exception)
     #   }
     #
@@ -65,9 +92,9 @@ module Direct
 
     def run_exception_block(exception)
       if __directions.key?(:exception)
-        as_directed(:exception, exception)
+        as_directed(:exception, exception, object)
       else
-        as_directed(:failure, exception)
+        as_directed(:failure, exception, object)
       end
     end
     private :run_exception_block

data/lib/direct/version.rb

@@ -1,3 +1,3 @@
 module Direct
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: direct
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby