Update Rubocop config, fix offenses

n-rodriguez · n-rodriguez · commit e7f470e66d3b · 2024-09-06T21:06:33.000+02:00
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -9,7 +9,6 @@ AllCops:
   Exclude:
     - bin/*
     - gemfiles/*
-    - spec/**/*
     - lib/store_base_sti_class_for_*.rb
 
 Gemspec/RequireMFA:
@@ -22,9 +21,39 @@ Gemspec/RequireMFA:
 Style/Documentation:
   Enabled: false
 
+Style/ArgumentsForwarding:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
 ##########
 # LAYOUT #
 ##########
 
 Layout/LineLength:
-  Max: 125
+  Max: 150
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+##########
+# NAMING #
+##########
+
+Naming/BlockForwarding:
+  Enabled: false
+
+#########
+# RSPEC #
+#########
+
+RSpec/ExampleLength:
+  Max: 8
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
diff --git a/spec/rspec_patch.rb b/spec/rspec_patch.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpecPatch
   module Expectations
     def expectation_count
@@ -11,22 +13,22 @@ def update_expectation_count
 
   module Matchers
     def expect(*args, &block)
-      ::RSpec::Expectations.update_expectation_count
+      RSpec::Expectations.update_expectation_count
       super
     end
   end
 
   module SummaryNotification
     def totals_line(*args)
       text = super
-      count  = ::RSpec::Expectations.expectation_count
-      message = RSpec::Core::Formatters::Helpers.pluralize(count, "expectation")
+      count = RSpec::Expectations.expectation_count
+      message = RSpec::Core::Formatters::Helpers.pluralize(count, 'expectation')
       "#{text.chomp}, #{message}"
     end
   end
 end
 
-unless ::RSpec::Expectations.respond_to?(:expectation_count)
+unless RSpec::Expectations.respond_to?(:expectation_count)
   RSpec::Expectations.extend(RSpecPatch::Expectations)
   RSpec::Matchers.prepend(RSpecPatch::Matchers)
   RSpec::Core::Notifications::SummaryNotification.prepend(RSpecPatch::SummaryNotification)
diff --git a/spec/store_base_sti_class_spec.rb b/spec/store_base_sti_class_spec.rb
@@ -9,12 +9,12 @@
   end
 
   after do
-    ActiveRecord::Base.store_base_sti_class = @old_store_base_sti_class
+    ActiveRecord::Base.store_base_sti_class = @old_store_base_sti_class # rubocop:disable RSpec/InstanceVariable
   end
 
   describe 'test_polymorphic_belongs_to_assignment_with_inheritance' do
     context 'when assigning a saved record' do
-      let(:post) { SpecialPost.create(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+      let(:post) { SpecialPost.create(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
       let(:tagging) { Tagging.new }
 
       it do
@@ -25,7 +25,7 @@
     end
 
     context 'when assigning a new record' do
-      let(:post) { SpecialPost.new(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+      let(:post) { SpecialPost.new(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
       let(:tagging) { Tagging.new }
 
       it do
@@ -37,7 +37,7 @@
   end
 
   describe 'test_polymorphic_has_many_create_model_with_inheritance' do
-    let(:post) { SpecialPost.new(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.new(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
     let(:misc_tag) { Tag.create(name: 'Misc') }
 
     it do
@@ -50,7 +50,7 @@
   end
 
   describe 'test_polymorphic_has_one_create_model_with_inheritance' do
-    let(:post) { SpecialPost.new(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.new(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
     let(:misc_tag) { Tag.create(name: 'Misc') }
 
     it do
@@ -76,14 +76,14 @@
     let(:tag) { SpecialTag.create!(name: 'Special') }
 
     it do
-      tag.polytagged_posts.create!(title: 'To Be or Not To Be?', body: "the body")
+      tag.polytagged_posts.create!(title: 'To Be or Not To Be?', body: 'the body')
 
       expect(tag.polytaggings.first.polytag_type).to eq 'SpecialTag'
     end
   end
 
   describe 'include_polymorphic_has_one' do
-    let(:post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
     let(:misc_tag) { Tag.create(name: 'Misc') }
 
     it do
@@ -96,8 +96,8 @@
 
   describe 'include_polymorphic_has_many' do
     let(:tag) { SpecialTag.create!(name: 'Special') }
-    let(:post) { SpecialPost.create(title: 'Thinking', body: "the body") }
-    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.create(title: 'Thinking', body: 'the body') }
+    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
 
     it do
       tag.polytagged_posts << special_post
@@ -110,8 +110,8 @@
 
   describe 'include_polymorphic_has_many_through' do
     let(:tag) { SpecialTag.create!(name: 'Special') }
-    let(:post) { SpecialPost.create(title: 'Thinking', body: "the body") }
-    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.create(title: 'Thinking', body: 'the body') }
+    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
 
     it do
       tag.polytagged_posts << special_post
@@ -124,8 +124,8 @@
 
   describe 'join_polymorhic_has_many' do
     let(:tag) { SpecialTag.create!(name: 'Special') }
-    let(:post) { SpecialPost.create(title: 'Thinking', body: "the body") }
-    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.create(title: 'Thinking', body: 'the body') }
+    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
 
     it do
       tag.polytagged_posts << special_post
@@ -137,8 +137,8 @@
 
   describe 'join_polymorhic_has_many_through' do
     let(:tag) { SpecialTag.create!(name: 'Special') }
-    let(:post) { SpecialPost.create(title: 'Thinking', body: "the body") }
-    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.create(title: 'Thinking', body: 'the body') }
+    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
 
     it do
       tag.polytagged_posts << special_post
@@ -150,8 +150,8 @@
 
   describe 'has_many_through_polymorphic_has_one' do
     let(:author) { Author.create!(name: 'Bob') }
-    let(:post) { Post.create!(title: 'Budget Forecasts Bigger 2011 Deficit', author: author, body: "the body") }
-    let(:special_post) { SpecialPost.create!(title: 'IBM Watson' 's Jeopardy play', author: author, body: "the body") }
+    let(:post) { Post.create!(title: 'Budget Forecasts Bigger 2011 Deficit', author: author, body: 'the body') }
+    let(:special_post) { SpecialPost.create!(title: 'IBM Watsons Jeopardy play', author: author, body: 'the body') }
     let(:special_tag) { SpecialTag.create!(name: 'SpecialGeneral') }
 
     it do
@@ -162,8 +162,8 @@
 
   describe 'has_many_polymorphic_with_source_type' do
     let(:tag) { SpecialTag.create!(name: 'Special') }
-    let(:post) { SpecialPost.create(title: 'Thinking', body: "the body") }
-    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: "the body") }
+    let(:post) { SpecialPost.create(title: 'Thinking', body: 'the body') }
+    let(:special_post) { SpecialPost.create!(title: 'Budget Forecasts Bigger 2011 Deficit', body: 'the body') }
 
     it do
       tag.polytagged_posts << special_post
@@ -180,7 +180,7 @@
 
   describe 'test_polymorphic_has_many_through_with_double_sti_on_join_model' do
     let(:tag) { SpecialTag.create!(name: 'Special') }
-    let(:post) { SpecialPost.create(title: 'Thinking', body: "the body") }
+    let(:post) { SpecialPost.create(title: 'Thinking', body: 'the body') }
 
     it do
       tag.polytagged_posts << post
@@ -210,7 +210,7 @@
 
   describe 'where_query' do
     let(:tag) { SpecialTag.create!(name: 'Special') }
-    let(:post) { SpecialPost.create(title: 'Thinking', body: "the body") }
+    let(:post) { SpecialPost.create(title: 'Thinking', body: 'the body') }
 
     it do
       tag.polytagged_posts << post
diff --git a/spec/support/models.rb b/spec/support/models.rb
@@ -19,8 +19,8 @@ class SpecialPost < Post
 
 class Tagging < ActiveRecord::Base
   belongs_to :tag
-  belongs_to :polytag, polymorphic:  true
-  belongs_to :taggable, polymorphic:  true, counter_cache: true
+  belongs_to :polytag, polymorphic: true
+  belongs_to :taggable, polymorphic: true, counter_cache: true
 end
 
 class Tag < ActiveRecord::Base
diff --git a/spec/support/schema.rb b/spec/support/schema.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Schema < ActiveRecord::Migration[5.0]
-  def self.up
+  def self.up # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     suppress_messages do
       create_table :authors, force: true do |t|
         t.string :name, null: false
diff --git a/spec/support/sql_counter.rb b/spec/support/sql_counter.rb
@@ -2,19 +2,32 @@
 
 # the following is needed because ActiveRecord::TestCase uses ActiveRecord::SQLCounter, which is
 # not bundled as part of the gem
+# rubocop:disable Style/RedundantSelf
 module ActiveRecord
   class SQLCounter
     class << self
       attr_accessor :ignored_sql, :log, :log_all
 
-      def clear_log;
-        self.log = []; self.log_all = [];
+      def clear_log
+        self.log = []
+        self.log_all = []
       end
     end
 
     self.clear_log
-
-    self.ignored_sql   = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/]
+    self.ignored_sql = [
+      /^PRAGMA/,
+      /^SELECT currval/,
+      /^SELECT CAST/,
+      /^SELECT @@IDENTITY/,
+      /^SELECT @@ROWCOUNT/,
+      /^SAVEPOINT/,
+      /^ROLLBACK TO SAVEPOINT/,
+      /^RELEASE SAVEPOINT/,
+      /^SHOW max_identifier_length/,
+      /^BEGIN/,
+      /^COMMIT/
+    ]
 
     # FIXME: this needs to be refactored so specific database can add their own
     # ignored SQL, or better yet, use a different notification for the queries
@@ -34,12 +47,12 @@ def initialize(ignore = Regexp.union(self.class.ignored_sql))
       @ignore = ignore
     end
 
-    def call(name, start, finish, message_id, values)
+    def call(_name, _start, _finish, _message_id, values)
       sql = values[:sql]
 
       # FIXME: this seems bad. we should probably have a better way to indicate
       # the query was cached
-      return if 'CACHE' == values[:name]
+      return if values[:name] == 'CACHE'
 
       self.class.log_all << sql
       self.class.log << sql unless ignore =~ sql
@@ -48,3 +61,4 @@ def call(name, start, finish, message_id, values)
 
   ActiveSupport::Notifications.subscribe('sql.active_record', SQLCounter.new)
 end
+# rubocop:enable Style/RedundantSelf
diff --git a/spec/support/test_helper.rb b/spec/support/test_helper.rb
@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
 module TestHelper
-  def assert_queries(num = 1, options = {})
+  # rubocop:disable Style/ZeroLengthPredicate
+  def assert_queries(num = 1, options = {}) # rubocop:disable Metrics/MethodLength
     ignore_none = options.fetch(:ignore_none) { num == :any }
     ActiveRecord::SQLCounter.clear_log
     yield
   ensure
     the_log = ignore_none ? ActiveRecord::SQLCounter.log_all : ActiveRecord::SQLCounter.log
     if num == :any
-      assert_operator the_log.size, :>=, 1, "1 or more queries expected, but none were executed."
+      assert_operator the_log.size, :>=, 1, '1 or more queries expected, but none were executed.'
     else
       mesg = "#{the_log.size} instead of #{num} queries were executed.#{the_log.size == 0 ? '' : "\nQueries:\n#{the_log.join("\n")}"}"
 
       expect(the_log.size).to eq(num), mesg
     end
   end
+  # rubocop:enable Style/ZeroLengthPredicate
 
   def assert_no_queries(&block)
     assert_queries(0, ignore_none: true, &block)
