Unify frozen_string_literal comment style (#1003)

* Unify `frozen_string_litteral` comment syle Some file used ```ruby class ... ``` other used ```ruby class ... ``` This commit makes the style same in every file, I've opeted to same style that Rails uses, and majority of other projects. * Enable rubocop rule --------- Co-authored-by: Ben Sheldon [he/him] <[email protected]>
bensheldon · Jul 10, 2023 · e6be97f · e6be97f
1 parent 06150f9
commit e6be97f
Show file tree

Hide file tree

Showing 131 changed files with 131 additions and 1 deletion.
diff --git a/.mdstyle.rb b/.mdstyle.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
 all
 rule 'MD007', indent: 4 # Unordered list indentation

diff --git a/.rubocop.yml b/.rubocop.yml
@@ -32,7 +32,7 @@ Gemspec/DevelopmentDependencies:
   Enabled: false
 
 Layout/EmptyLineAfterMagicComment:
-  Enabled: false
+  Enabled: true
 
 Layout/HashAlignment:
   Enabled: false

diff --git a/.yard_support.rb b/.yard_support.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'kramdown'
 require 'kramdown-parser-gfm'
 

diff --git a/Appraisals b/Appraisals
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 ruby_27_or_higher = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
 ruby_31_or_higher = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.1')
 jruby = RUBY_PLATFORM.include?('java')

diff --git a/Gemfile b/Gemfile
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 

diff --git a/Rakefile b/Rakefile
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError

diff --git a/app/controllers/good_job/application_controller.rb b/app/controllers/good_job/application_controller.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception

diff --git a/app/controllers/good_job/batches_controller.rb b/app/controllers/good_job/batches_controller.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class BatchesController < GoodJob::ApplicationController
     def index

diff --git a/app/controllers/good_job/cron_entries_controller.rb b/app/controllers/good_job/cron_entries_controller.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class CronEntriesController < GoodJob::ApplicationController
     before_action :check_settings_migration!, only: [:enable, :disable]

diff --git a/app/controllers/good_job/frontends_controller.rb b/app/controllers/good_job/frontends_controller.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class FrontendsController < ActionController::Base # rubocop:disable Rails/ApplicationController
     skip_after_action :verify_same_origin_request, raise: false

diff --git a/app/controllers/good_job/jobs_controller.rb b/app/controllers/good_job/jobs_controller.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class JobsController < GoodJob::ApplicationController
     DISCARD_MESSAGE = "Discarded through dashboard"

diff --git a/app/controllers/good_job/processes_controller.rb b/app/controllers/good_job/processes_controller.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class ProcessesController < GoodJob::ApplicationController
     def index

diff --git a/app/filters/good_job/base_filter.rb b/app/filters/good_job/base_filter.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class BaseFilter
     DEFAULT_LIMIT = 25

diff --git a/app/filters/good_job/batches_filter.rb b/app/filters/good_job/batches_filter.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class BatchesFilter < BaseFilter
     def records

diff --git a/app/filters/good_job/jobs_filter.rb b/app/filters/good_job/jobs_filter.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   class JobsFilter < BaseFilter
     def states

diff --git a/app/helpers/good_job/application_helper.rb b/app/helpers/good_job/application_helper.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ApplicationHelper
     def format_duration(sec)

diff --git a/app/models/concerns/good_job/error_events.rb b/app/models/concerns/good_job/error_events.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Shared methods for filtering Execution/Job records from the +good_jobs+ table.
   module ErrorEvents

diff --git a/app/models/concerns/good_job/filterable.rb b/app/models/concerns/good_job/filterable.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Shared methods for filtering Execution/Job records from the +good_jobs+ table.
   module Filterable

diff --git a/app/models/concerns/good_job/reportable.rb b/app/models/concerns/good_job/reportable.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module Reportable
     # There are 3 buckets of non-overlapping statuses:

diff --git a/app/models/good_job/base_record.rb b/app/models/good_job/base_record.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   ACTIVE_RECORD_PARENT_CLASS = Object.const_get(GoodJob.active_record_parent_class)
 

diff --git a/app/models/good_job/cron_entry.rb b/app/models/good_job/cron_entry.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "concurrent/hash"
 require "concurrent/scheduled_task"
 require "fugit"

diff --git a/app/models/good_job/execution.rb b/app/models/good_job/execution.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # ActiveRecord model that represents an +ActiveJob+ job.
   class Execution < BaseExecution

diff --git a/app/models/good_job/execution_result.rb b/app/models/good_job/execution_result.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Stores the results of job execution
   class ExecutionResult

diff --git a/app/models/good_job/job.rb b/app/models/good_job/job.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # ActiveRecord model that represents an +ActiveJob+ job.
   # There is not a table in the database whose discrete rows represents "Jobs".

diff --git a/app/models/good_job/lockable.rb b/app/models/good_job/lockable.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # Adds Postgres advisory locking capabilities to an ActiveRecord record.

diff --git a/app/models/good_job/process.rb b/app/models/good_job/process.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'socket'
 
 module GoodJob # :nodoc:

diff --git a/config/routes.rb b/config/routes.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 GoodJob::Engine.routes.draw do
   root to: redirect(path: 'jobs')
 

diff --git a/exe/good_job b/exe/good_job
@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 require 'good_job/cli'
 
 GoodJob::CLI.within_exe = true

diff --git a/good_job.gemspec b/good_job.gemspec
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_paths = ["lib"]
 require_paths.each do |require_path|
   $LOAD_PATH.push File.expand_path(require_path, __dir__)

diff --git a/lib/active_job/queue_adapters/good_job_adapter.rb b/lib/active_job/queue_adapters/good_job_adapter.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveJob # :nodoc:
   module QueueAdapters # :nodoc:
     # See {GoodJob::Adapter} for details.

diff --git a/lib/generators/good_job/install_generator.rb b/lib/generators/good_job/install_generator.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/active_record'
 

diff --git a/lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb b/lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
   def change
     # Uncomment for Postgres v12 or earlier to enable gen_random_uuid() support

diff --git a/lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb b/lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobs < ActiveRecord::Migration<%= migration_version %>
   def change
     # Uncomment for Postgres v12 or earlier to enable gen_random_uuid() support

diff --git a/lib/generators/good_job/templates/update/migrations/02_create_good_job_settings.rb.erb b/lib/generators/good_job/templates/update/migrations/02_create_good_job_settings.rb.erb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobSettings < ActiveRecord::Migration<%= migration_version %>
   def change
     reversible do |dir|

diff --git a/...e/migrations/03_create_index_good_jobs_jobs_on_priority_created_at_when_unfinished.rb.erb b/...e/migrations/03_create_index_good_jobs_jobs_on_priority_created_at_when_unfinished.rb.erb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateIndexGoodJobsJobsOnPriorityCreatedAtWhenUnfinished < ActiveRecord::Migration<%= migration_version %>
   disable_ddl_transaction!
 

diff --git a/lib/generators/good_job/templates/update/migrations/04_create_good_job_batches.rb.erb b/lib/generators/good_job/templates/update/migrations/04_create_good_job_batches.rb.erb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobBatches < ActiveRecord::Migration<%= migration_version %>
   def change
     reversible do |dir|

diff --git a/lib/generators/good_job/templates/update/migrations/05_create_good_job_executions.rb.erb b/lib/generators/good_job/templates/update/migrations/05_create_good_job_executions.rb.erb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobExecutions < ActiveRecord::Migration<%= migration_version %>
   def change
     reversible do |dir|

diff --git a/lib/generators/good_job/templates/update/migrations/06_create_good_jobs_error_event.rb.erb b/lib/generators/good_job/templates/update/migrations/06_create_good_jobs_error_event.rb.erb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateGoodJobsErrorEvent < ActiveRecord::Migration<%= migration_version %>
   def change
     reversible do |dir|

diff --git a/lib/generators/good_job/update_generator.rb b/lib/generators/good_job/update_generator.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/active_record'
 

diff --git a/lib/good_job.rb b/lib/good_job.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "active_job"
 require "active_job/queue_adapters"
 

diff --git a/lib/good_job/active_job_extensions/batches.rb b/lib/good_job/active_job_extensions/batches.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     module Batches

diff --git a/lib/good_job/active_job_extensions/concurrency.rb b/lib/good_job/active_job_extensions/concurrency.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     module Concurrency

diff --git a/lib/good_job/active_job_extensions/interrupt_errors.rb b/lib/good_job/active_job_extensions/interrupt_errors.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     module InterruptErrors

diff --git a/lib/good_job/active_job_extensions/notify_options.rb b/lib/good_job/active_job_extensions/notify_options.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   module ActiveJobExtensions
     # Allows configuring whether GoodJob should emit a NOTIFY event when a job is enqueued.

diff --git a/lib/good_job/adapter.rb b/lib/good_job/adapter.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # ActiveJob Adapter.

diff --git a/lib/good_job/assignable_connection.rb b/lib/good_job/assignable_connection.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob # :nodoc:
   # Extends an ActiveRecord odel to override the connection and use
   # an explicit connection that has been removed from the pool.

diff --git a/lib/good_job/bulk.rb b/lib/good_job/bulk.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 
 module GoodJob

diff --git a/lib/good_job/capsule.rb b/lib/good_job/capsule.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # A GoodJob::Capsule contains the resources necessary to execute jobs, including
   # a {GoodJob::Scheduler}, {GoodJob::Poller}, {GoodJob::Notifier}, and {GoodJob::CronManager}.

diff --git a/lib/good_job/cleanup_tracker.rb b/lib/good_job/cleanup_tracker.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob # :nodoc:
   # Tracks thresholds for cleaning up old jobs.
   class CleanupTracker

diff --git a/lib/good_job/cli.rb b/lib/good_job/cli.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'thor'
 
 module GoodJob

diff --git a/lib/good_job/configuration.rb b/lib/good_job/configuration.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # +GoodJob::Configuration+ provides normalized configuration information to

diff --git a/lib/good_job/cron_manager.rb b/lib/good_job/cron_manager.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "concurrent/hash"
 require "concurrent/scheduled_task"
 require "fugit"

diff --git a/lib/good_job/current_thread.rb b/lib/good_job/current_thread.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 
 module GoodJob

diff --git a/lib/good_job/daemon.rb b/lib/good_job/daemon.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # Manages daemonization of the current process.

diff --git a/lib/good_job/engine.rb b/lib/good_job/engine.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Ruby on Rails integration.
   class Engine < ::Rails::Engine

diff --git a/lib/good_job/interrupt_error.rb b/lib/good_job/interrupt_error.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Exception raised when a job is interrupted by a SIGKILL or power failure.
   class InterruptError < StandardError

diff --git a/lib/good_job/job_performer.rb b/lib/good_job/job_performer.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'concurrent/delay'
 
 module GoodJob

diff --git a/lib/good_job/log_subscriber.rb b/lib/good_job/log_subscriber.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   #
   # Listens to GoodJob notifications and logs them.

diff --git a/lib/good_job/metrics.rb b/lib/good_job/metrics.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob # :nodoc:
   # Metrics for the scheduler.
   class Metrics

diff --git a/lib/good_job/multi_scheduler.rb b/lib/good_job/multi_scheduler.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # Delegates the interface of a single {Scheduler} to multiple Schedulers.
   class MultiScheduler

diff --git a/lib/good_job/notifier.rb b/lib/good_job/notifier.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/core_ext/module/attribute_accessors_per_thread'
 require 'concurrent/atomic/atomic_boolean'
 require "good_job/notifier/process_heartbeat"

diff --git a/lib/good_job/poller.rb b/lib/good_job/poller.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'concurrent/atomic/atomic_boolean'
 
 module GoodJob # :nodoc:

diff --git a/lib/good_job/scheduler.rb b/lib/good_job/scheduler.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "concurrent/executor/thread_pool_executor"
 require "concurrent/executor/timer_set"
 require "concurrent/scheduled_task"

diff --git a/lib/good_job/version.rb b/lib/good_job/version.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GoodJob
   # GoodJob gem version.
   VERSION = '3.15.14'

diff --git a/spec/app/charts/good_job/scheduled_by_queue_chart_spec.rb b/spec/app/charts/good_job/scheduled_by_queue_chart_spec.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails_helper'
 
 RSpec.describe GoodJob::ScheduledByQueueChart do

diff --git a/spec/app/controllers/good_job/application_controller_spec.rb b/spec/app/controllers/good_job/application_controller_spec.rb
@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "rails_helper"
 
 RSpec.describe GoodJob::ApplicationController, type: :controller do