rubocop 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18bb71a6ddd6cdd142c68e789a70b0baf5704d79
-  data.tar.gz: f239d5e80896196e17211fa6834e3d7a261cb0e7
+  metadata.gz: 0005c0b6b6a9b9ee4037110fd8e9c71b9d79092b
+  data.tar.gz: 8d5bea9be330a3728f0f08d5025affc7d564e020
 SHA512:
-  metadata.gz: 1bac37f99223a0c20c2e7ba29c4dbbc1fc907962102962679153f6a55c5f1b1a5bdb2d482029aef3b7abf63242a31ebce47be9ea55f40ba3ccb858bf8951f69e
-  data.tar.gz: acf9e58f556f5fcc298584233e2ed12afc8ebe7f434fc7a0ac747a5f0cb1ef1579d5d14e9e4dad065eec13c9e3d39bd103b85790d4ce455f92f6210f026d1650
+  metadata.gz: fb25af1b50520d4c56c98958e653b5a963444d678e31754a362ae174946112420511575936b0dc6ce1fd3fcaa4eb80af1e996f856922403f1bc219f4c1fb2b76
+  data.tar.gz: 6b946667153c827780d2df4c7e315c063b3a5c2b4d72417e7578c6034ee981a47065dfc941dffa5494ccf88835a24887663dd93106062a6903c8fa0ea7ad0b93

data/.rubocop.yml

@@ -1,3 +1,3 @@
 # This is the configuration used to check the rubocop source code.
 
-inherit_from: rubocop-todo.yml
+inherit_from: .rubocop_todo.yml

data/{rubocop-todo.yml → .rubocop_todo.yml}

@@ -1,20 +1,20 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-04-06 16:06:47 +0200 using RuboCop version 0.20.1.
+# on 2014-04-29 22:57:01 +0200 using RuboCop version 0.21.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: 8
+# Offense count: 7
 # Configuration parameters: CountComments.
 ClassLength:
-  Max: 121
+  Max: 119
 
-# Offense count: 22
+# Offense count: 24
 CyclomaticComplexity:
   Max: 10
 
-# Offense count: 115
+# Offense count: 114
 # Configuration parameters: CountComments.
 MethodLength:
   Max: 20

data/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 ## master (unreleased)
 
+## 0.22.0 (20/04/2014)
+
+### New features
+
+* [#974](https://github.com/bbatsov/rubocop/pull/974): New cop `CommentIndentation` checks indentation of comments. ([@jonas054][])
+* Add new cop `EachWithObject` to prefer `each_with_object` over `inject` or `reduce`. ([@geniou][])
+* [#1010](https://github.com/bbatsov/rubocop/issues/1010): New Cop `Next` check for conditions at the end of an interation and propose to use `next` instead. ([@geniou][])
+* The `GuardClause` cop now also looks for unless and it is configurable how many lines the body of an if / unless needs to have to not be ignored. ([@geniou][])
+* [#835](https://github.com/bbatsov/rubocop/issues/835): New cop `UnneededPercentX` checks for `%x` when backquotes would do. ([@jonas054][])
+* Add auto-correct to `UnusedBlockArgument` and `UnusedMethodArgument` cops. ([@hannestyden][])
+* [#1074](https://github.com/bbatsov/rubocop/issues/1074): New cop `SpaceBeforeComment` checks for missing space between code and a comment on the same line. ([@jonas054][])
+* [#1089](https://github.com/bbatsov/rubocop/pull/1089): New option `-F`/`--fail-fast` inspects files in modification time order and stop after the first file with offenses. ([@jonas054][])
+
+### Changes
+
+* `NonNilCheck` offense reporting and autocorrect are configurable to include semantic changes. ([@hannestyden][])
+* The parameters `AllCops/Excludes` and `AllCops/Includes` with final `s` only give a warning and don't halt `rubocop` execution. ([@jonas054][])
+* The `GuardClause` cop is no longer irgnoring a one-line body by default - see configuration. ([@geniou][])
+* [#1050](https://github.com/bbatsov/rubocop/issues/1050): Rename `rubocop-todo.yml` file to `.rubocop_todo.yml`. ([@geniou][])
+* [#1064](https://github.com/bbatsov/rubocop/issues/1064): Adjust default max line length to 80. ([@bbatsov][])
+
+### Bugs fixed
+
+* Allow assignment in `AlignParameters` cop. ([@tommeier][])
+* Fix `Void` and `SpaceAroundOperators` for short call syntax `lambda.()`. ([@biinari][])
+* Fix `Delegate` for delegation with assignment or constant. ([@geniou][])
+* [#1032](https://github.com/bbatsov/rubocop/issues/1032): Avoid duplicate reporting when code moves around due to `--auto-correct`. ([@jonas054][])
+* [#1036](https://github.com/bbatsov/rubocop/issues/1036): Handle strings like `__FILE__` in `LineEndConcatenation`. ([@bbatsov][])
+* [#1006](https://github.com/bbatsov/rubocop/issues/1006): Fix LineEndConcatenation to handle chained concatenations. ([@barunio][])
+* [#1066](https://github.com/bbatsov/rubocop/issues/1066): Fix auto-correct for `NegatedIf` when the condition has parentheses around it. ([@jonas054][])
+* Fix `AlignParameters` `with_fixed_indentation` for multi-line method calls. ([@molawson][])
+* Fix problem that appears in some installations when reading empty YAML files. ([@jonas054][])
+* [#1022](https://github.com/bbatsov/rubocop/issues/1022): A Cop will no longer auto-correct a file that's excluded through an `Exclude` setting in the cop's configuration. ([@jonas054][])
+* Fix paths in `Exclude` config section not being recognized on Windows. ([@wndhydrnt][])
+* [#1094](https://github.com/bbatsov/rubocop/issues/1094): Fix ClassAndModuleChildren for classes with a single method. ([@geniou][])
+
 ## 0.21.0 (24/04/2014)
 
 ### New features
@@ -894,4 +930,9 @@
 [@bquorning]: https://github.com/bquorning
 [@bcobb]: https://github.com/bcobb
 [@irrationalfab]: https://github.com/irrationalfab
+[@tommeier]: https://github.com/tommeier
 [@sfeldon]: https://github.com/sfeldon
+[@biinari]: https://github.com/biinari
+[@barunio]: https://github.com/barunio
+[@molawson]: https://github.com/molawson
+[@wndhydrnt]: https://github.com/wndhydrnt

data/README.md

@@ -1,9 +1,9 @@
-[![Gem Version](https://badge.fury.io/rb/rubocop.png)](http://badge.fury.io/rb/rubocop)
-[![Dependency Status](https://gemnasium.com/bbatsov/rubocop.png)](https://gemnasium.com/bbatsov/rubocop)
-[![Build Status](https://travis-ci.org/bbatsov/rubocop.png?branch=master)](https://travis-ci.org/bbatsov/rubocop)
+[![Gem Version](https://badge.fury.io/rb/rubocop.svg)](http://badge.fury.io/rb/rubocop)
+[![Dependency Status](https://gemnasium.com/bbatsov/rubocop.svg)](https://gemnasium.com/bbatsov/rubocop)
+[![Build Status](https://travis-ci.org/bbatsov/rubocop.svg?branch=master)](https://travis-ci.org/bbatsov/rubocop)
 [![Coverage Status](https://coveralls.io/repos/bbatsov/rubocop/badge.png?branch=master)](https://coveralls.io/r/bbatsov/rubocop)
 [![Code Climate](https://codeclimate.com/github/bbatsov/rubocop.png)](https://codeclimate.com/github/bbatsov/rubocop)
-[![Inline docs](http://inch-pages.github.io/github/bbatsov/rubocop.png)](http://inch-pages.github.io/github/bbatsov/rubocop)
+[![Inline docs](http://inch-pages.github.io/github/bbatsov/rubocop.svg)](http://inch-pages.github.io/github/bbatsov/rubocop)
 
 # RuboCop
 
@@ -129,6 +129,7 @@ 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
 `-D/--display-cop-names`  | Displays cop names in offense messages.
 `-c/--config`             | Run with specified config file
@@ -315,12 +316,13 @@ CyclomaticComplexity:
 
 ### Automatically Generated Configuration
 
-If you have a code base with an overwhelming amount of offenses, it can be a
-good idea to use `rubocop --auto-gen-config` and add an `inherit_from:
-rubocop-todo.yml` in your `.rubocop.yml`. The generated file `rubocop-todo.yml`
-contains configuration to disable all cops that currently detect an offense in
-the code. Then you can start removing the entries in the generated file one by
-one as you work through all the offenses in the code.
+If you have a code base with an overwhelming amount of offenses, it can
+be a good idea to use `rubocop --auto-gen-config` and add an
+`inherit_from: .rubocop_todo.yml` in your `.rubocop.yml`. The generated
+file `.rubocop_todo.yml` contains configuration to disable all cops that
+currently detect an offense in the code. Then you can start removing the
+entries in the generated file one by one as you work through all the
+offenses in the code.
 
 ## Disabling Cops within Source Code
 
@@ -510,7 +512,7 @@ The JSON structure is like the following example:
       "path": "lib/bar.rb",
       "offenses": [{
           "severity": "convention",
-          "message": "Line is too long. [81/79]",
+          "message": "Line is too long. [81/80]",
           "cop_name": "LineLength",
           "corrected": true,
           "location": {
@@ -721,12 +723,20 @@ priority right now. Writing a new cop is a great way to dive into RuboCop!
 Of course, bug reports and suggestions for improvements are always
 welcome. GitHub pull requests are even better! :-)
 
+I'm also accepting financial contributions via [gittip](https://www.gittip.com/bbatsov).
+
+[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/bbatsov)
+
 ## Mailing List
 
 If you're interested in everything regarding RuboCop's development,
 consider joining its
 [Google Group](https://groups.google.com/forum/?fromgroups#!forum/rubocop).
 
+## Freenode
+
+If you're into IRC you can visit the `#rubocop` channel on Freenode.
+
 ## Changelog
 
 RuboCop's changelog is available [here](CHANGELOG.md).

data/config/default.yml

@@ -12,7 +12,7 @@ AllCops:
     - '**/*.gemspec'
     - '**/Rakefile'
   Exclude:
-    - 'vendor/**'
+    - 'vendor/**/*'
   # 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
@@ -54,7 +54,7 @@ AlignHash:
   # inspected? Valid values are:
   #
   # always_inspect - Inspect both implicit and explicit hashes.
-  #   Registers and offence for:
+  #   Registers an offence for:
   #     function(a: 1,
   #       b: 2)
   #   Registers an offence for:
@@ -67,14 +67,14 @@ AlignHash:
   #   Accepts:
   #     function({a: 1,
   #       b: 2})
-  # ignore_implicit - Ingore only implicit hashes.
+  # ignore_implicit - Ignore only implicit hashes.
   #   Accepts:
   #     function(a: 1,
   #       b: 2)
   #   Registers an offence for:
   #     function({a: 1,
   #       b: 2})
-  # ignore_explicit - Ingore only explicit hashes.
+  # ignore_explicit - Ignore only explicit hashes.
   #   Accepts:
   #     function({a: 1,
   #       b: 2})
@@ -97,8 +97,8 @@ AlignParameters:
   #     method_call(a,
   #                 b)
   #
-  # The `with_fixed_indentation` style alignes the following lines with one
-  # level of indenation relative to the start of the line with the method call.
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with the method call.
   #
   #     method_call(a,
   #       b)
@@ -133,7 +133,7 @@ ClassAndModuleChildren:
   #
   # Basically there are two different styles:
   #
-  # `nested` - have each child on a separat line
+  # `nested` - have each child on a separate line
   #   class Foo
   #     class Bar
   #     end
@@ -238,6 +238,11 @@ FormatString:
 GlobalVars:
   AllowedVariables: []
 
+# `MinBodyLength` defines the number of lines of the a body of an if / unless
+# needs to have to trigger this cop
+GuardClause:
+  MinBodyLength: 1
+
 HashSyntax:
   EnforcedStyle: ruby19
   SupportedStyles:
@@ -245,7 +250,7 @@ HashSyntax:
     - hash_rockets
 
 IfUnlessModifier:
-  MaxLineLength: 79
+  MaxLineLength: 80
 
 # Checks the indentation of the first key in a hash literal.
 IndentHash:
@@ -268,7 +273,25 @@ LambdaCall:
     - braces
 
 LineLength:
-  Max: 79
+  Max: 80
+
+Next:
+  # With `always` all conditions at the end of an iteration needs to be
+  # replace by next - with `skip_modifier_ifs` the modifier if like this one
+  # are ignored: [1, 2].each { |a| return 'yes' if a == 1 }
+  EnforcedStyle: skip_modifier_ifs
+  SupportedStyles:
+    - skip_modifier_ifs
+    - always
+
+NonNilCheck:
+  # With `IncludeSemanticChanges` set to `true`, this cop reports offences for
+  # `!x.nil?` and autocorrects that and `x != nil` to solely `x`, which is
+  # **usually** OK, but might change behavior.
+  #
+  # With `IncludeSemanticChanges` set to `false`, this cop does not report
+  # offences for `!x.nil?` and does no changes that might change behavior.
+  IncludeSemanticChanges: false
 
 MethodDefParentheses:
   EnforcedStyle: require_parentheses
@@ -442,7 +465,7 @@ VariableName:
     - camelCase
 
 WhileUntilModifier:
-  MaxLineLength: 79
+  MaxLineLength: 80
 
 WordArray:
   MinSize: 0

data/config/disabled.yml

@@ -1,9 +1,5 @@
 # These are all the cops that are disabled in the default configuration.
 
-GuardClause:
-  Description: 'Check for conditionals that can be replaced with guard clauses'
-  Enabled: false
-
 MethodCalledOnDoEndBlock:
   Description: 'Avoid chaining a method call on a do...end block.'
   Enabled: false

data/config/enabled.yml

@@ -119,6 +119,10 @@ CommentAnnotation:
                  (TODO, FIXME, OPTIMIZE, HACK, REVIEW).
   Enabled: true
 
+CommentIndentation:
+  Description: 'Indentation of comments.'
+  Enabled: true
+
 ConstantName:
   Description: 'Constants should use SCREAMING_SNAKE_CASE.'
   Enabled: true
@@ -151,6 +155,10 @@ DoubleNegation:
   Description: 'Checks for uses of double negation (!!).'
   Enabled: true
 
+EachWithObject:
+  Description: 'Prefer `each_with_object` over `inject` or `reduce`.'
+  Enabled: true
+
 EmptyLineBetweenDefs:
   Description: 'Use empty lines between defs.'
   Enabled: true
@@ -260,7 +268,7 @@ LineEndConcatenation:
   Enabled: true
 
 LineLength:
-  Description: 'Limit lines to 79 characters.'
+  Description: 'Limit lines to 80 characters.'
   Enabled: true
 
 MethodCallParentheses:
@@ -313,6 +321,10 @@ NestedTernaryOperator:
   Description: 'Use one expression per branch in a ternary operator.'
   Enabled: true
 
+Next:
+  Description: 'Use `next` to skip iteration instead of a condition at the end.'
+  Enabled: true
+
 NilComparison:
   Description: 'Prefer x.nil? to x == nil.'
   Enabled: true
@@ -457,6 +469,12 @@ SpaceBeforeBlockBraces:
                  before it.
   Enabled: true
 
+SpaceBeforeComment:
+  Description: >-
+                 Checks for missing space between code and a comment on the
+                 same line.
+  Enabled: true
+
 SpaceInsideBlockBraces:
   Description: >-
                  Checks that block braces have or don't have surrounding space.
@@ -529,6 +547,10 @@ UnneededCapitalW:
   Description: 'Checks for %W when interpolation is not needed.'
   Enabled: true
 
+UnneededPercentX:
+  Description: 'Checks for %x when `` would do.'
+  Enabled: true
+
 VariableInterpolation:
   Description: >-
                  Don't interpolate global, instance and class variables
@@ -620,6 +642,10 @@ Eval:
   Description: 'The use of eval represents a serious security risk.'
   Enabled: true
 
+GuardClause:
+  Description: 'Check for conditionals that can be replaced with guard clauses'
+  Enabled: true
+
 HandleExceptions:
   Description: "Don't suppress exception."
   Enabled: true

data/lib/rubocop.rb

@@ -1,6 +1,16 @@
 # encoding: utf-8
 
-require 'parser/current'
+# Try to load the latest parser and fall back to the latest supported version,
+# if parser does not yet support the current Ruby version.
+# This should only be problem when using development Ruby builds.
+begin
+  require 'parser/current'
+rescue NotImplementedError => error
+  warn "Falling back to Ruby 2.1 parser: #{error.message}"
+  require 'parser/ruby21'
+  Parser::CurrentRuby = Parser::Ruby21
+end
+
 require 'rainbow'
 # Rainbow 2.0 does not load the monkey-patch for String by default.
 require 'rainbow/ext/string' unless String.method_defined?(:color)
@@ -56,6 +66,7 @@ require 'rubocop/cop/mixin/space_inside'
 require 'rubocop/cop/mixin/space_after_punctuation'
 require 'rubocop/cop/mixin/statement_modifier'
 require 'rubocop/cop/mixin/string_help'
+require 'rubocop/cop/mixin/unused_argument'
 
 require 'rubocop/cop/lint/ambiguous_operator'
 require 'rubocop/cop/lint/ambiguous_regexp_literal'
@@ -121,6 +132,7 @@ require 'rubocop/cop/style/class_vars'
 require 'rubocop/cop/style/collection_methods'
 require 'rubocop/cop/style/colon_method_call'
 require 'rubocop/cop/style/comment_annotation'
+require 'rubocop/cop/style/comment_indentation'
 require 'rubocop/cop/style/constant_name'
 require 'rubocop/cop/style/cyclomatic_complexity'
 require 'rubocop/cop/style/def_with_parentheses'
@@ -128,6 +140,7 @@ require 'rubocop/cop/style/deprecated_hash_methods'
 require 'rubocop/cop/style/documentation'
 require 'rubocop/cop/style/dot_position'
 require 'rubocop/cop/style/double_negation'
+require 'rubocop/cop/style/each_with_object'
 require 'rubocop/cop/style/empty_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
 require 'rubocop/cop/style/empty_lines_around_access_modifier'
@@ -167,6 +180,7 @@ require 'rubocop/cop/style/multiline_ternary_operator'
 require 'rubocop/cop/style/negated_if'
 require 'rubocop/cop/style/negated_while'
 require 'rubocop/cop/style/nested_ternary_operator'
+require 'rubocop/cop/style/next'
 require 'rubocop/cop/style/nil_comparison'
 require 'rubocop/cop/style/non_nil_check'
 require 'rubocop/cop/style/not'
@@ -201,6 +215,7 @@ require 'rubocop/cop/style/space_after_semicolon'
 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'
+require 'rubocop/cop/style/space_before_comment'
 require 'rubocop/cop/style/space_before_modifier_keyword'
 require 'rubocop/cop/style/space_inside_block_braces'
 require 'rubocop/cop/style/space_inside_brackets'
@@ -216,6 +231,7 @@ require 'rubocop/cop/style/trailing_whitespace'
 require 'rubocop/cop/style/trivial_accessors'
 require 'rubocop/cop/style/unless_else'
 require 'rubocop/cop/style/unneeded_capital_w'
+require 'rubocop/cop/style/unneeded_percent_x'
 require 'rubocop/cop/style/variable_interpolation'
 require 'rubocop/cop/style/variable_name'
 require 'rubocop/cop/style/when_then'

data/lib/rubocop/config.rb

@@ -25,36 +25,42 @@ module Rubocop
     end
 
     def make_excludes_absolute
-      if self['AllCops'] && self['AllCops']['Exclude']
-        self['AllCops']['Exclude'].map! do |exclude_elem|
-          if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
-            File.join(base_dir_for_path_parameters, exclude_elem)
-          else
-            exclude_elem
-          end
+      return unless self['AllCops'] && self['AllCops']['Exclude']
+
+      self['AllCops']['Exclude'].map! do |exclude_elem|
+        if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
+          File.join(base_dir_for_path_parameters, exclude_elem)
+        else
+          exclude_elem
         end
       end
     end
 
     def add_excludes_from_higher_level(highest_config)
-      if highest_config['AllCops'] && highest_config['AllCops']['Exclude']
-        self['AllCops'] ||= {}
-        excludes = self['AllCops']['Exclude'] ||= []
-        highest_config['AllCops']['Exclude'].each do |path|
-          unless path.is_a?(Regexp) || path.start_with?('/')
-            path = File.join(File.dirname(highest_config.loaded_path), path)
-          end
-          excludes << path unless excludes.include?(path)
+      return unless highest_config['AllCops'] &&
+        highest_config['AllCops']['Exclude']
+
+      self['AllCops'] ||= {}
+      excludes = self['AllCops']['Exclude'] ||= []
+      highest_config['AllCops']['Exclude'].each do |path|
+        unless path.is_a?(Regexp) || path.start_with?('/')
+          path = File.join(File.dirname(highest_config.loaded_path), path)
         end
+        excludes << path unless excludes.include?(path)
       end
     end
 
     def deprecation_check
-      return unless self['AllCops']
-      if self['AllCops']['Excludes']
-        yield 'AllCops/Excludes was renamed to AllCops/Exclude'
-      elsif self['AllCops']['Includes']
-        yield 'AllCops/Includes was renamed to AllCops/Include'
+      all_cops = self['AllCops']
+      return unless all_cops
+
+      %w(Exclude Include).each do |key|
+        plural = "#{key}s"
+        next unless all_cops[plural]
+
+        all_cops[key] = all_cops[plural] # Stay backwards compatible.
+        all_cops.delete(plural)
+        yield "AllCops/#{plural} was renamed to AllCops/#{key}"
       end
     end
 
@@ -91,12 +97,12 @@ module Rubocop
 
       valid_cop_names.each do |name|
         @hash[name].each_key do |param|
-          unless COMMON_PARAMS.include?(param) ||
-                 default_config[name].key?(param)
-            fail ValidationError,
-                 "unrecognized parameter #{name}:#{param} found " \
-                 "in #{loaded_path || self}"
-          end
+          next if COMMON_PARAMS.include?(param) ||
+            default_config[name].key?(param)
+
+          fail ValidationError,
+               "unrecognized parameter #{name}:#{param} found " \
+               "in #{loaded_path || self}"
         end
       end
     end
@@ -109,7 +115,6 @@ module Rubocop
     end
 
     def file_to_exclude?(file)
-      file = File.join(Dir.pwd, file) unless file.start_with?('/')
       file = File.expand_path(file)
       patterns_to_exclude.any? do |pattern|
         match_path?(pattern, file, loaded_path)