rubocop 0.35.1 → 0.36.0

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -13,8 +14,8 @@ module RuboCop
       # reassignments and properly handles varied cases such as branch, loop,
       # rescue, ensure, etc.
       class UselessAssignment < Cop
-        MSG = 'Useless assignment to variable - `%s`.'
-        MINIMUM_SIMILARITY_TO_SUGGEST = 0.9
+        include NameSimilarity
+        MSG = 'Useless assignment to variable - `%s`.'.freeze
 
         def join_force?(force_class)
           force_class == VariableForce
@@ -35,7 +36,7 @@ module RuboCop
             message = message_for_useless_assignment(assignment)
 
             location = if assignment.regexp_named_capture?
-                         assignment.node.children.first.loc.expression
+                         assignment.node.children.first.source_range
                        else
                          assignment.node.loc.name
                        end
@@ -77,19 +78,6 @@ module RuboCop
           end
         end
 
-        def find_similar_name(target_name, scope)
-          names = collect_variable_like_names(scope)
-          names.delete(target_name)
-
-          scores = names.each_with_object({}) do |name, hash|
-            score = StringUtil.similarity(target_name, name)
-            hash[name] = score if score >= MINIMUM_SIMILARITY_TO_SUGGEST
-          end
-
-          most_similar_name, _max_score = scores.max_by { |_, score| score }
-          most_similar_name
-        end
-
         def collect_variable_like_names(scope)
           names = scope.each_node.with_object(Set.new) do |node, set|
             if variable_like_method_invocation?(node)

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -9,9 +10,9 @@ module RuboCop
       #
       #  x.top >= x.top
       class UselessComparison < Cop
-        MSG = 'Comparison of something with itself detected.'
+        MSG = 'Comparison of something with itself detected.'.freeze
 
-        OPS = %w(== === != < > <= >= <=>)
+        OPS = %w(== === != < > <= >= <=>).freeze
 
         def on_send(node)
           # lambda.() does not have a selector

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -14,7 +15,7 @@ module RuboCop
       class UselessElseWithoutRescue < Cop
         include ParserDiagnostic
 
-        MSG = '`else` without `rescue` is useless.'
+        MSG = '`else` without `rescue` is useless.'.freeze
 
         private
 

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -15,26 +16,19 @@ module RuboCop
       class UselessSetterCall < Cop
         include OnMethodDef
 
-        MSG = 'Useless setter call to local variable `%s`.'
+        MSG = 'Useless setter call to local variable `%s`.'.freeze
         ASSIGNMENT_TYPES = [:lvasgn, :ivasgn, :cvasgn, :gvasgn].freeze
-        LITERAL_TYPES = [
-          :true, :false, :nil,
-          :int, :float,
-          :str, :dstr, :sym, :dsym, :xstr, :regexp,
-          :array, :hash,
-          :irange, :erange
-        ].freeze
 
         private
 
         def on_method_def(_node, _method_name, _args, body)
           return unless body
 
-          if body.type == :begin
-            expression = body.children
-          else
-            expression = body
-          end
+          expression = if body.type == :begin
+                         body.children
+                       else
+                         body
+                       end
 
           last_expr = expression.is_a?(Array) ? expression.last : expression
 
@@ -136,16 +130,16 @@ module RuboCop
           def process_assignment(asgn_node, rhs_node)
             lhs_variable_name, = *asgn_node
 
-            if [:lvar, :ivar, :cvar, :gvar].include?(rhs_node.type)
-              rhs_variable_name, = *rhs_node
-              @local[lhs_variable_name] = @local[rhs_variable_name]
-            else
-              @local[lhs_variable_name] = constructor?(rhs_node)
-            end
+            @local[lhs_variable_name] = if rhs_node.variable?
+                                          rhs_variable_name, = *rhs_node
+                                          @local[rhs_variable_name]
+                                        else
+                                          constructor?(rhs_node)
+                                        end
           end
 
           def constructor?(node)
-            return true if LITERAL_TYPES.include?(node.type)
+            return true if node.literal?
             return false unless node.type == :send
             _receiver, method = *node
             method == :new

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -6,14 +7,11 @@ module RuboCop
       # This cop checks for operators, variables and literals used
       # in void context.
       class Void < Cop
-        OP_MSG = 'Operator `%s` used in void context.'
-        VAR_MSG = 'Variable `%s` used in void context.'
-        LIT_MSG = 'Literal `%s` used in void context.'
+        OP_MSG = 'Operator `%s` used in void context.'.freeze
+        VAR_MSG = 'Variable `%s` used in void context.'.freeze
+        LIT_MSG = 'Literal `%s` used in void context.'.freeze
 
-        OPS = %w(* / % + - == === != < > <= >= <=>)
-        VARS = [:ivar, :lvar, :cvar, :const]
-        LITERALS = [:str, :dstr, :int, :float, :array,
-                    :hash, :regexp, :nil, :true, :false, :sym]
+        OPS = %w(* / % + - == === != < > <= >= <=>).freeze
 
         def on_begin(node)
           check_begin(node)
@@ -45,14 +43,15 @@ module RuboCop
         end
 
         def check_for_var(node)
-          return unless VARS.include?(node.type)
+          return unless node.variable? || node.const_type?
           add_offense(node, :name, format(VAR_MSG, node.loc.name.source))
         end
 
         def check_for_literal(node)
-          return unless LITERALS.include?(node.type)
-          add_offense(node, :expression,
-                      format(LIT_MSG, node.loc.expression.source))
+          return unless node.literal?
+          return if node.xstr_type?
+
+          add_offense(node, :expression, format(LIT_MSG, node.source))
         end
       end
     end

data/lib/rubocop/cop/metrics/abc_size.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -9,7 +10,8 @@ module RuboCop
       class AbcSize < Cop
         include MethodComplexity
 
-        MSG = 'Assignment Branch Condition size for %s is too high. [%.4g/%.4g]'
+        MSG = 'Assignment Branch Condition size for %s is too high. ' \
+              '[%.4g/%.4g]'.freeze
         BRANCH_NODES = [:send].freeze
         CONDITION_NODES = CyclomaticComplexity::COUNTED_NODES.freeze
 

data/lib/rubocop/cop/metrics/block_nesting.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -15,7 +16,7 @@ module RuboCop
         NESTING_BLOCKS = [
           :case, :if, :while, :while_post,
           :until, :until_post, :for, :resbody
-        ]
+        ].freeze
 
         def investigate(processed_source)
           return unless processed_source.ast

data/lib/rubocop/cop/metrics/class_length.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop

data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -16,8 +17,9 @@ module RuboCop
       class CyclomaticComplexity < Cop
         include MethodComplexity
 
-        MSG = 'Cyclomatic complexity for %s is too high. [%d/%d]'
-        COUNTED_NODES = [:if, :while, :until, :for, :rescue, :when, :and, :or]
+        MSG = 'Cyclomatic complexity for %s is too high. [%d/%d]'.freeze
+        COUNTED_NODES = [:if, :while, :until, :for,
+                         :rescue, :when, :and, :or].freeze
 
         private
 

data/lib/rubocop/cop/metrics/line_length.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'uri'
 
@@ -10,12 +11,17 @@ module RuboCop
       class LineLength < Cop
         include ConfigurableMax
 
-        MSG = 'Line is too long. [%d/%d]'
+        MSG = 'Line is too long. [%d/%d]'.freeze
 
         def investigate(processed_source)
+          heredocs = extract_heredocs(processed_source.ast) if allow_heredoc?
           processed_source.lines.each_with_index do |line, index|
             next unless line.length > max
 
+            if allow_heredoc?
+              next if line_in_whitelisted_heredoc?(heredocs, index.succ)
+            end
+
             if allow_uri?
               uri_range = find_excessive_uri_range(line)
               next if uri_range && allowed_uri_position?(line, uri_range)
@@ -40,6 +46,31 @@ module RuboCop
           cop_config['Max']
         end
 
+        def allow_heredoc?
+          allowed_heredoc
+        end
+
+        def allowed_heredoc
+          cop_config['AllowHeredoc']
+        end
+
+        def extract_heredocs(ast)
+          return [] unless ast
+          ast.each_node.with_object([]) do |node, heredocs|
+            next unless node.location.is_a?(Parser::Source::Map::Heredoc)
+            body = node.location.heredoc_body
+            delimiter = node.location.heredoc_end.source.strip
+            heredocs << [body.first_line...body.last_line, delimiter]
+          end
+        end
+
+        def line_in_whitelisted_heredoc?(heredocs, line_number)
+          heredocs.any? do |range, delimiter|
+            range.cover?(line_number) &&
+              (allowed_heredoc == true || allowed_heredoc.include?(delimiter))
+          end
+        end
+
         def allow_uri?
           cop_config['AllowURI']
         end
@@ -58,18 +89,9 @@ module RuboCop
 
         def match_uris(string)
           matches = []
-          unscanned_position = 0
-
-          loop do
-            match_data = string.match(uri_regexp, unscanned_position)
-            break unless match_data
-
-            uri_ish_string = match_data[0]
-            matches << match_data if valid_uri?(uri_ish_string)
-
-            _, unscanned_position = match_data.offset(0)
+          string.scan(uri_regexp) do
+            matches << $LAST_MATCH_INFO if valid_uri?($LAST_MATCH_INFO[0])
           end
-
           matches
         end
 
@@ -81,7 +103,7 @@ module RuboCop
         end
 
         def uri_regexp
-          URI.regexp(cop_config['URISchemes'])
+          @regexp ||= URI.regexp(cop_config['URISchemes'])
         end
       end
     end

data/lib/rubocop/cop/metrics/method_length.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -21,7 +22,7 @@ module RuboCop
         end
 
         def code_length(node)
-          lines = node.loc.expression.source.lines.to_a[1..-2] || []
+          lines = node.source.lines.to_a[1..-2] || []
 
           lines.count { |line| !irrelevant_line(line) }
         end

data/lib/rubocop/cop/metrics/module_length.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop

data/lib/rubocop/cop/metrics/parameter_lists.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -10,7 +11,7 @@ module RuboCop
       class ParameterLists < Cop
         include ConfigurableMax
 
-        MSG = 'Avoid parameter lists longer than %d parameters.'
+        MSG = 'Avoid parameter lists longer than %d parameters.'.freeze
 
         def on_args(node)
           count = args_count(node)

data/lib/rubocop/cop/metrics/perceived_complexity.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
@@ -30,8 +31,9 @@ module RuboCop
         include MethodComplexity
         include IfNode
 
-        MSG = 'Perceived complexity for %s is too high. [%d/%d]'
-        COUNTED_NODES = [:if, :case, :while, :until, :for, :rescue, :and, :or]
+        MSG = 'Perceived complexity for %s is too high. [%d/%d]'.freeze
+        COUNTED_NODES = [:if, :case, :while, :until,
+                         :for, :rescue, :and, :or].freeze
 
         private
 

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

@@ -1,10 +1,11 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop
     # Common functionality for checking modifier nodes.
     module AccessModifierNode
-      extend AST::Sexp
+      extend RuboCop::Sexp
 
       PRIVATE_NODE = s(:send, nil, :private)
       PROTECTED_NODE = s(:send, nil, :protected)
@@ -30,20 +31,12 @@ module RuboCop
       def class_or_module_parent?(node)
         node.each_ancestor do |a|
           if a.type == :block
-            return true if class_constructor?(a)
+            return true if a.class_constructor?
           elsif a.type != :begin
             return [:casgn, :sclass, :class, :module].include?(a.type)
           end
         end
       end
-
-      # Returns true when the block node looks like Class or Module.new do ... .
-      def class_constructor?(block_node)
-        send_node = block_node.children.first
-        receiver_node, method_name, = *send_node
-        return false unless method_name == :new
-        %w(Class Module).include?(Util.const_name(receiver_node))
-      end
     end
   end
 end

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module RuboCop
   module Cop

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

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+module RuboCop
+  module Cop
+    # Common code for indenting literal arrays and hashes.
+    module ArrayHashIndentation
+      def each_argument_node(node, type)
+        _receiver, _method_name, *args = *node
+        left_parenthesis = node.loc.begin
+        return unless left_parenthesis
+
+        args.each do |arg|
+          on_node(type, arg, :send) do |type_node|
+            left_brace = type_node.loc.begin
+            if left_brace && left_brace.line == left_parenthesis.line
+              yield type_node, left_parenthesis
+              ignore_node(type_node)
+            end
+          end
+        end
+      end
+
+      def check_first(first, left_brace, left_parenthesis, offset)
+        actual_column = first.source_range.column
+        expected_column = base_column(left_brace, left_parenthesis) +
+                          configured_indentation_width + offset
+        @column_delta = expected_column - actual_column
+
+        if @column_delta == 0
+          # which column was actually used as 'base column' for indentation?
+          # (not the column which we think should be the 'base column',
+          # but the one which has actually been used for that purpose)
+          base_column = actual_column - configured_indentation_width - offset
+          styles = detected_styles(base_column, left_parenthesis, left_brace)
+          if styles.size > 1
+            ambiguous_style_detected(*styles)
+          else
+            correct_style_detected
+          end
+        else
+          incorrect_style_detected(actual_column, offset, first,
+                                   left_parenthesis, left_brace)
+        end
+      end
+
+      def base_column(left_brace, left_parenthesis)
+        if style == brace_alignment_style
+          left_brace.column
+        elsif left_parenthesis && style == :special_inside_parentheses
+          left_parenthesis.column + 1
+        else
+          left_brace.source_line =~ /\S/
+        end
+      end
+
+      def detected_styles(column, left_parenthesis, left_brace)
+        styles = []
+        if column == (left_brace.source_line =~ /\S/)
+          styles << :consistent
+          styles << :special_inside_parentheses unless left_parenthesis
+        end
+        if left_parenthesis && column == left_parenthesis.column + 1
+          styles << :special_inside_parentheses
+        end
+        styles << brace_alignment_style if column == left_brace.column
+        styles
+      end
+
+      def incorrect_style_detected(column, offset, first, left_parenthesis,
+                                   left_brace)
+        add_offense(first, :expression,
+                    message(base_description(left_parenthesis))) do
+          base_column = column - configured_indentation_width - offset
+          styles = detected_styles(base_column, left_parenthesis, left_brace)
+          ambiguous_style_detected(*styles)
+        end
+      end
+    end
+  end
+end