rubocop 0.37.0 → 0.37.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bdbb9f710745091d21b8fb1bc741a5964d7ad0f
-  data.tar.gz: 0c1bdb92f40935b9d9209c78e006a444e85ad5c1
+  metadata.gz: b67d84c23023e9ebfbbf8c68e50d03e81e635f49
+  data.tar.gz: 0a3e93f819e257610f970bc086d5e99578ad4655
 SHA512:
-  metadata.gz: 2f58d0c665369ccdcff54b88b35bd032327b0460ccb6a7b05101cbf853f6895f491636c11e59824b14cd54c87f599187ec41790902f7ff8bfd2f7a3a5febd9ba
-  data.tar.gz: 59de02eb56cc687d3dd664ee540d7338a8968b8ffe758a72596455d2cf2c48c8103b3fe54970d19b947abef418407a2af579d0f5e4d9fd06dc0b626a18af58d9
+  metadata.gz: da04ad8512393920149f4ae5d0e9b284ebf91e1cff0c22df0261b432d4b30c4b1adb192df930a66e34e308a4a97c0ad5ed5024f11f99b8e55a7ce6784ed18ba2
+  data.tar.gz: df9eab441cdd4086a3af7a6ba5724e15cd6a047773c0acfb75ee47380e14681f3b613bfd5b69a3de2c15b54c2bc6c04d5814c271d61afc96e89d1b58c93ee8cd

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.36.0', require: false
+gem 'rubocop', '~> 0.37.1', require: false
 ```
 
 ## Basic Usage

data/config/default.yml

@@ -481,9 +481,8 @@ Style/FormatString:
 Style/FrozenStringLiteralComment:
   EnforcedStyle: when_needed
   SupportedStyles:
-    # `when_needed` will add the frozen string literal comment to files that call
-    # `freeze` or `<<` on a string literal. It will only add the comment to files
-    # when running Ruby 2.3.0+.
+    # `when_needed` will add the frozen string literal comment to files
+    # only when the `TargetRubyVersion` is set to 2.3+.
     - when_needed
     # `always` will always add the frozen string literal comment to a file
     # regardless of the Ruby version or if `freeze` or `<<` are called on a

data/config/enabled.yml

@@ -620,7 +620,7 @@ Style/Semicolon:
 
 Style/SignalException:
   Description: 'Checks for proper usage of fail and raise.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#fail-method'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#prefer-raise-over-fail'
   Enabled: true
 
 Style/SingleLineBlockParams:
@@ -1239,7 +1239,7 @@ Performance/RedundantMatch:
   Enabled: true
 
 Performance/RedundantMerge:
-  Description: 'Use Hash#[]=, rather than Hash#merge! or Hash#update with a single key-value pair.'
+  Description: 'Use Hash#[]=, rather than Hash#merge! with a single key-value pair.'
   Reference: 'https://github.com/JuanitoFatas/fast-ruby#hashmerge-vs-hash-code'
   Enabled: true
 

data/lib/rubocop.rb

@@ -34,7 +34,6 @@ require 'rubocop/cop/cop'
 require 'rubocop/cop/commissioner'
 require 'rubocop/cop/corrector'
 require 'rubocop/cop/force'
-require 'rubocop/cop/team'
 require 'rubocop/cop/severity'
 
 require 'rubocop/cop/variable_force'
@@ -369,6 +368,8 @@ require 'rubocop/cop/rails/scope_args'
 require 'rubocop/cop/rails/time_zone'
 require 'rubocop/cop/rails/validation'
 
+require 'rubocop/cop/team'
+
 require 'rubocop/formatter/base_formatter'
 require 'rubocop/formatter/simple_text_formatter'
 require 'rubocop/formatter/clang_style_formatter' # relies on simple text

data/lib/rubocop/ast_node.rb

@@ -43,8 +43,6 @@ module RuboCop
     OPERATOR_KEYWORDS = [:and, :or].freeze
     SPECIAL_KEYWORDS = %w(__FILE__ __LINE__ __ENCODING__).freeze
 
-    RSPEC_METHODS = [:describe, :it].freeze
-
     # def_matcher can be used to define a pattern-matching method on Node
     class << self
       def def_matcher(method_name, pattern_str)
@@ -331,23 +329,47 @@ module RuboCop
           # to keep traversing up through nested classes/modules
           ancestor.defined_module_name
         when :sclass
-          obj = ancestor.children[0]
-          # TODO: look for constant definition and see if it is nested
-          # inside a class or module
-          return "#<Class:#{obj.const_name}>" if obj.const_type?
-          return "#<Class:#{ancestor.parent_module_name}>" if obj.self_type?
-          return nil
+          return parent_module_name_for_sclass(ancestor)
         else # block
-          return nil if ancestor.known_dsl?
-          if ancestor.method_name == :class_eval && ancestor.receiver
-            return nil unless ancestor.receiver.const_type?
-            ancestor.receiver.const_name
+          if ancestor.method_name == :class_eval
+            # `class_eval` with no receiver applies to whatever module or class
+            # we are currently in
+            next unless (receiver = ancestor.receiver)
+            return nil unless receiver.const_type?
+            receiver.const_name
+          elsif new_class_or_module_block?(ancestor)
+            # we will catch this in the `casgn` branch above
+            next
+          else
+            return nil
           end
         end
       end.compact.reverse.join('::')
       result.empty? ? 'Object' : result
     end
 
+    def parent_module_name_for_sclass(sclass_node)
+      # TODO: look for constant definition and see if it is nested
+      # inside a class or module
+      subject = sclass_node.children[0]
+
+      if subject.const_type?
+        "#<Class:#{subject.const_name}>"
+      elsif subject.self_type?
+        "#<Class:#{sclass_node.parent_module_name}>"
+      end
+    end
+
+    def new_class_or_module_block?(block_node)
+      receiver = block_node.receiver
+
+      block_node.method_name == :new &&
+        receiver && receiver.const_type? &&
+        (receiver.const_name == 'Class' || receiver.const_name == 'Module') &&
+        block_node.parent &&
+        block_node.parent.casgn_type?
+    end
+
     ## Predicates
 
     def multiline?
@@ -524,11 +546,6 @@ module RuboCop
       end
     end
 
-    # Known DSL methods which eval body inside an anonymous class/module
-    def known_dsl?
-      RSPEC_METHODS.include?(method_name) && receiver.nil?
-    end
-
     protected
 
     def visit_descendants(&block)

data/lib/rubocop/ast_node/traversal.rb

@@ -149,7 +149,8 @@ module RuboCop
 
       def on_block(node)
         children = node.children
-        on_send(children[0])
+        child = children[0]
+        send(:"on_#{child.type}", child) # can be send, zsuper...
         on_args(children[1])
         return unless (child = children[2])
         send(:"on_#{child.type}", child)

data/lib/rubocop/config.rb

@@ -255,7 +255,7 @@ module RuboCop
     end
 
     def check_obsolete_parameter(cop, parameter, alternative = nil)
-      if key?(cop) && self[cop].key?(parameter)
+      if self[cop] && self[cop].key?(parameter)
         raise ValidationError, "obsolete parameter #{parameter} (for #{cop}) " \
                               "found in #{loaded_path}" \
                               "#{"\n" if alternative}#{alternative}"

data/lib/rubocop/cop/commissioner.rb

@@ -35,6 +35,9 @@ module RuboCop
         next unless RuboCop::Node::Traversal.method_defined?(callback)
         class_eval <<-EOS, __FILE__, __LINE__
           def #{callback}(node)
+            @callbacks[:"#{callback}"] ||= @cops.select do |cop|
+              cop.respond_to?(:"#{callback}")
+            end
             @callbacks[:#{callback}].each do |cop|
               with_cop_error_handling(cop) do
                 cop.send(:#{callback}, node)
@@ -49,7 +52,7 @@ module RuboCop
       def investigate(processed_source)
         reset_errors
         remove_irrelevant_cops(processed_source.buffer.name)
-        setup_callbacks
+        reset_callbacks
         prepare(processed_source)
         invoke_custom_processing(@cops, processed_source)
         invoke_custom_processing(@forces, processed_source)
@@ -67,11 +70,8 @@ module RuboCop
         @cops.reject! { |cop| cop.excluded_file?(filename) }
       end
 
-      def setup_callbacks
+      def reset_callbacks
         @callbacks.clear
-        self.class.callback_methods.each do |method|
-          @callbacks[method] = @cops.select { |cop| cop.respond_to?(method) }
-        end
       end
 
       # TODO: Bad design.

data/lib/rubocop/cop/corrector.rb

@@ -31,21 +31,35 @@ module RuboCop
       #
       #   corrections = [AndOrCorrector.new(node)]
       #   corrector = Corrector.new(source_buffer, corrections)
-      def initialize(source_buffer, corrections)
+      def initialize(source_buffer, corrections = [])
         @source_buffer = source_buffer
         @corrections = corrections
         @source_rewriter = Parser::Source::Rewriter.new(source_buffer)
+
+        @diagnostics = []
+        # Don't print warnings to stderr if corrections conflict with each other
+        @source_rewriter.diagnostics.consumer = lambda do |diagnostic|
+          @diagnostics << diagnostic
+        end
       end
 
+      attr_reader :corrections, :diagnostics
+
       # Does the actual rewrite and returns string corresponding to
       # the rewritten source.
       #
       # @return [String]
-      # TODO: Handle conflict exceptions raised from the Source::Rewriter
       def rewrite
+        # rubocop:disable Lint/HandleExceptions
         @corrections.each do |correction|
-          correction.call(self)
+          begin
+            @source_rewriter.transaction do
+              correction.call(self)
+            end
+          rescue ::Parser::ClobberingError
+          end
         end
+        # rubocop:enable Lint/HandleExceptions
 
         @source_rewriter.process
       end

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

@@ -33,8 +33,8 @@ module RuboCop
               corrector.replace(block.source_range, body.source)
             else
               range = node.source_range
-              range = range_with_surrounding_space(range, :left, nil, false)
-              range = range_with_surrounding_space(range, :right, nil, true)
+              range = range_with_surrounding_space(range, :left, false)
+              range = range_with_surrounding_space(range, :right, true)
               corrector.remove(range)
             end
           end

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

@@ -38,7 +38,11 @@ module RuboCop
 
         def find_nested_defs(node, &block)
           node.each_child_node do |child|
-            if child.def_type? || child.defs_type?
+            if child.def_type?
+              yield child
+            elsif child.defs_type?
+              subject, = *child
+              next if subject.lvar_type?
               yield child
             elsif !(eval_call?(child) || class_or_module_new_call?(child))
               find_nested_defs(child, &block)

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

@@ -68,7 +68,7 @@ module RuboCop
 
               range = range_with_surrounding_comma(range, :right)
               # eat following spaces up to EOL, but not the newline itself
-              range = range_with_surrounding_space(range, :right, nil, false)
+              range = range_with_surrounding_space(range, :right, false)
 
               corrector.remove(range)
             end

data/lib/rubocop/cop/metrics/parameter_lists.rb

@@ -5,7 +5,7 @@ module RuboCop
   module Cop
     module Metrics
       # This cop checks for methods with too many parameters.
-      # The maximum number of parameters in configurable.
+      # The maximum number of parameters is configurable.
       # On Ruby 2.0+ keyword arguments can optionally
       # be excluded from the total count.
       class ParameterLists < Cop

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

@@ -34,7 +34,8 @@ module RuboCop
 
         def on_send(node)
           return unless match_call?(node) &&
-                        (!node.value_used? || only_truthiness_matters?(node))
+                        (!node.value_used? || only_truthiness_matters?(node)) &&
+                        !(node.parent && node.parent.block_type?)
           add_offense(node, :expression, MSG)
         end
 

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

@@ -15,8 +15,7 @@ module RuboCop
         AREF_ASGN = '%s[%s] = %s'.freeze
         MSG = 'Use `%s` instead of `%s`.'.freeze
 
-        def_node_matcher :redundant_merge,
-                         '(send $_ {:merge! :update} (hash $...))'
+        def_node_matcher :redundant_merge, '(send $_ :merge! (hash $...))'
         def_node_matcher :modifier_flow_control, '[{if while until} #modifier?]'
 
         def on_send(node)

data/lib/rubocop/cop/rails/find_each.rb

@@ -16,7 +16,7 @@ module RuboCop
       class FindEach < Cop
         MSG = 'Use `find_each` instead of `each`.'.freeze
 
-        SCOPE_METHODS = [:all, :where].freeze
+        SCOPE_METHODS = [:all, :where, :not].freeze
 
         def on_send(node)
           receiver, second_method, _selector = *node

data/lib/rubocop/cop/style/block_end_newline.rb

@@ -4,7 +4,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks whether the end statement of a do end blocks
+      # This cop checks whether the end statement of a do..end block
       # is on its own line.
       #
       # @example

data/lib/rubocop/cop/style/conditional_assignment.rb

@@ -8,6 +8,9 @@ module RuboCop
       # ConditionalAssignment Cop.
       module ConditionalAssignmentHelper
         EQUAL = '='.freeze
+        END_ALIGNMENT = 'Lint/EndAlignment'.freeze
+        ALIGN_WITH = 'AlignWith'.freeze
+        KEYWORD = 'keyword'.freeze
 
         # `elsif` branches show up in the `node` as an `else`. We need
         # to recursively iterate over all `else` branches and consider all
@@ -55,6 +58,16 @@ module RuboCop
           end
         end
 
+        def indent(cop, source)
+          if cop.config[END_ALIGNMENT] &&
+             cop.config[END_ALIGNMENT][ALIGN_WITH] &&
+             cop.config[END_ALIGNMENT][ALIGN_WITH] == KEYWORD
+            ' ' * source.length
+          else
+            ''
+          end
+        end
+
         private
 
         def expand_elsif(node, elsif_branches = [])
@@ -185,11 +198,11 @@ module RuboCop
           else
             case node.loc.keyword.source
             when IF
-              IfCorrector.correct(node)
+              IfCorrector.correct(self, node)
             when UNLESS
-              UnlessCorrector.correct(node)
+              UnlessCorrector.correct(self, node)
             else
-              CaseCorrector.correct(node)
+              CaseCorrector.correct(self, node)
             end
           end
         end
@@ -208,7 +221,7 @@ module RuboCop
           return true if ASSIGNMENT_TYPES.include?(branch.type)
 
           if branch.send_type?
-            _variable, method, = *branch
+            _receiver, method, = *branch
             return true if METHODS.include?(method)
             return true if method.to_s.end_with?(EQUAL)
           end
@@ -296,7 +309,7 @@ module RuboCop
         class << self
           include ConditionalAssignmentHelper
 
-          def correct(node)
+          def correct(cop, node)
             _condition, if_branch, else_branch = *node
             if_branch = tail(if_branch)
             _variable, *_operator, if_assignment = *if_branch
@@ -311,6 +324,7 @@ module RuboCop
               correct_branches(corrector, elsif_branches)
               corrector.replace(else_branch.source_range,
                                 else_assignment.source)
+              corrector.insert_before(node.loc.end, indent(cop, lhs(if_branch)))
             end
           end
         end
@@ -321,7 +335,7 @@ module RuboCop
         class << self
           include ConditionalAssignmentHelper
 
-          def correct(node)
+          def correct(cop, node)
             _condition, *when_branches, else_branch = *node
             else_branch = tail(else_branch)
             when_branches = expand_when_branches(when_branches)
@@ -333,6 +347,9 @@ module RuboCop
               correct_branches(corrector, when_branches)
               corrector.replace(else_branch.source_range,
                                 else_assignment.source)
+
+              corrector.insert_before(node.loc.end,
+                                      indent(cop, lhs(else_branch)))
             end
           end
         end
@@ -343,7 +360,7 @@ module RuboCop
         class << self
           include ConditionalAssignmentHelper
 
-          def correct(node)
+          def correct(cop, node)
             _condition, else_branch, if_branch = *node
             if_branch = tail(if_branch)
             else_branch = tail(else_branch)
@@ -355,6 +372,7 @@ module RuboCop
               corrector.replace(if_branch.source_range, if_assignment.source)
               corrector.replace(else_branch.source_range,
                                 else_assignment.source)
+              corrector.insert_before(node.loc.end, indent(cop, lhs(if_branch)))
             end
           end
         end

data/lib/rubocop/cop/style/empty_line_between_defs.rb

@@ -7,20 +7,26 @@ module RuboCop
       # This cop checks whether method definitions are
       # separated by empty lines.
       class EmptyLineBetweenDefs < Cop
-        include OnMethodDef
         MSG = 'Use empty lines between method definitions.'.freeze
 
-        def on_method_def(node, _method_name, _args, _body)
-          return unless node.parent && node.parent.begin_type?
-
-          nodes = [prev_node(node), node]
+        # We operate on `begin` nodes, instead of using `OnMethodDef`,
+        # so that we can walk over pairs of consecutive nodes and
+        # efficiently access a node's predecessor; #prev_node ends up
+        # doing a linear scan over siblings, so we don't want to call
+        # it on each def.
+        def on_begin(node)
+          node.children.each_cons(2) do |prev, n|
+            nodes = [prev, n]
+            check_defs(nodes) if nodes.all?(&method(:def_node?))
+          end
+        end
 
-          return unless nodes.all?(&method(:def_node?))
+        def check_defs(nodes)
           return if blank_lines_between?(*nodes)
           return if nodes.all?(&:single_line?) &&
                     cop_config['AllowAdjacentOneLineDefs']
 
-          add_offense(node, :keyword)
+          add_offense(nodes.last, :keyword)
         end
 
         private