ridecharge-rubocop 0.0.1

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

@@ -0,0 +1,99 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::Blocks do
+  subject(:cop) { described_class.new }
+
+  it 'accepts a multiline block with do-end' do
+    inspect_source(cop, ['each do |x|',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for a single line block with do-end' do
+    inspect_source(cop, ['each do |x| end'])
+    expect(cop.messages)
+      .to eq(['Prefer {...} over do...end for single-line blocks.'])
+  end
+
+  it 'accepts a single line block with braces' do
+    inspect_source(cop, ['each { |x| }'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'auto-corrects do and end for single line blocks to { and }' do
+    new_source = autocorrect_source(cop, 'block do |x| end')
+    expect(new_source).to eq('block { |x| }')
+  end
+
+  context 'when there are braces around a multi-line block' do
+    it 'registers an offence in the simple case' do
+      inspect_source(cop, ['each { |x|',
+                           '}'])
+      expect(cop.messages)
+        .to eq(['Avoid using {...} for multi-line blocks.'])
+    end
+
+    it 'accepts braces if do-end would change the meaning' do
+      src = ['scope :foo, lambda { |f|',
+             '  where(condition: "value")',
+             '}',
+             '',
+             'expect { something }.to raise_error(ErrorClass) { |error|',
+             '  # ...',
+             '}',
+             '',
+             'expect { x }.to change {',
+             '  Counter.count',
+             '}.from(0).to(1)']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'registers an offence for braces if do-end would not change ' \
+      'the meaning' do
+      src = ['scope :foo, (lambda { |f|',
+             '  where(condition: "value")',
+             '})',
+             '',
+             'expect { something }.to(raise_error(ErrorClass) { |error|',
+             '  # ...',
+             '})']
+      inspect_source(cop, src)
+      expect(cop.offences.size).to eq(2)
+    end
+
+    it 'can handle special method names such as []= and done?' do
+      src = ['h2[k2] = Hash.new { |h3,k3|',
+             '  h3[k3] = 0',
+             '}',
+             '',
+             'x = done? list.reject { |e|',
+             '  e.nil?',
+             '}']
+      inspect_source(cop, src)
+      expect(cop.messages)
+        .to eq(['Avoid using {...} for multi-line blocks.'])
+    end
+
+    it 'auto-corrects { and } to do and end' do
+      source = <<-END.strip_indent
+        each{ |x|
+          some_method
+          other_method
+        }
+      END
+
+      expected_source = <<-END.strip_indent
+        each do |x|
+          some_method
+          other_method
+        end
+      END
+
+      new_source = autocorrect_source(cop, source)
+      expect(new_source).to eq(expected_source)
+    end
+  end
+end

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

@@ -0,0 +1,284 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::BracesAroundHashParameters, :config do
+  subject(:cop) { described_class.new(config) }
+
+  context 'no_braces' do
+    let(:cop_config) do
+      { 'EnforcedStyle' => 'no_braces' }
+    end
+
+    describe 'accepts' do
+      it 'one non-hash parameter' do
+        inspect_source(cop, ['where(2)'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one empty hash parameter' do
+        inspect_source(cop, ['where({})'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one hash parameter with separators' do
+        inspect_source(cop, ["where(  {     \n }\t   )  "])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'multiple non-hash parameters' do
+        inspect_source(cop, ['where(1, "2")'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one hash parameter without braces' do
+        inspect_source(cop, ['where(x: "y")'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one hash parameter without braces and multiple keys' do
+        inspect_source(cop, ['where(x: "y", foo: "bar")'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one hash parameter without braces and one hash value' do
+        inspect_source(cop, ['where(x: { "y" => "z" })'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'multiple hash parameters with braces' do
+        inspect_source(cop, ['where({ x: 1 }, { y: 2 })'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'property assignment with braces' do
+        inspect_source(cop, ['x.z = { y: "z" }'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'operator with a hash parameter with braces' do
+        inspect_source(cop, ['x.z - { y: "z" }'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+    end
+
+    describe 'registers an offence for' do
+      it 'one non-hash parameter followed by a hash parameter with braces' do
+        inspect_source(cop, ['where(1, { y: 2 })'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['{ y: 2 }'])
+        expect(cop.config_to_allow_offences).to eq('EnforcedStyle' => 'braces')
+      end
+
+      it 'correct + opposite style' do
+        inspect_source(cop, ['where(1, y: 2)',
+                             'where(1, { y: 2 })'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+      end
+
+      it 'opposite + correct style' do
+        inspect_source(cop, ['where(1, { y: 2 })',
+                             'where(1, y: 2)'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+      end
+
+      it 'one object method hash parameter with braces' do
+        inspect_source(cop, ['x.func({ y: "z" })'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['{ y: "z" }'])
+      end
+
+      it 'one hash parameter with braces' do
+        inspect_source(cop, ['where({ x: 1 })'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['{ x: 1 }'])
+      end
+
+      it 'one hash parameter with braces and separators' do
+        inspect_source(cop, ["where(  \n { x: 1 }   )"])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['{ x: 1 }'])
+      end
+
+      it 'one hash parameter with braces and multiple keys' do
+        inspect_source(cop, ['where({ x: 1, foo: "bar" })'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['{ x: 1, foo: "bar" }'])
+      end
+    end
+
+    describe 'auto-corrects' do
+      it 'one non-hash parameter followed by a hash parameter with braces' do
+        corrected = autocorrect_source(cop, ['where(1, { y: 2 })'])
+        expect(corrected).to eq 'where(1,  y: 2 )'
+      end
+
+      it 'one object method hash parameter with braces' do
+        corrected = autocorrect_source(cop, ['x.func({ y: "z" })'])
+        expect(corrected).to eq 'x.func( y: "z" )'
+      end
+
+      it 'one hash parameter with braces' do
+        corrected = autocorrect_source(cop, ['where({ x: 1 })'])
+        expect(corrected).to eq 'where( x: 1 )'
+      end
+
+      it 'one hash parameter with braces and separators' do
+        corrected = autocorrect_source(cop, ["where(  \n { x: 1 }   )"])
+        expect(corrected).to eq "where(  \n  x: 1    )"
+      end
+
+      it 'one hash parameter with braces and multiple keys' do
+        corrected = autocorrect_source(cop, ['where({ x: 1, foo: "bar" })'])
+        expect(corrected).to eq 'where( x: 1, foo: "bar" )'
+      end
+
+      it 'one hash parameter with braces and a trailing comma' do
+        corrected = autocorrect_source(cop, ['where({ x: 1, y: 2, })'])
+        expect(corrected).to eq 'where( x: 1, y: 2 )'
+      end
+    end
+  end
+
+  context 'braces' do
+    let(:cop_config) do
+      { 'EnforcedStyle' => 'braces' }
+    end
+
+    describe 'accepts' do
+      it 'an empty hash parameter' do
+        inspect_source(cop, ['where({})'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one non-hash parameter' do
+        inspect_source(cop, ['where(2)'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'multiple non-hash parameters' do
+        inspect_source(cop, ['where(1, "2")'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one hash parameter with braces' do
+        inspect_source(cop, ['where({ x: 1 })'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'multiple hash parameters with braces' do
+        inspect_source(cop, ['where({ x: 1 }, { y: 2 })'])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one hash parameter with braces and spaces around it' do
+        inspect_source(cop, [
+          'where(     {  x: 1  }   )'
+        ])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+
+      it 'one hash parameter with braces and separators around it' do
+        inspect_source(cop, ["where( \t    {  x: 1 \n  }   )"])
+        expect(cop.messages).to be_empty
+        expect(cop.highlights).to be_empty
+      end
+    end
+
+    describe 'registers an offence for' do
+      it 'one hash parameter without braces' do
+        inspect_source(cop, ['where(x: "y")'])
+        expect(cop.messages).to eq([
+          'Missing curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['x: "y"'])
+        expect(cop.config_to_allow_offences).to eq('EnforcedStyle' =>
+                                                   'no_braces')
+      end
+
+      it 'opposite + correct style' do
+        inspect_source(cop, ['where(y: 2)',
+                             'where({ y: 2 })'])
+        expect(cop.messages).to eq([
+          'Missing curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+      end
+
+      it 'correct + opposite style' do
+        inspect_source(cop, ['where({ y: 2 })',
+                             'where(y: 2)'])
+        expect(cop.messages).to eq([
+          'Missing curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+      end
+
+      it 'one hash parameter with multiple keys and without braces' do
+        inspect_source(cop, ['where(x: "y", foo: "bar")'])
+        expect(cop.messages).to eq([
+          'Missing curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['x: "y", foo: "bar"'])
+      end
+
+      it 'one hash parameter without braces with one hash value' do
+        inspect_source(cop, ['where(x: { "y" => "z" })'])
+        expect(cop.messages).to eq([
+          'Missing curly braces around a hash parameter.'
+        ])
+        expect(cop.highlights).to eq(['x: { "y" => "z" }'])
+      end
+    end
+
+    describe 'auto-corrects' do
+      it 'one hash parameter without braces' do
+        corrected = autocorrect_source(cop, ['where(x: "y")'])
+        expect(corrected).to eq 'where({x: "y"})'
+      end
+
+      it 'one hash parameter with multiple keys and without braces' do
+        corrected = autocorrect_source(cop, ['where(x: "y", foo: "bar")'])
+        expect(corrected).to eq 'where({x: "y", foo: "bar"})'
+      end
+
+      it 'one hash parameter without braces with one hash value' do
+        corrected = autocorrect_source(cop, ['where(x: { "y" => "z" })'])
+        expect(corrected).to eq 'where({x: { "y" => "z" }})'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::CaseEquality do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for ===' do
+    inspect_source(cop, ['Array === var'])
+    expect(cop.offences.size).to eq(1)
+  end
+end

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

@@ -0,0 +1,289 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::CaseIndentation do
+  subject(:cop) { described_class.new(config) }
+  let(:config) do
+    merged = Rubocop::ConfigLoader
+      .default_configuration['CaseIndentation'].merge(cop_config)
+    Rubocop::Config.new('CaseIndentation' => merged)
+  end
+
+  context 'with IndentWhenRelativeTo: case' do
+    context 'with IndentOneStep: false' do
+      let(:cop_config) do
+        { 'IndentWhenRelativeTo' => 'case', 'IndentOneStep' => false }
+      end
+
+      context 'regarding assignment where the right hand side is a case' do
+        it 'accepts a correcty indented assignment' do
+          source = ['output = case variable',
+                    "         when 'value1'",
+                    "           'output1'",
+                    '         else',
+                    "           'output2'",
+                    '         end']
+          inspect_source(cop, source)
+          expect(cop.offences).to be_empty
+        end
+
+        it 'registers on offence for an assignment indented as end' do
+          source = ['output = case variable',
+                    "when 'value1'",
+                    "  'output1'",
+                    'else',
+                    "  'output2'",
+                    'end']
+          inspect_source(cop, source)
+          expect(cop.messages).to eq(['Indent when as deep as case.'])
+          expect(cop.config_to_allow_offences).to eq('IndentWhenRelativeTo' =>
+                                                     'end')
+        end
+
+        it 'registers on offence for an assignment indented some other way' do
+          source = ['output = case variable',
+                    "  when 'value1'",
+                    "    'output1'",
+                    '  else',
+                    "    'output2'",
+                    'end']
+          inspect_source(cop, source)
+          expect(cop.messages).to eq(['Indent when as deep as case.'])
+          expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+        end
+
+        it 'registers on offence for correct + opposite' do
+          source = ['output = case variable',
+                    "         when 'value1'",
+                    "           'output1'",
+                    '         else',
+                    "           'output2'",
+                    '         end',
+                    'output = case variable',
+                    "when 'value1'",
+                    "  'output1'",
+                    'else',
+                    "  'output2'",
+                    'end']
+          inspect_source(cop, source)
+          expect(cop.messages).to eq(['Indent when as deep as case.'])
+          expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+        end
+      end
+
+      it "registers an offence for a when clause that's deeper than case" do
+        source = ['case a',
+                  '    when 0 then return',
+                  '    else',
+                  '        case b',
+                  '         when 1 then return',
+                  '        end',
+                  'end']
+        inspect_source(cop, source)
+        expect(cop.messages).to eq(['Indent when as deep as case.'] * 2)
+      end
+
+      it "accepts a when clause that's equally indented with case" do
+        source = ['y = case a',
+                  '    when 0 then break',
+                  '    when 0 then return',
+                  '    else',
+                  '      z = case b',
+                  '          when 1 then return',
+                  '          when 1 then break',
+                  '          end',
+                  '    end',
+                  'case c',
+                  'when 2 then encoding',
+                  'end',
+                  '']
+        inspect_source(cop, source)
+        expect(cop.offences).to be_empty
+      end
+
+      it "doesn't get confused by strings with case in them" do
+        source = ['a = "case"',
+                  'case x',
+                  'when 0',
+                  'end',
+                  '']
+        inspect_source(cop, source)
+        expect(cop.messages).to be_empty
+      end
+
+      it "doesn't get confused by symbols named case or when" do
+        source = ['KEYWORDS = { :case => true, :when => true }',
+                  'case type',
+                  'when 0',
+                  '  ParameterNode',
+                  'when 1',
+                  '  MethodCallNode',
+                  'end',
+                  '']
+        inspect_source(cop, source)
+        expect(cop.messages).to be_empty
+      end
+
+      it 'accepts correctly indented whens in complex combinations' do
+        source = ['each {',
+                  '  case state',
+                  '  when 0',
+                  '    case name',
+                  '    when :a',
+                  '    end',
+                  '  when 1',
+                  '    loop {',
+                  '      case name',
+                  '      when :b',
+                  '      end',
+                  '    }',
+                  '  end',
+                  '}',
+                  'case s',
+                  'when Array',
+                  'end',
+                  '']
+        inspect_source(cop, source)
+        expect(cop.messages).to be_empty
+      end
+    end
+
+    context 'with IndentOneStep: true' do
+      let(:cop_config) do
+        { 'IndentWhenRelativeTo' => 'case', 'IndentOneStep' => true }
+      end
+
+      context 'regarding assignment where the right hand side is a case' do
+        it 'accepts a correcty indented assignment' do
+          source = ['output = case variable',
+                    "           when 'value1'",
+                    "             'output1'",
+                    '           else',
+                    "             'output2'",
+                    '         end']
+          inspect_source(cop, source)
+          expect(cop.offences).to be_empty
+        end
+
+        it 'registers on offence for an assignment indented some other way' do
+          source = ['output = case variable',
+                    "         when 'value1'",
+                    "           'output1'",
+                    '         else',
+                    "           'output2'",
+                    '         end']
+          inspect_source(cop, source)
+          expect(cop.messages).to eq(['Indent when one step more than case.'])
+        end
+      end
+
+      it "accepts a when clause that's 2 spaces deeper than case" do
+        source = ['case a',
+                  '  when 0 then return',
+                  '  else',
+                  '        case b',
+                  '          when 1 then return',
+                  '        end',
+                  'end']
+        inspect_source(cop, source)
+        expect(cop.offences).to be_empty
+      end
+
+      it "registers an offence for  a when clause that's equally indented " \
+        'with case' do
+        source = ['y = case a',
+                  '    when 0 then break',
+                  '    when 0 then return',
+                  '      z = case b',
+                  '          when 1 then return',
+                  '          when 1 then break',
+                  '          end',
+                  '    end',
+                  'case c',
+                  'when 2 then encoding',
+                  'end',
+                  '']
+        inspect_source(cop, source)
+        expect(cop.messages)
+          .to eq(['Indent when one step more than case.'] * 5)
+      end
+    end
+  end
+
+  context 'with IndentWhenRelativeTo: end' do
+    context 'with IndentOneStep: false' do
+      let(:cop_config) do
+        { 'IndentWhenRelativeTo' => 'end', 'IndentOneStep' => false }
+      end
+
+      context 'regarding assignment where the right hand side is a case' do
+        it 'accepts a correcty indented assignment' do
+          source = ['output = case variable',
+                    "when 'value1'",
+                    "  'output1'",
+                    'else',
+                    "  'output2'",
+                    'end']
+          inspect_source(cop, source)
+          expect(cop.offences).to be_empty
+        end
+
+        it 'registers on offence for an assignment indented some other way' do
+          source = ['output = case variable',
+                    "  when 'value1'",
+                    "    'output1'",
+                    '  else',
+                    "    'output2'",
+                    'end']
+          inspect_source(cop, source)
+          expect(cop.messages).to eq(['Indent when as deep as end.'])
+        end
+      end
+    end
+
+    context 'with IndentOneStep: true' do
+      let(:cop_config) do
+        { 'IndentWhenRelativeTo' => 'end', 'IndentOneStep' => true }
+      end
+
+      context 'regarding assignment where the right hand side is a case' do
+        it 'accepts a correcty indented assignment' do
+          source = ['output = case variable',
+                    "  when 'value1'",
+                    "    'output1'",
+                    '  else',
+                    "    'output2'",
+                    'end']
+          inspect_source(cop, source)
+          expect(cop.offences).to be_empty
+        end
+
+        it 'registers on offence for an assignment indented as case' do
+          source = ['output = case variable',
+                    "         when 'value1'",
+                    "           'output1'",
+                    '         else',
+                    "           'output2'",
+                    '         end']
+          inspect_source(cop, source)
+          expect(cop.messages).to eq(['Indent when one step more than end.'])
+          expect(cop.config_to_allow_offences).to eq('IndentWhenRelativeTo' =>
+                                                     'case')
+        end
+
+        it 'registers on offence for an assignment indented some other way' do
+          source = ['output = case variable',
+                    "       when 'value1'",
+                    "         'output1'",
+                    '       else',
+                    "         'output2'",
+                    '       end']
+          inspect_source(cop, source)
+          expect(cop.messages).to eq(['Indent when one step more than end.'])
+          expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+        end
+      end
+    end
+  end
+end