Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # This cop checks for options hashes and discourages them if the
      # current Ruby version supports keyword arguments.
      #
      # @example
      #
      #   # bad
      #   def fry(options = {})
      #     temperature = options.fetch(:temperature, 300)
      #     # ...
      #   end
      #
      #
      #   # good
      #   def fry(temperature: 300)
      #     # ...
      #   end
      class OptionHash < Cop
        MSG = 'Prefer keyword arguments to options hashes.'.freeze

        def_node_matcher :option_hash, <<-PATTERN
          (args ... $(optarg [#suspicious_name? _] (hash)))
        PATTERN

        def on_args(node)
          return if super_used?(node)
          return if whitelist.include?(node.parent.method_name.to_s)

          option_hash(node) do |options|
            add_offense(options)
          end
        end

        private

        def whitelist
          cop_config['Whitelist'] || []
        end

        def suspicious_name?(arg_name)
          cop_config.key?('SuspiciousParamNames') &&
            cop_config['SuspiciousParamNames'].include?(arg_name.to_s)
        end

        def super_used?(node)
          node.parent.each_node(:zsuper).any?
        end
      end
    end
  end
end

Version data entries

6,763 entries across 6,759 versions & 23 rubygems

Version	Path
rubocop-0.67.1	lib/rubocop/cop/style/option_hash.rb
rubocop-0.67.0	lib/rubocop/cop/style/option_hash.rb
rubocop-0.66.0	lib/rubocop/cop/style/option_hash.rb