module CustomFields::Types::Default::Target::ClassMethods

Public Instance Methods

apply_custom_field(klass, rule) click to toggle source

Modify the target class according to the rule. By default, it declares the field and a validator if specified by the rule

@param [ Class ] klass The class to modify @param [ Hash ] rule It contains the name of the field and if it is required or not

# File lib/custom_fields/types/default.rb, line 44
def apply_custom_field(klass, rule)
  klass.field rule['name'], localize: rule['localized'] || false, default: rule['default']

  klass.validates_presence_of rule['name'] if rule['required']

  return unless rule['unique']

  klass.validates_uniqueness_of rule['name'],
                                scope: :_type,
                                allow_blank: !rule['required']
end
default_attribute_get(instance, name) click to toggle source

Build a hash storing the formatted (or not) values for a custom field of an instance. Since aliases are accepted, we return a hash. Beside, it is more convenient to use (ex: API). By default, it only returns hash with only one entry whose key is the second parameter and the value the value of the field in the instance given in first parameter.

@param [ Object ] instance An instance of the class enhanced by the custom_fields @param [ String ] name The name of the custom field

@return [ Hash ] field name => formatted value or empty hash if no value

# File lib/custom_fields/types/default.rb, line 69
def default_attribute_get(instance, name)
  if (value = instance.send(name.to_sym)).nil?
    {}
  else
    { name => instance.send(name.to_sym) }
  end
end
default_attribute_set(instance, name, attributes) click to toggle source

Set the value for the instance and the field specified by the 2 params. Since the value can come from different attributes and other params can modify the instance too, we need to pass a hash instead of a single value.

@param [ Object ] instance An instance of the class enhanced by the custom_fields @param [ String ] name The name of the custom field @param [ Hash ] attributes The attributes used to fetch the values

# File lib/custom_fields/types/default.rb, line 87
def default_attribute_set(instance, name, attributes)
  # do not go further if the name is not one of the attributes keys.
  return unless attributes.key?(name)

  # simple assign
  instance.send(:"#{name}=", attributes[name])
end