Module: Attributor::Type::ClassMethods

Defined in:
lib/attributor/type.rb

Instance Method Summary collapse

Instance Method Details

#check_option!(name, definition) ⇒ Object


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/attributor/type.rb', line 66

def check_option!(name, definition)
  case name
  when :min
    raise AttributorException.new("Value for option :min does not implement '<='. Got: (#{definition.inspect})") unless definition.respond_to?(:<=)
  when :max
    raise AttributorException.new("Value for option :max does not implement '>='. Got(#{definition.inspect})") unless definition.respond_to?(:>=)
  when :regexp
    # could go for a respoind_to? :=~ here, but that seems overly... cute... and not useful.
    raise AttributorException.new("Value for option :regexp is not a Regexp object. Got (#{definition.inspect})") unless definition.is_a? ::Regexp
  else
    return :unknown
  end

  return :ok
end

#compile_dsl(options, block) ⇒ Object

By default, non complex types will not have a DSL subdefinition this handles such case


92
93
94
95
96
97
# File 'lib/attributor/type.rb', line 92

def compile_dsl( options, block )
  raise AttributorException.new("Basic structures cannot take extra block definitions") if block
  # Simply create a DSL compiler to store the options, and not to parse any DSL
  sub_definition=dsl_compiler.new( options )
  return sub_definition
end

#constructable?Boolean

Does this type support the generation of subtypes?

Returns:


14
15
16
# File 'lib/attributor/type.rb', line 14

def constructable?
  false
end

#describe(root = false, example: nil) ⇒ Object

Default describe for simple types…only their name (stripping the base attributor module)


100
101
102
103
104
105
106
107
108
109
# File 'lib/attributor/type.rb', line 100

def describe(root=false, example: nil)
  type_name = Attributor.type_name(self)
  hash = {
    name: type_name.gsub(Attributor::MODULE_PREFIX_REGEX, ''),
    family: self.family,
    id: self.id
  }
  hash[:example] = example if example
  hash
end

#dsl_compilerObject


87
88
89
# File 'lib/attributor/type.rb', line 87

def dsl_compiler
  DSLCompiler
end

#dump(value, **opts) ⇒ Object

Generic encoding of the attribute


29
30
31
# File 'lib/attributor/type.rb', line 29

def dump(value,**opts)
  value
end

#example(context = nil, options: {}) ⇒ Object

Default, overridable example function


58
59
60
# File 'lib/attributor/type.rb', line 58

def example(context=nil, options:{})
  raise AttributorException.new("#{self} must implement #example")
end

#familyObject


116
117
118
# File 'lib/attributor/type.rb', line 116

def family
  'any'
end

#generate_subcontext(context, subname) ⇒ Object


83
84
85
# File 'lib/attributor/type.rb', line 83

def generate_subcontext(context, subname)
  context + [subname]
end

#idObject


111
112
113
114
# File 'lib/attributor/type.rb', line 111

def id
  return nil if self.name.nil?
  self.name.gsub('::'.freeze,'-'.freeze)
end

#load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **options) ⇒ Object

Generic decoding and coercion of the attribute.


19
20
21
22
23
24
25
26
# File 'lib/attributor/type.rb', line 19

def load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
  return nil if value.nil?
  unless value.is_a?(self.native_type)
    raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
  end

  value
end

#valid_type?(value) ⇒ Boolean

Default, overridable valid_type? function

Returns:

Raises:


51
52
53
54
55
# File 'lib/attributor/type.rb', line 51

def valid_type?(value)
  return value.is_a?(native_type) if respond_to?(:native_type)

  raise AttributorException.new("#{self} must implement #valid_type? or #native_type")
end

#validate(value, context = Attributor::DEFAULT_ROOT_CONTEXT, attribute) ⇒ Object

TODO: refactor this to take just the options instead of the full attribute? TODO: delegate to subclass


35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/attributor/type.rb', line 35

def validate(value,context=Attributor::DEFAULT_ROOT_CONTEXT,attribute)
  errors = []
  attribute.options.each do |option, opt_definition|
    case option
    when :max
      errors << "#{Attributor.humanize_context(context)} value (#{value}) is larger than the allowed max (#{opt_definition.inspect})" unless value <= opt_definition
    when :min
      errors << "#{Attributor.humanize_context(context)} value (#{value}) is smaller than the allowed min (#{opt_definition.inspect})" unless value >= opt_definition
    when :regexp
      errors << "#{Attributor.humanize_context(context)} value (#{value}) does not match regexp (#{opt_definition.inspect})"  unless value =~ opt_definition
    end
  end
  errors
end