background_worker 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e545bf8b33b749d412dcaabec85001174bc787a
-  data.tar.gz: 85b78869946fa35bc82a64d321ee2d49c3497ef6
+SHA256:
+  metadata.gz: 851e96fbed1359db54547088ea0be4bb7a6c145169b61b82b42ab7e4a2825498
+  data.tar.gz: 608ed8a043ff96f7104262ad5d38691b8c27ce947060708a960fa85280351d6d
 SHA512:
-  metadata.gz: 230234c58f0cc42411c99e097832e509cd9085ac70f3170fc66e3f99f046793adfee09bfad01a1fb077ef0c0edac57d516cdbb7f213d6f80764bdd974eb706b3
-  data.tar.gz: e619104b7a7e7824e067be824aa90db4aeb0fd726520dd3898bb179c9c670fb83ddfce726cce6d345191ad97adb964c200ff18b697457cb45292ae894d8f0d59
+  metadata.gz: e3c702150edadf96f131e54a8f95477a28fd79ded9387d4df29e59cb8a5101f334bb7945440b7fe56f149ab661f0d847d7c0b4d488d182930c4781aa51f36831
+  data.tar.gz: 44212955d5f1410e42b69a7344f8eb8079e0cacf184b6ed5030ce03a5da2c21cfc4f2a158fba0e8cd5110fb39b67df487b6ac1db386e437b4ca1231dcd4c91e6

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,24 @@
+name: Build and Test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: [rails60, rails61, rails70]
+        ruby: ["2.7", "3.0", "3.1"]
+    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
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: coverage/lcov.info

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/CHANGELOG.md

@@ -3,7 +3,21 @@ 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/).  
 
-## Unreleased
+## 0.5.0
+
+- [PLAT-183] Ruby 3.1, Rails 7.0 and push coverage with github action
+
+## 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

data/README.md

@@ -1,10 +1,14 @@
-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)
+[![Coverage Status](https://coveralls.io/repos/sealink/background_worker/badge.png)](https://coveralls.io/r/sealink/background_worker)
 
 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,22 +21,27 @@ 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:
 
+```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.
 
@@ -41,23 +50,40 @@ This is independent of the status reporting which (currently) always uses Redis.
 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.
 
-# INSTALLATION
+# Installation
 
 Add to your Gemfile:
 
+```ruby
     gem 'background_worker'
+```
+
+# Release
+
+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,13 +19,15 @@ 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.7'
 
   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/gemfiles/rails70.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec path: '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 7.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.5.0'
 end

data/lib/background_worker.rb

@@ -24,16 +24,14 @@ module BackgroundWorker
   end
 
   def self.verify_active_connections!
-    Rails.cache.reconnect if defined?(Rails)
-    if defined?(ActiveRecord) && ActiveRecord::VERSION::MAJOR == 3
-      ActiveRecord::Base.verify_active_connections!
+    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!
-    if defined?(ActiveRecord) && ActiveRecord::VERSION::MAJOR >= 4
-      ActiveRecord::Base.clear_all_connections!
-    end
+    ActiveRecord::Base.clear_all_connections!
   end
 
   def self.after_exception(e)

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

@@ -7,6 +7,7 @@
 
 require 'rubygems'
 require 'bundler/setup'
+require 'active_support'
 require 'active_support/core_ext/string/inflections' #underscore
 
 require 'support/coverage_loader'

data/spec/support/coverage_loader.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: background_worker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 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: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -83,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-rcov
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,7 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -133,15 +133,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - background_worker.gemspec
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
 - lib/background_worker.rb
 - lib/background_worker/base.rb
 - lib/background_worker/config.rb
@@ -149,6 +156,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
@@ -164,19 +173,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.3.3
 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

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-  - 2.3.0
-script: bundle exec rake spec
-notifications:
-  email:
-    - support@travellink.com.au
-sudo: false
-cache: bundler