rubocop-airbnb 1.0.0

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

@@ -0,0 +1,26 @@
+describe RuboCop::Cop::Airbnb::FactoryClassUseString do
+  subject(:cop) { described_class.new }
+
+  it 'rejects with :class => Model' do
+    source = [
+      'factory :help_answer, :class => Help::Answer do',
+      '  text { Faker::Company.name }',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line)).to eq([1])
+  end
+
+  it 'passes with :class => "Model"' do
+    source = [
+      'factory :help_answer, :class => "Help::Answer" do',
+      '  text { Faker::Company.name }',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,28 @@
+describe RuboCop::Cop::Airbnb::MassAssignmentAccessibleModifier do
+  subject(:cop) { described_class.new }
+
+  it 'rejects when accessible= is called' do
+    source = [
+      'def some_method',
+      '  user = User.new',
+      '  user.accessible = [:first_name, :last_name]',
+      '  user.update_attributes(:first_name => "Walter", :last_name => "Udoing")',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'accepts when accessible= is not called' do
+    source = [
+      'def some_method',
+      '  user = User.new',
+      '  user.first_name = "Walter"',
+      '  user.last_name = "Udoing"',
+      '  user.save!',
+      'end',
+    ].join("\n")
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,181 @@
+describe RuboCop::Cop::Airbnb::ModuleMethodInWrongFile 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 module method is in file with non-matching name' do
+    source = [
+      'module Hello',
+      '  module Foo',
+      '    def baz', # error is here if this file is named bar.rb
+      '      42',
+      '    end',
+      '  end',
+      'end',
+    ].join("\n")
+
+    File.open "#{models_dir}/bar.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([3])
+    expect(cop.offenses.first.message).to include("Method baz should be defined in hello/foo.rb.")
+  end
+
+  it 'accepts if module method is in file with matching name' do
+    source = [
+      'module Foo',
+      '  def baz',
+      '    42',
+      '  end',
+      '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 'rejects with "self." static methods and a non-matching name' do
+    source = [
+      'module Foo',
+      '  def self.baz',
+      '    42',
+      '  end',
+      'end',
+    ].join("\n")
+
+    File.open "#{models_dir}/bar.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([2])
+  end
+
+  it 'accepts with "self." static methods and a matching name' do
+    source = [
+      'module Foo',
+      '  def self.baz',
+      '    42',
+      '  end',
+      '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 'rejects with "<<" static methods and a non-matching name' do
+    source = [
+      'module Foo',
+      '  class << self',
+      '    def baz',
+      '      42',
+      '    end',
+      '  end',
+      'end',
+    ].join("\n")
+
+    File.open "#{models_dir}/bar.rb", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([3])
+  end
+
+  it 'accepts with "<<" static methods and a matching name' do
+    source = [
+      'module Foo',
+      '  class << self',
+      '    def baz',
+      '      42',
+      '    end',
+      '  end',
+      '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 methods defined in a nested class' do
+    source = [
+      'module Foo',
+      '  class Bar',
+      '    def qux',
+      '    end',
+      '  end',
+      '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 methods where the containing class uses an acronym' do
+    source = [
+      'module CSVFoo',
+      '  def baz',
+      '    42',
+      '  end',
+      '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 'ignores rake tasks' do
+    source = [
+      'module Hello',
+      '  def baz', # error is here if this file is named bar.rb
+      '    42',
+      '  end',
+      'end',
+    ].join("\n")
+
+    File.open "#{models_dir}/bar.rake", "w" do |file|
+      inspect_source(source, file)
+    end
+
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,30 @@
+describe RuboCop::Cop::Airbnb::NoTimeout do
+  subject(:cop) { described_class.new }
+
+  context 'send' do
+    it 'rejects Timeout.timeout' do
+      source = [
+        'def some_method(a)',
+        '  Timeout.timeout(5) do',
+        '    some_other_method(a)',
+        '  end',
+        'end',
+      ].join("\n")
+      inspect_source(source)
+      expect(cop.offenses.size).to eql(1)
+      expect(cop.offenses.first.message).to start_with('Do not use Timeout.timeout')
+    end
+
+    it 'accepts foo.timeout' do
+      source = [
+        'def some_method(a)',
+        '  foo.timeout do',
+        '    some_other_method(a)',
+        '  end',
+        'end',
+      ].join("\n")
+      inspect_source(source)
+      expect(cop.offenses).to be_empty
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+describe RuboCop::Cop::Airbnb::OptArgParameters do
+  subject(:cop) { described_class.new }
+
+  it 'allows method with no parameters' do
+    source = [
+      'def my_method',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows method with one parameter' do
+    source = [
+      'def my_method(params)',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows method with one parameter with a default hash value' do
+    source = [
+      'def my_method(params = {})',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows method named default parameters' do
+    source = [
+      'def my_method(a, b, c: 5, d: 6)',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows method with multiple parameter with a default hash value' do
+    source = [
+      'def my_method(a, b, c, params = {})',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows method with default parameter before block parameter' do
+    source = [
+      'def my_method(a, b, c, params = {}, &block)',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects method with a default parameter other than the last non-block parameter' do
+    source = [
+      'def my_method(a, b = nil, c, &block)',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'rejects method with a default parameter other than the last parameter' do
+    source = [
+      'def my_method(a, b = 5, c = nil, params = {})',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(2)
+  end
+
+  it 'rejects method where last parameter has a default value of nil' do
+    source = [
+      'def my_method(a, b, c, params = nil)',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'rejects method where last parameter has a default value of a constant' do
+    source = [
+      'def my_method(a, b, c, params = Constants::A_CONSTANT)',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+end

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

@@ -0,0 +1,74 @@
+describe RuboCop::Cop::Airbnb::PhraseBundleKeys do
+  subject(:cop) { described_class.new }
+
+  it 'generates offenses for mismatched keys in PhraseBundle classes' do
+    source = <<EOS
+# encoding: UTF-8
+module PhraseBundles
+  class Host < PhraseBundle
+
+    def phrases
+      {
+        "shortened_key" => t(
+          "my_real_translation_key",
+          default: 'Does not matter',
+        ),
+      }
+    end
+  end
+end
+EOS
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([7])
+    expect(cop.messages).to eq(
+      ['Phrase bundle keys should match their translation keys.']
+    )
+  end
+
+  it 'does not generate offenses for matching keys in PhraseBundle classes' do
+    source = <<EOS
+# encoding: UTF-8
+module PhraseBundles
+  class Host < PhraseBundle
+
+    def phrases
+      {
+        "my_real_translation_key" => t(
+          "my_real_translation_key",
+          default: 'Does not matter',
+        ),
+      }
+    end
+  end
+end
+EOS
+
+    inspect_source(source)
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'passes on t calls that are not in PhraseBundle classes' do
+    source = <<EOS
+# encoding: UTF-8
+module PhraseBundles
+  class Host
+
+    def phrases
+      {
+        "shortened_key" => t(
+          "my_real_translation_key",
+          default: 'Does not matter',
+        ),
+      }
+    end
+  end
+end
+EOS
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+end