rubocop-airbnb 1.0.0

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

@@ -0,0 +1,54 @@
+describe RuboCop::Cop::Airbnb::RiskyActiverecordInvocation do
+  subject(:cop) { described_class.new }
+
+  it "allows where statement that's a hash" do
+    source = [
+      'Users.where({:name => "Bob"})',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it "allows where statement that's a flat string" do
+    source = 'Users.where("age = 24")'
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it "allows a multiline where statement" do
+    source = "Users.where(\"age = 24 OR \" \\\n\"age = 25\")"
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it "allows interpolation in subsequent arguments to where" do
+    source = 'Users.where("name like ?", "%#{name}%")'
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it "disallows interpolation in where statements" do
+    source = 'Users.where("name = #{username}")'
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it "disallows addition in where statements" do
+    source = 'Users.where("name = " + username)'
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it "disallows interpolation in order statements" do
+    source = 'Users.where("age = 24").order("name #{sortorder}")'
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+end

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

@@ -0,0 +1,284 @@
+describe RuboCop::Cop::Airbnb::RspecDescribeOrContextUnderNamespace do
+  subject(:cop) { described_class.new }
+
+  let(:tmpdir) { Dir.mktmpdir }
+  let(:models_spec_dir) do
+    FileUtils.mkdir_p("#{tmpdir}/spec/models").first
+  end
+
+  after do
+    FileUtils.rm_rf tmpdir
+  end
+
+  shared_examples 'rspec namespacing rule' do
+    context 'under a namespace' do
+      it 'rejects without change message when argument is a string' do
+        source = [
+          'module Foo',
+          "  #{method} 'SomeClass' do",
+          '    it "passes" do',
+          '      expect(true).to be_true',
+          '    end',
+          '  end',
+          'end',
+        ].join("\n")
+
+        FileUtils.mkdir_p "#{models_spec_dir}/foo"
+        File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+          inspect_source(source, file)
+        end
+
+        expect(cop.offenses.size).to eql(1)
+        expect(cop.offenses.first.message).
+          to include('Declaring a `module` in a spec can break autoloading because ')
+
+        expect(cop.offenses.first.message).
+          not_to include(
+            "Change `#{method} SomeClass do` to `#{method} Foo::SomeClass do`"
+          )
+
+        expect(cop.offenses.first.message).
+          to include('Remove `module Foo` and fix `Foo::CONST` and `Foo.method` calls')
+      end
+
+      it 'rejects with change message when argument is a constant' do
+        source = [
+          'module Foo',
+          "  #{method} SomeClass do",
+          '    it "passes" do',
+          '      expect(true).to be_true',
+          '    end',
+          '  end',
+          'end',
+        ].join("\n")
+
+        FileUtils.mkdir_p "#{models_spec_dir}/foo"
+        File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+          inspect_source(source, file)
+        end
+
+        expect(cop.offenses.size).to eql(1)
+        expect(cop.offenses.first.message).
+          to include('Declaring a `module` in a spec can break autoloading because ')
+
+        expect(cop.offenses.first.message).
+          to include(
+            "Change `#{method} SomeClass do` to `#{method} Foo::SomeClass do`"
+          )
+
+        expect(cop.offenses.first.message).
+          to include('Remove `module Foo` and fix `Foo::CONST` and `Foo.method` calls')
+      end
+
+      it 'rejects when within a nested block' do
+        source = [
+          'module Foo',
+          '  1.times do',
+          "    #{method} SomeClass do",
+          '      it "passes" do',
+          '        expect(true).to be_true',
+          '      end',
+          '    end',
+          '  end',
+          'end',
+        ].join("\n")
+
+        FileUtils.mkdir_p "#{models_spec_dir}/foo"
+        File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+          inspect_source(source, file)
+        end
+
+        expect(cop.offenses.size).to eql(1)
+        expect(cop.offenses.first.message).
+          to include('Declaring a `module` in a spec can break autoloading because ')
+
+        expect(cop.offenses.first.message).
+          to include(
+            "Change `#{method} SomeClass do` to `#{method} Foo::SomeClass do`"
+          )
+
+        expect(cop.offenses.first.message).
+          to include('Remove `module Foo` and fix `Foo::CONST` and `Foo.method` calls')
+      end
+
+      it 'rejects when a block is executed prior' do
+        source = [
+          'module Foo',
+          '  [1,2,3].each do',
+          '    something',
+          '  end',
+          '',
+          "  #{method} SomeClass do",
+          '    it "passes" do',
+          '      expect(true).to be_true',
+          '    end',
+          '  end',
+          'end',
+        ].join("\n")
+
+        FileUtils.mkdir_p "#{models_spec_dir}/foo"
+        File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+          inspect_source(source, file)
+        end
+
+        expect(cop.offenses.size).to eql(1)
+        expect(cop.offenses.first.message).
+          to include('Declaring a `module` in a spec can break autoloading because ')
+
+        expect(cop.offenses.first.message).
+          to include(
+            "Change `#{method} SomeClass do` to `#{method} Foo::SomeClass do`"
+          )
+
+        expect(cop.offenses.first.message).
+          to include('Remove `module Foo` and fix `Foo::CONST` and `Foo.method` calls')
+      end
+    end
+  end
+
+  context 'describe' do
+    let!(:method) { 'describe' }
+
+    it_behaves_like 'rspec namespacing rule'
+  end
+
+  context 'RSpec.describe' do
+    let!(:method) { 'RSpec.describe' }
+
+    it_behaves_like 'rspec namespacing rule'
+  end
+
+  context 'context' do
+    let!(:method) { 'context' }
+
+    it_behaves_like 'rspec namespacing rule'
+  end
+
+  context 'RSpec.context' do
+    let!(:method) { 'RSpec.context' }
+
+    it_behaves_like 'rspec namespacing rule'
+  end
+
+  it 'accepts if file is not a spec file' do
+    source = [
+      'module Foo',
+      '  RSpec.describe "SomeClass" do',
+      '    it "passes" do',
+      '      expect(true).to be_true',
+      '    end',
+      '  end',
+      'end',
+    ].join("\n")
+
+    FileUtils.mkdir_p "#{models_spec_dir}/foo"
+    File.open "#{models_spec_dir}/foo/some_class.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accepts if not under a module' do
+    source = [
+      'RSpec.describe "SomeClass" do',
+      '  it "passes" do',
+      '    expect(true).to be_true',
+      '  end',
+      'end',
+    ].join("\n")
+
+    FileUtils.mkdir_p "#{models_spec_dir}/foo"
+    File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accepts if not describe or context' do
+    source = [
+      'module Foo',
+      '  not_describe_or_context "SomeClass" do',
+      '    it "passes" do',
+      '      expect(true).to be_true',
+      '    end',
+      '  end',
+      'end',
+    ].join("\n")
+
+    FileUtils.mkdir_p "#{models_spec_dir}/foo"
+    File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accepts an empty module' do
+    source = [
+      'RSpec.describe "SomeClass" do',
+      '  module Bar; end',
+      '',
+      '  it "passes" do',
+      '    expect(true).to be_true',
+      '  end',
+      'end',
+    ].join("\n")
+
+    FileUtils.mkdir_p "#{models_spec_dir}/foo"
+    File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accepts a module with code' do
+    source = [
+      'RSpec.describe "SomeClass" do',
+      '  module Bar',
+      '    def self.foo',
+      '    end',
+      '    foo',
+      '  end',
+      '',
+      '  it "passes" do',
+      '    expect(true).to be_true',
+      '  end',
+      'end',
+    ].join("\n")
+
+    FileUtils.mkdir_p "#{models_spec_dir}/foo"
+    File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accepts when describe or context to be called when class or module is not RSpec' do
+    source = [
+      'module Foo',
+      '  Bar.describe "SomeClass" do',
+      '    it "passes" do',
+      '      expect(true).to be_true',
+      '    end',
+      '  end',
+      '',
+      '  Bar.context "SomeClass" do',
+      '    it "passes" do',
+      '      expect(true).to be_true',
+      '    end',
+      '  end',
+      'end',
+    ].join("\n")
+
+    FileUtils.mkdir_p "#{models_spec_dir}/foo"
+    File.open "#{models_spec_dir}/foo/some_class_spec.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,64 @@
+describe RuboCop::Cop::Airbnb::RspecEnvironmentModification do
+  subject(:cop) { described_class.new }
+
+  before(:each) do
+    allow(cop).to receive(:is_spec_file?).and_return(true)
+  end
+
+  it 'does not allow assignment of Rails.env' do
+    source = [
+      'Rails.env = :production',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses.size).to eql(1)
+  end
+
+  it 'allows assignment of Rails.env when not in spec' do
+    allow(cop).to receive(:is_spec_file?).and_return(false)
+    source = [
+      'Rails.env = :production',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects allow style stubbing of Rails.env' do
+    source = [
+      'def some_method(a)',
+      '  allow(Rails.env).to receive(:production?)',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses.size).to eql(1)
+  end
+
+  it 'rejects expect style stubbing of Rails.env' do
+    source = [
+      'def some_method(a)',
+      '  expect(Rails.env).to receive(:production?)',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses.size).to eql(1)
+  end
+
+  it 'rejects .stub stubbing of Rails.env' do
+    source = [
+      'def some_method(a)',
+      '  Rails.env.stub(:production)',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses.size).to eql(1)
+  end
+
+  it 'allows stub_env' do
+    source = [
+      'def some_method(a)',
+      '  stub_env(:production)',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,122 @@
+describe RuboCop::Cop::Airbnb::SimpleModifierConditional do
+  subject(:cop) { described_class.new }
+
+  context 'multiple conditionals' do
+    it 'rejects with modifier if with multiple conditionals' do
+      source = [
+        'return true if some_method == 0 || another_method',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'rejects with modifier unless with multiple conditionals' do
+      source = [
+        'return true unless true && false',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'allows with modifier if operator conditional' do
+      source = [
+        'return true if some_method == 0',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'allows with modifier if with single conditional' do
+      source = [
+        'return true if some_method == 0',
+        'return true if another_method',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'allows with modifier if and unless with single conditional ' do
+      source = [
+        'return true if some_method',
+        'return true unless another_method > 5',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'allows multiple conditionals in block form' do
+      source = [
+        'if some_method == 0 && another_method > 5 || true || false',
+        ' return true',
+        'end',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses).to be_empty
+    end
+  end
+
+  context 'multiple lines' do
+    it 'rejects modifier conditionals that span multiple lines' do
+      source = [
+        'return true if true ||',
+        '               false',
+        'return true unless true ||',
+        '                   false',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses.size).to eq(2)
+    end
+
+    it 'rejects with modifier if with method that spans multiple lines' do
+      source = [
+        'return true if some_method(param1,',
+        '                           param2,',
+        '                           param3)',
+        'return true unless some_method(param1,',
+        '                               param2,',
+        '                               param3)',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses.size).to eq(2)
+    end
+
+    it 'rejects inline if/unless after a multiline statement' do
+      source = [
+        'return some_method(',
+        '  param1,',
+        '  param2,',
+        '  param3',
+        ') if another_method == 0',
+        'return some_method(',
+        '  param1,',
+        '  param2,',
+        '  param3',
+        ') unless another_method == 0',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses.size).to eq(2)
+    end
+
+    it 'allows multline conditionals in block form' do
+      source = [
+        'if some_method(param1,',
+        '               param2,',
+        '               parma3)',
+        ' return true',
+        'end',
+      ].join("\n")
+
+      inspect_source(source)
+      expect(cop.offenses).to be_empty
+    end
+  end
+end