ridecharge-rubocop 0.0.1

data/spec/rubocop/cop/style/character_literal_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::CharacterLiteral do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for character literals' do
+    inspect_source(cop, ['x = ?x'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for literals like \n' do
+    inspect_source(cop, ['x = ?\n'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'accepts literals like ?\C-\M-d' do
+    inspect_source(cop, ['x = ?\C-\M-d'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts ? in a %w literal' do
+    inspect_source(cop, ['%w{? A}'])
+    expect(cop.offences).to be_empty
+  end
+
+  it "auto-corrects ?x to 'x'" do
+    new_source = autocorrect_source(cop, 'x = ?x')
+    expect(new_source).to eq("x = 'x'")
+  end
+
+  it 'auto-corrects ?\n to "\\n"' do
+    new_source = autocorrect_source(cop, 'x = ?\n')
+    expect(new_source).to eq('x = "\\n"')
+  end
+end

data/spec/rubocop/cop/style/class_and_module_camel_case_spec.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::ClassAndModuleCamelCase do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for underscore in class and module name' do
+    inspect_source(cop,
+                   ['class My_Class',
+                    'end',
+                    '',
+                    'module My_Module',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(2)
+  end
+
+  it 'is not fooled by qualified names' do
+    inspect_source(cop,
+                   ['class Top::My_Class',
+                    'end',
+                    '',
+                    'module My_Module::Ala',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(2)
+  end
+
+  it 'accepts CamelCase names' do
+    inspect_source(cop,
+                   ['class MyClass',
+                    'end',
+                    '',
+                    'module Mine',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+end

data/spec/rubocop/cop/style/class_length_spec.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::ClassLength, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { { 'Max' => 5, 'CountComments' => false } }
+
+  it 'rejects a class with more than 5 lines' do
+    inspect_source(cop, ['class Test',
+                         '  a = 1',
+                         '  a = 2',
+                         '  a = 3',
+                         '  a = 4',
+                         '  a = 5',
+                         '  a = 6',
+                         'end'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.messages).to eq(['Class definition is too long. [6/5]'])
+    expect(cop.config_to_allow_offences).to eq('Max' => 6)
+  end
+
+  it 'accepts a class with 5 lines' do
+    inspect_source(cop, ['class Test',
+                         '  a = 1',
+                         '  a = 2',
+                         '  a = 3',
+                         '  a = 4',
+                         '  a = 5',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts a class with less than 5 lines' do
+    inspect_source(cop, ['class Test',
+                         '  a = 1',
+                         '  a = 2',
+                         '  a = 3',
+                         '  a = 4',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'does not count blank lines' do
+    inspect_source(cop, ['class Test',
+                         '  a = 1',
+                         '  a = 2',
+                         '  a = 3',
+                         '  a = 4',
+                         '',
+                         '',
+                         '  a = 7',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts empty classes' do
+    inspect_source(cop, ['class Test',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  context 'when a class has inner classes' do
+    it 'does not count lines of inner classes' do
+      inspect_source(cop, ['class NamespaceClass',
+                           '  class TestOne',
+                           '    a = 1',
+                           '    a = 2',
+                           '    a = 3',
+                           '    a = 4',
+                           '    a = 5',
+                           '  end',
+                           '  class TestTwo',
+                           '    a = 1',
+                           '    a = 2',
+                           '    a = 3',
+                           '    a = 4',
+                           '    a = 5',
+                           '  end',
+                           '  a = 1',
+                           '  a = 2',
+                           '  a = 3',
+                           '  a = 4',
+                           '  a = 5',
+                           'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'rejects a class with 6 lines that belong to the class directly' do
+      inspect_source(cop, ['class NamespaceClass',
+                           '  class TestOne',
+                           '    a = 1',
+                           '    a = 2',
+                           '    a = 3',
+                           '    a = 4',
+                           '    a = 5',
+                           '  end',
+                           '  class TestTwo',
+                           '    a = 1',
+                           '    a = 2',
+                           '    a = 3',
+                           '    a = 4',
+                           '    a = 5',
+                           '  end',
+                           '  a = 1',
+                           '  a = 2',
+                           '  a = 3',
+                           '  a = 4',
+                           '  a = 5',
+                           '  a = 6',
+                           'end'])
+      expect(cop.offences.size).to eq(1)
+    end
+  end
+
+  context 'when CountComments is enabled' do
+    before { cop_config['CountComments'] = true }
+
+    it 'also counts commented lines' do
+      inspect_source(cop, ['class Test',
+                           '  a = 1',
+                           '  #a = 2',
+                           '  a = 3',
+                           '  #a = 4',
+                           '  a = 5',
+                           '  a = 6',
+                           'end'])
+      expect(cop.offences.size).to eq(1)
+    end
+  end
+end

data/spec/rubocop/cop/style/class_methods_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::ClassMethods do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for methods using a class name' do
+    inspect_source(cop,
+                   ['class Test',
+                    '  def Test.some_method',
+                    '    do_something',
+                    '  end',
+                    'end'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for methods using a module name' do
+    inspect_source(cop,
+                   ['module Test',
+                    '  def Test.some_method',
+                    '    do_something',
+                    '  end',
+                    'end'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'does not register an offence for methods using self' do
+    inspect_source(cop,
+                   ['module Test',
+                    '  def self.some_method',
+                    '    do_something',
+                    '  end',
+                    'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'does not register an offence outside class/module bodies' do
+    inspect_source(cop,
+                   ['def self.some_method',
+                    '  do_something',
+                    'end'])
+    expect(cop.offences).to be_empty
+  end
+end

data/spec/rubocop/cop/style/class_vars_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::ClassVars do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for class variable declaration' do
+    inspect_source(cop, ['class TestClass; @@test = 10; end'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.messages)
+      .to eq(['Replace class var @@test with a class instance var.'])
+  end
+
+  it 'does not register an offence for class variable usage' do
+    inspect_source(cop, ['@@test.test(20)'])
+    expect(cop.offences).to be_empty
+  end
+end

data/spec/rubocop/cop/style/collection_methods_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::CollectionMethods, :config do
+  cop_config = {
+    'PreferredMethods' => {
+      'collect' => 'map',
+      'inject' => 'reduce',
+      'detect' => 'find',
+      'find_all' => 'select'
+    }
+  }
+
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { cop_config }
+
+  cop_config['PreferredMethods'].each do |method, preferred_method|
+    it "registers an offence for #{method} with block" do
+      inspect_source(cop, ["[1, 2, 3].#{method} { |e| e + 1 }"])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(["Prefer #{preferred_method} over #{method}."])
+    end
+
+    it "registers an offence for #{method} with proc param" do
+      inspect_source(cop, ["[1, 2, 3].#{method}(&:test)"])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(["Prefer #{preferred_method} over #{method}."])
+    end
+
+    it "accepts #{method} with more than 1 param" do
+      inspect_source(cop, ["[1, 2, 3].#{method}(other, &:test)"])
+      expect(cop.offences).to be_empty
+    end
+
+    it "accepts #{method} without a block" do
+      inspect_source(cop, ["[1, 2, 3].#{method}"])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'auto-corrects to preferred method' do
+      new_source = autocorrect_source(cop, 'some.collect(&:test)')
+      expect(new_source).to eq('some.map(&:test)')
+    end
+  end
+end

data/spec/rubocop/cop/style/colon_method_call_spec.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::ColonMethodCall do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for instance method call' do
+    inspect_source(cop,
+                   ['test::method_name'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for instance method call with arg' do
+    inspect_source(cop,
+                   ['test::method_name(arg)'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for class method call' do
+    inspect_source(cop,
+                   ['Class::method_name'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for class method call with arg' do
+    inspect_source(cop,
+                   ['Class::method_name(arg, arg2)'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'does not register an offence for constant access' do
+    inspect_source(cop,
+                   ['Tip::Top::SOME_CONST'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'does not register an offence for nested class' do
+    inspect_source(cop,
+                   ['Tip::Top.some_method'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'does not register an offence for op methods' do
+    inspect_source(cop,
+                   ['Tip::Top.some_method[3]'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'does not register an offence when for constructor methods' do
+    inspect_source(cop,
+                   ['Tip::Top(some_arg)'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'auto-corrects "::" with "."' do
+    new_source = autocorrect_source(cop, 'test::method')
+    expect(new_source).to eq('test.method')
+  end
+end

data/spec/rubocop/cop/style/comment_annotation_spec.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::CommentAnnotation, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) do
+    { 'Keywords' => %w(TODO FIXME OPTIMIZE HACK REVIEW) }
+  end
+
+  it 'registers an offence for a missing colon' do
+    inspect_source(cop, ['# TODO make better'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  context 'with configured keyword' do
+    let(:cop_config) { { 'Keywords' => %w(ISSUE) } }
+
+    it 'registers an offence for a missing colon after the word' do
+      inspect_source(cop, ['# ISSUE wrong order'])
+      expect(cop.offences.size).to eq(1)
+    end
+  end
+
+  context 'when used with the clang formatter' do
+    let(:formatter) { Rubocop::Formatter::ClangStyleFormatter.new(output) }
+    let(:output) { StringIO.new }
+
+    it 'marks the annotation keyword' do
+      inspect_source(cop, ['# TODO:make better'])
+      formatter.report_file('t', cop.offences)
+      expect(output.string).to eq(["t:1:3: C: #{described_class::MSG}",
+                                   '# TODO:make better',
+                                   '  ^^^^^',
+                                   ''].join("\n"))
+    end
+  end
+
+  it 'registers an offence for lower case' do
+    inspect_source(cop, ['# fixme: does not work'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for capitalized annotation keyword' do
+    inspect_source(cop, ['# Optimize: does not work'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for upper case with colon but no note' do
+    inspect_source(cop, ['# HACK:'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'accepts upper case keyword with colon, space and note' do
+    inspect_source(cop, ['# REVIEW: not sure about this'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts upper case keyword alone' do
+    inspect_source(cop, ['# OPTIMIZE'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts a comment that is obviously a code example' do
+    inspect_source(cop, ['# Todo.destroy(1)'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts a keyword that is just the beginning of a sentence' do
+    inspect_source(cop,
+                   ["# Optimize if you want. I wouldn't recommend it.",
+                    '# Hack is a fun game.'])
+    expect(cop.offences).to be_empty
+  end
+
+  context 'when a keyword is not in the configuration' do
+    let(:cop_config) do
+      { 'Keywords' => %w(FIXME OPTIMIZE HACK REVIEW) }
+    end
+
+    it 'accepts the word without colon' do
+      inspect_source(cop, ['# TODO make better'])
+      expect(cop.offences).to be_empty
+    end
+  end
+end