Class: Chef::Node::ImmutableArray

Inherits:
Array
  • Object
show all
Includes:
Immutablize
Defined in:
lib/chef/node/immutable_collections.rb

Overview

== ImmutableArray ImmutableArray is used to implement Array collections when reading node attributes.

ImmutableArray acts like an ordinary Array, except:

  • Methods that mutate the array are overridden to raise an error, making the collection more or less immutable.
  • Since this class stores values computed from a parent Chef::Node::Attribute's values, it overrides all reader methods to detect staleness and raise an error if accessed when stale.

Instance Method Summary collapse

Methods included from Immutablize

#immutablize

Constructor Details

#initialize(array_data = []) ⇒ ImmutableArray


61
62
63
64
65
# File 'lib/chef/node/immutable_collections.rb', line 61

def initialize(array_data = [])
  array_data.each do |value|
    internal_push(immutablize(value))
  end
end

Instance Method Details

#convert_key(key) ⇒ Object

for consistency's sake -- integers 'converted' to integers


94
95
96
# File 'lib/chef/node/immutable_collections.rb', line 94

def convert_key(key)
  key
end

#dupObject


74
75
76
# File 'lib/chef/node/immutable_collections.rb', line 74

def dup
  Array.new(map { |e| safe_dup(e) })
end

#safe_dup(e) ⇒ Object

For elements like Fixnums, true, nil...


68
69
70
71
72
# File 'lib/chef/node/immutable_collections.rb', line 68

def safe_dup(e)
  e.dup
rescue TypeError
  e
end

#to_aObject Also known as: to_array


78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/chef/node/immutable_collections.rb', line 78

def to_a
  Array.new(map do |v|
    case v
    when ImmutableArray
      v.to_a
    when ImmutableMash
      v.to_h
    else
      safe_dup(v)
    end
  end)
end