bg 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b59fee4ea49e20b0f003c82d4e88cfe8944ba00
-  data.tar.gz: 5e1d394c114e456a75d342f566777a79f855cf49
+  metadata.gz: 4324480197c976cb308ccd3ea1793b5620e01be2
+  data.tar.gz: 76fafd8fa06023ebb0beea60f5d9a264293e3647
 SHA512:
-  metadata.gz: 0f98b49309738b49b5a2e91d361d7a1a4a7edde4547edade187374461d3be98d4c870820e4488ed57ae5e75b268cc673926b2a18cff7b7d43da41be3db645677
-  data.tar.gz: e19f24f3030ca8f696859d0b051ca5225095044b978ea68bea7d1cff8e55a834c485393507e509684d354de6b3b130028eb3ef5b8398fb113cf7335ab3712470
+  metadata.gz: 02a6086051a13bc6a062fe1490664b4eaf1e5a94f238020423e531038cce1894a2203936bc0fc7f0a8166bc188d25038a3c57f45fbbc16be1fd3fa5c8f78cd54
+  data.tar.gz: 49a95bf68e2c28513012074449c522a3803ccf2d02087ec2993f68f7e0d84e4ef2d458326f89902b5cedc18c0a3322044e64feca9de6660433e1aaa9636dd62a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bg (0.0.4)
+    bg (0.0.5)
       activejob (>= 5.0)
       activerecord (>= 5.0)
       concurrent-ruby (>= 1.0)

data/README.md

@@ -1,4 +1,4 @@
-[![Lines of Code](http://img.shields.io/badge/lines_of_code-121-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-117-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
 [![Code Status](http://img.shields.io/codeclimate/github/hopsoft/bg.svg?style=flat)](https://codeclimate.com/github/hopsoft/bg)
 [![Dependency Status](http://img.shields.io/gemnasium/hopsoft/bg.svg?style=flat)](https://gemnasium.com/hopsoft/bg)
 [![Build Status](http://img.shields.io/travis/hopsoft/bg.svg?style=flat)](https://travis-ci.org/hopsoft/bg)
@@ -30,19 +30,25 @@ end
 
 ```ruby
 user = User.find(params[:id])
-user.do_hard_work       # blocking in-process
-user.async.do_hard_work # non-blocking in-process
-user.defer.do_hard_work # non-blocking out-of-process background job
+
+# blocking in-process
+user.do_hard_work
+
+# non-blocking in-process separate thread
+user.async.do_hard_work
+
+# non-blocking out-of-process background job
+user.defer.do_hard_work
 user.defer(queue: :low, wait: 5.minutes).do_hard_work
 ```
 
-## Provisos
+## Deferrable
 
-Bg leverages [GlobalID::Identification](https://github.com/rails/globalid) to marshal ActiveRecord instances across thread & process boundaries.
-This means that state is not shared between the main process/thread with the process/thread actually executing the method.
+`Bg::Deferrable` leverages [GlobalID::Identification](https://github.com/rails/globalid) to marshal ActiveRecord instances across process boundaries.
+This means that state is not shared between the main process & the process actually executing the method.
 
-* __Do not__ depend on lexically scoped bindings when invoking methods with `Bg::Deferrable`.
-* __Do not__ pass unmarshallable types as arguments with `Bg::Deferrable`.
+* __Do not__ depend on lexically scoped bindings when invoking methods.
+* __Do not__ pass unmarshallable types as arguments.
   `Bg::Deferrable` will prepare arguments for enqueuing, but best practice is to follow
   Sidekiq's [simple parameters](https://github.com/mperham/sidekiq/wiki/Best-Practices#1-make-your-job-parameters-small-and-simple) rule.
 
@@ -52,9 +58,6 @@ This means that state is not shared between the main process/thread with the pro
 
 ```ruby
 user = User.find(params[:id])
-user.update(name: "new value") # persisted changes will be available in Bg invoked methods
-
-user.async.do_hard_work 1, true, "foo", :bar, Time.now
 user.defer.do_hard_work 1, true, "foo"
 ```
 
@@ -62,15 +65,41 @@ user.defer.do_hard_work 1, true, "foo"
 
 ```ruby
 user = User.find(params[:id])
-user.name = "new value" # in memory changes will not be available in Bg invoked methods
+# in memory changes will not be available in Bg::Deferrable invoked methods
+user.name = "new value"
 
-user.async.do_hard_work do
+# args may not marshal properly
+user.defer.do_hard_work :foo, Time.now, instance_of_complex_type
+
+user.defer.do_hard_work do
   # blocks are not supported
 end
+```
 
-user.defer.do_hard_work :foo, Time.now # args won't marshal properly
+## Asyncable
 
-user.defer.do_hard_work do
+`Bg::Asyncable` disallows invoking methods that take blocks as an argument.
+
+* __Important:__ It's your responsibility to protect shared data between threads
+
+### Examples
+
+#### Good
+
+```ruby
+user = User.find(params[:id])
+user.name = "new value"
+user.async.do_hard_work 1, true, "foo"
+user.async.do_hard_work :foo, Time.now, instance_of_complex_type
+```
+
+#### Bad
+
+```ruby
+user = User.find(params[:id])
+
+user.async.do_hard_work do
   # blocks are not supported
 end
 ```
+

data/lib/bg/asyncable.rb

@@ -1,51 +1,47 @@
 require "active_record"
 require "concurrent"
-require "globalid"
 
 module Bg
   class Asyncable
     class Wrapper
       include ::Concurrent::Async
-      attr_reader :global_id, :delay
 
-      def initialize(global_id, delay: 0)
+      def initialize(object, wait: 0)
         # IMPORTANT: call super without any arguments
         # https://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Async.html
         super()
-        @global_id = global_id
-        @delay = delay.to_f
+        @object = object
+        @wait = wait.to_f
       end
 
       def invoke_method(name, *args)
-        sleep delay if delay > 0
-        ::ActiveRecord::Base.connection_pool.with_connection do
-          global_id.find.send name, *args
+        sleep @wait if @wait > 0
+        base = self.is_a?(::ActiveRecord::Base) ? self.class : ::ActiveRecord::Base
+        base.connection_pool.with_connection do
+          @object.send name, *args
         end
       end
     end
 
     module Behavior
-      def async(delay: 0)
-        ::Bg::Asyncable.new(self, delay: delay.to_f)
+      def async(wait: 0)
+        ::Bg::Asyncable.new(self, wait: wait.to_f)
       end
     end
 
-    attr_reader :object, :delay
-
-    def initialize(object, delay: 0)
-      raise ::ArgumentError unless object.is_a?(::GlobalID::Identification)
+    def initialize(object, wait: 0)
       @object = object
-      @delay = delay.to_f
+      @wait = wait.to_f
     end
 
     def method_missing(name, *args)
-      if object.respond_to? name
+      if @object.respond_to? name
         raise ::ArgumentError.new("blocks are not supported") if block_given?
         begin
-          wrapped = ::Bg::Asyncable::Wrapper.new(object.to_global_id, delay: delay)
+          wrapped = ::Bg::Asyncable::Wrapper.new(@object, wait: @wait)
           wrapped.async.invoke_method name, *args
         rescue ::StandardError => e
-          raise ::ArgumentError.new("Failed to execute method asynchronously! <#{object.class.name}##{name}> #{e.message}")
+          raise ::ArgumentError.new("Failed to execute method asynchronously! <#{@object.class.name}##{name}> #{e.message}")
         ensure
           return
         end
@@ -54,7 +50,7 @@ module Bg
     end
 
     def respond_to?(name)
-      return true if object.respond_to? name
+      return true if @object.respond_to? name
       super
     end
   end

data/lib/bg/deferrable.rb

@@ -27,8 +27,6 @@ module Bg
       end
     end
 
-    attr_reader :object, :queue, :wait
-
     def initialize(object, queue: :default, wait: 0)
       raise ::ArgumentError unless object.is_a?(::GlobalID::Identification)
       @object = object
@@ -37,14 +35,14 @@ module Bg
     end
 
     def method_missing(name, *args)
-      if object.respond_to? name
+      if @object.respond_to? name
         raise ::ArgumentError.new("blocks are not supported") if block_given?
         begin
-          queue_args = { queue: queue }
-          queue_args[:wait] = wait if wait > 0
-          job = ::Bg::DeferredMethodCallJob.set(**queue_args).perform_later object, name.to_s, *self.class.make_enqueable(args)
+          queue_args = { queue: @queue }
+          queue_args[:wait] = @wait if @wait > 0
+          job = ::Bg::DeferredMethodCallJob.set(**queue_args).perform_later @object, name.to_s, *self.class.make_enqueable(args)
         rescue ::StandardError => e
-          raise ::ArgumentError.new("Failed to background method call! <#{object.class.name}##{name}> #{e.message}")
+          raise ::ArgumentError.new("Failed to background method call! <#{@object.class.name}##{name}> #{e.message}")
         ensure
           return job
         end
@@ -53,7 +51,7 @@ module Bg
     end
 
     def respond_to?(name)
-      return true if object.respond_to? name
+      return true if @object.respond_to? name
       super
     end
   end

data/lib/bg/version.rb

@@ -1,3 +1,3 @@
 module Bg
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/bg/deferred_method_call_test.rb

@@ -36,4 +36,9 @@ class Bg::DeferredMethodCallJobTest < ::ActiveJob::TestCase
     end
   end
 
+  test "#perform_now properly invokes the method" do
+    obj = ::Bg::BackgroundableObject.new(:example)
+    assert ::Bg::DeferredMethodCallJob.perform_now(obj, :update)
+  end
+
 end

data/test/test_helper.rb

@@ -4,9 +4,9 @@ require_relative "../lib/bg"
 require_relative "backgroundable_object"
 require "minitest/autorun"
 require "purdytest"
-#require "pry"
-#require "pry-nav"
-#require "pry-stack_explorer"
+require "pry"
+require "pry-nav"
+require "pry-stack_explorer"
 
 ::ActiveSupport::TestCase.test_order = :random
 ::GlobalID.app = "test"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bg
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nathan Hopkins