rubocop 0.57.2 → 0.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '059456c464bec007ceecf522ade27bd7cf5e7c5a'
-  data.tar.gz: cfe7d827a44e1a84835870f38d25c4f9b13a4a00
+  metadata.gz: f3841f2f7a2e69362f57238be2722eb4f06bccf8
+  data.tar.gz: '0193123e23f57b0cea3701b8f59c90c2ea6b0658'
 SHA512:
-  metadata.gz: bdd27ccbc33113527d0d6bfbdc83cc48cf83d1a00b1162328b25fa67b062b7d13330bb5011628aab74dacbcb690610f26e4e209361c1565c4ff9341c4e32cb48
-  data.tar.gz: '092c870e83c677788d8d314a1869a84a2a505090fc5c703f10145d1ad513231087d539a497050d985e483cf869a46b8fb96424b3465933796683972f9b02928a'
+  metadata.gz: 59d32b347c6000e8b1b23981d00cde8017bee3870e941fd72482d415de3966c3928c11b566489ba55e22545d8243e82008df7c5ba4c69e788a75c878df2d13dd
+  data.tar.gz: 85337f25210448131a7bc0be46a654fd71db0590c5269a328208fbb874e82b79647150b09d64a2a1178bd7d322c013642bd1ecb59ba17516c276a1e31461916d

data/README.md

@@ -1,9 +1,11 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop.svg)](http://badge.fury.io/rb/rubocop)
 [![Travis Status](https://travis-ci.org/rubocop-hq/rubocop.svg?branch=master)](https://travis-ci.org/rubocop-hq/rubocop)
+[![CircleCI Status](https://circleci.com/gh/rubocop-hq/rubocop/tree/master.svg?style=svg)](https://circleci.com/gh/rubocop-hq/rubocop/tree/master)
 [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/sj3ye7n5690d0nvg?svg=true)](https://ci.appveyor.com/project/bbatsov/rubocop)
 [![Coverage Status](https://img.shields.io/codeclimate/coverage/github/bbatsov/rubocop.svg)](https://codeclimate.com/github/bbatsov/rubocop)
 [![Code Climate](https://codeclimate.com/github/bbatsov/rubocop/badges/gpa.svg)](https://codeclimate.com/github/bbatsov/rubocop)
 [![Inline docs](http://inch-ci.org/github/bbatsov/rubocop.svg)](http://inch-ci.org/github/bbatsov/rubocop)
+[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)
 
 [![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov)
 [![Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/bbatsov/donate)
@@ -11,7 +13,7 @@
 [![OpenCollective](https://opencollective.com/rubocop/sponsors/badge.svg)](#open-collective-sponsors)
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/bbatsov/rubocop/master/logo/rubo-logo-horizontal.png" alt="RuboCop Logo"/>
+  <img src="https://raw.githubusercontent.com/rubocop-hq/rubocop/master/logo/rubo-logo-horizontal.png" alt="RuboCop Logo"/>
 </p>
 
 > Role models are important. <br/>
@@ -19,10 +21,10 @@
 
 **RuboCop** is a Ruby static code analyzer. Out of the box it will
 enforce many of the guidelines outlined in the community
-[Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
+[Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide).
 
 Most aspects of its behavior can be tweaked via various
-[configuration options](https://github.com/bbatsov/rubocop/blob/master/config/default.yml).
+[configuration options](https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml).
 
 Apart from reporting problems in your code, RuboCop can also
 automatically fix some of the problems for you.
@@ -51,7 +53,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version locking in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.57.2', require: false
+gem 'rubocop', '~> 0.58.0', require: false
 ```
 
 ## Quickstart
@@ -65,13 +67,13 @@ $ rubocop
 
 ## Official manual
 
-You can read a ton more about RuboCop in its [official manual](http://rubocop.readthedocs.io).
+You can read a ton more about RuboCop in its [official manual](http://docs.rubocop.org).
 
 ## Compatibility
 
 RuboCop supports the following Ruby implementations:
 
-* MRI 2.1+
+* MRI 2.2+
 * JRuby 9.0+
 
 The Rails cops support the following versions:
@@ -82,24 +84,25 @@ The Rails cops support the following versions:
 
 Here's a list of RuboCop's core developers:
 
-* [Bozhidar Batsov](https://github.com/bbatsov)
+* [Bozhidar Batsov](https://github.com/bbatsov) (author & head maintainer)
 * [Jonas Arvidsson](https://github.com/jonas054)
 * [Yuji Nakayama](https://github.com/yujinakayama)
 * [Evgeni Dzhelyov](https://github.com/edzhelyov) (retired)
 * [Ted Johansson](https://github.com/drenmi)
 * [Masataka Kuwabara](https://github.com/pocke)
+* [Koichi Ito](https://github.com/koic)
 
 ## Logo
 
 RuboCop's logo was created by [Dimiter Petrov](https://www.chadomoto.com/). You can find the logo in various
-formats [here](https://github.com/bbatsov/rubocop/tree/master/logo).
+formats [here](https://github.com/rubocop-hq/rubocop/tree/master/logo).
 
 The logo is licensed under a
 [Creative Commons Attribution-NonCommercial 4.0 International License](http://creativecommons.org/licenses/by-nc/4.0/deed.en_GB).
 
 ## Contributors
 
-Here's a [list](https://github.com/bbatsov/rubocop/graphs/contributors) of
+Here's a [list](https://github.com/rubocop-hq/rubocop/graphs/contributors) of
 all the people who have contributed to the development of RuboCop.
 
 I'm extremely grateful to each and every one of them!

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/config/default.yml

@@ -130,7 +130,7 @@ AllCops:
   # followed by the Gemfile.lock or gems.locked file. (Although the Ruby version
   # is specified in the Gemfile or gems.rb file, RuboCop reads the final value
   # from the lock file.) If the Ruby version is still unresolved, RuboCop will
-  # use the oldest officially supported Ruby version (currently Ruby 2.1).
+  # use the oldest officially supported Ruby version (currently Ruby 2.2).
   TargetRubyVersion: ~
   # What version of Rails is the inspected code using?  If a value is specified
   # for TargetRailsVersion then it is used.  Acceptable values are specificed
@@ -739,6 +739,13 @@ Naming/HeredocDelimiterCase:
     - lowercase
     - uppercase
 
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: disallowed
+  SupportedStylesForLeadingUnderscores:
+    - disallowed
+    - required
+    - optional
+
 Naming/MethodName:
   EnforcedStyle: snake_case
   SupportedStyles:
@@ -1132,6 +1139,12 @@ Style/InverseMethods:
     :select: :reject
     :select!: :reject!
 
+Style/IpAddresses:
+  # Allow strings to be whitelisted
+  Whitelist:
+    - "::"
+    # :: is a valid IPv6 address, but could potentially be legitimately in code
+
 Style/Lambda:
   EnforcedStyle: line_count_dependent
   SupportedStyles:
@@ -1539,7 +1552,10 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   CountComments: false  # count full line comments?
   Max: 25
-  ExcludedMethods: []
+  ExcludedMethods:
+    # By default, exclude the `#refine` method, as it tends to have larger
+    # associated blocks.
+    - refine
 
 Metrics/BlockNesting:
   CountBlocks: false

data/config/disabled.yml

@@ -82,6 +82,10 @@ Style/InlineComment:
   Description: 'Avoid trailing inline comments.'
   Enabled: false
 
+Style/IpAddresses:
+  Description: "Don't include literal IP addresses in code."
+  Enabled: false
+
 Style/MethodCallWithArgsParentheses:
   Description: 'Use parentheses for method calls with arguments.'
   StyleGuide: '#method-invocation-parens'

data/lib/rubocop.rb

@@ -441,6 +441,7 @@ require_relative 'rubocop/cop/style/implicit_runtime_error'
 require_relative 'rubocop/cop/style/infinite_loop'
 require_relative 'rubocop/cop/style/inverse_methods'
 require_relative 'rubocop/cop/style/inline_comment'
+require_relative 'rubocop/cop/style/ip_addresses'
 require_relative 'rubocop/cop/style/lambda'
 require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'

data/lib/rubocop/ast/node.rb

@@ -379,6 +379,11 @@ module RuboCop
         {equals_asgn? shorthand_asgn? asgn_method_call?}
       PATTERN
 
+      # Some cops treat the shovel operator as a kind of assignment.
+      def_node_matcher :assignment_or_similar?, <<-PATTERN
+        {assignment? (send _recv :<< ...)}
+      PATTERN
+
       def literal?
         LITERALS.include?(type)
       end

data/lib/rubocop/ast/node/str_node.rb

@@ -6,6 +6,8 @@ module RuboCop
     # in place of a plain node when the builder constructs the AST, making
     # its methods available to all `str` nodes within RuboCop.
     class StrNode < Node
+      include BasicLiteralNode
+
       def heredoc?
         loc.is_a?(Parser::Source::Map::Heredoc)
       end

data/lib/rubocop/cli.rb

@@ -39,7 +39,7 @@ module RuboCop
       act_on_options
       apply_default_formatter
       execute_runners(paths)
-    rescue RuboCop::ConfigNotFoundError => e
+    rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
       warn e.message
       STATUS_ERROR
     rescue RuboCop::Error => e
@@ -47,9 +47,6 @@ module RuboCop
       STATUS_ERROR
     rescue Finished
       STATUS_SUCCESS
-    rescue IncorrectCopNameError => e
-      warn e.message
-      STATUS_ERROR
     rescue OptionParser::InvalidOption => e
       warn e.message
       warn 'For usage information, use --help'
@@ -128,9 +125,9 @@ module RuboCop
     def validate_options_vs_config
       if @options[:parallel] &&
          !@config_store.for(Dir.pwd).for_all_cops['UseCache']
-        raise ArgumentError, '-P/--parallel uses caching to speed up ' \
-                             'execution, so combining with AllCops: ' \
-                             'UseCache: false is not allowed.'
+        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
+                                   'execution, so combining with AllCops: ' \
+                                   'UseCache: false is not allowed.'
       end
     end
 

data/lib/rubocop/config.rb

@@ -16,10 +16,10 @@ module RuboCop
 
     COMMON_PARAMS = %w[Exclude Include Severity
                        AutoCorrect StyleGuide Details].freeze
-    # 2.1 is the oldest officially supported Ruby version.
-    DEFAULT_RUBY_VERSION = 2.1
-    KNOWN_RUBIES = [2.1, 2.2, 2.3, 2.4, 2.5].freeze
-    OBSOLETE_RUBIES = { 1.9 => '0.50', 2.0 => '0.50' }.freeze
+    # 2.2 is the oldest officially supported Ruby version.
+    DEFAULT_RUBY_VERSION = 2.2
+    KNOWN_RUBIES = [2.2, 2.3, 2.4, 2.5].freeze
+    OBSOLETE_RUBIES = { 1.9 => '0.50', 2.0 => '0.50', 2.1 => '0.58' }.freeze
     RUBY_VERSION_FILENAME = '.ruby-version'.freeze
     DEFAULT_RAILS_VERSION = 5.0
     OBSOLETE_COPS = {

data/lib/rubocop/config_loader.rb

@@ -176,15 +176,11 @@ module RuboCop
       end
 
       def yaml_safe_load(yaml_code, filename)
-        if YAML.respond_to?(:safe_load) # Ruby 2.1+
-          if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
-            SafeYAML.load(yaml_code, filename,
-                          whitelisted_tags: %w[!ruby/regexp])
-          else
-            YAML.safe_load(yaml_code, [Regexp, Symbol], [], false, filename)
-          end
+        if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
+          SafeYAML.load(yaml_code, filename,
+                        whitelisted_tags: %w[!ruby/regexp])
         else
-          YAML.load(yaml_code, filename) # rubocop:disable Security/YAMLLoad
+          YAML.safe_load(yaml_code, [Regexp, Symbol], [], false, filename)
         end
       end
     end

data/lib/rubocop/cop/corrector.rb

@@ -32,6 +32,8 @@ module RuboCop
       #   corrector = Corrector.new(source_buffer, corrections)
       def initialize(source_buffer, corrections = [])
         @source_buffer = source_buffer
+        raise 'source_buffer should be a Parser::Source::Buffer' unless \
+          source_buffer.is_a? Parser::Source::Buffer
         @corrections = corrections
         @source_rewriter = Parser::Source::TreeRewriter.new(
           source_buffer,
@@ -72,6 +74,7 @@ module RuboCop
       #
       # @param [Parser::Source::Range] range
       def remove(range)
+        validate_range range
         @source_rewriter.remove(range)
       end
 
@@ -80,6 +83,7 @@ module RuboCop
       # @param [Parser::Source::Range] range
       # @param [String] content
       def insert_before(range, content)
+        validate_range range
         # TODO: Fix Cops using bad ranges instead
         if range.end_pos > @source_buffer.source.size
           range = range.with(end_pos: @source_buffer.source.size)
@@ -93,6 +97,7 @@ module RuboCop
       # @param [Parser::Source::Range] range
       # @param [String] content
       def insert_after(range, content)
+        validate_range range
         @source_rewriter.insert_after(range, content)
       end
 
@@ -101,6 +106,7 @@ module RuboCop
       # @param [Parser::Source::Range] range
       # @param [String] content
       def replace(range, content)
+        validate_range range
         @source_rewriter.replace(range, content)
       end
 
@@ -109,6 +115,7 @@ module RuboCop
       # @param [Parser::Source::Range] range
       # @param [Integer] size
       def remove_preceding(range, size)
+        validate_range range
         to_remove = Parser::Source::Range.new(range.source_buffer,
                                               range.begin_pos - size,
                                               range.begin_pos)
@@ -122,6 +129,7 @@ module RuboCop
       # @param [Parser::Source::Range] range
       # @param [Integer] size
       def remove_leading(range, size)
+        validate_range range
         to_remove = Parser::Source::Range.new(range.source_buffer,
                                               range.begin_pos,
                                               range.begin_pos + size)
@@ -135,11 +143,28 @@ module RuboCop
       # @param [Parser::Source::Range] range
       # @param [Integer] size
       def remove_trailing(range, size)
+        validate_range range
         to_remove = Parser::Source::Range.new(range.source_buffer,
                                               range.end_pos - size,
                                               range.end_pos)
         @source_rewriter.remove(to_remove)
       end
+
+      private
+
+      # :nodoc:
+      def validate_range(range)
+        return if range.source_buffer == @source_buffer
+        unless range.source_buffer.is_a?(Parser::Source::Buffer)
+          # actually this should be enforced by parser gem
+          raise 'Corrector expected range source buffer to be a '\
+                "Parser::Source::Buffer, but got #{range.source_buffer.class}"
+        end
+        raise "Correction target buffer #{range.source_buffer.object_id} "\
+              "name:#{range.source_buffer.name.inspect}"\
+              " is not current #{@source_buffer.object_id} "\
+              "name:#{@source_buffer.name.inspect} under investigation"
+      end
     end
   end
 end

data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb

@@ -55,13 +55,9 @@ module RuboCop
                   'beginning of method definition.'.freeze
 
         def on_heredoc(node)
-          return if heredoc_type(node) == SIMPLE_HEREDOC
-
-          if empty_heredoc?(node) ||
-             contents_indentation(node) >= closing_indentation(node)
-            return if opening_indentation(node) == closing_indentation(node)
-            return if argument_indentation_correct?(node)
-          end
+          return if heredoc_type(node) == SIMPLE_HEREDOC ||
+                    opening_indentation(node) == closing_indentation(node) ||
+                    argument_indentation_correct?(node)
 
           add_offense(node, location: :heredoc_end)
         end

data/lib/rubocop/cop/layout/end_alignment.rb

@@ -162,7 +162,7 @@ module RuboCop
         def alignment_node_for_variable_style(node)
           return node.parent if node.case_type? && node.argument?
 
-          assignment = node.ancestors.find(&:assignment?)
+          assignment = node.ancestors.find(&:assignment_or_similar?)
           if assignment && !line_break_before_keyword?(assignment.source_range,
                                                        node)
             assignment

data/lib/rubocop/cop/layout/indentation_width.rb

@@ -103,7 +103,11 @@ module RuboCop
 
           def_end_config = config.for_cop('Layout/DefEndAlignment')
           style = def_end_config['EnforcedStyleAlignWith'] || 'start_of_line'
-          base = style == 'def' ? node.first_argument : node
+          base = if style == 'def'
+                   node.first_argument
+                 else
+                   leftmost_modifier_of(node) || node
+                 end
 
           check_indentation(base.source_range, body)
           ignore_node(node.first_argument)
@@ -319,6 +323,10 @@ module RuboCop
         def configured_indentation_width
           cop_config['Width']
         end
+
+        def leftmost_modifier_of(node)
+          node.each_ancestor(:send).to_a.last
+        end
       end
     end
   end

data/lib/rubocop/cop/layout/leading_blank_lines.rb

@@ -39,7 +39,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          range = Parser::Source::Range.new(processed_source.raw_source,
+          range = Parser::Source::Range.new(processed_source.buffer,
                                             0,
                                             node.begin_pos)
 

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

@@ -53,7 +53,7 @@ module RuboCop
         ALTERNATIVE_PROTECTED = '`protected` inside a `class << self` ' \
                                 'block'.freeze
 
-        def_node_matcher :private_class_method, <<-PATTERN
+        def_node_search :private_class_methods, <<-PATTERN
           (send nil? :private_class_method $...)
         PATTERN
 
@@ -67,25 +67,26 @@ module RuboCop
 
         private
 
-        def clear
-          @useless = {}
-          @last_access_modifier = nil
-        end
-
         def check_node(node)
           return unless node && node.begin_type?
 
-          clear
-          check_scope(node)
+          ignored_methods = private_class_method_names(node)
 
-          @useless.each do |_name, (defs_node, visibility, modifier)|
+          ineffective_modifier(node, ignored_methods) do |defs_node, modifier|
             add_offense(defs_node,
                         location: :keyword,
-                        message: format_message(visibility, modifier))
+                        message: format_message(modifier))
           end
         end
 
-        def format_message(visibility, modifier)
+        def private_class_method_names(node)
+          private_class_methods(node).to_a.flatten
+                                     .select(&:basic_literal?)
+                                     .map(&:value)
+        end
+
+        def format_message(modifier)
+          visibility = modifier.method_name
           alternative = if visibility == :private
                           ALTERNATIVE_PRIVATE
                         else
@@ -96,52 +97,28 @@ module RuboCop
                       alternative: alternative)
         end
 
-        def check_scope(node, cur_vis = :public)
-          node.each_child_node.reduce(cur_vis) do |visibility, child|
-            check_child_scope(child, visibility)
-          end
-        end
-
-        def check_child_scope(node, cur_vis)
-          case node.type
-          when :send
-            cur_vis = check_send(node, cur_vis)
-          when :defs
-            check_defs(node, cur_vis)
-          when :kwbegin
-            check_scope(node, cur_vis)
+        def ineffective_modifier(node, ignored_methods, modifier = nil, &block)
+          node.each_child_node do |child|
+            case child.type
+            when :send
+              modifier = child if access_modifier?(child)
+            when :defs
+              next if correct_visibility?(child, modifier, ignored_methods)
+              yield child, modifier
+            when :kwbegin
+              ineffective_modifier(child, ignored_methods, modifier, &block)
+            end
           end
-
-          cur_vis
         end
 
-        def check_send(node, cur_vis)
-          if node.bare_access_modifier? && !node.method?(:module_function)
-            @last_access_modifier = node
-            return node.method_name
-          elsif (methods = private_class_method(node))
-            # don't warn about defs nodes which are followed by a call to
-            # `private_class_method :name`
-            # obviously the programmer knows what they are doing
-            revert_method_uselessness(methods)
-          end
-
-          cur_vis
+        def access_modifier?(node)
+          node.bare_access_modifier? && !node.method?(:module_function)
         end
 
-        def check_defs(node, cur_vis)
-          mark_method_as_useless(node, cur_vis) if cur_vis != :public
-        end
+        def correct_visibility?(node, modifier, ignored_methods)
+          return true if modifier.nil? || modifier.method_name == :public
 
-        def mark_method_as_useless(node, cur_vis)
-          @useless[node.method_name] = [node, cur_vis, @last_access_modifier]
-        end
-
-        def revert_method_uselessness(methods)
-          methods.each do |sym|
-            next unless sym.sym_type?
-            @useless.delete(sym.value)
-          end
+          ignored_methods.include?(node.method_name)
         end
       end
     end