rubocop 0.28.0 → 0.29.0

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

@@ -0,0 +1,293 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Style::FirstParameterIndentation, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:config) do
+    RuboCop::Config
+      .new('Style/FirstParameterIndentation' => {
+             'EnforcedStyle' => style,
+             'SupportedStyles' =>
+               %w(consistent special_for_inner_method_call
+                  special_for_inner_method_call_in_parentheses)
+           },
+           'Style/IndentationWidth' => { 'Width' => indentation_width })
+  end
+
+  shared_examples 'common behavior' do
+    context 'when IndentationWidth:Width is 2' do
+      let(:indentation_width) { 2 }
+
+      it 'registers an offense for an over-indented first parameter' do
+        inspect_source(cop, ['run(',
+                             '    :foo,',
+                             '    bar: 3',
+                             ')'])
+        expect(cop.messages).to eq(['Indent the first parameter one step ' \
+                                    'more than the previous line.'])
+        expect(cop.highlights).to eq([':foo'])
+      end
+
+      it 'registers an offense for an under-indented first parameter' do
+        inspect_source(cop, ['run(',
+                             ' :foo,',
+                             '    bar: 3',
+                             ')'])
+        expect(cop.highlights).to eq([':foo'])
+      end
+
+      context 'for assignment' do
+        it 'accepts a correctly indented first parameter and does not care ' \
+           'about the second parameter' do
+          inspect_source(cop, ['x = run(',
+                               '  :foo,',
+                               '    bar: 3',
+                               ')'])
+          expect(cop.offenses).to be_empty
+        end
+
+        context 'with line break' do
+          it 'accepts a correctly indented first parameter' do
+            inspect_source(cop, ['x =',
+                                 '  run(',
+                                 '    :foo)'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'registers an offense for an under-indented first parameter' do
+            inspect_source(cop, ['@x =',
+                                 '  run(',
+                                 '  :foo)'])
+            expect(cop.highlights).to eq([':foo'])
+          end
+        end
+      end
+
+      it 'accepts a first parameter that is not preceded by a line break' do
+        inspect_source(cop, ['run :foo,',
+                             '    bar: 3'])
+        expect(cop.offenses).to be_empty
+      end
+
+      context 'when the receiver contains a line break' do
+        it 'accepts a correctly indented first parameter' do
+          inspect_source(cop, ['puts x.',
+                               '  merge(',
+                               '    b: 2',
+                               '  )'])
+          expect(cop.offenses).to be_empty
+        end
+
+        it 'registers an offense for an over-indented first parameter' do
+          inspect_source(cop, ['puts x.',
+                               '  merge(',
+                               '      b: 2',
+                               '  )'])
+          expect(cop.messages).to eq(['Indent the first parameter one step ' \
+                                      'more than the previous line.'])
+          expect(cop.highlights).to eq(['b: 2'])
+        end
+
+        it 'accepts a correctly indented first parameter preceded by an ' \
+           'empty line' do
+          inspect_source(cop, ['puts x.',
+                               '  merge(',
+                               '',
+                               '    b: 2',
+                               '  )'])
+          expect(cop.offenses).to be_empty
+        end
+
+        context 'when preceded by a comment line' do
+          it 'accepts a correctly indented first parameter' do
+            inspect_source(cop, ['puts x.',
+                                 '  merge(',
+                                 '    # comment',
+                                 '    b: 2',
+                                 '  )'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'registers an offense for an under-indented first parameter' do
+            inspect_source(cop, ['puts x.',
+                                 '  merge(',
+                                 '  # comment',
+                                 '  b: 2',
+                                 '  )'])
+            expect(cop.messages).to eq(['Indent the first parameter one ' \
+                                        'step more than the previous line ' \
+                                        '(not counting the comment).'])
+            expect(cop.highlights).to eq(['b: 2'])
+          end
+        end
+      end
+
+      it 'accepts method calls with no parameters' do
+        inspect_source(cop, ['run()',
+                             'run_again'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'accepts operator calls' do
+        inspect_source(cop, ['params = default_cfg.keys - %w(Description) -',
+                             '         cfg.keys'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'does not view []= as an outer method call' do
+        inspect_source(cop, ['@subject_results[subject] = original.update(',
+                             '  mutation_results: (dup << mutation_result),',
+                             '  tests:            test_result.tests',
+                             ')'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'does not view chained call as an outer method call' do
+        inspect_source(cop, ['  A = Regexp.union(',
+                             '    /[A-Za-z_][A-Za-z\d_]*[!?=]?/,',
+                             '    *AST::Types::OPERATOR_METHODS.map(&:to_s)',
+                             '  ).freeze'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'auto-corrects an under-indented first parameter' do
+        new_source = autocorrect_source(cop, ['x =',
+                                              '  run(',
+                                              '  :foo,',
+                                              '    bar: 3',
+                                              ')'])
+        expect(new_source).to eq(['x =',
+                                  '  run(',
+                                  '    :foo,',
+                                  '    bar: 3',
+                                  ')'].join("\n"))
+      end
+    end
+
+    context 'when IndentationWidth:Width is 4' do
+      let(:indentation_width) { 4 }
+
+      it 'auto-corrects an over-indented first parameter' do
+        new_source = autocorrect_source(cop, ['run(',
+                                              '        :foo,',
+                                              '    bar: 3)'])
+        expect(new_source).to eq(['run(',
+                                  '    :foo,',
+                                  '    bar: 3)'].join("\n"))
+      end
+    end
+  end
+
+  context 'when EnforcedStyle is special_for_inner_method_call' do
+    let(:style) { 'special_for_inner_method_call' }
+    let(:indentation_width) { 2 }
+
+    include_examples 'common behavior'
+
+    context 'for method calls within method calls' do
+      context 'with outer parentheses' do
+        it 'registers an offense for an over-indented first parameter' do
+          inspect_source(cop, ['run(:foo, defaults.merge(',
+                               '                        bar: 3))'])
+          expect(cop.messages).to eq(['Indent the first parameter one step ' \
+                                      'more than `defaults.merge(`.'])
+          expect(cop.highlights).to eq(['bar: 3'])
+        end
+      end
+
+      context 'without outer parentheses' do
+        it 'accepts a first parameter with special indentation' do
+          inspect_source(cop, ['run :foo, defaults.merge(',
+                               '            bar: 3)'])
+          expect(cop.offenses).to be_empty
+        end
+      end
+
+      it 'auto-corrects an over-indented first parameter' do
+        new_source = autocorrect_source(cop,
+                                        ['run(:foo, defaults.merge(',
+                                         '                        bar: 3))'])
+        expect(new_source).to eq(['run(:foo, defaults.merge(',
+                                  '            bar: 3))'].join("\n"))
+      end
+    end
+  end
+
+  context 'when EnforcedStyle is ' \
+          'special_for_inner_method_call_in_parentheses' do
+    let(:style) { 'special_for_inner_method_call_in_parentheses' }
+    let(:indentation_width) { 2 }
+
+    include_examples 'common behavior'
+
+    context 'for method calls within method calls' do
+      context 'with outer parentheses' do
+        it 'registers an offense for an over-indented first parameter' do
+          inspect_source(cop, ['run(:foo, defaults.merge(',
+                               '                        bar: 3))'])
+          expect(cop.messages).to eq(['Indent the first parameter one step ' \
+                                      'more than `defaults.merge(`.'])
+          expect(cop.highlights).to eq(['bar: 3'])
+        end
+
+        it 'registers an offense for an under-indented first parameter' do
+          inspect_source(cop, ['run(:foo, defaults.',
+                               '          merge(',
+                               '  bar: 3))'])
+          expect(cop.messages).to eq(['Indent the first parameter one step ' \
+                                      'more than the previous line.'])
+          expect(cop.highlights).to eq(['bar: 3'])
+        end
+      end
+
+      context 'without outer parentheses' do
+        it 'accepts a first parameter with consistent style indentation' do
+          inspect_source(cop, ['run :foo, defaults.merge(',
+                               '  bar: 3)'])
+          expect(cop.offenses).to be_empty
+        end
+      end
+
+      it 'auto-corrects an over-indented first parameter' do
+        new_source = autocorrect_source(cop,
+                                        ['run(:foo, defaults.merge(',
+                                         '                        bar: 3))'])
+        expect(new_source).to eq(['run(:foo, defaults.merge(',
+                                  '            bar: 3))'].join("\n"))
+      end
+    end
+  end
+
+  context 'when EnforcedStyle is consistent' do
+    let(:style) { 'consistent' }
+    let(:indentation_width) { 2 }
+
+    include_examples 'common behavior'
+
+    context 'for method calls within method calls' do
+      it 'registers an offense for an over-indented first parameter' do
+        inspect_source(cop, ['run(:foo, defaults.merge(',
+                             '            bar: 3))'])
+        expect(cop.messages).to eq(['Indent the first parameter one step ' \
+                                    'more than the previous line.'])
+        expect(cop.highlights).to eq(['bar: 3'])
+      end
+
+      it 'accepts first parameter indented relative to previous line' do
+        inspect_source(cop,
+                       ['  @diagnostics.process(Diagnostic.new(',
+                        '    :error, :token, { :token => name }, location))'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'auto-corrects an over-indented first parameter' do
+        new_source = autocorrect_source(cop,
+                                        ['run(:foo, defaults.merge(',
+                                         '                        bar: 3))'])
+        expect(new_source).to eq(['run(:foo, defaults.merge(',
+                                  '  bar: 3))'].join("\n"))
+      end
+    end
+  end
+end

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

@@ -45,12 +45,12 @@ describe RuboCop::Cop::Style::For, :config do
     end
 
     it 'accepts :for' do
-      inspect_source(cop, ['[:for, :ala, :bala]'])
+      inspect_source(cop, '[:for, :ala, :bala]')
       expect(cop.offenses).to be_empty
     end
 
     it 'accepts def for' do
-      inspect_source(cop, ['def for; end'])
+      inspect_source(cop, 'def for; end')
       expect(cop.offenses).to be_empty
     end
   end

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

@@ -9,7 +9,7 @@ describe RuboCop::Cop::Style::FormatString, :config do
     let(:cop_config) { { 'EnforcedStyle' => 'sprintf' } }
     it 'registers an offense for a string followed by something' do
       inspect_source(cop,
-                     ['puts "%d" % 10'])
+                     'puts "%d" % 10')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `sprintf` over `String#%`.'])
@@ -17,7 +17,7 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'registers an offense for something followed by an array' do
       inspect_source(cop,
-                     ['puts x % [10, 11]'])
+                     'puts x % [10, 11]')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `sprintf` over `String#%`.'])
@@ -25,23 +25,23 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'does not register an offense for numbers' do
       inspect_source(cop,
-                     ['puts 10 % 4'])
+                     'puts 10 % 4')
       expect(cop.offenses).to be_empty
     end
 
     it 'does not register an offense for ambiguous cases' do
       inspect_source(cop,
-                     ['puts x % 4'])
+                     'puts x % 4')
       expect(cop.offenses).to be_empty
 
       inspect_source(cop,
-                     ['puts x % Y'])
+                     'puts x % Y')
       expect(cop.offenses).to be_empty
     end
 
     it 'works if the first operand contains embedded expressions' do
       inspect_source(cop,
-                     ['puts "#{x * 5} %d #{@test}" % 10'])
+                     'puts "#{x * 5} %d #{@test}" % 10')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `sprintf` over `String#%`.'])
@@ -49,7 +49,15 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'registers an offense for format' do
       inspect_source(cop,
-                     ['format(something, a, b)'])
+                     'format(something, a, b)')
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Favor `sprintf` over `format`.'])
+    end
+
+    it 'registers an offense for format with 2 arguments' do
+      inspect_source(cop,
+                     'format("%X", 123)')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `sprintf` over `format`.'])
@@ -61,7 +69,7 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'registers an offense for a string followed by something' do
       inspect_source(cop,
-                     ['puts "%d" % 10'])
+                     'puts "%d" % 10')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `format` over `String#%`.'])
@@ -69,7 +77,7 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'registers an offense for something followed by an array' do
       inspect_source(cop,
-                     ['puts x % [10, 11]'])
+                     'puts x % [10, 11]')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `format` over `String#%`.'])
@@ -77,23 +85,23 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'does not register an offense for numbers' do
       inspect_source(cop,
-                     ['puts 10 % 4'])
+                     'puts 10 % 4')
       expect(cop.offenses).to be_empty
     end
 
     it 'does not register an offense for ambiguous cases' do
       inspect_source(cop,
-                     ['puts x % 4'])
+                     'puts x % 4')
       expect(cop.offenses).to be_empty
 
       inspect_source(cop,
-                     ['puts x % Y'])
+                     'puts x % Y')
       expect(cop.offenses).to be_empty
     end
 
     it 'works if the first operand contains embedded expressions' do
       inspect_source(cop,
-                     ['puts "#{x * 5} %d #{@test}" % 10'])
+                     'puts "#{x * 5} %d #{@test}" % 10')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `format` over `String#%`.'])
@@ -101,7 +109,15 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'registers an offense for sprintf' do
       inspect_source(cop,
-                     ['sprintf(something, a, b)'])
+                     'sprintf(something, a, b)')
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Favor `format` over `sprintf`.'])
+    end
+
+    it 'registers an offense for sprintf with 2 arguments' do
+      inspect_source(cop,
+                     "sprintf('%020d', 123)")
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `format` over `sprintf`.'])
@@ -113,7 +129,7 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'registers an offense for format' do
       inspect_source(cop,
-                     ['format(something, a, b)'])
+                     'format(something, a, b)')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `String#%` over `format`.'])
@@ -121,39 +137,47 @@ describe RuboCop::Cop::Style::FormatString, :config do
 
     it 'registers an offense for sprintf' do
       inspect_source(cop,
-                     ['sprintf(something, a, b)'])
+                     'sprintf(something, a, b)')
       expect(cop.offenses.size).to eq(1)
       expect(cop.messages)
         .to eq(['Favor `String#%` over `sprintf`.'])
     end
 
+    it 'registers an offense for sprintf with 3 arguments' do
+      inspect_source(cop,
+                     'format("%d %04x", 123, 123)')
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.messages)
+        .to eq(['Favor `String#%` over `format`.'])
+    end
+
     it 'accepts format with 1 argument' do
       inspect_source(cop,
-                     ['format :xml'])
+                     'format :xml')
       expect(cop.offenses).to be_empty
     end
 
     it 'accepts sprintf with 1 argument' do
       inspect_source(cop,
-                     ['sprintf :xml'])
+                     'sprintf :xml')
       expect(cop.offenses).to be_empty
     end
 
     it 'accepts format without arguments' do
       inspect_source(cop,
-                     ['format'])
+                     'format')
       expect(cop.offenses).to be_empty
     end
 
     it 'accepts sprintf without arguments' do
       inspect_source(cop,
-                     ['sprintf'])
+                     'sprintf')
       expect(cop.offenses).to be_empty
     end
 
     it 'accepts String#%' do
       inspect_source(cop,
-                     ['puts "%d" % 10'])
+                     'puts "%d" % 10')
       expect(cop.offenses).to be_empty
     end
   end