Sha256: cc4b161c35d2ad8f5ab517c5c9a6f572e82c0bd1cba7e44a988e14e56f9e4f32

Contents?: true

Size: 1.46 KB

Versions: 17

Compression:

Stored size: 1.46 KB

Contents

# frozen_string_literal: true

module RuboCop
  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 < Base
        MSG = 'Optional arguments should appear at the end of the argument list.'

        def on_def(node)
          each_misplaced_optional_arg(node.arguments) { |argument| add_offense(argument) }
        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

Version data entries

17 entries across 17 versions & 3 rubygems

Version Path
rubocop-1.21.0 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.20.0 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.19.1 lib/rubocop/cop/style/optional_arguments.rb
rails_mini_profiler-0.2.0 vendor/bundle/ruby/3.0.0/gems/rubocop-1.18.3/lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.19.0 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.18.4 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.18.3 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.18.2 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.18.1 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.18.0 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.17.0 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.16.1 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.16.0 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.15.0 lib/rubocop/cop/style/optional_arguments.rb
cocRb-0.1.0 .bundle/ruby/3.0.0/gems/rubocop-1.14.0/lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.14.0 lib/rubocop/cop/style/optional_arguments.rb
rubocop-1.13.0 lib/rubocop/cop/style/optional_arguments.rb