rubocop 0.41.2 → 0.42.0

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

@@ -4,15 +4,23 @@
 module RuboCop
   module Cop
     module Style
-      # This cop makes sure that certain operator methods have their sole
-      # parameter named `other`.
+      # This cop makes sure that certain binary operator methods have their
+      # sole  parameter named `other`.
+      #
+      # @example
+      #
+      #   # bad
+      #   def +(amount); end
+      #
+      #   # good
+      #   def +(other); end
       class OpMethod < Cop
         MSG = 'When defining the `%s` operator, ' \
               'name its argument `other`.'.freeze
 
         OP_LIKE_METHODS = [:eql?, :equal?].freeze
 
-        BLACKLISTED = [:+@, :-@, :[], :[]=, :<<].freeze
+        BLACKLISTED = [:+@, :-@, :[], :[]=, :<<, :`].freeze
 
         TARGET_ARGS = [s(:args, s(:arg, :other)),
                        s(:args, s(:arg, :_other))].freeze
@@ -20,7 +28,7 @@ module RuboCop
         def on_def(node)
           name, args, _body = *node
           return unless op_method?(name) &&
-                        args.children.size == 1 &&
+                        args.children.one? &&
                         !TARGET_ARGS.include?(args)
 
           add_offense(args.children[0], :expression, format(MSG, name))

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

@@ -179,13 +179,21 @@ module RuboCop
           protected
 
           def assignment
-            @new_elements.map do |lhs, rhs|
-              "#{lhs.source} = #{rhs.source}"
-            end
+            @new_elements.map { |lhs, rhs| "#{lhs.source} = #{source(rhs)}" }
           end
 
           private
 
+          def source(node)
+            if node.str_type? && node.loc.begin.nil?
+              "'#{node.source}'"
+            elsif node.sym_type? && node.loc.begin.nil?
+              ":#{node.source}"
+            else
+              node.source
+            end
+          end
+
           def extract_sources(node)
             node.children.map(&:source)
           end

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

@@ -58,14 +58,17 @@ module RuboCop
 
         def check(node)
           end_loc = ancestor_node(node).loc.end
-          return if end_loc.column == node.loc.keyword.column
-          return if end_loc.line == node.loc.keyword.line
-
           kw_loc = node.loc.keyword
 
-          add_offense(node, kw_loc,
-                      format(MSG, kw_loc.source, kw_loc.line, kw_loc.column,
-                             end_loc.line, end_loc.column))
+          return if end_loc.column == kw_loc.column
+          return if end_loc.line == kw_loc.line
+
+          add_offense(node, kw_loc, format_message(kw_loc, end_loc))
+        end
+
+        def format_message(kw_loc, end_loc)
+          format(MSG, kw_loc.source, kw_loc.line, kw_loc.column, end_loc.line,
+                 end_loc.column)
         end
 
         def modifier?(node)

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

@@ -12,7 +12,7 @@ module RuboCop
       class SingleLineBlockParams < Cop
         def on_block(node)
           # we care only for single line blocks
-          return unless block_length(node) == 0
+          return unless block_length(node).zero?
 
           method_node, args_node, _body_node = *node
           receiver, method_name, _method_args = *method_node
@@ -21,9 +21,10 @@ module RuboCop
           return unless receiver
           return unless method_names.include?(method_name)
 
-          # discard cases with argument destructuring
           args = *args_node
 
+          return if args.empty?
+          # discard cases with argument destructuring
           return true unless args.all? { |n| n.type == :arg }
           return if args_match?(method_name, args)
 

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

@@ -70,7 +70,7 @@ module RuboCop
             space_inside_left_brace(left_brace, args_delimiter, sb)
           end
 
-          if inner =~ /\S$/ && block_length(node) == 0
+          if inner =~ /\S$/ && block_length(node).zero?
             no_space(sb, right_brace.begin_pos, right_brace.end_pos,
                      'Space missing inside }.')
           else

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

@@ -40,7 +40,7 @@ module RuboCop
         private
 
         def autocorrect(node)
-          new_source = (style == :no_space) ? node.source : " #{node.source} "
+          new_source = style == :no_space ? node.source : " #{node.source} "
           lambda do |corrector|
             corrector.replace(range_with_surrounding_space(node.source_range),
                               new_source)

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

@@ -76,23 +76,31 @@ module RuboCop
         def autocorrect(node)
           syms = node.children.map { |c| c.children[0].to_s }
           corrected = if style == :percent
-                        escape = syms.any? { |s| needs_escaping?(s) }
-                        syms = syms.map { |s| escape_string(s) } if escape
-                        syms = syms.map { |s| s.gsub(/\)/, '\\)') }
-                        if escape
-                          "%I(#{syms.join(' ')})"
-                        else
-                          "%i(#{syms.join(' ')})"
-                        end
+                        percent_replacement(syms)
                       else
-                        syms = syms.map { |s| to_symbol_literal(s) }
-                        "[#{syms.join(', ')}]"
+                        bracket_replacement(syms)
                       end
 
           lambda do |corrector|
             corrector.replace(node.source_range, corrected)
           end
         end
+
+        def percent_replacement(syms)
+          escape = syms.any? { |s| needs_escaping?(s) }
+          syms = syms.map { |s| escape_string(s) } if escape
+          syms = syms.map { |s| s.gsub(/\)/, '\\)') }
+          if escape
+            "%I(#{syms.join(' ')})"
+          else
+            "%i(#{syms.join(' ')})"
+          end
+        end
+
+        def bracket_replacement(syms)
+          syms = syms.map { |s| to_symbol_literal(s) }
+          "[#{syms.join(', ')}]"
+        end
       end
     end
   end

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

@@ -0,0 +1,94 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for the presence of arentheses around ternary
+      # conditions. It is configurable to enforce inclusion or omission of
+      # parentheses using `EnforcedStyle`.
+      #
+      # @example
+      #
+      #   EnforcedStyle: require_no_parentheses (deafault)
+      #
+      #   @bad
+      #   foo = (bar?) ? a : b
+      #   foo = (bar.baz) ? a : b
+      #   foo = (bar && baz) ? a : b
+      #
+      #   @good
+      #   foo = bar? ? a : b
+      #   foo = bar.baz? ? a : b
+      #   foo = bar && baz ? a : b
+      #
+      # @example
+      #
+      #   EnforcedStyle: require_parentheses
+      #
+      #   @bad
+      #   foo = bar? ? a : b
+      #   foo = bar.baz? ? a : b
+      #   foo = bar && baz ? a : b
+      #
+      #   @good
+      #   foo = (bar?) ? a : b
+      #   foo = (bar.baz) ? a : b
+      #   foo = (bar && baz) ? a : b
+      class TernaryParentheses < Cop
+        include IfNode
+        include SafeAssignment
+        include ConfigurableEnforcedStyle
+
+        MSG = '%s parentheses for ternary conditions.'.freeze
+
+        def on_if(node)
+          return unless ternary?(node)
+
+          add_offense(node, node.source_range, message) if offense?(node)
+        end
+
+        private
+
+        def offense?(node)
+          condition, = *node
+
+          (require_parentheses? && !parenthesized?(condition) ||
+            !require_parentheses? && parenthesized?(condition)) &&
+            !(safe_assignment?(condition) && safe_assignment_allowed?)
+        end
+
+        def autocorrect(node)
+          condition, = *node
+
+          lambda do |corrector|
+            if require_parentheses?
+              corrector.insert_before(condition.source_range, '(')
+              corrector.insert_after(condition.source_range, ')')
+            else
+              # Don't correct if it's a safe assignment
+              unless safe_assignment?(condition)
+                corrector.remove(condition.loc.begin)
+                corrector.remove(condition.loc.end)
+              end
+            end
+          end
+        end
+
+        def message
+          verb = require_parentheses? ? 'Use' : 'Omit'
+
+          format(MSG, verb)
+        end
+
+        def require_parentheses?
+          style == :require_parentheses
+        end
+
+        def parenthesized?(node)
+          node.source =~ /^\(.*\)$/
+        end
+      end
+    end
+  end
+end

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

@@ -60,7 +60,7 @@ module RuboCop
           when 0
             'Trailing blank line missing.'
           else
-            instead_of = if wanted_blank_lines == 0
+            instead_of = if wanted_blank_lines.zero?
                            ''
                          else
                            "instead of #{wanted_blank_lines} "

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

@@ -16,6 +16,7 @@ module RuboCop
         PERCENT_Q = '%q'.freeze
         PERCENT_CAPITAL_Q = '%Q'.freeze
         STRING_INTERPOLATION_REGEXP = /#\{.+}/
+        ESCAPED_NON_BACKSLASH = /\\[^\\]/
 
         def on_dstr(node)
           check(node)
@@ -35,12 +36,9 @@ module RuboCop
           src = node.source
           return unless start_with_percent_q_variant?(src)
           return if src.include?(SINGLE_QUOTE) && src.include?(QUOTE)
-          if src.start_with?(PERCENT_Q) && src =~ STRING_INTERPOLATION_REGEXP
-            return
-          end
-          if src.start_with?(PERCENT_CAPITAL_Q) && acceptable_capital_q?(node)
-            return
-          end
+          return if src.start_with?(PERCENT_Q) && acceptable_q?(node)
+          return if src.start_with?(PERCENT_CAPITAL_Q) &&
+                    acceptable_capital_q?(node)
 
           add_offense(node, :expression)
         end
@@ -73,6 +71,14 @@ module RuboCop
           string.start_with?(PERCENT_Q, PERCENT_CAPITAL_Q)
         end
 
+        def acceptable_q?(node)
+          src = node.source
+
+          return true if src =~ STRING_INTERPOLATION_REGEXP
+
+          src.scan(/\\./).any? { |s| s =~ ESCAPED_NON_BACKSLASH }
+        end
+
         def acceptable_capital_q?(node)
           src = node.source
           src.include?(QUOTE) &&

data/lib/rubocop/cop/util.rb

@@ -95,7 +95,7 @@ module RuboCop
           column_index = column
         end
 
-        line_begin_pos = if line_number == 0
+        line_begin_pos = if line_number.zero?
                            0
                          else
                            source_buffer.line_range(line_number).begin_pos

data/lib/rubocop/cop/variable_force/assignment.rb

@@ -79,7 +79,7 @@ module RuboCop
         def operator_assignment_node
           return nil unless node.parent
           return nil unless OPERATOR_ASSIGNMENT_TYPES.include?(node.parent.type)
-          return nil unless node.parent.children.index(node) == 0
+          return nil unless node.sibling_index.zero?
           node.parent
         end
 

data/lib/rubocop/cop/variable_force/locatable.rb

@@ -124,7 +124,7 @@ module RuboCop
         end
 
         def rescue_body_name
-          if body_index == 0
+          if body_index.zero?
             'main'
           elsif branch_body_node.type == :resbody
             "rescue#{body_index - 1}"

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -60,6 +60,8 @@ module RuboCop
              "#{output.path}` in a .rubocop.yml file."
       end
 
+      private
+
       def command
         command = 'rubocop --auto-gen-config'
         if @exclude_limit_option
@@ -89,14 +91,22 @@ module RuboCop
           output.puts '# Cop supports --auto-correct.'
         end
 
-        default_cfg = RuboCop::ConfigLoader.default_configuration[cop_name]
+        default_cfg = default_config(cop_name)
         return unless default_cfg
 
-        params = default_cfg.keys -
-                 %w(Description StyleGuide Reference Enabled Exclude) -
-                 cfg.keys
+        params = cop_config_params(default_cfg, cfg)
         return if params.empty?
 
+        output_cop_param_comments(params, default_cfg)
+      end
+
+      def cop_config_params(default_cfg, cfg)
+        default_cfg.keys -
+          %w(Description StyleGuide Reference Enabled Exclude) -
+          cfg.keys
+      end
+
+      def output_cop_param_comments(params, default_cfg)
         output.puts "# Configuration parameters: #{params.join(', ')}."
 
         params.each do |param|
@@ -108,6 +118,10 @@ module RuboCop
         end
       end
 
+      def default_config(cop_name)
+        RuboCop::ConfigLoader.default_configuration[cop_name]
+      end
+
       def output_cop_config(output, cfg, cop_name)
         # 'Enabled' option will be put into file only if exclude
         # limit is exceeded.
@@ -156,9 +170,6 @@ module RuboCop
             output.puts "    - '#{file}'"
           end
         end
-      rescue LoadError
-        # Fallback to Enabled: false for Ruby < 1.9.3
-        output.puts '  Enabled: false'
       end
     end
   end

data/lib/rubocop/formatter/html_formatter.rb

@@ -94,20 +94,34 @@ module RuboCop
         end
 
         def highlighted_source_line(offense)
-          location = offense.location
-          source_line = location.source_line
-
-          escape(source_line[0...offense.highlighted_area.begin_pos]) +
-            "<span class=\"highlight #{offense.severity}\">" +
-            escape(offense.highlighted_area.source) +
-            '</span>' +
-            escape(source_line[offense.highlighted_area.end_pos..-1]) +
-            (location.first_line == location.last_line ? '' : " #{ELLIPSES}")
+          source_before_highlight(offense) +
+            hightlight_source_tag(offense) +
+            source_after_highlight(offense) +
+            possible_ellipses(offense.location)
+        end
+
+        def hightlight_source_tag(offense)
+          "<span class=\"highlight #{offense.severity}\">" \
+            "#{escape(offense.highlighted_area.source)}" \
+            '</span>'
+        end
+
+        def source_before_highlight(offense)
+          source_line = offense.location.source_line
+          escape(source_line[0...offense.highlighted_area.begin_pos])
+        end
+
+        def source_after_highlight(offense)
+          source_line = offense.location.source_line
+          escape(source_line[offense.highlighted_area.end_pos..-1])
+        end
+
+        def possible_ellipses(location)
+          location.first_line == location.last_line ? '' : " #{ELLIPSES}"
         end
 
         def escape(s)
-          # Single quotes not escaped in Ruby 1.9, so add extra substitution.
-          CGI.escapeHTML(s).gsub(/'/, '&#39;')
+          CGI.escapeHTML(s)
         end
 
         def base64_encoded_logo_image

data/lib/rubocop/formatter/text_util.rb

@@ -8,7 +8,7 @@ module RuboCop
       module_function
 
       def pluralize(number, thing, options = {})
-        if number == 0 && options[:no_for_zero]
+        if number.zero? && options[:no_for_zero]
           "no #{thing}s"
         elsif number == 1
           "1 #{thing}"