rubocop-airbnb 1.0.0

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

@@ -0,0 +1,178 @@
+describe RuboCop::Cop::Airbnb::ConstAssignedInWrongFile do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) do
+    RuboCop::Config.new(
+      {
+        "Rails" => {
+          "Enabled" => true,
+        },
+      }
+    )
+  end
+
+  # Put source in a directory under /tmp because this cop cares about the filename
+  # but not the parent dir name.
+  let(:tmpdir) { Dir.mktmpdir }
+  let(:models_dir) do
+    gemfile = File.new("#{tmpdir}/Gemfile", "w")
+    gemfile.close
+    FileUtils.mkdir_p("#{tmpdir}/app/models").first
+  end
+
+  after do
+    FileUtils.rm_rf tmpdir
+  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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,162 @@
+describe RuboCop::Cop::Airbnb::ContinuationSlash do
+  subject(:cop) { described_class.new }
+
+  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])
+  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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    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
+    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
+    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
+    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
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+describe RuboCop::Cop::Airbnb::DefaultScope do
+  subject(:cop) { described_class.new }
+
+  it 'rejects with default_scopes' do
+    source = [
+      '# encoding: UTF-8',
+      'module SurveyQuestion',
+      '  class Host < PhraseBundle',
+      '    db_magic :connection => AIRMISC_MASTER,',
+      '             :slaves => AIRMISC_DB_SLAVES,',
+      '             :force_slave_reads => FORCE_SLAVE_READS',
+      '',
+      '    default_scope where(active: true)',
+      '',
+      '  end',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([8])
+  end
+
+  it 'passes when there is no default_scope' do
+    source = [
+      '# encoding: UTF-8',
+      'module SurveyQuestion',
+      '  class Host < PhraseBundle',
+      '    db_magic :connection => AIRMISC_MASTER,',
+      '             :slaves => AIRMISC_DB_SLAVES,',
+      '             :force_slave_reads => FORCE_SLAVE_READS',
+      '  end',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,160 @@
+describe RuboCop::Cop::Airbnb::FactoryAttrReferencesClass do
+  subject(:cop) { described_class.new }
+
+  it 'rejects with `attr_name CONST_NAME` in a factory' do
+    source = [
+      'factory :reservation2 do',
+      '  status Reservation2::STATUS_NEW',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line)).to eq([2])
+  end
+
+  it 'passes with `attr_name { CONST_NAME }` in a factory' do
+    source = [
+      'factory :reservation2 do',
+      '  status { Reservation2::STATUS_NEW }',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects with `attr_name [CONST_NAME]`' do
+    source = [
+      'factory :reservation2 do',
+      '  statuses [Reservation2::STATUS_NEW]',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line)).to eq([2])
+  end
+
+  it 'passes with `attr_name { [CONST_NAME] }`' do
+    source = [
+      'factory :reservation2 do',
+      '  statuses { [Reservation2::STATUS_NEW] }',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects with `attr_name [[CONST_NAME]]`' do
+    source = [
+      'factory :reservation2 do',
+      '  statuses [[Reservation2::STATUS_NEW]]',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line)).to eq([2])
+  end
+
+  it 'passes with `attr_name { [[CONST_NAME]] }`' do
+    source = [
+      'factory :reservation2 do',
+      '  statuses { [[Reservation2::STATUS_NEW]] }',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects with `attr_name({ ConstName => something })' do
+    source = [
+      'factory :reservation2 do',
+      '  status_names({ Reservation2::STATUS_NEW => "new" })',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line)).to eq([2])
+  end
+
+  it 'passes with `attr_name { { ConstName => something } }`' do
+    source = [
+      'factory :reservation2 do',
+      '  status_names { { Reservation2::STATUS_NEW => "new" } }',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects with `attr_name ConstName[:symbol]`' do
+    source = [
+      'factory :airlock_rule do',
+      '  stickiness Airlock::STICKINESS[:user]',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line)).to eq([2])
+  end
+
+  it 'passes with `attr_name { ConstName[:symbol] }`' do
+    source = [
+      'factory :airlock_rule do',
+      '  stickiness { Airlock::STICKINESS[:user] }',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects even if the const is not the first attr' do
+    source = [
+      'factory :reservation2 do',
+      '  trait :accepted do',
+      '    cancel_policy Hosting::CANCEL_FLEXIBLE',
+      '    status Reservation2::STATUS_NEW',
+      '  end',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(2)
+    expect(cop.offenses.map(&:line)).to eq([3, 4])
+  end
+
+  it 'rejects with `attr_name CONST_NAME` in a trait' do
+    source = [
+      'factory :reservation2 do',
+      '  trait :accepted do',
+      '    status Reservation2::STATUS_NEW',
+      '  end',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line)).to eq([3])
+  end
+
+  it 'passes with `attr_name { CONST_NAME }` in a trait' do
+    source = [
+      'factory :reservation2 do',
+      '  trait :accepted do',
+      '    status { Reservation2::STATUS_NEW }',
+      '  end',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses).to be_empty
+  end
+end