Allow configuration of Rails queue adapter with :good_job

README.md

@@ -14,12 +14,12 @@ Inspired by [Delayed::Job](https://github.com/collectiveidea/delayed_job) and [Q
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'good_job', github: 'bensheldon/good_job'
+gem 'good_job'
 ```
 
 And then execute:
 ```bash
-$ bundle
+$ bundle install
 ```
 
 ## Usage
@@ -56,11 +56,21 @@ $ bundle
 
 1. Configure the ActiveJob adapter:
     ```ruby
-    # config/environments/production.rb
-    config.active_job.queue_adapter = GoodJob::Adapter.new
-
+    # config/application.rb
+    config.active_job.queue_adapter = :good_job
+    ```
+
+    By default, using `:good_job` is equivalent to manually configuring the adapter:
+
+    ```ruby
     # config/environments/development.rb
     config.active_job.queue_adapter = GoodJob::Adapter.new(inline: true)
+
+    # config/environments/test.rb
+    config.active_job.queue_adapter = GoodJob::Adapter.new(inline: true)
+
+    # config/environments/production.rb
+    config.active_job.queue_adapter = GoodJob::Adapter.new
     ```
 
 1. In production, the scheduler is designed to run in its own process:

lib/active_job/queue_adapters/good_job_adapter.rb

@@ -0,0 +1,13 @@
+module ActiveJob
+  module QueueAdapters
+    class GoodJobAdapter < GoodJob::Adapter
+      def initialize
+        if Rails.env.development? || Rails.env.test?
+          super(inline: true)
+        else
+          super(inline: false)
+        end
+      end
+    end
+  end
+end

lib/good_job.rb

@@ -8,6 +8,8 @@
 require 'good_job/adapter'
 require 'good_job/pg_locks'
 
+require 'active_job/queue_adapters/good_job_adapter'
+
 module GoodJob
   include Logging
 

lib/good_job/adapter.rb

@@ -27,8 +27,6 @@ def shutdown(wait: true) # rubocop:disable Lint/UnusedMethodArgument
       nil
     end
 
-    private
-
     def inline?
       @inline
     end

spec/active_job/queue_adapters/good_job_adapter_spec.rb

@@ -0,0 +1,43 @@
+require 'rails_helper'
+
+describe ActiveJob::QueueAdapters::GoodJobAdapter do
+  it 'inherits from GoodJob::Adapter' do
+    expect(described_class).to be < GoodJob::Adapter
+  end
+
+  it 'allows usage of ActiveJob symbol' do
+    ActiveJob::Base.queue_adapter = :good_job
+    expect(ActiveJob::Base.queue_adapter).to be_a described_class
+  end
+
+  describe '#initialize' do
+    before { allow(Rails.env).to receive(:test?).and_return(false) }
+
+    context 'when in development environment' do
+      before { allow(Rails.env).to receive(:development?).and_return(true) }
+
+      it 'runs inline' do
+        adapter = described_class.new
+        expect(adapter.inline?).to eq true
+      end
+    end
+
+    context 'when in test environment' do
+      before { allow(Rails.env).to receive(:test?).and_return(true) }
+
+      it 'runs inline' do
+        adapter = described_class.new
+        expect(adapter.inline?).to eq true
+      end
+    end
+
+    context 'when in production environment' do
+      before { allow(Rails.env).to receive(:production?).and_return(true) }
+
+      it 'runs in normal mode' do
+        adapter = described_class.new
+        expect(adapter.inline?).to eq false
+      end
+    end
+  end
+end

spec/good_job/scheduler_spec.rb

@@ -1,14 +1,9 @@
 require 'rails_helper'
 
 RSpec.describe GoodJob::Scheduler do
-  around do |example|
-    original_adapter = ActiveJob::Base.queue_adapter
+  before do
     ActiveJob::Base.queue_adapter = adapter
-    example.run
-    ActiveJob::Base.queue_adapter = original_adapter
-  end
 
-  before do
     stub_const "RUN_JOBS", Concurrent::Array.new
     stub_const "THREAD_JOBS", Concurrent::Hash.new(Concurrent::Array.new)
 

spec/support/reset_rails_queue_adapter.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.around do |example|
+    original_adapter = ActiveJob::Base.queue_adapter
+    example.run
+    ActiveJob::Base.queue_adapter = original_adapter
+  end
+end