good_job 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c0fc31238c6d66b5b9ed3ddc0d4b9393a0a5a2cca85c7fcd0f2f24650892675
-  data.tar.gz: d6484d63b86eb7bc748b308cbfebe1ca7798fa1fa77d9542754dc99504f12244
+  metadata.gz: 66c19e40862f09e5c7816911c0a21e8cb88f036980a9c33df62cba058b3993e5
+  data.tar.gz: 218153476e92ca847e7279d9979c4396ed02f36a41918b32b58bf1fb17b8cd92
 SHA512:
-  metadata.gz: 7e4d9fc5ae59750231906be49188aba712f1bdfbe2d66ed441f82c69ad267b0a056fed12998fe594c33c862f81d36d912a56d598c8e436e1e0ea225634abe66a
-  data.tar.gz: b02e2c08035b4a90713a0378e2b83173232baec7bf6b22ecbd56033d8fd38e78be0e3d992a7ca4e3339485014bc97fac62efd3d3fd94df195fceb9248703f004
+  metadata.gz: d5b0305c889392d2879ccd818eb98b09a867d85a5b853dc8ec35b5a17fee3490cc082f032827f631b15e0a8e1143ea676eea05738d901f97ec4737adf0a514d0
+  data.tar.gz: 96a8537b85de48b07f676746642bb43ff18369db559b0c058c21d101a7740a0269a772a3b8629fefe3242d2e8a1df0d34a0f12b85b5928caf6272572fcff0d67

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## [Unreleased](https://github.com/bensheldon/good_job/tree/HEAD)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v0.2.0...HEAD)
+
+**Merged pull requests:**
+
+- Clean up Gemspec [\#15](https://github.com/bensheldon/good_job/pull/15) ([bensheldon](https://github.com/bensheldon))
+- Set up Rubocop [\#14](https://github.com/bensheldon/good_job/pull/14) ([bensheldon](https://github.com/bensheldon))
+- Add pg gem as explicit dependency [\#13](https://github.com/bensheldon/good_job/pull/13) ([bensheldon](https://github.com/bensheldon))
+- Bump nokogiri from 1.10.7 to 1.10.9 [\#12](https://github.com/bensheldon/good_job/pull/12) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add Appraisal with tests for Rails 5.1, 5.2, 6.0 [\#11](https://github.com/bensheldon/good_job/pull/11) ([bensheldon](https://github.com/bensheldon))
+
+## [v0.2.0](https://github.com/bensheldon/good_job/tree/v0.2.0) (2020-03-06)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v0.1.0...v0.2.0)
+
+**Merged pull requests:**
+
+- Use Rails.logger and ActiveSupport::Notifications for logging instead of puts [\#10](https://github.com/bensheldon/good_job/pull/10) ([bensheldon](https://github.com/bensheldon))
+- Remove minitest files [\#9](https://github.com/bensheldon/good_job/pull/9) ([bensheldon](https://github.com/bensheldon))
+- Use scheduled\_at and priority for scheduling [\#8](https://github.com/bensheldon/good_job/pull/8) ([bensheldon](https://github.com/bensheldon))
+- Create Github Action workflow for PRs and Issues [\#7](https://github.com/bensheldon/good_job/pull/7) ([bensheldon](https://github.com/bensheldon))
+
+## [v0.1.0](https://github.com/bensheldon/good_job/tree/v0.1.0) (2020-03-03)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/6866006239f1a6b7fcb7103f5df60d904952fb84...v0.1.0)
+
+**Merged pull requests:**
+
+- Add executable with Thor [\#4](https://github.com/bensheldon/good_job/pull/4) ([bensheldon](https://github.com/bensheldon))
+- Refactor adapter enqueing methods; expand Readme, tests, editorconfig [\#3](https://github.com/bensheldon/good_job/pull/3) ([bensheldon](https://github.com/bensheldon))
+- Fetch new jobs within the worker thread itself; incrementally grow worker threads [\#2](https://github.com/bensheldon/good_job/pull/2) ([bensheldon](https://github.com/bensheldon))
+- Set up Github Workflows for tests [\#1](https://github.com/bensheldon/good_job/pull/1) ([bensheldon](https://github.com/bensheldon))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -107,10 +107,10 @@ $ gem signin
 $ gem bump -v minor --no-commit
 
 # Update the changelog
-$ bundle exec changelog
+$ bundle exec rake changelog
 
 # Commit the version and changelog to git
-$ bundle commit_version
+$ bundle exec rake commit_version
 
 # Push to rubygems.org
 $ gem release

data/lib/good_job/adapter.rb

@@ -5,10 +5,6 @@ module GoodJob
       @scheduler = InlineScheduler.new if inline?
     end
 
-    def inline?
-      @options.fetch(:inline, false)
-    end
-
     def enqueue(job)
       enqueue_at(job, nil)
     end
@@ -35,5 +31,11 @@ module GoodJob
     def shutdown(wait: true)
       @scheduler&.shutdown(wait: wait)
     end
+
+    private
+
+    def inline?
+      @options.fetch(:inline, false)
+    end
   end
 end

data/lib/good_job/cli.rb

@@ -8,7 +8,8 @@ module GoodJob
     def start
       require RAILS_ENVIRONMENT_RB
 
-      scheduler = GoodJob::Scheduler.new
+      GoodJob::Scheduler.new
+
       Kernel.loop do
         sleep 1
       end

data/lib/good_job/lockable.rb

@@ -17,7 +17,7 @@ module GoodJob
       scope :advisory_unlocked, -> { joins_advisory_locks.where(pg_locks: { locktype: nil }) }
       scope :with_advisory_lock, (lambda do
         where(<<~SQL)
-           pg_try_advisory_lock(('x'||substr(md5(id::text), 1, 16))::bit(64)::bigint)
+          pg_try_advisory_lock(('x'||substr(md5(id::text), 1, 16))::bit(64)::bigint)
         SQL
       end)
 
@@ -42,7 +42,7 @@ module GoodJob
       end
 
       def advisory_lock
-        self.class.connection.execute(self.class.sanitize_sql_for_conditions(["SELECT 1 as one WHERE pg_try_advisory_lock(('x'||substr(md5(?), 1, 16))::bit(64)::bigint)", id])).ntuples > 0
+        self.class.connection.execute(sanitize_sql_for_conditions(["SELECT 1 as one WHERE pg_try_advisory_lock(('x'||substr(md5(?), 1, 16))::bit(64)::bigint)", id])).ntuples.positive?
       end
 
       def advisory_lock!
@@ -51,17 +51,15 @@ module GoodJob
       end
 
       def with_advisory_lock
-        begin
-          advisory_lock!
-          yield
-        rescue StandardError => e
-          advisory_unlock unless e.is_a? RecordAlreadyAdvisoryLockedError
-          raise
-        end
+        advisory_lock!
+        yield
+      rescue StandardError => e
+        advisory_unlock unless e.is_a? RecordAlreadyAdvisoryLockedError
+        raise
       end
 
       def advisory_locked?
-        self.class.connection.execute(<<~SQL).ntuples > 0
+        self.class.connection.execute(<<~SQL).ntuples.positive?
           SELECT 1 as one
           FROM pg_locks
           WHERE
@@ -73,7 +71,7 @@ module GoodJob
       end
 
       def owns_advisory_lock?
-        self.class.connection.execute(<<~SQL).ntuples > 0
+        self.class.connection.execute(<<~SQL).ntuples.positive?
           SELECT 1 as one
           FROM pg_locks
           WHERE
@@ -92,6 +90,13 @@ module GoodJob
       def advisory_unlock!
         advisory_unlock while advisory_locked?
       end
+
+      private
+
+      def sanitize_sql_for_conditions(*args)
+        # Made public in Rails 5.2
+        self.class.send(:sanitize_sql_for_conditions, *args)
+      end
     end
   end
 end

data/lib/good_job/logging.rb

@@ -1,58 +1,56 @@
-module GoodJob::Logging
-  extend ActiveSupport::Concern
-
-  included do
-    cattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
-
-    def self.tag_logger(*tags)
-      if logger.respond_to?(:tagged)
-        tags.unshift "GoodJob" unless logger.formatter.current_tags.include?("GoodJob")
-        logger.tagged(*tags) { yield }
-      else
-        yield
+module GoodJob
+  module Logging
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
+
+      def self.tag_logger(*tags)
+        if logger.respond_to?(:tagged)
+          tags.unshift "GoodJob" unless logger.formatter.current_tags.include?("GoodJob")
+          logger.tagged(*tags) { yield }
+        else
+          yield
+        end
       end
     end
-  end
 
-  class LogSubscriber < ActiveSupport::LogSubscriber
-    def create(event)
-      good_job = event.payload[:good_job]
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      def create(event)
+        good_job = event.payload[:good_job]
 
-      info do
-        "Created GoodJob resource with id #{good_job.id}"
+        info do
+          "Created GoodJob resource with id #{good_job.id}"
+        end
       end
-    end
 
-    def timer_task_finished(event)
-      result = event.payload[:result]
-      exception = event.payload[:error]
+      def timer_task_finished(event)
+        exception = event.payload[:error]
+        return unless exception
 
-      if exception
         error do
           "ERROR: #{exception}\n #{exception.backtrace}"
         end
       end
-    end
 
-    def job_finished(event)
-      result = event.payload[:result]
-      exception = event.payload[:error]
+      def job_finished(event)
+        exception = event.payload[:error]
+        return unless exception
 
-      if exception
         error do
           "ERROR: #{exception}\n #{exception.backtrace}"
         end
       end
-    end
 
-    private
+      private
 
-    def logger
-      GoodJob.logger
-    end
+      def logger
+        GoodJob.logger
+      end
 
-    def thread_name
-      Thread.current.name || Thread.current.object_id
+      def thread_name
+        Thread.current.name || Thread.current.object_id
+      end
     end
   end
 end

data/lib/good_job/scheduler.rb

@@ -9,7 +9,7 @@ module GoodJob
     DEFAULT_TIMER_OPTIONS = {
       execution_interval: 1,
       timeout_interval: 1,
-      run_now: true
+      run_now: true,
     }.freeze
 
     DEFAULT_POOL_OPTIONS = {
@@ -19,10 +19,10 @@ module GoodJob
       auto_terminate: true,
       idletime: 0,
       max_queue: 0,
-      fallback_policy: :abort # shouldn't matter -- 0 max queue
+      fallback_policy: :abort, # shouldn't matter -- 0 max queue
     }.freeze
 
-    def initialize(query = GoodJob::Job.all, **options)
+    def initialize(query = GoodJob::Job.all, **_options)
       @query = query
 
       @pool = Concurrent::ThreadPoolExecutor.new(DEFAULT_POOL_OPTIONS)
@@ -51,12 +51,17 @@ module GoodJob
         @pool.shutdown
         @pool.wait_for_termination if wait
       end
+
+      true
     end
 
     def create_thread
       future = Concurrent::Future.new(args: [ordered_query], executor: @pool) do |query|
         Rails.application.executor.wrap do
-          while good_job = query.with_advisory_lock.first
+          loop do
+            good_job = query.with_advisory_lock.first
+            break unless good_job
+
             ActiveSupport::Notifications.instrument("job_started.good_job", { good_job: good_job })
 
             JobWrapper.new(good_job).perform
@@ -64,6 +69,7 @@ module GoodJob
             good_job.advisory_unlock
           end
         end
+
         true
       end
       future.add_observer(TaskObserver.new)

data/lib/good_job/version.rb

@@ -1,3 +1,3 @@
 module GoodJob
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2020-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,37 +16,65 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop
+  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-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,17 +164,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: GoodJob is a minimal postgres based job queue system for Rails
+description: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
 email:
 - bensheldon@gmail.com
 executables:
 - good_job
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- bin/good_job
+- exe/good_job
 - lib/good_job.rb
 - lib/good_job/adapter.rb
 - lib/good_job/cli.rb
@@ -147,16 +193,28 @@ files:
 homepage: https://github.com/benheldon/good_job
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/bensheldon/good_job/issues
+  changelog_uri: https://github.com/bensheldon/good_job/blob/master/CHANGELOG.md
+  documentation_uri: https://rdoc.info/github/bensheldon/good_job
+  homepage_uri: https://github.com/benheldon/good_job
+  source_code_uri: https://github.com/bensheldon/good_job
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- GoodJob - a multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -166,5 +224,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: GoodJob is a minimal postgres based job queue system for Rails
+summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
 test_files: []