rubocop 0.9.1 → 0.10.0

data/.travis.yml

@@ -4,4 +4,6 @@ rvm:
   - 2.0.0
   - jruby-19mode
   - rbx-19mode
-script: bundle exec rspec
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -2,6 +2,44 @@
 
 ## master (unreleased)
 
+## 0.10.0 (17/07/2013)
+
+### New features
+
+* New cop `RedundantReturn` tracks redundant `return`s in method bodies
+* New cop `RedundantBegin` tracks redundant `begin` blocks in method definitions.
+* New cop `RedundantSelf` tracks redundant uses of `self`.
+* New cop `EmptyEnsure` tracks empty `ensure` blocks.
+* New cop `CommentAnnotation` tracks formatting of annotation comments such as TODO.
+* Added custom rake task.
+* New formatter `FileListFormatter` outputs just a list of files with offences in them (related to [#357](https://github.com/bbatsov/rubocop/issues/357)).
+
+### Changes
+
+* `TrivialAccessors` now has an `ExactNameMatch` config option (related to [#308](https://github.com/bbatsov/rubocop/issues/308)).
+* `TrivialAccessors` now has an `ExcludePredicates` config option (related to [#326](https://github.com/bbatsov/rubocop/issues/326)).
+* Cops don't inherit from `Parser::AST::Rewriter` anymore. All 3rd party Cops should remove the call to `super` in their
+  callbacks. If you implement your own processing you need to define the `#investigate` method instead of `#inspect`. Refer to
+  the documentation of `Cop::Commissioner` and `Cop::Cop` classes for more information.
+* `EndAlignment` cop split into `EndAlignment` and `BlockAlignment` cops.
+
+### Bugs fixed
+
+* [#288](https://github.com/bbatsov/rubocop/issues/288) - work with absolute Excludes paths internally (2nd fix for this issue)
+* `TrivialAccessors` now detects class attributes as well as instance attributes
+* [#338](https://github.com/bbatsov/rubocop/issues/338) - fix end alignment of blocks in chained assignments
+* [#345](https://github.com/bbatsov/rubocop/issues/345) - add `$SAFE` to the list of built-in global variables
+* [#340](https://github.com/bbatsov/rubocop/issues/340) - override config parameters rather than merging them
+* [#349](https://github.com/bbatsov/rubocop/issues/349) - fix false positive for `CharacterLiteral` (`%w(?)`)
+* [#346](https://github.com/bbatsov/rubocop/issues/346) - support method chains for block end alignment checks
+* [#350](https://github.com/bbatsov/rubocop/issues/350) - support line breaks between variables on left hand side for block end alignment checks
+* [#356](https://github.com/bbatsov/rubocop/issues/350) - allow safe assignment in `ParenthesesAroundCondition`
+
+### Misc
+
+* Improved performance on Ruby 1.9 by about 20%
+* Improved overall performance by about 35%
+
 ## 0.9.1 (05/07/2013)
 
 ### New features

data/README.md

@@ -165,6 +165,16 @@ subdirectories.
 
 ## Formatters
 
+### File List Formmater
+
+Sometimes you might want to just open all files with offences in your
+favorite editor. This formatter outputs just the names of the files
+with offences in them and makes it possible to do something like:
+
+```
+rubocop --format files | xargs vim
+```
+
 ### JSON Formatter
 
 You can get RuboCop's inspection result in JSON format by passing `--format json` option in command line.
@@ -287,6 +297,30 @@ like
 allows you to automatically check Ruby code style with RuboCop when
 files are modified.
 
+
+## Rake integration
+
+To use RuboCop in your `Rakefile` add the following:
+
+```ruby
+require 'rubocop/rake_task'
+
+Rubocop::RakeTask.new
+```
+
+The above will use default values
+
+```ruby
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop on the lib directory'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+```
+
 ## Contributors
 
 Here's a [list](https://github.com/bbatsov/rubocop/contributors) of

data/Rakefile

@@ -27,3 +27,6 @@ task default: :spec
 
 require 'yard'
 YARD::Rake::YardocTask.new
+
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new

data/config/default.yml

@@ -67,4 +67,17 @@ CollectionMethods:
 
 # Muli-line method chaining should be done with leading dots.
 DotPosition:
-  Style: 'leading'
+  Style: 'leading'
+
+# TrivialAccessors doesn't require exact name matches and doesn't allow predicated methods by default.
+TrivialAccessors:
+  ExactNameMatch: false
+  AllowPredicates: false
+
+# Allow safe assignment in conditions.
+AssignmentInCondition:
+  AllowSafeAssignment: true
+
+# Allow safe assignment in conditions.
+ParenthesesAroundCondition:
+  AllowSafeAssignment: true

data/config/enabled.yml

@@ -352,17 +352,40 @@ BeginBlock:
 EndBlock:
   Enabled: true
 
-## Warnings
+# Don't use return where it's not required.
+RedundantReturn:
+  Enabled: true
+
+# Don't use begin blocks when they are not needed.
+RedundantBegin:
+  Enabled: true
+
+# Don't use self where it's not needed.
+RedundantSelf:
+  Enabled: true
+
+# Checks the position of the dot in multi-line method calls.
+DotPosition:
+  Enabled: true
+
+# Checks for uses of Module#attr.
+Attr:
+  Enabled: true
+
+#################### Lint ################################
 
 # Don't use assignment in conditions.
 AssignmentInCondition:
   Enabled: true
-  AllowSafeAssignment: true
 
 # Align ends correctly.
 EndAlignment:
   Enabled: true
 
+# Align block ends correctly.
+BlockAlignment:
+  Enabled: true
+
 # Possible use of operator/literal/variable in void context.
 Void:
   Enabled: true
@@ -388,15 +411,15 @@ EndInMethod:
 LiteralInCondition:
   Enabled: true
 
-# Checks the position of the dot in multi-line method calls.
-DotPosition:
+# Checks for empty ensure block.
+EmptyEnsure:
   Enabled: true
 
-# Checks for uses of Module#attr.
-Attr:
+# Checks formatting of special comments (TODO, FIXME, OPTIMIZE, HACK, REVIEW).
+CommentAnnotation:
   Enabled: true
 
-## Rails
+##################### Rails ##################################
 
 # Use sexy validations.
 Validation:

data/lib/rubocop.rb

@@ -1,16 +1,22 @@
 # encoding: utf-8
 
+require 'backports/2.0.0/array/bsearch'
 require 'rainbow'
 require 'English'
 require 'parser/current'
 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/lint/assignment_in_condition'
+require 'rubocop/cop/lint/block_alignment'
+require 'rubocop/cop/lint/empty_ensure'
 require 'rubocop/cop/lint/end_alignment'
 require 'rubocop/cop/lint/end_in_method'
 require 'rubocop/cop/lint/ensure_return'
@@ -47,6 +53,7 @@ require 'rubocop/cop/style/class_and_module_camel_case'
 require 'rubocop/cop/style/class_methods'
 require 'rubocop/cop/style/collection_methods'
 require 'rubocop/cop/style/colon_method_call'
+require 'rubocop/cop/style/comment_annotation'
 require 'rubocop/cop/style/constant_name'
 require 'rubocop/cop/style/def_parentheses'
 require 'rubocop/cop/style/documentation'
@@ -80,6 +87,9 @@ require 'rubocop/cop/style/parameter_lists'
 require 'rubocop/cop/style/parentheses_around_condition'
 require 'rubocop/cop/style/proc'
 require 'rubocop/cop/style/reduce_arguments'
+require 'rubocop/cop/style/redundant_begin'
+require 'rubocop/cop/style/redundant_return'
+require 'rubocop/cop/style/redundant_self'
 require 'rubocop/cop/style/regexp_literal'
 require 'rubocop/cop/style/rescue_modifier'
 require 'rubocop/cop/style/semicolon'
@@ -108,9 +118,14 @@ require 'rubocop/formatter/emacs_style_formatter'
 require 'rubocop/formatter/clang_style_formatter'
 require 'rubocop/formatter/progress_formatter'
 require 'rubocop/formatter/json_formatter'
+require 'rubocop/formatter/file_list_formatter'
 require 'rubocop/formatter/formatter_set'
 
 require 'rubocop/config'
 require 'rubocop/config_store'
+require 'rubocop/target_finder'
+require 'rubocop/token'
+require 'rubocop/processed_source'
+require 'rubocop/source_parser'
 require 'rubocop/cli'
 require 'rubocop/version'

data/lib/rubocop/cli.rb

@@ -19,7 +19,7 @@ module Rubocop
       @cops = Cop::Cop.all
       @errors = []
       @options = {}
-      ConfigStore.prepare
+      @config_store = ConfigStore.new
     end
 
     # Entry point for the application logic. Here we
@@ -42,7 +42,7 @@ module Rubocop
       # filter out style cops when --lint is passed
       @cops.select!(&:lint?) if @options[:lint]
 
-      target_files = target_files(args)
+      target_files = target_finder.find(args)
       target_files.each(&:freeze).freeze
       inspected_files = []
       any_failed = false
@@ -78,9 +78,7 @@ module Rubocop
 
     def inspect_file(file)
       begin
-        ast, comments, tokens, source_buffer, source, syntax_offences =
-          CLI.parse(file) { |sb| sb.read }
-
+        processed_source = SourceParser.parse_file(file)
       rescue Encoding::UndefinedConversionError, ArgumentError => e
         handle_error(e, "An error occurred while parsing #{file}.".color(:red))
         return []
@@ -89,30 +87,39 @@ module Rubocop
       # 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
-      return syntax_offences unless syntax_offences.empty?
+      unless processed_source.diagnostics.empty?
+        return processed_source.diagnostics.map do |diagnostic|
+                 Cop::Offence.from_diagnostic(diagnostic)
+               end
+      end
 
-      config = ConfigStore.for(file)
-      disabled_lines = disabled_lines_in(source)
+      config = @config_store.for(file)
 
       set_config_for_all_cops(config)
 
-      @cops.reduce([]) do |offences, cop_class|
+      cops = []
+      @cops.each do |cop_class|
         cop_name = cop_class.cop_name
-        if config.cop_enabled?(cop_name)
-          cop = setup_cop(cop_class, disabled_lines)
-          if !@options[:only] || @options[:only] == cop_name
-            begin
-              cop.inspect(source_buffer, source, tokens, ast, comments)
-            rescue => e
-              handle_error(e,
-                           "An error occurred while #{cop.name}".color(:red) +
-                           " cop was inspecting #{file}.".color(:red))
-            end
-          end
-          offences.concat(cop.offences)
+        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
-        offences
-      end.sort
+      end
     end
 
     def set_config_for_all_cops(config)
@@ -121,11 +128,13 @@ module Rubocop
       end
     end
 
-    def setup_cop(cop_class, disabled_lines = nil)
+    def setup_cop(cop_class, disabled_lines_for_cops = nil)
       cop = cop_class.new
       cop.debug = @options[:debug]
       cop.autocorrect = @options[:autocorrect]
-      cop.disabled_lines = disabled_lines[cop_class.cop_name] if disabled_lines
+      if disabled_lines_for_cops
+        cop.disabled_lines = disabled_lines_for_cops[cop_class.cop_name]
+      end
       cop
     end
 
@@ -151,7 +160,7 @@ module Rubocop
         end
         opts.on('-c', '--config FILE', 'Specify configuration file.') do |f|
           @options[:config] = f
-          ConfigStore.set_options_config(@options[:config])
+          @config_store.set_options_config(@options[:config])
         end
         opts.on('--only COP', 'Run just one cop.') do |s|
           @options[:only] = s
@@ -166,6 +175,7 @@ module Rubocop
                 '  [c]lang',
                 '  [e]macs',
                 '  [j]son',
+                '  [f]iles',
                 '  custom formatter class name') do |key|
           @options[:formatters] ||= []
           @options[:formatters] << [key]
@@ -240,139 +250,27 @@ module Rubocop
       puts Rubocop::Version.version(true)
     end
 
-    def disabled_lines_in(source)
-      disabled_lines = Hash.new([])
-      disabled_section = {}
-      regexp = '# rubocop : (%s)\b ((?:\w+,? )+)'.gsub(' ', '\s*')
-      section_regexp = '^\s*' + sprintf(regexp, '(?:dis|en)able')
-      single_line_regexp = '\S.*' + sprintf(regexp, 'disable')
-
-      source.each_with_index do |line, ix|
-        each_mentioned_cop(/#{section_regexp}/, line) do |cop_name, kind|
-          disabled_section[cop_name] = (kind == 'disable')
-        end
-        disabled_section.keys.each do |cop_name|
-          disabled_lines[cop_name] += [ix + 1] if disabled_section[cop_name]
-        end
-
-        each_mentioned_cop(/#{single_line_regexp}/, line) do |cop_name, kind|
-          disabled_lines[cop_name] += [ix + 1] if kind == 'disable'
-        end
-      end
-      disabled_lines
-    end
-
-    def each_mentioned_cop(regexp, line)
-      match = line.match(regexp)
-      if match
-        kind, cops = match.captures
-        cops = Cop::Cop.all.map(&:cop_name).join(',') if cops.include?('all')
-        cops.split(/,\s*/).each { |cop_name| yield cop_name, kind }
-      end
-    end
-
-    def self.parse(file)
-      parser = Parser::CurrentRuby.new
-
-      # On JRuby and Rubinius, there's a risk that we hang in
-      # tokenize() if we don't set the all errors as fatal flag.
-      parser.diagnostics.all_errors_are_fatal = RUBY_ENGINE != 'ruby'
-      parser.diagnostics.ignore_warnings      = false
+    def autocorrect(buffer, cops)
+      return unless @options[:autocorrect]
 
-      diagnostics = []
-      parser.diagnostics.consumer = lambda do |diagnostic|
-        diagnostics << diagnostic
+      corrections = cops.reduce([]) do |array, cop|
+        array.concat(cop.corrections)
+        array
       end
 
-      source_buffer = Parser::Source::Buffer.new(file, 1)
-      yield source_buffer
-
-      begin
-        ast, comments, tokens = parser.tokenize(source_buffer)
-      rescue Parser::SyntaxError # rubocop:disable HandleExceptions
-        # All errors are in diagnostics. No need to handle exception.
-      end
+      corrector = Cop::Corrector.new(buffer, corrections)
+      new_source = corrector.rewrite
 
-      if tokens
-        tokens = tokens.map do |t|
-          type, details = *t
-          text, range = *details
-          Rubocop::Cop::Token.new(range, type, text)
-        end
+      unless new_source == buffer.source
+        filename = buffer.instance_variable_get(:@name)
+        File.open(filename, 'w') { |f| f.write(new_source) }
       end
-
-      syntax_offences = diagnostics.map do |d|
-        Cop::Offence.new(d.level, d.location, "#{d.message}",
-                         'Syntax')
-      end
-
-      source = source_buffer.source.split($RS)
-
-      [ast, comments, tokens, source_buffer, source, syntax_offences]
-    end
-
-    # Generate a list of target files by expanding globing patterns
-    # (if any). If args is empty recursively finds all Ruby source
-    # files under the current directory
-    # @return [Array] array of filenames
-    def target_files(args)
-      return ruby_files if args.empty?
-
-      files = []
-
-      args.each do |target|
-        if File.directory?(target)
-          files += ruby_files(target.chomp(File::SEPARATOR))
-        elsif target =~ /\*/
-          files += Dir[target]
-        else
-          files << target
-        end
-      end
-
-      files.map { |f| File.expand_path(f) }.uniq
-    end
-
-    # Finds all Ruby source files under the current or other supplied
-    # directory.  A Ruby source file is defined as a file with the `.rb`
-    # extension or a file with no extension that has a ruby shebang line
-    # as its first line.
-    # It is possible to specify includes and excludes using the config file,
-    # so you can include other Ruby files like Rakefiles and gemspecs.
-    # @param root Root directory under which to search for ruby source files
-    # @return [Array] Array of filenames
-    def ruby_files(root = Dir.pwd)
-      files = Dir["#{root}/**/*"].select { |file| FileTest.file?(file) }
-
-      rb = []
-
-      rb += files.select { |file| File.extname(file) == '.rb' }
-      rb += files.select do |file|
-        if File.extname(file) == '' && !excluded_file?(file)
-          begin
-            File.open(file) { |f| f.readline } =~ /#!.*ruby/
-          rescue EOFError, ArgumentError => e
-            log_error(e, "Unprocessable file #{file.inspect}: ")
-            false
-          end
-        end
-      end
-
-      rb += files.select do |file|
-        config = ConfigStore.for(file)
-        config.file_to_include?(file)
-      end
-
-      rb.reject { |file| excluded_file?(file) }.uniq
     end
 
     private
 
-    def log_error(e, msg = '')
-      if @options[:debug]
-        error_message = "#{e.class}, #{e.message}"
-        warn "#{msg}\t#{error_message}"
-      end
+    def target_finder
+      @target_finder ||= TargetFinder.new(@config_store, @options[:debug])
     end
 
     def formatter_set
@@ -396,9 +294,5 @@ module Rubocop
       message << " Please use #{alternative} instead." if alternative
       warn message
     end
-
-    def excluded_file?(file)
-      ConfigStore.for(file).file_to_exclude?(file)
-    end
   end
 end