Sha256: 3defdc6577b97ccb353aa6a7e0c9280da54d91d8b944bb108a1e621ee3c37acf
Contents?: true
Size: 1.64 KB
Versions: 6
Compression:
Stored size: 1.64 KB
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
# 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
Version data entries
6 entries across 6 versions & 1 rubygems