rubocop 0.47.1 → 0.48.0

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    class VariableForce
+      # Mix-in module for classes which own a node and need branch information
+      # of the node. The user classes must implement #node and #scope.
+      module Branchable
+        def branch
+          return @branch if instance_variable_defined?(:@branch)
+          @branch = Branch.of(node, scope: scope)
+        end
+
+        def run_exclusively_with?(other)
+          return false if !branch || !other.branch
+          branch.exclusive_with?(other.branch)
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module RuboCop
     class VariableForce
       # This class represents each reference of a variable.
       class Reference
-        include Locatable
+        include Branchable
 
         VARIABLE_REFERENCE_TYPES = (
           [VARIABLE_REFERENCE_TYPE] +
@@ -24,8 +24,6 @@ module RuboCop
 
           @node = node
           @scope = scope
-
-          super
         end
 
         # There's an implicit variable reference by the zero-arity `super`:

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

@@ -15,14 +15,18 @@ module RuboCop
           block:  0..0
         }.freeze
 
-        attr_reader :node, :variables
+        attr_reader :node, :variables, :naked_top_level
+        alias naked_top_level? naked_top_level
 
         def initialize(node)
-          # Accept any node type for top level scope
-          unless SCOPE_TYPES.include?(node.type) || !node.parent
-            raise ArgumentError,
-                  "Node type must be any of #{SCOPE_TYPES}, " \
-                  "passed #{node.type}"
+          unless SCOPE_TYPES.include?(node.type)
+            # Accept any node type for top level scope
+            if node.parent
+              raise ArgumentError,
+                    "Node type must be any of #{SCOPE_TYPES}, " \
+                    "passed #{node.type}"
+            end
+            @naked_top_level = true
           end
           @node = node
           @variables = {}
@@ -41,37 +45,43 @@ module RuboCop
         end
 
         def body_node
-          child_index = case @node.type
-                        when :module, :sclass     then 1
-                        when :def, :class, :block then 2
-                        when :defs                then 3
-                        end
+          if naked_top_level?
+            node
+          else
+            child_index = case node.type
+                          when :module, :sclass     then 1
+                          when :def, :class, :block then 2
+                          when :defs                then 3
+                          end
 
-          child_index ? @node.children[child_index] : @node
+            node.children[child_index]
+          end
+        end
+
+        def include?(target_node)
+          !belong_to_outer_scope?(target_node) &&
+            !belong_to_inner_scope?(target_node)
         end
 
         def each_node(&block)
           return to_enum(__method__) unless block_given?
+          yield node if naked_top_level?
           scan_node(node, &block)
         end
 
         private
 
         def scan_node(node, &block)
-          yield node unless node.parent
-
           node.each_child_node do |child_node|
-            next if belong_to_another_scope?(child_node)
+            next unless include?(child_node)
             yield child_node
             scan_node(child_node, &block)
           end
         end
 
-        def belong_to_another_scope?(node)
-          belong_to_outer_scope?(node) || belong_to_inner_scope?(node)
-        end
-
         def belong_to_outer_scope?(target_node)
+          return true if !naked_top_level? && target_node.equal?(node)
+          return true if ancestor_node?(target_node)
           return false unless target_node.parent.equal?(node)
           indices = OUTER_SCOPE_CHILD_INDICES[target_node.parent.type]
           return false unless indices
@@ -79,12 +89,18 @@ module RuboCop
         end
 
         def belong_to_inner_scope?(target_node)
-          return false if target_node.parent.equal?(node)
+          return false if !target_node.parent || target_node.parent.equal?(node)
           return false unless SCOPE_TYPES.include?(target_node.parent.type)
           indices = OUTER_SCOPE_CHILD_INDICES[target_node.parent.type]
           return true unless indices
           !indices.include?(target_node.sibling_index)
         end
+
+        def ancestor_node?(target_node)
+          node.each_ancestor.any? do |ancestor_node|
+            ancestor_node.equal?(target_node)
+          end
+        end
       end
     end
   end

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

@@ -41,19 +41,20 @@ module RuboCop
         def reference!(node)
           reference = Reference.new(node, @scope)
           @references << reference
-          consumed_branch_ids = Set.new
+          consumed_branches = Set.new
 
           @assignments.reverse_each do |assignment|
-            next if consumed_branch_ids.include?(assignment.branch_id)
+            next if consumed_branches.include?(assignment.branch)
 
             unless assignment.run_exclusively_with?(reference)
               assignment.reference!
             end
 
-            break unless assignment.inside_of_branch?
-            break if assignment.branch_id == reference.branch_id
-            next if assignment.reference_penetrable?
-            consumed_branch_ids << assignment.branch_id
+            break if !assignment.branch || assignment.branch == reference.branch
+
+            unless assignment.branch.may_run_incompletely?
+              consumed_branches << assignment.branch
+            end
           end
         end
 
@@ -82,7 +83,7 @@ module RuboCop
         end
 
         def method_argument?
-          argument? && [:def, :defs].include?(@scope.node.type)
+          argument? && %i(def defs).include?(@scope.node.type)
         end
 
         def block_argument?
@@ -90,7 +91,7 @@ module RuboCop
         end
 
         def keyword_argument?
-          [:kwarg, :kwoptarg].include?(@declaration_node.type)
+          %i(kwarg kwoptarg).include?(@declaration_node.type)
         end
 
         def explicit_block_local_variable?

data/lib/rubocop/formatter/colorizable.rb

@@ -22,16 +22,16 @@ module RuboCop
         rainbow.wrap(string).color(*args)
       end
 
-      [
-        :black,
-        :red,
-        :green,
-        :yellow,
-        :blue,
-        :magenta,
-        :cyan,
-        :white
-      ].each do |color|
+      %i(
+        black
+        red
+        green
+        yellow
+        blue
+        magenta
+        cyan
+        white
+      ).each do |color|
         define_method(color) do |string|
           colorize(string, color)
         end

data/lib/rubocop/formatter/formatter_set.rb

@@ -22,7 +22,7 @@ module RuboCop
         'worst'    => WorstOffendersFormatter
       }.freeze
 
-      FORMATTER_APIS = [:started, :finished].freeze
+      FORMATTER_APIS = %i(started finished).freeze
 
       FORMATTER_APIS.each do |method_name|
         define_method(method_name) do |*args|

data/lib/rubocop/formatter/html_formatter.rb

@@ -61,7 +61,8 @@ module RuboCop
 
       # This class provides helper methods used in the ERB template.
       class ERBContext
-        include PathUtil, TextUtil
+        include PathUtil
+        include TextUtil
 
         SEVERITY_COLORS = {
           refactor:   Color.new(0xED, 0x9C, 0x28, 1.0),

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -9,7 +9,8 @@ module RuboCop
     # Offenses are displayed at compact form - just the
     # location of the problem and the associated message.
     class SimpleTextFormatter < BaseFormatter
-      include Colorizable, PathUtil
+      include Colorizable
+      include PathUtil
 
       COLOR_FOR_SEVERITY = {
         refactor:   :yellow,
@@ -90,7 +91,8 @@ module RuboCop
 
       # A helper class for building the report summary text.
       class Report
-        include Colorizable, TextUtil
+        include Colorizable
+        include TextUtil
 
         def initialize(file_count, offense_count, correction_count, rainbow)
           @file_count = file_count

data/lib/rubocop/magic_comment.rb

@@ -26,6 +26,10 @@ module RuboCop
       @comment = comment
     end
 
+    def any?
+      frozen_string_literal_specified? || encoding_specified?
+    end
+
     # Does the magic comment enable the frozen string literal feature.
     #
     # Test whether the frozen string literal value is `true`. Cannot
@@ -42,7 +46,7 @@ module RuboCop
     #
     # @return [Boolean]
     def frozen_string_literal_specified?
-      !frozen_string_literal.nil?
+      specified?(frozen_string_literal)
     end
 
     # Expose the `frozen_string_literal` value coerced to a boolean if possible.
@@ -61,8 +65,16 @@ module RuboCop
       end
     end
 
+    def encoding_specified?
+      specified?(encoding)
+    end
+
     private
 
+    def specified?(value)
+      !value.nil?
+    end
+
     # Match the entire comment string with a pattern and take the first capture.
     #
     # @param pattern [Regexp]
@@ -109,11 +121,10 @@ module RuboCop
     #
     # @example Emacs style comment
     #   comment = RuboCop::MagicComment.parse(
-    #     '# -*- encoding: ASCII-8BIT; frozen_string_literal: true -*-'
+    #     '# -*- encoding: ASCII-8BIT -*-'
     #   )
     #
-    #   comment.encoding              # => 'ascii-8bit'
-    #   comment.frozen_string_literal # => true
+    #   comment.encoding # => 'ascii-8bit'
     #
     # @see https://www.gnu.org/software/emacs/manual/html_node/emacs/Specify-Coding.html
     # @see https://git.io/vMCXh Emacs handling in Ruby's parse.y
@@ -179,7 +190,7 @@ module RuboCop
     class SimpleComment < MagicComment
       # Match `encoding` or `coding`
       def encoding
-        extract(/\b(?:en)?coding: (#{TOKEN})/)
+        extract(/\b(?:en)?coding: (#{TOKEN})/i)
       end
 
       private
@@ -188,8 +199,11 @@ module RuboCop
       #
       # The `frozen_string_literal` magic comment only works if it
       # is the only text in the comment.
+      #
+      # Case-insensitive and dashes/underscores are acceptable.
+      # @see https://git.io/vM7Mg
       def extract_frozen_string_literal
-        extract(/^#\s*frozen_string_literal:\s*(#{TOKEN})\s*$/)
+        extract(/\A#\s*frozen[_-]string[_-]literal:\s*(#{TOKEN})\s*\z/i)
       end
     end
   end

data/lib/rubocop/options.rb

@@ -6,7 +6,7 @@ require 'shellwords'
 module RuboCop
   # This class handles command line options.
   class Options
-    EXITING_OPTIONS = [:version, :verbose_version, :show_cops].freeze
+    EXITING_OPTIONS = %i(version verbose_version show_cops).freeze
     DEFAULT_MAXIMUM_EXCLUSION_ITEMS = 15
 
     def initialize

data/lib/rubocop/platform.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This module provides information on the platform that RuboCop is being run
+  # on.
+  module Platform
+    def self.windows?
+      RUBY_PLATFORM =~ /cygwin|mswin|mingw|bccwin|wince|emx/
+    end
+  end
+end

data/lib/rubocop/processed_source.rb

@@ -70,7 +70,7 @@ module RuboCop
 
     def valid_syntax?
       return false if @parser_error
-      @diagnostics.none? { |d| [:error, :fatal].include?(d.level) }
+      @diagnostics.none? { |d| %i(error fatal).include?(d.level) }
     end
 
     # Raw source checksum for tracking infinite loops.

data/lib/rubocop/remote_config.rb

@@ -27,17 +27,29 @@ module RuboCop
 
     private
 
-    def request
-      http = Net::HTTP.new(@uri.hostname, @uri.port)
-      http.use_ssl = true if @uri.instance_of? URI::HTTPS
+    def request(uri = @uri, limit = 10, &block)
+      raise ArgumentError, 'HTTP redirect too deep' if limit.zero?
 
-      request = Net::HTTP::Get.new(@uri.request_uri)
+      http = Net::HTTP.new(uri.hostname, uri.port)
+      http.use_ssl = true if uri.instance_of? URI::HTTPS
+
+      request = Net::HTTP::Get.new(uri.request_uri)
       if cache_path_exists?
         request['If-Modified-Since'] = File.stat(cache_path).mtime.rfc2822
       end
 
-      response = http.request(request)
-      yield response if response.is_a?(Net::HTTPSuccess)
+      handle_response(http.request(request), limit, &block)
+    end
+
+    def handle_response(response, limit, &block)
+      case response
+      when Net::HTTPSuccess
+        yield response
+      when Net::HTTPRedirection
+        request(URI.parse(response['location']), limit - 1, &block)
+      else
+        response.error!
+      end
     end
 
     def cache_path

data/lib/rubocop/result_cache.rb

@@ -8,8 +8,8 @@ require 'etc'
 module RuboCop
   # Provides functionality for caching rubocop runs.
   class ResultCache
-    NON_CHANGING = [:color, :format, :formatters, :out, :debug, :fail_level,
-                    :cache, :fail_fast, :stdin].freeze
+    NON_CHANGING = %i(color format formatters out debug fail_level
+                      cache fail_fast stdin).freeze
 
     # Remove old files so that the cache doesn't grow too big. When the
     # threshold MaxFilesInCache has been exceeded, the oldest 50% of all the
@@ -44,20 +44,20 @@ module RuboCop
           puts "Removing the #{remove_count} oldest files from #{cache_root}"
         end
         sorted = files.sort_by { |path| File.mtime(path) }
-        remove_files(sorted, dirs, remove_count, verbose)
+        remove_files(sorted, dirs, remove_count)
+      rescue Errno::ENOENT
+        # This can happen if parallel RuboCop invocations try to remove the
+        # same files. No problem.
+        puts $ERROR_INFO if verbose
       end
 
-      def remove_files(files, dirs, remove_count, verbose)
+      def remove_files(files, dirs, remove_count)
         # Batch file deletions, deleting over 130,000+ files will crash
         # File.delete.
         files[0, remove_count].each_slice(10_000).each do |files_slice|
           File.delete(*files_slice)
         end
         dirs.each { |dir| Dir.rmdir(dir) if Dir["#{dir}/*"].empty? }
-      rescue Errno::ENOENT
-        # This can happen if parallel RuboCop invocations try to remove the
-        # same files. No problem.
-        puts $ERROR_INFO if verbose
       end
     end
 

data/lib/rubocop/rspec/cop_helper.rb

@@ -7,6 +7,8 @@ module CopHelper
   extend RSpec::SharedContext
 
   let(:ruby_version) { 2.2 }
+  let(:enabled_rails) { false }
+  let(:rails_version) { false }
 
   def inspect_source_file(cop, source)
     Tempfile.open('tmp') { |f| inspect_source(cop, source, f) }