rubbycop 0.49.0

data/lib/rubbycop/cop/style/one_line_conditional.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # TODO: Make configurable.
+      # Checks for uses of if/then/else/end on a single line.
+      class OneLineConditional < Cop
+        include OnNormalIfUnless
+
+        MSG = 'Favor the ternary operator (`?:`) ' \
+              'over `%s/then/else/end` constructs.'.freeze
+
+        def on_normal_if_unless(node)
+          return unless node.single_line? && node.else_branch
+
+          add_offense(node, :expression, format(MSG, node.keyword))
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.source_range, replacement(node))
+          end
+        end
+
+        def replacement(node)
+          return to_ternary(node) unless node.parent
+
+          if %i[and or].include?(node.parent.type)
+            return "(#{to_ternary(node)})"
+          end
+
+          if node.parent.send_type? && operator?(node.parent.method_name)
+            return "(#{to_ternary(node)})"
+          end
+
+          to_ternary(node)
+        end
+
+        def to_ternary(node)
+          cond, body, else_clause = *node
+          "#{expr_replacement(cond)} ? #{expr_replacement(body)} : " \
+            "#{expr_replacement(else_clause)}"
+        end
+
+        def expr_replacement(node)
+          requires_parentheses?(node) ? "(#{node.source})" : node.source
+        end
+
+        def requires_parentheses?(node)
+          return true if %i[and or if].include?(node.type)
+          return true if node.assignment?
+          return true if method_call_with_changed_precedence?(node)
+
+          keyword_with_changed_precedence?(node)
+        end
+
+        def method_call_with_changed_precedence?(node)
+          return false unless node.send_type?
+          return false if node.method_args.empty?
+          return false if parenthesized_call?(node)
+
+          !operator?(node.method_name)
+        end
+
+        def keyword_with_changed_precedence?(node)
+          return false unless node.keyword?
+          return true if node.keyword_not?
+
+          !parenthesized_call?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # 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 = %i[eql? equal?].freeze
+        BLACKLISTED = %i[+@ -@ [] []= << `].freeze
+
+        def_node_matcher :op_method_candidate?, <<-PATTERN
+          (def $_ (args $(arg [!:other !:_other])) _)
+        PATTERN
+
+        def on_def(node)
+          op_method_candidate?(node) do |name, arg|
+            return unless op_method?(name)
+            add_offense(arg, :expression, format(MSG, name))
+          end
+        end
+
+        def op_method?(name)
+          return false if BLACKLISTED.include?(name)
+          name !~ /\A\w/ || OP_LIKE_METHODS.include?(name)
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/style/option_hash.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # This cop checks for options hashes and discourages them if the
+      # current Ruby version supports keyword arguments.
+      #
+      # @example
+      #   Instead of:
+      #
+      #   def fry(options = {})
+      #     temperature = options.fetch(:temperature, 300)
+      #     ...
+      #   end
+      #
+      #   Prefer:
+      #
+      #   def fry(temperature: 300)
+      #     ...
+      #   end
+      class OptionHash < Cop
+        MSG = 'Prefer keyword arguments to options hashes.'.freeze
+
+        def on_args(node)
+          *_but_last, last_arg = *node
+
+          return unless last_arg && last_arg.optarg_type?
+
+          arg, default_value = *last_arg
+
+          return unless default_value.hash_type? && default_value.pairs.empty?
+          return unless suspicious_name?(arg)
+
+          add_offense(last_arg, :expression, MSG)
+        end
+
+        def validate_config
+          return unless target_ruby_version < 2.0
+
+          raise ValidationError, 'The `Style/OptionHash` cop is only ' \
+                                'compatible with Ruby 2.0 and up, but the ' \
+                                'target Ruby version for your project is ' \
+                                "1.9.\nPlease disable this cop or adjust " \
+                                'the `TargetRubyVersion` parameter in your ' \
+                                'configuration.'
+        end
+
+        private
+
+        def suspicious_name?(arg_name)
+          cop_config.key?('SuspiciousParamNames') &&
+            cop_config['SuspiciousParamNames'].include?(arg_name.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/style/optional_arguments.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # This cop checks for optional arguments to methods
+      # that do not come at the end of the argument list
+      #
+      # @example
+      #   # bad
+      #   def foo(a = 1, b, c)
+      #   end
+      #
+      #   # good
+      #   def baz(a, b, c = 1)
+      #   end
+      #
+      #   def foobar(a = 1, b = 2, c = 3)
+      #   end
+      class OptionalArguments < Cop
+        MSG = 'Optional arguments should appear at the end ' \
+              'of the argument list.'.freeze
+
+        def on_def(node)
+          _method, arguments, = *node
+          arguments = *arguments
+
+          each_misplaced_optional_arg(arguments) do |argument|
+            arg, = *argument
+            add_offense(argument, :expression, format(MSG, arg))
+          end
+        end
+
+        private
+
+        def each_misplaced_optional_arg(arguments)
+          optarg_positions, arg_positions = argument_positions(arguments)
+          return if optarg_positions.empty? || arg_positions.empty?
+
+          optarg_positions.each do |optarg_position|
+            # there can only be one group of optional arguments
+            break if optarg_position > arg_positions.max
+
+            yield arguments[optarg_position]
+          end
+        end
+
+        def argument_positions(arguments)
+          optarg_positions = []
+          arg_positions = []
+
+          arguments.each_with_index do |argument, index|
+            optarg_positions << index if argument.optarg_type?
+            arg_positions << index if argument.arg_type?
+          end
+
+          [optarg_positions, arg_positions]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+require 'tsort'
+
+module RubbyCop
+  module Cop
+    module Style
+      # Checks for simple usages of parallel assignment.
+      # This will only complain when the number of variables
+      # being assigned matched the number of assigning variables.
+      #
+      # @example
+      #   # bad
+      #   a, b, c = 1, 2, 3
+      #   a, b, c = [1, 2, 3]
+      #
+      #   # good
+      #   one, two = *foo
+      #   a, b = foo()
+      #   a, b = b, a
+      #
+      #   a = 1
+      #   b = 2
+      #   c = 3
+      class ParallelAssignment < Cop
+        include RescueNode
+
+        MSG = 'Do not use parallel assignment.'.freeze
+
+        def on_masgn(node)
+          lhs, rhs = *node
+          lhs_elements = *lhs
+          rhs_elements = [*rhs].compact # edge case for one constant
+
+          return if allowed_lhs?(lhs) || allowed_rhs?(rhs) ||
+                    allowed_masign?(lhs_elements, rhs_elements)
+
+          add_offense(node, :expression)
+        end
+
+        private
+
+        def allowed_masign?(lhs_elements, rhs_elements)
+          lhs_elements.size != rhs_elements.size ||
+            !find_valid_order(lhs_elements,
+                              add_self_to_getters(rhs_elements))
+        end
+
+        def allowed_lhs?(node)
+          elements = *node
+
+          # Account for edge cases using one variable with a comma
+          # E.g.: `foo, = *bar`
+          elements.one? || elements.any?(&:splat_type?)
+        end
+
+        def allowed_rhs?(node)
+          # Edge case for one constant
+          elements = [*node].compact
+
+          # Account for edge case of `Constant::CONSTANT`
+          !node.array_type? ||
+            return_of_method_call?(node) ||
+            elements.any?(&:splat_type?)
+        end
+
+        def return_of_method_call?(node)
+          node.block_type? || node.send_type?
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            left, right = *node
+            left_elements = *left
+            right_elements = [*right].compact
+            order = find_valid_order(left_elements, right_elements)
+            correction = assignment_corrector(node, order)
+
+            corrector.replace(correction.correction_range,
+                              correction.correction)
+          end
+        end
+
+        def assignment_corrector(node, order)
+          _assignment, modifier = *node.parent
+          if modifier_statement?(node.parent)
+            ModifierCorrector.new(node, config, order)
+          elsif rescue_modifier?(modifier)
+            RescueCorrector.new(node, config, order)
+          else
+            GenericCorrector.new(node, config, order)
+          end
+        end
+
+        def find_valid_order(left_elements, right_elements)
+          # arrange left_elements in an order such that no corresponding right
+          # element refers to a left element earlier in the sequence
+          # this can be done using an algorithm called a "topological sort"
+          # fortunately for us, Ruby's stdlib contains an implementation
+          assignments = left_elements.zip(right_elements)
+
+          begin
+            AssignmentSorter.new(assignments).tsort
+          rescue TSort::Cyclic
+            nil
+          end
+        end
+
+        # Converts (send nil :something) nodes to (send (:self) :something).
+        # This makes the sorting algorithm work for expressions such as
+        # `self.a, self.b = b, a`.
+        def add_self_to_getters(right_elements)
+          right_elements.map do |e|
+            implicit_self_getter?(e) { |var| s(:send, s(:self), var) } || e
+          end
+        end
+
+        def_node_matcher :implicit_self_getter?, '(send nil $_)'
+
+        # Helper class necessitated by silly design of TSort prior to Ruby 2.1
+        # Newer versions have a better API, but that doesn't help us
+        class AssignmentSorter
+          include TSort
+          extend RubbyCop::NodePattern::Macros
+
+          def_node_matcher :var_name, '{(casgn _ $_) (_ $_)}'
+          def_node_search :uses_var?, '{({lvar ivar cvar gvar} %) (const _ %)}'
+          def_node_search :matching_calls, '(send %1 %2 $...)'
+
+          def initialize(assignments)
+            @assignments = assignments
+          end
+
+          def tsort_each_node
+            @assignments.each { |a| yield a }
+          end
+
+          def tsort_each_child(assignment)
+            # yield all the assignments which must come after `assignment`
+            # (due to dependencies on the previous value of the assigned var)
+            my_lhs, _my_rhs = *assignment
+
+            @assignments.each do |other|
+              _other_lhs, other_rhs = *other
+
+              next unless dependency?(my_lhs, other_rhs)
+
+              yield other
+            end
+          end
+
+          def dependency?(lhs, rhs)
+            uses_var?(rhs, var_name(lhs)) ||
+              lhs.send_type? && lhs.assignment_method? && accesses?(rhs, lhs)
+          end
+
+          # `lhs` is an assignment method call like `obj.attr=` or `ary[idx]=`.
+          # Does `rhs` access the same value which is assigned by `lhs`?
+          def accesses?(rhs, lhs)
+            if lhs.method?(:[]=)
+              matching_calls(rhs, lhs.receiver, :[]).any? do |args|
+                args == lhs.method_args
+              end
+            else
+              access_method = lhs.method_name.to_s.chop.to_sym
+              matching_calls(rhs, lhs.receiver, access_method).any?
+            end
+          end
+        end
+
+        def modifier_statement?(node)
+          node && %i[if while until].include?(node.type) && node.modifier_form?
+        end
+
+        # An internal class for correcting parallel assignment
+        class GenericCorrector
+          include AutocorrectAlignment
+
+          attr_reader :config, :node
+
+          def initialize(node, config, new_elements)
+            @node = node
+            @config = config
+            @new_elements = new_elements
+          end
+
+          def correction
+            assignment.join("\n#{offset(node)}")
+          end
+
+          def correction_range
+            node.source_range
+          end
+
+          protected
+
+          def assignment
+            @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
+
+          def cop_config
+            @config.for_cop('Style/ParallelAssignment')
+          end
+        end
+
+        # An internal class for correcting parallel assignment
+        # protected by rescue
+        class RescueCorrector < GenericCorrector
+          def correction
+            _node, rescue_clause = *node.parent
+            _, _, rescue_result = *rescue_clause
+
+            # If the parallel assignment uses a rescue modifier and it is the
+            # only contents of a method, then we want to make use of the
+            # implicit begin
+            if node.parent.parent && node.parent.parent.def_type?
+              super + def_correction(rescue_result)
+            else
+              begin_correction(rescue_result)
+            end
+          end
+
+          def correction_range
+            node.parent.source_range
+          end
+
+          private
+
+          def def_correction(rescue_result)
+            "\nrescue" \
+              "\n#{offset(node)}#{rescue_result.source}"
+          end
+
+          def begin_correction(rescue_result)
+            "begin\n" \
+              "#{indentation(node)}" \
+              "#{assignment.join("\n#{indentation(node)}")}" \
+              "\n#{offset(node)}rescue\n" \
+              "#{indentation(node)}#{rescue_result.source}" \
+              "\n#{offset(node)}end"
+          end
+        end
+
+        # An internal class for correcting parallel assignment
+        # guarded by if, unless, while, or until
+        class ModifierCorrector < GenericCorrector
+          def correction
+            parent = node.parent
+
+            "#{modifier_range(parent).source}\n" \
+              "#{indentation(node)}" \
+              "#{assignment.join("\n#{indentation(node)}")}" \
+              "\n#{offset(node)}end"
+          end
+
+          def correction_range
+            node.parent.source_range
+          end
+
+          private
+
+          def modifier_range(node)
+            Parser::Source::Range.new(node.source_range.source_buffer,
+                                      node.loc.keyword.begin_pos,
+                                      node.source_range.end_pos)
+          end
+        end
+      end
+    end
+  end
+end