module FamilySearch::Gedcomx::SuperCoercion::ClassMethods

Public Instance Methods

coerce_key(*attrs) click to toggle source

Set up a coercion rule such that any time the specified key is set it will be coerced into the specified class. Coercion will occur by first attempting to call Class.coerce and then by calling Class.new with the value as an argument in either case.

@param [Object] key the key or array of keys you would like to be coerced. @param [Class] into the class into which you want the key(s) coerced.

@example Coerce a “user” subhash into a User object

class Tweet < Hash
  include FamilySearch::Gedcomx::SuperCoercion
  coerce_key :user, User
  coerce_key :tags, [Tag]
end
# File lib/familysearch/gedcomx/super_coercion.rb, line 102
def coerce_key(*attrs)
  @key_coercions ||= {}
  into = attrs.pop
  attrs.each { |key| @key_coercions[key] = into }
  if defined? @subclasses
    @subclasses.each { |klass| klass.coerce_key(attrs) }
  end
end
Also aliased as: coerce_keys
coerce_keys(*attrs)
Alias for: coerce_key
coerce_value(from, into, options = {}) click to toggle source

Set up a coercion rule such that any time a value of the specified type is set it will be coerced into the specified class.

@param [Class] from the type you would like coerced. @param [Class] into the class into which you would like the value coerced. @option options [Boolean] :strict (true) whether use exact source class only or include ancestors

@example Coerce all hashes into this special type of hash

class SpecialHash < Hash
  include FamilySearch::Gedcomx::SuperCoercion
  coerce_value Hash, SpecialHash

  def initialize(hash = {})
    super
    hash.each_pair do |k,v|
      self[k] = v
    end
  end
end
# File lib/familysearch/gedcomx/super_coercion.rb, line 152
def coerce_value(from, into, options = {})
  options = {:strict => true}.merge(options)

  if options[:strict]
    (@strict_value_coercions ||= {})[from] = into
  else
    while from.superclass && from.superclass != Object
      (@lenient_value_coercions ||= {})[from] = into
      from = from.superclass
    end
  end
  if defined? @subclasses
    @subclasses.each { |klass| klass.coerce_value(from,into,options) }
  end
end
inherited(klass) click to toggle source
Calls superclass method
# File lib/familysearch/gedcomx/super_coercion.rb, line 124
def inherited(klass)
  super
  (@subclasses ||= Set.new) << klass
  klass.instance_variable_set('@key_coercions', self.key_coercions.dup)
  klass.instance_variable_set('@lenient_value_coercions', self.lenient_value_coercions.dup)
  klass.instance_variable_set('@strict_value_coercions', self.strict_value_coercions.dup)
end
key_coercion(key) click to toggle source

Returns the specific key coercion for the specified key, if one exists.

# File lib/familysearch/gedcomx/super_coercion.rb, line 120
def key_coercion(key)
  key_coercions[key.to_sym]
end
key_coercions() click to toggle source

Returns a hash of any existing key coercions.

# File lib/familysearch/gedcomx/super_coercion.rb, line 114
def key_coercions
  @key_coercions || {}
end
lenient_value_coercions() click to toggle source

Return all value coercions that have the :strict rule as false.

# File lib/familysearch/gedcomx/super_coercion.rb, line 171
def lenient_value_coercions; @value_coercions || {} end
strict_value_coercions() click to toggle source

Return all value coercions that have the :strict rule as true.

# File lib/familysearch/gedcomx/super_coercion.rb, line 169
def strict_value_coercions; @strict_value_coercions || {} end
value_coercion(value) click to toggle source

Fetch the value coercion, if any, for the specified object.

# File lib/familysearch/gedcomx/super_coercion.rb, line 174
def value_coercion(value)
  from = value.class
  strict_value_coercions[from] || lenient_value_coercions[from]
end