module Attributor::Type::ClassMethods
Public Instance Methods
anonymous?()
click to toggle source
# File lib/attributor/type.rb, line 73 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)
click to toggle source
Allow a type to be marked as if it was anonymous (i.e. not referenceable by name)
# File lib/attributor/type.rb, line 69 def anonymous_type(val = true) @_anonymous = val end
as_json_schema( shallow: false, example: nil, attribute_options: {} )
click to toggle source
# File lib/attributor/type.rb, line 186 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)
click to toggle source
HELPER FUNCTIONS
# File lib/attributor/type.rb, line 127 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)
click to toggle source
By default, non complex types will not have a DSL subdefinition this handles such case
# File lib/attributor/type.rb, line 152 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?()
click to toggle source
Does this type support the generation of subtypes?
# File lib/attributor/type.rb, line 64 def constructable? false end
describe(_root = false, example: nil)
click to toggle source
Default describe for simple types…only their name (stripping the base attributor module)
# File lib/attributor/type.rb, line 160 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 )
click to toggle source
# File lib/attributor/type.rb, line 199 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()
click to toggle source
# File lib/attributor/type.rb, line 147 def dsl_compiler DSLCompiler end
dump(value, **_opts)
click to toggle source
Generic encoding of the attribute
# File lib/attributor/type.rb, line 92 def dump(value, **_opts) value end
example(_context = nil, options: {})
click to toggle source
Default, overridable example function
# File lib/attributor/type.rb, line 121 def example(_context = nil, options: {}) raise AttributorException, "#{self} must implement #example" end
family()
click to toggle source
# File lib/attributor/type.rb, line 177 def family 'any' end
generate_subcontext(context, subname)
click to toggle source
# File lib/attributor/type.rb, line 143 def generate_subcontext(context, subname) context + [subname] end
id()
click to toggle source
# File lib/attributor/type.rb, line 172 def id return nil if name.nil? name.gsub('::'.freeze, '-'.freeze) end
json_schema_string_format()
click to toggle source
Default no format in case it’s a string type
# File lib/attributor/type.rb, line 182 def json_schema_string_format nil end
load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
click to toggle source
Generic decoding and coercion of the attribute.
# File lib/attributor/type.rb, line 82 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
options()
click to toggle source
# File lib/attributor/type.rb, line 207 def options {} end
valid_type?(value)
click to toggle source
Default, overridable valid_type? function
# File lib/attributor/type.rb, line 114 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)
click to toggle source
TODO: refactor this to take just the options instead of the full attribute? TODO: delegate to subclass
# File lib/attributor/type.rb, line 98 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