Class: Chef::Resource::File

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

Direct Known Subclasses

CookbookFile, RemoteFile, Template

Defined Under Namespace

Classes: Verification

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary collapse

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #declared_type, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #ignore_failure, #not_if_args, #only_if_args, #params, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #sensitive, #source_line, #updated

Instance Method Summary collapse

Methods included from Mixin::Securable

#group, included, #mode, #owner

Methods included from Mixin::Securable::WindowsSecurableAttributes

#inherits

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #declared_key, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #immediate_notifications, #inspect, #is, json_create, #load_from, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, #provider, #provider=, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #supports, #supports=, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action, #validate_resource_spec!

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

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

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::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ File

Returns a new instance of File.



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/chef/resource/file.rb', line 43

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)
  @atomic_update = Chef::Config[:file_atomic_update]
  @force_unlink = false
  @manage_symlink_source = nil
  @diff = nil
  @verifications = []
end

Dynamic Method Handling

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

Instance Attribute Details

#checksum(arg = nil) ⇒ Object 



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

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

Instance Method Details

#atomic_update(arg = nil) ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/chef/resource/file.rb', line 97

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

#backup(arg = nil) ⇒ Object 



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

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

#content(arg = nil) ⇒ Object 



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

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

#diff(arg = nil) ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/chef/resource/file.rb', line 89

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

#force_unlink(arg = nil) ⇒ Object 



105
106
107
108
109
110
111
 
# File 'lib/chef/resource/file.rb', line 105

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

#manage_symlink_source(arg = nil) ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/chef/resource/file.rb', line 113

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

#path(arg = nil) ⇒ Object 



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

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

#verify(command = nil, opts = {}, &block) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/chef/resource/file.rb', line 121

def verify(command=nil, opts={}, &block)
  if ! (command.nil? || [String, Symbol].include?(command.class))
    raise ArgumentError, "verify requires either a string, symbol, or a block"
  end

  if command || block_given?
    @verifications << Verification.new(self, command, opts, &block)
  else
    @verifications
  end
end