rubocop 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8589f766e3f0895be647fba9351e4fb39a59a9a
-  data.tar.gz: e19066dcc0432f7e529721251f23f9349fc37cab
+  metadata.gz: fa14a751d9a506d14ddc238a96b32436f59694d7
+  data.tar.gz: f522a8666bb49b81317c707e8a279ea1e31d49b8
 SHA512:
-  metadata.gz: 8e7c61eb4754551ff087156bb63393b93661e8e1d49f44577ee2ec57e701f23303fac4b300ccf8249fee63f4c6925015d4107fbb5b2cb3bd98681e9c2313a68e
-  data.tar.gz: 3ff42ef90979b0a32df0411da3b6404c243efbbd3902cc3cb1b53d9a614892b5942c70a1077b2819692c403a51e4f69737933b64338784d30e6e7899307763b8
+  metadata.gz: f3c12cd56fa480bf29ada0d78e2790016756a12d6c545238c14b621a95a5d74cab15f2628663f943042a3658021058e6d8337fd3181365fa6d57604552e65983
+  data.tar.gz: ac12f065a8921d0de5152716e5796cbe30621b6791103dfab15e97675ad7594ed3553579b12b34c29efd20d605d72e6b4a1d756631048021709216e10a614e5f

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
   - ruby-head
   - jruby-19mode
   - rbx-2

data/CHANGELOG.md

@@ -2,6 +2,39 @@
 
 ## master (unreleased)
 
+## 0.24.0 (25/06/2014)
+
+### New features
+
+* [#639](https://github.com/bbatsov/rubocop/issues/639): Support square bracket setters in `UselessSetterCall`. ([@yujinakayama][])
+* [#835](https://github.com/bbatsov/rubocop/issues/835): `UnneededCapitalW` cop does auto-correction. ([@sfeldon][])
+* [#1092](https://github.com/bbatsov/rubocop/issues/1092): New cop `DefEndAlignment` takes over responsibility for checkng alignment of method definition `end`s from `EndAlignment`, and is configurable. ([@jonas054][])
+* [#1145](https://github.com/bbatsov/rubocop/issues/1145): New cop `ClassCheck` enforces consistent use of `is_a?` or `kind_of?`. ([@bbatsov][])
+* [#1161](https://github.com/bbatsov/rubocop/pull/1161): New cop `SpaceBeforeComma` detects spaces before a comma. ([@agrimm][])
+* [#1161](https://github.com/bbatsov/rubocop/pull/1161): New cop `SpaceBeforeSemicolon` detects spaces before a semicolon. ([@agrimm][])
+* [#835](https://github.com/bbatsov/rubocop/issues/835): New cop `UnneededPercentQ` checks for usage of the `%q`/`%Q` syntax when `''` or `""` would do. ([@jonas054][])
+* [#977](https://github.com/bbatsov/rubocop/issues/977): Add `AllowURI` option (enabled by default) to `LineLength` cop. ([@yujinakayama][])
+
+### Changes
+
+* Unused block local variables (`obj.each { |arg; this| }`) are now handled by `UnusedBlockArgument` cop instead of `UselessAssignment` cop. ([@yujinakayama][])
+* [#1141](https://github.com/bbatsov/rubocop/issues/1141): Clarify in the message from `TrailingComma` that a trailing comma is never allowed for lists where some items share a line. ([@jonas054][])
+
+### Bugs fixed
+
+* [#1133](https://github.com/bbatsov/rubocop/issues/1133): Handle `reduce/inject` with no arguments in `EachWithObject`. ([@bbatsov][])
+* [#1152](https://github.com/bbatsov/rubocop/issues/1152): Handle `while/until` with no body in `Next`. ([@tamird][])
+* Fix a false positive in `UselessSetterCall` for setter call on a local variable that contains a non-local object. ([@yujinakayama][])
+* [#1158](https://github.com/bbatsov/rubocop/issues/1158): Fix auto-correction of floating-point numbers. ([@bbatsov][])
+* [#1159](https://github.com/bbatsov/rubocop/issues/1159): Fix checking of `begin`..`end` structures, blocks, and parenthesized expressions in `IndentationWidth`. ([@jonas054][])
+* [#1159](https://github.com/bbatsov/rubocop/issues/1159): More rigid conditions for when `attr` is considered an offense. ([@jonas054][])
+* [#1167](https://github.com/bbatsov/rubocop/issues/1167): Fix handling of parameters spanning multiple lines in `TrailingComma`. ([@jonas054][])
+* [#1169](https://github.com/bbatsov/rubocop/issues/1169): Fix handling of ternary op conditions in `ParenthesesAroundCondition`. ([@bbatsov][])
+* [#1147](https://github.com/bbatsov/rubocop/issues/1147): WordArray checks arrays with special characters. ([@camilleldn][])
+* Fix a false positive against `return` in a loop in `Next` cop. ([@yujinakayama][])
+* [#1165](https://github.com/bbatsov/rubocop/issues/1165): Support `rescue`/`else`/`ensure` bodies in `IndentationWidth`. ([@jonas054][])
+* Fix false positive for aligned list of values after `when` in `IndentationWidth`. ([@jonas054][])
+
 ## 0.23.0 (02/06/2014)
 
 ### New features
@@ -32,7 +65,7 @@
 * [#1120](https://github.com/bbatsov/rubocop/issues/1120): Don't change indentation of heredoc strings in auto-correct. ([@jonas054][])
 * [#1109](https://github.com/bbatsov/rubocop/issues/1109): Handle conditions with modifier ops in them in `ParenthesesAroundCondition`. ([@bbatsov][])
 
-## 0.22.0 (20/04/2014)
+## 0.22.0 (20/05/2014)
 
 ### New features
 
@@ -969,3 +1002,4 @@
 [@wndhydrnt]: https://github.com/wndhydrnt
 [@ggilder]: https://github.com/ggilder
 [@salbertson]: https://github.com/salbertson
+[@camilleldn]: https://github.com/camilleldn

data/CONTRIBUTING.md

@@ -38,7 +38,7 @@ $ rubocop -V
   is fine, but please isolate to its own commit so I can cherry-pick
   around it.
 * Make sure the test suite is passing ([including rbx and jruby][7]) and the code you wrote doesn't produce
-  RuboCop offences.
+  RuboCop offenses.
 * [Squash related commits together][5].
 * Open a [pull request][4] that relates to *only* one subject with a clear title
   and description in grammatically correct, complete sentences.

data/README.md

@@ -3,7 +3,7 @@
 [![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.svg)](http://inch-pages.github.io/github/bbatsov/rubocop)
+[![Inline docs](http://inch-ci.org/github/bbatsov/rubocop.svg)](http://inch-ci.org/github/bbatsov/rubocop)
 
 # RuboCop
 
@@ -257,12 +257,12 @@ Here is an example that might be used for a Rails project:
 ```yaml
 AllCops:
   Include:
-    - Rakefile
-    - config.ru
+    - '**/Rakefile'
+    - '**/config.ru'
   Exclude:
-    - db/**/*
-    - config/**/*
-    - script/**/*
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
     - !ruby/regexp /old_and_unused\.rb$/
 
 # other configuration

data/config/default.yml

@@ -54,10 +54,10 @@ Style/AlignHash:
   # inspected? Valid values are:
   #
   # always_inspect - Inspect both implicit and explicit hashes.
-  #   Registers an offence for:
+  #   Registers an offense for:
   #     function(a: 1,
   #       b: 2)
-  #   Registers an offence for:
+  #   Registers an offense for:
   #     function({a: 1,
   #       b: 2})
   # always_ignore - Ignore both implicit and explicit hashes.
@@ -71,14 +71,14 @@ Style/AlignHash:
   #   Accepts:
   #     function(a: 1,
   #       b: 2)
-  #   Registers an offence for:
+  #   Registers an offense for:
   #     function({a: 1,
   #       b: 2})
   # ignore_explicit - Ignore only explicit hashes.
   #   Accepts:
   #     function({a: 1,
   #       b: 2})
-  #   Registers an offence for:
+  #   Registers an offense for:
   #     function(a: 1,
   #       b: 2)
   EnforcedLastArgumentHashStyle: always_inspect
@@ -145,6 +145,12 @@ Style/ClassAndModuleChildren:
     - nested
     - compact
 
+Style/ClassCheck:
+  EnforcedStyle: is_a?
+  SupportedStyles:
+    - is_a?
+    - kind_of?
+    
 Style/ClassLength:
   CountComments: false  # count full line comments?
   Max: 100
@@ -258,6 +264,7 @@ Style/LambdaCall:
 
 Style/LineLength:
   Max: 80
+  AllowURI: true
 
 Style/Next:
   # With `always` all conditions at the end of an iteration needs to be
@@ -269,12 +276,12 @@ Style/Next:
     - always
 
 Style/NonNilCheck:
-  # With `IncludeSemanticChanges` set to `true`, this cop reports offences for
+  # With `IncludeSemanticChanges` set to `true`, this cop reports offenses 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.
+  # offenses for `!x.nil?` and does no changes that might change behavior.
   IncludeSemanticChanges: false
 
 Style/MethodDefParentheses:
@@ -404,6 +411,8 @@ Style/TrailingBlankLines:
     - final_blank_line
 
 Style/TrailingComma:
+  # If EnforcedStyleForMultiline is comma, the cop allows a comma after the
+  # last item of a list, but only for lists where each item is on its own line.
   EnforcedStyleForMultiline: no_comma
   SupportedStyles:
     - comma
@@ -472,6 +481,16 @@ Lint/EndAlignment:
     - keyword
     - variable
 
+Lint/DefEndAlignment:
+  # The value `def` means that `end` should be aligned with the def keyword.
+  # The value `start_of_line` means that `end` should be aligned with method
+  # calls like `private`, `public`, etc, if present in front of the `def`
+  # keyword on the same line.
+  AlignWith: start_of_line
+  SupportedStyles:
+    - start_of_line
+    - def
+
 ##################### Rails ##################################
 
 Rails/ActionFilter:

data/config/enabled.yml

@@ -93,6 +93,10 @@ Style/ClassAndModuleChildren:
   Description: 'Checks style of children classes and modules.'
   Enabled: true
 
+Style/ClassCheck:
+  Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
+  Enabled: true
+
 Style/ClassLength:
   Description: 'Avoid classes longer than 100 lines of code.'
   Enabled: true
@@ -469,12 +473,20 @@ Style/SpaceBeforeBlockBraces:
                  before it.
   Enabled: true
 
+Style/SpaceBeforeComma:
+  Description: 'No spaces before commas.'
+  Enabled: true
+
 Style/SpaceBeforeComment:
   Description: >-
                  Checks for missing space between code and a comment on the
                  same line.
   Enabled: true
 
+Style/SpaceBeforeSemicolon:
+  Description: 'No spaces before semicolons.'
+  Enabled: true
+
 Style/SpaceInsideBlockBraces:
   Description: >-
                  Checks that block braces have or don't have surrounding space.
@@ -547,6 +559,10 @@ Style/UnneededCapitalW:
   Description: 'Checks for %W when interpolation is not needed.'
   Enabled: true
 
+Style/UnneededPercentQ:
+  Description: 'Checks for %q/%Q when single quotes or double quotes would do.'
+  Enabled: true
+
 Style/UnneededPercentX:
   Description: 'Checks for %x when `` would do.'
   Enabled: true
@@ -610,6 +626,10 @@ Lint/Debugger:
   Description: 'Check for debugger calls.'
   Enabled: true
 
+Lint/DefEndAlignment:
+  Description: 'Align ends corresponding to defs correctly.'
+  Enabled: true
+
 Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
   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)
@@ -45,6 +35,7 @@ require 'rubocop/cop/variable_force/reference'
 require 'rubocop/cop/variable_force/scope'
 require 'rubocop/cop/variable_force/variable_table'
 
+require 'rubocop/cop/mixin/access_modifier_node'
 require 'rubocop/cop/mixin/annotation_comment'
 require 'rubocop/cop/mixin/array_syntax'
 require 'rubocop/cop/mixin/autocorrect_alignment'
@@ -55,6 +46,7 @@ require 'rubocop/cop/mixin/configurable_max'
 require 'rubocop/cop/mixin/code_length'
 require 'rubocop/cop/mixin/configurable_enforced_style'
 require 'rubocop/cop/mixin/configurable_naming'
+require 'rubocop/cop/mixin/end_keyword_alignment'
 require 'rubocop/cop/mixin/if_node'
 require 'rubocop/cop/mixin/if_then_else'
 require 'rubocop/cop/mixin/negative_conditional'
@@ -64,6 +56,7 @@ require 'rubocop/cop/mixin/safe_assignment'
 require 'rubocop/cop/mixin/surrounding_space'
 require 'rubocop/cop/mixin/space_inside'
 require 'rubocop/cop/mixin/space_after_punctuation'
+require 'rubocop/cop/mixin/space_before_punctuation'
 require 'rubocop/cop/mixin/statement_modifier'
 require 'rubocop/cop/mixin/string_help'
 require 'rubocop/cop/mixin/unused_argument'
@@ -74,6 +67,7 @@ require 'rubocop/cop/lint/assignment_in_condition'
 require 'rubocop/cop/lint/block_alignment'
 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/else_layout'
 require 'rubocop/cop/lint/empty_ensure'
@@ -126,6 +120,7 @@ require 'rubocop/cop/style/case_indentation'
 require 'rubocop/cop/style/character_literal'
 require 'rubocop/cop/style/class_and_module_camel_case'
 require 'rubocop/cop/style/class_and_module_children'
+require 'rubocop/cop/style/class_check'
 require 'rubocop/cop/style/class_length'
 require 'rubocop/cop/style/class_methods'
 require 'rubocop/cop/style/class_vars'
@@ -216,8 +211,10 @@ 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_comma'
 require 'rubocop/cop/style/space_before_comment'
 require 'rubocop/cop/style/space_before_modifier_keyword'
+require 'rubocop/cop/style/space_before_semicolon'
 require 'rubocop/cop/style/space_inside_block_braces'
 require 'rubocop/cop/style/space_inside_brackets'
 require 'rubocop/cop/style/space_inside_hash_literal_braces'
@@ -232,6 +229,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_q'
 require 'rubocop/cop/style/unneeded_percent_x'
 require 'rubocop/cop/style/variable_interpolation'
 require 'rubocop/cop/style/variable_name'
@@ -269,7 +267,6 @@ require 'rubocop/target_finder'
 require 'rubocop/token'
 require 'rubocop/comment_config'
 require 'rubocop/processed_source'
-require 'rubocop/source_parser'
-require 'rubocop/file_inspector'
+require 'rubocop/runner'
 require 'rubocop/cli'
 require 'rubocop/options'

data/lib/rubocop/cli.rb

@@ -4,13 +4,8 @@ module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
-    # If set true while running,
-    # RuboCop will abort processing and exit gracefully.
-    attr_accessor :wants_to_quit
     attr_reader :options, :config_store
 
-    alias_method :wants_to_quit?, :wants_to_quit
-
     def initialize
       @options = {}
       @config_store = ConfigStore.new
@@ -21,19 +16,15 @@ module RuboCop
     # the target files
     # @return [Fixnum] UNIX exit code
     def run(args = ARGV)
-      trap_interrupt
-
-      @options, remaining_args = Options.new.parse(args)
+      @options, paths = Options.new.parse(args)
       act_on_options
-      target_files = target_finder.find(remaining_args)
 
-      inspector = FileInspector.new(@options)
-      any_failed = inspector.process_files(target_files, @config_store) do
-        wants_to_quit?
-      end
-      inspector.display_error_summary
+      runner = Runner.new(@options, @config_store)
+      trap_interrupt(runner)
+      all_passed = runner.run(paths)
+      display_error_summary(runner.errors)
 
-      !any_failed && !wants_to_quit ? 0 : 1
+      all_passed && !runner.aborting? ? 0 : 1
     rescue Cop::AmbiguousCopName => e
       $stderr.puts "Ambiguous cop name #{e.message} needs namespace " \
                    'qualifier.'
@@ -44,10 +35,10 @@ module RuboCop
       return 1
     end
 
-    def trap_interrupt
+    def trap_interrupt(runner)
       Signal.trap('INT') do
-        exit!(1) if wants_to_quit?
-        self.wants_to_quit = true
+        exit!(1) if runner.aborting?
+        runner.abort
         $stderr.puts
         $stderr.puts 'Exiting... Interrupt again to exit immediately.'
       end
@@ -106,8 +97,20 @@ module RuboCop
       end
     end
 
-    def target_finder
-      @target_finder ||= TargetFinder.new(@config_store, @options)
+    def display_error_summary(errors)
+      return if errors.empty?
+
+      plural = errors.count > 1 ? 's' : ''
+      warn "\n#{errors.count} error#{plural} occurred:".color(:red)
+
+      errors.each { |error| warn error }
+
+      warn <<-END.strip_indent
+        Errors are usually caused by RuboCop bugs.
+        Please, report your problems to RuboCop's issue tracker.
+        Mention the following information in the issue report:
+        #{RuboCop::Version.version(true)}
+      END
     end
   end
 end

data/lib/rubocop/cop/lint/def_end_alignment.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop checks whether the end keywords of method definitions are
+      # aligned properly.
+      #
+      # Two modes are supported through the AlignWith configuration
+      # parameter. If it's set to `start_of_line` (which is the default), the
+      # `end` shall be aligned with the start of the line where the `def`
+      # keyword is. If it's set to `def`, the `end` shall be aligned with the
+      # `def` keyword.
+      #
+      # @example
+      #
+      #   private def foo
+      #   end
+      class DefEndAlignment < Cop
+        include CheckMethods
+        include EndKeywordAlignment
+
+        MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d'
+
+        def on_send(node)
+          receiver, method_name, *args = *node
+          return unless visibility_and_def_on_same_line?(receiver, method_name,
+                                                         args)
+
+          method_def = args.first
+          if style == :start_of_line
+            expr = node.loc.expression
+            range = Parser::Source::Range.new(expr.source_buffer,
+                                              expr.begin_pos,
+                                              method_def.loc.keyword.end_pos)
+            check_offset(method_def, range.source,
+                         method_def.loc.keyword.begin_pos - expr.begin_pos)
+          else
+            check_offset(method_def, 'def', 0)
+          end
+
+          ignore_node(method_def) # Don't check the same `end` again.
+        end
+      end
+    end
+  end
+end