Class: Chef::Resource::File

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

Direct Known Subclasses

CookbookFile, RemoteFile, Template

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, 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, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods included from Mixin::Securable

#group, #inherits, #mode, #owner, rights_attribute

Methods inherited from Chef::Resource

#action, #add_notification, #after_created, #as_json, attribute, build_from_file, #defined_at, #epic_fail, #ignore_failure, #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, provides, #resolve_notification_references, resource_for_node, resource_for_platform, #resources, #run_action, #should_skip?, #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?, #platform_family?, #search, #value_for_platform, #value_for_platform_family

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.



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

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)
  @provider = Chef::Provider::File
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 



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

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

#checksum(arg = nil) ⇒ Object 



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

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

#content(arg = nil) ⇒ Object 



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

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

#path(arg = nil) ⇒ Object 



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

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