Add generator to set queue_adapter and magic comment for frozen strings consistently

rosa · rosa · commit da3a2caa30c6 · 2023-12-15T17:48:39.000+01:00
diff --git a/app/models/solid_queue/blocked_execution.rb b/app/models/solid_queue/blocked_execution.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class BlockedExecution < Execution
     assume_attributes_from_job :concurrency_key
diff --git a/app/models/solid_queue/claimed_execution.rb b/app/models/solid_queue/claimed_execution.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SolidQueue::ClaimedExecution < SolidQueue::Execution
   belongs_to :process
 
diff --git a/app/models/solid_queue/execution.rb b/app/models/solid_queue/execution.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Execution < Record
     include JobAttributes
diff --git a/app/models/solid_queue/execution/job_attributes.rb b/app/models/solid_queue/execution/job_attributes.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Execution
     module JobAttributes
diff --git a/app/models/solid_queue/failed_execution.rb b/app/models/solid_queue/failed_execution.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SolidQueue::FailedExecution < SolidQueue::Execution
   if Gem::Version.new(Rails.version) >= Gem::Version.new("7.1")
     serialize :error, coder: JSON
diff --git a/app/models/solid_queue/job.rb b/app/models/solid_queue/job.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SolidQueue::Job < SolidQueue::Record
   include Executable
 
diff --git a/app/models/solid_queue/job/clearable.rb b/app/models/solid_queue/job/clearable.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Job
     module Clearable
diff --git a/app/models/solid_queue/job/concurrency_controls.rb b/app/models/solid_queue/job/concurrency_controls.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Job
     module ConcurrencyControls
diff --git a/app/models/solid_queue/job/executable.rb b/app/models/solid_queue/job/executable.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Job
     module Executable
diff --git a/app/models/solid_queue/pause.rb b/app/models/solid_queue/pause.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Pause < Record
   end
diff --git a/app/models/solid_queue/process.rb b/app/models/solid_queue/process.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SolidQueue::Process < SolidQueue::Record
   include Prunable
 
diff --git a/app/models/solid_queue/process/prunable.rb b/app/models/solid_queue/process/prunable.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue::Process::Prunable
   extend ActiveSupport::Concern
 
diff --git a/app/models/solid_queue/queue.rb b/app/models/solid_queue/queue.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Queue
     attr_accessor :name
diff --git a/app/models/solid_queue/ready_execution.rb b/app/models/solid_queue/ready_execution.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class ReadyExecution < Execution
     scope :queued_as, ->(queue_name) { where(queue_name: queue_name) }
diff --git a/app/models/solid_queue/record.rb b/app/models/solid_queue/record.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Record < ActiveRecord::Base
     self.abstract_class = true
diff --git a/app/models/solid_queue/scheduled_execution.rb b/app/models/solid_queue/scheduled_execution.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class ScheduledExecution < Execution
     scope :due, -> { where(scheduled_at: ..Time.current) }
diff --git a/app/models/solid_queue/semaphore.rb b/app/models/solid_queue/semaphore.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SolidQueue::Semaphore < SolidQueue::Record
   scope :available, -> { where("value > 0") }
   scope :expired, -> { where(expires_at: ...Time.current) }
diff --git a/lib/generators/solid_queue/install/USAGE b/lib/generators/solid_queue/install/USAGE
@@ -0,0 +1,9 @@
+Description:
+    Installs solid_queue as the Active Job's queue adapter
+
+Example:
+    bin/rails generate solid_queue:install
+
+    This will create:
+        Installs solid_queue migrations
+        Replaces Active Job's adapter in envionment configuration
diff --git a/lib/generators/solid_queue/install/install_generator.rb b/lib/generators/solid_queue/install/install_generator.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class SolidQueue::InstallGenerator < Rails::Generators::Base
+  class_option :skip_migrations, type: :boolean, default: nil, desc: "Skip migrations"
+
+  def add_solid_queue
+    %w[ development test production ].each do |env_name|
+      if (env_config = Pathname(destination_root).join("config/environments/#{env_name}.rb")).exist?
+        gsub_file env_config, /(# )?config\.active_job\.queue_adapter\s+=.*/, "config.active_job.queue_adapter = :solid_queue"
+      end
+    end
+  end
+
+  def create_migrations
+    unless options[:skip_migrations]
+      rails_command "railties:install:migrations FROM=solid_queue", inline: true
+    end
+  end
+end
diff --git a/lib/solid_queue.rb b/lib/solid_queue.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "solid_queue/version"
 require "solid_queue/engine"
 
diff --git a/lib/solid_queue/engine.rb b/lib/solid_queue/engine.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidQueue
   class Engine < ::Rails::Engine
     isolate_namespace SolidQueue

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module SolidQueue`
`2`	`4`	`class BlockedExecution < Execution`
`3`	`5`	`assume_attributes_from_job :concurrency_key`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`class SolidQueue::ClaimedExecution < SolidQueue::Execution`
`2`	`4`	`belongs_to :process`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`class SolidQueue::FailedExecution < SolidQueue::Execution`
`2`	`4`	`if Gem::Version.new(Rails.version) >= Gem::Version.new("7.1")`
`3`	`5`	`serialize :error, coder: JSON`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`class SolidQueue::Job < SolidQueue::Record`
`2`	`4`	`include Executable`
`3`	`5`