bg 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c84b2acf5bc22423b5a47b7705fd9f20022fab38
-  data.tar.gz: 087b132f0f6ad791d32608192b7d8676325649e5
+  metadata.gz: 701fc3678ec92e6f30a6df96f361b447c4e9a73b
+  data.tar.gz: f882ff93d30fe5c0e77c7e3e585933b28015fa82
 SHA512:
-  metadata.gz: ee2a7e4363d06db876253b5383514c82e66b82582a73db39c95d8edd9fd7d2042c7ce080a2d47bd5ab47618f001954aa9d2d2afe21ee1cfa79eb49a3df5ccf7e
-  data.tar.gz: 993822472d6d798aa60acbcfb79bbaf0c814663ed72ab4fae54f48bbfd01c8ccd53c7341b54263e8d7c605cc71344b6c7b79ebf6db1498b3413b63e5ddbd1505
+  metadata.gz: 9bbbc79e1998a606803a4ce94d2e9213561ff6576998a67c5fc72a700c165ea854a9b2cf6ab1407c324a9c59ca4f57f289314d802d051dd9a82e44668903ad8c
+  data.tar.gz: dc287ca50eb890ddb1b0a827300d5f0b1d634000af02500de4e308060e340484954d412c91aa7ee389abc94168bbf65724c1deb374de83095cee4de7ad92120c

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in bg.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    bg (0.0.2)
+      activejob (>= 5.0)
+      activerecord (>= 5.0)
+      concurrent-ruby (>= 1.0)
+      globalid (>= 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    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)
+    debug_inspector (0.0.2)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    interception (0.5)
+    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-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
+    rake (11.3.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bg!
+  pry-test
+  rake
+
+BUNDLED WITH
+   1.13.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Nathan Hopkins
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Bg
+
+## Non-blocking ActiveRecord method invocation
+
+This library allows you to invoke ActiveRecord instance methods in the background.
+
+* `Bg::Asyncable` uses concurrent-ruby to execute methods in a different thread
+* `Bg::Deferrable` uses ActiveJob to execute methods in a background process
+
+
+## Quickstart
+
+### Setup
+
+```ruby
+class User < ApplicationRecord
+  include Bg::Asyncable  # uses concurrent-ruby
+  include Bg::Deferrable # uses ActiveJob
+end
+```
+
+### Usage
+
+```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
+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.
+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
+
+### Examples
+
+#### Good
+
+```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"
+```
+
+#### Bad
+
+```ruby
+user = User.find(params[:id])
+user.name = "new value" # in memory changes will not be available in Bg invoked methods
+
+user.async.do_hard_work do
+  # this is dangerous... you better know what you're doing
+  # best to avoid
+end
+
+user.defer.do_hard_work :foo, Time.now # args won't marshal properly
+
+user.defer.do_hard_work do
+  # blocks are not supported
+end
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bg"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bg/asyncable.rb

@@ -0,0 +1,62 @@
+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)
+        # 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
+      end
+
+      def invoke_method(name, *args)
+        sleep delay if delay > 0
+        ::ActiveRecord::Base.connection_pool.with_connection do
+          global_id.find.send name, *args
+        end
+      end
+    end
+
+    module Behavior
+      def async(delay: 0)
+        ::Bg::Asyncable.new(self, delay: delay.to_f)
+      end
+    end
+
+    attr_reader :object, :delay
+
+    def initialize(object, delay: 0)
+      raise ::ArgumentError unless object.is_a?(::GlobalID::Identification)
+      super()
+      @object = object
+      @delay = delay.to_f
+    end
+
+    def method_missing(name, *args)
+      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.async.invoke_method name, *args
+        rescue ::StandardError => e
+          raise ::ArgumentError.new("Failed to execute method asynchronously! <#{object.class.name}##{name}> #{e.message}")
+        ensure
+          return
+        end
+      end
+      super
+    end
+
+    def respond_to?(name)
+      return true if object.respond_to? name
+      super
+    end
+  end
+end

data/lib/bg/deferrable.rb

@@ -0,0 +1,45 @@
+require "globalid"
+require "bg/deferred_method_call_job"
+
+module Bg
+  class Deferrable
+    module Behavior
+      # Enqueues the method call to be executed by a DeferredMethodCallJob background worker.
+      def defer(queue: :default, wait: 0)
+        ::Bg::Deferrable.new self, queue: queue, wait: wait
+      end
+    end
+
+    attr_reader :object, :queue, :wait
+
+    def initialize(object, queue: :default, wait: 0)
+      raise ::ArgumentError unless object.is_a?(::GlobalID::Identification)
+      @object = object
+      @queue  = queue || :default
+      @wait   = wait.to_i
+    end
+
+    def method_missing(name, *args)
+      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
+        rescue ::StandardError => e
+          raise ::ArgumentError.new("Failed to background method call! <#{object.class.name}##{name}> #{e.message}")
+        ensure
+          return job
+        end
+      end
+      super
+    end
+
+    def respond_to?(name)
+      return true if object.respond_to? name
+      super
+    end
+  end
+end

data/lib/bg/deferred_method_call_job.rb

@@ -0,0 +1,11 @@
+require "active_job"
+
+module Bg
+  class DeferredMethodCallJob < ::ActiveJob::Base
+    queue_as :default
+
+    def perform(object, method, *args)
+      object.send method, *args
+    end
+  end
+end

data/lib/bg/version.rb

@@ -1,3 +1,3 @@
 module Bg
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/bg.rb

@@ -1,13 +1,6 @@
 require "bg/version"
-require "bg/runner"
+require "bg/asyncable"
+require "bg/deferrable"
 
 module Bg
-  class << self
-    attr_accessor :logfile
-
-    def run(*args, &block)
-      Runner.new(logfile: logfile).run(*args, &block)
-    end
-
-  end
 end

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: bg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2016-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: os
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: method_source
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,31 +81,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: micro_test
+  name: pry-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
-description: Easily run code in a separate background process.
+        version: '0'
+description: 
 email:
 - natehop@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/bg.rb
-- lib/bg/drb_runner.rb
-- lib/bg/runner.rb
+- lib/bg/asyncable.rb
+- lib/bg/deferrable.rb
+- lib/bg/deferred_method_call_job.rb
 - lib/bg/version.rb
-- test/runner_test.rb
 homepage: https://github.com/hopsoft/bg
 licenses:
 - MIT
@@ -126,9 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Easily run code in a separate background process.
-test_files:
-- test/runner_test.rb
+summary: ''
+test_files: []

data/lib/bg/drb_runner.rb

@@ -1,36 +0,0 @@
-require "thread"
-require "drb"
-require "logger"
-
-module Bg
-  class DrbRunner
-    attr_reader :logger
-
-    def initialize(logfile: logfile)
-      @logger = Logger.new(logfile || "/dev/null")
-    end
-
-    def ready?
-      true
-    end
-
-    def run(proc: nil, args: [])
-      Thread.new do
-        begin
-          sleep 0
-          method = "define_method :run #{proc}"
-          runner = Class.new { eval method }
-          logger.info "Start exec: #{method}"
-          runner.new.run(*Marshal.load(args))
-          logger.info "Finish exec: #{method}"
-        rescue Exception => e
-          logger.error "Failed exec: #{method}\n#{e}"
-        ensure
-          DRb.stop_service rescue nil
-          Process.exit
-        end
-      end
-    end
-
-  end
-end

data/lib/bg/runner.rb

@@ -1,62 +0,0 @@
-require "method_source"
-require "thread"
-require "drb"
-require "bg/drb_runner"
-
-module Bg
-  class Runner
-    attr_reader :logfile, :drb_uri, :drb_pid, :drb_runner
-
-    def initialize(logfile: nil)
-      @logfile = logfile
-      @drb_uri = "druby://127.0.0.1:#{random_port}"
-    end
-
-    def run(*args, &block)
-      DRb.start_service
-      start_drb_runner
-      drb_runner.run(
-        proc: proc_string(block),
-        args: Marshal.dump(args)
-      )
-      DRb.stop_service
-    end
-
-    private
-
-    def proc_string(proc)
-      code = proc.source
-      index = code.index(/\{|do/)
-      code[index..-1].strip
-    end
-
-    def start_drb_runner
-      return if drb_runner
-      @drb_pid = fork do
-        DRb.start_service drb_uri, DrbRunner.new(logfile: logfile)
-        DRb.thread.join
-      end
-      Process.detach drb_pid
-      @drb_runner = DRbObject.new_with_uri(drb_uri)
-      sleep 0.001 while !drb_runner_ready?
-      drb_runner
-    end
-
-    def drb_runner_ready?
-      begin
-        drb_runner.ready?
-      rescue DRb::DRbConnError
-        false
-      end
-    end
-
-    def random_port
-     socket = Socket.new(:INET, :STREAM, 0)
-     socket.bind(Addrinfo.tcp("127.0.0.1", 0))
-     port = socket.local_address.ip_port
-     socket.close
-     port
-    end
-
-  end
-end

data/test/runner_test.rb

@@ -1,21 +0,0 @@
-require "micro_test"
-require "pry"
-require_relative "../lib/bg"
-
-module Bg
-  class RunnerTest < MicroTest::Test
-
-    before do
-      Bg.logfile = File.expand_path("../../log/test.log", __FILE__)
-    end
-
-    test "3 sleeps" do
-      Bg.run 1, 2, 3 do |a, b, c|
-        sleep a
-        sleep b
-        sleep c
-      end
-    end
-
-  end
-end