Class: Dry::Schema::KeyMap
- Inherits:
-
Object
- Object
- Dry::Schema::KeyMap
- Extended by:
- Core::Cache
- Includes:
- Enumerable
- Defined in:
- lib/dry/schema/key_map.rb
Overview
Represents a list of keys defined by the DSL
KeyMap objects expose an API for introspecting schema keys and the ability to rebuild an input hash using configured coercer function.
Instances of this class are used as the very first step by the schema processors.
Instance Attribute Summary collapse
-
#keys ⇒ Array<Key>
readonly
A list of defined key objects.
Class Method Summary collapse
-
.[](*keys) ⇒ KeyMap
Coerce a list of key specs into a key map.
-
.new(*args) ⇒ KeyMap
Build new, or returned a cached instance of a key map.
Instance Method Summary collapse
-
#+(other) ⇒ KeyMap
Return a new key map merged with the provided one.
-
#coercible(&coercer) ⇒ KeyMap
Return a new key map that is configured to coerce keys using provided coercer function.
-
#dump ⇒ Array
Dump keys to their spec format.
-
#each(&block) ⇒ Object
Iterate over keys.
-
#initialize(keys) ⇒ KeyMap
constructor
private
Set key objects.
-
#inspect ⇒ String
Return a string representation of a key map.
-
#stringified ⇒ KeyMap
Return a new key map with stringified keys.
-
#write(source, target = EMPTY_HASH.dup) ⇒ Hash
Write a new hash based on the source hash.
Constructor Details
#initialize(keys) ⇒ KeyMap
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Set key objects
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/dry/schema/key_map.rb', line 53 def initialize(keys) @keys = keys.map { |key| case key when Hash root, rest = key.flatten Key::Hash[root, members: KeyMap[*rest]] when Array root, rest = key Key::Array[root, member: KeyMap[*rest]] when Key key else Key[key] end } end |
Instance Attribute Details
#keys ⇒ Array<Key> (readonly)
Returns A list of defined key objects.
25 26 27 |
# File 'lib/dry/schema/key_map.rb', line 25 def keys @keys end |
Class Method Details
.[](*keys) ⇒ KeyMap
Coerce a list of key specs into a key map
37 38 39 |
# File 'lib/dry/schema/key_map.rb', line 37 def self.[](*keys) new(keys) end |
.new(*args) ⇒ KeyMap
Build new, or returned a cached instance of a key map
46 47 48 |
# File 'lib/dry/schema/key_map.rb', line 46 def self.new(*args) fetch_or_store(*args) { super } end |
Instance Method Details
#+(other) ⇒ KeyMap
Return a new key map merged with the provided one
115 116 117 |
# File 'lib/dry/schema/key_map.rb', line 115 def +(other) self.class.new(keys + other.to_a) end |
#coercible(&coercer) ⇒ KeyMap
Return a new key map that is configured to coerce keys using provided coercer function
88 89 90 |
# File 'lib/dry/schema/key_map.rb', line 88 def coercible(&coercer) self.class.new(map { |key| key.coercible(&coercer) }) end |
#dump ⇒ Array
Dump keys to their spec format
129 130 131 |
# File 'lib/dry/schema/key_map.rb', line 129 def dump keys.map(&:dump) end |
#each(&block) ⇒ Object
Iterate over keys
106 107 108 |
# File 'lib/dry/schema/key_map.rb', line 106 def each(&block) keys.each(&block) end |
#inspect ⇒ String
Return a string representation of a key map
122 123 124 |
# File 'lib/dry/schema/key_map.rb', line 122 def inspect "#<#{self.class}[#{keys.map(&:dump).map(&:inspect).join(", ")}]>" end |
#stringified ⇒ KeyMap
Return a new key map with stringified keys
A stringified key map is suitable for reading hashes with string keys
99 100 101 |
# File 'lib/dry/schema/key_map.rb', line 99 def stringified self.class.new(map(&:stringified)) end |
#write(source, target = EMPTY_HASH.dup) ⇒ Hash
Write a new hash based on the source hash
78 79 80 81 |
# File 'lib/dry/schema/key_map.rb', line 78 def write(source, target = EMPTY_HASH.dup) each { |key| key.write(source, target) } target end |