Class: Chef::FileCache

Inherits:
Object show all
Extended by:
Mixin::CreatePath, Mixin::ParamsValidate
Defined in:
lib/chef/file_cache.rb

Class Method Summary collapse

Methods included from Mixin::CreatePath

create_path

Methods included from Mixin::ParamsValidate

set_or_return, validate

Class Method Details

.create_cache_path(path, create_if_missing = true) ⇒ Object

Create a full path to a given file in the cache. By default, also creates the path if it does not exist.

Parameters

path

The path to create, relative to Chef::Config

create_if_missing

True by default - whether to create the path if it does not exist

Returns

String

The fully expanded path



194
195
196
197
198
199
200
201
 
# File 'lib/chef/file_cache.rb', line 194

def create_cache_path(path, create_if_missing=true)
  cache_dir = File.expand_path(File.join(Chef::Config[:file_cache_path], path))
  if create_if_missing
    create_path(cache_dir) 
  else
    cache_dir
  end
end

.delete(path) ⇒ Object

Delete a file from the File Cache

Parameters

path<String>

The path to the file you want to delete - should

be relative to Chef::Config[:file_cache_path]

Returns

true



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/chef/file_cache.rb', line 128

def delete(path)
  validate(
    {
      :path => path
    },
    {
      :path => { :kind_of => String },
    }
  )
  cache_path = create_cache_path(path, false)
  if File.exists?(cache_path)
    File.unlink(cache_path)
  end
  true
end

.has_key?(path) ⇒ Boolean

Whether or not this file exists in the Cache

Parameters

path

The path to the file you want to check - is relative 

to Chef::Config[:file_cache_path]

Returns

True

If the file exists

False

If it does not

Returns:

  • (Boolean) 


168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/chef/file_cache.rb', line 168

def has_key?(path)
  validate(
    {
      :path => path
    },
    {
      :path => { :kind_of => String },
    }
  )
  full_path = create_cache_path(path, false)
  if File.exists?(full_path)
    true
  else
    false
  end
end

.list ⇒ Object

List all the files in the Cache

Returns

Array

An array of files in the cache, suitable for use with load, delete and store



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/chef/file_cache.rb', line 148

def list()
  keys = Array.new
  Dir[File.join(Chef::Config[:file_cache_path], '**', '*')].each do |f|
    if File.file?(f)
      path = f.match("^#{Chef::Config[:file_cache_path]}\/(.+)")[1]
      keys << path
    end
  end
  keys
end

.load(path, read = true) ⇒ Object

Read a file from the File Cache

Parameters

path<String>

The path to the file you want to load - should

be relative to Chef::Config[:file_cache_path]
read<True/False>

Whether to return the file contents, or the path.

Defaults to true.

Returns

String

A string with the file contents, or the path to the file.

Raises

Chef::Exceptions::FileNotFound

If it cannot find the file in the cache

Raises:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/chef/file_cache.rb', line 102

def load(path, read=true)
  validate(
    {
      :path => path
    },
    {
      :path => { :kind_of => String }
    }
  )
  cache_path = create_cache_path(path, false)
  raise Chef::Exceptions::FileNotFound, "Cannot find #{cache_path} for #{path}!" unless File.exists?(cache_path)
  if read
    File.read(cache_path)
  else
    cache_path
  end
end

.move_to(file, path) ⇒ Object

Move a file in to the cache. Useful with the REST raw file output.

Parameteres

file<String>

The path to the file you want in the cache

path<String>

The relative name you want the new file to use



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/chef/file_cache.rb', line 65

def move_to(file, path)
  validate(
    {
      :file => file,
      :path => path
    },
    {
      :file => { :kind_of => String },
      :path => { :kind_of => String },
    }
  )
  
  file_path_array = File.split(path)
  file_name = file_path_array.pop
  if File.exists?(file) && File.writable?(file)
    FileUtils.mv(
      file, 
      File.join(create_cache_path(File.join(file_path_array), true), file_name)
    )
  else
    raise RuntimeError, "Cannot move #{file} to #{path}!"
  end
end

.store(path, contents) ⇒ Object

Write a file to the File Cache.

Parameters

path<String>

The path to the file you want to put in the cache - should

be relative to Chef::Config[:file_cache_path]
contents<String>

A string with the contents you want written to the file

Returns

true



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/chef/file_cache.rb', line 39

def store(path, contents)
  validate(
    {
      :path => path,
      :contents => contents
    },
    {
      :path => { :kind_of => String },
      :contents => { :kind_of => String },
    }
  )

  file_path_array = File.split(path)
  file_name = file_path_array.pop
  cache_path = create_cache_path(File.join(file_path_array))
  io = File.open(File.join(cache_path, file_name), "w")
  io.print(contents)
  io.close
  true
end