Class: Hanami::Utils::Attributes

Inherits:
Object
  • Object
show all
Defined in:
lib/hanami/utils/attributes.rb

Overview

A set of attributes.

It internally stores the data as a Hash.

All the operations convert keys to strings. This strategy avoids memory attacks due to Symbol abuses when parsing untrusted input.

At the same time, this allows to get/set data with the original key or with the string representation. See the examples below.

Since:

  • 0.3.2

Instance Method Summary collapse

Constructor Details

#initialize(hash = {}) ⇒ Hanami::Utils::Attributes

Initialize a set of attributes All the keys of the given Hash are recursively converted to strings.

Examples:

require 'hanami/utils/attributes'

attributes = Hanami::Utils::Attributes.new(a: 1, b: { 2 => [3, 4] })
attributes.to_h # => { "a" => 1, "b" => { "2" => [3, 4] } }

Parameters:

  • hash (#to_h) (defaults to: {}) —

    a Hash or any object that implements #to_h

Since:

  • 0.3.2



32
33
34
 
# File 'lib/hanami/utils/attributes.rb', line 32

def initialize(hash = {})
  @attributes = Utils::Hash.new(hash, &nil).stringify!
end

Instance Method Details

#get(attribute) ⇒ Object, NilClass Also known as: []

Get the value associated with the given attribute

Examples:

require 'hanami/utils/attributes'

attributes = Hanami::Utils::Attributes.new(a: 1, 'b' => 2, 23 => 'foo')

attributes.get(:a)  # => 1
attributes.get('a') # => 1
attributes[:a]      # => 1
attributes['a']     # => 1

attributes.get(:b)  # => 2
attributes.get('b') # => 2
attributes[:b]      # => 2
attributes['b']     # => 2

attributes.get(23)   # => "foo"
attributes.get('23') # => "foo"
attributes[23]       # => "foo"
attributes['23']     # => "foo"

attributes.get(:unknown)  # => nil
attributes.get('unknown') # => nil
attributes[:unknown]      # => nil
attributes['unknown']     # => nil

Parameters:

  • attribute (#to_s) —

    a String or any object that implements #to_s

Returns:

  • (Object, NilClass) —

    the associated value, if present

Since:

  • 0.3.2



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/hanami/utils/attributes.rb', line 68

def get(attribute)
  value = @attributes

  keys = attribute.to_s.split('.')
  keys.each do |key|
    break unless value

    value = value[key]
  end

  value.is_a?(Hash) ? self.class.new(value) : value
end

#set(attribute, value) ⇒ NilClass

Set the given value for the given attribute

Examples:

require 'hanami/utils/attributes'

attributes = Hanami::Utils::Attributes.new

attributes.set(:a, 1)
attributes.get(:a)  # => 1
attributes.get('a') # => 1

attributes.set('b', 2)
attributes.get(:b)  # => 2
attributes.get('b') # => 2

attributes.set(23, 'foo')
attributes.get(23)   # => "foo"
attributes.get('23') # => "foo"

Parameters:

  • attribute (#to_s) —

    a String or any object that implements #to_s

  • value (Object) —

    any value

Returns:

  • (NilClass)

Since:

  • 0.3.2



109
110
111
112
 
# File 'lib/hanami/utils/attributes.rb', line 109

def set(attribute, value)
  @attributes[attribute.to_s] = value
  nil
end

#to_h ⇒ ::Hash

Returns a deep duplicated copy of the attributes as a Hash

Returns:

  • (::Hash)

Since:

  • 0.3.2



119
120
121
122
123
124
125
 
# File 'lib/hanami/utils/attributes.rb', line 119

def to_h
  ::Hash[].tap do |result|
    @attributes.each do |k, v|
      result[k] = _read_value(v)
    end
  end
end