rubocop 0.12.0 → 0.13.0

data/CHANGELOG.md

@@ -2,6 +2,46 @@
 
 ## master (unreleased)
 
+### New features
+
+* New configuration parameter `AllowAdjacentOneLineDefs` for `EmptyLineBetweenDefs`.
+* New cop `MultilineBlockChain` keeps track of chained blocks spanning multiple lines.
+* `RedundantSelf` cop does auto-correction
+* `AvoidPerlBackrefs` cop does auto-correction.
+* `AvoidPerlisms` cop does auto-correction.
+* `RedundantReturn` cop does auto-correction.
+* `Blocks` cop does auto-correction.
+* New cop `TrailingBlankLines` keeps track of extra blanks lines at the end of source file.
+* New cop `AlignHash` keeps track of bad alignment in multi-line hash literals.
+* New cop `AlignArray` keeps track of bad alignment in multi-line array literals.
+* New cop `SpaceBeforeModifierKeyword` keeps track of missing space before a modifier keyword (`if`, `unless`, `while`, `until`).
+* New cop `FinalNewline` keeps tracks of the required final newline in a source file.
+* Highlightling corrected in `SpaceInsideHashLiteralBraces` and `SpaceAroundBraces` cops.
+
+### Changes
+
+* [#447](https://github.com/bbatsov/rubocop/issues/447) - `BlockAlignment` cop now allows `end` to be aligned with the start of the line containing `do`.
+* `SymbolName` now has an `AllowDots` config option to allow symbols like `:'whatever.submit_button'`.
+* [#469](https://github.com/bbatsov/rubocop/issues/469) - Extracted useless setter call tracking part of `UselessAssignment` cop to `UselessSetterCall`.
+* [#469](https://github.com/bbatsov/rubocop/issues/469) - Merged `UnusedLocalVariable` cop into `UselessAssignment`.
+* [#458](https://github.com/bbatsov/rubocop/issues/458) - The merged `UselessAssignment` cop now has advanced logic that tracks not only assignment at the end of the method but also every assignment in every scope.
+* [#466](https://github.com/bbatsov/rubocop/issues/466) - Allow built-in JRuby global vars in `AvoidGlobalVars`
+* Added a config option `AllowedVariables` to `AvoidGlobalVars` to allow users to whitelist certain global variables
+* Renamed `AvoidGlobalVars` to `GlobalVars`
+* Renamed `AvoidPerlisms` to `SpecialGlobalVars`
+* Renamed `AvoidFor` to `For`
+* Renamed `AvoidClassVars` to `ClassVars`
+* Renamed `AvoidPerlBackrefs` to `PerlBackrefs`
+* `NumericLiterals` now accepts a config param `MinDigits` - the minimal number of digits in the integer portion of number for the cop to check it.
+
+### Bugs fixed
+
+* [#449](https://github.com/bbatsov/rubocop/issues/449) - Remove whitespaces between condition and `do` with `WhileUntilDo` auto-correction
+* Continue with file inspection after parser warnings. Give up only on syntax errors.
+* Don’t trigger the HashSyntax cop on digit-starting keys.
+* Fix crashes while inspecting class definition subclassing another class stored in a local variable in `UselessAssignment` (formerly of `UnusedLocalVariable`) and `ShadowingOuterLocalVariable` (like `clazz = Array; class SomeClass < clazz; end`).
+* [#463](https://github.com/bbatsov/rubocop/issues/463) - Do not warn if using destructuring in second `reduce` argument (`ReduceArguments`)
+
 ## 0.12.0 (23/08/2013)
 
 ### New features

data/README.md

@@ -7,9 +7,15 @@
 > Role models are important. <br/>
 > -- Officer Alex J. Murphy / RoboCop
 
-**RuboCop** is a Ruby code style checker based on the
+**RuboCop** is a Ruby static code analyzer. Out of the box it will
+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.
+
+Apart from reporting problems in your code, RuboCop can also
+automatically fix some of the problems for you.
+
 ## Installation
 
 **RuboCop**'s installation is pretty standard:
@@ -79,11 +85,45 @@ Command flag           | Description
 `-R/--rails`           | Run extra Rails cops
 `-l/--lint`            | Run only lint cops
 `-a/--auto-correct`    | Auto-correct certain offences *Note:* Experimental - use with caution
-`-s/--silent`          | Suppress the final summary
 `--only`               | Run only the specified cop
 `--auto-gen-config`    | Generate a configuration file acting as a TODO list
 `--show-cops`          | Shows available cops and their configuration
 
+### Cops
+
+In RuboCop lingo the various checks performed on the code are called cops. There are several cop departments.
+
+#### Style
+
+Most of the cops in RuboCop are so called style cops that check for
+stylistics problems in your code. Almost all of the them are based on
+the Ruby Style Guide. Many of the style cops have configurations
+options allowing them to support different popular coding
+conventions.
+
+#### Lint
+
+Lint cops check for possible errors and very bad practices in your
+code. RuboCop implements in a portable way all built-in MRI lint
+checks (`ruby -wc`) and adds a lot of extra lint checks of its
+own. You can run only the lint cops like this:
+
+```
+$ rubocop -l
+```
+
+Disabling any of the lint cops in generally a bad idea.
+
+#### Rails
+
+Rails cops are specific to the Ruby on Rails framework. Unlike style
+and lint cops they are not used by default and you have to request them
+specifically:
+
+```
+$ rubocop -R
+```
+
 ## Configuration
 
 The behavior of RuboCop can be controlled via the
@@ -129,12 +169,13 @@ inherit_from:
 
 ### Defaults
 
-The file `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.
+The file
+[config/default.yml]([.rubocop.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
 

data/config/default.yml

@@ -50,6 +50,9 @@ BlockNesting:
   Description: 'Avoid more than `Max` levels of nesting.'
   Max: 3
 
+NumericLiterals:
+  MinDigits: 5
+
 RegexpLiteral:
   Description: >
                  Use %r for regular expressions matching more than
@@ -58,6 +61,10 @@ RegexpLiteral:
                  `MaxSlashes` '/' character.
   MaxSlashes: 1
 
+# Built-in global variables are allowed by default.
+GlobalVars:
+  AllowedVariables: []
+
 # Align with the style guide.
 CollectionMethods:
   PreferredMethods:
@@ -111,3 +118,36 @@ CommentAnnotation:
     - 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

data/config/enabled.yml

@@ -20,6 +20,14 @@ TrailingWhitespace:
   Description: 'Avoid trailing whitespace.'
   Enabled: true
 
+TrailingBlankLines:
+  Description: 'Checks for superflous trailing blank lines.'
+  Enabled: true
+
+FinalNewline:
+  Description: 'Checks for a final newline in a source file.'
+  Enabled: true
+
 CaseIndentation:
   Description: 'Indent when as deep as case.'
   Enabled: true
@@ -208,19 +216,19 @@ CollectionMethods:
   Description: 'Preferred collection methods.'
   Enabled: true
 
-AvoidFor:
+For:
   Description: 'Prefer each over for.'
   Enabled: true
 
-AvoidPerlisms:
+SpecialGlobalVars:
   Description: 'Avoid Perl-style global variables.'
   Enabled: true
 
-AvoidPerlBackrefs:
+PerlBackrefs:
   Description: 'Avoid Perl-style regex back references.'
   Enabled: true
 
-AvoidClassVars:
+ClassVars:
   Description: 'Avoid the use of class variables.'
   Enabled: true
 
@@ -326,7 +334,7 @@ ColonMethodCall:
   Description: 'Do not use :: for method call.'
   Enabled: true
 
-AvoidGlobalVars:
+GlobalVars:
   Description: 'Do not introduce global variables.'
   Enabled: true
 
@@ -436,6 +444,26 @@ HashMethods:
   Description: Checks for use of deprecated Hash methods.
   Enabled: true
 
+MultilineBlockChain:
+  Description: Avoid multi-line chains of blocks.
+  Enabled: true
+
+AlignHash:
+  Description: >
+                 Align the elements of a hash literal if they span more than
+                 one line.
+  Enabled: true
+
+AlignArray:
+  Description: >
+                 Align the elements of an array literal if they span more than
+                 one line.
+  Enabled: true
+
+SpaceBeforeModifierKeyword:
+  Description: Put a space before the modifier keyword.
+  Enabled: true
+
 #################### Lint ################################
 ### Warnings
 
@@ -459,10 +487,6 @@ UnreachableCode:
   Description: 'Unreachable code.'
   Enabled: true
 
-UnusedLocalVariable:
-  Description: 'Unused local variable.'
-  Enabled: true
-
 ShadowingOuterLocalVariable:
   Description: >
                  Do not use the same name as outer local variable
@@ -491,6 +515,10 @@ UselessAssignment:
   Description: 'Checks for useless assignment to a local variable.'
   Enabled: true
 
+UselessSetterCall:
+  Description: 'Checks for useless setter call to a local variable.'
+  Enabled: true
+
 UselessComparison:
   Description: 'Checks for comparison of something with itself.'
   Enabled: true

data/lib/rubocop.rb

@@ -8,11 +8,19 @@ require 'ast/sexp'
 require 'powerpack'
 
 require 'rubocop/cop/util'
-require 'rubocop/cop/variable_inspector'
 require 'rubocop/cop/offence'
 require 'rubocop/cop/cop'
 require 'rubocop/cop/commissioner'
 require 'rubocop/cop/corrector'
+require 'rubocop/cop/team'
+
+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/lint/assignment_in_condition'
 require 'rubocop/cop/lint/block_alignment'
@@ -28,32 +36,30 @@ require 'rubocop/cop/lint/parentheses_as_grouped_expression'
 require 'rubocop/cop/lint/rescue_exception'
 require 'rubocop/cop/lint/shadowing_outer_local_variable'
 require 'rubocop/cop/lint/unreachable_code'
-require 'rubocop/cop/lint/unused_local_variable'
 require 'rubocop/cop/lint/useless_assignment'
 require 'rubocop/cop/lint/useless_comparison'
+require 'rubocop/cop/lint/useless_setter_call'
 require 'rubocop/cop/lint/void'
 
 require 'rubocop/cop/style/access_control'
 require 'rubocop/cop/style/alias'
+require 'rubocop/cop/style/align_array'
+require 'rubocop/cop/style/align_hash'
 require 'rubocop/cop/style/align_parameters'
 require 'rubocop/cop/style/and_or'
 require 'rubocop/cop/style/ascii_comments'
 require 'rubocop/cop/style/ascii_identifiers'
 require 'rubocop/cop/style/attr'
-require 'rubocop/cop/style/avoid_class_vars'
-require 'rubocop/cop/style/avoid_for'
-require 'rubocop/cop/style/avoid_global_vars'
-require 'rubocop/cop/style/avoid_perl_backrefs'
-require 'rubocop/cop/style/avoid_perlisms'
 require 'rubocop/cop/style/begin_block'
 require 'rubocop/cop/style/block_comments'
 require 'rubocop/cop/style/block_nesting'
 require 'rubocop/cop/style/blocks'
-require 'rubocop/cop/style/character_literal'
 require 'rubocop/cop/style/case_equality'
 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_methods'
+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'
@@ -72,13 +78,14 @@ require 'rubocop/cop/style/favor_join'
 require 'rubocop/cop/style/favor_modifier'
 require 'rubocop/cop/style/favor_sprintf'
 require 'rubocop/cop/style/favor_unless_over_negated_if'
+require 'rubocop/cop/style/final_newline'
+require 'rubocop/cop/style/for'
+require 'rubocop/cop/style/global_vars'
 require 'rubocop/cop/style/hash_methods'
 require 'rubocop/cop/style/hash_syntax'
 require 'rubocop/cop/style/if_then_else'
 require 'rubocop/cop/style/if_with_semicolon'
 require 'rubocop/cop/style/indentation_width'
-require 'rubocop/cop/style/multiline_if_then'
-require 'rubocop/cop/style/one_line_conditional'
 require 'rubocop/cop/style/lambda'
 require 'rubocop/cop/style/leading_comment_space'
 require 'rubocop/cop/style/line_length'
@@ -86,12 +93,16 @@ require 'rubocop/cop/style/method_and_variable_snake_case'
 require 'rubocop/cop/style/method_call_parentheses'
 require 'rubocop/cop/style/method_length'
 require 'rubocop/cop/style/module_function'
+require 'rubocop/cop/style/multiline_block_chain'
+require 'rubocop/cop/style/multiline_if_then'
 require 'rubocop/cop/style/nil_comparison'
 require 'rubocop/cop/style/not'
 require 'rubocop/cop/style/numeric_literals'
+require 'rubocop/cop/style/one_line_conditional'
 require 'rubocop/cop/style/op_method'
 require 'rubocop/cop/style/parameter_lists'
 require 'rubocop/cop/style/parentheses_around_condition'
+require 'rubocop/cop/style/perl_backrefs'
 require 'rubocop/cop/style/proc'
 require 'rubocop/cop/style/reduce_arguments'
 require 'rubocop/cop/style/redundant_begin'
@@ -105,12 +116,15 @@ require 'rubocop/cop/style/single_line_methods'
 require 'rubocop/cop/style/space_after_comma_etc'
 require 'rubocop/cop/style/space_after_control_keyword'
 require 'rubocop/cop/style/space_after_method_name'
+require 'rubocop/cop/style/special_global_vars'
+require 'rubocop/cop/style/space_before_modifier_keyword'
 require 'rubocop/cop/style/string_literals'
 require 'rubocop/cop/style/surrounding_space'
 require 'rubocop/cop/style/symbol_array'
 require 'rubocop/cop/style/symbol_name'
 require 'rubocop/cop/style/tab'
 require 'rubocop/cop/style/ternary_operator'
+require 'rubocop/cop/style/trailing_blank_lines'
 require 'rubocop/cop/style/trailing_whitespace'
 require 'rubocop/cop/style/trivial_accessors'
 require 'rubocop/cop/style/unless_else'

data/lib/rubocop/cli.rb

@@ -16,7 +16,6 @@ module Rubocop
     alias_method :wants_to_quit?, :wants_to_quit
 
     def initialize
-      @cops = Cop::Cop.all
       @errors = []
       @options = {}
       @config_store = ConfigStore.new
@@ -33,12 +32,6 @@ module Rubocop
 
       Config.debug = @options[:debug]
 
-      # filter out Rails cops unless requested
-      @cops.reject!(&:rails?) unless @options[:rails]
-
-      # filter out style cops when --lint is passed
-      @cops.select!(&:lint?) if @options[:lint]
-
       target_files = target_finder.find(args)
       target_files.each(&:freeze).freeze
       inspected_files = []
@@ -70,8 +63,34 @@ module Rubocop
       return 1
     end
 
+    def mobilized_cop_classes
+      @mobilized_cop_classes ||= begin
+        cop_classes = Cop::Cop.all
+
+        if @options[:only]
+          cop_classes.select! { |c| c.cop_name == @options[:only] }
+        else
+          # filter out Rails cops unless requested
+          cop_classes.reject!(&:rails?) unless @options[:rails]
+
+          # filter out style cops when --lint is passed
+          cop_classes.select!(&:lint?) if @options[:lint]
+        end
+
+        cop_classes
+      end
+    end
+
+    def inspect_file(file)
+      config = @config_store.for(file)
+      team = Cop::Team.new(mobilized_cop_classes, config, @options)
+      offences = team.inspect_file(file)
+      @errors.concat(team.errors)
+      offences
+    end
+
     def validate_only_option
-      if @cops.none? { |c| c.cop_name == @options[:only] }
+      if Cop::Cop.all.none? { |c| c.cop_name == @options[:only] }
         fail ArgumentError, "Unrecognized cop name: #{@options[:only]}."
       end
     end
@@ -81,18 +100,26 @@ module Rubocop
         fail ArgumentError,
              '--auto-gen-config can not be combined with any other arguments.'
       end
+
+      target_finder.find(args).each do |file|
+        config = @config_store.for(file)
+        if @options[:auto_gen_config] && config.contains_auto_generated_config
+          fail "Remove #{Config::AUTO_GENERATED_FILE} from the current " +
+            'configuration before generating it again.'
+        end
+      end
     end
 
     def print_available_cops
-      puts "Available cops (#{@cops.length}) + config for #{Dir.pwd.to_s}: "
+      cops = Cop::Cop.all
+      puts "Available cops (#{cops.length}) + config for #{Dir.pwd.to_s}: "
       dirconf = @config_store.for(Dir.pwd.to_s)
-      @cops.types.sort!.each do |type|
-        coptypes = @cops.with_type(type).sort_by!(&:cop_name)
+      cops.types.sort!.each do |type|
+        coptypes = cops.with_type(type).sort_by!(&:cop_name)
         puts "Type '#{type.to_s.capitalize}' (#{coptypes.size}):"
         coptypes.each do |cop|
-          name = cop.cop_name
-          puts " - #{name}"
-          cnf = dirconf.for_cop(name).dup
+          puts " - #{cop.cop_name}"
+          cnf = dirconf.for_cop(cop).dup
           print_conf_option('Description',
                             cnf.delete('Description') { 'None' })
           cnf.each { |k, v| print_conf_option(k, v) }
@@ -104,81 +131,6 @@ module Rubocop
       puts  "    - #{option}: #{value}"
     end
 
-    def inspect_file(file)
-      begin
-        processed_source = SourceParser.parse_file(file)
-      rescue Encoding::UndefinedConversionError, ArgumentError => e
-        handle_error(e, "An error occurred while parsing #{file}.".color(:red))
-        return []
-      end
-
-      # If we got any syntax errors, return only the syntax offences.
-      # Parser may return nil for AST even though there are no syntax errors.
-      # e.g. sources which contain only comments
-      unless processed_source.diagnostics.empty?
-        return processed_source.diagnostics.map do |diagnostic|
-                 Cop::Offence.from_diagnostic(diagnostic)
-               end
-      end
-
-      config = @config_store.for(file)
-      if @options[:auto_gen_config] && config.contains_auto_generated_config
-        fail "Remove #{Config::AUTO_GENERATED_FILE} from the current " +
-          'configuration before generating it again.'
-      end
-      set_config_for_all_cops(config)
-
-      cops = []
-      @cops.each do |cop_class|
-        cop_name = cop_class.cop_name
-        next unless config.cop_enabled?(cop_name)
-        next unless !@options[:only] || @options[:only] == cop_name
-        cop = setup_cop(cop_class, processed_source.disabled_lines_for_cops)
-        cops << cop
-      end
-      commissioner = Cop::Commissioner.new(cops)
-      offences = commissioner.investigate(processed_source)
-      process_commissioner_errors(file, commissioner.errors)
-      autocorrect(processed_source.buffer, cops)
-      offences.sort
-    end
-
-    def process_commissioner_errors(file, file_errors)
-      file_errors.each do |cop, errors|
-        errors.each do |e|
-          handle_error(e,
-                       "An error occurred while #{cop.name}".color(:red) +
-                       " cop was inspecting #{file}.".color(:red))
-        end
-      end
-    end
-
-    def set_config_for_all_cops(config)
-      @cops.each do |cop_class|
-        cop_class.config = config.for_cop(cop_class.cop_name)
-      end
-    end
-
-    def setup_cop(cop_class, disabled_lines_for_cops = nil)
-      cop = cop_class.new
-      cop.debug = @options[:debug]
-      cop.autocorrect = @options[:autocorrect]
-      if disabled_lines_for_cops
-        cop.disabled_lines = disabled_lines_for_cops[cop_class.cop_name]
-      end
-      cop
-    end
-
-    def handle_error(e, message)
-      @errors << message
-      warn message
-      if @options[:debug]
-        puts e.message, e.backtrace
-      else
-        warn 'To see the complete backtrace run rubocop -d.'
-      end
-    end
-
     # rubocop:disable MethodLength
     def parse_options(args)
       ignore_dropped_options(args)
@@ -306,23 +258,6 @@ module Rubocop
       warn Rubocop::Version.version(true)
     end
 
-    def autocorrect(buffer, cops)
-      return unless @options[:autocorrect]
-
-      corrections = cops.reduce([]) do |array, cop|
-        array.concat(cop.corrections)
-        array
-      end
-
-      corrector = Cop::Corrector.new(buffer, corrections)
-      new_source = corrector.rewrite
-
-      unless new_source == buffer.source
-        filename = buffer.instance_variable_get(:@name)
-        File.open(filename, 'w') { |f| f.write(new_source) }
-      end
-    end
-
     private
 
     def target_finder