ridecharge-rubocop 0.0.1

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

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::RegexpLiteral, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { { 'MaxSlashes' => 1 } }
+
+  context 'when a regexp uses // delimiters' do
+    context 'when MaxSlashes is 1' do
+      it 'registers an offence for two slashes in regexp' do
+        inspect_source(cop, ['x =~ /home\/\//',
+                             'y =~ /etc\/top\//'])
+        expect(cop.messages)
+          .to eq(['Use %r for regular expressions matching more ' \
+                  "than 1 '/' character."] * 2)
+        expect(cop.config_to_allow_offences).to eq('MaxSlashes' => 2)
+      end
+
+      it 'accepts zero or one slash in regexp' do
+        inspect_source(cop, ['x =~ /\/home/',
+                             'y =~ /\//',
+                             'w =~ /\//m',
+                             'z =~ /a/'])
+        expect(cop.offences).to be_empty
+      end
+    end
+
+    context 'when MaxSlashes is 0' do
+      let(:cop_config) { { 'MaxSlashes' => 0 } }
+
+      it 'registers an offence for one slash in regexp' do
+        inspect_source(cop, ['x =~ /home\//'])
+        expect(cop.messages)
+          .to eq(['Use %r for regular expressions matching more ' \
+                  "than 0 '/' characters."])
+        expect(cop.config_to_allow_offences).to eq('MaxSlashes' => 1)
+      end
+
+      it 'accepts zero slashes in regexp' do
+        inspect_source(cop, ['z =~ /a/'])
+        expect(cop.offences).to be_empty
+      end
+
+      it 'registers an offence for zero slashes in regexp' do
+        inspect_source(cop, ['y =~ %r(etc)'])
+        expect(cop.messages)
+          .to eq(['Use %r only for regular expressions matching more ' \
+                  "than 0 '/' characters."])
+        expect(cop.config_to_allow_offences).to eq('MaxSlashes' => 1)
+      end
+
+      it 'accepts regexp with one slash' do
+        inspect_source(cop, ['x =~ %r(/home)'])
+        expect(cop.offences).to be_empty
+      end
+    end
+
+    it 'ignores slashes do not belong regexp' do
+      inspect_source(cop, ['x =~ /\s{#{x[/\s+/].length}}/'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'when a regexp uses %r delimiters' do
+    context 'when MaxSlashes is 1' do
+      it 'registers an offence for zero or one slash in regexp' do
+        inspect_source(cop, ['x =~ %r(/home)',
+                             'y =~ %r(etc)'])
+        expect(cop.messages)
+          .to eq(['Use %r only for regular expressions matching more ' \
+                  "than 1 '/' character."] * 2)
+        expect(cop.config_to_allow_offences).to eq('MaxSlashes' => 2)
+      end
+
+      it 'accepts regexp with two or more slashes' do
+        inspect_source(cop, ['x =~ %r(/home/)',
+                             'y =~ %r(/////)'])
+        expect(cop.offences).to be_empty
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::RescueModifier do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for modifier rescue' do
+    inspect_source(cop,
+                   ['method rescue handle'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.messages)
+      .to eq(['Avoid using rescue in its modifier form.'])
+  end
+
+  it 'handles more complex expression with modifier rescue' do
+    inspect_source(cop,
+                   ['method1 or method2 rescue handle'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.messages)
+      .to eq(['Avoid using rescue in its modifier form.'])
+  end
+
+  it 'handles modifier rescue in normal rescue' do
+    inspect_source(cop,
+                   ['begin',
+                    '  test rescue modifier_handle',
+                    'rescue',
+                    '  normal_handle',
+                    'end'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.offences.first.line).to eq(2)
+  end
+
+  it 'does not register an offence for normal rescue' do
+    inspect_source(cop,
+                   ['begin',
+                    '  test',
+                    'rescue',
+                    '  handle',
+                    'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'does not register an offence for normal rescue with ensure' do
+    inspect_source(cop,
+                   ['begin',
+                    '  test',
+                    'rescue',
+                    '  handle',
+                    'ensure',
+                    '  cleanup',
+                    'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'does not register an offence for nested normal rescue' do
+    inspect_source(cop,
+                   ['begin',
+                    '  begin',
+                    '    test',
+                    '  rescue',
+                    '    handle_inner',
+                    '  end',
+                    'rescue',
+                    '  handle_outer',
+                    'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  context 'when an instance method has implicit begin' do
+    it 'accepts normal rescue' do
+      inspect_source(cop,
+                     ['def some_method',
+                      '  test',
+                      'rescue',
+                      '  handle',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'handles modifier rescue in body of implicit begin' do
+      inspect_source(cop,
+                     ['def some_method',
+                      '  test rescue modifier_handle',
+                      'rescue',
+                      '  normal_handle',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.offences.first.line).to eq(2)
+    end
+  end
+
+  context 'when a singleton method has implicit begin' do
+    it 'accepts normal rescue' do
+      inspect_source(cop,
+                     ['def self.some_method',
+                      '  test',
+                      'rescue',
+                      '  handle',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'handles modifier rescue in body of implicit begin' do
+      inspect_source(cop,
+                     ['def self.some_method',
+                      '  test rescue modifier_handle',
+                      'rescue',
+                      '  normal_handle',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.offences.first.line).to eq(2)
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::Semicolon, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { { 'AllowAsExpressionSeparator' => false } }
+
+  it 'registers an offence for a single expression' do
+    inspect_source(cop,
+                   ['puts "this is a test";'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for several expressions' do
+    inspect_source(cop,
+                   ['puts "this is a test"; puts "So is this"'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for one line method with two statements' do
+    inspect_source(cop,
+                   ['def foo(a) x(1); y(2); z(3); end'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'accepts semicolon before end if so configured' do
+    inspect_source(cop,
+                   ['def foo(a) z(3); end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts semicolon after params if so configured' do
+    inspect_source(cop,
+                   ['def foo(a); z(3) end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts one line method definitions' do
+    inspect_source(cop,
+                   ['def foo1; x(3) end',
+                    'def initialize(*_); end',
+                    'def foo2() x(3); end',
+                    'def foo3; x(3); end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts one line empty class definitions' do
+    inspect_source(cop,
+                   ['# Prefer a single-line format for class ...',
+                    'class Foo < Exception; end',
+                    '',
+                    'class Bar; end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts one line empty method definitions' do
+    inspect_source(cop,
+                   ['# One exception to the rule are empty-body methods',
+                    'def no_op; end',
+                    '',
+                    'def foo; end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts one line empty module definitions' do
+    inspect_source(cop,
+                   ['module Foo; end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for semicolon at the end no matter what' do
+    inspect_source(cop,
+                   ['module Foo; end;'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'accept semicolons inside strings' do
+    inspect_source(cop,
+                   ['string = ";',
+                    'multi-line string"'])
+    expect(cop.offences).to be_empty
+  end
+
+  context 'when AllowAsExpressionSeparator is true' do
+    let(:cop_config) { { 'AllowAsExpressionSeparator' => true } }
+
+    it 'accepts several expressions' do
+      inspect_source(cop,
+                     ['puts "this is a test"; puts "So is this"'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts one line method with two statements' do
+      inspect_source(cop,
+                     ['def foo(a) x(1); y(2); z(3); end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+end

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

@@ -0,0 +1,266 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::SignalException, :config do
+  subject(:cop) { described_class.new(config) }
+
+  context 'when enforced style is `semantic`' do
+    let(:cop_config) { { 'EnforcedStyle' => 'semantic' } }
+
+    it 'registers an offence for raise in begin section' do
+      inspect_source(cop,
+                     ['begin',
+                      '  raise',
+                      'rescue Exception',
+                      '  #do nothing',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Use `fail` instead of `raise` to signal exceptions.'])
+    end
+
+    it 'registers an offence for raise in def body' do
+      inspect_source(cop,
+                     ['def test',
+                      '  raise',
+                      'rescue Exception',
+                      '  #do nothing',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Use `fail` instead of `raise` to signal exceptions.'])
+    end
+
+    it 'registers an offence for fail in rescue section' do
+      inspect_source(cop,
+                     ['begin',
+                      '  fail',
+                      'rescue Exception',
+                      '  fail',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Use `raise` instead of `fail` to rethrow exceptions.'])
+    end
+
+    it 'accepts raise in rescue section' do
+      inspect_source(cop,
+                     ['begin',
+                      '  fail',
+                      'rescue Exception',
+                      '  raise RuntimeError',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'registers an offence for fail in def rescue section' do
+      inspect_source(cop,
+                     ['def test',
+                      '  fail',
+                      'rescue Exception',
+                      '  fail',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Use `raise` instead of `fail` to rethrow exceptions.'])
+    end
+
+    it 'registers only offence for one raise that should be fail' do
+      # This is a special case that has caused double reporting.
+      inspect_source(cop,
+                     ['map do',
+                      "  raise 'I'",
+                      'end.flatten.compact'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Use `fail` instead of `raise` to signal exceptions.'])
+    end
+
+    it 'accepts raise in def rescue section' do
+      inspect_source(cop,
+                     ['def test',
+                      '  fail',
+                      'rescue Exception',
+                      '  raise',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'registers an offence for raise not in a begin/rescue/end' do
+      inspect_source(cop,
+                     ["case cop_config['EnforcedStyle']",
+                      "when 'single_quotes' then true",
+                      "when 'double_quotes' then false",
+                      "else raise 'Unknown StringLiterals style'",
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Use `fail` instead of `raise` to signal exceptions.'])
+    end
+
+    it 'registers one offence for each raise' do
+      inspect_source(cop,
+                     ['cop.stub(:on_def) { raise RuntimeError }',
+                      'cop.stub(:on_def) { raise RuntimeError }'])
+      expect(cop.offences.size).to eq(2)
+      expect(cop.messages)
+        .to eq(['Use `fail` instead of `raise` to signal exceptions.'] * 2)
+    end
+
+    it 'is not confused by nested begin/rescue' do
+      inspect_source(cop,
+                     ['begin',
+                      '  raise',
+                      '  begin',
+                      '    raise',
+                      '  rescue',
+                      '    fail',
+                      '  end',
+                      'rescue Exception',
+                      '  #do nothing',
+                      'end'])
+      expect(cop.offences.size).to eq(3)
+      expect(cop.messages)
+        .to eq(['Use `fail` instead of `raise` to signal exceptions.'] * 2 +
+               ['Use `raise` instead of `fail` to rethrow exceptions.'])
+    end
+
+    it 'auto-corrects raise to fail when appropriate' do
+      new_source = autocorrect_source(cop,
+                                      ['begin',
+                                       '  raise',
+                                       'rescue Exception',
+                                       '  raise',
+                                       'end'])
+      expect(new_source).to eq(['begin',
+                                '  fail',
+                                'rescue Exception',
+                                '  raise',
+                                'end'].join("\n"))
+    end
+
+    it 'auto-corrects fail to raise when appropriate' do
+      new_source = autocorrect_source(cop,
+                                      ['begin',
+                                       '  fail',
+                                       'rescue Exception',
+                                       '  fail',
+                                       'end'])
+      expect(new_source).to eq(['begin',
+                                '  fail',
+                                'rescue Exception',
+                                '  raise',
+                                'end'].join("\n"))
+    end
+  end
+
+  context 'when enforced style is `raise`' do
+    let(:cop_config) { { 'EnforcedStyle' => 'only_raise' } }
+
+    it 'registers an offence for fail in begin section' do
+      inspect_source(cop,
+                     ['begin',
+                      '  fail',
+                      'rescue Exception',
+                      '  #do nothing',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Always use `raise` to signal exceptions.'])
+    end
+
+    it 'registers an offence for fail in def body' do
+      inspect_source(cop,
+                     ['def test',
+                      '  fail',
+                      'rescue Exception',
+                      '  #do nothing',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Always use `raise` to signal exceptions.'])
+    end
+
+    it 'registers an offence for fail in rescue section' do
+      inspect_source(cop,
+                     ['begin',
+                      '  raise',
+                      'rescue Exception',
+                      '  fail',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Always use `raise` to signal exceptions.'])
+    end
+
+    it 'auto-corrects fail to raise always' do
+      new_source = autocorrect_source(cop,
+                                      ['begin',
+                                       '  fail',
+                                       'rescue Exception',
+                                       '  fail',
+                                       'end'])
+      expect(new_source).to eq(['begin',
+                                '  raise',
+                                'rescue Exception',
+                                '  raise',
+                                'end'].join("\n"))
+    end
+
+  end
+
+  context 'when enforced style is `fail`' do
+    let(:cop_config) { { 'EnforcedStyle' => 'only_fail' } }
+
+    it 'registers an offence for raise in begin section' do
+      inspect_source(cop,
+                     ['begin',
+                      '  raise',
+                      'rescue Exception',
+                      '  #do nothing',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Always use `fail` to signal exceptions.'])
+    end
+
+    it 'registers an offence for raise in def body' do
+      inspect_source(cop,
+                     ['def test',
+                      '  raise',
+                      'rescue Exception',
+                      '  #do nothing',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Always use `fail` to signal exceptions.'])
+    end
+
+    it 'registers an offence for raise in rescue section' do
+      inspect_source(cop,
+                     ['begin',
+                      '  fail',
+                      'rescue Exception',
+                      '  raise',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Always use `fail` to signal exceptions.'])
+    end
+
+    it 'auto-corrects raise to fail always' do
+      new_source = autocorrect_source(cop,
+                                      ['begin',
+                                       '  raise',
+                                       'rescue Exception',
+                                       '  raise',
+                                       'end'])
+      expect(new_source).to eq(['begin',
+                                '  fail',
+                                'rescue Exception',
+                                '  fail',
+                                'end'].join("\n"))
+    end
+  end
+end