rubocop 0.38.0 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c755e82e5751b549039b4eb7556f74a512045e00
-  data.tar.gz: 0c943dff109818624263c8d44e8d533208f066e0
+  metadata.gz: dfcbbab3c5c192b9ec4f2af0d65ef6af2218196a
+  data.tar.gz: 13951f737deacbbca91730cafca92ed861e5b4b9
 SHA512:
-  metadata.gz: 64399fb16df2d1275a11f442b7904d6c036918509eccaffc2be52feea9ed1509d7f5d83c4f9b0eba7542c6d41c60d55c0a5d6ccf7a4c035569b510fcfc014345
-  data.tar.gz: d87cb665637072f82c9b95800d784e0457c817d7da5a4c95ac55675b1ac71447bd54074fc4018488b949d1e10394379961485583c0314d5385d6d57f6b40ae86
+  metadata.gz: 938228431a9934dc8916618e35256c75bf5a95ad3387933019599ecc242a3281ce2a234f3a174793634b44bcf5043b924ee18f1949f3abfd97e67c8db1aea088
+  data.tar.gz: 20459e73a5a9fbe29eeac14413a6f2e54253692d474e01cde4ec1155dfff8010a1202297b1d35a4d422cddc27d7d15a2f633725d1ebe6e63ffff41bf672f8114

data/README.md

@@ -115,7 +115,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.38.0', require: false
+gem 'rubocop', '~> 0.39.0', require: false
 ```
 
 ## Basic Usage
@@ -289,7 +289,14 @@ Metrics/LineLength:
 ### Inheritance
 
 RuboCop supports inheriting configuration from one or more supplemental
-configuration files at runtime.
+configuration files at runtime. Settings in the file that inherits
+override settings in the file that's inherited from. Configuration
+parameter that are hashes, for example `PreferredMethods` in
+`Style/CollectionMethods` are merged with the same parameter in the base
+configuration, while other parameter, such as `AllCops` / `Include`, are
+simply replaced by the local setting. If arrays were merged, there would
+be no way to remove elements through overriding them in local
+configuration.
 
 #### Inheriting from another configuration file in the project
 
@@ -1017,7 +1024,8 @@ require:
 
 Note: The paths are directly passed to `Kernel.require`.  If your
 extension file is not in `$LOAD_PATH`, you need to specify the path as
-relative path prefixed with `./` explicitly, or absolute path.
+relative path prefixed with `./` explicitly, or absolute path. Paths
+starting with a `.` are resolved relative to `.rubocop.yml`.
 
 ### Custom Cops
 

data/config/default.yml

@@ -344,6 +344,19 @@ Style/CommentAnnotation:
     - HACK
     - REVIEW
 
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_to_condition
+  SupportedStyles:
+    - assign_to_condition
+    - assign_inside_condition
+  # When configured to `assign_to_condition`, `SingleLineConditionsOnly`
+  # will only register an offense when all branches of a condition are
+  # a single line.
+  # When configured to `assign_inside_condition`, `SingleLineConditionsOnly`
+  # will only register an offense for assignment to a condition that has
+  # at least one multiline branch.
+  SingleLineConditionsOnly: true
+
 # Checks that you have put a copyright in a comment before any code.
 #
 # You can override the default Notice in your .rubocop.yml file.

data/config/enabled.yml

@@ -159,9 +159,6 @@ Style/ConditionalAssignment:
                  assignment to a variable and variable comparison instead
                  of assigning that variable inside of each branch.
   Enabled: true
-  SingleLineConditionsOnly: true
-  # Whether the cop should register offenses for conditionals whose branches
-  # contain more than one statement a piece
 
 Style/ConstantName:
   Description: 'Constants should use SCREAMING_SNAKE_CASE.'
@@ -324,6 +321,11 @@ Style/IfUnlessModifier:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
   Enabled: true
 
+Style/IfUnlessModifierOfIfUnless:
+  Description: >-
+                 Avoid modifier if/unless usage on conditionals.
+  Enabled: true
+
 Style/IfWithSemicolon:
   Description: 'Do not use if x; .... Use the ternary operator instead.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs'
@@ -1173,6 +1175,11 @@ Performance/Count:
                   Use `count` instead of `select...size`, `reject...size`,
                   `select...count`, `reject...count`, `select...length`,
                   and `reject...length`.
+  # This cop has known compatibility issues with `ActiveRecord` and other
+  # frameworks. ActiveRecord's `count` ignores the block that is passed to it.
+  # For more information, see the documentation in the cop itself.
+  # If you understand the known risk, you can disable `SafeMode`.
+  SafeMode: true
   Enabled: true
 
 Performance/Detect:
@@ -1180,6 +1187,11 @@ Performance/Detect:
                   Use `detect` instead of `select.first`, `find_all.first`,
                   `select.last`, and `find_all.last`.
   Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code'
+  # This cop has known compatibility issues with `ActiveRecord` and other
+  # frameworks. `ActiveRecord` does not implement a `detect` method and `find`
+  # has its own meaning. Correcting `ActiveRecord` methods with this cop
+  # should be considered unsafe.
+  SafeMode: true
   Enabled: true
 
 Performance/DoubleStartEndWith:

data/lib/rubocop.rb

@@ -238,6 +238,7 @@ require 'rubocop/cop/style/hash_syntax'
 require 'rubocop/cop/style/identical_conditional_branches'
 require 'rubocop/cop/style/if_inside_else'
 require 'rubocop/cop/style/if_unless_modifier'
+require 'rubocop/cop/style/if_unless_modifier_of_if_unless'
 require 'rubocop/cop/style/if_with_semicolon'
 require 'rubocop/cop/style/indent_array'
 require 'rubocop/cop/style/indent_assignment'
@@ -387,6 +388,7 @@ require 'rubocop/formatter/formatter_set'
 
 require 'rubocop/cached_data'
 require 'rubocop/config'
+require 'rubocop/config_loader_resolver'
 require 'rubocop/config_loader'
 require 'rubocop/config_store'
 require 'rubocop/target_finder'

data/lib/rubocop/ast_node/builder.rb

@@ -20,6 +20,12 @@ module RuboCop
       def n(type, children, source_map)
         Node.new(type, children, location: source_map)
       end
+
+      # TODO: Figure out what to do about literal encoding handling...
+      # More details here https://github.com/whitequark/parser/issues/283
+      def string_value(token)
+        value(token)
+      end
     end
   end
 end

data/lib/rubocop/cli.rb

@@ -85,8 +85,8 @@ module RuboCop
       # This must be done after the options have already been processed,
       # because they can affect how ConfigStore behaves
       @options[:formatters] ||= begin
-        cfg = @config_store.for(Dir.pwd)['AllCops']
-        formatter = (cfg && cfg['DefaultFormatter']) || 'progress'
+        cfg = @config_store.for(Dir.pwd).for_all_cops
+        formatter = cfg['DefaultFormatter'] || 'progress'
         [[formatter, @options[:output_path]]]
       end
 

data/lib/rubocop/config.rb

@@ -66,12 +66,10 @@ module RuboCop
     end
 
     def add_excludes_from_higher_level(highest_config)
-      return unless highest_config['AllCops'] &&
-                    highest_config['AllCops']['Exclude']
+      return unless highest_config.for_all_cops['Exclude']
 
-      self['AllCops'] ||= {}
-      excludes = self['AllCops']['Exclude'] ||= []
-      highest_config['AllCops']['Exclude'].each do |path|
+      excludes = for_all_cops['Exclude'] ||= []
+      highest_config.for_all_cops['Exclude'].each do |path|
         unless path.is_a?(Regexp) || absolute?(path)
           path = File.join(File.dirname(highest_config.loaded_path), path)
         end
@@ -80,14 +78,12 @@ module RuboCop
     end
 
     def deprecation_check
-      return unless (all_cops = self['AllCops'])
-
       %w(Exclude Include).each do |key|
         plural = "#{key}s"
-        next unless all_cops[plural]
+        next unless for_all_cops[plural]
 
-        all_cops[key] = all_cops[plural] # Stay backwards compatible.
-        all_cops.delete(plural)
+        for_all_cops[key] = for_all_cops[plural] # Stay backwards compatible.
+        for_all_cops.delete(plural)
         yield "AllCops/#{plural} was renamed to AllCops/#{key}"
       end
     end
@@ -96,6 +92,10 @@ module RuboCop
       @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop]
     end
 
+    def for_all_cops
+      @for_all_cops ||= self['AllCops'] || {}
+    end
+
     def cop_enabled?(cop)
       department = cop.cop_type.to_s.capitalize!
 
@@ -167,11 +167,11 @@ module RuboCop
     end
 
     def patterns_to_include
-      @patterns_to_include ||= self['AllCops']['Include']
+      @patterns_to_include ||= for_all_cops['Include']
     end
 
     def patterns_to_exclude
-      @patterns_to_exclude ||= self['AllCops']['Exclude']
+      @patterns_to_exclude ||= for_all_cops['Exclude']
     end
 
     def path_relative_to_config(path)
@@ -272,7 +272,7 @@ module RuboCop
     end
 
     def check_target_ruby
-      target = self['AllCops'] && self['AllCops']['TargetRubyVersion']
+      target = for_all_cops['TargetRubyVersion']
       return unless target
 
       unless KNOWN_RUBIES.include?(target)

data/lib/rubocop/config_loader.rb

@@ -17,6 +17,8 @@ module RuboCop
     AUTO_GENERATED_FILE = '.rubocop_todo.yml'.freeze
 
     class << self
+      include ConfigLoaderResolver
+
       attr_accessor :debug, :auto_gen_config
       attr_writer :root_level # The upwards search is stopped at this level.
       attr_writer :default_configuration
@@ -34,11 +36,7 @@ module RuboCop
 
         resolve_inheritance_from_gems(hash, hash.delete('inherit_gem'))
         resolve_inheritance(path, hash)
-
-        config_dir = File.dirname(path)
-        Array(hash.delete('require')).each do |r|
-          require(File.join(config_dir, r))
-        end
+        resolve_requires(path, hash)
 
         hash.delete('inherit_from')
         config = Config.new(hash, path)
@@ -119,7 +117,7 @@ module RuboCop
       # that only cops from user configuration are enabled.
       def merge_with_default(config, config_file)
         configs =
-          if config.key?('AllCops') && config['AllCops']['DisabledByDefault']
+          if config.for_all_cops['DisabledByDefault']
             disabled_default = transform(default_configuration) do |params|
               params.merge('Enabled' => false) # Overwrite with false.
             end
@@ -161,7 +159,7 @@ module RuboCop
 
       def yaml_safe_load(yaml_code)
         if YAML.respond_to?(:safe_load) # Ruby 2.1+
-          if defined?(SafeYAML)
+          if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
             SafeYAML.load(yaml_code, nil, whitelisted_tags: %w(!ruby/regexp))
           else
             YAML.safe_load(yaml_code, [Regexp])
@@ -171,27 +169,6 @@ module RuboCop
         end
       end
 
-      def resolve_inheritance(path, hash)
-        base_configs(path, hash['inherit_from']).reverse_each do |base_config|
-          base_config.each do |k, v|
-            hash[k] = hash.key?(k) ? merge(v, hash[k]) : v if v.is_a?(Hash)
-          end
-        end
-      end
-
-      def resolve_inheritance_from_gems(hash, gems)
-        (gems || {}).each_pair do |gem_name, config_path|
-          if gem_name == 'rubocop'
-            raise ArgumentError,
-                  "can't inherit configuration from the rubocop gem"
-          end
-
-          hash['inherit_from'] = Array(hash['inherit_from'])
-          # Put gem configuration first so local configuration overrides it.
-          hash['inherit_from'].unshift gem_config_path(gem_name, config_path)
-        end
-      end
-
       def gem_config_path(gem_name, relative_config_path)
         spec = Gem::Specification.find_by_name(gem_name)
         return File.join(spec.gem_dir, relative_config_path)

data/lib/rubocop/config_loader_resolver.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'yaml'
+require 'pathname'
+
+module RuboCop
+  # A mixin to break up ConfigLoader
+  module ConfigLoaderResolver
+    def resolve_requires(path, hash)
+      config_dir = File.dirname(path)
+      Array(hash.delete('require')).each do |r|
+        if r.start_with?('.')
+          require(File.join(config_dir, r))
+        else
+          require(r)
+        end
+      end
+    end
+
+    def resolve_inheritance(path, hash)
+      base_configs(path, hash['inherit_from']).reverse_each do |base_config|
+        base_config.each do |k, v|
+          hash[k] = hash.key?(k) ? merge(v, hash[k]) : v if v.is_a?(Hash)
+        end
+      end
+    end
+
+    def resolve_inheritance_from_gems(hash, gems)
+      (gems || {}).each_pair do |gem_name, config_path|
+        if gem_name == 'rubocop'
+          raise ArgumentError,
+                "can't inherit configuration from the rubocop gem"
+        end
+
+        hash['inherit_from'] = Array(hash['inherit_from'])
+        # Put gem configuration first so local configuration overrides it.
+        hash['inherit_from'].unshift gem_config_path(gem_name, config_path)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cop.rb

@@ -138,18 +138,17 @@ module RuboCop
 
       def display_cop_names?
         debug? || @options[:display_cop_names] ||
-          config['AllCops'] && config['AllCops']['DisplayCopNames']
+          @config.for_all_cops['DisplayCopNames']
       end
 
       def display_style_guide?
         (style_guide_url || reference_url) &&
           (@options[:display_style_guide] ||
-            config['AllCops'] && config['AllCops']['DisplayStyleGuide'])
+            config.for_all_cops['DisplayStyleGuide'])
       end
 
       def extra_details?
-        @options[:extra_details] ||
-          config['AllCops'] && config['AllCops']['ExtraDetails']
+        @options[:extra_details] || config.for_all_cops['ExtraDetails']
       end
 
       def message(_node = nil)
@@ -194,7 +193,7 @@ module RuboCop
       end
 
       def target_ruby_version
-        @config['AllCops'] && @config['AllCops']['TargetRubyVersion']
+        @config.for_all_cops['TargetRubyVersion']
       end
 
       def parse(source, path = nil)

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

@@ -34,7 +34,7 @@ module RuboCop
           traverse_node(condition, ASGN_TYPES) do |asgn_node|
             if asgn_node.type == :send
               _receiver, method_name, *_args = *asgn_node
-              next :skip_children if method_name != :[]=
+              next :skip_children if method_name !~ /=\z/
             end
 
             # skip safe assignment nodes if safe assignment is allowed

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

@@ -11,14 +11,14 @@ module RuboCop
       #   "result is #{10}"
       class LiteralInInterpolation < Cop
         MSG = 'Literal interpolation detected.'.freeze
+        COMPOSITE = [:array, :hash, :pair, :irange, :erange].freeze
 
         def on_dstr(node)
           node.children.select { |n| n.type == :begin }.each do |begin_node|
             final_node = begin_node.children.last
             next unless final_node
             next if special_keyword?(final_node)
-            next if final_node.xstr_type?
-            next unless final_node.literal?
+            next unless prints_as_self?(final_node)
 
             add_offense(final_node, :expression)
           end
@@ -58,6 +58,13 @@ module RuboCop
                                     node.loc.begin.end_pos,
                                     end_pos).source
         end
+
+        # Does node print its own source when converted to a string?
+        def prints_as_self?(node)
+          node.basic_literal? ||
+            (COMPOSITE.include?(node.type) &&
+              node.children.all? { |child| prints_as_self?(child) })
+        end
       end
     end
   end

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

@@ -20,14 +20,15 @@ module RuboCop
         return false if body_has_comment?(body)
         return false if end_keyword_has_comment?(node)
 
+        length_in_modifier_form(node, cond, body_length) <= max_line_length
+      end
+
+      def length_in_modifier_form(node, cond, body_length)
         indentation = node.loc.keyword.column
         kw_length = node.loc.keyword.size
         cond_length = cond.source_range.size
         space = 1
-        total = indentation + body_length + space + kw_length + space +
-                cond_length
-
-        total <= max_line_length
+        indentation + body_length + space + kw_length + space + cond_length
       end
 
       def max_line_length

data/lib/rubocop/cop/performance/case_when_splat.rb

@@ -101,7 +101,7 @@ module RuboCop
         def splat_offenses(when_conditions)
           found_non_splat = false
           when_conditions.reverse.each_with_object([]) do |condition, result|
-            found_non_splat ||= true if error_condition?(condition)
+            found_non_splat ||= error_condition?(condition)
 
             next unless condition.splat_type?
             result << condition if found_non_splat

data/lib/rubocop/cop/performance/count.rb

@@ -25,6 +25,19 @@ module RuboCop
       #   [1, 2, 3].count { |e| e < 2 && e.even? }
       #   Model.select('field AS field_one').count
       #   Model.select(:value).count
+      #
+      # `ActiveRecord` compatibility:
+      # `ActiveRecord` will ignore the block that is passed to `count`.
+      # Other methods, such as `select`, will convert the association to an
+      # array and then run the block on the array. A simple work around to
+      # make `count` work with a block is to call `to_a.count {...}`.
+      #
+      # Example:
+      #   Model.where(id: [1, 2, 3].select { |m| m.method == true }.size
+      #
+      #   becomes:
+      #
+      #   Model.where(id: [1, 2, 3]).to_a.count { |m| m.method == true }
       class Count < Cop
         MSG = 'Use `count` instead of `%s...%s`.'.freeze
 
@@ -32,6 +45,7 @@ module RuboCop
         COUNTERS = [:count, :length, :size].freeze
 
         def on_send(node)
+          return unless should_run?
           selector, selector_loc, params, counter = parse(node)
           return unless COUNTERS.include?(counter)
           return unless SELECTORS.include?(selector)
@@ -62,6 +76,12 @@ module RuboCop
 
         private
 
+        def should_run?
+          !(cop_config['SafeMode'.freeze] ||
+            config['Rails'.freeze] &&
+            config['Rails'.freeze]['Enabled'.freeze])
+        end
+
         def parse(node)
           left, counter = *node
           expression, selector, params = *left