Class: Chef::Resource::Group

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/group.rb

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, find_subclass_by_name, #identity, identity_attr, #ignore_failure, #immediate_notifications, inherited, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, platform_map, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_classes, resource_for_node, resource_for_platform, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::PlatformIntrospection

#platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Constructor Details

#initialize(name, run_context = nil) ⇒ Group

Returns a new instance of Group.



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/chef/resource/group.rb', line 28

def initialize(name, run_context=nil)
  super
  @resource_name = :group
  @group_name = name
  @gid = nil
  @members = []
  @action = :create
  @append = false
  @allowed_actions.push(:create, :remove, :modify, :manage)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#append(arg = nil) ⇒ Object 



66
67
68
69
70
71
72
 
# File 'lib/chef/resource/group.rb', line 66

def append(arg=nil)
  set_or_return(
    :append,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#gid(arg = nil) ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/chef/resource/group.rb', line 47

def gid(arg=nil)
  set_or_return(
    :gid,
    arg,
    :kind_of => [ String, Integer ]
  )
end

#group_name(arg = nil) ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/chef/resource/group.rb', line 39

def group_name(arg=nil)
  set_or_return(
    :group_name,
    arg,
    :kind_of => [ String ]
  )
end

#members(arg = nil) ⇒ Object Also known as: users 



55
56
57
58
59
60
61
62
 
# File 'lib/chef/resource/group.rb', line 55

def members(arg=nil)
  converted_members = arg.is_a?(String) ? [].push(arg) : arg
  set_or_return(
    :members,
    converted_members,
    :kind_of => [ Array ]
  )
end

#system(arg = nil) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/chef/resource/group.rb', line 74

def system(arg=nil)
  set_or_return(
    :system,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end