rubocop 0.52.0 → 0.52.1

data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb

@@ -51,6 +51,10 @@ module RuboCop
                 node.source_range.end_pos)
         end
 
+        def autocorrect(range)
+          PunctuationCorrector.swap_comma(range)
+        end
+
         private
 
         def avoid_autocorrect?(args)

data/lib/rubocop/cop/style/trailing_comma_in_literal.rb

@@ -53,6 +53,10 @@ module RuboCop
           check_literal(node, 'item of %<article>s hash')
         end
 
+        def autocorrect(range)
+          PunctuationCorrector.swap_comma(range)
+        end
+
         private
 
         def check_literal(node, kind)

data/lib/rubocop/cop/style/trailing_method_end_statement.rb

@@ -34,7 +34,7 @@ module RuboCop
       #   end
       #
       class TrailingMethodEndStatement < Cop
-        include AutocorrectAlignment
+        include Alignment
 
         MSG = 'Place the end statement of a multi-line method on ' \
               'its own line.'.freeze

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -79,14 +79,21 @@ module RuboCop
         output.puts
         cfg = self.class.config_to_allow_offenses[cop_name] || {}
 
-        output_cop_comments(output, cfg, cop_name, offense_count)
-        output_cop_config(output, cfg, cop_name)
-      end
-
-      def output_cop_comments(output, cfg, cop_name, offense_count)
-        output.puts "# Offense count: #{offense_count}" if @show_offense_counts
+        # To avoid malformed YAML when potentially reading the config in
+        # #excludes, we use an output buffer and append it to the actual output
+        # only when it results in valid YAML.
+        output_buffer = StringIO.new
+        output_cop_comments(output_buffer, cfg, cop_name, offense_count)
+        output_cop_config(output_buffer, cfg, cop_name)
+        output.puts(output_buffer.string)
+      end
+
+      def output_cop_comments(output_buffer, cfg, cop_name, offense_count)
+        if @show_offense_counts
+          output_buffer.puts "# Offense count: #{offense_count}"
+        end
         if COPS[cop_name] && COPS[cop_name].first.new.support_autocorrect?
-          output.puts '# Cop supports --auto-correct.'
+          output_buffer.puts '# Cop supports --auto-correct.'
         end
 
         default_cfg = default_config(cop_name)
@@ -95,7 +102,7 @@ module RuboCop
         params = cop_config_params(default_cfg, cfg)
         return if params.empty?
 
-        output_cop_param_comments(params, default_cfg)
+        output_cop_param_comments(output_buffer, params, default_cfg)
       end
 
       def cop_config_params(default_cfg, cfg)
@@ -104,15 +111,17 @@ module RuboCop
           cfg.keys
       end
 
-      def output_cop_param_comments(params, default_cfg)
+      def output_cop_param_comments(output_buffer, params, default_cfg)
         config_params = params.reject { |p| p.start_with?('Supported') }
-        output.puts "# Configuration parameters: #{config_params.join(', ')}."
+        output_buffer.puts(
+          "# Configuration parameters: #{config_params.join(', ')}."
+        )
 
         params.each do |param|
           value = default_cfg[param]
           if value.is_a?(Array)
             next if value.empty?
-            output.puts "# #{param}: #{value.join(', ')}"
+            output_buffer.puts "# #{param}: #{value.join(', ')}"
           end
         end
       end
@@ -121,38 +130,38 @@ module RuboCop
         RuboCop::ConfigLoader.default_configuration[cop_name]
       end
 
-      def output_cop_config(output, cfg, cop_name)
+      def output_cop_config(output_buffer, cfg, cop_name)
         # 'Enabled' option will be put into file only if exclude
         # limit is exceeded.
         cfg_without_enabled = cfg.reject { |key| key == 'Enabled' }
 
-        output.puts "#{cop_name}:"
+        output_buffer.puts "#{cop_name}:"
         cfg_without_enabled.each do |key, value|
           value = value[0] if value.is_a?(Array)
-          output.puts "  #{key}: #{value}"
+          output_buffer.puts "  #{key}: #{value}"
         end
 
-        output_offending_files(output, cfg_without_enabled, cop_name)
+        output_offending_files(output_buffer, cfg_without_enabled, cop_name)
       end
 
-      def output_offending_files(output, cfg, cop_name)
+      def output_offending_files(output_buffer, cfg, cop_name)
         return unless cfg.empty?
 
         offending_files = @files_with_offenses[cop_name].uniq.sort
         if offending_files.count > @exclude_limit
-          output.puts '  Enabled: false'
+          output_buffer.puts '  Enabled: false'
         else
-          output_exclude_list(output, offending_files, cop_name)
+          output_exclude_list(output_buffer, offending_files, cop_name)
         end
       end
 
-      def output_exclude_list(output, offending_files, cop_name)
+      def output_exclude_list(output_buffer, offending_files, cop_name)
         require 'pathname'
         parent = Pathname.new(Dir.pwd)
 
-        output.puts '  Exclude:'
+        output_buffer.puts '  Exclude:'
         excludes(offending_files, cop_name, parent).each do |file|
-          output_exclude_path(output, file, parent)
+          output_exclude_path(output_buffer, file, parent)
         end
       end
 
@@ -168,12 +177,12 @@ module RuboCop
         ((cfg['Exclude'] || []) + offending_files).uniq
       end
 
-      def output_exclude_path(output, file, parent)
+      def output_exclude_path(output_buffer, file, parent)
         file_path = Pathname.new(file)
         relative = file_path.relative_path_from(parent)
-        output.puts "    - '#{relative}'"
+        output_buffer.puts "    - '#{relative}'"
       rescue ArgumentError
-        output.puts "    - '#{file}'"
+        output_buffer.puts "    - '#{file}'"
       end
     end
   end

data/lib/rubocop/options.rb

@@ -4,6 +4,8 @@ require 'optparse'
 require 'shellwords'
 
 module RuboCop
+  class IncorrectCopNameError < StandardError; end
+
   # This class handles command line options.
   class Options
     EXITING_OPTIONS = %i[version verbose_version show_cops].freeze
@@ -183,19 +185,40 @@ module RuboCop
 
   # Validates option arguments and the options' compatibility with each other.
   class OptionsValidator
-    # Cop name validation must be done later than option parsing, so it's not
-    # called from within Options.
-    def self.validate_cop_list(names)
-      return unless names
+    class << self
+      # Cop name validation must be done later than option parsing, so it's not
+      # called from within Options.
+      def validate_cop_list(names)
+        return unless names
+
+        cop_names = Cop::Cop.registry.names
+        departments = Cop::Cop.registry.departments.map(&:to_s)
+
+        names.each do |name|
+          next if cop_names.include?(name)
+          next if departments.include?(name)
+          next if %w[Syntax Lint/Syntax].include?(name)
+
+          raise IncorrectCopNameError, format_message_from(name, cop_names)
+        end
+      end
 
-      departments = Cop::Cop.registry.departments.map(&:to_s)
+      private
 
-      names.each do |name|
-        next if Cop::Cop.registry.names.include?(name)
-        next if departments.include?(name)
-        next if %w[Syntax Lint/Syntax].include?(name)
+      def format_message_from(name, cop_names)
+        message = 'Unrecognized cop or department: %{name}.'
+        message_with_candidate = "#{message}\nDid you mean? %{candidate}"
+        corrections = cop_names.select do |cn|
+          score = StringUtil.similarity(cn, name)
+          score >= NameSimilarity::MINIMUM_SIMILARITY_TO_SUGGEST
+        end.sort
 
-        raise ArgumentError, "Unrecognized cop or department: #{name}."
+        if corrections.empty?
+          format message, name: name
+        else
+          format message_with_candidate, name: name,
+                                         candidate: corrections.join(', ')
+        end
       end
     end
 

data/lib/rubocop/path_util.rb

@@ -43,6 +43,13 @@ module RuboCop
       end
     end
 
+    def find_file_upwards(filename, start_dir = PathUtil.pwd)
+      Pathname(File.expand_path(start_dir)).ascend do |dir|
+        file = File.join(dir, filename)
+        return file if File.exist?(file)
+      end
+    end
+
     # Returns true for an absolute Unix or Windows path.
     def absolute?(path)
       path =~ %r{\A([A-Z]:)?/}

data/lib/rubocop/token.rb

@@ -50,6 +50,10 @@ module RuboCop
       type == :tLBRACK2
     end
 
+    def left_bracket?
+      %i[tLBRACK tLBRACK2].include?(type)
+    end
+
     def right_bracket?
       type == :tRBRACK
     end

data/lib/rubocop/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.52.0
+  version: 0.52.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2017-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -200,11 +200,22 @@ files:
 - lib/rubocop/cop/commissioner.rb
 - lib/rubocop/cop/cop.rb
 - lib/rubocop/cop/corrector.rb
+- lib/rubocop/cop/correctors/alignment_corrector.rb
+- lib/rubocop/cop/correctors/condition_corrector.rb
+- lib/rubocop/cop/correctors/empty_line_corrector.rb
+- lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb
+- lib/rubocop/cop/correctors/ordered_gem_corrector.rb
+- lib/rubocop/cop/correctors/parentheses_corrector.rb
+- lib/rubocop/cop/correctors/punctuation_corrector.rb
+- lib/rubocop/cop/correctors/space_corrector.rb
+- lib/rubocop/cop/correctors/string_literal_corrector.rb
+- lib/rubocop/cop/correctors/unused_arg_corrector.rb
 - lib/rubocop/cop/force.rb
 - lib/rubocop/cop/gemspec/duplicated_assignment.rb
 - lib/rubocop/cop/gemspec/ordered_dependencies.rb
 - lib/rubocop/cop/gemspec/required_ruby_version.rb
 - lib/rubocop/cop/generator.rb
+- lib/rubocop/cop/generator/require_file_injector.rb
 - lib/rubocop/cop/ignored_node.rb
 - lib/rubocop/cop/internal_affairs.rb
 - lib/rubocop/cop/internal_affairs/node_destructuring.rb
@@ -370,11 +381,11 @@ files:
 - lib/rubocop/cop/metrics/module_length.rb
 - lib/rubocop/cop/metrics/parameter_lists.rb
 - lib/rubocop/cop/metrics/perceived_complexity.rb
+- lib/rubocop/cop/mixin/alignment.rb
 - lib/rubocop/cop/mixin/annotation_comment.rb
 - lib/rubocop/cop/mixin/array_hash_indentation.rb
 - lib/rubocop/cop/mixin/array_min_size.rb
 - lib/rubocop/cop/mixin/array_syntax.rb
-- lib/rubocop/cop/mixin/autocorrect_alignment.rb
 - lib/rubocop/cop/mixin/check_assignment.rb
 - lib/rubocop/cop/mixin/classish_length.rb
 - lib/rubocop/cop/mixin/code_length.rb
@@ -552,7 +563,6 @@ files:
 - lib/rubocop/cop/style/end_block.rb
 - lib/rubocop/cop/style/eval_with_location.rb
 - lib/rubocop/cop/style/even_odd.rb
-- lib/rubocop/cop/style/extend_self.rb
 - lib/rubocop/cop/style/flip_flop.rb
 - lib/rubocop/cop/style/for.rb
 - lib/rubocop/cop/style/format_string.rb

data/lib/rubocop/cop/mixin/autocorrect_alignment.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    # This module does auto-correction of nodes that should just be moved to
-    # the left or to the right, amount being determined by the instance
-    # variable @column_delta.
-    module AutocorrectAlignment
-      SPACE = ' '.freeze
-
-      def configured_indentation_width
-        cop_config['IndentationWidth'] ||
-          config.for_cop('IndentationWidth')['Width']
-      end
-
-      def indentation(node)
-        offset(node) + (SPACE * configured_indentation_width)
-      end
-
-      def offset(node)
-        SPACE * node.loc.column
-      end
-
-      def display_column(range)
-        line = processed_source.lines[range.line - 1]
-        Unicode::DisplayWidth.of(line[0, range.column])
-      end
-
-      def check_alignment(items, base_column = nil)
-        unless items.empty?
-          base_column ||= display_column(items.first.source_range)
-        end
-
-        each_bad_alignment(items, base_column) do |current|
-          expr = current.source_range
-          if offenses.any? { |o| within?(expr, o.location) }
-            # If this offense is within a line range that is already being
-            # realigned by autocorrect, we report the offense without
-            # autocorrecting it. Two rewrites in the same area by the same
-            # cop can not be handled. The next iteration will find the
-            # offense again and correct it.
-            add_offense(nil, location: expr)
-          else
-            add_offense(current)
-          end
-        end
-      end
-
-      def autocorrect(arg)
-        return unless arg
-
-        heredoc_ranges = heredoc_ranges(arg)
-        expr = arg.respond_to?(:loc) ? arg.loc.expression : arg
-
-        # We can't use the instance variable inside the lambda. That would just
-        # give each lambda the same reference and they would all get the last
-        # value of @column_delta. A local variable fixes the problem.
-        column_delta = @column_delta
-
-        return if block_comment_within?(expr)
-
-        lambda do |corrector|
-          each_line(expr) do |line_begin_pos|
-            autocorrect_line(corrector, line_begin_pos, expr, column_delta,
-                             heredoc_ranges)
-          end
-        end
-      end
-
-      private
-
-      def each_bad_alignment(items, base_column)
-        prev_line = -1
-        items.each do |current|
-          if current.loc.line > prev_line &&
-             begins_its_line?(current.source_range)
-            @column_delta = base_column - display_column(current.source_range)
-
-            yield current if @column_delta.nonzero?
-          end
-          prev_line = current.loc.line
-        end
-      end
-
-      def autocorrect_line(corrector, line_begin_pos, expr, column_delta,
-                           heredoc_ranges)
-        range = calculate_range(expr, line_begin_pos, column_delta)
-        # We must not change indentation of heredoc strings.
-        return if heredoc_ranges.any? { |h| within?(range, h) }
-
-        if column_delta > 0
-          unless range.source == "\n"
-            corrector.insert_before(range, ' ' * column_delta)
-          end
-        elsif range.source =~ /\A[ \t]+\z/
-          remove(range, corrector)
-        end
-      end
-
-      def heredoc_ranges(arg)
-        return [] unless arg.is_a?(Parser::AST::Node)
-
-        arg.each_node(:dstr)
-           .select { |n| n.loc.respond_to?(:heredoc_body) }
-           .map { |n| n.loc.heredoc_body.join(n.loc.heredoc_end) }
-      end
-
-      def block_comment_within?(expr)
-        processed_source.comments.select(&:document?).any? do |c|
-          within?(c.loc.expression, expr)
-        end
-      end
-
-      def within?(inner, outer)
-        inner.begin_pos >= outer.begin_pos && inner.end_pos <= outer.end_pos
-      end
-
-      def calculate_range(expr, line_begin_pos, column_delta)
-        starts_with_space = expr.source_buffer.source[line_begin_pos] =~ / /
-        pos_to_remove = if column_delta > 0 || starts_with_space
-                          line_begin_pos
-                        else
-                          line_begin_pos - column_delta.abs
-                        end
-
-        range_between(pos_to_remove, pos_to_remove + column_delta.abs)
-      end
-
-      def remove(range, corrector)
-        original_stderr = $stderr
-        $stderr = StringIO.new # Avoid error messages on console
-        corrector.remove(range)
-      rescue RuntimeError
-        range = range_between(range.begin_pos + 1, range.end_pos + 1)
-        retry if range.source =~ /^ +$/
-      ensure
-        $stderr = original_stderr
-      end
-
-      def each_line(expr)
-        line_begin_pos = expr.begin_pos
-        expr.source.each_line do |line|
-          yield line_begin_pos
-          line_begin_pos += line.length
-        end
-      end
-    end
-  end
-end