Class: ActiveModel::Serializer::IncludeTree

Inherits:

Object

• Object
• ActiveModel::Serializer::IncludeTree

show all

Defined in:

lib/active_model/serializer/include_tree.rb

Overview

Defined Under Namespace

Modules: Parsing

Class Method Summary (collapse)

• + (IncludeTree) from_include_args(included)

  Translates the arguments passed to the include option into an IncludeTree.

• + (IncludeTree) from_string(included)

  Builds an IncludeTree from a comma separated list of dot separated paths (JSON API format).

Instance Method Summary (collapse)

• - (Object) [](key)
• - (IncludeTree) initialize(hash = {}) constructor

  A new instance of IncludeTree.

• - (Boolean) key?(key)

88
89
90

# File 'lib/active_model/serializer/include_tree.rb', line 88

def initialize(hash = {})
  @hash = hash
end

81
82
83
84
85

# File 'lib/active_model/serializer/include_tree.rb', line 81

def self.from_include_args(included)
  return included if included.is_a?(IncludeTree)

  new(Parsing.include_args_to_hash(included))
end

70
71
72

# File 'lib/active_model/serializer/include_tree.rb', line 70

def self.from_string(included)
  new(Parsing.include_string_to_hash(included))
end

96
97
98
99
100
101
102
103
104
105
106
107
108

# File 'lib/active_model/serializer/include_tree.rb', line 96

def [](key)
  # TODO(beauby): Adopt a lazy caching strategy for generating subtrees.
  case
  when @hash.key?(key)
    self.class.new(@hash[key])
  when @hash.key?(:*)
    self.class.new(@hash[:*])
  when @hash.key?(:**)
    self.class.new(:** => {})
  else
    nil
  end
end

92
93
94

# File 'lib/active_model/serializer/include_tree.rb', line 92

def key?(key)
  @hash.key?(key) || @hash.key?(:*) || @hash.key?(:**)
end