Class: Restspec::Schema::Types::BasicType

Inherits:
Object
  • Object
show all
Defined in:
lib/restspec/schema/types/basic_type.rb

Overview

This is the parent class for all the Types used in the schemas definition. The two main reasons of the inheritance over simple duck typing are:

  1. To force the usage of example_options and schema_options, different sets of options for the two cases a type is used. This two methods are only used privately by the subclasses.
  2. To allow some kind of 'type algebra', with the #|, #of and #totally_valid? methods.

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ BasicType

Returns a new instance of BasicType.



9
10
11
 
# File 'lib/restspec/schema/types/basic_type.rb', line 9

def initialize(options = {})
  self.options = options
end

Instance Method Details

#of(other_type) ⇒ BasicType

The only work of of is to set a parameterized_type attribute on the type. This parameterized type can be used by the type itself to whatever the type wants. The major limitation is that, by now, we only allow one parameterized type. For example, ArrayType uses this parameterized type to do this:

Examples:

attribute :codes, array.of(integer)

Parameters:

  • other_type (instance of subclass of BasicType) —

    the type to make the save as the parameterized type.

Returns:

  • (BasicType) —

    the same object that is used to call the method. (self)



58
59
60
61
 
# File 'lib/restspec/schema/types/basic_type.rb', line 58

def of(other_type)
  self.parameterized_type = other_type
  self
end

#to_s ⇒ String

Returns a string representation of the type. It's basically the class name without the Type postfix underscorized.

Examples:


StringType.new.to_s #=> string
ArrayType.new.to_s #=> array
SchemaIdType.new.to_s #=> schema_id

Returns:

  • (String) —

    a string representation of the type. It's basically the class name without the Type postfix underscorized.



86
87
88
 
# File 'lib/restspec/schema/types/basic_type.rb', line 86

def to_s
  self.class.name.demodulize.gsub(/Type$/, "").underscore
end

#totally_valid?(attribute, value) ⇒ true, false

This calls the valid? method (that is not present in this class but should be present on their children) making sure to fallback to the disjunction if the disjunction is present.

Parameters:

  • attribute (Restspec::Schema::Attribute) —

    The attribute to use.

  • value (Object) —

    the object that holds the actual value to test against.

Returns:

  • (true, false) —

    If the type is valid with the following attribute and value.



70
71
72
73
74
75
76
 
# File 'lib/restspec/schema/types/basic_type.rb', line 70

def totally_valid?(attribute, value)
  if disjuction.present?
    valid?(attribute, value) || disjuction.valid?(attribute, value)
  else
    valid?(attribute, value)
  end
end

#|(other_type) ⇒ BasicType

The disjunction operator (||) is not a method in ruby, so we are using | because it looks similar. The important thing about the type disjunction is that, when checking through a type, a value can checks itself against multiple possible types.

The example works because the type returned by string | null is basically just string with a disjunction set to null. When validating, if the validation fails initially, the disjunction is used as a second source of thuth. Because the disjunction can have disjunctions too, we can test against more than two types.

Examples:

with two types

attribute :name, string | null

attr_type = schema.attributes[:name].type
attr_type.totally_valid?(schema.attributes[:name], 'Hola') # true
attr_type.totally_valid?(schema.attributes[:name], nil) # true
attr_type.totally_valid?(schema.attributes[:name], 10) # false

with more than two types

attribute :name, string | (null | integer)

attr_type = schema.attributes[:name].type
attr_type.totally_valid?(schema.attributes[:name], 'Hola') # true
attr_type.totally_valid?(schema.attributes[:name], nil) # true
attr_type.totally_valid?(schema.attributes[:name], 10) # true

Parameters:

  • other_type (instance of subclass of BasicType) —

    the type to make the disjuction.

Returns:

  • (BasicType) —

    the same object that is used to call the method. (self)



41
42
43
44
 
# File 'lib/restspec/schema/types/basic_type.rb', line 41

def |(other_type)
  self.disjuction = other_type
  self
end