rubocop 0.34.2 → 0.35.0

data/config/disabled.yml

@@ -22,6 +22,30 @@ Style/InlineComment:
   Description: 'Avoid inline comments.'
   Enabled: false
 
+Style/FirstArrayElementLineBreak:
+  Description: >-
+                 Checks for a line break before the first element in a
+                 multi-line array.
+  Enabled: false
+
+Style/FirstHashElementLineBreak:
+  Description: >-
+                 Checks for a line break before the first element in a
+                 multi-line hash.
+  Enabled: false
+
+Style/FirstMethodArgumentLineBreak:
+  Description: >-
+                 Checks for a line break before the first argument in a
+                 multi-line method call.
+  Enabled: false
+
+Style/FirstMethodParameterLineBreak:
+  Description: >-
+                 Checks for a line break before the first parameter in a
+                 multi-line method parameter definition.
+  Enabled: false
+
 Style/MethodCalledOnDoEndBlock:
   Description: 'Avoid chaining a method call on a do...end block.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'

data/config/enabled.yml

@@ -415,6 +415,10 @@ Style/NegatedWhile:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#until-for-negatives'
   Enabled: true
 
+Style/NestedModifier:
+  Description: 'Avoid using nested modifiers.'
+  Enabled: true
+
 Style/NestedTernaryOperator:
   Description: 'Use one expression per branch in a ternary operator.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-ternary'
@@ -690,6 +694,11 @@ Style/SpecialGlobalVars:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms'
   Enabled: true
 
+Style/StabbyLambdaParentheses:
+  Description: 'Check for the usage of parentheses around stabby lambda arguments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#stabby-lambda-with-args'
+  Enabled: true
+
 Style/StringLiterals:
   Description: 'Checks if uses of quotes match the configured preference.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
@@ -759,6 +768,7 @@ Style/TrailingUnderscoreVariable:
   Description: >-
                  Checks for the usage of unneeded trailing underscores at the
                  end of parallel variable assignment.
+  AllowNamedUnderscoreVariables: true
   Enabled: true
 
 Style/VariableInterpolation:
@@ -857,7 +867,7 @@ Lint/AmbiguousOperator:
 Lint/AmbiguousRegexpLiteral:
   Description: >-
                  Checks for ambiguous regexp literals in the first argument of
-                 a method invocation without parenthesis.
+                 a method invocation without parentheses.
   Enabled: true
 
 Lint/AssignmentInCondition:
@@ -870,7 +880,7 @@ Lint/BlockAlignment:
   Enabled: true
 
 Lint/CircularArgumentReference:
-  Description: "Don't refer to the keyword argument in the default value."
+  Description: "Default values in optional keyword arguments and optional ordinal arguments should not refer back to the name of the argument."
   Enabled: true
 
 Lint/ConditionPosition:
@@ -1079,6 +1089,10 @@ Performance/Detect:
   Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code'
   Enabled: true
 
+Performance/FixedSize:
+  Description: 'Do not compute the size of statically sized objects except in constants'
+  Enabled: true
+
 Performance/FlatMap:
   Description: >-
                   Use `Enumerable#flat_map`
@@ -1155,6 +1169,10 @@ Rails/Output:
   Description: 'Checks for calls to puts, print, etc.'
   Enabled: true
 
+Rails/PluralizationGrammar:
+  Description: 'Checks for incorrect grammar when using methods like `3.day.ago`.'
+  Enabled: true
+
 Rails/ReadWriteAttribute:
   Description: >-
                  Checks for read_attribute(:attr) and

data/lib/rubocop.rb

@@ -15,6 +15,8 @@ require 'rubocop/version'
 
 require 'rubocop/path_util'
 require 'rubocop/string_util'
+require 'rubocop/node_pattern'
+require 'rubocop/ast_node'
 
 require 'rubocop/cop/util'
 require 'rubocop/cop/offense'
@@ -48,6 +50,7 @@ require 'rubocop/cop/mixin/configurable_enforced_style'
 require 'rubocop/cop/mixin/configurable_naming'
 require 'rubocop/cop/mixin/empty_lines_around_body'
 require 'rubocop/cop/mixin/end_keyword_alignment'
+require 'rubocop/cop/mixin/first_element_line_break'
 require 'rubocop/cop/mixin/if_node'
 require 'rubocop/cop/mixin/negative_conditional'
 require 'rubocop/cop/mixin/on_method_def'
@@ -126,6 +129,7 @@ require 'rubocop/cop/metrics/perceived_complexity'
 require 'rubocop/cop/performance/case_when_splat'
 require 'rubocop/cop/performance/count'
 require 'rubocop/cop/performance/detect'
+require 'rubocop/cop/performance/fixed_size'
 require 'rubocop/cop/performance/flat_map'
 require 'rubocop/cop/performance/reverse_each'
 require 'rubocop/cop/performance/sample'
@@ -189,6 +193,10 @@ require 'rubocop/cop/style/end_of_line'
 require 'rubocop/cop/style/even_odd'
 require 'rubocop/cop/style/extra_spacing'
 require 'rubocop/cop/style/file_name'
+require 'rubocop/cop/style/first_array_element_line_break'
+require 'rubocop/cop/style/first_hash_element_line_break'
+require 'rubocop/cop/style/first_method_argument_line_break'
+require 'rubocop/cop/style/first_method_parameter_line_break'
 require 'rubocop/cop/style/first_parameter_indentation'
 require 'rubocop/cop/style/flip_flop'
 require 'rubocop/cop/style/for'
@@ -222,6 +230,7 @@ require 'rubocop/cop/style/multiline_ternary_operator'
 require 'rubocop/cop/style/mutable_constant'
 require 'rubocop/cop/style/negated_if'
 require 'rubocop/cop/style/negated_while'
+require 'rubocop/cop/style/nested_modifier'
 require 'rubocop/cop/style/nested_ternary_operator'
 require 'rubocop/cop/style/next'
 require 'rubocop/cop/style/nil_comparison'
@@ -276,6 +285,7 @@ require 'rubocop/cop/style/space_inside_parens'
 require 'rubocop/cop/style/space_inside_range_literal'
 require 'rubocop/cop/style/space_inside_string_interpolation'
 require 'rubocop/cop/style/special_global_vars'
+require 'rubocop/cop/style/stabby_lambda_parentheses'
 require 'rubocop/cop/style/string_literals'
 require 'rubocop/cop/style/string_literals_in_interpolation'
 require 'rubocop/cop/style/string_methods'
@@ -307,6 +317,7 @@ require 'rubocop/cop/rails/find_by'
 require 'rubocop/cop/rails/find_each'
 require 'rubocop/cop/rails/has_and_belongs_to_many'
 require 'rubocop/cop/rails/output'
+require 'rubocop/cop/rails/pluralization_grammar'
 require 'rubocop/cop/rails/read_write_attribute'
 require 'rubocop/cop/rails/scope_args'
 require 'rubocop/cop/rails/time_zone'
@@ -337,3 +348,5 @@ require 'rubocop/result_cache'
 require 'rubocop/runner'
 require 'rubocop/cli'
 require 'rubocop/options'
+require 'rubocop/warning'
+require 'rubocop/remote_config'

data/lib/rubocop/ast_node.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'astrolabe/node'
+
+module Astrolabe
+  # RuboCop's extensions to Astrolabe::Node (which extends Parser::AST::Node)
+  #
+  # Contribute as much of this as possible to the `astrolabe` gem
+  # If any of it is accepted, it can be deleted from here
+  #
+  class Node
+    # def_matcher can be used to define a pattern-matching method on Node:
+    class << self
+      extend RuboCop::NodePattern::Macros
+
+      # define both Node.method_name(node), and also node.method_name
+      def def_matcher(method_name, pattern_str)
+        singleton_class.def_node_matcher method_name, pattern_str
+        class_eval("def #{method_name}; Node.#{method_name}(self); end")
+      end
+    end
+
+    ## Destructuring
+
+    def_matcher :method_name, '{(send _ $_ ...) (block (send _ $_ ...) ...)}'
+    # Note: for masgn, #asgn_rhs will be an array node
+    def_matcher :asgn_rhs, '[assignment? (... $_)]'
+
+    ## Predicates
+
+    def multiline?
+      expr = loc.expression
+      expr && (expr.first_line != expr.last_line)
+    end
+
+    def single_line?
+      !multiline?
+    end
+
+    def asgn_method_call?
+      method_name != :== && method_name.to_s.end_with?('=')
+    end
+
+    def_matcher :equals_asgn?, '{lvasgn ivasgn cvasgn gvasgn casgn masgn}'
+    def_matcher :shorthand_asgn?, '{op_asgn or_asgn and_asgn}'
+    def_matcher :assignment?, '{equals_asgn? shorthand_asgn? asgn_method_call?}'
+  end
+end

data/lib/rubocop/cli.rb

@@ -24,6 +24,7 @@ module RuboCop
       runner = Runner.new(@options, @config_store)
       trap_interrupt(runner)
       all_passed = runner.run(paths)
+      display_warning_summary(runner.warnings)
       display_error_summary(runner.errors)
 
       all_passed && !runner.aborting? && runner.errors.empty? ? 0 : 1
@@ -100,6 +101,14 @@ module RuboCop
       end
     end
 
+    def display_warning_summary(warnings)
+      return if warnings.empty?
+
+      warn Rainbow("\n#{pluralize(warnings.size, 'warning')}:").yellow
+
+      warnings.each { |warning| warn warning }
+    end
+
     def display_error_summary(errors)
       return if errors.empty?
 

data/lib/rubocop/config.rb

@@ -14,12 +14,15 @@ module RuboCop
 
     class ValidationError < StandardError; end
 
-    COMMON_PARAMS = %w(Exclude Include Severity AutoCorrect)
+    COMMON_PARAMS = %w(Exclude Include Severity AutoCorrect StyleGuide Details)
 
     attr_reader :loaded_path
 
     def initialize(hash = {}, loaded_path = nil)
       @loaded_path = loaded_path
+      @for_cop = Hash.new do |h, cop|
+        h[cop] = self[Cop::Cop.qualified_cop_name(cop, loaded_path)] || {}
+      end
       super(hash)
     end
 
@@ -72,13 +75,11 @@ module RuboCop
     end
 
     def for_cop(cop)
-      cop = cop.cop_name if cop.respond_to?(:cop_name)
-      @for_cop ||= {}
-      @for_cop[cop] ||= self[Cop::Cop.qualified_cop_name(cop, loaded_path)]
+      @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop]
     end
 
     def cop_enabled?(cop)
-      for_cop(cop).nil? || for_cop(cop)['Enabled']
+      for_cop(cop).empty? || for_cop(cop)['Enabled']
     end
 
     def warn_unless_valid
@@ -170,7 +171,8 @@ module RuboCop
     def base_dir_for_path_parameters
       config_files = [ConfigLoader::DOTFILE, ConfigLoader::AUTO_GENERATED_FILE]
       @base_dir_for_path_parameters ||=
-        if config_files.include?(File.basename(loaded_path))
+        if config_files.include?(File.basename(loaded_path)) &&
+           loaded_path != File.join(Dir.home, ConfigLoader::DOTFILE)
           File.expand_path(File.dirname(loaded_path))
         else
           Dir.pwd

data/lib/rubocop/config_loader.rb

@@ -18,6 +18,7 @@ module RuboCop
     class << self
       attr_accessor :debug, :auto_gen_config, :exclude_limit
       attr_writer :root_level # The upwards search is stopped at this level.
+      attr_writer :default_configuration
 
       alias_method :debug?, :debug
       alias_method :auto_gen_config?, :auto_gen_config
@@ -26,6 +27,7 @@ module RuboCop
         path = File.absolute_path(path)
         hash = load_yaml_configuration(path)
 
+        resolve_inheritance_from_gems(hash, hash.delete('inherit_gem'))
         resolve_inheritance(path, hash)
 
         Array(hash.delete('require')).each { |r| require(r) }
@@ -57,16 +59,21 @@ module RuboCop
       end
 
       def base_configs(path, inherit_from)
-        configs = Array(inherit_from).map do |f|
-          f = File.expand_path(f, File.dirname(path))
+        configs = Array(inherit_from).compact.map do |f|
+          if f =~ URI.regexp
+            f = RemoteConfig.new(f).file
+            load_file(f)
+          else
+            f = File.expand_path(f, File.dirname(path))
 
-          if auto_gen_config?
-            next if f.include?(AUTO_GENERATED_FILE)
-            old_auto_config_file_warning if f.include?('rubocop-todo.yml')
-          end
+            if auto_gen_config?
+              next if f.include?(AUTO_GENERATED_FILE)
+              old_auto_config_file_warning if f.include?('rubocop-todo.yml')
+            end
 
-          print 'Inheriting ' if debug?
-          load_file(f)
+            print 'Inheriting ' if debug?
+            load_file(f)
+          end
         end
 
         configs.compact
@@ -165,6 +172,21 @@ module RuboCop
         end
       end
 
+      def resolve_inheritance_from_gems(hash, gems)
+        (gems || {}).each_pair do |gem_name, config_path|
+          hash['inherit_from'] = Array(hash['inherit_from'])
+          hash['inherit_from'] << 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)
+      rescue Gem::LoadError => e
+        raise Gem::LoadError,
+              "Unable to find gem #{gem_name}; is the gem installed? #{e}"
+      end
+
       def config_files_in_path(target)
         possible_config_files = dirs_to_search(target).map do |dir|
           File.join(dir, DOTFILE)

data/lib/rubocop/cop/commissioner.rb

@@ -30,7 +30,7 @@ module RuboCop
       end
 
       callback_methods.each do |callback|
-        class_eval <<-EOS
+        class_eval <<-EOS, __FILE__, __LINE__
           def #{callback}(node)
             @cops.each do |cop|
               next unless cop.respond_to?(:#{callback})

data/lib/rubocop/cop/cop.rb

@@ -49,7 +49,7 @@ module RuboCop
     #
     # The Cop class is meant to be extended.
     #
-    # Cops track offenses and can autocorrect them of the fly.
+    # Cops track offenses and can autocorrect them on the fly.
     #
     # A commissioner object is responsible for traversing the AST and invoking
     # the specific callbacks on each cop.
@@ -66,6 +66,7 @@ module RuboCop
     #   end
     class Cop
       extend AST::Sexp
+      extend NodePattern::Macros
       include Util
       include IgnoredNode
       include AutocorrectLogic
@@ -138,6 +139,11 @@ module RuboCop
             config['AllCops'] && config['AllCops']['DisplayStyleGuide'])
       end
 
+      def extra_details?
+        @options[:extra_details] ||
+          config['AllCops'] && config['AllCops']['ExtraDetails']
+      end
+
       # Returns true if the cop name or the cop namespace matches any of the
       # given names.
       def self.match?(given_names)
@@ -179,7 +185,8 @@ module RuboCop
       end
 
       def config_to_allow_offenses
-        Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name]
+        Formatter::DisabledConfigFormatter
+          .config_to_allow_offenses[cop_name] ||= {}
       end
 
       def config_to_allow_offenses=(hash)
@@ -203,19 +210,25 @@ module RuboCop
       end
 
       def style_guide_url
-        url = cop_config && cop_config['StyleGuide']
+        url = cop_config['StyleGuide']
         (url.nil? || url.empty?) ? nil : url
       end
 
       def reference_url
-        url = cop_config && cop_config['Reference']
+        url = cop_config['Reference']
         (url.nil? || url.empty?) ? nil : url
       end
 
+      def details
+        details = cop_config && cop_config['Details']
+        (details.nil? || details.empty?) ? nil : details
+      end
+
       private
 
       def annotate_message(message)
         message = "#{name}: #{message}" if display_cop_names?
+        message += " #{details}" if extra_details?
         if display_style_guide?
           links = [style_guide_url, reference_url].compact.join(', ')
           message = "#{message} (#{links})"
@@ -224,7 +237,7 @@ module RuboCop
       end
 
       def file_name_matches_any?(file, parameter, default_result)
-        patterns = cop_config && cop_config[parameter]
+        patterns = cop_config[parameter]
         return default_result unless patterns
         path = nil
         patterns.any? do |pattern|
@@ -247,7 +260,7 @@ module RuboCop
       end
 
       def custom_severity
-        severity = cop_config && cop_config['Severity']
+        severity = cop_config['Severity']
         return unless severity
 
         if Severity::NAMES.include?(severity.to_sym)

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

@@ -3,19 +3,50 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for circular argument references in keyword arguments.
+      # This cop checks for circular argument references in optional keyword
+      # arguments and optional ordinal arguments.
       #
       # This cop mirrors a warning produced by MRI since 2.2.
       #
       # @example
+      #   # bad
       #   def bake(pie: pie)
       #     pie.heat_up
       #   end
+      #
+      #   # good
+      #   def bake(pie:)
+      #     pie.refrigerate
+      #   end
+      #
+      #   # good
+      #   def bake(pie: self.pie)
+      #     pie.feed_to(user)
+      #   end
+      #
+      #   # bad
+      #   def cook(dry_ingredients = dry_ingredients)
+      #     dry_ingredients.reduce(&:+)
+      #   end
+      #
+      #   # good
+      #   def cook(dry_ingredients = self.dry_ingredients)
+      #     dry_ingredients.combine
+      #   end
       class CircularArgumentReference < Cop
         MSG = 'Circular argument reference - `%s`.'
 
         def on_kwoptarg(node)
-          arg_name, arg_value = *node
+          check_for_circular_argument_references(*node)
+        end
+
+        def on_optarg(node)
+          check_for_circular_argument_references(*node)
+        end
+
+        private
+
+        def check_for_circular_argument_references(arg_name, arg_value)
           case arg_value.type
           when :send
             # Ruby 2.0 will have type send every time, and "send nil" if it is