rubocop 0.20.1 → 0.21.0

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module Rubocop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.20.1'
+    STRING = '0.21.0'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/relnotes/v0.21.0.md

@@ -0,0 +1,45 @@
+This release brings a few new cops and extended auto-correction support. The most significant
+change is that we've changed the syntax for excluding/including to be closer to that of shell globbing.
+
+Below is the list of all the gory details. Enjoy!
+
+
+### New features
+
+* [#835](https://github.com/bbatsov/rubocop/issues/835): New cop `UnneededCapitalW` checks for `%W` when interpolation not necessary and `%w` would do. ([@sfeldon][])
+* [#934](https://github.com/bbatsov/rubocop/issues/934): New cop `UnderscorePrefixedVariableName` checks for `_`-prefixed variables that are actually used. ([@yujinakayama][])
+* [#934](https://github.com/bbatsov/rubocop/issues/934): New cop `UnusedMethodArgument` checks for unused method arguments. ([@yujinakayama][])
+* [#934](https://github.com/bbatsov/rubocop/issues/934): New cop `UnusedBlockArgument` checks for unused block arguments. ([@yujinakayama][])
+* [#964](https://github.com/bbatsov/rubocop/issues/964): `RedundantBegin` cop does auto-correction. ([@tamird][])
+* [#966](https://github.com/bbatsov/rubocop/issues/966): `RescueException` cop does auto-correction. ([@tamird][])
+* [#967](https://github.com/bbatsov/rubocop/issues/967): `TrivialAccessors` cop does auto-correction. ([@tamird][])
+* [#963](https://github.com/bbatsov/rubocop/issues/963): Add `AllowDSLWriters` options to `TrivialAccessors`. ([@tamird][])
+* [#969](https://github.com/bbatsov/rubocop/issues/969): Let the `Debugger` cop check for forgotten calls to byebug. ([@bquorning][])
+* [#971](https://github.com/bbatsov/rubocop/issues/971): Configuration format deprecation warnings include the path to the problematic config file. ([@bcobb][])
+* [#490](https://github.com/bbatsov/rubocop/issues/490): Add EnforcedStyle config option to TrailingBlankLines. ([@jonas054][])
+* Add `auto_correct` task to Rake integration. ([@irrationalfab][])
+* [#986](https://github.com/bbatsov/rubocop/issues/986): The `--only` option can take a comma-separated list of cops. ([@jonas054][])
+* New Rails cop `Delegate` that checks for delegations that could be replaced by the `delegate` method. ([@geniou][])
+* Add configuration to `Encoding` cop to only enforce encoding comment if there are non ASCII characters. ([@geniou][])
+
+### Changes
+
+* Removed `FinalNewline` cop as its check is now performed by `TrailingBlankLines`. ([@jonas054][])
+* [#1011](https://github.com/bbatsov/rubocop/issues/1011): Pattern matching with `Dir#[]` for config parameters added. ([@jonas054][])
+
+### Bugs fixed
+
+* Update description on `LineEndConcatenation` cop. ([@mockdeep][])
+* [#978](https://github.com/bbatsov/rubocop/issues/978): Fix regression in `IndentationWidth` handling method calls. ([@tamird][])
+* [#976](https://github.com/bbatsov/rubocop/issues/976): Fix `EndAlignment` not handling element assignment correctly. ([@tamird][])
+* [#976](https://github.com/bbatsov/rubocop/issues/976): Fix `IndentationWidth` not handling element assignment correctly. ([@tamird][])
+* [#800](https://github.com/bbatsov/rubocop/issues/800): Do not report `[Corrected]` in `--auto-correct` mode if correction wasn't done. ([@jonas054][])
+* [#968](https://github.com/bbatsov/rubocop/issues/968): Fix bug when running Rubocop with `-c .rubocop.yml`. ([@bquorning][])
+* [#975](https://github.com/bbatsov/rubocop/pull/975): Fix infinite correction in `IndentationWidth`. ([@jonas054][])
+* [#986](https://github.com/bbatsov/rubocop/issues/986): When `--lint` is used together with `--only`, all lint cops are run in addition to the given cops. ([@jonas054][])
+* [#997](https://github.com/bbatsov/rubocop/issues/997): Fix handling of file paths for matching against `Exclude` property when `rubocop .` is called. ([@jonas054][])
+* [#1000](https://github.com/bbatsov/rubocop/issues/1000): Support modifier (e.g., `private`) and `def` on the same line (Ruby >= 2.1) in `IndentationWidth`. ([@jonas054][])
+* [#1001](https://github.com/bbatsov/rubocop/issues/1001): Fix `--auto-gen-config` logic for `RegexpLiteral`. ([@jonas054][])
+* [#993](https://github.com/bbatsov/rubocop/issues/993): Do not report any offenses for the contents of an empty file. ([@jonas054][])
+* [#1016](https://github.com/bbatsov/rubocop/issues/1016): Fix a false positive in `ConditionPosition` regarding statement modifiers. ([@bbatsov][])
+* [#1014](https://github.com/bbatsov/rubocop/issues/1014): Fix handling of strings nested in `dstr` nodes. ([@bbatsov][])

data/rubocop-todo.yml

@@ -1,20 +1,20 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-03-01 12:00:46 +1100 using RuboCop version 0.18.1.
+# on 2014-04-06 16:06:47 +0200 using RuboCop version 0.20.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 6
+# Offense count: 8
 # Configuration parameters: CountComments.
 ClassLength:
-  Max: 146
+  Max: 121
 
-# Offense count: 16
+# Offense count: 22
 CyclomaticComplexity:
   Max: 10
 
-# Offense count: 105
+# Offense count: 115
 # Configuration parameters: CountComments.
 MethodLength:
-  Max: 22
+  Max: 20

data/rubocop.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.summary = 'Automatic Ruby code style checking tool.'
 
   s.add_runtime_dependency('rainbow', '>= 1.99.1', '< 3.0')
-  s.add_runtime_dependency('parser', '~> 2.1.7')
+  s.add_runtime_dependency('parser', '~> 2.1.9')
   s.add_runtime_dependency('powerpack', '~> 0.0.6')
   s.add_runtime_dependency('json', '>= 1.7.7', '< 2')
   s.add_runtime_dependency('ruby-progressbar', '~> 1.4')

data/spec/rubocop/cli_spec.rb

@@ -61,15 +61,15 @@ describe Rubocop::CLI, :isolated_environment do
         e = abs('example.rb')
         expect($stdout.string)
           .to eq(["#{e}:2:35: C: [Corrected] Redundant curly braces around " \
-                  "a hash parameter.",
+                  'a hash parameter.',
                   "#{e}:2:35: C: [Corrected] Use the new Ruby 1.9 hash " \
-                  "syntax.",
+                  'syntax.',
                   # TODO: Don't report that a problem is corrected when it
                   # actually went away due to another correction.
                   "#{e}:2:35: C: [Corrected] Space inside { missing.",
                   # TODO: Don't report duplicates (HashSyntax in this case).
                   "#{e}:2:36: C: [Corrected] Use the new Ruby 1.9 hash " \
-                  "syntax.",
+                  'syntax.',
                   "#{e}:2:50: C: [Corrected] Space inside } missing.",
                   ''].join("\n"))
       end
@@ -299,9 +299,9 @@ describe Rubocop::CLI, :isolated_environment do
         expect(cli.run(%w(-D --auto-correct --format emacs))).to eq(1)
         expect($stdout.string)
           .to eq(["#{abs('example.rb')}:2:21: C: [Corrected] " \
-                  "SpaceAfterComma: Space missing after comma.",
+                  'SpaceAfterComma: Space missing after comma.',
                   "#{abs('example.rb')}:2:22: C: [Corrected] " \
-                  "HashSyntax: Use the new Ruby 1.9 hash syntax.",
+                  'HashSyntax: Use the new Ruby 1.9 hash syntax.',
                   ''].join("\n"))
         expect(IO.read('example.rb'))
           .to eq(['# encoding: utf-8',
@@ -319,9 +319,9 @@ describe Rubocop::CLI, :isolated_environment do
                                              ''].join("\n"))
         expect($stdout.string)
           .to eq(["#{abs('example.rb')}:2:3: C: [Corrected] HashSyntax: Use " \
-                  "the new Ruby 1.9 hash syntax.",
+                  'the new Ruby 1.9 hash syntax.',
                   "#{abs('example.rb')}:2:5: C: [Corrected] " \
-                  "SpaceAroundOperators: Surrounding space missing for " \
+                  'SpaceAroundOperators: Surrounding space missing for ' \
                   "operator '=>'.",
                   ''].join("\n"))
       end
@@ -337,7 +337,7 @@ describe Rubocop::CLI, :isolated_environment do
                                              ''].join("\n"))
         expect($stdout.string)
           .to eq(["#{abs('example.rb')}:2:3: C: [Corrected] Use the new " \
-                  "Ruby 1.9 hash syntax.",
+                  'Ruby 1.9 hash syntax.',
                   ''].join("\n"))
       end
 
@@ -349,13 +349,12 @@ describe Rubocop::CLI, :isolated_environment do
                      '',
                      ''])
         expect(cli.run(%w(--auto-correct --format emacs))).to eq(1)
-        expect($stderr.string).to eq('')
         expect(IO.read('example.rb')).to eq("# encoding: utf-8\n")
         expect($stdout.string)
           .to eq(["#{abs('example.rb')}:2:1: C: [Corrected] 3 trailing " \
-                  "blank lines detected.",
+                  'blank lines detected.',
                   "#{abs('example.rb')}:3:1: C: [Corrected] Trailing " \
-                  "whitespace detected.",
+                  'whitespace detected.',
                   ''].join("\n"))
       end
 
@@ -370,9 +369,9 @@ describe Rubocop::CLI, :isolated_environment do
                                              ''].join("\n"))
         expect($stdout.string)
           .to eq(["#{abs('example.rb')}:2:1: C: [Corrected] Use hash " \
-                  "literal {} instead of Hash.new.",
+                  'literal {} instead of Hash.new.',
                   "#{abs('example.rb')}:2:9: C: [Corrected] Do not use " \
-                  "parentheses for method calls with no arguments.",
+                  'parentheses for method calls with no arguments.',
                   ''].join("\n"))
       end
 
@@ -400,6 +399,29 @@ describe Rubocop::CLI, :isolated_environment do
                   ''].join("\n"))
       end
 
+      it 'does not say [Corrected] if correction was avoided' do
+        create_file('example.rb', ['# encoding: utf-8',
+                                   'func a and b',
+                                   'not a && b',
+                                   'func a do b end'])
+        expect(cli.run(%w(-a -f simple))).to eq(1)
+        expect($stderr.string).to eq('')
+        expect(IO.read('example.rb')).to eq(['# encoding: utf-8',
+                                             'func a and b',
+                                             'not a && b',
+                                             'func a do b end',
+                                             ''].join("\n"))
+        expect($stdout.string)
+          .to eq(['== example.rb ==',
+                  'C:  2:  8: Use && instead of and.',
+                  'C:  3:  1: Use ! instead of not.',
+                  'C:  4:  8: Prefer {...} over do...end for single-line ' \
+                  'blocks.',
+                  '',
+                  '1 file inspected, 3 offenses detected',
+                  ''].join("\n"))
+      end
+
       it 'should not hang SpaceAfterPunctuation and SpaceInsideParens' do
         create_file('example.rb',
                     ['# encoding: utf-8',
@@ -611,44 +633,92 @@ describe Rubocop::CLI, :isolated_environment do
     end
 
     describe '--only' do
-      it 'runs just one cop' do
-        create_file('example.rb', ['if x== 0 ',
-                                   "\ty",
-                                   'end'])
-        # IfUnlessModifier depends on the configuration of LineLength.
+      context 'when one cop is given' do
+        it 'runs just one cop' do
+          create_file('example.rb', ['if x== 0 ',
+                                     "\ty",
+                                     'end'])
+          # IfUnlessModifier depends on the configuration of LineLength.
+
+          expect(cli.run(['--format', 'simple',
+                          '--only', 'IfUnlessModifier',
+                          'example.rb'])).to eq(1)
+          expect($stdout.string)
+            .to eq(['== example.rb ==',
+                    'C:  1:  1: Favor modifier if usage when ' \
+                    'having a single-line body. Another good alternative is ' \
+                    'the usage of control flow &&/||.',
+                    '',
+                    '1 file inspected, 1 offense detected',
+                    ''].join("\n"))
+        end
 
-        expect(cli.run(['--format', 'simple',
-                        '--only', 'IfUnlessModifier',
-                        'example.rb'])).to eq(1)
-        expect($stdout.string)
-          .to eq(['== example.rb ==',
-                  'C:  1:  1: Favor modifier if usage when ' \
-                  'having a single-line body. Another good alternative is ' \
-                  'the usage of control flow &&/||.',
-                  '',
-                  '1 file inspected, 1 offense detected',
-                  ''].join("\n"))
+        it 'enables the given cop' do
+          create_file('example.rb', ['x = 0 ',
+                                     # Disabling comments still apply.
+                                     '# rubocop:disable TrailingWhitespace',
+                                     'y = 1  '])
+
+          create_file('.rubocop.yml', ['TrailingWhitespace:',
+                                       '  Enabled: false'])
+
+          expect(cli.run(['--format', 'simple',
+                          '--only', 'TrailingWhitespace',
+                          'example.rb'])).to eq(1)
+          expect($stderr.string).to eq('')
+          expect($stdout.string)
+            .to eq(['== example.rb ==',
+                    'C:  1:  6: Trailing whitespace detected.',
+                    '',
+                    '1 file inspected, 1 offense detected',
+                    ''].join("\n"))
+        end
       end
 
-      it 'enables the given cop' do
-        create_file('example.rb', ['x = 0 ',
-                                   # Disabling comments still apply.
-                                   '# rubocop:disable TrailingWhitespace',
-                                   'y = 1  '])
-
-        create_file('.rubocop.yml', ['TrailingWhitespace:',
-                                     '  Enabled: false'])
+      context 'when several cops are given' do
+        it 'runs the given cops' do
+          create_file('example.rb', ['if x== 100000000000000 ',
+                                     "\ty",
+                                     'end'])
+          expect(cli.run(['--format', 'simple',
+                          '--only',
+                          'IfUnlessModifier,Tab,SpaceAroundOperators',
+                          'example.rb'])).to eq(1)
+          expect($stderr.string).to eq('')
+          expect($stdout.string)
+            .to eq(['== example.rb ==',
+                    'C:  1:  1: Favor modifier if usage when ' \
+                    'having a single-line body. Another good alternative is ' \
+                    'the usage of control flow &&/||.',
+                    "C:  1:  5: Surrounding space missing for operator '=='.",
+                    'C:  2:  1: Tab detected.',
+                    '',
+                    '1 file inspected, 3 offenses detected',
+                    ''].join("\n"))
+        end
 
-        expect(cli.run(['--format', 'simple',
-                        '--only', 'TrailingWhitespace',
-                        'example.rb'])).to eq(1)
-        expect($stderr.string).to eq('')
-        expect($stdout.string)
-          .to eq(['== example.rb ==',
-                  'C:  1:  6: Trailing whitespace detected.',
-                  '',
-                  '1 file inspected, 1 offense detected',
-                  ''].join("\n"))
+        context 'and --lint' do
+          it 'runs the given cops plus all enabled lint cops' do
+            create_file('example.rb', ['if x== 100000000000000 ',
+                                       "\ty = 3",
+                                       '  end'])
+            create_file('.rubocop.yml', ['EndAlignment:',
+                                         '  Enabled: false'])
+            expect(cli.run(['--format', 'simple',
+                            '--only', 'Tab,SpaceAroundOperators',
+                            '--lint',
+                            'example.rb'])).to eq(1)
+            expect($stdout.string)
+              .to eq(['== example.rb ==',
+                      'C:  1:  5: Surrounding space missing for operator ' \
+                      "'=='.",
+                      'C:  2:  1: Tab detected.',
+                      'W:  2:  2: Useless assignment to variable - y.',
+                      '',
+                      '1 file inspected, 3 offenses detected',
+                      ''].join("\n"))
+          end
+        end
       end
     end
 
@@ -953,11 +1023,11 @@ describe Rubocop::CLI, :isolated_environment do
                   output.puts "started: #{all_files.join(',')}"
                 end
 
-                def file_started(file, options)
+                def file_started(file, _options)
                   output.puts "file_started: #{file}"
                 end
 
-                def file_finished(file, offenses)
+                def file_finished(file, _offenses)
                   output.puts "file_finished: #{file}"
                 end
 
@@ -1161,7 +1231,7 @@ describe Rubocop::CLI, :isolated_environment do
       .to eq(["#{abs('example.rb')}:2:6: W: " \
               'Ambiguous splat operator. Parenthesize the method arguments ' \
               "if it's surely a splat operator, or add a whitespace to the " \
-              'right of the * if it should be a multiplication.',
+              'right of the `*` if it should be a multiplication.',
               "#{abs('example.rb')}:3:1: C: " \
               'Favor the ternary operator (?:) over if/then/else/end ' \
               'constructs.',
@@ -1261,6 +1331,13 @@ describe Rubocop::CLI, :isolated_environment do
       .to eq(['', '1 file inspected, no offenses detected', ''].join("\n"))
   end
 
+  it 'does not register any offenses for an empty file' do
+    create_file('example.rb', '')
+    expect(cli.run(%w(--format simple))).to eq(0)
+    expect($stdout.string)
+      .to eq(['', '1 file inspected, no offenses detected', ''].join("\n"))
+  end
+
   describe 'rails cops' do
     describe 'enabling/disabling' do
       it 'by default does not run rails cops' do
@@ -1285,16 +1362,16 @@ describe Rubocop::CLI, :isolated_environment do
         create_file('dir1/.rubocop.yml', ['AllCops:',
                                           '  RunRailsCops: true',
                                           '',
-                                          'ReadAttribute:',
+                                          'ReadWriteAttribute:',
                                           '  Include:',
-                                          '    - app/models/*.rb'])
+                                          '    - app/models/**/*.rb'])
         create_file('dir2/app/models/example2.rb', source)
         create_file('dir2/.rubocop.yml', ['AllCops:',
                                           '  RunRailsCops: false',
                                           '',
-                                          'ReadAttribute:',
+                                          'ReadWriteAttribute:',
                                           '  Include:',
-                                          '    - app/models/*.rb'])
+                                          '    - app/models/**/*.rb'])
         expect(cli.run(%w(--format simple dir1 dir2))).to eq(1)
         expect($stdout.string)
           .to eq(['== dir1/app/models/example1.rb ==',
@@ -1334,7 +1411,7 @@ describe Rubocop::CLI, :isolated_environment do
                                           '',
                                           'ReadWriteAttribute:',
                                           '  Exclude:',
-                                          '    - example2.rb',
+                                          '    - "**/example2.rb"',
                                           '',
                                           'DefaultScope:',
                                           '  Exclude:',
@@ -1384,6 +1461,19 @@ describe Rubocop::CLI, :isolated_environment do
   end
 
   describe 'configuration from file' do
+    it 'allows the default configuration file as the -c argument' do
+      create_file('example.rb', ['# encoding: utf-8',
+                                 'x = 0',
+                                 'puts x'
+                                ])
+      create_file('.rubocop.yml', [])
+
+      expect(cli.run(%w(--format simple -c .rubocop.yml))).to eq(0)
+      expect($stdout.string)
+        .to eq(['', '1 file inspected, no offenses detected',
+                ''].join("\n"))
+    end
+
     it 'finds included files' do
       create_file('example', ['# encoding: utf-8',
                               'x = 0',
@@ -1430,6 +1520,27 @@ describe Rubocop::CLI, :isolated_environment do
                 ''].join("\n"))
     end
 
+    it 'matches included/excluded files corectly when . argument is given' do
+      create_file('example.rb', 'x = 0')
+      create_file('special.dsl', ['# encoding: utf-8',
+                                  'setup { "stuff" }'
+                                 ])
+      create_file('.rubocop.yml', ['AllCops:',
+                                   '  Include:',
+                                   '    - "*.dsl"',
+                                   '  Exclude:',
+                                   '    - example.rb'
+                                  ])
+      expect(cli.run(%w(--format simple .))).to eq(1)
+      expect($stdout.string)
+        .to eq(['== special.dsl ==',
+                "C:  2:  9: Prefer single-quoted strings when you don't " \
+                'need string interpolation or special symbols.',
+                '',
+                '1 file inspected, 1 offense detected',
+                ''].join("\n"))
+    end
+
     # With rubinius 2.0.0.rc1 + rspec 2.13.1,
     # File.stub(:open).and_call_original causes SystemStackError.
     it 'does not read files in excluded list', broken: :rbx do
@@ -1638,7 +1749,7 @@ describe Rubocop::CLI, :isolated_environment do
       create_file('example/.rubocop.yml', ['AllCops:',
                                            '  Exclude:',
                                            '    - src/**',
-                                           '    - etc/**',
+                                           '    - etc/**/*',
                                            '    - tmp/spec/**'])
 
       expect(cli.run(%w(--format simple example))).to eq(1)
@@ -1663,7 +1774,7 @@ describe Rubocop::CLI, :isolated_environment do
       create_file('.rubocop.yml',
                   ['AllCops:',
                    '  Exclude:',
-                   '    - vendor/**'])
+                   '    - vendor/**/*'])
 
       cli.run(%w(--format simple))
       expect($stdout.string)
@@ -1698,7 +1809,7 @@ describe Rubocop::CLI, :isolated_environment do
       create_file('.rubocop.yml',
                   ['AllCops:',
                    '  Exclude:',
-                   '    - vendor/**'])
+                   '    - vendor/**/*'])
 
       cli.run(%w(--format simple))
       expect($stderr.string).to eq('')
@@ -1726,7 +1837,7 @@ describe Rubocop::CLI, :isolated_environment do
       create_file('config/default.yml',
                   ['AllCops:',
                    '  Exclude:',
-                   '    - vendor/**'])
+                   '    - vendor/**/*'])
 
       cli.run(%w(--format simple))
       expect($stdout.string)