rubocop-airbnb 3.0.2 → 5.0.0

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

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

@@ -1,6 +1,4 @@
-describe RuboCop::Cop::Airbnb::ConstAssignedInWrongFile do
-  subject(:cop) { described_class.new(config) }
-
+describe RuboCop::Cop::Airbnb::ConstAssignedInWrongFile, :config do
   let(:config) do
     RuboCop::Config.new(
       {
@@ -25,154 +23,113 @@ describe RuboCop::Cop::Airbnb::ConstAssignedInWrongFile do
   end
 
   it 'rejects if const assignment is in a file with non-matching name' do
-    source = [
-      'module Foo',
-      '  module Bar',
-      '    BAZ = 42',
-      '  end',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/qux.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        module Foo
+          module Bar
+            BAZ = 42
+            ^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this const, move the const assignment to a file that defines the owning module. Const BAZ should be defined in foo/bar.rb.
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses.map(&:line)).to include(3)
-    expect(cop.offenses.map(&:message)).to include(%r{Const BAZ should be defined in foo/bar\.rb.})
   end
 
   it 'rejects if const assignment is in a file with matching name but wrong parent dir' do
-    source = [
-      'module Foo',
-      '  module Bar',
-      '    BAZ = 42',
-      '  end',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/bar.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        module Foo
+          module Bar
+            BAZ = 42
+            ^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this const, move the const assignment to a file that defines the owning module. Const BAZ should be defined in foo/bar.rb.
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses.map(&:line)).to include(3)
-    expect(cop.offenses.map(&:message)).to include(%r{Const BAZ should be defined in foo/bar\.rb.})
   end
 
   it 'accepts if const assignment is in a file with matching name and right parent dir' do
-    source = [
-      'module Foo',
-      '  module Bar',
-      '    BAZ = 42',
-      '  end',
-      'end',
-    ].join("\n")
-
     FileUtils.mkdir "#{models_dir}/foo"
     File.open "#{models_dir}/foo/bar.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        module Foo
+          module Bar
+            BAZ = 42
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'accepts if const assignment is in a file with matching name and right parent dir' \
     'and parent modules were defined on a single line' do
-    source = [
-      'module Foo::Bar',
-      '  BAZ = 42',
-      'end',
-    ].join("\n")
-
     FileUtils.mkdir "#{models_dir}/foo"
     File.open "#{models_dir}/foo/bar.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        module Foo::Bar
+          BAZ = 42
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'accepts if const assignment is in a file whose name matches the const and right parent dir' do
-    source = [
-      'module Foo',
-      '  module Bar',
-      '    BAZ = 42',
-      '  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
+            BAZ = 42
+          end
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'ignores if const assignment is assigning something in another scope' do
-    source = [
-      'module Foo',
-      '  Bar::BAZ = 42',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/foo.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        module Foo
+          Bar::BAZ = 42
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'accepts const assignment where the containing class uses an acronym' do
-    source = [
-      'module CSVFoo',
-      '  BAZ = 42',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/csv_foo.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        module CSVFoo
+          BAZ = 42
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'suggests moving a global const into a namespace' do
-    source = [
-      'FOO = 42',
-    ].join("\n")
-
     File.open "#{models_dir}/bar.rb", "w" do |file|
-      inspect_source(source, file)
+      expect_offense(<<~RUBY, file)
+        FOO = 42
+        ^^^^^^^^ In order for Rails autoloading to be able to find and load this file when someone references this const, move the const assignment to a file that defines the owning module. Const FOO should be moved into a namespace or defined in foo.rb.
+      RUBY
     end
-
-    expect(cop.offenses.map(&:line)).to eq([1])
-    expect(cop.offenses.first.message).
-      to include('Const FOO should be moved into a namespace or defined in foo.rb.')
   end
 
   it 'ignores const assignment in global namespace in a rake task' do
-    source = [
-      'FOO = 42',
-    ].join("\n")
-
     File.open "#{models_dir}/foo.rake", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        FOO = 42
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 
   it 'ignores const assignment in a class in a rake task' do
-    source = [
-      'class Baz',
-      '  FOO = 42',
-      'end',
-    ].join("\n")
-
     File.open "#{models_dir}/foo.rake", "w" do |file|
-      inspect_source(source, file)
+      expect_no_offenses(<<~RUBY, file)
+        class Baz
+          FOO = 42
+        end
+      RUBY
     end
-
-    expect(cop.offenses).to be_empty
   end
 end

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

@@ -1,162 +1,127 @@
-describe RuboCop::Cop::Airbnb::ContinuationSlash do
-  subject(:cop) { described_class.new }
-
+describe RuboCop::Cop::Airbnb::ContinuationSlash, :config do
   it 'rejects continuations used to continue a method call with trailing dot' do
-    source = [
-      'User. \\',
-      '  first_name',
-    ].join("\n")
-    inspect_source(source)
-
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect_offense(<<~RUBY)
+      User. \\
+      ^^^^^^^ Slash continuation should be reserved [...]
+        first_name
+    RUBY
   end
 
   context 'on assignment' do
     it 'rejects on constant assignment' do
-      source = [
-        'CONSTANT = "I am a string that \\',
-        '  spans multiple lines"',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        CONSTANT = "I am a string that \\
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Slash continuation should be reserved [...]
+          spans multiple lines"
+      RUBY
     end
 
     it 'rejects on local variable assignment' do
-      source = [
-        'variable = "I am a string that \\',
-        '  spans multiple lines"',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        variable = "I am a string that \\
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Slash continuation should be reserved [...]
+          spans multiple lines"
+      RUBY
     end
 
     it 'rejects on @var assignment' do
-      source = [
-        'class SomeClass',
-        '  @class_var = "I am a string that \\',
-        '    spans multiple lines"',
-        'end',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        class SomeClass
+          @class_var = "I am a string that \\
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Slash continuation should be reserved [...]
+            spans multiple lines"
+        end
+      RUBY
     end
 
     it 'rejects on @@var assignment' do
-      source = [
-        'class SomeClass',
-        '  @@class_var = "I am a string that \\',
-        '    spans multiple lines"',
-        'end',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        class SomeClass
+          @@class_var = "I am a string that \\
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Slash continuation should be reserved [...]
+            spans multiple lines"
+        end
+      RUBY
     end
   end
 
   context 'in conditional continuation' do
     it 'rejects if with continuation \\ before operator' do
-      source = [
-        'if true \\',
-        '   && false',
-        '  return false',
-        'end',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        if true \\
+        ^^^^^^^^^ Slash continuation should be reserved [...]
+           && false
+          return false
+        end
+      RUBY
     end
 
     it 'rejects unless with continuation \\' do
-      source = [
-        'unless true \\',
-        '   && false',
-        '  return false',
-        'end',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        unless true \\
+        ^^^^^^^^^^^^^ Slash continuation should be reserved [...]
+           && false
+          return false
+        end
+      RUBY
     end
 
     it 'rejects if with continuation \\ after operator' do
-      source = [
-        'if true || \\',
-        '   false',
-        '  return false',
-        'end',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        if true || \\
+        ^^^^^^^^^^^^ Slash continuation should be reserved [...]
+           false
+          return false
+        end
+      RUBY
     end
   end
 
   context 'open string continuation' do
     it 'rejects contination with space before \\' do
-      source = [
-        'I18n.t("I am a string that \\',
-        '  spans multiple lines")',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        I18n.t("I am a string that \\
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Slash continuation should be reserved [...]
+          spans multiple lines")
+      RUBY
     end
 
     it 'rejects contination with no space before \\' do
-      source = [
-        'I18n.t(\'I am a string that \\',
-        '  spans multiple lines\')',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses.size).to eq(1)
+      expect_offense(<<~RUBY)
+        I18n.t(\'I am a string that \\
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Slash continuation should be reserved [...]
+          spans multiple lines\')
+      RUBY
     end
   end
 
   context 'closed string continuation' do
     it 'allows double quote string with no space before \\' do
-      source = [
-        'I18n.t("I am a string that "\\',
-        '  "spans multiple lines")',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses).to be_empty
+      expect_no_offenses(<<~RUBY)
+        I18n.t("I am a string that "\\
+          "spans multiple lines")
+      RUBY
     end
 
     it 'allows double quote string with space before \\' do
-      source = [
-        'I18n.t("I am a string that " \\',
-        '  "spans multiple lines")',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses).to be_empty
+      expect_no_offenses(<<~RUBY)
+        I18n.t("I am a string that " \\
+          "spans multiple lines")
+      RUBY
     end
 
     it 'allows single quote string with no space before \\' do
-      source = [
-        'I18n.t(\'I am a string that \'\\',
-        '  \'spans multiple lines\')',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses).to be_empty
+      expect_no_offenses(<<~RUBY)
+        I18n.t(\'I am a string that \'\\
+          \'spans multiple lines\')
+      RUBY
     end
 
     it 'allows single quote string with space before \\' do
-      source = [
-        'I18n.t(\'I am a string that \' \\',
-        '  \'spans multiple lines\')',
-      ].join("\n")
-      inspect_source(source)
-
-      expect(cop.offenses).to be_empty
+      expect_no_offenses(<<~RUBY)
+        I18n.t(\'I am a string that \' \\
+          \'spans multiple lines\')
+      RUBY
     end
   end
 end