rubocop 0.58.2 → 0.59.0

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

@@ -165,6 +165,7 @@ module RuboCop
 
           while node && node.send_type?
             break if extract_method(node) == :localtime
+
             node = node.parent
           end
 

data/lib/rubocop/cop/security/eval.rb

@@ -21,6 +21,7 @@ module RuboCop
         def on_send(node)
           eval?(node) do |code|
             return if code.dstr_type? && code.recursive_literal?
+
             add_offense(node, location: :selector)
           end
         end

data/lib/rubocop/cop/security/json_load.rb

@@ -15,11 +15,11 @@ module RuboCop
       # Other similar issues may apply.
       #
       # @example
-      #   # always offense
+      #   # bad
       #   JSON.load("{}")
       #   JSON.restore("{}")
       #
-      #   # no offense
+      #   # good
       #   JSON.parse("{}")
       #
       class JSONLoad < Cop

data/lib/rubocop/cop/security/open.rb

@@ -4,11 +4,12 @@ module RuboCop
   module Cop
     module Security
       # This cop checks for the use of `Kernel#open`.
+      #
       # `Kernel#open` enables not only file access but also process invocation
-      # by prefixing a pipe symbol (e.g., `open("| ls")`).  So, it may lead to
+      # by prefixing a pipe symbol (e.g., `open("| ls")`). So, it may lead to
       # a serious security risk by using variable input to the argument of
-      # `Kernel#open`.  It would be better to use `File.open` or `IO.popen`
-      # explicitly.
+      # `Kernel#open`. It would be better to use `File.open`, `IO.popen` or
+      # `URI#open` explicitly.
       #
       # @example
       #   # bad
@@ -17,6 +18,7 @@ module RuboCop
       #   # good
       #   File.open(something)
       #   IO.popen(something)
+      #   URI.parse(something).open
       class Open < Cop
         MSG = 'The use of `Kernel#open` is a serious security risk.'.freeze
 
@@ -39,6 +41,7 @@ module RuboCop
         def on_send(node)
           open?(node) do |code|
             return if safe?(code)
+
             add_offense(node, location: :selector)
           end
         end

data/lib/rubocop/cop/severity.rb

@@ -34,6 +34,7 @@ module RuboCop
         unless NAMES.include?(name)
           raise ArgumentError, "Unknown severity: #{name}"
         end
+
         @name = name.freeze
         freeze
       end

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for uses of `and` and `or`, and suggests using `&&` and
-      # `|| instead`. It can be configured to check only in conditions, or in
+      # `||` instead. It can be configured to check only in conditions, or in
       # all contexts.
       #
       # @example EnforcedStyle: always (default)
@@ -110,11 +110,11 @@ module RuboCop
         # recurse down a level and add parens to 'obj.method arg'
         # however, 'not x' also parses as (send x :!)
         def correct_not(node, receiver, corrector)
-          if node.keyword_bang?
+          if node.prefix_bang?
             return unless receiver.send_type?
 
             correct_send(receiver, corrector)
-          elsif node.keyword_not?
+          elsif node.prefix_not?
             correct_other(node, corrector)
           else
             raise 'unrecognized unary negation operator'

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

@@ -24,6 +24,7 @@ module RuboCop
           processed_source.each_comment do |comment|
             next if comment.text.ascii_only?
             next if only_allowed_non_ascii_chars?(comment.text)
+
             add_offense(comment, location: first_offense_range(comment))
           end
         end

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

@@ -73,6 +73,7 @@ module RuboCop
       #
       class BlockDelimiters < Cop
         include ConfigurableEnforcedStyle
+        include IgnoredMethods
 
         def on_send(node)
           return unless node.arguments?
@@ -189,6 +190,7 @@ module RuboCop
             # In that case, one of the K/V pairs could contain a block node
             # which could change in meaning if do...end replaced {...}
             return if node.braces?
+
             node.each_child_node { |child| get_blocks(child, &block) }
           when :pair
             node.each_child_node { |child| get_blocks(child, &block) }
@@ -240,10 +242,6 @@ module RuboCop
           node.send_node.arguments? && !node.send_node.parenthesized?
         end
 
-        def ignored_method?(method_name)
-          cop_config['IgnoredMethods'].map(&:to_sym).include?(method_name)
-        end
-
         def functional_method?(method_name)
           cop_config['FunctionalMethods'].map(&:to_sym).include?(method_name)
         end

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

@@ -127,13 +127,12 @@ module RuboCop
         end
 
         def remove_braces_with_whitespace(corrector, node, space)
-          right_brace_and_space = right_brace_and_space(node.loc.end, space)
-
           if node.multiline?
             remove_braces_with_range(corrector,
                                      left_whole_line_range(node.loc.begin),
                                      right_whole_line_range(node.loc.end))
           else
+            right_brace_and_space = right_brace_and_space(node.loc.end, space)
             left_brace_and_space = left_brace_and_space(node.loc.begin, space)
             remove_braces_with_range(corrector,
                                      left_brace_and_space,
@@ -155,7 +154,7 @@ module RuboCop
         end
 
         def right_whole_line_range(loc_end)
-          if range_by_whole_lines(loc_end).source.strip == '}'
+          if range_by_whole_lines(loc_end).source.strip =~ /}\s*,?\z/
             range_by_whole_lines(loc_end, include_final_newline: true)
           else
             loc_end

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

@@ -33,6 +33,7 @@ module RuboCop
         def on_class(node)
           _name, superclass, body = *node
           return if superclass && style != :nested
+
           check_style(node, body)
         end
 
@@ -129,11 +130,13 @@ module RuboCop
 
         def check_nested_style(node)
           return unless compact_node_name?(node)
+
           add_offense(node, location: :name, message: NESTED_MSG)
         end
 
         def check_compact_style(node, body)
           return unless one_child?(body) && !compact_node_name?(node)
+
           add_offense(node, location: :name, message: COMPACT_MSG)
         end
 

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

@@ -26,7 +26,7 @@ module RuboCop
       #
       #   class A
       #     def test
-      #       @@test # you can access class variable without offence
+      #       @@test # you can access class variable without offense
       #     end
       #   end
       #

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

@@ -24,6 +24,7 @@ module RuboCop
 
         def on_defs(node)
           return unless node.loc.operator.source == '::'
+
           add_offense(node, location: :operator)
         end
 

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

@@ -47,6 +47,7 @@ module RuboCop
             line = processed_source.lines[line_position - 1]
             next if heredoc_lines.any? { |r| r.include?(line_position) }
             next unless offensive?(line)
+
             range = source_range(processed_source.buffer,
                                  line_position,
                                  (location.column)...(location.last_column))
@@ -74,6 +75,7 @@ module RuboCop
 
         def extract_heredoc_lines(ast)
           return [] unless ast
+
           ast.each_node(:str, :dstr, :xstr).select(&:heredoc?).map do |node|
             body = node.location.heredoc_body
             (body.first_line...body.last_line)

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

@@ -69,6 +69,7 @@ module RuboCop
 
         def expand_elsif(node, elsif_branches = [])
           return [] if node.nil? || !node.if_type?
+
           _condition, elsif_branch, else_branch = *node
           elsif_branches << elsif_branch
           if else_branch && else_branch.if_type?
@@ -100,6 +101,7 @@ module RuboCop
         def assignment_rhs_exist?(node)
           parent = node.parent
           return true unless parent
+
           !(parent.mlhs_type? || parent.resbody_type?)
         end
       end

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

@@ -6,12 +6,12 @@ module RuboCop
       # Check that a copyright notice was given in each source file.
       #
       # The default regexp for an acceptable copyright notice can be found in
-      # config/default.yml.  The default can be changed as follows:
+      # config/default.yml. The default can be changed as follows:
       #
       #     Style/Copyright:
       #       Notice: '^Copyright (\(c\) )?2\d{3} Acme Inc'
       #
-      # This regex string is treated as an unanchored regex.  For each file
+      # This regex string is treated as an unanchored regex. For each file
       # that RuboCop scans, a comment that matches this regex must be found or
       # an offense is reported.
       #
@@ -26,6 +26,7 @@ module RuboCop
         def investigate(processed_source)
           return if notice.empty?
           return if notice_found?(processed_source)
+
           range = source_range(processed_source.buffer, 1, 0)
           add_offense(insert_notice_before(processed_source),
                       location: range, message: format(MSG, notice: notice))
@@ -33,6 +34,7 @@ module RuboCop
 
         def autocorrect(token)
           raise Warning, AUTOCORRECT_EMPTY_WARNING if autocorrect_notice.empty?
+
           regex = Regexp.new(notice)
           unless autocorrect_notice =~ regex
             raise Warning, "AutocorrectNotice '#{autocorrect_notice}' must " \
@@ -64,12 +66,14 @@ module RuboCop
 
         def shebang_token?(processed_source, token_index)
           return false if token_index >= processed_source.tokens.size
+
           token = processed_source.tokens[token_index]
           token.comment? && token.text =~ /^#!.*$/
         end
 
         def encoding_token?(processed_source, token_index)
           return false if token_index >= processed_source.tokens.size
+
           token = processed_source.tokens[token_index]
           token.comment? && token.text =~ /^#.*coding\s?[:=]\s?(?:UTF|utf)-8/
         end
@@ -79,6 +83,7 @@ module RuboCop
           notice_regexp = Regexp.new(notice)
           processed_source.each_token do |token|
             break unless token.comment?
+
             notice_found = !(token.text =~ notice_regexp).nil?
             break if notice_found
           end

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

@@ -3,8 +3,11 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for uses of `DateTime` that should be replaced by
-      # `Date` or `Time`.
+      # This cop checks for consistent usage of the `DateTime` class over the
+      # `Time` class. This cop is disabled by default since these classes,
+      # although highly overlapping, have particularities that make them not
+      # replaceable in certain situations when dealing with multiple timezones
+      # and/or DST.
       #
       # @example
       #
@@ -17,13 +20,30 @@ module RuboCop
       #   # bad - uses `DateTime` for modern date
       #   DateTime.iso8601('2016-06-29')
       #
-      #   # good - uses `Date` for modern date
-      #   Date.iso8601('2016-06-29')
+      #   # good - uses `Time` for modern date
+      #   Time.iso8601('2016-06-29')
       #
       #   # good - uses `DateTime` with start argument for historical date
       #   DateTime.iso8601('1751-04-23', Date::ENGLAND)
+      #
+      # @example AllowCoercion: false (default)
+      #
+      #   # bad - coerces to `DateTime`
+      #   something.to_datetime
+      #
+      #   # good - coerces to `Time`
+      #   something.to_time
+      #
+      # @example AllowCoercion: true
+      #
+      #   # good
+      #   something.to_datetime
+      #
+      #   # good
+      #   something.to_time
       class DateTime < Cop
-        MSG = 'Prefer Date or Time over DateTime.'.freeze
+        CLASS_MSG = 'Prefer Time over DateTime.'.freeze
+        COERCION_MSG = 'Do not use #to_datetime.'.freeze
 
         def_node_matcher :date_time?, <<-PATTERN
           (send (const {nil? (cbase)} :DateTime) ...)
@@ -33,10 +53,23 @@ module RuboCop
           (send _ _ _ (const (const nil? :Date) _))
         PATTERN
 
+        def_node_matcher :to_datetime?, <<-PATTERN
+          (send _ :to_datetime)
+        PATTERN
+
         def on_send(node)
-          return unless date_time?(node)
+          return unless date_time?(node) ||
+                        (to_datetime?(node) && disallow_coercion?)
           return if historic_date?(node)
-          add_offense(node)
+
+          message = to_datetime?(node) ? COERCION_MSG : CLASS_MSG
+          add_offense(node, message: message)
+        end
+
+        private
+
+        def disallow_coercion?
+          !cop_config['AllowCoercion']
         end
       end
     end

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

@@ -25,7 +25,7 @@ module RuboCop
         def_node_matcher :double_negative?, '(send (send _ :!) :!)'
 
         def on_send(node)
-          return unless double_negative?(node) && node.keyword_bang?
+          return unless double_negative?(node) && node.prefix_bang?
 
           add_offense(node, location: :selector)
         end

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

@@ -43,6 +43,14 @@ module RuboCop
 
         def on_case(case_node)
           return if case_node.condition
+          return if case_node.when_branches.any? do |when_branch|
+            when_branch.each_descendant.any?(&:return_type?)
+          end
+
+          if (else_branch = case_node.else_branch)
+            return if else_branch.return_type? ||
+                      else_branch.each_descendant.any?(&:return_type?)
+          end
 
           add_offense(case_node, location: :keyword)
         end

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

@@ -148,12 +148,14 @@ module RuboCop
 
         def else_line_range(loc)
           return 0..0 if loc.else.nil? || loc.end.nil?
+
           loc.else.first_line..loc.end.first_line
         end
 
         def base_node(node)
           return node if node.case_type?
           return node unless node.elsif?
+
           node.each_ancestor(:if, :case, :when).find(-> { node }) do |parent|
             parent.loc.end
           end

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

@@ -25,6 +25,7 @@ module RuboCop
         def on_block(node)
           send_node = node.send_node
           return unless send_node.send_type?
+
           check(node) if node.send_node.stabby_lambda?
         end
 

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

@@ -124,6 +124,7 @@ module RuboCop
 
         def add_offense_for_same_line(node, line_node)
           return if special_line_keyword?(line_node)
+
           add_offense(
             node,
             location: line_node.loc.expression,
@@ -134,6 +135,7 @@ module RuboCop
         def add_offense_for_different_line(node, line_node, line_diff)
           sign = line_diff > 0 ? :+ : :-
           return if line_with_offset?(line_node, sign, line_diff.abs)
+
           add_offense(
             node,
             location: line_node.loc.expression,

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

@@ -43,12 +43,24 @@ module RuboCop
         include RangeHelp
 
         EACH_LENGTH = 'each'.length
+        PREFER_EACH = 'Prefer `each` over `for`.'.freeze
+        PREFER_FOR = 'Prefer `for` over `each`.'.freeze
+
+        def_node_matcher :deconstruct_for, <<-PATTERN
+          (for $_item $_enumerable _block)
+        PATTERN
+
+        def_node_matcher :deconstruct_each, <<-PATTERN
+          (block (send $_enumerable :each) $_ _block)
+        PATTERN
+
+        def_node_matcher :extract_variables, <<-PATTERN
+          (args $_)
+        PATTERN
 
         def on_for(node)
           if style == :each
-            msg = 'Prefer `each` over `for`.'
-
-            add_offense(node, location: :keyword, message: msg) do
+            add_offense(node, message: PREFER_EACH) do
               opposite_style_detected
             end
           else
@@ -63,23 +75,57 @@ module RuboCop
                         !node.send_node.arguments?
 
           if style == :for
-            incorrect_style_detected(node.send_node)
+            incorrect_style_detected(node)
           else
             correct_style_detected
           end
         end
 
-        private
+        def autocorrect(node)
+          if style == :each
+            autocorrect_to_each(node)
+          else
+            autocorrect_to_for(node)
+          end
+        end
 
-        def incorrect_style_detected(method)
-          end_pos = method.source_range.end_pos
-          range = range_between(end_pos - EACH_LENGTH, end_pos)
-          msg = 'Prefer `for` over `each`.'
+        private
 
-          add_offense(range, location: range, message: msg) do
+        def incorrect_style_detected(node)
+          add_offense(node, message: PREFER_FOR) do
             opposite_style_detected
           end
         end
+
+        def autocorrect_to_each(node)
+          item, enumerable = deconstruct_for(node)
+          replacement_range = replacement_range(node, node.loc.begin.end_pos)
+          correction = "#{enumerable.source}.each do |#{item.source}|"
+
+          ->(corrector) { corrector.replace(replacement_range, correction) }
+        end
+
+        def autocorrect_to_for(node)
+          enumerable, items = deconstruct_each(node)
+          variables = extract_variables(items)
+
+          if variables.nil?
+            replacement_range = replacement_range(node, node.loc.begin.end_pos)
+            correction = "for _ in #{enumerable.source} do"
+          else
+            replacement_range = replacement_range(node,
+                                                  items.loc.expression.end_pos)
+            correction = "for #{variables.source} in #{enumerable.source} do"
+          end
+
+          ->(corrector) { corrector.replace(replacement_range, correction) }
+        end
+
+        def replacement_range(node, end_pos)
+          Parser::Source::Range.new(node.loc.expression.source_buffer,
+                                    node.loc.expression.begin_pos,
+                                    end_pos)
+        end
       end
     end
   end