1
2
3
4
5
6
7
8
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
#
# Author:: Adam Jacob (<adam@opscode.com>)
# Author:: Christopher Walters (<cw@opscode.com>)
# Copyright:: Copyright (c) 2008, 2009 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require 'chef/resource_collection/resource_set'
require 'chef/resource_collection/resource_list'
require 'chef/resource_collection/resource_collection_serialization'
require 'chef/log'
require 'forwardable'
##
# ResourceCollection currently handles two tasks:
# 1) Keeps an ordered list of resources to use when converging the node
# 2) Keeps a unique list of resources (keyed as `type[name]`) used for notifications
class Chef
class ResourceCollection
include ResourceCollectionSerialization
extend Forwardable
def initialize
@resource_set = ResourceSet.new
@resource_list = ResourceList.new
end
# @param resource [Chef::Resource] The resource to insert
# @param resource_type [String,Symbol] If known, the resource type used in the recipe, Eg `package`, `execute`
# @param instance_name [String] If known, the recource name as used in the recipe, IE `vim` in `package 'vim'`
# @param at_location [Integer] If know, a location in the @resource_list to insert resource
# If you know the at_location but not the resource_type or instance_name, pass them in as nil
# This method is meant to be the 1 insert method necessary in the future. It should support all known use cases
# for writing into the ResourceCollection.
def insert(resource, resource_type:nil, instance_name:nil, at_location:nil)
if at_location
@resource_list.insert_at(at_location, resource)
else
@resource_list.insert(resource)
end
if !(resource_type.nil? && instance_name.nil?)
@resource_set.insert_as(resource, resource_type, instance_name)
else
@resource_set.insert_as(resource)
end
end
# @param insert_at_index [Integer] Location to insert resources
# @param resources [Chef::Resource] Resources to insert
# @deprecated Callers should use the insert method above and loop through their resources as necessary
def insert_at(insert_at_index, *resources)
Chef::Log.warn("`insert_at` is deprecated, use `insert` with the `at_location` parameter")
@resource_list.insert_at(insert_at_index, *resources)
resources.each do |resource|
@resource_set.insert_as(resource)
end
end
# @deprecated
def []=(index, resource)
Chef::Log.warn("`[]=` is deprecated, use `insert` with the `at_location` parameter")
@resource_list[index] = resource
@resource_set.insert_as(resource)
end
# @deprecated
def <<(*resources)
Chef::Log.warn("`<<` is deprecated, use `insert`")
resources.flatten.each do |res|
insert(res)
end
self
end
# @deprecated
alias_method :push, :<<
# Read-only methods are simple to delegate - doing that below
RESOURCE_LIST_METHODS = Enumerable.instance_methods +
[:iterator, :all_resources, :[], :each, :execute_each_resource, :each_index, :empty?] -
[:find] # find needs to run on the set
RESOURCE_SET_METHODS = [:lookup, :find, :resources, :keys, :validate_lookup_spec!]
def_delegators :@resource_list, *RESOURCE_LIST_METHODS
def_delegators :@resource_set, *RESOURCE_SET_METHODS
end
end
|