background_worker 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e545bf8b33b749d412dcaabec85001174bc787a
-  data.tar.gz: 85b78869946fa35bc82a64d321ee2d49c3497ef6
+  metadata.gz: adc5011226295995d19e4fac5920ec5507921e1b
+  data.tar.gz: 358a861e8f41d6a66ffdebf64d561521cf766608
 SHA512:
-  metadata.gz: 230234c58f0cc42411c99e097832e509cd9085ac70f3170fc66e3f99f046793adfee09bfad01a1fb077ef0c0edac57d516cdbb7f213d6f80764bdd974eb706b3
-  data.tar.gz: e619104b7a7e7824e067be824aa90db4aeb0fd726520dd3898bb179c9c670fb83ddfce726cce6d345191ad97adb964c200ff18b697457cb45292ae894d8f0d59
+  metadata.gz: 56cc930cc991e58352cda3fe9cf687d92dc7d5e1dcc3d8e5c6af088d6aab4b27d36bba7cca9efb7615a501cbf408a6db117ebc49de3d93ea7b2f2c0ffee89c4d
+  data.tar.gz: 8bf4c992d2233f2224c6a2a7595014f628ab9bea24c392bcb6d4207bfd801140ed42c9dd4947fa69c2196647e51d41448cfd6987b44f8081557bf27cd95f55a2

data/.travis.yml

@@ -3,6 +3,13 @@ rvm:
   - 2.2.2
   - 2.3.0
 script: bundle exec rake spec
+gemfile:
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails4_0.gemfile
+  - gemfiles/rails4_1.gemfile
+  - gemfiles/rails4_2.gemfile
+  - gemfiles/rails5_0.gemfile
+  - gemfiles/rails5_1.gemfile
 notifications:
   email:
     - support@travellink.com.au

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This changelog adheres to [Keep a CHANGELOG](http://keepachangelog.com/).
 
 ## Unreleased
 
+## 0.2.1
+### Fixed
+- [RU-123] Worker disconnecting within transactions in rails 4+
+
 ## 0.2.0
 ### Added
 - [RU-79] Release connections after execution for Rails 4

data/Rakefile

@@ -1 +1,12 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+
+desc 'Default: run specs.'
+task :default => :spec
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/background_worker.gemspec

@@ -28,4 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'simplecov-rcov'
   spec.add_development_dependency 'rubocop'
+
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
 end

data/gemfiles/rails3.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 3.2.0'
+end

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 4.0.0'
+end

data/gemfiles/rails4_1.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 4.1.0'
+end

data/gemfiles/rails4_2.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 4.2.0'
+end

data/gemfiles/rails5_0.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 5.0.0'
+end

data/gemfiles/rails5_1.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 5.1.0'
+end

data/lib/background_worker/base.rb

@@ -7,14 +7,12 @@ module BackgroundWorker
     attr_accessor :uid, :state
 
     def initialize(options = {})
-      Time.zone = Setting.time_zone
-
       @uid = options[:uid]
 
       # Store state persistently, to enable status checkups & progress reporting
       @state = BackgroundWorker::PersistentState.new(@uid, options.except(:uid))
       log("Created #{self.class}")
-      log("Options are: #{options.pretty_inspect}")
+      log("Options are: #{options.inspect}")
     end
 
     # Report progress...
@@ -79,13 +77,13 @@ module BackgroundWorker
       #
       # It will just call your preferred method in the worker.
       def perform(method_name, options = {})
-        BackgroundWorker.verify_active_connections!
+        BackgroundWorker.verify_active_connections! if BackgroundWorker.config.backgrounded
 
         worker = new(options)
         execution = WorkerExecution.new(worker, method_name, options)
         execution.call
       ensure
-        BackgroundWorker.release_connections!
+        BackgroundWorker.release_connections! if BackgroundWorker.config.backgrounded
       end
     end
   end

data/lib/background_worker/config.rb

@@ -2,7 +2,7 @@ require 'logger'
 
 module BackgroundWorker
   class Config
-    attr_reader :logger, :enqueue_with
+    attr_reader :logger, :enqueue_with, :backgrounded
 
     # Configuration includes following options:
     #   logger: what logger to user throughout
@@ -19,6 +19,7 @@ module BackgroundWorker
       @logger = attrs.fetch(:logger, ::Logger.new(STDOUT))
       @enqueue_with = attrs.fetch(:enqueue_with, method(:foreground_enqueue))
       @after_exception = attrs.fetch(:after_exception, method(:default_after_exception))
+      @backgrounded = attrs.fetch(:backgrounded, true)
     end
 
     # Callback fired when an exception occurs

data/lib/background_worker/version.rb

@@ -1,3 +1,3 @@
 module BackgroundWorker
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/base_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+require 'active_support/core_ext/hash/keys' # Hash.symbolize_keys
+require 'active_support/core_ext/numeric/time' # Numeric.hours
+
+require 'active_record'
+
+DB_FILE = 'tmp/test_db'
+FileUtils.mkdir_p File.dirname(DB_FILE)
+FileUtils.rm_f DB_FILE
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => DB_FILE
+
+load('spec/schema.rb')
+
+describe BackgroundWorker::Base do
+  let(:cache) { double(write: nil, read: nil, reconnect: nil, store: nil) }
+  let(:model_class) { Model = Class.new(ActiveRecord::Base) }
+  let(:worker_class) {
+    Class.new(BackgroundWorker::Base) do
+      def store_in_cache(opts)
+        Rails.cache.store(opts[:value])
+      end
+    end
+  }
+
+  before do
+    stub_const 'Model', model_class
+    stub_const 'Rails', double(cache: cache, env: 'production')
+    BackgroundWorker.configure(backgrounded: false)
+  end
+
+  it 'should perform action and handle transactions/connections appropriately' do
+    Model.transaction do
+      worker_class.perform_in_background(:store_in_cache, value: 42)
+    end
+    expect(cache).to have_received(:store).with(42)
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :models do |t|
+    t.string :name
+  end
+end

data/spec/support/coverage_loader.rb

@@ -1,4 +1,4 @@
 require 'simplecov-rcov'
 require 'coveralls'
 require 'coverage/kit'
-Coverage::Kit.setup(minimum_coverage: 47.5)
+Coverage::Kit.setup(minimum_coverage: 82.1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: background_worker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Michael Noack
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -124,6 +124,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: sqlite3
+  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'
 description: See README for full details
 email:
 - development@travellink.com.au
@@ -142,6 +170,12 @@ files:
 - README.md
 - Rakefile
 - background_worker.gemspec
+- gemfiles/rails3.gemfile
+- gemfiles/rails4_0.gemfile
+- gemfiles/rails4_1.gemfile
+- gemfiles/rails4_2.gemfile
+- gemfiles/rails5_0.gemfile
+- gemfiles/rails5_1.gemfile
 - lib/background_worker.rb
 - lib/background_worker/base.rb
 - lib/background_worker/config.rb
@@ -149,6 +183,8 @@ files:
 - lib/background_worker/uid.rb
 - lib/background_worker/version.rb
 - lib/background_worker/worker_execution.rb
+- spec/base_spec.rb
+- spec/schema.rb
 - spec/spec_helper.rb
 - spec/support/coverage_loader.rb
 - spec/uid_spec.rb
@@ -177,6 +213,8 @@ signing_key:
 specification_version: 4
 summary: Background worker abstraction with status updates
 test_files:
+- spec/base_spec.rb
+- spec/schema.rb
 - spec/spec_helper.rb
 - spec/support/coverage_loader.rb
 - spec/uid_spec.rb