Class: Puppet::Property::List

Inherits:
Puppet::Property show all
Defined in:
lib/puppet/property/list.rb

Overview

This subclass of Puppet::Property manages an unordered list of values. For an ordered list see OrderedList.

Direct Known Subclasses

OrderedList

Constant Summary

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Instance Attribute Summary

Attributes inherited from Puppet::Property

#noop, #shouldorig

Attributes inherited from Puppet::Parameter

#name, #parent, #resource, #sensitive

Attributes included from Util::Docs

#doc, #nodoc

Instance Method Summary collapse

Methods inherited from Puppet::Property

#call_provider, #change_to_s, #event, #event_name, idempotent, idempotent=, #idempotent?, #insync_values?, #log, #match_all?, method_added, #name, newvalue, #property_matches?, #safe_insync?, #set, #should=, #should_to_s, #sync, #unsafe_validate, #validate_features_per_value, #value, #value=, value_name, value_option

Methods inherited from Puppet::Parameter

aliasvalue, defaultto, desc, doc, #file, #format, format_value_for_display, #initialize, initvars, isnamevar, #isnamevar?, isnamevar?, isrequired, #line, #log, #metaparam?, munge, #munge, newvalues, nodefault, #noop, #path, #pathbuilder, #provider, proxymethods, #remove, #required?, required?, sensitive, #tags, #to_s, unmunge, #unmunge, #unsafe_munge, #unsafe_unmunge, #unsafe_validate, validate, #validate, #value, #value=, #version

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, create_erb, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::Logging

#clear_deprecation_warnings, #debug, #deprecation_warning, #format_backtrace, #format_exception, #get_deprecation_offender, #log_and_raise, #log_deprecations_to_file, #log_exception, #puppet_deprecation_warning, #send_log, setup_facter_logging!, #warn_once

Methods included from Util::Errors

#adderrorcontext, #devfail, #error_context, error_location, error_location_with_space, error_location_with_unknowns, #exceptwrap, #fail

Constructor Details

This class inherits a constructor from Puppet::Parameter

Instance Method Details

#add_should_with_current(should, current) ⇒ Object 



19
20
21
22
 
# File 'lib/puppet/property/list.rb', line 19

def add_should_with_current(should, current)
  should += current if current.is_a?(Array)
  should.uniq
end

#dearrayify(array) ⇒ Object

dearrayify was motivated because to simplify the implementation of the OrderedList property



29
30
31
 
# File 'lib/puppet/property/list.rb', line 29

def dearrayify(array)
  array.sort.join(delimiter)
end

#delimiter ⇒ Object 



43
44
45
 
# File 'lib/puppet/property/list.rb', line 43

def delimiter
  ","
end

#inclusive? ⇒ Boolean

Returns:



24
25
26
 
# File 'lib/puppet/property/list.rb', line 24

def inclusive?
  @resource[membership] == :inclusive
end

#insync?(is) ⇒ Boolean

Returns:



64
65
66
67
68
 
# File 'lib/puppet/property/list.rb', line 64

def insync?(is)
  return true unless is

  (prepare_is_for_comparison(is) == should)
end

#is_to_s(currentvalue) ⇒ Object

rubocop:disable Naming/PredicateName



11
12
13
 
# File 'lib/puppet/property/list.rb', line 11

def is_to_s(currentvalue) # rubocop:disable Naming/PredicateName
  currentvalue == :absent ? super(currentvalue) : currentvalue.join(delimiter)
end

#membership ⇒ Object 



15
16
17
 
# File 'lib/puppet/property/list.rb', line 15

def membership
  :membership
end

#prepare_is_for_comparison(is) ⇒ Object 



57
58
59
60
61
62
 
# File 'lib/puppet/property/list.rb', line 57

def prepare_is_for_comparison(is)
  if is == :absent
    is = []
  end
  dearrayify(is)
end

#retrieve ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'lib/puppet/property/list.rb', line 47

def retrieve
  # ok, some 'convention' if the list property is named groups, provider should implement a groups method
  tmp = provider.send(name) if provider
  if tmp && tmp != :absent
    tmp.instance_of?(Array) ? tmp : tmp.split(delimiter)
  else
    :absent
  end
end

#should ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/puppet/property/list.rb', line 33

def should
  return nil unless @should

  members = @should
  # inclusive means we are managing everything so if it isn't in should, its gone
  members = add_should_with_current(members, retrieve) unless inclusive?

  dearrayify(members)
end