Module: Attributor::Type::ClassMethods

Defined in:
lib/attributor/type.rb

Instance Method Summary collapse

Instance Method Details

#anonymous? ⇒ Boolean

Returns:



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

def anonymous?
  if @_anonymous.nil?
    name.nil? # if nothing is set, consider it anonymous if the class does not have a name
  else
    @_anonymous
  end
end

#anonymous_type(val = true) ⇒ Object

Allow a type to be marked as if it was anonymous (i.e. not referenceable by name)



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

def anonymous_type(val = true)
  @_anonymous = val
end

#as_json_schema(shallow: false, example: nil, attribute_options: {}) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/attributor/type.rb', line 131

def as_json_schema( shallow: false, example: nil, attribute_options: {} )
  type_name = self.ancestors.find { |k| k.name && !k.name.empty? }.name
  hash = { type: json_schema_type, 'x-type_name': type_name.gsub( Attributor::MODULE_PREFIX_REGEX, '' )}
  # Add a format, if the type has defined
  if hash[:type] == :string && the_format = json_schema_string_format
    hash[:format] = the_format
  end
  # Common options
  hash[:enum] = attribute_options[:values] if attribute_options[:values]
  
  hash
end

#check_option!(name, definition) ⇒ Object

HELPER FUNCTIONS



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/attributor/type.rb', line 72

def check_option!(name, definition)
  case name
  when :min
    raise AttributorException, "Value for option :min does not implement '<='. Got: (#{definition.inspect})" unless definition.respond_to?(:<=)
  when :max
    raise AttributorException, "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, "Value for option :regexp is not a Regexp object. Got (#{definition.inspect})" unless definition.is_a? ::Regexp
  else
    return :unknown
  end

  :ok
end

#compile_dsl(options, block) ⇒ Object

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

Raises:



97
98
99
100
101
102
 
# File 'lib/attributor/type.rb', line 97

def compile_dsl(options, block)
  raise AttributorException, '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)
  sub_definition
end

#constructable? ⇒ Boolean

Does this type support the generation of subtypes?

Returns:



9
10
11
 
# File 'lib/attributor/type.rb', line 9

def constructable?
  false
end

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

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



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/attributor/type.rb', line 105

def describe(_root = false, example: nil)
  type_name = Attributor.type_name(self)
  hash = {
    name: type_name.gsub(Attributor::MODULE_PREFIX_REGEX, ''),
    family: family,
    id: id
  }
  hash[:anonymous] = @_anonymous unless @_anonymous.nil?
  hash[:example] = example if example
  hash
end

#describe_option(option_name, option_value) ⇒ Object 



144
145
146
147
148
149
150
151
 
# File 'lib/attributor/type.rb', line 144

def describe_option( option_name, option_value )
  return case option_name
  when :description
    option_value
  else
    option_value  # By default, describing an option returns the hash with the specification
  end
end

#dsl_compiler ⇒ Object 



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

def dsl_compiler
  DSLCompiler
end

#dump(value, **_opts) ⇒ Object

Generic encoding of the attribute



37
38
39
 
# File 'lib/attributor/type.rb', line 37

def dump(value, **_opts)
  value
end

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

Default, overridable example function

Raises:



66
67
68
 
# File 'lib/attributor/type.rb', line 66

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

#family ⇒ Object 



122
123
124
 
# File 'lib/attributor/type.rb', line 122

def family
  'any'
end

#generate_subcontext(context, subname) ⇒ Object 



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

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

#id ⇒ Object 



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

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

#json_schema_string_format ⇒ Object

Default no format in case it’s a string type



127
128
129
 
# File 'lib/attributor/type.rb', line 127

def json_schema_string_format
  nil
end

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

Generic decoding and coercion of the attribute.



27
28
29
30
31
32
33
34
 
# File 'lib/attributor/type.rb', line 27

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

  value
end

#valid_type?(value) ⇒ Boolean

Default, overridable valid_type? function

Returns:

Raises:



59
60
61
62
63
 
# File 'lib/attributor/type.rb', line 59

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

  raise AttributorException, "#{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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/attributor/type.rb', line 43

def validate(value, context = Attributor::DEFAULT_ROOT_CONTEXT, attribute) # rubocop:disable Style/OptionalArguments
  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