ridecharge-rubocop 0.0.1

data/spec/rubocop/cop/lint/assignment_in_condition_spec.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Lint::AssignmentInCondition, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { { 'AllowSafeAssignment' => true } }
+
+  it 'registers an offence for lvar assignment in condition' do
+    inspect_source(cop,
+                   ['if test = 10',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for lvar assignment in while condition' do
+    inspect_source(cop,
+                   ['while test = 10',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for lvar assignment in until condition' do
+    inspect_source(cop,
+                   ['until test = 10',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for ivar assignment in condition' do
+    inspect_source(cop,
+                   ['if @test = 10',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for clvar assignment in condition' do
+    inspect_source(cop,
+                   ['if @@test = 10',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for gvar assignment in condition' do
+    inspect_source(cop,
+                   ['if $test = 10',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for constant assignment in condition' do
+    inspect_source(cop,
+                   ['if TEST = 10',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'accepts == in condition' do
+    inspect_source(cop,
+                   ['if test == 10',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts = in a block that is called in a condition' do
+    inspect_source(cop,
+                   ['return 1 if any_errors? { o = inspect(file) }'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts ||= in condition' do
+    inspect_source(cop,
+                   ['raise StandardError unless foo ||= bar'])
+    expect(cop.offences).to be_empty
+  end
+
+  context 'safe assignment is allowed' do
+    it 'accepts = in condition surrounded with braces' do
+      inspect_source(cop,
+                     ['if (test = 10)',
+                      'end'
+                     ])
+      expect(cop.offences).to be_empty
+    end
+
+  end
+
+  context 'safe assignment is not allowed' do
+    let(:cop_config) { { 'AllowSafeAssignment' => false } }
+
+    it 'does not accepts = in condition surrounded with braces' do
+      inspect_source(cop,
+                     ['if (test = 10)',
+                      'end'
+                     ])
+      expect(cop.offences.size).to eq(1)
+    end
+  end
+end

data/spec/rubocop/cop/lint/block_alignment_spec.rb

@@ -0,0 +1,411 @@
+# encoding: utf-8
+# rubocop:disable LineLength
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Lint::BlockAlignment do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for mismatched block end' do
+    inspect_source(cop,
+                   ['test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with test do |ala| at 1, 0'])
+  end
+
+  context 'when the block is a logical operand' do
+    it 'accepts a correctly aligned block end' do
+      inspect_source(cop,
+                     ['(value.is_a? Array) && value.all? do |subvalue|',
+                      '  type_check_value(subvalue, array_type)',
+                      'end',
+                      'a || b do',
+                      'end'
+                     ])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  it 'accepts end aligned with a variable' do
+    inspect_source(cop,
+                   ['variable = test do |ala|',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  context 'when there is an assignment chain' do
+    it 'registers an offence for an end aligned with the 2nd variable' do
+      inspect_source(cop,
+                     ['a = b = c = test do |ala|',
+                      '    end'
+                     ])
+      expect(cop.messages)
+        .to eq(['end at 2, 4 is not aligned with a = b = c = test do |ala| at 1, 0'])
+    end
+
+    it 'accepts end aligned with the first variable' do
+      inspect_source(cop,
+                     ['a = b = c = test do |ala|',
+                      'end'
+                     ])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'and the block is an operand' do
+    it 'accepts end aligned with a variable' do
+      inspect_source(cop,
+                     ['b = 1 + preceding_line.reduce(0) do |a, e|',
+                      '  a + e.length + newline_length',
+                      'end + 1'
+                     ])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  it 'registers an offence for mismatched block end with a variable' do
+    inspect_source(cop,
+                   ['variable = test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with variable = test do |ala| at 1, 0'])
+  end
+
+  context 'when the block is defined on the next line' do
+    it 'accepts end aligned with the block expression' do
+      inspect_source(cop,
+                     ['variable =',
+                      '  a_long_method_that_dont_fit_on_the_line do |v|',
+                      '    v.foo',
+                      '  end'
+                     ])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'registers an offences for mismatched end alignment' do
+      inspect_source(cop,
+                     ['variable =',
+                      '  a_long_method_that_dont_fit_on_the_line do |v|',
+                      '    v.foo',
+                      'end'
+                     ])
+      expect(cop.messages)
+        .to eq(['end at 4, 0 is not aligned with a_long_method_that_dont_fit_on_the_line ' \
+                'do |v| at 2, 2'])
+    end
+  end
+
+  context 'when the method part is a call chain that spans several lines' do
+    # Example from issue 346 of bbatsov/rubocop on github:
+    it 'accepts pretty alignment style' do
+      src = ['def foo(bar)',
+             '  bar.get_stuffs',
+             '      .reject do |stuff| ',
+             '        stuff.with_a_very_long_expression_that_doesnt_fit_the_line',
+             '      end.select do |stuff|',
+             '        stuff.another_very_long_expression_that_doesnt_fit_the_line',
+             '      end',
+             '      .select do |stuff|',
+             '        stuff.another_very_long_expression_that_doesnt_fit_the_line',
+             '      end',
+             'end']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'registers offences for misaligned ends' do
+      src = ['def foo(bar)',
+             '  bar.get_stuffs',
+             '      .reject do |stuff|',
+             '        stuff.with_a_very_long_expression_that_doesnt_fit_the_line',
+             '        end.select do |stuff|',
+             '        stuff.another_very_long_expression_that_doesnt_fit_the_line',
+             '    end',
+             '      .select do |stuff|',
+             '        stuff.another_very_long_expression_that_doesnt_fit_the_line',
+             '        end',
+             'end']
+      inspect_source(cop, src)
+      expect(cop.messages)
+        .to eq(['end at 5, 8 is not aligned with bar.get_stuffs at 2, 2 or' \
+                ' .reject do |stuff| at 3, 6',
+                'end at 7, 4 is not aligned with bar.get_stuffs at 2, 2 or' \
+                ' end.select do |stuff| at 5, 8',
+                'end at 10, 8 is not aligned with bar.get_stuffs at 2, 2 or' \
+                ' .select do |stuff| at 8, 6'])
+    end
+
+    # Example from issue 393 of bbatsov/rubocop on github:
+    it 'accepts end indented as the start of the block' do
+      src = ['my_object.chaining_this_very_long_method(with_a_parameter)',
+             '    .and_one_with_a_block do',
+             '  do_something',
+             'end',
+             '', # Other variant:
+             'my_object.chaining_this_very_long_method(',
+             '    with_a_parameter).and_one_with_a_block do',
+             '  do_something',
+             'end']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    # Example from issue 447 of bbatsov/rubocop on github:
+    it 'accepts two kinds of end alignment' do
+      src = [
+             # Aligned with start of line where do is:
+             'params = default_options.merge(options)',
+             '          .delete_if { |k, v| v.nil? }',
+             '          .each_with_object({}) do |(k, v), new_hash|',
+             '            new_hash[k.to_s] = v.to_s',
+             '          end',
+             # Aligned with start of the whole expression:
+             'params = default_options.merge(options)',
+             '          .delete_if { |k, v| v.nil? }',
+             '          .each_with_object({}) do |(k, v), new_hash|',
+             '            new_hash[k.to_s] = v.to_s',
+             'end'
+            ]
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'when variables of a mass assignment spans several lines' do
+    it 'accepts end aligned with the variables' do
+      src = ['e,',
+             'f = [5, 6].map do |i|',
+             '  i - 5',
+             'end']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'registers an offence for end aligned with the block' do
+      src = ['e,',
+             'f = [5, 6].map do |i|',
+             '  i - 5',
+             '    end']
+      inspect_source(cop, src)
+      expect(cop.messages)
+        .to eq(['end at 4, 4 is not aligned with e, at 1, 0 or f = [5, 6].map do |i| at 2, 0'])
+    end
+  end
+
+  it 'accepts end aligned with an instance variable' do
+    inspect_source(cop,
+                   ['@variable = test do |ala|',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with an instance variable' do
+    inspect_source(cop,
+                   ['@variable = test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with @variable = test do |ala| at 1, 0'])
+  end
+
+  it 'accepts end aligned with a class variable' do
+    inspect_source(cop,
+                   ['@@variable = test do |ala|',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with a class variable' do
+    inspect_source(cop,
+                   ['@@variable = test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with @@variable = test do |ala| at 1, 0'])
+  end
+
+  it 'accepts end aligned with a global variable' do
+    inspect_source(cop,
+                   ['$variable = test do |ala|',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with a global variable' do
+    inspect_source(cop,
+                   ['$variable = test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with $variable = test do |ala| at 1, 0'])
+  end
+
+  it 'accepts end aligned with a constant' do
+    inspect_source(cop,
+                   ['CONSTANT = test do |ala|',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with a constant' do
+    inspect_source(cop,
+                   ['Module::CONSTANT = test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with Module::CONSTANT = test do |ala| at 1, 0'])
+  end
+
+  it 'accepts end aligned with a method call' do
+    inspect_source(cop,
+                   ['parser.childs << lambda do |token|',
+                    '  token << 1',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with a method call' do
+    inspect_source(cop,
+                   ['parser.childs << lambda do |token|',
+                    '  token << 1',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 3, 2 is not aligned with parser.childs << lambda do |token| at 1, 0'])
+  end
+
+  it 'accepts end aligned with a method call with arguments' do
+    inspect_source(cop,
+                   ['@h[:f] = f.each_pair.map do |f, v|',
+                    '  v = 1',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched end with a method call with arguments' do
+    inspect_source(cop,
+                   ['@h[:f] = f.each_pair.map do |f, v|',
+                    '  v = 1',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 3, 2 is not aligned with @h[:f] = f.each_pair.map do |f, v| at 1, 0'])
+  end
+
+  it 'does not raise an error for nested block in a method call' do
+    inspect_source(cop,
+                   ['expect(arr.all? { |o| o.valid? })'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts end aligned with the block when the block is a method argument' do
+    inspect_source(cop,
+                   ['expect(arr.all? do |o|',
+                    '         o.valid?',
+                    '       end)'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched end not aligned with the block that is an argument' do
+    inspect_source(cop,
+                   ['expect(arr.all? do |o|',
+                    '  o.valid?',
+                    '  end)'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 3, 2 is not aligned with arr.all? do |o| at 1, 7 or ' \
+              'expect(arr.all? do |o| at 1, 0'])
+  end
+
+  it 'accepts end aligned with an op-asgn (+=, -=)' do
+    inspect_source(cop,
+                   ['rb += files.select do |file|',
+                    '  file << something',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with an op-asgn (+=, -=)' do
+    inspect_source(cop,
+                   ['rb += files.select do |file|',
+                    '  file << something',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 3, 2 is not aligned with rb at 1, 0'])
+  end
+
+  it 'accepts end aligned with an and-asgn (&&=)' do
+    inspect_source(cop,
+                   ['variable &&= test do |ala|',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with an and-asgn (&&=)' do
+    inspect_source(cop,
+                   ['variable &&= test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with variable &&= test do |ala| at 1, 0'])
+  end
+
+  it 'accepts end aligned with an or-asgn (||=)' do
+    inspect_source(cop,
+                   ['variable ||= test do |ala|',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with an or-asgn (||=)' do
+    inspect_source(cop,
+                   ['variable ||= test do |ala|',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 2, 2 is not aligned with variable ||= test do |ala| at 1, 0'])
+  end
+
+  it 'accepts end aligned with a mass assignment' do
+    inspect_source(cop,
+                   ['var1, var2 = lambda do |test|',
+                    '  [1, 2]',
+                    'end'
+                   ])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts end aligned with a call chain left hand side' do
+    inspect_source(cop,
+                   ['parser.diagnostics.consumer = lambda do |diagnostic|',
+                    '  diagnostics << diagnostic',
+                    'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for mismatched block end with a mass assignment' do
+    inspect_source(cop,
+                   ['var1, var2 = lambda do |test|',
+                    '  [1, 2]',
+                    '  end'
+                   ])
+    expect(cop.messages)
+      .to eq(['end at 3, 2 is not aligned with var1, var2 at 1, 0'])
+  end
+end