rubocop 0.14.1 → 0.15.0

data/README.md

@@ -1,6 +1,8 @@
 [![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)
 [![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)
 
 # RuboCop
 
@@ -447,6 +449,11 @@ If you're a ST2 user you might find the
 [Sublime RuboCop plugin](https://github.com/pderichs/sublime_rubocop)
 useful.
 
+### Brackets
+The [brackets-rubocop](https://github.com/smockle/brackets-rubocop)
+extension displays RuboCop results in Brackets.
+It can be installed via the extension manager in Brackets.
+
 ### Other Editors
 
 Here's one great opportunity to contribute to RuboCop - implement

data/Rakefile

@@ -13,6 +13,7 @@ end
 require 'rake'
 require 'rspec/core'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
@@ -23,7 +24,10 @@ task :coverage do
   Rake::Task['spec'].execute
 end
 
-task default: :spec
+desc 'Run RuboCop over itself'
+Rubocop::RakeTask.new(:internal_investigation)
+
+task default: [:spec, :internal_investigation]
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/config/default.yml

@@ -16,6 +16,11 @@ AllCops:
   # directory .rubocop.yml files, or by giving the -R/--rails option.
   RunRailsCops: false
 
+# Indent private/protected/public as deep as method definitions
+AccessModifierIndentation:
+  # supported styles are "indent" and "outdent"
+  EnforcedStyle: indent
+
 # 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:
@@ -50,6 +55,10 @@ AssignmentInCondition:
 BlockNesting:
   Max: 3
 
+BracesAroundHashParameters:
+  # Valid values are: braces, no_braces
+  EnforcedStyle: no_braces
+
 ClassLength:
   CountComments: false  # count full line comments?
   Max: 100
@@ -72,6 +81,10 @@ CommentAnnotation:
     - HACK
     - REVIEW
 
+# Avoid complex methods.
+CyclomaticComplexity:
+  Max: 6
+
 # Multi-line method chaining should be done with leading dots.
 DotPosition:
   Style: 'leading'
@@ -108,6 +121,13 @@ MethodName:
 NumericLiterals:
   MinDigits: 5
 
+Output:
+  Ignore:
+    - '^.*\.rake$'
+    - '^.*/script/.*$'
+    - '^.*/tasks/.*$'
+    - 'Rakefile$'
+
 ParameterLists:
   Max: 5
   CountKeywordArgs: true
@@ -148,11 +168,15 @@ StringLiterals:
 SpaceAroundBlockBraces:
   # Valid values are: space_inside_braces, no_space_inside_braces
   EnforcedStyle: space_inside_braces
+  # Valid values are: space, no_space
+  EnforcedStyleForEmptyBraces: no_space
   # Space between { and |. Overrides EnforcedStyle if there is a conflict.
   SpaceBeforeBlockParameters: true
 
 SpaceInsideHashLiteralBraces:
-  EnforcedStyleIsWithSpaces: true
+  # Valid values (for both parameters) are: space, no_space
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
 
 SymbolName:
   AllowCamelCase: true
@@ -185,6 +209,5 @@ VariableName:
   # Valid values are: snake_case, camelCase
   EnforcedStyle: snake_case
 
-BracesAroundHashParameters:
-  # Valid values are: braces, no_braces
-  EnforcedStyle: no_braces
+WordArray:
+  MinSize: 0

data/config/enabled.yml

@@ -1,9 +1,7 @@
 # These are all the cops that are enabled in the default configuration.
 
-AccessControl:
-  Description: >
-                  Indent private/protected as deep as defs and keep blank
-                  lines around them.
+AccessModifierIndentation:
+  Description: Check indentation of private/protected visibility modifiers.
   Enabled: true
 
 Alias:
@@ -103,6 +101,10 @@ ConstantName:
   Description: 'Constants should use SCREAMING_SNAKE_CASE.'
   Enabled: true
 
+CyclomaticComplexity:
+  Description: 'Avoid complex methods.'
+  Enabled: true
+
 DefWithParentheses:
   Description: 'Use def with parentheses when there are arguments.'
   Enabled: true
@@ -125,6 +127,14 @@ EmptyLines:
   Description: "Don't use several empty lines in a row."
   Enabled: true
 
+EmptyLinesAroundAccessModifier:
+  Description: "Keep blank lines around access modifiers."
+  Enabled: true
+
+EmptyLinesAroundBody:
+  Description: "Keeps track of blank lines around expression bodies."
+  Enabled: true
+
 EmptyLineBetweenDefs:
   Description: 'Use empty lines between defs.'
   Enabled: true
@@ -569,6 +579,10 @@ HasAndBelongsToMany:
   Description: 'Prefer has_many :through to has_and_belongs_to_many.'
   Enabled: true
 
+Output:
+  Description: 'Checks for calls to puts, print, etc.'
+  Enabled: true
+
 ReadAttribute:
   Description: 'Prefer self[:attribute] over read_attribute(:attribute).'
   Enabled: true

data/lib/rubocop.rb

@@ -2,6 +2,7 @@
 
 require 'rainbow'
 require 'English'
+require 'set'
 require 'parser/current'
 require 'ast/sexp'
 require 'powerpack'
@@ -44,8 +45,9 @@ require 'rubocop/cop/lint/void'
 
 require 'rubocop/cop/style/autocorrect_alignment'
 require 'rubocop/cop/style/configurable_naming'
+require 'rubocop/cop/style/cyclomatic_complexity'
 require 'rubocop/cop/style/string_help'
-require 'rubocop/cop/style/access_control'
+require 'rubocop/cop/style/access_modifier_indentation'
 require 'rubocop/cop/style/alias'
 require 'rubocop/cop/style/align_array'
 require 'rubocop/cop/style/align_hash'
@@ -74,6 +76,8 @@ require 'rubocop/cop/style/documentation'
 require 'rubocop/cop/style/dot_position'
 require 'rubocop/cop/style/empty_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
+require 'rubocop/cop/style/empty_lines_around_body'
+require 'rubocop/cop/style/empty_lines_around_access_modifier'
 require 'rubocop/cop/style/empty_literal'
 require 'rubocop/cop/style/encoding'
 require 'rubocop/cop/style/end_block'
@@ -130,6 +134,13 @@ 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/space_around_block_braces'
+require 'rubocop/cop/style/space_around_equals_in_parameter_default'
+require 'rubocop/cop/style/space_around_operators'
+require 'rubocop/cop/style/space_inside'
+require 'rubocop/cop/style/space_inside_hash_literal_braces'
+require 'rubocop/cop/style/space_inside_brackets'
+require 'rubocop/cop/style/space_inside_parens'
 require 'rubocop/cop/style/symbol_array'
 require 'rubocop/cop/style/symbol_name'
 require 'rubocop/cop/style/tab'
@@ -146,6 +157,7 @@ require 'rubocop/cop/style/word_array'
 require 'rubocop/cop/style/braces_around_hash_parameters'
 
 require 'rubocop/cop/rails/has_and_belongs_to_many'
+require 'rubocop/cop/rails/output'
 require 'rubocop/cop/rails/read_attribute'
 require 'rubocop/cop/rails/validation'
 

data/lib/rubocop/cli.rb

@@ -24,10 +24,44 @@ module Rubocop
     def run(args = ARGV)
       trap_interrupt
 
-      @options, target_files = Options.new(@config_store).parse(args)
+      @options, remaining_args = Options.new.parse(args)
+      target_files = target_finder.find(remaining_args)
 
-      ConfigLoader.debug = @options[:debug]
+      act_on_options(remaining_args)
+
+      any_failed = process_files(target_files)
+
+      display_error_summary(@errors)
+
+      !any_failed && !wants_to_quit ? 0 : 1
+    rescue => e
+      $stderr.puts e.message
+      return 1
+    end
+
+    def trap_interrupt
+      Signal.trap('INT') do
+        exit!(1) if wants_to_quit?
+        self.wants_to_quit = true
+        $stderr.puts
+        $stderr.puts 'Exiting... Interrupt again to exit immediately.'
+      end
+    end
+
+    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 'Errors are usually caused by RuboCop bugs.'
+      warn 'Please, report your problems to RuboCop\'s issue tracker.'
+      warn 'Mention the following information in the issue report:'
+      warn Rubocop::Version.version(true)
+    end
+
+    private
 
+    def process_files(target_files)
       target_files.each(&:freeze).freeze
       inspected_files = []
       any_failed = false
@@ -49,13 +83,34 @@ module Rubocop
 
       formatter_set.finished(inspected_files.freeze)
       formatter_set.close_output_files
+      any_failed
+    end
 
-      display_error_summary(@errors)
+    def act_on_options(args)
+      if @options[:show_cops]
+        print_available_cops
+        exit(0)
+      end
 
-      !any_failed && !wants_to_quit ? 0 : 1
-    rescue => e
-      $stderr.puts e.message
-      return 1
+      @config_store.set_options_config(@options[:config]) if @options[:config]
+
+      Sickill::Rainbow.enabled = false if @options[:no_color]
+
+      puts Rubocop::Version.version(false) if @options[:version]
+      puts Rubocop::Version.version(true) if @options[:verbose_version]
+      exit(0) if @options[:version] || @options[:verbose_version]
+
+      ConfigLoader.debug = @options[:debug]
+
+      if @options[:auto_gen_config]
+        target_finder.find(args).each do |file|
+          config = @config_store.for(file)
+          if config.contains_auto_generated_config
+            fail "Remove #{ConfigLoader::AUTO_GENERATED_FILE} from the " +
+              'current configuration before generating it again.'
+          end
+        end
+      end
     end
 
     def mobilized_cop_classes(config)
@@ -85,27 +140,32 @@ module Rubocop
       offences
     end
 
-    def trap_interrupt
-      Signal.trap('INT') do
-        exit!(1) if wants_to_quit?
-        self.wants_to_quit = true
-        $stderr.puts
-        $stderr.puts 'Exiting... Interrupt again to exit immediately.'
+    def print_available_cops
+      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)
+        puts "Type '#{type.to_s.capitalize}' (#{coptypes.size}):"
+        coptypes.each do |cop|
+          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) }
+          print_conf_option('SupportsAutoCorrection',
+                            cop.new.support_autocorrect?.to_s)
+        end
       end
     end
 
-    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 'Errors are usually caused by RuboCop bugs.'
-      warn 'Please, report your problems to RuboCop\'s issue tracker.'
-      warn 'Mention the following information in the issue report:'
-      warn Rubocop::Version.version(true)
+    def print_conf_option(option, value)
+      puts  "    - #{option}: #{value}"
     end
 
-    private
+    def target_finder
+      @target_finder ||= TargetFinder.new(@config_store, @options[:debug])
+    end
 
     def run_rails_cops?(config)
       @options[:rails] || config['AllCops']['RunRailsCops']

data/lib/rubocop/config.rb

@@ -33,7 +33,7 @@ module Rubocop
     def warn_unless_valid
       validate
     rescue Config::ValidationError => e
-      puts "Warning: #{e.message}".color(:red)
+      warn "Warning: #{e.message}".color(:red)
     end
 
     # TODO: This should be a private method

data/lib/rubocop/cop/cop.rb

@@ -2,9 +2,10 @@
 
 module Rubocop
   module Cop
+    class CorrectionNotPossible < Exception; end
+
     # Store for all cops with helper functions
     class CopStore < ::Array
-
       # @return [Array<String>] list of types for current cops.
       def types
         @types = map(&:cop_type).uniq! unless defined? @types
@@ -15,6 +16,11 @@ module Rubocop
       def with_type(type)
         select { |c| c.cop_type == type }
       end
+
+      # @return [Array<Cop>] Cops not for a specific type.
+      def without_type(type)
+        reject { |c| c.cop_type == type }
+      end
     end
 
     # A scaffold for concrete cops.
@@ -55,6 +61,10 @@ module Rubocop
         @all.clone
       end
 
+      def self.non_rails
+        @all.without_type(:rails)
+      end
+
       def self.inherited(subclass)
         @all << subclass
       end
@@ -81,7 +91,7 @@ module Rubocop
 
       def initialize(config = nil, options = nil)
         @config = config || Config.new
-        @options = options || { autocorrect: false, debug: false }
+        @options = options || { auto_correct: false, debug: false }
 
         @offences = []
         @corrections = []
@@ -93,7 +103,7 @@ module Rubocop
       end
 
       def autocorrect?
-        @options[:autocorrect] && support_autocorrect?
+        @options[:auto_correct] && support_autocorrect?
       end
 
       def debug?
@@ -115,10 +125,14 @@ module Rubocop
 
         message = message ? message : message(node)
         message = debug? ? "#{name}: #{message}" : message
-        @offences <<
-          Offence.new(severity, location, message, name, autocorrect?)
 
-        autocorrect(node) if autocorrect?
+        corrected = begin
+                      autocorrect(node) if autocorrect?
+                      autocorrect?
+                    rescue CorrectionNotPossible
+                      false
+                    end
+        @offences << Offence.new(severity, location, message, name, corrected)
       end
 
       def convention(node, location, message = nil)
@@ -194,6 +208,17 @@ module Rubocop
         Parser::Source::Range.new(source_buffer, begin_pos,
                                   begin_pos + column_count)
       end
+
+      def range_with_surrounding_space(range, side = :both)
+        src = @processed_source.buffer.source
+        go_left = side == :left || side == :both
+        go_right = side == :right || side == :both
+        begin_pos = range.begin_pos
+        begin_pos -= 1 while go_left && src[begin_pos - 1] =~ /[ \t]/
+        end_pos = range.end_pos
+        end_pos += 1 while go_right && src[end_pos] =~ /[ \t]/
+        Parser::Source::Range.new(@processed_source.buffer, begin_pos, end_pos)
+      end
     end
   end
 end

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

@@ -129,23 +129,26 @@ module Rubocop
             match = /\S.*/.match(do_loc.source_line)
             indentation_of_do_line = match.begin(0)
             if end_loc.column != indentation_of_do_line
-              alt_start_msg = if start_loc.line == do_loc.line &&
-                                  start_loc.column == indentation_of_do_line
-                                ''
-                              else
-                                " or #{match[0]} at #{do_loc.line}, " +
-                                  "#{indentation_of_do_line}"
-                              end
               warning(nil,
                       end_loc,
                       sprintf(MSG, end_loc.line, end_loc.column,
                               start_loc.source.lines.to_a.first.chomp,
                               start_loc.line, start_loc.column,
-                              alt_start_msg))
+                              alt_start_msg(match, start_loc, do_loc,
+                                            indentation_of_do_line)))
             end
           end
         end
 
+        def alt_start_msg(match, start_loc, do_loc, indentation_of_do_line)
+          if start_loc.line == do_loc.line &&
+              start_loc.column == indentation_of_do_line
+            ''
+          else
+            " or #{match[0]} at #{do_loc.line}, #{indentation_of_do_line}"
+          end
+        end
+
         def message
         end