Module: JsonSchema::Attributes::ClassMethods

Defined in:
lib/json_schema/attributes.rb

Overview

Provides class-level methods for the Attributes module.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#copyable_attrs ⇒ Object (readonly)

Attributes that should be copied between classes when invoking Attributes#copy_from.

Hash contains instance variable names mapped to a default value for the field.



13
14
15
 
# File 'lib/json_schema/attributes.rb', line 13

def copyable_attrs
  @copyable_attrs
end

#schema_attrs ⇒ Object (readonly)

Attributes that are part of the JSON schema and hyper-schema specifications. These are allowed to be accessed with the [] operator.

Hash contains the access key mapped to the name of the method that should be invoked to retrieve a value. For example, ‘type` maps to `type` and `additionalItems` maps to `additional_items`.



21
22
23
 
# File 'lib/json_schema/attributes.rb', line 21

def schema_attrs
  @schema_attrs
end

Instance Method Details

#attr_copyable(attr, options = {}) ⇒ Object

identical to attr_accessible, but allows us to copy in values from a target schema to help preserve our hierarchy during reference expansion



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/json_schema/attributes.rb', line 25

def attr_copyable(attr, options = {})
  attr_accessor(attr)

  ref = :"@#{attr}"
  # Usually the default being assigned here is nil.
  self.copyable_attrs[ref] = options[:default]

  if default = options[:default]
    # remove the reader already created by attr_accessor
    remove_method(attr)

    if [Array, Hash, Set].include?(default.class)
      default = default.freeze
    end

    define_method(attr) do
      val = instance_variable_get(ref)
      if !val.nil?
        val
      else
        default
      end
    end
  end

  if options[:clear_cache]
    remove_method(:"#{attr}=")
    define_method(:"#{attr}=") do |value|
      instance_variable_set(options[:clear_cache], nil)
      instance_variable_set(ref, value)
    end
  end
end

#attr_schema(attr, options = {}) ⇒ Object 



59
60
61
62
 
# File 'lib/json_schema/attributes.rb', line 59

def attr_schema(attr, options = {})
  attr_copyable(attr, :default => options[:default], :clear_cache => options[:clear_cache])
  self.schema_attrs[options[:schema_name] || attr] = attr
end

#inherit_attrs ⇒ Object

Directive indicating that attributes should be inherited from a parent class.

Must appear as first statement in class that mixes in (or whose parent mixes in) the Attributes module.



69
70
71
72
 
# File 'lib/json_schema/attributes.rb', line 69

def inherit_attrs
  @copyable_attrs = self.superclass.instance_variable_get(:@copyable_attrs).dup
  @schema_attrs = self.superclass.instance_variable_get(:@schema_attrs).dup
end

#initialize_attrs ⇒ Object

Initializes some class instance variables required to make other methods in the Attributes module work. Run automatically when the module is mixed into another class.



77
78
79
80
 
# File 'lib/json_schema/attributes.rb', line 77

def initialize_attrs
  @copyable_attrs = {}
  @schema_attrs = {}
end