Module: Alba::Resource::InstanceMethods

Included in:
Alba::Resource
Defined in:
lib/alba/resource.rb

Overview

Instance methods

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#object ⇒ Object (readonly)

Returns the value of attribute object.



47
48
49
 
# File 'lib/alba/resource.rb', line 47

def object
  @object
end

#params ⇒ Object (readonly)

Returns the value of attribute params.



47
48
49
 
# File 'lib/alba/resource.rb', line 47

def params
  @params
end

Instance Method Details

#as_json(_options = EMPTY_HASH, root_key: nil, meta: EMPTY_HASH) ⇒ Hash

Returns a Hash corresponding #serialize

Parameters:

  • _options (Hash) (defaults to: EMPTY_HASH) —

    dummy parameter for Rails compatibility

  • root_key (Symbol, nil) (defaults to: nil)
  • meta (Hash) (defaults to: EMPTY_HASH) —

    metadata for this serialization

Returns:

  • (Hash) 


98
99
100
101
102
103
104
105
106
107
 
# File 'lib/alba/resource.rb', line 98

def as_json(_options = EMPTY_HASH, root_key: nil, meta: EMPTY_HASH)
  key = root_key.nil? ? fetch_key : root_key
  key = Alba.regularize_key(key)
  if key && !key.empty?
    h = {key => serializable_hash}
    hash_with_metadata(h, meta)
  else
    serializable_hash
  end
end

#initialize(object, params: EMPTY_HASH, within: WITHIN_DEFAULT, with_traits: nil, select: nil) ⇒ Object

Parameters:

  • object (Object) —

    the object to be serialized

  • params (Hash) (defaults to: EMPTY_HASH) —

    user-given Hash for arbitrary data

  • within (Alba::WITHIN_DEFAULT, Hash, Array, nil, false, true) (defaults to: WITHIN_DEFAULT) —

    determines what associations to be serialized. If not set, it serializes all associations.

  • with_traits (Symbol, Array<Symbol>, nil) (defaults to: nil) —

    specified traits

  • select (Method) (defaults to: nil) —

    select method object used with ‘nested_attribute` and `trait`



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/alba/resource.rb', line 55

def initialize(object, params: EMPTY_HASH, within: WITHIN_DEFAULT, with_traits: nil, select: nil)
  @object = object
  @params = params
  @within = within
  @with_traits = with_traits
  # select override to share the same method with `trait` and `nested_attribute`
  # Trait and NestedAttribute generates anonymous class so it checks if it's anonymous class to prevent accidental overriding
  self.class.define_method(:select, &select) if select && self.class.name.nil?
  _setup
end

#serializable_hash ⇒ Hash Also known as: to_h

A Hash for serialization

Returns:

  • (Hash) 


112
113
114
 
# File 'lib/alba/resource.rb', line 112

def serializable_hash
  Alba.collection?(@object) ? serializable_hash_for_collection : attributes_to_hash(@object, {})
end

#serialize(root_key: nil, meta: EMPTY_HASH) ⇒ String

Serialize object into JSON string

Parameters:

  • root_key (Symbol, nil) (defaults to: nil)
  • meta (Hash) (defaults to: EMPTY_HASH) —

    metadata for this serialization

Returns:

  • (String) —

    serialized JSON string



71
72
73
 
# File 'lib/alba/resource.rb', line 71

def serialize(root_key: nil, meta: EMPTY_HASH)
  serialize_with(as_json(root_key: root_key, meta: meta))
end

#to_json(options = EMPTY_HASH, root_key: nil, meta: EMPTY_HASH) ⇒ Object

For Rails compatibility The first options is a dummy parameter

See Also:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/alba/resource.rb', line 80

def to_json(options = EMPTY_HASH, root_key: nil, meta: EMPTY_HASH)
  confusing_keys = [:only, :except]
  confusing_options = options.keys.select { |k| confusing_keys.include?(k.to_sym) }
  unless confusing_options.empty?
    confusing_options.sort!
    confusing_options.map! { |s| "\"#{s}\"" }
    message = "You passed #{confusing_options.join(' and ')} options but ignored. Please refer to the document: https://github.com/okuramasafumi/alba/blob/main/docs/rails.md"
    Kernel.warn(message)
  end
  serialize(root_key: root_key, meta: meta)
end