rubocop-airbnb 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d15fbaae4390350367ffaf63eb8983bfd6b3f5b20b204a84396b1e52f7f6509
-  data.tar.gz: eb4b2cb7e6b3fb6a347c8c8aa1d3c189a5787d14b0d59db5a5993d4fe400a299
+  metadata.gz: 02cd198bf2e20a941f06c78615775bbbcf525f428a41adbd07d1ef4a7e716509
+  data.tar.gz: 1073b91470656809fb195a4eba990e9303e7389a94af1dba88728bba14ec5c4e
 SHA512:
-  metadata.gz: bc207a5af59c1eecfeaba405a3a216fae0afa3b54288b35249de115b9f6c1d5036f9ae3f692823ee0a5a3af64718cd7aef072f0e6402c6c4b305b7f6f13bdd5f
-  data.tar.gz: e99bd2c461379d8a13f20a880b2963b0d0241d8affa7028d67cff807573ffe9fe8053bd7d8bbe65174bf0d3021dd9c7a75c4456f9dd1c58e5fe340280554d5d0
+  metadata.gz: db877cf8c1eb61e805eb3a700cd489bbc2b3b61cf7b307ed2ae66e3930aa57f85e41bd14740e7117e1ff1d0c7cc0701de542b05e9bfebcb4a180dae976bd2cb1
+  data.tar.gz: 5392e711442b997a3fdccd3cc17eaec5b9d153df6803a4227221c82b20acb24a841e8643e99311c77a2be36b8283bb7afa99e00629b2c4d8a6baa73ae49c697c

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 5.0.0
+* Add support for Ruby 3.1
+* Drop support for Ruby 2.4
+* Update rubocop to 1.22.0
+* Update rubocop-rspec to 2.0.0
+* Remove deprecated cops InvalidPredicateMatcher and CustomIncludeMethods
+
 # 4.0.0
 * Add support for Ruby 3.0
 * Run CI against Ruby 2.7

data/config/default.yml

@@ -15,14 +15,6 @@ AllCops:
     - 'vendor/**/*'
     - Vagrantfile
     - Guardfile
-  RSpec:
-    Patterns:
-    - _spec.rb
-    - "(?:^|/)spec/"
-  RSpec/FactoryBot:
-    Patterns:
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
 
   # While Rubocop has released a bunch of new cops, not all of these cops have been evaluated as
   # part of this styleguide. To prevent new, unevaluated cops from imposing on this styleguide, we
@@ -33,6 +25,15 @@ AllCops:
   # https://github.com/rubocop/rubocop/blob/1e55b1aa5e4c5eaeccad5d61f08b7930ed6bc341/config/default.yml#L89-L101
   DisabledByDefault: true
 
+RSpec:
+  Include:
+  - _spec.rb
+  - "(?:^|/)spec/"
+RSpec/FactoryBot:
+  Include:
+  - spec/factories/**/*.rb
+  - features/support/factories/**/*.rb
+
 inherit_from:
   - './rubocop-airbnb.yml'
   - './rubocop-bundler.yml'

data/config/rubocop-performance.yml

@@ -1,3 +1,6 @@
+require:
+    - rubocop-performance
+
 Performance/Caller:
   Enabled: false
 

data/config/rubocop-rails.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-rails
+
 # before_action doesn't seem to exist, so this doesn't make sense.
 Rails/ActionFilter:
   Enabled: false

data/config/rubocop-rspec.yml

@@ -56,7 +56,6 @@ RSpec/DescribedClass:
 RSpec/EmptyExampleGroup:
   Description: Checks if an example group does not include any tests.
   Enabled: true
-  CustomIncludeMethods: []
 
 RSpec/EmptyLineAfterExampleGroup:
   Description: Checks if there is an empty line after example group blocks.
@@ -155,10 +154,6 @@ RSpec/InstanceVariable:
   Description: 'Checks for the usage of instance variables.'
   Enabled: false
 
-RSpec/InvalidPredicateMatcher:
-  Description: Checks invalid usage for predicate matcher.
-  Enabled: false
-
 RSpec/ItBehavesLike:
   Description: Checks that only one `it_behaves_like` style is used.
   Enabled: false
@@ -314,18 +309,18 @@ RSpec/VoidExpect:
   Description: This cop checks void `expect()`.
   Enabled: false
 
-Capybara/CurrentPathExpectation:
+RSpec/Capybara/CurrentPathExpectation:
   Description: Checks that no expectations are set on Capybara's `current_path`.
   Enabled: false
 
-Capybara/FeatureMethods:
+RSpec/Capybara/FeatureMethods:
   Description: Checks for consistent method usage in feature specs.
   Enabled: false
 
-FactoryBot/AttributeDefinedStatically:
+RSpec/FactoryBot/AttributeDefinedStatically:
   Description: Always declare attribute values as blocks.
   Enabled: false
 
-FactoryBot/CreateList:
+RSpec/FactoryBot/CreateList:
   Description: Checks for create_list usage.
   Enabled: true

data/lib/rubocop/airbnb/version.rb

@@ -3,6 +3,6 @@
 module RuboCop
   module Airbnb
     # Version information for the the Airbnb RuboCop plugin.
-    VERSION = '4.0.0'
+    VERSION = '5.0.0'
   end
 end

data/lib/rubocop/cop/airbnb/class_or_module_declared_in_wrong_file.rb

@@ -56,7 +56,7 @@ module RuboCop
       #     class Bar # nested class
       #     end
       #   end
-      class ClassOrModuleDeclaredInWrongFile < Cop
+      class ClassOrModuleDeclaredInWrongFile < Base
         include Inflections
         include RailsAutoloading
 

data/lib/rubocop/cop/airbnb/const_assigned_in_wrong_file.rb

@@ -22,7 +22,7 @@ module RuboCop
       #   module Foo
       #     BAZ = 42
       #   end
-      class ConstAssignedInWrongFile < Cop
+      class ConstAssignedInWrongFile < Base
         include Inflections
         include RailsAutoloading
 

data/lib/rubocop/cop/airbnb/continuation_slash.rb

@@ -1,7 +1,7 @@
 module RuboCop
   module Cop
     module Airbnb
-      class ContinuationSlash < Cop
+      class ContinuationSlash < Base
         MSG = 'Slash continuation should be reserved for closed string continuation. ' \
               'Many times it is used to get around other existing rules.'.freeze
 

data/lib/rubocop/cop/airbnb/default_scope.rb

@@ -3,7 +3,7 @@ module RuboCop
     module Airbnb
       # Cop to help prevent the scorge of Default Scopes from ActiveRecord.
       # Once in place they are almost impossible to remove.
-      class DefaultScope < Cop
+      class DefaultScope < Base
         MSG = 'Avoid `default_scope`.  Default scopes make it difficult to '\
               'refactor data access patterns since the scope becomes part '\
               'of every query unless explicitly excluded, even when it is '\

data/lib/rubocop/cop/airbnb/factory_attr_references_class.rb

@@ -4,7 +4,7 @@ module RuboCop
       # Cop to enforce "attr { CONST }" instead of "attr CONST" in factories,
       # because the latter forces autoload, which slows down spec startup time and
       # Zeus reload time after touching a model.
-      class FactoryAttrReferencesClass < Cop
+      class FactoryAttrReferencesClass < Base
         MSG = "Instead of attr_name MyClass::MY_CONST, use attr_name { MyClass::MY_CONST }. " \
           "This enables faster spec startup time and Zeus reload time.".freeze
 

data/lib/rubocop/cop/airbnb/factory_class_use_string.rb

@@ -3,7 +3,7 @@ module RuboCop
     module Airbnb
       # Cop to tell developers to use :class => "MyClass" instead of :class => MyClass,
       # because the latter slows down reloading zeus.
-      class FactoryClassUseString < Cop
+      class FactoryClassUseString < Base
         MSG = 'Instead of :class => MyClass, use :class => "MyClass". ' \
           "This enables faster spec startup time and faster Zeus reload time.".freeze
 

data/lib/rubocop/cop/airbnb/mass_assignment_accessible_modifier.rb

@@ -3,7 +3,7 @@ module RuboCop
     module Airbnb
       # Modifying Mass assignment restrictions eliminates the entire point of disabling
       # mass assignment. It's a lazy, potentially dangerous approach that should be discouraged.
-      class MassAssignmentAccessibleModifier < Cop
+      class MassAssignmentAccessibleModifier < Base
         MSG = 'Do no override and objects mass assignment restrictions.'.freeze
 
         def on_send(node)

data/lib/rubocop/cop/airbnb/module_method_in_wrong_file.rb

@@ -59,7 +59,7 @@ module RuboCop
       #       end
       #     end
       #   end
-      class ModuleMethodInWrongFile < Cop
+      class ModuleMethodInWrongFile < Base
         include Inflections
         include RailsAutoloading
 

data/lib/rubocop/cop/airbnb/no_timeout.rb

@@ -1,7 +1,7 @@
 module RuboCop
   module Cop
     module Airbnb
-      class NoTimeout < Cop
+      class NoTimeout < Base
         MSG =
           'Do not use Timeout.timeout. In combination with Rails autoloading, ' \
           'timeout can cause Segmentation Faults in version of Ruby we use. ' \

data/lib/rubocop/cop/airbnb/opt_arg_parameters.rb

@@ -3,7 +3,7 @@ module RuboCop
     module Airbnb
       # Cop to enforce use of options hash over default arguments
       # https://github.com/airbnb/ruby#no-default-args
-      class OptArgParameters < Cop
+      class OptArgParameters < Base
         MSG =
           'Do not use default positional arguments. '\
           'Use keyword arguments or an options hash instead.'.freeze

data/lib/rubocop/cop/airbnb/phrase_bundle_keys.rb

@@ -24,7 +24,7 @@ module RuboCop
       #       ),
       #     }
       #   end
-      class PhraseBundleKeys < Cop
+      class PhraseBundleKeys < Base
         MESSAGE =
           'Phrase bundle keys should match their translation keys.'.freeze
 

data/lib/rubocop/cop/airbnb/risky_activerecord_invocation.rb

@@ -2,7 +2,7 @@ module RuboCop
   module Cop
     module Airbnb
       # Disallow ActiveRecord calls that pass interpolated or added strings as an argument.
-      class RiskyActiverecordInvocation < Cop
+      class RiskyActiverecordInvocation < Base
         VULNERABLE_AR_METHODS = [
           :delete_all,
           :destroy_all,

data/lib/rubocop/cop/airbnb/rspec_describe_or_context_under_namespace.rb

@@ -20,7 +20,7 @@ module RuboCop
       #
       #   describe Foo::Bar
       #   end
-      class RspecDescribeOrContextUnderNamespace < Cop
+      class RspecDescribeOrContextUnderNamespace < Base
         DESCRIBE_OR_CONTEXT_UNDER_NAMESPACE_MSG =
           'Declaring a `module` in a spec can break autoloading because subsequent references ' \
           'to it will not cause it to be loaded from the app. This could cause flaky tests.'.freeze

data/lib/rubocop/cop/airbnb/rspec_environment_modification.rb

@@ -28,7 +28,7 @@ module RuboCop
       #   before(:each) do
       #     stub_env(:production)
       #   end
-      class RspecEnvironmentModification < Cop
+      class RspecEnvironmentModification < Base
         def_node_matcher :allow_or_expect_rails_env, <<-PATTERN
           (send (send nil? {:expect :allow} (send (const nil? :Rails) :env)) :to ...)
         PATTERN

data/lib/rubocop/cop/airbnb/simple_modifier_conditional.rb

@@ -3,7 +3,7 @@ module RuboCop
     module Airbnb
       # Cop to tackle prevent more complicated modifier if/unless statements
       # https://github.com/airbnb/ruby#only-simple-if-unless
-      class SimpleModifierConditional < Cop
+      class SimpleModifierConditional < Base
         MSG = 'Modifier if/unless usage is okay when the body is simple, ' \
           'the condition is simple, and the whole thing fits on one line. ' \
           'Otherwise, avoid modifier if/unless.'.freeze

data/lib/rubocop/cop/airbnb/simple_unless.rb

@@ -3,7 +3,7 @@ module RuboCop
     module Airbnb
       # Cop to tackle prevent unless statements with multiple conditions
       # https://github.com/airbnb/ruby#unless-with-multiple-conditions
-      class SimpleUnless < Cop
+      class SimpleUnless < Base
         MSG = 'Unless usage is okay when there is only one conditional'.freeze
 
         def_node_matcher :multiple_conditionals?, '(if ({and or :^} ...) ...)'

data/lib/rubocop/cop/airbnb/spec_constant_assignment.rb

@@ -25,16 +25,15 @@ module RuboCop
       #   describe Something do
       #     before { stub_const('MyClass::PAYLOAD', [1, 2, 3])
       #   end
-      class SpecConstantAssignment < Cop
-        include RuboCop::RSpec::TopLevelDescribe
+      class SpecConstantAssignment < Base
         MESSAGE = "Defining constants inside of specs can cause spurious behavior. " \
-                  "It is almost always preferable to use `let` statements, "\
+                  "It is almost always preferable to use `let` statements, " \
                   "anonymous class/module definitions, or stub_const".freeze
 
         def on_casgn(node)
           return unless in_spec_file?(node)
           parent_module_name = node.parent_module_name
-          if node.parent_module_name && parent_module_name != 'Object'
+          if parent_module_name && parent_module_name != "Object"
             return
           end
           add_offense(node, message: MESSAGE)

data/lib/rubocop/cop/airbnb/unsafe_yaml_marshal.rb

@@ -2,7 +2,7 @@ module RuboCop
   module Cop
     module Airbnb
       # Disallow use of YAML/Marshal methods that can trigger RCE on untrusted input
-      class UnsafeYamlMarshal < Cop
+      class UnsafeYamlMarshal < Base
         MSG = 'Using unsafe YAML parsing methods on untrusted input can lead ' \
               'to remote code execution. Use `safe_load`, `parse`, `parse_file`, or ' \
               '`parse_stream` instead'.freeze

data/rubocop-airbnb.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
   spec.version = RuboCop::Airbnb::VERSION
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.require_paths = ['lib']
   spec.files = Dir[
@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
     'Gemfile',
   ]
 
-  spec.add_dependency('rubocop', '~> 0.93.1')
+  spec.add_dependency('rubocop', '~> 1.22.0')
   spec.add_dependency('rubocop-performance', '~> 1.10.2')
   spec.add_dependency('rubocop-rails', '~> 2.9.1')
-  spec.add_dependency('rubocop-rspec', '~> 1.44.1')
+  spec.add_dependency('rubocop-rspec', '~> 2.0.0')
   spec.add_development_dependency('rspec', '~> 3.5')
 end

data/spec/rubocop/cop/airbnb/class_or_module_declared_in_wrong_file_spec.rb

@@ -1,6 +1,4 @@
-describe RuboCop::Cop::Airbnb::ClassOrModuleDeclaredInWrongFile do
-  subject(:cop) { described_class.new(config) }
-
+describe RuboCop::Cop::Airbnb::ClassOrModuleDeclaredInWrongFile, :config do
   let(:config) do
     RuboCop::Config.new(
       {
@@ -25,150 +23,119 @@ describe RuboCop::Cop::Airbnb::ClassOrModuleDeclaredInWrongFile do
   end
 
   it 'rejects if class declaration is in a file with non-matching name' do
-    source = [
-      'module Foo',
-      '  module Bar',
-      '    class Baz',
-      '    end',
-      '  end',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/qux.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        module Foo
+        ^^^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this class/module, move its definition to a file that matches its name. Module Foo should be defined in foo.rb.
+          module Bar
+          ^^^^^^^^^^ In order for Rails autoloading [...]
+            class Baz
+            ^^^^^^^^^ In order for Rails autoloading [...]
+            end
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses.size).to eq(3)
-    expect(cop.offenses.map(&:line).sort).to eq([1, 2, 3])
-    expect(cop.offenses.first.message).to include('Module Foo should be defined in foo.rb.')
   end
 
   it 'rejects if class declaration is in a file with matching name but wrong parent dir' do
-    source = [
-      'module Foo',
-      '  module Bar',
-      '    class Baz',
-      '    end',
-      '  end',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/baz.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        module Foo
+        ^^^^^^^^^^ In order for Rails autoloading [...]
+          module Bar
+          ^^^^^^^^^^ In order for Rails autoloading [...]
+            class Baz
+            ^^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this class/module, move its definition to a file that matches its name. Class Baz should be defined in foo/bar/baz.rb.
+            end
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses.size).to eq(3)
-    expect(cop.offenses.map(&:line).sort).to eq([1, 2, 3])
-    expect(cop.offenses.last.message).to include('Class Baz should be defined in foo/bar/baz.rb.')
   end
 
   it 'accepts if class declaration is in a file with matching name and right parent dir' do
-    source = [
-      'module Foo',
-      '  module Bar',
-      '    class Baz',
-      '    end',
-      '  end',
-      'end',
-    ].join("\n")
-
     FileUtils.mkdir_p "#{models_dir}/foo/bar"
     File.open "#{models_dir}/foo/bar/baz.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        module Foo
+          module Bar
+            class Baz
+            end
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'rejects if class declaration is in wrong dir and parent module uses ::' do
-    source = [
-      'module Foo::Bar',
-      '  class Baz',
-      '  end',
-      'end',
-    ].join("\n")
-
     FileUtils.mkdir_p "#{models_dir}/bar"
     File.open "#{models_dir}/bar/baz.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        module Foo::Bar
+        ^^^^^^^^^^^^^^^ In order for Rails autoloading [...]
+          class Baz
+          ^^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this class/module, move its definition to a file that matches its name. Class Baz should be defined in foo/bar/baz.rb.
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses.map(&:line).sort).to eq([1, 2])
-    expect(cop.offenses.last.message).to include('Class Baz should be defined in foo/bar/baz.rb.')
   end
 
   it 'accepts if class declaration is in a file with matching name and parent module uses ::' do
-    source = [
-      'module Foo::Bar',
-      '  class Baz',
-      '  end',
-      'end',
-    ].join("\n")
-
     FileUtils.mkdir_p "#{models_dir}/foo/bar"
     File.open "#{models_dir}/foo/bar/baz.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        module Foo::Bar
+          class Baz
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'accepts class declaration where the containing class uses an acronym' do
-    source = [
-      'module CSVFoo',
-      '  class Baz',
-      '  end',
-      'end',
-    ].join("\n")
-
     FileUtils.mkdir_p "#{models_dir}/csv_foo"
     File.open "#{models_dir}/csv_foo/baz.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY)
+        module CSVFoo
+          class Baz
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'ignores class/module declaration in a rake task' do
-    source = [
-      'class Baz',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/foo.rake", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        class Baz
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'suggests moving error classes into the file that defines the owning scope' do
-    source = [
-      'module Foo',
-      '  class BarError < StandardError; end',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/bar.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        module Foo
+        ^^^^^^^^^^ In order for Rails autoloading [...]
+          class BarError < StandardError; end
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this class, move its definition to a file that defines the owning module. Class BarError should be defined in foo.rb.
+        end
+      RUBY
     end
-
-    expect(cop.offenses.map(&:line)).to include(2)
-    expect(cop.offenses.map(&:message)).to include(%r{Class BarError should be defined in foo\.rb.})
   end
 
   it 'recognizes error class based on the superclass name' do
-    source = [
-      'module Foo',
-      '  class Bar < StandardError; end',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/bar.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        module Foo
+        ^^^^^^^^^^ In order for Rails autoloading [...]
+          class Bar < StandardError; end
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this class, move its definition to a file that defines the owning module. Class Bar should be defined in foo.rb.
+        end
+      RUBY
     end
-
-    expect(cop.offenses.map(&:line)).to include(2)
-    expect(cop.offenses.map(&:message)).to include(%r{Class Bar should be defined in foo\.rb.})
   end
 end