Class: Parametric::Schema

Inherits:
Object
  • Object
show all
Defined in:
lib/parametric/schema.rb

Defined Under Namespace

Classes: MatchContext

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, &block) ⇒ Schema

Returns a new instance of Schema.



7
8
9
10
11
12
13
14
15
 
# File 'lib/parametric/schema.rb', line 7

def initialize(options = {}, &block)
  @options = options
  @fields = {}
  @definitions = []
  @definitions << block if block_given?
  @default_field_policies = []
  @ignored_field_keys = []
  @expansions = {}
end

Instance Method Details

#clone ⇒ Object 



42
43
44
45
 
# File 'lib/parametric/schema.rb', line 42

def clone
  instance = self.class.new(options)
  copy_into instance
end

#coerce(val, _, context) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/parametric/schema.rb', line 127

def coerce(val, _, context)
  if val.is_a?(Array)
    val.map.with_index{|v, idx|
      subcontext = context.sub(idx)
      out = coerce_one(v, subcontext)
      resolve_expansions(v, out, subcontext)
    }
  else
    out = coerce_one(val, context)
    resolve_expansions(val, out, context)
  end
end

#copy_into(instance) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/parametric/schema.rb', line 59

def copy_into(instance)
  instance.policy(*default_field_policies) if default_field_policies.any?

  definitions.each do |d|
    instance.definitions << d
  end

  instance.ignore *ignored_field_keys
  instance
end

#eligible?(value, key, payload) ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/parametric/schema.rb', line 109

def eligible?(value, key, payload)
  payload.key? key
end

#expand(exp, &block) ⇒ Object 



93
94
95
96
 
# File 'lib/parametric/schema.rb', line 93

def expand(exp, &block)
  expansions[exp] = block
  self
end

#field(field_or_key) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/parametric/schema.rb', line 79

def field(field_or_key)
  f, key = if field_or_key.kind_of?(Field)
    [field_or_key, field_or_key.key]
  else
    [Field.new(field_or_key), field_or_key.to_sym]
  end

  if ignored_field_keys.include?(f.key)
    f
  else
    @fields[key] = apply_default_field_policies_to(f)
  end
end

#fields ⇒ Object 



21
22
23
24
 
# File 'lib/parametric/schema.rb', line 21

def fields
  apply!
  @fields
end

#ignore(*field_keys, &block) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/parametric/schema.rb', line 33

def ignore(*field_keys, &block)
  @ignored_field_keys += field_keys
  @ignored_field_keys.uniq!

  definitions << block if block_given?

  self
end

#merge(other_schema = nil, &block) ⇒ Object

Raises:

  • (ArgumentError) 


47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/parametric/schema.rb', line 47

def merge(other_schema = nil, &block)
  raise ArgumentError, '#merge takes either a schema instance or a block' if other_schema.nil? && !block_given?

  if other_schema
    instance = self.class.new(options.merge(other_schema.options))
    copy_into(instance)
    other_schema.copy_into(instance)
  else
    merge(self.class.new(&block))
  end
end

#meta_data ⇒ Object 



117
118
119
 
# File 'lib/parametric/schema.rb', line 117

def meta_data
  {}
end

#policy(*names, &block) ⇒ Object 



26
27
28
29
30
31
 
# File 'lib/parametric/schema.rb', line 26

def policy(*names, &block)
  @default_field_policies = names
  definitions << block if block_given?

  self
end

#resolve(payload) ⇒ Object 



98
99
100
101
102
 
# File 'lib/parametric/schema.rb', line 98

def resolve(payload)
  context = Context.new
  output = coerce(payload, nil, context)
  Results.new(output, context.errors)
end

#schema ⇒ Object 



17
18
19
 
# File 'lib/parametric/schema.rb', line 17

def schema
  self
end

#structure ⇒ Object 



70
71
72
73
74
75
76
77
 
# File 'lib/parametric/schema.rb', line 70

def structure
  fields.each_with_object({}) do |(_, field), obj|
    meta = field.meta_data.dup
    sc = meta.delete(:schema)
    meta[:structure] = sc.structure if sc
    obj[field.key] = meta
  end
end

#valid?(*_) ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/parametric/schema.rb', line 113

def valid?(*_)
  true
end

#visit(meta_key = nil, &visitor) ⇒ Object 



121
122
123
124
125
 
# File 'lib/parametric/schema.rb', line 121

def visit(meta_key = nil, &visitor)
  fields.each_with_object({}) do |(_, field), m|
    m[field.key] = field.visit(meta_key, &visitor)
  end
end

#walk(meta_key = nil, &visitor) ⇒ Object 



104
105
106
107
 
# File 'lib/parametric/schema.rb', line 104

def walk(meta_key = nil, &visitor)
  r = visit(meta_key, &visitor)
  Results.new(r, {})
end