Class: Chef::Resource::File

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

Direct Known Subclasses

CookbookFile, RemoteFile, Template

Constant Summary

Constants inherited from Chef::Resource

HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #delayed_notifications, #enclosing_provider, #immediate_notifications, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #add_notification, attribute, build_from_file, #epic_fail, #ignore_failure, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #resolve_notification_references, #resources, #run_action, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_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 Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, run_context = nil) ⇒ File

Returns a new instance of File.



25
26
27
28
29
30
31
32
 
# File 'lib/chef/resource/file.rb', line 25

def initialize(name, run_context=nil)
  super
  @resource_name = :file
  @path = name
  @backup = 5
  @action = "create"
  @allowed_actions.push(:create, :delete, :touch, :create_if_missing)
end

Dynamic Method Handling

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

Instance Method Details

#backup(arg = nil) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/chef/resource/file.rb', line 42

def backup(arg=nil)
  set_or_return(
    :backup,
    arg,
    :kind_of => [ Integer, FalseClass ]
  )
end

#checksum(arg = nil) ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/chef/resource/file.rb', line 50

def checksum(arg=nil)
  set_or_return(
    :checksum,
    arg,
    :regex => /^[a-zA-Z0-9]{64}$/
  )
end

#content(arg = nil) ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/chef/resource/file.rb', line 34

def content(arg=nil)
  set_or_return(
    :content,
    arg,
    :kind_of => String
  )
end

#group(arg = nil) ⇒ Object 



58
59
60
61
62
63
64
 
# File 'lib/chef/resource/file.rb', line 58

def group(arg=nil)
  set_or_return(
    :group,
    arg,
    :regex => Chef::Config[:group_valid_regex]
  )
end

#mode(arg = nil) ⇒ Object 



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

def mode(arg=nil)
  set_or_return(
    :mode,
    arg,
    :regex => /^0?\d{3,4}$/
  )
end

#owner(arg = nil) ⇒ Object 



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

def owner(arg=nil)
  set_or_return(
    :owner,
    arg,
    :regex => Chef::Config[:user_valid_regex]
  )
end

#path(arg = nil) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/chef/resource/file.rb', line 82

def path(arg=nil)
  set_or_return(
    :path,
    arg,
    :kind_of => String
  )
end