Class: Yerba::Map

Inherits:
Object
  • Object
show all
Includes:
Enumerable, Node
Defined in:
lib/yerba/map.rb

Instance Attribute Summary

Attributes included from Node

#key, #location, #selector

Instance Method Summary collapse

Methods included from Node

#connected?, #document, #file_path, included, #line, #source

Constructor Details

#initialize(hash = nil, **data) ⇒ Map

Returns a new instance of Map.



8
9
10
11
12
13
14
15
16
 
# File 'lib/yerba/map.rb', line 8

def initialize(hash = nil, **data)
  init_node(nil, nil, nil, nil, nil, nil)

  @data = if hash.is_a?(Hash)
            hash
          else
            (data.empty? ? {} : data)
          end
end

Instance Method Details

#[](key) ⇒ Object 



18
19
20
21
22
23
24
25
 
# File 'lib/yerba/map.rb', line 18

def [](key)
  if connected?
    new_path = @selector.empty? ? key.to_s : "#{@selector}.#{key}"
    document[new_path]
  else
    @data[key]
  end
end

#[]=(key, value) ⇒ Object 



27
28
29
 
# File 'lib/yerba/map.rb', line 27

def []=(key, value)
  set(key, value)
end

#collection_style ⇒ Object 



219
220
221
 
# File 'lib/yerba/map.rb', line 219

def collection_style
  @collection_style || document&.get_collection_style(@selector)
end

#collection_style=(style) ⇒ Object 



223
224
225
226
227
 
# File 'lib/yerba/map.rb', line 223

def collection_style=(style)
  document&.set_collection_style(@selector, style)

  @collection_style = style
end

#delete(key = nil) ⇒ Object

Deletes a key from the map, or deletes the entire map node from the document.

When key is given and the map is connected to a document, deletes that key from the map in the YAML document. When no key is given and the map is connected, removes the entire map node at its selector path. When not connected to a document, delegates to the underlying Hash.

Returns self.

# Delete a specific key from a connected map:
document = Yerba::Document.parse(<<~YAML)
database:
  host: localhost
  pool: 10
YAML

document["database"].delete("pool")
document.to_s # => "database:\n  host: localhost\n"

# Delete the entire map node:
document["database"].delete
document.to_s # => "{}\n"


153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/yerba/map.rb', line 153

def delete(key = nil)
  if key && connected?
    new_path = @selector.empty? ? key.to_s : "#{@selector}.#{key}"
    document.delete(new_path)
  elsif connected?
    document.delete(@selector)
  else
    @data.delete(key)
  end

  self
end

#dig(*keys) ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/yerba/map.rb', line 114

def dig(*keys)
  if connected?
    keys.reduce(self) { |node, key| node.nil? ? nil : node[key] }
  else
    @data.dig(*keys)
  end
end

#each ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/yerba/map.rb', line 85

def each(&)
  return enum_for(:each) unless block_given?

  unless connected?
    @data.each(&)
    return self
  end

  names = keys
  values = document.get_all(@selector.empty? ? "*" : "#{@selector}.*")

  if values.length == names.length && values.all?(&:key)
    values.each { |value| yield value.key.value, value }
  else
    names.each { |key| yield key, self[key] }
  end

  self
end

#fetch(key) ⇒ Object 



105
106
107
108
109
110
111
112
 
# File 'lib/yerba/map.rb', line 105

def fetch(key)
  if connected?
    new_path = @selector.empty? ? key.to_s : "#{@selector}.#{key}"
    document.fetch(new_path)
  else
    @data.fetch(key)
  end
end

#insert(key, value, before: nil, after: nil, style: nil) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/yerba/map.rb', line 61

def insert(key, value, before: nil, after: nil, style: nil)
  if connected?
    new_path = @selector.empty? ? key.to_s : "#{@selector}.#{key}"

    document.insert(new_path, coerce_value(value, style: style), before: before, after: after)
  else
    @data[key] = value
  end

  self
end

#inspect ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/yerba/map.rb', line 202

def inspect
  if connected?
    results = document.find(@selector)

    if results.is_a?(Array) && !results.empty? && results.first.is_a?(Hash)
      map_keys = results.first.keys.first(5)
      preview = map_keys.map { |key| "#{key}: #{results.first[key].inspect}" }.join(", ")

      "#<Yerba::Map selector=#{@selector.inspect} {#{preview}}>"
    else
      "#<Yerba::Map selector=#{@selector.inspect}>"
    end
  else
    "#<Yerba::Map {#{@data.map { |key, value| "#{key}: #{value.inspect}" }.join(", ")}}>"
  end
end

#key?(key) ⇒ Boolean Also known as: has_key?, include?

Returns:

  • (Boolean) 


166
167
168
169
170
171
172
173
 
# File 'lib/yerba/map.rb', line 166

def key?(key)
  if connected?
    new_path = @selector.empty? ? key.to_s : "#{@selector}.#{key}"
    document.exists?(new_path)
  else
    @data.key?(key)
  end
end

#keys ⇒ Object 



79
80
81
82
83
 
# File 'lib/yerba/map.rb', line 79

def keys
  return @data.keys unless connected?

  document.keys_at(@selector)
end

#set(key, value, style: nil) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/yerba/map.rb', line 31

def set(key, value, style: nil)
  if connected?
    new_path = @selector.empty? ? key.to_s : "#{@selector}.#{key}"
    coerced = coerce_value(value, style: style)
    is_block_value = coerced.is_a?(String) && (coerced.include?("\n") || coerced.start_with?("- "))

    if document.exists?(new_path) && is_block_value
      # Block-style collections can't replace a scalar via set().
      # Delete the key and re-insert at the same position.
      all_keys = keys
      key_index = all_keys.index(key.to_s)
      after_key = key_index&.positive? ? all_keys[key_index - 1] : nil

      document.delete(new_path)

      if after_key
        document.insert(new_path, coerced, after: after_key)
      else
        document.insert(new_path, coerced)
      end
    elsif document.exists?(new_path)
      document.set(new_path, coerced)
    else
      document.insert(new_path, coerced)
    end
  else
    @data[key] = value
  end
end

#sort_keys(order) ⇒ Object 



73
74
75
76
77
 
# File 'lib/yerba/map.rb', line 73

def sort_keys(order)
  document&.sort_keys(@selector, order)

  self
end

#to_h ⇒ Object Also known as: to_hash 



181
182
183
184
185
186
187
188
 
# File 'lib/yerba/map.rb', line 181

def to_h
  if connected?
    results = document.find(@selector)
    results&.first || {}
  else
    @data
  end
end

#to_s ⇒ Object 



191
192
193
 
# File 'lib/yerba/map.rb', line 191

def to_s
  source || to_yaml
end

#to_yaml ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/yerba/map.rb', line 195

def to_yaml
  to_hash.map do |key, val|
    formatted = format_value(val)
    "#{key}: #{formatted}"
  end.join("\n")
end

#value ⇒ Object 



177
178
179
 
# File 'lib/yerba/map.rb', line 177

def value
  @data || nil
end

#value_at(key) ⇒ Object 



122
123
124
125
126
127
128
129
 
# File 'lib/yerba/map.rb', line 122

def value_at(key)
  if connected?
    new_path = @selector.empty? ? key.to_s : "#{@selector}.#{key}"
    document.value_at(new_path)
  else
    @data[key]
  end
end