bg 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9e60fe8556df41a4f6c110b705b01468f5028ff
-  data.tar.gz: 02f1248cb0922f0574cce67be91686f101822f42
+  metadata.gz: 5b59fee4ea49e20b0f003c82d4e88cfe8944ba00
+  data.tar.gz: 5e1d394c114e456a75d342f566777a79f855cf49
 SHA512:
-  metadata.gz: 4134f2a8341716975bc058ba67e16a1776fc86d41dd54448844d60d35f10d0afd3ec2dde8d3f1f9babf26d816a256c7894d634f86c1167ef3283561a02b08ce1
-  data.tar.gz: c9ec7d2e1901e04efa435319b817e0b0907071d4a37a74abb519020a8aa98c050fc3f4a26238b04d3eea71f15af6fb00525330b8ec2a85dd123b8903efaf68a1
+  metadata.gz: 0f98b49309738b49b5a2e91d361d7a1a4a7edde4547edade187374461d3be98d4c870820e4488ed57ae5e75b268cc673926b2a18cff7b7d43da41be3db645677
+  data.tar.gz: e19f24f3030ca8f696859d0b051ca5225095044b978ea68bea7d1cff8e55a834c485393507e509684d354de6b3b130028eb3ef5b8398fb113cf7335ab3712470

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bg (0.0.3)
+    bg (0.0.4)
       activejob (>= 5.0)
       activerecord (>= 5.0)
       concurrent-ruby (>= 1.0)
@@ -27,39 +27,45 @@ GEM
     arel (7.1.2)
     binding_of_caller (0.7.2)
       debug_inspector (>= 0.0.1)
-    byebug (9.0.6)
     coderay (1.1.1)
     concurrent-ruby (1.0.2)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
     debug_inspector (0.0.2)
+    docile (1.1.5)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
-    interception (0.5)
+    json (1.8.3)
     method_source (0.8.2)
     minitest (5.9.1)
-    os (0.9.6)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (3.4.0)
-      byebug (~> 9.0)
-      pry (~> 0.10)
-    pry-rescue (1.4.4)
-      interception (>= 0.5)
-      pry
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
     pry-stack_explorer (0.4.9.2)
       binding_of_caller (>= 0.7)
       pry (>= 0.9.11)
-    pry-test (0.6.4)
-      os
-      pry
-      pry-byebug
-      pry-rescue
-      pry-stack_explorer
+    purdytest (2.0.0)
+      minitest (~> 5.5)
     rake (11.3.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
     thread_safe (0.3.5)
+    tins (1.6.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
@@ -68,7 +74,11 @@ PLATFORMS
 
 DEPENDENCIES
   bg!
-  pry-test
+  coveralls
+  pry
+  pry-nav
+  pry-stack_explorer
+  purdytest
   rake
 
 BUNDLED WITH

data/README.md

@@ -1,3 +1,10 @@
+[![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/)
+[![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)
+[![Coverage Status](https://img.shields.io/coveralls/hopsoft/bg.svg?style=flat)](https://coveralls.io/r/hopsoft/bg?branch=master)
+[![Downloads](http://img.shields.io/gem/dt/bg.svg?style=flat)](http://rubygems.org/gems/bg)
+
 # Bg
 
 ## Non-blocking ActiveRecord method invocation
@@ -31,12 +38,13 @@ user.defer(queue: :low, wait: 5.minutes).do_hard_work
 
 ## Provisos
 
-Bg leverages [GlobalID](https://github.com/rails/globalid) to marshal ActiveRecord instances across thread & process boundaries.
+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.
 
-* Do not depend on lexically scoped bindings when invoking methods with Bg::Deferrable
-* Do not pass unmarshallable types as arguments with Bg::Deferrable.
-  Follow Sidekiq's [simple parameters](https://github.com/mperham/sidekiq/wiki/Best-Practices#1-make-your-job-parameters-small-and-simple) rule
+* __Do not__ depend on lexically scoped bindings when invoking methods with `Bg::Deferrable`.
+* __Do not__ pass unmarshallable types as arguments with `Bg::Deferrable`.
+  `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.
 
 ### Examples
 

data/Rakefile

@@ -1 +1,12 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["tests/**/test_*.rb"]
+  t.libs.push "test"
+  t.pattern = "test/**/*_test.rb"
+  t.warning = true
+  t.verbose = true
+end
+
+task default: :test

data/lib/bg/deferrable.rb

@@ -10,6 +10,23 @@ module Bg
       end
     end
 
+    def self.make_enqueable(value)
+      case value
+      when ::Hash then
+        value.each.with_object({}) do |(key, val), memo|
+          memo[key.to_s] = make_enqueable(val)
+        end
+      when ::Array then
+        value.map { |val| make_enqueable val }
+      when ::Symbol then
+        value.to_s
+      when ::Date, ::Time, ::DateTime then
+        value.respond_to?(:iso8601) ? value.iso8601 : value.to_s
+      else
+        value
+      end
+    end
+
     attr_reader :object, :queue, :wait
 
     def initialize(object, queue: :default, wait: 0)
@@ -23,11 +40,9 @@ module Bg
       if object.respond_to? name
         raise ::ArgumentError.new("blocks are not supported") if block_given?
         begin
-          if wait > 0
-            job = ::Bg::DeferredMethodCallJob.set(queue: queue, wait: wait).perform_later object, name.to_s, *args
-          else
-            job = ::Bg::DeferredMethodCallJob.set(queue: queue).perform_later object, name.to_s, *args
-          end
+          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}")
         ensure

data/lib/bg/version.rb

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

data/test/backgroundable_object.rb

@@ -0,0 +1,30 @@
+require "globalid"
+
+class Bg::BackgroundableObject
+  include ::GlobalID::Identification
+
+  def self.find(id)
+    new id
+  end
+
+  attr_accessor :id
+
+  def initialize(id)
+    @id = id
+  end
+
+  def update(attrs={})
+    true
+  end
+
+  def wait(seconds=0)
+    sleep seconds.to_i
+    true
+  end
+
+  def eigen
+    class << self
+      self
+    end
+  end
+end

data/test/bg/asyncable_test.rb

@@ -0,0 +1,13 @@
+require_relative "../test_helper"
+
+class Bg::AsyncableTest < ::ActiveSupport::TestCase
+
+  test "slow io bound method invocations run in parallel" do
+    obj = ::Bg::BackgroundableObject.new(:example)
+    obj.eigen.send :include, ::Bg::Asyncable::Behavior
+    start = Time.now
+    10.times { obj.async.wait 1 }
+    assert (Time.now - start) <= 1.1
+  end
+
+end

data/test/bg/deferrable_test.rb

@@ -0,0 +1,79 @@
+require_relative "../test_helper"
+
+class Bg::DeferrableTest < ::ActiveSupport::TestCase
+
+  setup do
+    @deferrable = ::Bg::Deferrable.new(::Bg::BackgroundableObject.new(:example))
+  end
+
+  test ".make_enqueable with Symbol" do
+    value = ::Bg::Deferrable.make_enqueable(:foo)
+    assert value == "foo"
+  end
+
+  test ".make_enqueable with Date" do
+    date = ::Date.today
+    value = ::Bg::Deferrable.make_enqueable(date)
+    assert value == date.iso8601
+  end
+
+  test ".make_enqueable with Time" do
+    time = ::Time.now
+    value = ::Bg::Deferrable.make_enqueable(time)
+    assert value == time.iso8601
+  end
+
+  test ".make_enqueable with DateTime" do
+    date_time = ::DateTime.now
+    value = ::Bg::Deferrable.make_enqueable(date_time)
+    assert value == date_time.iso8601
+  end
+
+  test ".make_enqueable with Array" do
+    date_time = ::DateTime.now
+    list = [:foo, "bar", true, date_time]
+    value = ::Bg::Deferrable.make_enqueable(list)
+    assert value == ["foo", "bar", true, date_time.iso8601]
+  end
+
+  test ".make_enqueable with nested Array" do
+    date_time = ::DateTime.now
+    list = [:foo, "bar", true, date_time]
+    list << list.dup
+    value = ::Bg::Deferrable.make_enqueable(list)
+    expected = ["foo", "bar", true, date_time.iso8601]
+    expected << expected.dup
+    assert value == expected
+  end
+
+  test ".make_enqueable with Hash" do
+    date_time = ::DateTime.now
+    hash = { a: :foo, b: "bar", c: true, d: date_time }
+    value = ::Bg::Deferrable.make_enqueable(hash)
+    assert value == { "a" => "foo", "b" => "bar", "c" => true, "d" => date_time.iso8601 }
+  end
+
+  test ".make_enqueable with nested Hash" do
+    date_time = ::DateTime.now
+    hash = { a: :foo, b: "bar", c: true, d: date_time }
+    hash[:e] = hash.dup
+    value = ::Bg::Deferrable.make_enqueable(hash)
+    expected = { "a" => "foo", "b" => "bar", "c" => true, "d" => date_time.iso8601 }
+    expected["e"] = expected.dup
+    assert value == expected
+  end
+
+  test ".make_enqueable with complex Hash" do
+    time = ::Time.now
+    hash = { a: :foo, b: time, c: { a: :bar, b: time.dup }, d: [:baz, time.dup, {a: :wat, b: time.dup, c: [a: time.dup]}] }
+    value = ::Bg::Deferrable.make_enqueable(hash)
+    expected = {
+      "a" => "foo",
+      "b" => time.iso8601,
+      "c" => { "a" => "bar", "b" => time.iso8601 },
+      "d" => [ "baz", time.iso8601, { "a" => "wat", "b" => time.iso8601, "c" => [{"a" => time.iso8601}] } ]
+    }
+    assert value == expected
+  end
+
+end

data/test/bg/deferred_method_call_test.rb

@@ -0,0 +1,39 @@
+require_relative "../test_helper"
+require "active_job/test_helper"
+
+class Bg::DeferredMethodCallJobTest < ::ActiveJob::TestCase
+
+  test "enqueues with no args" do
+    assert_enqueued_with job: ::Bg::DeferredMethodCallJob do
+      obj = ::Bg::BackgroundableObject.new(:example)
+      obj.eigen.send :include, ::Bg::Deferrable::Behavior
+      obj.defer.update
+    end
+  end
+
+  test "enqueues with simple args" do
+    assert_enqueued_with job: ::Bg::DeferredMethodCallJob do
+      obj = ::Bg::BackgroundableObject.new(:example)
+      obj.eigen.send :include, ::Bg::Deferrable::Behavior
+      obj.defer.update foo: true, bar: "baz"
+    end
+  end
+
+  test "enqueues with globalid args" do
+    assert_enqueued_with job: ::Bg::DeferredMethodCallJob do
+      parent = ::Bg::BackgroundableObject.new(:parent)
+      parent.eigen.send :include, ::Bg::Deferrable::Behavior
+      parent.defer.update child: ::Bg::BackgroundableObject.new(:child)
+    end
+  end
+
+  test "enqueues with complex args" do
+    assert_enqueued_with job: ::Bg::DeferredMethodCallJob do
+      parent = ::Bg::BackgroundableObject.new(:parent)
+      parent.eigen.send :include, ::Bg::Deferrable::Behavior
+      parent.defer.update children: [::Bg::BackgroundableObject.new(:child1), ::Bg::BackgroundableObject.new(:child2)],
+        foo: { bar: [:baz, Date.new, Time.new, DateTime.new] }
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require "coveralls"
+Coveralls.wear!
+require_relative "../lib/bg"
+require_relative "backgroundable_object"
+require "minitest/autorun"
+require "purdytest"
+#require "pry"
+#require "pry-nav"
+#require "pry-stack_explorer"
+
+::ActiveSupport::TestCase.test_order = :random
+::GlobalID.app = "test"
+::ActiveRecord::Base = Class.new do
+  def connection_pool
+    Class.new do
+      def with_connection
+        yield
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,7 +81,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-test
+  name: purdytest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -113,6 +169,11 @@ files:
 - lib/bg/deferrable.rb
 - lib/bg/deferred_method_call_job.rb
 - lib/bg/version.rb
+- test/backgroundable_object.rb
+- test/bg/asyncable_test.rb
+- test/bg/deferrable_test.rb
+- test/bg/deferred_method_call_test.rb
+- test/test_helper.rb
 homepage: https://github.com/hopsoft/bg
 licenses:
 - MIT
@@ -137,4 +198,9 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ''
-test_files: []
+test_files:
+- test/backgroundable_object.rb
+- test/bg/asyncable_test.rb
+- test/bg/deferrable_test.rb
+- test/bg/deferred_method_call_test.rb
+- test/test_helper.rb