rubocop 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e091003352d55c98a9579dc743d9ab5542a32229
-  data.tar.gz: a1840b93e9ee0d9cac37c4a9e3749acf17fca02b
+  metadata.gz: 18bb71a6ddd6cdd142c68e789a70b0baf5704d79
+  data.tar.gz: f239d5e80896196e17211fa6834e3d7a261cb0e7
 SHA512:
-  metadata.gz: 6f9ac51993ab31b7b6c0a9ffdd1ab5136a024cf5d341891e71ad5af0f1ef08cbb09f77759dbe8aefd0a64f04a306b64649f1c53c6977b0c2d4436786d04ed5ef
-  data.tar.gz: 8a78d285ece4159fade45e13ee06af7286632a1176130760dbd8c2599efc288ee6d7abf88775a1a3127e2879b2fe475219ed19fadd069125a7763ee00352e724
+  metadata.gz: 1bac37f99223a0c20c2e7ba29c4dbbc1fc907962102962679153f6a55c5f1b1a5bdb2d482029aef3b7abf63242a31ebce47be9ea55f40ba3ccb858bf8951f69e
+  data.tar.gz: acf9e58f556f5fcc298584233e2ed12afc8ebe7f434fc7a0ac747a5f0cb1ef1579d5d14e9e4dad065eec13c9e3d39bd103b85790d4ce455f92f6210f026d1650

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 ## master (unreleased)
 
+## 0.21.0 (24/04/2014)
+
+### 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][])
+
 ## 0.20.1 (05/04/2014)
 
 ### Bugs fixed
@@ -849,3 +891,7 @@
 [@tamird]: https://github.com/tamird
 [@fshowalter]: https://github.com/fshowalter
 [@cschramm]: https://github.com/cschramm
+[@bquorning]: https://github.com/bquorning
+[@bcobb]: https://github.com/bcobb
+[@irrationalfab]: https://github.com/irrationalfab
+[@sfeldon]: https://github.com/sfeldon

data/README.md

@@ -138,7 +138,7 @@ Command flag              | Description
 `-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
+`--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
@@ -166,6 +166,9 @@ own. You can run only the lint cops like this:
 $ rubocop -l
 ```
 
+The `-l`/`--lint` option can be used together with `--only` to run all the
+enabled lint cops plus a selection of other cops.
+
 Disabling any of the lint cops is generally a bad idea.
 
 #### Rails
@@ -247,9 +250,9 @@ AllCops:
     - Rakefile
     - config.ru
   Exclude:
-    - db/**
-    - config/**
-    - script/**
+    - db/**/*
+    - config/**/*
+    - script/**/*
     - !ruby/regexp /old_and_unused\.rb$/
 
 # other configuration
@@ -258,6 +261,15 @@ AllCops:
 
 Files and directories are specified relative to the `.rubocop.yml` file.
 
+**Note**: Patterns that are just a file name, e.g. `Rakefile`, will match
+that file name in any directory, but this pattern style deprecated. The
+correct way to match the file in any directory, including the current, is
+`**/Rakefile`.
+
+**Note**: The pattern `config/**` will match any file recursively under
+`config`, but this pattern style is deprecated and should be replaced by
+`config/**/*`.
+
 **Note**: The `Exclude` parameter is special. It is valid for the
 directory tree starting where it is defined. It is not shadowed by the
 setting of `Exclude` in other `.rubocop.yml` files in

data/config/default.yml

@@ -155,6 +155,12 @@ ClassLength:
 
 # Align with the style guide.
 CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
   PreferredMethods:
     collect: 'map'
     collect!: 'map!'
@@ -188,6 +194,13 @@ EmptyLineBetweenDefs:
   # need an empty line between them.
   AllowAdjacentOneLineDefs: false
 
+# Checks whether the source file has a utf-8 encoding comment or not
+Encoding:
+  EnforcedStyle: always
+  SupportedStyles:
+    - when_needed
+    - always
+
 # Align ends correctly.
 EndAlignment:
   # The value `keyword` means that `end` should be aligned with the matching
@@ -202,9 +215,9 @@ EndAlignment:
 
 FileName:
   Exclude:
-    - Rakefile
-    - Gemfile
-    - Capfile
+    - '**/Rakefile'
+    - '**/Gemfile'
+    - '**/Capfile'
 
 # Checks use of for or each in multiline loops.
 For:
@@ -377,6 +390,12 @@ SpaceInsideHashLiteralBraces:
     - space
     - no_space
 
+TrailingBlankLines:
+  EnforcedStyle: final_newline
+  SupportedStyles:
+    - final_newline
+    - final_blank_line
+
 TrailingComma:
   EnforcedStyleForMultiline: no_comma
   SupportedStyles:
@@ -388,6 +407,15 @@ TrailingComma:
 TrivialAccessors:
   ExactNameMatch: false
   AllowPredicates: false
+  # Allows trivial writers that don't end in an equal sign. e.g.
+  #
+  # def on_exception(action)
+  #   @on_exception=action
+  # end
+  # on_exception :restart
+  #
+  # Commonly used in DSLs
+  AllowDSLWriters: false
   Whitelist:
     - to_ary
     - to_a
@@ -427,25 +455,24 @@ ActionFilter:
     - action
     - filter
   Include:
-    - app/controllers/*.rb
+    - app/controllers/**/*.rb
 
 DefaultScope:
   Include:
-    - app/models/*.rb
+    - app/models/**/*.rb
 
 HasAndBelongsToMany:
   Include:
-    - app/models/*.rb
+    - app/models/**/*.rb
 
 ReadWriteAttribute:
   Include:
-    - app/models/*.rb
+    - app/models/**/*.rb
 
 ScopeArgs:
   Include:
-    - app/models/*.rb
+    - app/models/**/*.rb
 
 Validation:
   Include:
-    - app/models/*.rb
-
+    - app/models/**/*.rb

data/config/enabled.yml

@@ -131,6 +131,10 @@ DefWithParentheses:
   Description: 'Use def with parentheses when there are arguments.'
   Enabled: true
 
+Delegate:
+  Description: 'Prefer delegate method for delegations.'
+  Enabled: true
+
 DeprecatedHashMethods:
   Description: 'Checks for use of deprecated Hash methods.'
   Enabled: true
@@ -187,10 +191,6 @@ FileName:
   Description: 'Use snake_case for source file names.'
   Enabled: true
 
-FinalNewline:
-  Description: 'Checks for a final newline in a source file.'
-  Enabled: true
-
 FlipFlop:
   Description: 'Checks for flip flops'
   Enabled: true
@@ -254,7 +254,9 @@ LeadingCommentSpace:
   Enabled: true
 
 LineEndConcatenation:
-  Description: 'Use \\ instead of + to concatenate two string literals at line end.'
+  Description: >-
+                 Use \ instead of + or << to concatenate two string literals at
+                 line end.
   Enabled: true
 
 LineLength:
@@ -502,7 +504,7 @@ Tab:
   Enabled: true
 
 TrailingBlankLines:
-  Description: 'Checks for superfluous trailing blank lines.'
+  Description: 'Checks trailing blank lines and final newline.'
   Enabled: true
 
 TrailingComma:
@@ -523,6 +525,10 @@ UnlessElse:
                  case first.
   Enabled: true
 
+UnneededCapitalW:
+  Description: 'Checks for %W when interpolation is not needed.'
+  Enabled: true
+
 VariableInterpolation:
   Description: >-
                  Don't interpolate global, instance and class variables
@@ -663,13 +669,25 @@ ShadowingOuterLocalVariable:
 SpaceBeforeFirstArg:
   Description: >-
                  Put a space between a method name and the first argument
-                 in a method call wihtout parentheses.
+                 in a method call without parentheses.
   Enabled: true
 
 StringConversionInInterpolation:
   Description: 'Checks for Object#to_s usage in string interpolation.'
   Enabled: true
 
+UnderscorePrefixedVariableName:
+  Description: 'Do not use prefix `_` for a variable that is used.'
+  Enabled: true
+
+UnusedBlockArgument:
+  Description: 'Checks for unused block arguments.'
+  Enabled: true
+
+UnusedMethodArgument:
+  Description: 'Checks for unused method arguments.'
+  Enabled: true
+
 UnreachableCode:
   Description: 'Unreachable code.'
   Enabled: true

data/lib/rubocop.rb

@@ -1,16 +1,6 @@
 # encoding: utf-8
 
-# 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 'parser/current'
 require 'rainbow'
 # Rainbow 2.0 does not load the monkey-patch for String by default.
 require 'rainbow/ext/string' unless String.method_defined?(:color)
@@ -33,16 +23,17 @@ require 'rubocop/cop/ignored_node'
 require 'rubocop/cop/cop'
 require 'rubocop/cop/commissioner'
 require 'rubocop/cop/corrector'
+require 'rubocop/cop/force'
 require 'rubocop/cop/team'
 require 'rubocop/cop/severity'
 
-require 'rubocop/cop/variable_inspector'
-require 'rubocop/cop/variable_inspector/locatable'
-require 'rubocop/cop/variable_inspector/variable'
-require 'rubocop/cop/variable_inspector/assignment'
-require 'rubocop/cop/variable_inspector/reference'
-require 'rubocop/cop/variable_inspector/scope'
-require 'rubocop/cop/variable_inspector/variable_table'
+require 'rubocop/cop/variable_force'
+require 'rubocop/cop/variable_force/locatable'
+require 'rubocop/cop/variable_force/variable'
+require 'rubocop/cop/variable_force/assignment'
+require 'rubocop/cop/variable_force/reference'
+require 'rubocop/cop/variable_force/scope'
+require 'rubocop/cop/variable_force/variable_table'
 
 require 'rubocop/cop/mixin/annotation_comment'
 require 'rubocop/cop/mixin/array_syntax'
@@ -58,6 +49,7 @@ require 'rubocop/cop/mixin/if_node'
 require 'rubocop/cop/mixin/if_then_else'
 require 'rubocop/cop/mixin/negative_conditional'
 require 'rubocop/cop/mixin/parser_diagnostic'
+require 'rubocop/cop/mixin/percent_literal'
 require 'rubocop/cop/mixin/safe_assignment'
 require 'rubocop/cop/mixin/surrounding_space'
 require 'rubocop/cop/mixin/space_inside'
@@ -91,7 +83,10 @@ require 'rubocop/cop/lint/shadowing_outer_local_variable'
 require 'rubocop/cop/lint/space_before_first_arg'
 require 'rubocop/cop/lint/string_conversion_in_interpolation'
 require 'rubocop/cop/lint/syntax'
+require 'rubocop/cop/lint/underscore_prefixed_variable_name'
 require 'rubocop/cop/lint/unreachable_code'
+require 'rubocop/cop/lint/unused_block_argument'
+require 'rubocop/cop/lint/unused_method_argument'
 require 'rubocop/cop/lint/useless_access_modifier'
 require 'rubocop/cop/lint/useless_assignment'
 require 'rubocop/cop/lint/useless_comparison'
@@ -143,7 +138,6 @@ require 'rubocop/cop/style/end_block'
 require 'rubocop/cop/style/end_of_line'
 require 'rubocop/cop/style/even_odd'
 require 'rubocop/cop/style/file_name'
-require 'rubocop/cop/style/final_newline'
 require 'rubocop/cop/style/flip_flop'
 require 'rubocop/cop/style/for'
 require 'rubocop/cop/style/format_string'
@@ -221,6 +215,7 @@ require 'rubocop/cop/style/trailing_comma'
 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/variable_interpolation'
 require 'rubocop/cop/style/variable_name'
 require 'rubocop/cop/style/when_then'
@@ -230,6 +225,7 @@ require 'rubocop/cop/style/word_array'
 
 require 'rubocop/cop/rails/action_filter'
 require 'rubocop/cop/rails/default_scope'
+require 'rubocop/cop/rails/delegate'
 require 'rubocop/cop/rails/has_and_belongs_to_many'
 require 'rubocop/cop/rails/output'
 require 'rubocop/cop/rails/read_write_attribute'

data/lib/rubocop/cli.rb

@@ -24,7 +24,7 @@ module Rubocop
       trap_interrupt
 
       @options, remaining_args = Options.new.parse(args)
-      act_on_options(remaining_args)
+      act_on_options
       target_files = target_finder.find(remaining_args)
 
       inspector = FileInspector.new(@options)
@@ -51,7 +51,7 @@ module Rubocop
 
     private
 
-    def act_on_options(args)
+    def act_on_options
       handle_exiting_options
 
       ConfigLoader.debug = @options[:debug]

data/lib/rubocop/config.rb

@@ -24,6 +24,40 @@ module Rubocop
       super(@hash)
     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
+        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)
+        end
+      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'
+      end
+    end
+
     def for_cop(cop)
       cop = cop.cop_name if cop.respond_to?(:cop_name)
       self[cop]
@@ -70,13 +104,16 @@ module Rubocop
     def file_to_include?(file)
       relative_file_path = path_relative_to_config(file)
       patterns_to_include.any? do |pattern|
-        match_path?(pattern, relative_file_path)
+        match_path?(pattern, relative_file_path, loaded_path)
       end
     end
 
     def file_to_exclude?(file)
       file = File.join(Dir.pwd, file) unless file.start_with?('/')
-      patterns_to_exclude.any? { |pattern| match_path?(pattern, file) }
+      file = File.expand_path(file)
+      patterns_to_exclude.any? do |pattern|
+        match_path?(pattern, file, loaded_path)
+      end
     end
 
     def patterns_to_include
@@ -97,7 +134,7 @@ module Rubocop
     # not relative to RuboCop's config directory since that wouldn't work.
     def base_dir_for_path_parameters
       if File.basename(loaded_path) == ConfigLoader::DOTFILE
-        File.dirname(loaded_path)
+        File.expand_path(File.dirname(loaded_path))
       else
         Dir.pwd
       end