sucker_punch-backgroundable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGYyZWEyZWM0ZWJhMTFlNmI5MTFmZjRjOWQxYzk5NmY5ZDc2NTMwYQ==
+    YTljNmMwNGMyOTc0MjlhZGM0NTg3NDRhMmNlODlkYWI3NmFmM2Y4NQ==
   data.tar.gz: !binary |-
-    YjgyMzgyYTZlNzAzMWQwZTgzZjgwNTc4ZjRlMGJkNzcyODFjZTkwZA==
+    ODY2NTNhMjNjNDFjYjgwNzQ0ZDY1ZTgyNTkzNWViNTEyNTQwNGJmZQ==
 SHA512:
   metadata.gz: !binary |-
-    NTAyYzMxZDQxYmFkMzk2NzMwODFiYmI5NmMxYWZlYmU0OWVlNDZmOTQ5Njcz
-    MDkxZmFjOThjNjNjMDMwNmUyOWU1N2Y5YTY2Mzk0ZTMyZGY3YWI4ODJmMjM2
-    ZDVmNDk1NzBlMzliNzkxZGRkOTQwMmY1YThiOWI5ODBjMjZiYzU=
+    NjIxM2QzN2Y2YWY2NzQ5YjM1Mzk1NjZhYjZlODU1MjA4YzBlMzJiYzUyMWQw
+    ZGY3MWYxNGQwMjIyNzZhMDVhMjcwMWJlOWZkNDZlYTUyZjMzZTUzY2RlNGY5
+    NDhmNzZkOWM0MmU4OWI3NTVlZmY3Y2RlM2EwNjZhYzBjNzFkYzM=
   data.tar.gz: !binary |-
-    ZTY0M2Q3MGMxMTJkZTY4ODQ3ZDc4N2M2NjE0YzNkZGQ4YTcyYzZlNjU3NTRm
-    MjdiOTBhMGE5ZDNlMDhkY2M4ZjYwMWEzYTliYzU5ZGMwYmNjODEwNzdkY2Uy
-    NmFiNzAyMGE2ZDRiNmNiNTE3NWZiNjZlOWUxZjQ2MDg3MzIzOWY=
+    ODk5OTRkMzZhYmM0MDhlYzVhNjY0ZWM3MTA1ZjkzNzRjMmYzMDNlNzJiNDlm
+    YWNhMWM1MmZlZjk5YTRlMzQ2MTFkYmNkM2RkNmU1MDFmZGRhMGNkOGU4NTY3
+    ZmIzODk2NzIzZmVmMDY2YzU2YjQ1NjE1MDU3NjQyODJhYThkODU=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
-## 0.0.1 (19/5/2014)
+## 0.2.0 (20/5/2014)
+
+* Added 'enabled' configuration option
+
+## 0.1.0 (19/5/2014)
 
 * First Release

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
-gem "sucker_punch", ">= 1.0.0"
+gem "sucker_punch", "~> 1.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -98,4 +98,4 @@ DEPENDENCIES
   rspec (~> 2.8.0)
   simplecov
   sqlite3
-  sucker_punch (>= 1.0.0)
+  sucker_punch (~> 1.0)

data/README.md

@@ -114,17 +114,21 @@ end
 
 ## Configuration
 
-Apart from the `reload` option described above, there is only one other configuration setting:
+Apart from the `reload` option described above, there is two other configuration settings:
 
 ```ruby
 SuckerPunch::Backgroundable.configure do |config|
   config.reload = true
   config.workers = 4   # default is 2
+  config.enabled = true
 end
 ```
 
 The number of workers sets the number of background threads that SuckerPunch will use. The default (and minimum) is 2.
 
+By setting enabled to false, backgrounding is globally disabled, so all methods will be executed synchronously. This
+can be useful in tests.
+
 ## Usage with ActiveRecord
 
 When using this gem with ActiveRecord models, it is recommended to set the `reload` option to true (see above).
@@ -134,6 +138,24 @@ If you want sucker_punch-backgroundable to be available in all models you can  u
 ActiveRecord::Base.send(:include, SuckerPunch::Backgroundable)
 ```
 
+## Switching from TorqueBox Backgroundable
+
+This gem is completely independent from TorqueBox (or JRuby). But if you are already using TorqueBox Backgroundable, you can switch
+to backgrounding with SuckerPunch by a simple change in an initializer:
+
+```ruby
+# In config/initializers/active_record_backgroundable.rb, replace
+if defined?(TorqueBox::Messaging::Backgroundable) && defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, TorqueBox::Messaging::Backgroundable)
+end
+
+# by this:
+ActiveRecord::Base.send(:include, SuckerPunch::Backgroundable)
+```
+
+Switching from TorqueBox Backgroundable to SuckerPunch will save you RAM (since TorqueBox uses a separate application instance
+for Backgroundable), but remember that SuckerPunch jobs are not persisted, so you might lose jobs on a server restart.
+
 ## Contributing to sucker_punch-backgroundable
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/sucker_punch/backgroundable/backgroundable.rb

@@ -110,7 +110,8 @@ module SuckerPunch
         (singleton_method ? singleton : self).class_eval do
           define_method async_method do |*args|
             # run sucker punch job asynchronously
-            Job.new.async.perform(self, sync_method, args, options)
+#            Job.new.async.perform(self, sync_method, args, options)
+            JobRunner.new(self, sync_method, args, options).run
           end
         end
         
@@ -142,11 +143,7 @@ module SuckerPunch
       def method_missing(method, *args, &block)
         @receiver.method_missing(method, *args, &block) unless @receiver.respond_to?(method)
         raise ArgumentError.new("Backgrounding a method with a block argument is not supported.") if block_given?
-        if @seconds > 0
-          Job.new.async.later(@seconds, @receiver, method, args, @options)
-        else
-          Job.new.async.perform(@receiver, method, args, @options)
-        end
+        JobRunner.new(@receiver, method, args, @options).run(@seconds)
       end
     end
     

data/lib/sucker_punch/backgroundable/config.rb

@@ -11,10 +11,12 @@ module SuckerPunch
     end
   
     class Configuration
+      attr_accessor :enabled
       attr_accessor :workers
       attr_accessor :reload
   
       def initialize
+        @enabled = true
         @workers = 2
         @reload = false
       end

data/lib/sucker_punch/backgroundable/job.rb

@@ -1,35 +1,69 @@
 module SuckerPunch
   module Backgroundable
 
+    module CallMethod
+      private
+      
+        def instantiate?(options)
+          return true if SuckerPunch::Backgroundable.configuration.reload && !(!options[:reload].nil? && options[:reload] == false)
+          options[:reload]
+        end
+        
+        def load(receiver)
+          receiver.respond_to?(:id) ? receiver.class.find(receiver.id) : receiver
+        end
+        
+        def call(receiver, method, *args)
+          if defined?(ActiveRecord)
+            begin
+              ActiveRecord::Base.connection_pool.with_connection do
+                receiver.send(method, *args)
+              end
+            ensure
+              ActiveRecord::Base.connection_handler.clear_active_connections!
+            end
+          else
+            receiver.send(method, *args)
+          end
+        end
+    end
+    
     class Job
       include SuckerPunch::Job
       workers SuckerPunch::Backgroundable.configuration.workers
+      include CallMethod
     
       def perform(receiver, method, args, options)
         receiver = load(receiver) if instantiate?(options)
-        if defined?(ActiveRecord)
-          ActiveRecord::Base.connection_pool.with_connection do
-            receiver.send(method, *args)
-          end
-        else
-          receiver.send(method, *args)
-        end
+        call(receiver, method, *args)
       end
     
       def later(sec, *args)
         after(sec) { perform(*args) }
       end
+    end
+    
+    class JobRunner
+      include CallMethod
       
-      private
+      def initialize(receiver, method, args, options)
+        @receiver, @method, @args, @options = receiver, method, args, options
+      end
       
-        def instantiate?(options)
-          return true if SuckerPunch::Backgroundable.configuration.reload && !(!options[:reload].nil? && options[:reload] == false)
-          options[:reload]
-        end
-        
-        def load(receiver)
-          receiver.respond_to?(:id) ? receiver.class.find(receiver.id) : receiver
+      def run(seconds = 0)
+        if SuckerPunch::Backgroundable.configuration.enabled
+          # run as SuckerPunch Job
+          if seconds > 0
+            Job.new.async.later(seconds, @receiver, @method, @args, @options)
+          else
+            Job.new.async.perform(@receiver, @method, @args, @options)
+          end
+        else
+          # run without SuckerPunch or Celluloid
+          @receiver = load(@receiver) if instantiate?(@options)
+          call(@receiver, @method, *@args)
         end
+      end
     end
 
   end

data/spec/sucker_punch-backgroundable_spec.rb

@@ -28,7 +28,7 @@ describe "sucker_punch-backgroundable" do
       check_queue(200, 2.2)
     end
 
-    it "allows running instance methods with a specified delay, even when they are declared as :always_bacground" do
+    it "allows running instance methods with a specified delay, even when they are declared as :always_background" do
       @obj.later(2).always1 # run after 2 seconds
       check_queue(1, 2.2)
     end
@@ -86,7 +86,7 @@ describe "sucker_punch-backgroundable" do
     TestClass.queue.length.should eq(1)
     TestClass.queue.pop.should eq(value)
   end
-
+  
   context 'reloading' do
     before do
       require File.expand_path(File.dirname(__FILE__) + '/load_active_record')
@@ -123,10 +123,19 @@ describe "sucker_punch-backgroundable" do
     end
 
     context 'global reload option' do
-      it "honors when global reload is set to true" do
+      before do
         SuckerPunch::Backgroundable.configure do |config|
           config.reload = true
         end
+      end
+      
+      after do
+        SuckerPunch::Backgroundable.configure do |config|
+          config.reload = false
+        end
+      end
+      
+      it "honors when global reload is set to true" do
         @model.later(0.4).copy_value
         @model.value += 1 # change object
         sleep(0.5)
@@ -134,9 +143,6 @@ describe "sucker_punch-backgroundable" do
       end
 
       it "honors :reload => false even when when global reload is set to true" do
-        SuckerPunch::Backgroundable.configure do |config|
-          config.reload = true
-        end
         @model.later(0.4, :reload => false).copy_value
         @model.value += 1 # change object
         sleep(0.5)
@@ -144,9 +150,6 @@ describe "sucker_punch-backgroundable" do
       end
 
       it "ignores :reload for class methods" do
-        SuckerPunch::Backgroundable.configure do |config|
-          config.reload = true
-        end
         TestModel.class_always
         sleep(0.5)
         TestModel.queue.pop.should eq(7)
@@ -155,4 +158,41 @@ describe "sucker_punch-backgroundable" do
     end
   end
   
+  context 'enable / disable' do
+    before do
+      SuckerPunch::Backgroundable.configure do |config|
+        config.enabled = false
+      end
+      @obj = TestClass.new
+      TestClass.clear
+    end
+
+    it "respects enabled => false for methods marked as :always_background" do
+      @obj.always1
+      TestClass.queue.length.should eq(1)
+      TestClass.queue.pop.should eq(1)
+    end
+    
+    it "respects enabled => false for calls to 'background'" do
+      @obj.background.normal(6)
+      TestClass.queue.length.should eq(1)
+      TestClass.queue.pop.should eq(6)
+    end
+
+    it "respects enabled => false for calls to 'later'" do
+      @obj.later(10).normal(6)
+      TestClass.queue.length.should eq(1)
+      TestClass.queue.pop.should eq(6)
+    end
+
+    it "respects enabled => false for methods marked as :always_background (with reloading)" do
+      require File.expand_path(File.dirname(__FILE__) + '/load_active_record')
+      require File.expand_path(File.dirname(__FILE__) + '/test_model')
+      @model = TestModel.create(:value => 5)
+      @model.copy_value_in_background
+      TestModel.queue.pop.should eq(5)
+    end
+    
+  end
+
 end

data/sucker_punch-backgroundable.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: sucker_punch-backgroundable 0.2.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "sucker_punch-backgroundable"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Micha\u{eb}l Van Damme"]
+  s.date = "2014-05-20"
+  s.description = "This gem allows you to background any method call without having to write a special job class. Heavily inspired by the Backgroundable module in TorqueBox."
+  s.email = "michael.vandamme@vub.ac.be"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis",
+    "CHANGELOG.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/sucker_punch-backgroundable.rb",
+    "lib/sucker_punch/backgroundable/backgroundable.rb",
+    "lib/sucker_punch/backgroundable/config.rb",
+    "lib/sucker_punch/backgroundable/job.rb",
+    "lib/sucker_punch/backgroundable/util.rb",
+    "spec/load_active_record.rb",
+    "spec/spec_helper.rb",
+    "spec/sucker_punch-backgroundable_spec.rb",
+    "spec/test_class.rb",
+    "spec/test_model.rb",
+    "sucker_punch-backgroundable.gemspec"
+  ]
+  s.homepage = "http://github.com/mvdamme/sucker_punch-backgroundable"
+  s.licenses = ["LGPL-3"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Easily execute an object's methods in the background with sucker_punch"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sucker_punch>, ["~> 1.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+    else
+      s.add_dependency(%q<sucker_punch>, ["~> 1.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sucker_punch>, ["~> 1.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+  end
+end
+

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch-backgroundable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michaël Van Damme
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +151,7 @@ files:
 - spec/sucker_punch-backgroundable_spec.rb
 - spec/test_class.rb
 - spec/test_model.rb
+- sucker_punch-backgroundable.gemspec
 homepage: http://github.com/mvdamme/sucker_punch-backgroundable
 licenses:
 - LGPL-3