module T::Props::Optional::DecoratorMethods

NB: This must stay in the same file where T::Props::Optional is defined due to T::Props::Decorator#apply_plugin; see git.corp.stripe.com/stripe-internal/pay-server/blob/fc7f15593b49875f2d0499ffecfd19798bac05b3/chalk/odm/lib/chalk-odm/document_decorator.rb#L716-L717

Constants

DEFAULT_SETTER_RULE_KEY
VALID_RULE_KEYS

Attributes

props_with_defaults[R]
props_without_defaults[R]

Public Instance Methods

add_prop_definition(prop, rules) click to toggle source
Calls superclass method
# File lib/types/props/optional.rb, line 45
def add_prop_definition(prop, rules)
  compute_derived_rules(rules)

  default_setter = T::Props::Private::ApplyDefault.for(decorated_class, rules)
  if default_setter
    @props_with_defaults ||= {}
    @props_with_defaults[prop] = default_setter
    @props_without_defaults&.delete(prop) # Handle potential override

    rules[DEFAULT_SETTER_RULE_KEY] = default_setter
  else
    @props_without_defaults ||= {}
    @props_without_defaults[prop] = rules.fetch(:setter_proc)
    @props_with_defaults&.delete(prop) # Handle potential override
  end

  super
end
compute_derived_rules(rules) click to toggle source
# File lib/types/props/optional.rb, line 32
def compute_derived_rules(rules)
  rules[:fully_optional] = !T::Props::Utils.need_nil_write_check?(rules)
  rules[:need_nil_read_check] = T::Props::Utils.need_nil_read_check?(rules)
end
get_default(rules, instance_class) click to toggle source
# File lib/types/props/optional.rb, line 78
def get_default(rules, instance_class)
  rules[DEFAULT_SETTER_RULE_KEY]&.default
end
has_default?(rules) click to toggle source
# File lib/types/props/optional.rb, line 74
def has_default?(rules)
  rules.include?(DEFAULT_SETTER_RULE_KEY)
end
prop_optional?(prop) click to toggle source
# File lib/types/props/optional.rb, line 28
def prop_optional?(prop)
  prop_rules(prop)[:fully_optional]
end
prop_validate_definition!(name, cls, rules, type) click to toggle source
Calls superclass method
# File lib/types/props/optional.rb, line 64
def prop_validate_definition!(name, cls, rules, type)
  result = super

  if rules.key?(:default) && rules.key?(:factory)
    raise ArgumentError.new("Setting both :default and :factory is invalid. See: go/chalk-docs")
  end

  result
end
valid_rule_key?(key) click to toggle source
Calls superclass method
# File lib/types/props/optional.rb, line 24
def valid_rule_key?(key)
  super || VALID_RULE_KEYS[key]
end