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 ⇒ Object
readonly
@!attribute keys @return [Array<Key>] 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
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/dry/schema/key_map.rb', line 54 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 ⇒ Object (readonly)
@!attribute keys
@return [Array<Key>] A list of defined key objects
26 27 28 |
# File 'lib/dry/schema/key_map.rb', line 26 def keys @keys end |
Class Method Details
.[](*keys) ⇒ KeyMap
Coerce a list of key specs into a key map
38 39 40 |
# File 'lib/dry/schema/key_map.rb', line 38 def self.[](*keys) new(keys) end |
.new(*args) ⇒ KeyMap
Build new, or returned a cached instance of a key map
47 48 49 |
# File 'lib/dry/schema/key_map.rb', line 47 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
116 117 118 |
# File 'lib/dry/schema/key_map.rb', line 116 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
89 90 91 |
# File 'lib/dry/schema/key_map.rb', line 89 def coercible(&coercer) self.class.new(map { |key| key.coercible(&coercer) }) end |
#dump ⇒ Array
Dump keys to their spec format
130 131 132 |
# File 'lib/dry/schema/key_map.rb', line 130 def dump keys.map(&:dump) end |
#each(&block) ⇒ Object
Iterate over keys
107 108 109 |
# File 'lib/dry/schema/key_map.rb', line 107 def each(&block) keys.each(&block) end |
#inspect ⇒ String
Return a string representation of a key map
123 124 125 |
# File 'lib/dry/schema/key_map.rb', line 123 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
100 101 102 |
# File 'lib/dry/schema/key_map.rb', line 100 def stringified self.class.new(map(&:stringified)) end |
#write(source, target = EMPTY_HASH.dup) ⇒ Hash
Write a new hash based on the source hash
79 80 81 82 |
# File 'lib/dry/schema/key_map.rb', line 79 def write(source, target = EMPTY_HASH.dup) each { |key| key.write(source, target) } target end |