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.



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/parametric/schema.rb', line 9

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

Instance Method Details

#after_resolve(klass = nil, &block) ⇒ Object

Raises:

  • (ArgumentError) 


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

def after_resolve(klass = nil, &block)
  raise ArgumentError, '#after_resolve expects a callable object, or a block' if !klass && !block_given?
  callable = klass || block
  after_hooks << callable
  self
end

#before_resolve(klass = nil, &block) ⇒ Object

Raises:

  • (ArgumentError) 


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

def before_resolve(klass = nil, &block)
  raise ArgumentError, '#before_resolve expects a callable object, or a block' if !klass && !block_given?
  callable = klass || block
  before_hooks << callable
  self
end

#clone ⇒ Object 



46
47
48
49
 
# File 'lib/parametric/schema.rb', line 46

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

#coerce(val, _, context) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/parametric/schema.rb', line 145

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 



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/parametric/schema.rb', line 63

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) 


127
128
129
 
# File 'lib/parametric/schema.rb', line 127

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

#expand(exp, &block) ⇒ Object 



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

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

#field(field_or_key) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/parametric/schema.rb', line 83

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 



25
26
27
28
 
# File 'lib/parametric/schema.rb', line 25

def fields
  apply!
  @fields
end

#ignore(*field_keys, &block) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/parametric/schema.rb', line 37

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) 


51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/parametric/schema.rb', line 51

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 



135
136
137
 
# File 'lib/parametric/schema.rb', line 135

def meta_data
  {}
end

#policy(*names, &block) ⇒ Object 



30
31
32
33
34
35
 
# File 'lib/parametric/schema.rb', line 30

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

  self
end

#resolve(payload) ⇒ Object 



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

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

#schema ⇒ Object 



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

def schema
  self
end

#structure ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'lib/parametric/schema.rb', line 74

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) 


131
132
133
 
# File 'lib/parametric/schema.rb', line 131

def valid?(*_)
  true
end

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



139
140
141
142
143
 
# File 'lib/parametric/schema.rb', line 139

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 



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

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