Class: LLM::Object

Inherits:
BasicObject
Includes:
Enumerable
Defined in:
lib/llm/object.rb,
lib/llm/object/kernel.rb,
lib/llm/object/builder.rb

Overview

The LLM::Object class encapsulates a Hash object. It is similar in spirit to OpenStruct, and it was introduced after OpenStruct became a bundled gem rather than a default gem in Ruby 3.5.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(h = {}) ⇒ LLM::Object

Parameters:

  • h (Hash) (defaults to: {}) 


50
51
52
 
# File 'lib/llm/object.rb', line 50

def initialize(h = {})
  @h = h || {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args, &b) ⇒ Object (private) 



212
213
214
215
216
217
218
219
220
 
# File 'lib/llm/object.rb', line 212

def method_missing(m, *args, &b)
  if m.to_s.end_with?("=")
    self[m[0..-2]] = args.first
  elsif k = SINGLETON.key(@h, m)
    @h[k]
  else
    nil
  end
end

Class Method Details

.get(h, k) ⇒ Object?

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.

Parameters:

  • h (Hash)
  • k (#to_s, #to_sym)

Returns:



37
38
39
40
 
# File 'lib/llm/object.rb', line 37

def self.get(h, k)
  name = key(h, k)
  h[name] if name
end

.key(h, k) ⇒ String, ...

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.

Parameters:

  • h (Hash)
  • k (#to_s, #to_sym)

Returns:

  • (String, Symbol, nil) 


21
22
23
24
25
26
27
28
29
30
 
# File 'lib/llm/object.rb', line 21

def self.key(h, k)
  return nil if k.nil?
  if h.key?(k.to_s)
    k.to_s
  elsif h.key?(k.to_sym)
    k.to_sym
  else
    nil
  end
end

Instance Method Details

#==(other) ⇒ Boolean Also known as: eql?

Parameters:

  • other (Hash, #to_h)

Returns:

  • (Boolean) 


204
205
206
207
 
# File 'lib/llm/object.rb', line 204

def ==(other)
  return false unless other.respond_to?(:to_h)
  to_h == other.to_h || to_hash == other.to_h
end

#each {|k, v| ... }

This method returns an undefined value.

Yields a key|value pair to a block.

Yield Parameters:



59
60
61
 
# File 'lib/llm/object.rb', line 59

def each(&)
  @h.each(&)
end

#transform_values! {|v| ... } ⇒ Hash

In-place transform of values with a block.

Yield Parameters:

Returns:

  • (Hash) 


67
68
69
 
# File 'lib/llm/object.rb', line 67

def transform_values!(&)
  @h.transform_values!(&)
end

#[](k) ⇒ Object

Parameters:

  • k (Symbol, #to_sym)

Returns:



74
75
76
 
# File 'lib/llm/object.rb', line 74

def [](k)
  @h[SINGLETON.key(@h, k)]
end

#[]=(k, v)

This method returns an undefined value.

Parameters:

  • k (Symbol, #to_sym)
  • v (Object) 


82
83
84
 
# File 'lib/llm/object.rb', line 82

def []=(k, v)
  @h[k.to_s] = v
end

#to_json ⇒ String

Returns:

  • (String) 


88
89
90
 
# File 'lib/llm/object.rb', line 88

def to_json(...)
  LLM.json.dump(to_h, ...)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/llm/object.rb', line 94

def empty?
  @h.empty?
end

#to_h ⇒ Hash

Returns:

  • (Hash) 


100
101
102
 
# File 'lib/llm/object.rb', line 100

def to_h
  @h.dup
end

#to_hash ⇒ Hash

Returns:

  • (Hash) 


106
107
108
 
# File 'lib/llm/object.rb', line 106

def to_hash
  @h.transform_keys(&:to_sym)
end

#keys ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'lib/llm/object.rb', line 112

def keys
  @h.keys
end

#values ⇒ Array

Returns:

  • (Array) 


118
119
120
 
# File 'lib/llm/object.rb', line 118

def values
  @h.values
end

#key?(k = UNDEFINED) ⇒ Boolean Also known as: has_key?

Parameters:

  • k (String, Symbol) (defaults to: UNDEFINED)

Returns:

  • (Boolean) 


125
126
127
128
 
# File 'lib/llm/object.rb', line 125

def key?(k = UNDEFINED)
  return SINGLETON.get(@h, :key?) if k.equal?(UNDEFINED)
  @h.key?(SINGLETON.key(@h, k))
end

#fetch(k = UNDEFINED, *args, &b) ⇒ Object

Parameters:

  • k (String, Symbol) (defaults to: UNDEFINED)

Returns:



134
135
136
137
138
 
# File 'lib/llm/object.rb', line 134

def fetch(k = UNDEFINED, *args, &b)
  return SINGLETON.get(@h, :fetch) if k.equal?(UNDEFINED)
  key = SINGLETON.key(@h, k)
  @h.fetch(key || k, *args, &b)
end

#merge(other = UNDEFINED) ⇒ LLM::Object

Returns a new LLM::Object

Parameters:

  • other (Hash, to_h) (defaults to: UNDEFINED) —

    The hash to merge

Returns:

Raises:

  • (TypeError) 


145
146
147
148
149
150
 
# File 'lib/llm/object.rb', line 145

def merge(other = UNDEFINED)
  return SINGLETON.get(@h, :merge) if other.equal?(UNDEFINED)
  other = ::Hash.try_convert(other)
  raise TypeError, "#{other} cannot be coerced into a Hash" unless other
  SINGLETON.from @h.merge(other)
end

#merge!(other = UNDEFINED) ⇒ LLM::Object

Returns self

Parameters:

  • other (Hash, #to_h) (defaults to: UNDEFINED) —

    The hash to merge in place

Returns:

Raises:

  • (TypeError) 


157
158
159
160
161
162
163
 
# File 'lib/llm/object.rb', line 157

def merge!(other = UNDEFINED)
  return SINGLETON.get(@h, :merge!) if other.equal?(UNDEFINED)
  other = ::Hash.try_convert(other)
  raise TypeError, "#{other} cannot be coerced into a Hash" unless other
  @h.merge!(other)
  self
end

#delete(k = UNDEFINED)

This method returns an undefined value.

Parameters:

  • k (#to_s, #to_sym) (defaults to: UNDEFINED) —

    The key name



169
170
171
172
 
# File 'lib/llm/object.rb', line 169

def delete(k = UNDEFINED)
  return SINGLETON.get(@h, :delete) if k.equal?(UNDEFINED)
  @h.delete(SINGLETON.key(@h, k))
end

#size ⇒ Integer Also known as: length

Returns:

  • (Integer) 


176
177
178
 
# File 'lib/llm/object.rb', line 176

def size
  @h.size
end

#each_pair {|| ... } ⇒ Object

Yield Parameters:



183
184
185
 
# File 'lib/llm/object.rb', line 183

def each_pair(&)
  @h.each(&)
end

#dig(*args) ⇒ Object?

Returns:



189
190
191
192
 
# File 'lib/llm/object.rb', line 189

def dig(*args)
  return SINGLETON.get(@h, :dig) if args.empty?
  @h.dig(*args)
end

#slice(*args) ⇒ Hash

Returns:

  • (Hash) 


196
197
198
199
 
# File 'lib/llm/object.rb', line 196

def slice(*args)
  return SINGLETON.get(@h, :slice) if args.empty?
  @h.slice(*args)
end