Module: Puppet::Util::Tagging
- Included in:
- Resource, Resource::Catalog, Resource::Status, Transaction, Transaction::Event, Type, Log, SkipTags
- Defined in:
- lib/puppet/util/tagging.rb
Constant Summary collapse
- ValidTagRegex =
/\A[[:alnum:]_][[:alnum:]_:.-]*\Z/u
Instance Method Summary collapse
-
#merge_into(tag_set) ⇒ Object
Merge the tags of this instance into the provide TagSet.
-
#merge_tags_from(tag_source) ⇒ Object
Merge tags from a tagged instance with no attempts to split, downcase or verify the tags.
-
#raw_tagged?(tag_array) ⇒ Boolean
Answers if this resource is tagged with at least one of the tags given in downcased string form.
-
#set_tags(tag_source) ⇒ Object
Only use this method when copying known tags from one Tagging instance to another.
-
#tag(*ary) ⇒ Object
Add a tag to the current tag set.
-
#tag_if_valid(name) ⇒ Object
Add a name to the current tag set.
-
#tagged?(*tags) ⇒ Boolean
Answers if this resource is tagged with at least one of the given tags.
-
#tags ⇒ Object
Return a copy of the tag list, so someone can’t ask for our tags and then modify them.
- #tags=(tags) ⇒ Object
- #valid_tag?(maybe_tag) ⇒ Boolean
Instance Method Details
#merge_into(tag_set) ⇒ Object
Merge the tags of this instance into the provide TagSet
96 97 98 |
# File 'lib/puppet/util/tagging.rb', line 96 def merge_into(tag_set) tag_set.merge(@tags) unless @tags.nil? end |
#merge_tags_from(tag_source) ⇒ Object
Merge tags from a tagged instance with no attempts to split, downcase or verify the tags
90 91 92 93 |
# File 'lib/puppet/util/tagging.rb', line 90 def (tag_source) @tags ||= tag_source.merge_into(@tags) end |
#raw_tagged?(tag_array) ⇒ Boolean
Answers if this resource is tagged with at least one of the tags given in downcased string form.
The method is a faster variant of the tagged? method that does no conversion of its arguments.
71 72 73 74 |
# File 'lib/puppet/util/tagging.rb', line 71 def raw_tagged?(tag_array) = self. !tag_array.index { |t| .include?(t) }.nil? end |
#set_tags(tag_source) ⇒ Object
Only use this method when copying known tags from one Tagging instance to another
77 78 79 |
# File 'lib/puppet/util/tagging.rb', line 77 def (tag_source) @tags = tag_source. end |
#tag(*ary) ⇒ Object
Add a tag to the current tag set. When a tag set is used for a scope, these tags will be added to all of the objects contained in this scope when the objects are finished.
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/puppet/util/tagging.rb', line 10 def tag(*ary) @tags ||= ary.flatten.compact.each do |tag| name = tag.to_s.downcase # Add the tag before testing if it's valid since this means that # we never need to test the same valid tag twice. This speeds things # up since we get a lot of duplicates and rarely fail on bad tags if @tags.add?(name) # not seen before, so now we test if it is valid if valid_tag?(name) if # avoid adding twice by first testing if the string contains '::' @tags.merge(name.split('::')) if name.include?('::') end else @tags.delete(name) fail(Puppet::ParseError, _("Invalid tag '%{name}'") % { name: name }) end end end end |
#tag_if_valid(name) ⇒ Object
Add a name to the current tag set. Silently ignore names that does not represent valid tags.
Use this method instead of doing this:
tag(name) if is_valid?(name)
since that results in testing the same string twice
42 43 44 45 46 47 48 49 50 |
# File 'lib/puppet/util/tagging.rb', line 42 def tag_if_valid(name) if name.is_a?(String) && valid_tag?(name) name = name.downcase @tags ||= if @tags.add?(name) && name.include?('::') @tags.merge(name.split('::')) end end end |
#tagged?(*tags) ⇒ Boolean
Answers if this resource is tagged with at least one of the given tags.
The given tags are converted to downcased strings before the match is performed.
59 60 61 |
# File 'lib/puppet/util/tagging.rb', line 59 def tagged?(*) raw_tagged?(.collect {|t| t.to_s.downcase}) end |
#tags ⇒ Object
Return a copy of the tag list, so someone can’t ask for our tags and then modify them.
83 84 85 86 |
# File 'lib/puppet/util/tagging.rb', line 83 def @tags ||= @tags.dup end |
#tags=(tags) ⇒ Object
100 101 102 103 104 105 106 107 |
# File 'lib/puppet/util/tagging.rb', line 100 def () @tags = return if .nil? = .strip.split(/\s*,\s*/) if .is_a?(String) tag(*) end |
#valid_tag?(maybe_tag) ⇒ Boolean
109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/puppet/util/tagging.rb', line 109 def valid_tag?(maybe_tag) begin tag_enc = maybe_tag.encoding if tag_enc == Encoding::UTF_8 || tag_enc == Encoding::ASCII maybe_tag =~ ValidTagRegex else maybe_tag.encode(Encoding::UTF_8) =~ ValidTagRegex end rescue Encoding::UndefinedConversionError, Encoding::InvalidByteSequenceError false end end |