Class: GetStream::BaseModel

Inherits:

Object

Object
GetStream::BaseModel

show all

Defined in:: lib/getstream_ruby/generated/base_model.rb

Overview

Base model class for all generated models

Direct Known Subclasses

Class Method Summary collapse

.omit_empty_fields ⇒ Array<Symbol>

Class method to define which fields should be omitted when empty (like Go’s omitempty) Override this in subclasses to specify fields that should be excluded from JSON serialization when empty.

Instance Method Summary collapse

#==(other) ⇒ Object

Equality comparison.
#initialize(attributes = {}) ⇒ BaseModel constructor

A new instance of BaseModel.
#inspect ⇒ Object

String representation.
#to_h ⇒ Object

Convert to hash (used for equality, inspect, etc.).
#to_json(*args) ⇒ Object

Convert to JSON with optional field filtering This is the Ruby-idiomatic way: filter only for JSON, keep to_h clean Automatically omits nil values (optional fields default to nil, like Go pointers).

Constructor Details

#initialize(attributes = {}) ⇒ `BaseModel`

Returns a new instance of BaseModel.

# File 'lib/getstream_ruby/generated/base_model.rb', line 6

def initialize(attributes = {})
  # Set attributes from hash
  attributes.each do |key, value|
    method_name = "#{key}="
    if respond_to?(method_name)
      send(method_name, value)
    end
  end
end

Class Method Details

.omit_empty_fields ⇒ `Array<Symbol>`

Class method to define which fields should be omitted when empty (like Go’s omitempty) Override this in subclasses to specify fields that should be excluded from JSON serialization when empty

Returns:

(Array<Symbol>) —

Array of field names to omit when empty



19
20
21

# File 'lib/getstream_ruby/generated/base_model.rb', line 19

def self.omit_empty_fields
  []
end

Instance Method Details

#==(other) ⇒ `Object`

Equality comparison

# File 'lib/getstream_ruby/generated/base_model.rb', line 56

def ==(other)
  return false unless other.is_a?(self.class)
  to_h == other.to_h
end

#inspect ⇒ `Object`

String representation



62
63
64

# File 'lib/getstream_ruby/generated/base_model.rb', line 62

def inspect
  "#<#{self.class.name} #{to_h.inspect}>"
end

#to_h ⇒ `Object`

Convert to hash (used for equality, inspect, etc.)

# File 'lib/getstream_ruby/generated/base_model.rb', line 24

def to_h
  instance_variables.each_with_object({}) do |var, hash|
    key = var.to_s.delete('@').to_sym
    value = instance_variable_get(var)
    hash[key] = value
  end
end

#to_json(*args) ⇒ `Object`

Convert to JSON with optional field filtering This is the Ruby-idiomatic way: filter only for JSON, keep to_h clean Automatically omits nil values (optional fields default to nil, like Go pointers)

# File 'lib/getstream_ruby/generated/base_model.rb', line 35

def to_json(*args)
  hash = to_h
  omit_fields = self.class.omit_empty_fields
  
  # Filter out nil values and empty fields for JSON serialization
  hash = hash.reject do |key, value|
    # Always omit nil values (optional fields default to nil)
    next true if value.nil?
    
    # For fields in omit_empty_fields, also omit empty strings/arrays/hashes
    if omit_fields.include?(key)
      value == "" || (value.respond_to?(:empty?) && value.empty?)
    else
      false
    end
  end
  
  hash.to_json(*args)
end