rubocop 0.65.0 → 0.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed6850978760ea5017481293cb1b14ac57cf36f3cdbc2592c54bbe10fd9be632
-  data.tar.gz: 3389c4b2855e381dbfddbf1448e5b3216118d2c47fb6903ce91590ce00345b9b
+  metadata.gz: 7917fb6bc9ad3c4e8e80d2931b7c275f7485ece4bcd0d18be214949e2facb5c6
+  data.tar.gz: e243620f2c8903c4a71eb755397cb6f0b7094c47202df5bc6310f911ec161557
 SHA512:
-  metadata.gz: cde514edb63d0f5bf73c690ec7eeea0fa3af4240bcdde7e570582854fe09760fc81907ca42a92042502cc15cf40b3166591cf859ba29837283fc46854545f1d0
-  data.tar.gz: eceae6226ef3cae7ff49335ce9536138eaae8abb1151b505fb8b559c2c3fd82cbd271b0c5393236c4ed0cd5d37e19620b5404d0c85b39053d61f387dde00190a
+  metadata.gz: 398cf3d8e470cdece6665bd91f9960639acc9196989a80bf6189cea39bdc4f3345a3ff11c5073646d9d4c80369d5ae7e5cc132f01e7855940b546b62ea143352
+  data.tar.gz: bdc1aabc612fb36230023a06d8cb507a95539ecdc42386ac5f608aff02bb0d8a918f1b39412322905fab1bcb58f107296f4a84b2a34c80d64edf302ba8976d06

data/README.md

@@ -31,7 +31,7 @@ automatically fix some of the problems for you.
 
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bbatsov/rubocop?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-**Please consider [supporting financially its ongoing development](#funding).**
+**Please consider [financially supporting its ongoing development](#funding).**
 
 ## Installation
 
@@ -50,10 +50,10 @@ gem 'rubocop', require: false
 RuboCop's development is moving at a very rapid pace and there are
 often backward-incompatible changes between minor releases (since we
 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`:
+might want to use a conservative version lock in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.65.0', require: false
+gem 'rubocop', '~> 0.66.0', require: false
 ```
 
 ## Quickstart

data/config/default.yml

@@ -581,6 +581,10 @@ Layout/ExtraSpacing:
   # things with the previous or next line, not counting empty lines or comment
   # lines.
   AllowForAlignment: true
+  # When true, allows things like 'obj.meth(arg)  # comment',
+  # rather than insisting on 'obj.meth(arg) # comment'.
+  # If done for alignment, either this OR AllowForAlignment will allow it.
+  AllowBeforeTrailingComments: false
   # When true, forces the alignment of `=` in assignments on consecutive lines.
   ForceEqualSignAlignment: false
 
@@ -1479,6 +1483,11 @@ Lint/SafeNavigationConsistency:
     - try!
 
 
+Lint/SafeNavigationWithEmpty:
+  Description: 'Avoid `foo&.empty?` in conditionals.'
+  Enabled: true
+  VersionAdded: '0.62'
+
 Lint/ScriptPermission:
   Description: 'Grant script file execute permission.'
   Enabled: true
@@ -1519,6 +1528,10 @@ Lint/Syntax:
   VersionAdded: '0.9'
 
 
+Lint/ToJSON:
+  Description: 'Ensure #to_json includes an optional argument.'
+  Enabled: true
+
 Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: true
@@ -1632,9 +1645,12 @@ Metrics/AbcSize:
   Description: >-
                  A calculated magnitude based on number of assignments,
                  branches, and conditions.
-  Reference: 'http://c2.com/cgi/wiki?AbcMetric'
+  Reference:
+    - http://c2.com/cgi/wiki?AbcMetric
+    - https://en.wikipedia.org/wiki/ABC_Software_Metric'
   Enabled: true
   VersionAdded: '0.27'
+  VersionChanged: '0.66'
   # The ABC size is a calculated magnitude, so this number can be an Integer or
   # a Float.
   Max: 15
@@ -1643,13 +1659,15 @@ Metrics/BlockLength:
   Description: 'Avoid long blocks with many lines.'
   Enabled: true
   VersionAdded: '0.44'
-  VersionChanged: '0.58'
+  VersionChanged: '0.66'
   CountComments: false  # count full line comments?
   Max: 25
   ExcludedMethods:
     # By default, exclude the `#refine` method, as it tends to have larger
     # associated blocks.
     - refine
+  Exclude:
+    - '**/*.gemspec'
 
 Metrics/BlockNesting:
   Description: 'Avoid excessive block nesting'
@@ -2764,8 +2782,9 @@ Style/BlockDelimiters:
     - line_count_based
     # The `semantic` style enforces braces around functional blocks, where the
     # primary purpose of the block is to return a value and do..end for
-    # procedural blocks, where the primary purpose of the block is its
-    # side-effects.
+    # multi-line procedural blocks, where the primary purpose of the block is
+    # its side-effects. Single-line procedural blocks may only use do-end,
+    # unless AllowBracesOnProceduralOneLiners has a truthy value (see below).
     #
     # This looks at the usage of a block's method to determine its type (e.g. is
     # the result of a `map` assigned to a variable or passed to another
@@ -2826,6 +2845,28 @@ Style/BlockDelimiters:
     - lambda
     - proc
     - it
+  # The AllowBracesOnProceduralOneLiners option is ignored unless the
+  # EnforcedStyle is set to `semantic`. If so:
+  #
+  # If AllowBracesOnProceduralOneLiners is unspecified, or set to any
+  # falsey value, then semantic purity is maintained, so one-line
+  # procedural blocks must use do-end, not braces.
+  #
+  #   # bad
+  #   collection.each { |element| puts element }
+  #
+  #   # good
+  #   collection.each do |element| puts element end
+  #
+  # If AllowBracesOnProceduralOneLiners is set to any truthy value,
+  # then one-line procedural blocks may use either style.
+  #
+  #   # good
+  #   collection.each { |element| puts element }
+  #
+  #   # also good
+  #   collection.each do |element| puts element end
+  AllowBracesOnProceduralOneLiners: false
 
 Style/BracesAroundHashParameters:
   Description: 'Enforce braces style around hash parameters.'
@@ -3020,6 +3061,13 @@ Style/ConditionalAssignment:
 #   Notice: 'Copyright (\(c\) )?2015 Yahoo! Inc'
 #   AutocorrectNotice: '# Copyright (c) 2015 Yahoo! Inc.'
 #
+Style/ConstantVisibility:
+  Description: >-
+                 Check that class- and module constants have
+                 visibility declarations.
+  Enabled: false
+  VersionAdded: '0.66'
+
 Style/Copyright:
   Description: 'Include a copyright notice in each file before any code.'
   Enabled: false
@@ -3867,6 +3915,7 @@ Style/RedundantFreeze:
   Description: "Checks usages of Object#freeze on immutable objects."
   Enabled: true
   VersionAdded: '0.34'
+  VersionChanged: '0.66'
 
 Style/RedundantParentheses:
   Description: "Checks for parentheses that seem not to serve any purpose."

data/lib/rubocop.rb

@@ -6,15 +6,11 @@ require 'rainbow'
 require 'English'
 require 'set'
 require 'forwardable'
-require 'powerpack/array/butfirst'
-require 'powerpack/enumerable/drop_last'
-require 'powerpack/hash/symbolize_keys'
-require 'powerpack/string/blank'
-require 'powerpack/string/strip_indent'
 require 'unicode/display_width/no_string_ext'
 
 require_relative 'rubocop/version'
 
+require_relative 'rubocop/core_ext/string'
 require_relative 'rubocop/path_util'
 require_relative 'rubocop/file_finder'
 require_relative 'rubocop/platform'
@@ -313,12 +309,14 @@ require_relative 'rubocop/cop/lint/rescue_type'
 require_relative 'rubocop/cop/lint/return_in_void_context'
 require_relative 'rubocop/cop/lint/safe_navigation_consistency'
 require_relative 'rubocop/cop/lint/safe_navigation_chain'
+require_relative 'rubocop/cop/lint/safe_navigation_with_empty'
 require_relative 'rubocop/cop/lint/script_permission'
 require_relative 'rubocop/cop/lint/shadowed_argument'
 require_relative 'rubocop/cop/lint/shadowed_exception'
 require_relative 'rubocop/cop/lint/shadowing_outer_local_variable'
 require_relative 'rubocop/cop/lint/string_conversion_in_interpolation'
 require_relative 'rubocop/cop/lint/syntax'
+require_relative 'rubocop/cop/lint/to_json'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
 require_relative 'rubocop/cop/lint/unified_integer'
 require_relative 'rubocop/cop/lint/unneeded_cop_disable_directive'
@@ -421,6 +419,7 @@ require_relative 'rubocop/cop/style/command_literal'
 require_relative 'rubocop/cop/style/comment_annotation'
 require_relative 'rubocop/cop/style/commented_keyword'
 require_relative 'rubocop/cop/style/conditional_assignment'
+require_relative 'rubocop/cop/style/constant_visibility'
 require_relative 'rubocop/cop/style/copyright'
 require_relative 'rubocop/cop/style/date_time'
 require_relative 'rubocop/cop/style/def_with_parentheses'

data/lib/rubocop/cli.rb

@@ -263,7 +263,7 @@ module RuboCop
 
     def config_lines(cop)
       cnf = @config_store.for(Dir.pwd).for_cop(cop)
-      cnf.to_yaml.lines.to_a.butfirst.map { |line| '  ' + line }
+      cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
     end
 
     def display_warning_summary(warnings)

data/lib/rubocop/config.rb

@@ -297,7 +297,7 @@ module RuboCop
     end
 
     def signature
-      @signature ||= Digest::MD5.hexdigest(to_s)
+      @signature ||= Digest::SHA1.hexdigest(to_s)
     end
 
     def make_excludes_absolute

data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb

@@ -31,7 +31,7 @@ module RuboCop
       attr_reader :block_node, :method, :arguments
 
       def remove_unparenthesized_whitespace(corrector)
-        return unless !arguments.empty? && !arguments.parenthesized_call?
+        return if arguments.empty? || arguments.parenthesized_call?
 
         remove_leading_whitespace(corrector)
         remove_trailing_whitespace(corrector)
@@ -69,10 +69,8 @@ module RuboCop
       end
 
       def remove_trailing_whitespace(corrector)
-        corrector.remove_preceding(
-          block_begin,
-          block_begin.begin_pos - arguments.source_range.end_pos - 1
-        )
+        size = block_begin.begin_pos - arguments.source_range.end_pos - 1
+        corrector.remove_preceding(block_begin, size) if size > 0
       end
 
       def replace_delimiters(corrector)

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

@@ -8,35 +8,43 @@ module RuboCop
       # `Categories` allows us to map macro names into a category.
       #
       # Consider an example of code style that covers the following order:
+      # - Module inclusion (include, prepend, extend)
       # - Constants
       # - Associations (has_one, has_many)
-      # - Attributes (attr_accessor, attr_writer, attr_reader)
+      # - Public attribute macros (attr_accessor, attr_writer, attr_reader)
+      # - Other macros (validates, validate)
+      # - Public class methods
       # - Initializer
-      # - Instance methods
-      # - Protected methods
-      # - Private methods
+      # - Public instance methods
+      # - Protected attribute macros (attr_accessor, attr_writer, attr_reader)
+      # - Protected instance methods
+      # - Private attribute macros (attr_accessor, attr_writer, attr_reader)
+      # - Private instance methods
       #
       # You can configure the following order:
       #
       # ```yaml
       #  Layout/ClassStructure:
-      #    Categories:
-      #      module_inclusion:
-      #        - include
-      #        - prepend
-      #        - extend
       #    ExpectedOrder:
-      #        - module_inclusion
-      #        - constants
-      #        - public_class_methods
-      #        - initializer
-      #        - public_methods
-      #        - protected_methods
-      #        - private_methods
-      #
+      #      - module_inclusion
+      #      - constants
+      #      - association
+      #      - public_attribute_macros
+      #      - public_delegate
+      #      - macros
+      #      - public_class_methods
+      #      - initializer
+      #      - public_methods
+      #      - protected_attribute_macros
+      #      - protected_methods
+      #      - private_attribute_macros
+      #      - private_delegate
+      #      - private_methods
       # ```
+      #
       # Instead of putting all literals in the expected order, is also
-      # possible to group categories of macros.
+      # possible to group categories of macros. Visibility levels are handled
+      # automatically.
       #
       # ```yaml
       #  Layout/ClassStructure:
@@ -44,10 +52,17 @@ module RuboCop
       #      association:
       #        - has_many
       #        - has_one
-      #      attribute:
+      #      attribute_macros:
       #        - attr_accessor
       #        - attr_reader
       #        - attr_writer
+      #      macros:
+      #        - validates
+      #        - validate
+      #      module_inclusion:
+      #        - include
+      #        - prepend
+      #        - extend
       # ```
       #
       # @example
@@ -73,12 +88,15 @@ module RuboCop
       #     # constants are next
       #     SOME_CONSTANT = 20
       #
-      #     # afterwards we have attribute macros
+      #     # afterwards we have public attribute macros
       #     attr_reader :name
       #
       #     # followed by other macros (if any)
       #     validates :name
       #
+      #     # then we have public delegate macros
+      #     delegate :to_s, to: :name
+      #
       #     # public class methods are next in line
       #     def self.some_method
       #     end
@@ -91,14 +109,22 @@ module RuboCop
       #     def some_method
       #     end
       #
-      #     # protected and private methods are grouped near the end
+      #     # protected attribute macros and methods go next
       #     protected
       #
+      #     attr_reader :protected_name
+      #
       #     def some_protected_method
       #     end
       #
+      #     # private attribute macros, delegate macros and methods
+      #     # are grouped near the end
       #     private
       #
+      #     attr_reader :private_name
+      #
+      #     delegate :some_private_delegate, to: :name
+      #
       #     def some_private_method
       #     end
       #   end
@@ -108,7 +134,8 @@ module RuboCop
         HUMANIZED_NODE_TYPE = {
           casgn: :constants,
           defs: :class_methods,
-          def: :public_methods
+          def: :public_methods,
+          sclass: :class_singleton
         }.freeze
 
         VISIBILITY_SCOPES = %i[private protected public].freeze
@@ -167,19 +194,23 @@ module RuboCop
           when :block
             classify(node.send_node)
           when :send
-            find_category(node.method_name)
+            find_category(node)
           else
             humanize_node(node)
           end.to_s
         end
 
-        # Categorize a method_name according to the {expected_order}
-        # @param method_name try to match {categories} values
+        # Categorize a node according to the {expected_order}
+        # Try to match {categories} values against the node's method_name given
+        # also its visibility.
+        # @param node to be analysed.
         # @return [String] with the key category or the `method_name` as string
-        def find_category(method_name)
-          name = method_name.to_s
+        def find_category(node)
+          name = node.method_name.to_s
           category, = categories.find { |_, names| names.include?(name) }
-          category || name
+          key = category || name
+          visibility_key = "#{node_visibility(node)}_#{key}"
+          expected_order.include?(visibility_key) ? visibility_key : key
         end
 
         def walk_over_nested_class_definition(class_node)

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

@@ -19,6 +19,17 @@ module RuboCop
       #   # bad for any configuration
       #   set_app("RuboCop")
       #   website  = "https://github.com/rubocop-hq/rubocop"
+      #
+      #   # good only if AllowBeforeTrailingComments is true
+      #   object.method(arg)  # this is a comment
+      #
+      #   # good even if AllowBeforeTrailingComments is false or not set
+      #   object.method(arg) # this is a comment
+      #
+      #   # good with either AllowBeforeTrailingComments or AllowForAlignment
+      #   object.method(arg)         # this is a comment
+      #   another_object.method(arg) # this is another comment
+      #   some_object.method(arg)    # this is some comment
       class ExtraSpacing < Cop
         include PrecedingFollowingAlignment
         include RangeHelp
@@ -98,6 +109,9 @@ module RuboCop
         end
 
         def check_other(token1, token2, ast)
+          return false if allow_for_trailing_comments? &&
+                          token2.text.start_with?('#')
+
           extra_space_range(token1, token2) do |range|
             # Unary + doesn't appear as a token and needs special handling.
             next if ignored_range?(ast, range.begin_pos)
@@ -222,6 +236,10 @@ module RuboCop
           optarg_eql = optargs.map { |o| o.loc.operator.begin_pos }.to_set
           asgn_tokens.reject { |t| optarg_eql.include?(t.begin_pos) }
         end
+
+        def allow_for_trailing_comments?
+          cop_config['AllowBeforeTrailingComments']
+        end
       end
     end
   end

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

@@ -54,6 +54,10 @@ module RuboCop
 
         SPECIAL_MODIFIERS = %w[private protected].freeze
 
+        def_node_matcher :access_modifier?, <<-PATTERN
+          [(send ...) access_modifier?]
+        PATTERN
+
         def on_rescue(node)
           _begin_node, *_rescue_nodes, else_node = *node
           check_indentation(node.loc.else, else_node)
@@ -161,15 +165,12 @@ module RuboCop
         private
 
         def check_members(base, members)
-          check_indentation(base, members.first)
+          check_indentation(base, select_check_member(members.first))
 
           return unless members.any? && members.first.begin_type?
 
           if indentation_consistency_style == 'rails'
-            each_member(members) do |member, previous_modifier|
-              check_indentation(previous_modifier, member,
-                                indentation_consistency_style)
-            end
+            check_members_for_rails_style(members)
           else
             members.first.children.each do |member|
               next if member.send_type? && member.access_modifier?
@@ -179,6 +180,23 @@ module RuboCop
           end
         end
 
+        def select_check_member(member)
+          return unless member
+
+          if access_modifier?(member.children.first)
+            member.children.first
+          else
+            member
+          end
+        end
+
+        def check_members_for_rails_style(members)
+          each_member(members) do |member, previous_modifier|
+            check_indentation(previous_modifier, member,
+                              indentation_consistency_style)
+          end
+        end
+
         def each_member(members)
           previous_modifier = nil
           members.first.children.each do |member|
@@ -326,6 +344,8 @@ module RuboCop
           return unless body_node.begin_type?
 
           starting_node = body_node.children.first
+          return unless starting_node
+
           starting_node.send_type? && starting_node.bare_access_modifier?
         end