rubocop 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d09cfe000191e9a91719f1f3a75d401d97dcec7
-  data.tar.gz: a4528c98896b1d0330be5138b4509ccabb0bf0cc
+  metadata.gz: 2a1f32b26b9ff39fe0348f90855ab63dccc0e3c8
+  data.tar.gz: 30d21bcc89c00bb7cd629b9c5089fc4d041afeb7
 SHA512:
-  metadata.gz: b51f275c969f27f455f3f14e260452a7f52b8142cb0389020dddb1391ae61dd22f320658fdb20f041210dec8aa9513113981fd1a8913dcc90b91b65d32e8a5a2
-  data.tar.gz: 06784538ec77970b8f0fdd76c037d0bd6d4aa70a26f5181705f413d245e5364abf2d4d7644c769286c9f5e735f71712bfeba9e6a4b4bd5681431050dba16df71
+  metadata.gz: a82dd617f97b5bf6bacc3cab91c1888ba9db3d78dd866ae8a5c58fdf2235cff8ffc354ee0c99e69506db4353571d7292fc1ed4e03b20d1b590597be8dfeea45e
+  data.tar.gz: af859406fb7c0100a90e2cd1356550124b7d473c252da59b15034d55a08a9c786cad6c3efd5906100a565acfd62ce5cf6488483561db2e8903f82c9a5adf762a

data/.rubocop_todo.yml

@@ -1,28 +1,28 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-10-22 08:31:49 +0200 using RuboCop version 0.26.1.
+# on 2014-12-19 23:52:21 +0100 using RuboCop version 0.28.0.
 # 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: 116
+# Offense count: 122
 Metrics/AbcSize:
   Max: 38
 
-# Offense count: 10
+# Offense count: 9
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 131
+  Max: 138
 
-# Offense count: 27
+# Offense count: 28
 Metrics/CyclomaticComplexity:
   Max: 10
 
-# Offense count: 129
+# Offense count: 130
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 16
 
-# Offense count: 16
+# Offense count: 18
 Metrics/PerceivedComplexity:
   Max: 11

data/.travis.yml

@@ -1,14 +1,18 @@
+sudo: false
+cache: bundler
 language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+  - 2.2
   - ruby-head
   - jruby-19mode
   - rbx-2
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: jruby-19mode
     - rvm: rbx-2
 before_install: gem update --remote bundler
 install:

data/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 ## master (unreleased)
 
+## 0.29.0 (05/02/2015)
+
+### New features
+
+* [#1430](https://github.com/bbatsov/rubocop/issues/1430): Add `--except` option for disabling cops on the command line. ([@jonas054][])
+* [#1506](https://github.com/bbatsov/rubocop/pull/1506): Add auto-correct from `EvenOdd` cop. ([@blainesch][])
+* [#1507](https://github.com/bbatsov/rubocop/issues/1507): `Debugger` cop now checks for the Capybara debug methods `save_and_open_page` and `save_and_open_screenshot`. ([@rrosenblum][])
+* [#1539](https://github.com/bbatsov/rubocop/pull/1539): Implement autocorrection for Rails/ReadWriteAttribute cop. ([@huerlisi][])
+* [#1324](https://github.com/bbatsov/rubocop/issues/1324): Add `AllCops/DisplayCopNames` configuration option for showing cop names in reports, like `--display-cop-names`. ([@jonas054][])
+* [#1271](https://github.com/bbatsov/rubocop/issues/1271): `Lambda` cop does auto-correction. ([@lumeet][])
+* [#1284](https://github.com/bbatsov/rubocop/issues/1284): Support namespaces, e.g. `Lint`, in the arguments to `--only` and `--except`. ([@jonas054][])
+* [#1276](https://github.com/bbatsov/rubocop/issues/1276): `SelfAssignment` cop does auto-correction. ([@lumeet][])
+* Add autocorrect to `RedundantException`. ([@mattjmcnaughton][])
+* [#1571](https://github.com/bbatsov/rubocop/pull/1571): New cop `StructInheritance` checks for inheritance from Struct.new. ([@mmozuras][])
+* [#1575](https://github.com/bbatsov/rubocop/issues/1575): New cop `DuplicateMethods` points out duplicate method name in class and module. ([@d4rk5eed][])
+* [#1144](https://github.com/bbatsov/rubocop/issues/1144): New cop `FirstParameterIndentation` checks the indentation of the first parameter in a method call. ([@jonas054][])
+* [#1627](https://github.com/bbatsov/rubocop/issues/1627): New cop `SpaceAroundBlockParameters` checks the spacing inside and after block parameters pipes. ([@jonas054][])
+
+### Changes
+
+* [#1492](https://github.com/bbatsov/rubocop/pull/1492): Abort when auto-correct causes an infinite loop. ([@dblock][])
+* Options `-e`/`--emacs` and `-s`/`--silent` are no longer recognized. Using them will now raise an error. ([@bquorning][])
+* [#1565](https://github.com/bbatsov/rubocop/issues/1565): Let `--fail-level A` cause exit with error if all offenses are auto-corrected. ([@jonas054][])
+* [#1309](https://github.com/bbatsov/rubocop/issues/1309): Add argument handling to `MultilineBlockLayout`. ([@lumeet][])
+
+### Bugs fixed
+
+* [#1634](https://github.com/bbatsov/rubocop/pull/1634): Fix `PerlBackrefs` Cop Autocorrections to Not Raise. ([@cshaffer][])
+* [#1553](https://github.com/bbatsov/rubocop/pull/1553): Fix bug where `Style/EmptyLinesAroundAccessModifier` interfered with `Style/EmptyLinesAroundBlockBody` when there is and access modifier at the beginning of a block. ([@volkert][])
+* Handle element assignment in `Lint/AssignmentInCondition`. ([@jonas054][])
+* [#1484](https://github.com/bbatsov/rubocop/issues/1484): Fix `EmptyLinesAroundAccessModifier` incorrectly finding a violation inside method calls with names identical to an access modifier. ([@dblock][])
+* Fix bug concerning `Exclude` properties inherited from a higher directory level. ([@jonas054][])
+* [#1500](https://github.com/bbatsov/rubocop/issues/1500): Fix crashing `--auto-correct --only IndentationWidth`. ([@jonas054][])
+* [#1512](https://github.com/bbatsov/rubocop/issues/1512): Fix false negative for typical string formatting examples. ([@kakutani][], [@jonas054][])
+* [#1504](https://github.com/bbatsov/rubocop/issues/1504): Fail with a meaningful error if the configuration file is malformed. ([@bquorning][])
+* Fix bug where `auto_correct` Rake tasks does not take in the options specified in its parent task. ([@rrosenblum][])
+* [#1054](https://github.com/bbatsov/rubocop/issues/1054): Handle comments within concatenated strings in `LineEndConcatenation`. ([@yujinakayama][], [@jonas054][])
+* [#1527](https://github.com/bbatsov/rubocop/issues/1527): Make autocorrect `BracesAroundHashParameter` leave the correct number of spaces. ([@mattjmcnaughton][])
+* [#1547](https://github.com/bbatsov/rubocop/issues/1547): Don't print `[Corrected]` when auto-correction was avoided in `Style/Semicolon`. ([@jonas054][])
+* [#1573](https://github.com/bbatsov/rubocop/issues/1573): Fix assignment-related auto-correction for `BlockAlignment`. ([@lumeet][])
+* [#1587](https://github.com/bbatsov/rubocop/pull/1587): Exit with exit code 1 if there were errors ("crashing" cops). ([@jonas054][])
+* [#1574](https://github.com/bbatsov/rubocop/issues/1574): Avoid auto-correcting `Hash.new` to `{}` when braces would be interpreted as a block. ([@jonas054][])
+* [#1591](https://github.com/bbatsov/rubocop/issues/1591): Don't check parameters inside `[]` in `MultilineOperationIndentation`. ([@jonas054][])
+* [#1509](https://github.com/bbatsov/rubocop/issues/1509): Ignore class methods in `Rails/Delegate`. ([@bbatsov][])
+* [#1594](https://github.com/bbatsov/rubocop/issues/1594): Fix `@example` warnings in Yard Doc documentation generation. ([@mattjmcnaughton][])
+* [#1598](https://github.com/bbatsov/rubocop/issues/1598): Fix bug in file inclusion when running from another directory. ([@jonas054][])
+* [#1580](https://github.com/bbatsov/rubocop/issues/1580): Don't print `[Corrected]` when auto-correction was avoided in `TrivialAccessors`. ([@lumeet][])
+* [#1612](https://github.com/bbatsov/rubocop/issues/1612): Allow `expand_path` on `inherit_from` in `.rubocop.yml`. ([@mattjmcnaughton][])
+* [#1610](https://github.com/bbatsov/rubocop/issues/1610): Check that class method names actually match the name of the containing class/module in `Style/ClassMethods`. ([@bbatsov][])
+
 ## 0.28.0 (10/12/2014)
 
 ### New features
@@ -1190,3 +1240,12 @@
 [@blainesch]: https://github.com/blainesch
 [@marxarelli]: https://github.com/marxarelli
 [@katieschilling]: https://github.com/katieschilling
+[@kakutani]: https://github.com/kakutani
+[@rrosenblum]: https://github.com/rrosenblum
+[@mattjmcnaughton]: https://github.com/mattjmcnaughton
+[@huerlisi]: https://github.com/huerlisi
+[@volkert]: https://github.com/volkert
+[@lumeet]: https://github.com/lumeet
+[@mmozuras]: https://github.com/mmozuras
+[@d4rk5eed]: https://github.com/d4rk5eed
+[@cshaffer]: https://github.com/cshaffer

data/README.md

@@ -44,6 +44,7 @@ release.**
     - [Inheritance](#inheritance)
     - [Defaults](#defaults)
     - [Including/Excluding files](#includingexcluding-files)
+    - [Generic configuration parameters](#generic-configuration-parameters)
     - [Automatically Generated Configuration](#automatically-generated-configuration)
 - [Disabling Cops within Source Code](#disabling-cops-within-source-code)
 - [Formatters](#formatters)
@@ -125,19 +126,25 @@ end
 Running RuboCop on it (assuming it's in a file named `test.rb`) would produce the following report:
 
 ```
+Inspecting 1 file
+W
+
 Offenses:
 
-test.rb:1:5: C: Use snake_case for methods and variables.
+test.rb:1:5: C: Use snake_case for method names.
 def badName
     ^^^^^^^
-test.rb:2:3: C: Favor modifier if/unless usage when you have a single-line body. Another good alternative is the usage of control flow &&/||.
+test.rb:2:3: C: Use a guard clause instead of wrapping the code inside a conditional expression.
+  if something
+  ^^
+test.rb:2:3: C: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
   if something
   ^^
 test.rb:4:5: W: end at 4, 4 is not aligned with if at 2, 2
     end
     ^^^
 
-1 file inspected, 3 offenses detected
+1 file inspected, 4 offenses detected
 ```
 
 For more details check the available command-line options:
@@ -148,22 +155,23 @@ $ rubocop -h
 
 Command flag              | Description
 --------------------------|------------------------------------------------------------
-`-v/--version`            | Displays the current version and exits
-`-V/--verbose-version`    | Displays the current version plus the version of Parser and Ruby
-`-F/--fail-fast`          | Inspects in modification time order and stops after first file with offenses
-`-d/--debug`              | Displays some extra debug output
+`-v/--version`            | Displays the current version and exits.
+`-V/--verbose-version`    | Displays the current version plus the version of Parser and Ruby.
+`-F/--fail-fast`          | Inspects in modification time order and stops after first file with offenses.
+`-d/--debug`              | Displays some extra debug output.
 `-D/--display-cop-names`  | Displays cop names in offense messages.
-`-c/--config`             | Run with specified config file
-`-f/--format`             | Choose a formatter
-`-o/--out`                | Write output to a file instead of STDOUT
-`-r/--require`            | Require Ruby file (see [Loading Extensions](#loading-extensions))
-`-R/--rails`              | Run extra Rails cops
-`-l/--lint`               | Run only lint cops
-`-a/--auto-correct`       | Auto-correct certain offenses *Note:* Experimental - use with caution
-`--only`                  | Run only the specified cop(s)
-`--auto-gen-config`       | Generate a configuration file acting as a TODO list
-`--show-cops`             | Shows available cops and their configuration
-`--fail-level`            | Minimum severity for exit with error code
+`-c/--config`             | Run with specified config file.
+`-f/--format`             | Choose a formatter.
+`-o/--out`                | Write output to a file instead of STDOUT.
+`-r/--require`            | Require Ruby file (see [Loading Extensions](#loading-extensions)).
+`-R/--rails`              | Run extra Rails cops.
+`-l/--lint`               | Run only lint cops.
+`-a/--auto-correct`       | Auto-correct certain offenses. *Note:* Experimental - use with caution.
+`--only`                  | Run only the specified cop(s) and/or cops in the specified departments.
+`--except`                | Run all cops enabled by configuration except the specified cop(s) and/or departments.
+`--auto-gen-config`       | Generate a configuration file acting as a TODO list.
+`--show-cops`             | Shows available cops and their configuration.
+`--fail-level`            | Minimum [severity](#severity) for exit with error code. Full severity name or upper case initial can be given. Normally, auto-corrected offenses are ignored. Use `A` or `autocorrect` if you'd like them to trigger failure.
 
 ### Cops
 
@@ -343,6 +351,13 @@ Rails/DefaultScope:
     - app/models/problematic.rb
 ```
 
+### Generic configuration parameters
+
+In addition to `Include` and `Exclude`, the following parameters are available
+for every cop.
+
+#### Enabled
+
 Specific cops can be disabled by setting `Enabled` to `false` for that specific cop.
 
 ```yaml
@@ -350,8 +365,17 @@ Metrics/LineLength:
   Enabled: false
 ```
 
-Cops can customize their severity level. All cops support the `Severity` param.
-Allowed params are `refactor`, `convention`, `warning`, `error` and `fatal`.
+#### Severity
+
+Each cop has a default severity level based on which department it belongs
+to. The level is `warning` for `Lint` and `convention` for all the others.
+Cops can customize their severity level. Allowed params are `refactor`,
+`convention`, `warning`, `error` and `fatal`.
+
+There is one exception from the general rule above and that is `Lint/Syntax`, a
+special cop that checks for syntax errors before the other cops are invoked. It
+can not be disabled and its severity (`fatal`) can not be changed in
+configuration.
 
 ```yaml
 Metrics/CyclomaticComplexity:
@@ -399,7 +423,7 @@ for x in (0..19) # rubocop:disable Style/AvoidFor
 You can change the output format of RuboCop by specifying formatters with the `-f/--format` option.
 RuboCop ships with several built-in formatters, and also you can create your custom formatter.
 
-Additionaly the output can be redirected to a file instead of `$stdout` with the `-o/--out` option.
+Additionally the output can be redirected to a file instead of `$stdout` with the `-o/--out` option.
 
 Some of the built-in formatters produce **machine-parsable** output
 and they are considered public APIs.
@@ -466,17 +490,25 @@ The `clang` formatter displays the offenses in a manner similar to `clang`:
 
 ```
 $ rubocop test.rb
-test.rb:1:1: C: Use snake_case for methods and variables.
+Inspecting 1 file
+W
+
+Offenses:
+
+test.rb:1:5: C: Use snake_case for method names.
 def badName
     ^^^^^^^
-test.rb:2:3: C: Favor modifier if/unless usage when you have a single-line body. Another good alternative is the usage of control flow &&/||.
+test.rb:2:3: C: Use a guard clause instead of wrapping the code inside a conditional expression.
+  if something
+  ^^
+test.rb:2:3: C: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
   if something
   ^^
 test.rb:4:5: W: end at 4, 4 is not aligned with if at 2, 2
     end
     ^^^
 
-1 file inspected, 3 offenses detected
+1 file inspected, 4 offenses detected
 ```
 
 ### Fuubar Style Formatter
@@ -516,11 +548,12 @@ The name of the formatter says it all :-)
 ```
 $ rubocop --format simple test.rb
 == test.rb ==
-C:  1:  1: Use snake_case for methods and variables.
-C:  2:  3: Favor modifier if/unless usage when you have a single-line body. Another good alternative is the usage of control flow &&/||.
+C:  1:  5: Use snake_case for method names.
+C:  2:  3: Use a guard clause instead of wrapping the code inside a conditional expression.
+C:  2:  3: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
 W:  4:  5: end at 4, 4 is not aligned with if at 2, 2
 
-1 file inspected, 3 offenses detected
+1 file inspected, 4 offenses detected
 ```
 
 ### File List Formatter
@@ -629,6 +662,7 @@ RuboCop supports the following Ruby implementations:
 * MRI 1.9.3
 * MRI 2.0
 * MRI 2.1
+* MRI 2.2
 * JRuby in 1.9 mode
 * Rubinius 2.0+
 
@@ -839,5 +873,5 @@ RuboCop's changelog is available [here](CHANGELOG.md).
 
 ## Copyright
 
-Copyright (c) 2012-2014 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
+Copyright (c) 2012-2015 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
 further details.

data/config/default.yml

@@ -29,6 +29,14 @@ AllCops:
   # By default, the rails cops are not run. Override in project or home
   # directory .rubocop.yml files, or by giving the -R/--rails option.
   RunRailsCops: false
+  # Cop names are not displayed in offense messages by default. Change behavior
+  # by overriding DisplayCopNames, or by giving the -D/--display-cop-names
+  # option.
+  DisplayCopNames: false
+  # Additional cops that do not reference a style guide rule may be enabled by
+  # default. Change behavior by overriding StyleGuideCopsOnly, or by giving
+  # the --only-guide-cops option.
+  StyleGuideCopsOnly: false
 
 # Indent private/protected/public as deep as method definitions
 Style/AccessModifierIndentation:
@@ -252,6 +260,21 @@ Style/FileName:
   # excludes here.
   Exclude: []
 
+Style/FirstParameterIndentation:
+  EnforcedStyle: special_for_inner_method_call_in_parentheses
+  SupportedStyles:
+    # The first parameter should always be indented one step more than the
+    # preceding line.
+    - consistent
+    # The first parameter should normally be indented one step more than the
+    # preceding line, but if it's a parameter for a method call that is itself
+    # a parameter in a method call, then the inner parameter should be indented
+    # relative to the inner method.
+    - special_for_inner_method_call
+    # Same as special_for_inner_method_call except that the special rule only
+    # applies if the outer method call encloses its arguments in parentheses.
+    - special_for_inner_method_call_in_parentheses
+
 # Checks use of for or each in multiline loops.
 Style/For:
   EnforcedStyle: each
@@ -435,6 +458,12 @@ Style/StringLiteralsInInterpolation:
     - single_quotes
     - double_quotes
 
+Style/SpaceAroundBlockParameters:
+  EnforcedStyleInsidePipes: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
 Style/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: space
   SupportedStyles:
@@ -551,6 +580,8 @@ Metrics/CyclomaticComplexity:
 
 Metrics/LineLength:
   Max: 80
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # contaning a URI to be longer than Max.
   AllowURI: true
   URISchemes:
     - http

data/config/disabled.yml

@@ -2,7 +2,7 @@
 
 Style/CollectionMethods:
   Description: 'Preferred collection methods.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#map-fine-select-reduce-size'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size'
   Enabled: false
 
 Style/Encoding:

data/config/enabled.yml

@@ -239,6 +239,10 @@ Style/FileName:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
   Enabled: true
 
+Style/FirstParameterIndentation:
+  Description: 'Checks the indentation of the first parameter in a method call.'
+  Enabled: true
+
 Style/FlipFlop:
   Description: 'Checks for flip flops'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-flip-flops'
@@ -594,6 +598,10 @@ Style/SpaceInsideBlockBraces:
                  or doesn't have trailing space.
   Enabled: true
 
+Style/SpaceAroundBlockParameters:
+  Description: 'Checks the spacing inside and after block parameters pipes.'
+  Enabled: true
+
 Style/SpaceAroundEqualsInParameterDefault:
   Description: >-
                  Checks that the equals signs in parameter default assignments
@@ -647,6 +655,11 @@ Style/StringLiteralsInInterpolation:
                  strings match the configured preference.
   Enabled: true
 
+Style/StructInheritance:
+  Description: 'Checks for inheritance from Struct.new.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new'
+  Enabled: true
+
 Style/SymbolProc:
   Description: 'Use symbols as procs instead of blocks when possible.'
   Enabled: true
@@ -819,6 +832,10 @@ Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
   Enabled: true
 
+Lint/DuplicateMethods:
+  Description: 'Check for duplicate methods calls.'
+  Enabled: true
+
 Lint/ElseLayout:
   Description: 'Check for odd code arrangement in an else block.'
   Enabled: true

data/lib/rubocop.rb

@@ -73,6 +73,7 @@ require 'rubocop/cop/lint/condition_position'
 require 'rubocop/cop/lint/debugger'
 require 'rubocop/cop/lint/def_end_alignment'
 require 'rubocop/cop/lint/deprecated_class_methods'
+require 'rubocop/cop/lint/duplicate_methods'
 require 'rubocop/cop/lint/else_layout'
 require 'rubocop/cop/lint/empty_ensure'
 require 'rubocop/cop/lint/empty_interpolation'
@@ -164,6 +165,7 @@ require 'rubocop/cop/style/end_of_line'
 require 'rubocop/cop/style/even_odd'
 require 'rubocop/cop/style/extra_spacing'
 require 'rubocop/cop/style/file_name'
+require 'rubocop/cop/style/first_parameter_indentation'
 require 'rubocop/cop/style/flip_flop'
 require 'rubocop/cop/style/for'
 require 'rubocop/cop/style/format_string'
@@ -227,6 +229,7 @@ require 'rubocop/cop/style/space_after_control_keyword'
 require 'rubocop/cop/style/space_after_method_name'
 require 'rubocop/cop/style/space_after_not'
 require 'rubocop/cop/style/space_after_semicolon'
+require 'rubocop/cop/style/space_around_block_parameters'
 require 'rubocop/cop/style/space_around_equals_in_parameter_default'
 require 'rubocop/cop/style/space_around_operators'
 require 'rubocop/cop/style/space_before_block_braces'
@@ -242,6 +245,7 @@ require 'rubocop/cop/style/space_inside_range_literal'
 require 'rubocop/cop/style/special_global_vars'
 require 'rubocop/cop/style/string_literals'
 require 'rubocop/cop/style/string_literals_in_interpolation'
+require 'rubocop/cop/style/struct_inheritance'
 require 'rubocop/cop/style/symbol_array'
 require 'rubocop/cop/style/symbol_proc'
 require 'rubocop/cop/style/tab'