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, #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 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, #cookbook_version, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #identity, identity_attr, #ignore_failure, #immediate_notifications, #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_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 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.



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

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
  @diff = nil
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 



61
62
63
64
65
66
67
 
# File 'lib/chef/resource/file.rb', line 61

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

#checksum(arg = nil) ⇒ Object 



69
70
71
72
73
74
75
 
# File 'lib/chef/resource/file.rb', line 69

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

#content(arg = nil) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/chef/resource/file.rb', line 53

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

#diff(arg = nil) ⇒ Object 



85
86
87
88
89
90
91
 
# File 'lib/chef/resource/file.rb', line 85

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

#path(arg = nil) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/chef/resource/file.rb', line 77

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