Module: SimpleJsonapi::Definition::Concerns::HasMetaObject

Included in:
Error, Relationship, Resource
Defined in:
lib/simple_jsonapi/definition/concerns/has_meta_object.rb

Overview

Adds a #meta method and #meta_definitions collection to a definition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#meta_definitions ⇒ Hash{Symbol => String,Object} (readonly)

Returns:

  • (Hash{Symbol => String,Object}) 


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/simple_jsonapi/definition/concerns/has_meta_object.rb', line 9

module HasMetaObject
  # @visibility private
  def self.included(base)
    base.send :attr_accessor, :meta_definitions
  end

  def initialize(*args, &block)
    super
    @meta_definitions = {}
  end

  private def initialize_dup(new_def)
    super
    new_def.meta_definitions = meta_definitions.deep_dup
  end

  # @overload meta(name, options = {}, &block)
  # @overload meta(name, value, options = {})
  # @yieldparam object [Object]
  # @yieldreturn [Object]
  # @return [void]
  def meta(name, *args, **options, &block)
    meta_definitions[name.to_sym] = Meta.new(name, *args, options, &block)
  end
end

Instance Method Details

#initialize(*args, &block) ⇒ Object 



15
16
17
18
 
# File 'lib/simple_jsonapi/definition/concerns/has_meta_object.rb', line 15

def initialize(*args, &block)
  super
  @meta_definitions = {}
end

#meta(name, options = {}, &block) ⇒ void #meta(name, value, options = {}) ⇒ void

This method returns an undefined value.

Yield Parameters:

  • object (Object)

Yield Returns:

  • (Object) 


30
31
32
 
# File 'lib/simple_jsonapi/definition/concerns/has_meta_object.rb', line 30

def meta(name, *args, **options, &block)
  meta_definitions[name.to_sym] = Meta.new(name, *args, options, &block)
end