rubocop 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93f1416caf62b3dbb7452feeeb5be8b017bf3926
-  data.tar.gz: 6de08a58bf2d425bb08411fd33f0e20e9515bba6
+  metadata.gz: 98ac250f0e0bf154099056814a9ab3e479b18ca0
+  data.tar.gz: 889fe91593bb5d98857a87cdf54a0e103d289727
 SHA512:
-  metadata.gz: 59017f0bc97a22ee8b1ed0795d14cafa479992b8e5338af31c8db0dd0dc3c9b0a999799a2a01cf6843e6f39c10e03cacd87c88bdcf3d8455962f1187be033fc2
-  data.tar.gz: a54661cf2a09e2078ed40b5fb0e3649356d82a2fb2a6f4821b9837e1c1975a0df23c4f25178b7ed782f17b04634d696cfc87316e2f587929d9ead94c195d701b
+  metadata.gz: 8808eb3774ea169915eaeafee503e01e94c54357c70c50154ecb2a40ccf00e743d2997e2ec5b0e6caf328180ef76f5e2d9136f0ea3ec47141c9eaab3780d5529
+  data.tar.gz: e47780e9359a3ea1c1215eaa418ce62ae01b895f12910624a2d931a4b7db009d21886edf298b42e54286f2f1abc8045460de4c5ff05a2104fa4407f8a32d5536

data/.rubocop.yml

@@ -5,3 +5,6 @@ inherit_from: config/default.yml
 # Avoid methods longer than 30 lines of code
 MethodLength:
   Max: 30
+
+ClassLength:
+  Max: 210

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 ## master (unreleased)
 
+## 0.14.0 (07/10/2013)
+
+### New features
+
+* [#491](https://github.com/bbatsov/rubocop/issues/491) - New cop `MethodCalledOnDoEndBlock` keeps track of methods called on `do`...`end` blocks.
+* [#456](https://github.com/bbatsov/rubocop/issues/456) - New configuration parameter `AllCops`/`RunRailsCops` can be set to `true` for a project, removing the need to give the `-R`/`--rails` option with every invocation of `rubocop`.
+* [#501](https://github.com/bbatsov/rubocop/issues/501) - `simple`/`clang`/`progress`/`emacs` formatters now print `[Corrected]` along with offence message when the offence is automatically corrected.
+* [#501](https://github.com/bbatsov/rubocop/issues/501) - `simple`/`clang`/`progress` formatters now print count of auto-corrected offences in the final summary.
+* [#501](https://github.com/bbatsov/rubocop/issues/501) - `json` formatter now outputs `corrected` key with boolean value in offence objects whether the offence is automatically corrected.
+* New cop `ClassLength` checks for overly long class definitions
+* New cop `Debugger` checks for forgotten calls to debugger or pry
+* New cop `RedundantException` checks for code like `raise RuntimeError, message`
+* [#526](https://github.com/bbatsov/rubocop/issues/526) - New cop `RaiseArgs` checks the args passed to `raise/fail`.
+
+### Changes
+
+* Cop `MethodAndVariableSnakeCase` replaced by `MethodName` and `VariableName`, both having the configuration parameter `EnforcedStyle` with values `snake_case` (default) and `camelCase`.
+* [#519](https://github.com/bbatsov/rubocop/issues/519) - `HashSyntax` cop is now configurable and can enforce the use of the classic hash rockets syntax
+* [#520](https://github.com/bbatsov/rubocop/issues/520) - `StringLiterals` cop is now configurable and can enforce either single-quoted or double-quoted strings.
+* [#528](https://github.com/bbatsov/rubocop/issues/528) - Added a config option to `RedundantReturn` to allow a `return` with multiple values.
+* [#524](https://github.com/bbatsov/rubocop/issues/524) - Added a config option to `Semicolon` to allow the use of `;` as an expression separator.
+* [#525](https://github.com/bbatsov/rubocop/issues/525) - `SignalException` cop is now configurable and can enforce the semantic rule or an exclusive use of `raise` or `fail`.
+* `LambdaCall` is now configurable and enforce either `Proc#call` or `Proc#()`.
+* [#529](https://github.com/bbatsov/rubocop/issues/529) - Added config option `EnforcedStyle` to `SpaceAroundBraces`.
+* [#529](https://github.com/bbatsov/rubocop/issues/529) - Changed config option `NoSpaceBeforeBlockParameters` to `SpaceBeforeBlockParameters`.
+* Support Parser 2.0.0 (non-beta)
+
+### Bugs fixed
+
+* [#514](https://github.com/bbatsov/rubocop/issues/514) - Fix alignment of the hash containing different key lengths in one line
+* [#496](https://github.com/bbatsov/rubocop/issues/496) - Fix corner case crash in `AlignHash` cop: single key/value pair when configuration is `table` for '=>' and `separator` for `:`.
+* [#502](https://github.com/bbatsov/rubocop/issues/502) - Don't check non-decimal literals with `NumericLiterals`
+* [#448](https://github.com/bbatsov/rubocop/issues/448) - Fix auto-correction of parameters spanning more than one line in `AlignParameters` cop.
+* [#493](https://github.com/bbatsov/rubocop/issues/493) - Support disabling `Syntax` offences with `warning` severity
+* Fix bug appearing when there were different values for the `AllCops`/`RunRailsCops` configuration parameter in different directories.
+* [#512](https://github.com/bbatsov/rubocop/issues/512) - Fix bug causing crash in `AndOr` auto-correction.
+* [#515](https://github.com/bbatsov/rubocop/issues/515) - Fix bug causing `AlignParameters` and `AlignArray` auto-correction to destroy code.
+* [#516](https://github.com/bbatsov/rubocop/issues/516) - Fix bug causing `RedundantReturn` auto-correction to produce invalid code.
+* [#527](https://github.com/bbatsov/rubocop/issues/527) - Handle `!=` expressions in `EvenOdd` cop
+* `SignalException` cop now finds `raise` calls anywhere, not only in `begin` sections.
+* [#538](https://github.com/bbatsov/rubocop/issues/538) - Fix bug causing `Blocks` auto-correction to produce invalid code.
+
 ## 0.13.1 (19/09/2013)
 
 ### New features

data/README.md

@@ -11,7 +11,8 @@
 enforce many of the guidelines outlined in the community
 [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
 
-Most aspects of its behavior can be tweaked via various configuration options.
+Most aspects of its behavior can be tweaked via various
+[configuration options](https://github.com/bbatsov/rubocop/blob/master/config/default.yml).
 
 Apart from reporting problems in your code, RuboCop can also
 automatically fix some of the problems for you.
@@ -27,13 +28,13 @@ $ gem install rubocop
 ## Basic Usage
 
 Running `rubocop` with no arguments will check all Ruby source files
-in the current folder:
+in the current directory:
 
 ```bash
 $ rubocop
 ```
 
-Alternatively you can pass `rubocop` a list of files and folders to check:
+Alternatively you can pass `rubocop` a list of files and directories to check:
 
 ```bash
 $ rubocop app spec lib/something.rb
@@ -128,11 +129,12 @@ $ rubocop -R
 
 The behavior of RuboCop can be controlled via the
 [.rubocop.yml](https://github.com/bbatsov/rubocop/blob/master/.rubocop.yml)
-configuration file. The file can be placed either in your home folder
-or in some project folder.
+configuration file. It makes it possible to enable/disable certain cops
+(checks) and to alter their behavior if they accept any parameters. The file
+can be placed either in your home directory or in some project directory.
 
 RuboCop will start looking for the configuration file in the directory
-where the inspected file is and continue its way up to the root folder.
+where the inspected file is and continue its way up to the root directory.
 
 The file has the following format:
 
@@ -140,26 +142,24 @@ The file has the following format:
 inherit_from: ../.rubocop.yml
 
 Encoding:
-  Enabled: true
+  Enabled: false
 
 LineLength:
-  Enabled: true
-  Max: 79
+  Max: 99
 ```
 
-It allows to enable/disable certain cops (checks) and to alter their
-behavior if they accept any parameters.
+### Inheritance
 
 The optional `inherit_from` directive is used to include configuration
 from one or more files. This makes it possible to have the common
 project settings in the `.rubocop.yml` file at the project root, and
 then only the deviations from those rules in the subdirectories. The
-included files can be given with absolute paths or paths relative to
-the file where they are referenced. The settings after an
-`inherit_from` directive override any settings in the included
-file(s). When multiple files are included, the first file in the list
-has the lowest precedence and the last one has the highest. The format
-for multiple inclusion is:
+files can be given with absolute paths or paths relative to the file
+where they are referenced. The settings after an `inherit_from`
+directive override any settings in the file(s) inherited from. When
+multiple files are included, the first file in the list has the lowest
+precedence and the last one has the highest. The format for multiple
+inheritance is:
 
 ```yaml
 inherit_from:
@@ -170,47 +170,21 @@ inherit_from:
 ### Defaults
 
 The file
-[config/default.yml]([.rubocop.yml](https://github.com/bbatsov/rubocop/blob/master/config/.default.yml))
+[config/default.yml](https://github.com/bbatsov/rubocop/blob/master/config/default.yml)
 under the RuboCop home directory contains the default settings that
 all configurations inherit from. Project and personal `.rubocop.yml`
 files need only make settings that are different from the default
 ones. If there is no `.rubocop.yml` file in the project or home
 directory, `config/default.yml` will be used.
 
-### Disabling Cops within Source Code
-
-One or more individual cops can be disabled locally in a section of a
-file by adding a comment such as
-
-```ruby
-# rubocop:disable LineLength, StringLiterals
-[...]
-# rubocop:enable LineLength, StringLiterals
-```
-
-You can also disable *all* cops with
-
-```ruby
-# rubocop:disable all
-[...]
-# rubocop:enable all
-```
-
-One or more cops can be disabled on a single line with an end-of-line
-comment.
-
-```ruby
-for x in (0..19) # rubocop:disable AvoidFor
-```
-
 ### Including/Excluding files
 
 RuboCop checks all files recursively within the directory it is run
-on.  However, it does not recognize some files as Ruby(only files
-ending with `.rb` or extensionless files with a `#!.*ruby` declaration
-are automatically detected) files, and if you'd like it to check these
-you'll need to manually pass them in.  Files and directories can
-also be ignored through `.rubocop.yml`.
+on.  However, it only recognizes files ending with `.rb` or
+extensionless files with a `#!.*ruby` declaration as Ruby files. If
+you'd like it to check other files you'll need to manually pass them
+in, or to add entries for them under `AllCops`/`Includes`.  Files and
+directories can also be ignored through `AllCops`/`Excludes`.
 
 Here is an example that might be used for a Rails project:
 
@@ -228,11 +202,14 @@ AllCops:
 # ...
 ```
 
-Note: Files and directories are specified relative to the
-`.rubocop.yml` file. The `Excludes` parameter is special. It is valid
-for the directory tree starting where it is defined. It is not
-shadowed by the setting of `Excludes` in other `.rubocop.yml` files in
-subdirectories.
+Files and directories are specified relative to the `.rubocop.yml` file.
+
+**Note**: The `Excludes` parameter is special. It is valid for the
+directory tree starting where it is defined. It is not shadowed by the
+setting of `Excludes` in other `.rubocop.yml` files in
+subdirectories. This is different from all other parameters, who
+follow RuboCop's general principle that configuration for an inspected
+file is taken from the nearest `.rubocop.yml`, searching upwards.
 
 ### Automatically Generated Configuration
 
@@ -243,6 +220,32 @@ contains configuration to disable all cops that currently detect an offence in
 the code. Then you can start removing the entries in the generated file one by
 one as you work through all the offences in the code.
 
+## Disabling Cops within Source Code
+
+One or more individual cops can be disabled locally in a section of a
+file by adding a comment such as
+
+```ruby
+# rubocop:disable LineLength, StringLiterals
+[...]
+# rubocop:enable LineLength, StringLiterals
+```
+
+You can also disable *all* cops with
+
+```ruby
+# rubocop:disable all
+[...]
+# rubocop:enable all
+```
+
+One or more cops can be disabled on a single line with an end-of-line
+comment.
+
+```ruby
+for x in (0..19) # rubocop:disable AvoidFor
+```
+
 ## Formatters
 
 ### Clang Formatter (default)
@@ -332,6 +335,7 @@ The JSON structure is like the following example:
           "severity": "convention",
           "message": "Line is too long. [81/79]",
           "cop_name": "LineLength",
+          "corrected": true,
           "location": {
             "line": 546,
             "column": 80
@@ -340,6 +344,7 @@ The JSON structure is like the following example:
           "severity": "warning",
           "message": "Unreachable code detected.",
           "cop_name": "UnreachableCode",
+          "corrected": false,
           "location": {
             "line": 15,
             "column": 9

data/config/default.yml

@@ -12,76 +12,151 @@ AllCops:
     - '**/*.gemspec'
     - '**/Rakefile'
   Excludes: []
+  # 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
+
+# Align the elements of a hash literal if they span more than one line.
+AlignHash:
+  # Alignment of entries using hash rocket as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   'a' => 2
+  #   'bb' => 3
+  # separator - alignment of hash rockets, keys are right aligned
+  #    'a' => 2
+  #   'bb' => 3
+  # table - left alignment of keys, hash rockets, and values
+  #   'a'  => 2
+  #   'bb' => 3
+  EnforcedHashRocketStyle: key
+  # Alignment of entries using colon as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   a: 0
+  #   bb: 1
+  # separator - alignment of colons, keys are right aligned
+  #    a: 0
+  #   bb: 1
+  # table - left alignment of keys and values
+  #   a:  0
+  #   bb: 1
+  EnforcedColonStyle: key
+
+# Allow safe assignment in conditions.
+AssignmentInCondition:
+  AllowSafeAssignment: true
+
+BlockNesting:
+  Max: 3
+
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+# Multi-line method chaining should be done with leading dots.
+DotPosition:
+  Style: 'leading'
+
+# Use empty lines between defs.
+EmptyLineBetweenDefs:
+  # If true, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: false
+
+# Built-in global variables are allowed by default.
+GlobalVars:
+  AllowedVariables: []
+
+HashSyntax:
+  # Valid values are: ruby19, hash_rockets
+  EnforcedStyle: ruby19
+
+LambdaCall:
+  # Valid values are: call, braces
+  EnforcedStyle: call
 
 LineLength:
-  Description: 'Limit lines to 79 characters.'
   Max: 79
 
 MethodLength:
-  Description: 'Avoid methods longer than 10 lines of code.'
   CountComments: false  # count full line comments?
   Max: 10
 
-SpaceAroundBlockBraces:
-  Description: 'Use spaces around { and before } in blocks.'
-  NoSpaceBeforeBlockParameters: false
+MethodName:
+  # Valid values are: snake_case, camelCase
+  EnforcedStyle: snake_case
+
+NumericLiterals:
+  MinDigits: 5
 
 ParameterLists:
-  Description: 'Avoid parameter lists longer than five parameters.'
   Max: 5
   CountKeywordArgs: true
 
+# Allow safe assignment in conditions.
+ParenthesesAroundCondition:
+  AllowSafeAssignment: true
+
+RaiseArgs:
+  # Valid values are: compact and exploded
+  # exploded: raise Exception, msg
+  # compact: raise Exception.new(msg)
+  EnforcedStyle: exploded
+
+RedundantReturn:
+  # When true allows code like `return x, y`.
+  AllowMultipleReturnValues: false
+
+RegexpLiteral:
+  MaxSlashes: 1
+
 Semicolon:
-  Description: "Don't use semicolons to terminate expressions."
-  # For example; def area(height, width); height * width end
-  AllowAfterParameterListInOneLineMethods: false
-  # For example; def area(height, width) height * width; end
-  AllowBeforeEndInOneLineMethods: true
+  # Allow ; to separate several expressions on the same line.
+  AllowAsExpressionSeparator: false
+
+SignalException:
+  # Valid values are: semantic, only_raise and only_fail
+  EnforcedStyle: semantic
 
 SingleLineMethods:
-  Description: 'Avoid single-line methods.'
   AllowIfMethodIsEmpty: true
 
+StringLiterals:
+  # Valid values (denoting the preferred quote delimiters) are:
+  # single_quotes, double_quotes
+  EnforcedStyle: single_quotes
+
+SpaceAroundBlockBraces:
+  # Valid values are: space_inside_braces, no_space_inside_braces
+  EnforcedStyle: space_inside_braces
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: true
+
 SpaceInsideHashLiteralBraces:
-  Description: "Use spaces inside hash literal braces - or don't."
   EnforcedStyleIsWithSpaces: true
 
 SymbolName:
-  Description: 'Symbol literals should use snake_case.'
   AllowCamelCase: true
 
-BlockNesting:
-  Description: 'Avoid more than `Max` levels of nesting.'
-  Max: 3
-
-NumericLiterals:
-  MinDigits: 5
-
-RegexpLiteral:
-  Description: >
-                 Use %r for regular expressions matching more than
-                 `MaxSlashes` '/' characters.
-                 Use %r only for regular expressions matching more than
-                 `MaxSlashes` '/' character.
-  MaxSlashes: 1
-
-# Built-in global variables are allowed by default.
-GlobalVars:
-  AllowedVariables: []
-
-# Align with the style guide.
-CollectionMethods:
-  PreferredMethods:
-    collect: 'map'
-    collect!: 'map!'
-    inject: 'reduce'
-    detect: 'find'
-    find_all: 'select'
-
-# Multi-line method chaining should be done with leading dots.
-DotPosition:
-  Style: 'leading'
-
 # TrivialAccessors doesn't require exact name matches and doesn't allow
 # predicated methods by default.
 TrivialAccessors:
@@ -106,52 +181,6 @@ TrivialAccessors:
     - to_s
     - to_sym
 
-# Allow safe assignment in conditions.
-AssignmentInCondition:
-  AllowSafeAssignment: true
-
-# Allow safe assignment in conditions.
-ParenthesesAroundCondition:
-  AllowSafeAssignment: true
-
-# Checks formatting of special comments
-CommentAnnotation:
-  Keywords:
-    - TODO
-    - FIXME
-    - OPTIMIZE
-    - HACK
-    - REVIEW
-
-# Use empty lines between defs.
-EmptyLineBetweenDefs:
-  # If true, this parameter means that single line method definitions don't
-  # need an empty line between them.
-  AllowAdjacentOneLineDefs: false
-
-# Align the elements of a hash literal if they span more than one line.
-AlignHash:
-  # Alignment of entries using hash rocket as separator. Valid values are:
-  #
-  # key - left alignment of keys
-  #   'a' => 2
-  #   'bb' => 3
-  # separator - alignment of hash rockets, keys are right aligned
-  #    'a' => 2
-  #   'bb' => 3
-  # table - left alignment of keys, hash rockets, and values
-  #   'a'  => 2
-  #   'bb' => 3
-  EnforcedHashRocketStyle: key
-  # Alignment of entries using colon as separator. Valid values are:
-  #
-  # key - left alignment of keys
-  #   a: 0
-  #   bb: 1
-  # separator - alignment of colons, keys are right aligned
-  #    a: 0
-  #   bb: 1
-  # table - left alignment of keys and values
-  #   a:  0
-  #   bb: 1
-  EnforcedColonStyle: key
+VariableName:
+  # Valid values are: snake_case, camelCase
+  EnforcedStyle: snake_case