parallel_minion 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ca9bfc8f399bcbb7cf2d90c3bb71c30fb160b23890c53ca4ca7add4a5b12fdb
-  data.tar.gz: a196538e92034bce7281060fcc6f22db09d3c26c49c5b6175f2471d2015aea7b
+  metadata.gz: 8ee831ee7f2939c246ff997e0abbdeca9f2779a4faa21d68d1cd6d4e27c09b52
+  data.tar.gz: e681733d3cbd2e9da49a0552e070a9fa52be776208d2bbfa02943752fd3b6a53
 SHA512:
-  metadata.gz: 6c8f413c6fda9af1dcb94efdc4e16bf40183359f942410f38a7c57884def7ca53aee16d51c824b24c499037288ed56a5458b329bb92e87f16f8cf73c9922c15a
-  data.tar.gz: 44697598c5916f29a6b02bc15cf26fcd5871de81a13cc7426192d4e49ea11ed21d0fa03d9085f44daa0be0a2f565f9cf3978e3ffe84f4487910e5400870a16c6
+  metadata.gz: aa0986ec9d4c9c8713f9a19a37ba32739af5c184fd558e1ce9860a2b38de5caf6ccb8aa1a933fb4969f9ca94224a21386fd608551b6d582d0e2418976b9c26c6
+  data.tar.gz: 8d7b3ca45414d9154311fed2fa3d7ab487f201224532e07304c1f8965265d0d8bb96a44da10aa4b82b940869df0c60c3e91e1fbd43390f0595cc91a6aef716e8

data/README.md

@@ -1,5 +1,5 @@
-parallel_minion [![Build Status](https://secure.travis-ci.org/reidmorrison/parallel_minion.png?branch=master)](http://travis-ci.org/reidmorrison/parallel_minion)
-===============
+# Parallel Minion
+[![Gem Version](https://img.shields.io/gem/v/parallel_minion.svg)](https://rubygems.org/gems/parallel_minion) [![Build Status](https://github.com/reidmorrison/parallel_minion/workflows/build/badge.svg)](https://github.com/reidmorrison/parallel_minion/actions?query=workflow%3Abuild) [![Downloads](https://img.shields.io/gem/dt/parallel_minion.svg)](https://rubygems.org/gems/parallel_minion) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg)
 
 Wrap Ruby code with a minion so that it is run on a parallel thread.
 
@@ -46,12 +46,20 @@ has been achieved by moving existing blocks of code into Minions.
 
     gem install parallel_minion
 
+## Rails 7.2 compatibility
+
+- **Apps** need **Ruby ≥ 3.1** (Rails 7.2 requirement).
+- **Code:** Thread cleanup uses `ActiveRecord::Base.connection_handler.clear_active_connections!` instead of `ActiveRecord::Base.clear_active_connections!` because Rails 7 deprecates the latter.
+- **Railtie:** Unchanged (`config.parallel_minion` as before).
+- **CI:** `rails_7.2` Appraisal  `gemfiles/rails_7.2.gemfile`, Ruby 3.2. The 7.2 appraisal pins **Minitest ~> 5.0** (tests use `stub`, removed in Minitest 6).
+- **sqlite3 (dev):** The 7.2 appraisal allows `sqlite3 >= 1.4` (including 2.x). Other gemfiles use `sqlite3 >= 1.5, < 2` to skip **1.4.4**, which often fails to compile on modern toolchains (all OSes).
+
 ## Meta
 
 * Code: `git clone git://github.com/reidmorrison/parallel_minion.git`
 * Home: <https://github.com/reidmorrison/parallel_minion>
 * Bugs: <http://github.com/reidmorrison/parallel_minion/issues>
-* Gems: <http://rubygems.org/gems/parallel_minion>
+* Gems: <https://rubygems.org/gems/parallel_minion>
 
 This project uses [Semantic Versioning](http://semver.org/).
 

data/Rakefile

@@ -1,30 +1,30 @@
 # Setup bundler to avoid having to run bundle exec all the time.
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-require 'rake/testtask'
-require_relative 'lib/parallel_minion/version'
+require "rake/testtask"
+require_relative "lib/parallel_minion/version"
 
 task :gem do
-  system 'gem build parallel_minion.gemspec'
+  system "gem build parallel_minion.gemspec"
 end
 
 task publish: :gem do
-  system "git tag -a v#{ParallelMinion::VERSION} -m 'Tagging #{ParallelMinion::VERSION}'"
-  system 'git push --tags'
+  # system "git tag -a v#{ParallelMinion::VERSION} -m 'Tagging #{ParallelMinion::VERSION}'"
+  # system "git push --tags"
   system "gem push parallel_minion-#{ParallelMinion::VERSION}.gem"
   system "rm parallel_minion-#{ParallelMinion::VERSION}.gem"
 end
 
 Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*_test.rb'
+  t.pattern = "test/**/*_test.rb"
   t.verbose = true
   t.warning = false
 end
 
 # By default run tests against all appraisals
-if !ENV['APPRAISAL_INITIALIZED'] && !ENV['TRAVIS']
-  require 'appraisal'
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  require "appraisal"
   task default: :appraisal
 else
   task default: :test

data/lib/parallel_minion/minion.rb

@@ -70,6 +70,7 @@ module ParallelMinion
     #   :trace, :debug, :info, :warn, :error, :fatal
     def self.started_log_level=(level)
       raise(ArgumentError, "Invalid log level: #{level}") unless SemanticLogger::LEVELS.include?(level)
+
       @started_log_level = level
     end
 
@@ -85,6 +86,7 @@ module ParallelMinion
     #   :trace, :debug, :info, :warn, :error, :fatal
     def self.completed_log_level=(level)
       raise(ArgumentError, "Invalid log level: #{level}") unless SemanticLogger::LEVELS.include?(level)
+
       @completed_log_level = level
     end
 
@@ -96,7 +98,6 @@ module ParallelMinion
     self.completed_log_level = :info
     self.enabled             = true
     self.scoped_classes      = []
-    logger.name              = 'Minion'
 
     # Create a new Minion
     #
@@ -215,7 +216,7 @@ module ParallelMinion
     #     customer.save!
     #   end
     def initialize(*arguments,
-                   description: 'Minion',
+                   description: "Minion",
                    metric: nil,
                    log_exception: nil,
                    on_exception_level: self.class.completed_log_level,
@@ -224,7 +225,8 @@ module ParallelMinion
                    on_timeout: nil,
                    wait_metric: nil,
                    &block)
-      raise 'Missing mandatory block that Minion must perform' unless block
+      raise "Missing mandatory block that Minion must perform" unless block
+
       @start_time         = Time.now
       @exception          = nil
       @arguments          = arguments
@@ -238,10 +240,10 @@ module ParallelMinion
 
       @wait_metric        = (wait_metric || "#{metric}/wait") if @metric
 
-      # When minion is disabled it is obvious in the logs since the name will now be 'Inline' instead of 'Minion'
+      # When minion is disabled make it obvious in the logs by setting the name to 'Inline' instead of 'Minion'.
       unless @enabled
         l           = self.class.logger.dup
-        l.name      = 'Inline'
+        l.name      = "Inline"
         self.logger = l
       end
 
@@ -295,7 +297,8 @@ module ParallelMinion
     # Returns nil if their is no time limit. I.e. :timeout was set to Minion::INFINITE (infinite time left)
     def time_left
       return nil if timeout.zero? || (timeout == -1)
-      duration = timeout - (Time.now - start_time) * 1000
+
+      duration = timeout - ((Time.now - start_time) * 1000)
       duration <= 0 ? 0 : duration
     end
 
@@ -335,8 +338,8 @@ module ParallelMinion
       ) do
         @result = instance_exec(*arguments, &block)
       end
-    rescue Exception => exc
-      @exception = exc
+    rescue Exception => e
+      @exception = e
     ensure
       @duration = Time.now - start_time
     end
@@ -372,13 +375,13 @@ module ParallelMinion
                 metric:             metric,
                 &proc
               )
-            rescue Exception => exc
-              @exception = exc
+            rescue Exception => e
+              @exception = e
               nil
             ensure
               @duration = Time.now - start_time
               # Return any database connections used by this thread back to the pool
-              ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
+              ActiveRecord::Base.connection_handler.clear_active_connections! if defined?(ActiveRecord::Base)
             end
             # rubocop:enable Lint/RescueException
           end

data/lib/parallel_minion/railtie.rb

@@ -1,5 +1,5 @@
-module ParallelMinion #:nodoc:
-  class Railtie < Rails::Railtie #:nodoc:
+module ParallelMinion # :nodoc:
+  class Railtie < Rails::Railtie # :nodoc:
     #
     # Make the ParallelMinion config available in the Rails application config
     #

data/lib/parallel_minion/version.rb

@@ -1,3 +1,3 @@
 module ParallelMinion
-  VERSION = '1.3.0'.freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/parallel_minion.rb

@@ -1,7 +1,7 @@
-require 'semantic_logger'
+require "semantic_logger"
 
 module ParallelMinion
-  autoload :Minion, 'parallel_minion/minion'
+  autoload :Minion, "parallel_minion/minion"
 end
 
-require 'parallel_minion/railtie' if defined?(Rails)
+require "parallel_minion/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: parallel_minion
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Reid Morrison
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
@@ -24,9 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-description: 
-email:
-- reidmo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -38,16 +34,11 @@ files:
 - lib/parallel_minion/minion.rb
 - lib/parallel_minion/railtie.rb
 - lib/parallel_minion/version.rb
-- test/config/database.yml
-- test/minion_scope_test.rb
-- test/minion_test.rb
-- test/test_db.sqlite3
-- test/test_helper.rb
 homepage: https://github.com/reidmorrison/parallel_minion
 licenses:
 - Apache License V2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -55,21 +46,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Wrap Ruby code with a minion so that it is run on a parallel thread
-test_files:
-- test/minion_test.rb
-- test/minion_scope_test.rb
-- test/config/database.yml
-- test/test_db.sqlite3
-- test/test_helper.rb
+test_files: []

data/test/config/database.yml

@@ -1,5 +0,0 @@
-test:
-  adapter:  sqlite3
-  database: test/test_db.sqlite3
-  pool:     5
-  timeout:  5000

data/test/minion_scope_test.rb

@@ -1,58 +0,0 @@
-require_relative 'test_helper'
-require 'erb'
-require 'active_record'
-
-ActiveRecord::Base.logger         = SemanticLogger[ActiveRecord]
-ActiveRecord::Base.configurations = YAML.safe_load(ERB.new(IO.read('test/config/database.yml')).result)
-ActiveRecord::Base.establish_connection(:test)
-
-ActiveRecord::Schema.define version: 0 do
-  create_table :people, force: true do |t|
-    t.string :name
-    t.string :state
-    t.string :zip_code
-  end
-end
-
-class Person < ActiveRecord::Base
-end
-
-class MinionScopeTest < Minitest::Test
-  describe ParallelMinion::Minion do
-    [false, true].each do |enabled|
-      describe ".new with enabled: #{enabled.inspect}" do
-        before do
-          Person.create(name: 'Jack', state: 'FL', zip_code: 38_729)
-          Person.create(name: 'John', state: 'FL', zip_code: 35_363)
-          Person.create(name: 'Jill', state: 'FL', zip_code: 73_534)
-          Person.create(name: 'Joe', state: 'NY', zip_code: 45_325)
-          Person.create(name: 'Jane', state: 'NY', zip_code: 45_325)
-          Person.create(name: 'James', state: 'CA', zip_code: 123_123)
-          # Instruct Minions to adhere to any dynamic scopes for Person model
-          ParallelMinion::Minion.scoped_classes << Person
-          ParallelMinion::Minion.enabled = enabled
-        end
-
-        after do
-          Person.destroy_all
-          ParallelMinion::Minion.scoped_classes.clear
-          SemanticLogger.flush
-        end
-
-        it 'copy across model scope' do
-          assert_equal 6, Person.count
-
-          Person.unscoped.where(state: 'FL').scoping { Person.count }
-
-          Person.unscoped.where(state: 'FL').scoping do
-            assert_equal 3, Person.count
-            minion = ParallelMinion::Minion.new(description: 'Scope Test', log_exception: :full) do
-              Person.count
-            end
-            assert_equal 3, minion.result
-          end
-        end
-      end
-    end
-  end
-end

data/test/minion_test.rb

@@ -1,245 +0,0 @@
-require_relative './test_helper'
-
-# Test ParallelMinion standalone without Rails
-# Run this test standalone to verify it has no Rails dependencies
-class MinionTest < Minitest::Test
-  include SemanticLogger::Loggable
-
-  describe ParallelMinion::Minion do
-    class InMemoryAppender < SemanticLogger::Subscriber
-      attr_reader :messages
-
-      def initialize
-        @messages = []
-        self.name = 'Minion'
-      end
-
-      def log(log)
-        messages << log.dup
-      end
-    end
-
-    let :log_messages do
-      appender.messages
-    end
-
-    let :appender do
-      InMemoryAppender.new
-    end
-
-    before do
-      ParallelMinion::Minion.logger = appender
-    end
-
-    [false, true].each do |enabled|
-      describe enabled ? 'enabled' : 'disabled' do
-        before do
-          ParallelMinion::Minion.enabled = enabled
-        end
-
-        it 'without parameters' do
-          minion = ParallelMinion::Minion.new { 196 }
-          assert_equal 196, minion.result
-        end
-
-        it 'with a description' do
-          minion = ParallelMinion::Minion.new(description: 'Test') { 197 }
-          assert_equal 197, minion.result
-        end
-
-        it 'with an argument' do
-          p1     = {name: 198}
-          minion = ParallelMinion::Minion.new(p1, description: 'Test') do |v|
-            v[:name]
-          end
-          assert_equal 198, minion.result
-        end
-
-        it 'raise exception' do
-          minion = ParallelMinion::Minion.new(description: 'Test') { raise 'An exception' }
-          assert_raises RuntimeError do
-            minion.result
-          end
-        end
-
-        it 'has correct logger name' do
-          minion = ParallelMinion::Minion.new { 196 }
-          name   = enabled ? 'Minion' : 'Inline'
-          assert_equal name, minion.logger.name
-        end
-
-        # TODO: Blocks still have access to their original scope if variables cannot be
-        #      resolved first by the parameters, then by the values in Minion itself
-        #        it 'not have access to local variables' do
-        #          name = 'Jack'
-        #          minion = ParallelMinion::Minion.new(description: 'Test') { puts name }
-        #          assert_raises NameError do
-        #            minion.result
-        #          end
-        #        end
-
-        it 'run minion' do
-          hash   = {value: 23}
-          value  = 47
-          minion = ParallelMinion::Minion.new(hash, description: 'Test') do |h|
-            value     = 321
-            h[:value] = 123
-            456
-          end
-          assert_equal 456, minion.result
-          assert_equal 123, hash[:value]
-          assert_equal 321, value
-        end
-
-        it 'copy across logging tags' do
-          minion = nil
-          SemanticLogger.tagged('TAG') do
-            assert_equal 'TAG', SemanticLogger.tags.last
-            minion = ParallelMinion::Minion.new(description: 'Tag Test') do
-              logger.info 'Tag Test'
-              logger.tags.last
-            end
-          end
-          assert_equal 'TAG', minion.result
-        end
-
-        it 'copy across named tags' do
-          minion = nil
-          SemanticLogger.named_tagged(tag: 'TAG') do
-            assert_equal({tag: 'TAG'}, SemanticLogger.named_tags)
-            minion = ParallelMinion::Minion.new(description: 'Named Tags Test') do
-              logger.info 'Named Tags Test'
-              SemanticLogger.named_tags
-            end
-          end
-          assert_equal({tag: 'TAG'}, minion.result)
-        end
-
-        it 'copy across tags and named tags' do
-          minion = nil
-          SemanticLogger.tagged('TAG') do
-            SemanticLogger.named_tagged(tag: 'TAG') do
-              assert_equal({tag: 'TAG'}, SemanticLogger.named_tags)
-              assert_equal 'TAG', SemanticLogger.tags.last
-              minion = ParallelMinion::Minion.new(description: 'Tags Test') do
-                logger.info 'Tags Test'
-                [SemanticLogger.named_tags, SemanticLogger.tags.last]
-              end
-
-              assert_equal({tag: 'TAG'}, minion.result.first)
-              assert_equal 'TAG', minion.result.last
-            end
-          end
-        end
-
-        it 'include metric' do
-          metric_name = 'model/method'
-          hash        = {value: 23}
-          value       = 47
-          minion      = ParallelMinion::Minion.new(hash, description: 'Test', metric: metric_name) do |h|
-            value     = 321
-            h[:value] = 123
-            sleep 1
-            456
-          end
-          assert_equal 456, minion.result
-          assert_equal 123, hash[:value]
-          assert_equal 321, value
-
-          assert log_messages.shift, -> { log_messages.ai }
-          assert completed_log = log_messages.shift, -> { log_messages.ai }
-          # Completed log message
-          assert_equal metric_name, completed_log.metric, -> { completed_log.ai }
-          if enabled
-            # Wait log message
-            assert waited_log = log_messages.shift, -> { log_messages.ai }
-            assert_equal "#{metric_name}/wait", waited_log.metric, -> { waited_log.ai }
-          end
-        end
-
-        it ':on_exception_level' do
-          minion = ParallelMinion::Minion.new(
-            description:        'Test',
-            on_exception_level: :error
-          ) do |_h|
-            raise 'Oh No'
-          end
-          # Wait for thread to complete
-          assert_raises RuntimeError do
-            minion.result
-          end
-
-          assert log_messages.shift, -> { log_messages.ai }
-          assert completed_log = log_messages.shift, -> { log_messages.ai }
-
-          assert_equal :error, completed_log.level
-          assert_equal 'Completed Test -- Exception: RuntimeError: Oh No', completed_log.message
-          refute completed_log.backtrace.empty?
-        end
-
-        it 'handle multiple minions concurrently' do
-          # Start 10 minions
-          minions = Array.new(10) do |i|
-            # Each Minion returns its index in the collection
-            ParallelMinion::Minion.new(i, description: "Minion:#{i}") { |counter| counter }
-          end
-          assert_equal 10, minions.count
-          # Fetch the result from each Minion
-          minions.each_with_index do |minion, index|
-            assert_equal index, minion.result
-          end
-        end
-
-        it 'timeout' do
-          if enabled
-            minion = ParallelMinion::Minion.new(description: 'Test', timeout: 100) { sleep 1 }
-            assert_nil minion.result
-          end
-        end
-
-        it 'timeout and terminate thread with Exception' do
-          if enabled
-            minion = ParallelMinion::Minion.new(description: 'Test', timeout: 100, on_timeout: Timeout::Error) { sleep 1 }
-            assert_nil minion.result
-            # Give time for thread to terminate
-            sleep 0.1
-            assert_equal Timeout::Error, minion.exception.class
-            assert_equal false, minion.working?
-            assert_equal true, minion.completed?
-            assert_equal true, minion.failed?
-            assert_equal 0, minion.time_left
-          end
-        end
-
-        it 'make description instance variable available' do
-          minion = ParallelMinion::Minion.new(description: 'Test') do
-            description
-          end
-          assert_equal 'Test', minion.result
-        end
-
-        it 'make timeout instance variable available' do
-          minion = ParallelMinion::Minion.new(description: 'Test', timeout: 1000) do
-            timeout
-          end
-          assert_equal 1000, minion.result
-        end
-
-        it 'make enabled? method available' do
-          minion = ParallelMinion::Minion.new(description: 'Test') do
-            enabled?
-          end
-          assert_equal enabled, minion.result
-        end
-
-        it 'keep the original arguments' do
-          minion = ParallelMinion::Minion.new(1, 'data', 14.1, description: 'Test') do |num, _str, float|
-            num + float
-          end
-          assert_equal 15.1, minion.result
-          assert_equal [1, 'data', 14.1], minion.arguments
-        end
-      end
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,8 +0,0 @@
-# $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-
-require 'minitest/autorun'
-require 'parallel_minion'
-require 'semantic_logger'
-
-SemanticLogger.default_level = :trace
-SemanticLogger.add_appender(file_name: 'test.log', formatter: :color)