background_worker 0.0.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fcc18679c11c98ef7f0da1d7d5112004edd1bfb4
-  data.tar.gz: 3d4cacb66997222274d85dde11e5787c3fad9ffb
+SHA256:
+  metadata.gz: 6e2f1d5ad9dc6f2f79dfcd55838f8b7d9ded9c7518fc77f90ecea89fe537539c
+  data.tar.gz: 1e05a4e548ebdfea30e6bcf9ecc20dd7aaa3edc75966a2433f1f8ca016eb879c
 SHA512:
-  metadata.gz: 37680e16cc121d912e38df598045df83c3e8e3fce5dedb168830932ac1e126d3de8fbfdb34860f0806c4999f26f4a891a7589310adfb323a7810aa4e4cab5553
-  data.tar.gz: 4002280277529ea9af57c9714d19f1649a920719501e06eb1c9c63c521a295ce4acbb980dc652509f7cd9b10d7257e4725cba829bbb484275c8b17a6eb526967
+  metadata.gz: c98bc9599be6db3a4a5f5dd6b8dc699a9209dcf6889553ae786ee7c780198d4af3c37198fdf486477f5a150288c1ab818632eeefb655bf7453c5372806ba4871
+  data.tar.gz: 19d317689204f81a81f782c6a8697087c13d5616341abd6258a0284249804fd216c389cf07e738993b522ec1346c517224a040531a574428233e0170502eb506

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "vendor"

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec rake
+
+  release:
+    needs: build
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Generate Changelog
+        run: |
+          # Get version from github ref (remove 'refs/tags/' and prefix 'v')
+          version="${GITHUB_REF#refs/tags/v}"
+          npx changelog-parser CHANGELOG.md | jq -cr ".versions | .[] | select(.version == \"$version\") | .body" > ${{ github.workflow }}-CHANGELOG.txt
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: ${{ github.workflow }}-CHANGELOG.txt
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: [build, release]
+    name: Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,19 @@
+name: Build and Test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: [rails60, rails61]
+        ruby: ["2.6", "2.7", "3.0"]
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+coverage
+vendor
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Change Log
+All notable changes to this project will be documented in this file.  
+This project adheres to [Semantic Versioning](http://semver.org/).  
+This changelog adheres to [Keep a CHANGELOG](http://keepachangelog.com/).  
+
+## 0.4.0
+
+- [TT-8623] Update to build with github actions / ruby 3.0 / rails 6.1
+
+## 0.3.0
+
+- [TT-6292] Support Rails 5.2 built-in redis cache, remove legacy supports
+
+## 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
+
+## 0.1.0
+### Added
+- [TT-1392] Changelog file
+- [TT-2141] Only verify connections for Rails 3

data/README.md

@@ -1,10 +1,13 @@
-Background Worker
-=================
+# Background Worker
+
+[![Gem Version](https://badge.fury.io/rb/background_worker.svg)](http://badge.fury.io/rb/background_worker)
+[![Build Status](https://github.com/sealink/background_worker/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/sealink/background_worker/actions)
 
 Provides a worker abstraction with an additional status channel.
 
 Start by making a worker class which extends from BackgroundWorker::Base
 
+```ruby
     class MyWorker < BackgroundWorker::Base
       def my_task(options={})
         report_progress('Starting')
@@ -17,48 +20,69 @@ Start by making a worker class which extends from BackgroundWorker::Base
         {original_message: message}
       end
     end
+```
 
 Then, when you want to perform a task in the background, use
 klass#perform_in_background which exists in Base:
 
-   worker_id = MyWorker.perform_in_background(:my_task, message: "hello!")
+```ruby
+    worker_id = MyWorker.perform_in_background(:my_task, message: "hello!")
+```
 
 # Backgrounded
 
 By default this will call your instance method in the foreground -- you have to
 provide an #enqueue_with configuration like so:
 
+```ruby
     BackgroundWorker.configure(
       enqueue_with: -> klass, method_name, options {
         Resque.enqueue(klass, method_name, options)
       }
     )
+```
 
 This is independent of the status reporting which (currently) always uses Redis.
 
 # Getting the status
 
-The worker_id you are returned can be used to get the status, and
-whether the worker has finished successfully, failed, or in progress:
+The worker_id you are returned can be used to get the status and
+whether the worker has finished successfully, failed, or is still in progress:
 
+```ruby
     state = BackgroundWorker.get_state_of(worker_id)
+```
 
 The state is represented by a hash with the following keys:
 
-    message: Reported message
-    detailed_message: Detailed version of above when provided
-    status: :successful, :failed, or null if still processing
-    completed: True if report_failed, report_successful called (or worker
-               finished without exception -- which calls report_successful)
-    data: Arbitrary data returned by worker method on success or report_failed
+| key                                                          | description                                                          |
+| ------------------------------------------------------------ | -------------------------------------------------------------------- |
+| message                                                      | Reported message                                                     |
+| detailed_message                                             | Detailed version of above when provided                              |
+| status                                                       | :successful, :failed, or null if still processing                    |
+| completed                                                    | True if report_failed, report_successful called (or worker           |
+| finished without exception -- which calls report_successful) |
+| data                                                         | Arbitrary data returned by worker method on success or report_failed |
 
 If an exception is raised, the worker will call #report_failed with the
-details. You can provide a callback with #after_exception in the config
+details. You can provide a callback with #after_exception in the config.
+
+# Installation
+
+Add to your Gemfile:
 
-# INSTALLATION
+```ruby
+    gem 'background_worker'
+```
 
-gem install background_worker
+# Release
 
-or add to your Gemfile:
-gem 'background_worker'
+To publish a new version of this gem the following steps must be taken.
 
+- Update the version in the following files
+  ```
+    CHANGELOG.md
+    lib/background_worker/version.rb
+  ```
+- Create a tag using the format v0.1.0
+- Follow build progress in GitHub actions

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

@@ -19,8 +19,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6'
 
+  spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coverage-kit'
+  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/rails60.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec path: '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 6.0'
+end

data/gemfiles/rails61.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec path: '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 6.1'
+end

data/lib/background_worker.rb

@@ -24,8 +24,14 @@ module BackgroundWorker
   end
 
   def self.verify_active_connections!
-    Rails.cache.reconnect if defined?(Rails)
-    ActiveRecord::Base.verify_active_connections! if defined?(ActiveRecord)
+    if defined?(Rails)
+      Rails.cache.reconnect if Rails.cache.respond_to?(:reconnect)
+      Rails.cache.redis.close if Rails.cache.respond_to?(:redis)
+    end
+  end
+
+  def self.release_connections!
+    ActiveRecord::Base.clear_all_connections!
   end
 
   def self.after_exception(e)

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,11 +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! 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.0.5'
+  VERSION = '0.4.0'
 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/spec_helper.rb

@@ -0,0 +1,14 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler/setup'
+require 'active_support/core_ext/string/inflections' #underscore
+
+require 'support/coverage_loader'
+
+require 'background_worker'

data/spec/support/coverage_loader.rb

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

data/spec/uid_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe BackgroundWorker::Uid do
+  let(:class_name) { 'CopyWorker' }
+  let(:method) { 'make_copy' }
+  let(:uid_object) { BackgroundWorker::Uid.new(class_name, method) }
+
+  context '#generate' do
+    subject(:uid) { uid_object.generate }
+    it { is_expected.to match(/copy_worker:make_copy:[0-9a-f]{16}/) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: background_worker
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Noack
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +54,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: coverage-kit
+  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: simplecov-rcov
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -54,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
@@ -63,12 +161,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - background_worker.gemspec
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
 - lib/background_worker.rb
 - lib/background_worker/base.rb
 - lib/background_worker/config.rb
@@ -76,6 +183,11 @@ 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
 homepage: http://github.com/sealink/background_worker
 licenses:
 - MIT
@@ -88,16 +200,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Background worker abstraction with status updates
-test_files: []
+test_files:
+- spec/base_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/coverage_loader.rb
+- spec/uid_spec.rb