background_worker 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92739c3cd6034d467914e25cacf4a240e38c046b6e388cec4f9af9679b97d9a6
-  data.tar.gz: 89f898f9989bcf29e5db58bf9bd23f189aa9e87702d145309c072a3a501ff2a1
+  metadata.gz: 21cc4f8353107acd3a07a1dbb33709a5f5629e266c64ec66eee2a558d61e6614
+  data.tar.gz: 9499f710d1e056be82da09af4c28a8229ac43e6aada29725a1d766f4638fc136
 SHA512:
-  metadata.gz: ce83fb384503d92765da69f1daec6f11eeff92fc8c9792ed5e4a8e770aa67224e0fd63ad7783d02b692ba38c75b7623785e2df22457ab58b5ae5fa8d4ca3b78b
-  data.tar.gz: '091732c22801dc033d91957cba5a3d4a84776414ca4f09d5f09dd02205b8c54ef243d462f7e2092e3249554c4f58e6ff00996efaa1c6bf1a50794737fa5a00e0'
+  metadata.gz: f869b9563b92e17c75632b3de27946ac87939033c068c093e3060b8f062bb26abab31a3559def9fe06a6291016a9c26e764c25a6c96fe7f789e886e934aec709
+  data.tar.gz: fc67495315f925f92ff8e00fe4c8e3babffd1b9c6e608ae274cfa26e72364fa83ea76ea1903b636e979ef9100dd26edd8422a3b64149e6ff726bdc6c0c87a503

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

@@ -1 +1 @@
-2.6.5
+3.1.0

data/CHANGELOG.md

@@ -3,6 +3,18 @@ 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.6.0
+
+- [PLAT-664] Align interface to ActiveJob
+
+## 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

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/background_worker.gemspec

@@ -19,14 +19,13 @@ 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'

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

@@ -58,7 +58,7 @@ module BackgroundWorker
       end
 
       # Public method to do in background...
-      def perform_in_background(method_name, options = {})
+      def perform_later(method_name, options = {})
         opts = options.symbolize_keys
 
         method_name = method_name.to_sym
@@ -76,7 +76,7 @@ module BackgroundWorker
       # This method is called by the job runner
       #
       # It will just call your preferred method in the worker.
-      def perform(method_name, options = {})
+      def perform_now(method_name, options = {})
         BackgroundWorker.verify_active_connections! if BackgroundWorker.config.backgrounded
 
         worker = new(options)

data/lib/background_worker/config.rb

@@ -28,7 +28,7 @@ module BackgroundWorker
     end
 
     def foreground_enqueue(klass, method_name, opts)
-      klass.perform(method_name, opts)
+      klass.perform_now(method_name, opts)
     end
 
     def default_after_exception(e)

data/lib/background_worker/version.rb

@@ -1,3 +1,3 @@
 module BackgroundWorker
-  VERSION = '0.3.0'
+  VERSION = '0.6.0'
 end

data/spec/base_spec.rb

@@ -32,7 +32,7 @@ describe BackgroundWorker::Base do
 
   it 'should perform action and handle transactions/connections appropriately' do
     Model.transaction do
-      worker_class.perform_in_background(:store_in_cache, value: 42)
+      worker_class.perform_later(:store_in_cache, value: 42)
     end
     expect(cache).to have_received(:store).with(42)
   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: 82.75)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: background_worker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael Noack
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -82,34 +82,6 @@ dependencies:
     - - ">="
       - !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
@@ -161,17 +133,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - background_worker.gemspec
-- gemfiles/rails5_2.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
 - lib/background_worker.rb
 - lib/background_worker/base.rb
 - lib/background_worker/config.rb
@@ -196,14 +173,14 @@ 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: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Background worker abstraction with status updates

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.5
-script: bundle exec rake spec
-gemfile:
-  - gemfiles/rails5_2.gemfile
-notifications:
-  email:
-    - support@travellink.com.au
-sudo: false
-cache: bundler

data/gemfiles/rails5_2.gemfile

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