rubocop 0.23.0 → 0.24.0

data/lib/rubocop/cop/util.rb

@@ -121,14 +121,24 @@ module RuboCop
         end
       end
 
-      def source_range(source_buffer, preceding_lines, begin_column,
-                       column_count)
-        newline_length = 1
-        begin_pos = preceding_lines.reduce(0) do |a, e|
-          a + e.length + newline_length
-        end + begin_column
-        Parser::Source::Range.new(source_buffer, begin_pos,
-                                  begin_pos + column_count)
+      def source_range(source_buffer, line_number, column, length = 1)
+        if column.is_a?(Range)
+          column_index = column.begin
+          length = numeric_range_size(column)
+        else
+          column_index = column
+        end
+
+        preceding_line_numbers = (1...line_number)
+
+        line_begin_pos = preceding_line_numbers.reduce(0) do |pos, line|
+          pos + source_buffer.source_line(line).length + 1
+        end
+
+        begin_pos = line_begin_pos + column_index
+        end_pos = begin_pos + length
+
+        Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
       end
 
       def range_with_surrounding_space(range, side = :both)
@@ -160,6 +170,14 @@ module RuboCop
         end
         node
       end
+
+      # Range#size is not avaialable prior to Ruby 2.0.
+      def numeric_range_size(range)
+        size = range.end - range.begin
+        size += 1 unless range.exclude_end?
+        size = 0 if size < 0
+        size
+      end
     end
   end
 end

data/lib/rubocop/cop/variable_force.rb

@@ -31,12 +31,9 @@ module RuboCop
       ARGUMENT_DECLARATION_TYPES = [
         :arg, :optarg, :restarg,
         :kwarg, :kwoptarg, :kwrestarg,
-        :blockarg # This doen't mean block argument, it's block-pass (&block).
+        :blockarg, # This doen't mean block argument, it's block-pass (&block).
+        :shadowarg # This means block local variable (obj.each { |arg; this| }).
       ].freeze
-      BLOCK_LOCAL_VARIABLE_DECLARATION_TYPE = :shadowarg
-      DECLARATION_TYPES = (
-        ARGUMENT_DECLARATION_TYPES + [BLOCK_LOCAL_VARIABLE_DECLARATION_TYPE]
-      ).freeze
 
       LOGICAL_OPERATOR_ASSIGNMENT_TYPES = [:or_asgn, :and_asgn].freeze
       OPERATOR_ASSIGNMENT_TYPES =
@@ -105,7 +102,7 @@ module RuboCop
       # rubocop:disable Style/MethodLength, Style/CyclomaticComplexity
       def dispatch_node(node)
         case node.type
-        when *DECLARATION_TYPES
+        when *ARGUMENT_DECLARATION_TYPES
           process_variable_declaration(node)
         when VARIABLE_ASSIGNMENT_TYPE
           process_variable_assignment(node)

data/lib/rubocop/cop/variable_force/variable.rb

@@ -8,7 +8,7 @@ module RuboCop
       # and some states of the variable.
       class Variable
         VARIABLE_DECLARATION_TYPES =
-          (VARIABLE_ASSIGNMENT_TYPES + DECLARATION_TYPES).freeze
+          (VARIABLE_ASSIGNMENT_TYPES + ARGUMENT_DECLARATION_TYPES).freeze
 
         attr_reader :name, :declaration_node, :scope,
                     :assignments, :references, :captured_by_block
@@ -76,6 +76,10 @@ module RuboCop
           @captured_by_block || referenced?
         end
 
+        def should_be_unused?
+          name.to_s.start_with?('_')
+        end
+
         def argument?
           ARGUMENT_DECLARATION_TYPES.include?(@declaration_node.type)
         end
@@ -88,8 +92,8 @@ module RuboCop
           argument? && @scope.node.type == :block
         end
 
-        def block_local_variable?
-          @declaration_node.type == BLOCK_LOCAL_VARIABLE_DECLARATION_TYPE
+        def explicit_block_local_variable?
+          @declaration_node.type == :shadowarg
         end
       end
     end

data/lib/rubocop/processed_source.rb

@@ -5,16 +5,21 @@ module RuboCop
   # and other information such as disabled lines for cops.
   # It also provides a convenient way to access source lines.
   class ProcessedSource
-    attr_reader :buffer, :ast, :comments, :tokens, :diagnostics,
-                :comment_config
+    attr_reader :path, :buffer, :ast, :comments, :tokens, :diagnostics,
+                :parser_error
 
-    def initialize(buffer, ast, comments, tokens, diagnostics)
-      @buffer = buffer
-      @ast = ast
-      @comments = comments
-      @tokens = tokens
-      @diagnostics = diagnostics
-      @comment_config = CommentConfig.new(self)
+    def self.from_file(path)
+      new(File.read(path), path)
+    end
+
+    def initialize(source, path = nil)
+      @path = path
+      @diagnostics = []
+      parse(source, path)
+    end
+
+    def comment_config
+      @comment_config ||= CommentConfig.new(self)
     end
 
     def disabled_line_ranges
@@ -44,14 +49,49 @@ module RuboCop
     end
 
     def valid_syntax?
+      return false if @parser_error
       @diagnostics.none? { |d| [:error, :fatal].include?(d.level) }
     end
 
-    def file_path
-      @buffer.name
+    private
+
+    def parse(source, path)
+      buffer_name = path || '(string)'
+      @buffer = Parser::Source::Buffer.new(buffer_name, 1)
+
+      begin
+        @buffer.source = source
+      rescue Encoding::UndefinedConversionError, ArgumentError => error
+        # TODO: Rescue EncodingError here once the patch in Parser is released.
+        #   https://github.com/whitequark/parser/pull/156
+        @parser_error = error
+        return
+      end
+
+      parser = create_parser
+
+      begin
+        @ast, @comments, tokens = parser.tokenize(@buffer)
+      rescue Parser::SyntaxError # rubocop:disable Lint/HandleExceptions
+        # All errors are in diagnostics. No need to handle exception.
+      end
+
+      @tokens = tokens.map { |t| Token.from_parser_token(t) } if tokens
     end
 
-    private
+    def create_parser
+      Parser::CurrentRuby.new.tap do |parser|
+        # On JRuby and Rubinius, there's a risk that we hang in tokenize() if we
+        # don't set the all errors as fatal flag. The problem is caused by a bug
+        # in Racc that is discussed in issue #93 of the whitequark/parser
+        # project on GitHub.
+        parser.diagnostics.all_errors_are_fatal = (RUBY_ENGINE != 'ruby')
+        parser.diagnostics.ignore_warnings = false
+        parser.diagnostics.consumer = lambda do |diagnostic|
+          @diagnostics << diagnostic
+        end
+      end
+    end
 
     def init_lines
       @raw_lines = @buffer.source.lines

data/lib/rubocop/{file_inspector.rb → runner.rb}

@@ -3,63 +3,59 @@
 module RuboCop
   # This class handles the processing of files, which includes dealing with
   # formatters and letting cops inspect the files.
-  class FileInspector
-    def initialize(options)
+  class Runner
+    attr_reader :errors, :aborting
+    alias_method :aborting?, :aborting
+
+    def initialize(options, config_store)
       @options = options
+      @config_store = config_store
       @errors = []
+      @aborting = false
     end
 
-    # Takes a block which it calls once per inspected file.  The block shall
-    # return true if the caller wants to break the loop early.
-    def process_files(target_files, config_store)
-      target_files.each(&:freeze).freeze
+    def run(paths)
+      target_files = find_target_files(paths)
+
       inspected_files = []
-      any_failed = false
+      all_passed = true
 
       formatter_set.started(target_files)
 
       target_files.each do |file|
-        break if yield
-        offenses = process_file(file, config_store)
-
-        any_failed = true if offenses.any? do |o|
-          o.severity >= fail_level
-        end
+        break if aborting?
+        offenses = process_file(file)
+        all_passed = false if offenses.any? { |o| considered_failure?(o) }
         inspected_files << file
-        break if @options[:fail_fast] && any_failed
+        break if @options[:fail_fast] && !all_passed
       end
 
       formatter_set.finished(inspected_files.freeze)
-
       formatter_set.close_output_files
-      any_failed
+
+      all_passed
     end
 
-    def display_error_summary
-      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 abort
+      @aborting = true
     end
 
     private
 
-    def process_file(file, config_store)
+    def find_target_files(paths)
+      target_finder = TargetFinder.new(@config_store, @options)
+      target_files = target_finder.find(paths)
+      target_files.each(&:freeze).freeze
+    end
+
+    def process_file(file)
       puts "Scanning #{file}" if @options[:debug]
-      processed_source, offenses = process_source(file)
 
-      if offenses.any?
-        formatter_set.file_started(file, offenses)
-        formatter_set.file_finished(file, offenses.compact.sort.freeze)
-        return offenses
-      end
+      processed_source = ProcessedSource.from_file(file)
 
-      formatter_set.file_started(
-        file, cop_disabled_line_ranges: processed_source.disabled_line_ranges)
+      formatter_set.file_started(file, file_info(processed_source))
+
+      offenses = []
 
       # When running with --auto-correct, we need to inspect the file (which
       # includes writing a corrected version of it) until no more corrections
@@ -70,38 +66,23 @@ module RuboCop
         # only keep the corrected ones in order to avoid duplicate reporting.
         offenses.select!(&:corrected?)
 
-        new_offenses, updated_source_file =
-          inspect_file(processed_source, config_store)
-        offenses += new_offenses.reject { |n| offenses.include?(n) }
+        new_offenses, updated_source_file = inspect_file(processed_source)
+        offenses.concat(new_offenses).uniq!
         break unless updated_source_file
 
         # We have to reprocess the source to pickup the changes. Since the
         # change could (theoretically) introduce parsing errors, we break the
         # loop if we find any.
-        processed_source, parse_offenses = process_source(file)
-        offenses += parse_offenses if parse_offenses.any?
+        processed_source = ProcessedSource.from_file(file)
       end
 
-      formatter_set.file_finished(file, offenses.compact.sort.freeze)
-      offenses
-    end
-
-    def process_source(file)
-      begin
-        processed_source = SourceParser.parse_file(file)
-      rescue Encoding::UndefinedConversionError, ArgumentError => e
-        range = Struct.new(:line, :column, :source_line).new(1, 0, '')
-        return [
-          nil,
-          [Cop::Offense.new(:fatal, range, e.message.capitalize + '.',
-                            'Parser')]]
-      end
+      formatter_set.file_finished(file, offenses.sort.freeze)
 
-      [processed_source, []]
+      offenses
     end
 
-    def inspect_file(processed_source, config_store)
-      config = config_store.for(processed_source.file_path)
+    def inspect_file(processed_source)
+      config = @config_store.for(processed_source.path)
       team = Cop::Team.new(mobilized_cop_classes(config), config, @options)
       offenses = team.inspect_file(processed_source)
       @errors.concat(team.errors)
@@ -148,9 +129,19 @@ module RuboCop
       end
     end
 
-    def fail_level
-      @fail_level ||= RuboCop::Cop::Severity.new(
-        @options[:fail_level] || :refactor)
+    def considered_failure?(offense)
+      offense.severity >= minimum_severity_to_fail
+    end
+
+    def minimum_severity_to_fail
+      @minimum_severity_to_fail ||= begin
+        name = @options[:fail_level] || :refactor
+        RuboCop::Cop::Severity.new(name)
+      end
+    end
+
+    def file_info(processed_source)
+      { cop_disabled_line_ranges: processed_source.disabled_line_ranges }
     end
   end
 end

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.23.0'
+    STRING = '0.24.0'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/relnotes/v0.24.0.md

@@ -0,0 +1,77 @@
+This release is mostly about fixing bugs, but it also features a few new cops.
+
+Below is the list of all the gory details. Enjoy!
+
+### 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][])
+
+[@bbatsov]: https://github.com/bbatsov
+[@jonas054]: https://github.com/jonas054
+[@yujinakayama]: https://github.com/yujinakayama
+[@dblock]: https://github.com/dblock
+[@nevir]: https://github.com/nevir
+[@daviddavis]: https://github.com/daviddavis
+[@sds]: https://github.com/sds
+[@fancyremarker]: https://github.com/fancyremarker
+[@sinisterchipmunk]: https://github.com/sinisterchipmunk
+[@vonTronje]: https://github.com/vonTronje
+[@agrimm]: https://github.com/agrimm
+[@pmenglund]: https://github.com/pmenglund
+[@chulkilee]: https://github.com/chulkilee
+[@codez]: https://github.com/codez
+[@emou]: https://github.com/emou
+[@skanev]: http://github.com/skanev
+[@claco]: http://github.com/claco
+[@rifraf]: http://github.com/rifraf
+[@scottmatthewman]: https://github.com/scottmatthewman
+[@ma2gedev]: http://github.com/ma2gedev
+[@jeremyolliver]: https://github.com/jeremyolliver
+[@hannestyden]: https://github.com/hannestyden
+[@geniou]: https://github.com/geniou
+[@jkogara]: https://github.com/jkogara
+[@tmorris-fiksu]: https://github.com/tmorris-fiksu
+[@mockdeep]: https://github.com/mockdeep
+[@hiroponz]: https://github.com/hiroponz
+[@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
+[@tommeier]: https://github.com/tommeier
+[@sfeldon]: https://github.com/sfeldon
+[@biinari]: https://github.com/biinari
+[@barunio]: https://github.com/barunio
+[@molawson]: https://github.com/molawson
+[@wndhydrnt]: https://github.com/wndhydrnt
+[@ggilder]: https://github.com/ggilder
+[@salbertson]: https://github.com/salbertson
+[@camilleldn]: https://github.com/camilleldn

data/rubocop.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |s|
   s.version = RuboCop::Version::STRING
   s.platform = Gem::Platform::RUBY
   s.required_ruby_version = '>= 1.9.2'
-  s.authors = ['Bozhidar Batsov']
+  s.authors = ['Bozhidar Batsov', 'Jonas Arvidsson', 'Yuji Nakayama']
   s.description = <<-EOF
     Automatic Ruby code style checking tool.
     Aims to enforce the community-driven Ruby Style Guide.
   EOF
 
-  s.email = 'bozhidar@batsov.com'
+  s.email = 'rubocop@googlegroups.com'
   s.files = `git ls-files`.split($RS)
   s.test_files = s.files.grep(/^spec\//)
   s.executables = s.files.grep(/^bin\//) { |f| File.basename(f) }
@@ -27,12 +27,12 @@ Gem::Specification.new do |s|
   s.summary = 'Automatic Ruby code style checking tool.'
 
   s.add_runtime_dependency('rainbow', '>= 1.99.1', '< 3.0')
-  s.add_runtime_dependency('parser', '~> 2.1.9')
+  s.add_runtime_dependency('parser', '>= 2.2.0.pre.2', '< 3.0')
   s.add_runtime_dependency('powerpack', '~> 0.0.6')
   s.add_runtime_dependency('json', '>= 1.7.7', '< 2')
   s.add_runtime_dependency('ruby-progressbar', '~> 1.4')
   s.add_development_dependency('rake', '~> 10.1')
-  s.add_development_dependency('rspec', '~> 2.14')
+  s.add_development_dependency('rspec', '~> 3.0')
   s.add_development_dependency('yard', '~> 0.8')
   s.add_development_dependency('bundler', '~> 1.3')
   s.add_development_dependency('simplecov', '~> 0.7')