Class: Parametric::Schema
- Inherits:
-
Object
- Object
- Parametric::Schema
- Defined in:
- lib/parametric/schema.rb
Instance Method Summary collapse
- #clone ⇒ Object
- #coerce(val, _, context) ⇒ Object
- #copy_into(instance) ⇒ Object
- #eligible?(value, key, payload) ⇒ Boolean
- #field(field_or_key) ⇒ Object
- #fields ⇒ Object
- #ignore(*field_keys, &block) ⇒ Object
-
#initialize(options = {}, &block) ⇒ Schema
constructor
A new instance of Schema.
- #merge(other_schema) ⇒ Object
- #meta_data ⇒ Object
- #policy(*names, &block) ⇒ Object
- #resolve(payload) ⇒ Object
- #structure ⇒ Object
- #valid?(*_) ⇒ Boolean
- #visit(meta_key = nil, &visitor) ⇒ Object
- #walk(meta_key = nil, &visitor) ⇒ Object
Constructor Details
#initialize(options = {}, &block) ⇒ Schema
Returns a new instance of Schema.
7 8 9 10 11 12 13 14 |
# File 'lib/parametric/schema.rb', line 7 def initialize( = {}, &block) @options = @fields = {} @definitions = [] @definitions << block if block_given? @default_field_policies = [] @ignored_field_keys = [] end |
Instance Method Details
#clone ⇒ Object
37 38 39 40 |
# File 'lib/parametric/schema.rb', line 37 def clone instance = self.class.new() copy_into instance end |
#coerce(val, _, context) ⇒ Object
112 113 114 115 116 117 118 119 120 |
# File 'lib/parametric/schema.rb', line 112 def coerce(val, _, context) if val.is_a?(Array) val.map.with_index{|v, idx| coerce_one(v, context.sub(idx)) } else coerce_one val, context end end |
#copy_into(instance) ⇒ Object
49 50 51 52 53 54 55 56 57 58 |
# File 'lib/parametric/schema.rb', line 49 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
94 95 96 |
# File 'lib/parametric/schema.rb', line 94 def eligible?(value, key, payload) payload.key? key end |
#field(field_or_key) ⇒ Object
69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/parametric/schema.rb', line 69 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
16 17 18 19 |
# File 'lib/parametric/schema.rb', line 16 def fields apply! @fields end |
#ignore(*field_keys, &block) ⇒ Object
28 29 30 31 32 33 34 35 |
# File 'lib/parametric/schema.rb', line 28 def ignore(*field_keys, &block) @ignored_field_keys += field_keys @ignored_field_keys.uniq! definitions << block if block_given? self end |
#merge(other_schema) ⇒ Object
42 43 44 45 46 47 |
# File 'lib/parametric/schema.rb', line 42 def merge(other_schema) instance = self.class.new(.merge(other_schema.)) copy_into(instance) other_schema.copy_into(instance) end |
#meta_data ⇒ Object
102 103 104 |
# File 'lib/parametric/schema.rb', line 102 def {} end |
#policy(*names, &block) ⇒ Object
21 22 23 24 25 26 |
# File 'lib/parametric/schema.rb', line 21 def policy(*names, &block) @default_field_policies = names definitions << block if block_given? self end |
#resolve(payload) ⇒ Object
83 84 85 86 87 |
# File 'lib/parametric/schema.rb', line 83 def resolve(payload) context = Context.new output = coerce(payload, nil, context) Results.new(output, context.errors) end |
#structure ⇒ Object
60 61 62 63 64 65 66 67 |
# File 'lib/parametric/schema.rb', line 60 def structure fields.each_with_object({}) do |(_, field), obj| = field..dup sc = .delete(:schema) [:structure] = sc.structure if sc obj[field.key] = end end |
#valid?(*_) ⇒ Boolean
98 99 100 |
# File 'lib/parametric/schema.rb', line 98 def valid?(*_) true end |
#visit(meta_key = nil, &visitor) ⇒ Object
106 107 108 109 110 |
# File 'lib/parametric/schema.rb', line 106 def visit( = nil, &visitor) fields.each_with_object({}) do |(_, field), m| m[field.key] = field.visit(, &visitor) end end |