summaryrefslogtreecommitdiff
path: root/lib/chef/node/mixin/immutablize_array.rb
blob: b5e0993cfac130c66f3487ffcae45c4f87e997b1 (plain)
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
#--
# Copyright:: Copyright 2016-2018, Chef Software 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.
#

class Chef
  class Node
    module Mixin
      module ImmutablizeArray
        # Allowed methods that MUST NOT mutate the object
        # (if any of these methods mutate the underlying object that is a bug that needs to be fixed)
        ALLOWED_METHODS = [
          :&,
          :*,
          :+,
          :-,
          :[],
          :abbrev,
          :all?,
          :any?,
          :assoc,
          :at,
          :bsearch,
          :bsearch_index,
          :chunk,
          :chunk_while,
          :collect,
          :collect_concat,
          :combination,
          :compact,
          :count,
          :cycle,
          :detect,
          :dig,
          :drop,
          :drop_while,
          :each,
          :each_cons,
          :each_entry,
          :each_index,
          :each_slice,
          :each_with_index,
          :each_with_object,
          :empty?,
          :entries,
          :fetch,
          :find,
          :find_all,
          :find_index,
          :first,
          :flat_map,
          :flatten,
          :grep,
          :grep_v,
          :group_by,
          :include?,
          :index,
          :inject,
          :join,
          :last,
          :lazy,
          :length,
          :map,
          :max,
          :max_by,
          :member?,
          :min,
          :min_by,
          :minmax,
          :minmax_by,
          :none?,
          :one?,
          :pack,
          :partition,
          :permutation,
          :product,
          :rassoc,
          :reduce,
          :reject,
          :repeated_combination,
          :repeated_permutation,
          :reverse,
          :reverse_each,
          :rindex,
          :rotate,
          :sample,
          :save_plist,
          :select,
          :shelljoin,
          :shuffle,
          :size,
          :slice,
          :slice_after,
          :slice_before,
          :slice_when,
          :sort,
          :sort_by,
          :sum,
          :take,
          :take_while,
          :to_a,
          :to_ary,
          :to_csv,
          :to_h,
          :to_plist,
          :to_set,
          :transpose,
          :uniq,
          :values_at,
          :zip,
          :|,
        ].freeze
        # A list of methods that mutate Array. Each of these is overridden to
        # raise an error, making this instances of this class more or less
        # immutable.
        DISALLOWED_MUTATOR_METHODS = [
          :<<,
          :[]=,
          :append,
          :clear,
          :collect!,
          :compact!,
          :concat,
          :default=,
          :default_proc=,
          :delete,
          :delete_at,
          :delete_if,
          :fill,
          :flatten!,
          :insert,
          :keep_if,
          :map!,
          :merge!,
          :pop,
          :prepend,
          :push,
          :reject!,
          :replace,
          :reverse!,
          :rotate!,
          :select!,
          :shift,
          :shuffle!,
          :slice!,
          :sort!,
          :sort_by!,
          :uniq!,
          :unshift,
        ].freeze

        # Redefine all of the methods that mutate a Hash to raise an error when called.
        # This is the magic that makes this object "Immutable"
        DISALLOWED_MUTATOR_METHODS.each do |mutator_method_name|
          define_method(mutator_method_name) do |*args, &block|
            raise Exceptions::ImmutableAttributeModification
          end
        end
      end
    end
  end
end