Class: JSON::SchemaBuilder::Entity

Inherits:
Object
  • Object
show all
Includes:
Attribute, DSL, Helpers, Validation
Defined in:
lib/json/schema_builder/entity.rb

Direct Known Subclasses

Any, Array, Boolean, Null, Numeric, Object, String

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers

#id, #object_or_array

Methods included from Validation

#fully_validate, #validate, #validate!

Methods included from DSL

#entity

Constructor Details

#initialize(name, opts = { }, &block) ⇒ Entity

Returns a new instance of Entity.



30
31
32
33
34
35
36
37
38
39
# File 'lib/json/schema_builder/entity.rb', line 30

def initialize(name, opts = { }, &block)
  @name = name
  @children = []
  @fragments = Hash.new { |hash, key| hash[key] = ::Array.new }
  @fragments["#/"] << self if opts[:root]
  self.type = self.class.registered_type
  initialize_parent_with opts
  initialize_with opts
  eval_block &block
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &block) ⇒ Object



77
78
79
80
81
82
83
# File 'lib/json/schema_builder/entity.rb', line 77

def method_missing(method_name, *args, &block)
  if @parent_context && respond_to?(method_name, true)
    @parent_context.send method_name, *args, &block
  else
    super
  end
end

Instance Attribute Details

#childrenObject

Returns the value of attribute children.



15
16
17
# File 'lib/json/schema_builder/entity.rb', line 15

def children
  @children
end

#errorObject

Returns the value of attribute error.



15
16
17
# File 'lib/json/schema_builder/entity.rb', line 15

def error
  @error
end

#fragmentObject

Returns the value of attribute fragment.



15
16
17
# File 'lib/json/schema_builder/entity.rb', line 15

def fragment
  @fragment
end

#fragmentsObject

Returns the value of attribute fragments.



15
16
17
# File 'lib/json/schema_builder/entity.rb', line 15

def fragments
  @fragments
end

#nameObject

Returns the value of attribute name.



15
16
17
# File 'lib/json/schema_builder/entity.rb', line 15

def name
  @name
end

#optionsObject

Returns the value of attribute options.



15
16
17
# File 'lib/json/schema_builder/entity.rb', line 15

def options
  @options
end

#parentObject

Returns the value of attribute parent.



15
16
17
# File 'lib/json/schema_builder/entity.rb', line 15

def parent
  @parent
end

Instance Method Details

#add_fragment(child) ⇒ Object



41
42
43
44
# File 'lib/json/schema_builder/entity.rb', line 41

def add_fragment(child)
  @fragments[child.fragment] << child
  @parent.add_fragment(child) if @parent
end

#as_jsonObject



65
66
67
# File 'lib/json/schema_builder/entity.rb', line 65

def as_json
  schema.as_json
end

#merge_children!Object



59
60
61
62
63
# File 'lib/json/schema_builder/entity.rb', line 59

def merge_children!
  children.each do |child|
    schema.merge! child.schema
  end
end

#requiredObject



50
51
52
# File 'lib/json/schema_builder/entity.rb', line 50

def required
  schema["required"] || []
end

#required=(*values) ⇒ Object



54
55
56
57
# File 'lib/json/schema_builder/entity.rb', line 54

def required=(*values)
  @parent.schema["required"] ||= []
  @parent.schema["required"] << @name
end

#respond_to?(method_name, include_all = false) ⇒ Boolean

Returns:



69
70
71
72
73
74
75
# File 'lib/json/schema_builder/entity.rb', line 69

def respond_to?(method_name, include_all = false)
  if @parent_context
    @parent_context.respond_to? method_name, include_all
  else
    super
  end
end

#schemaObject



46
47
48
# File 'lib/json/schema_builder/entity.rb', line 46

def schema
  @schema ||= Schema.new({}, self)
end