class Chef::ChefFS::FileSystem::BaseFSObject

Attributes

bare_name[R]
display_name[R]
display_path[R]
name[R]
parent[R]
path[R]

Public Class Methods

new(name, parent) click to toggle source
# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 26
def initialize(name, parent)
  @parent = parent
  @name = name
  if parent
    @path = Chef::ChefFS::PathUtils.join(parent.path, name)
  else
    if name != ""
      raise ArgumentError, "Name of root object must be empty string: was '#{name}' instead"
    end

    @path = "/"
  end
end

Public Instance Methods

can_have_child?(name, is_dir) click to toggle source

Override can_have_child? to report whether a given file could be added to this directory. (Some directories can’t have subdirs, some can only have .json files, etc.)

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 88
def can_have_child?(name, is_dir)
  false
end
chef_object() click to toggle source

Expand this entry into a chef object (Chef::Role, ::Node, etc.)

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 117
def chef_object
  raise NotFoundError.new(self) unless exists?

  nil
end
child(name) click to toggle source

Get a child of this entry with the given name. This MUST always return a child, even if it is NonexistentFSObject. Overriders should take caution not to do expensive network requests to get the list of children to fulfill this request, unless absolutely necessary here; it is intended as a quick way to traverse a hierarchy.

For example, knife show /data_bags/x/y.json will call root.child(‘data_bags’).child(‘x’).child(‘y.json’), which can then directly perform a network request to retrieve the y.json data bag. No network request was necessary to retrieve

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 102
def child(name)
  if can_have_child?(name, true) || can_have_child?(name, false)
    result = make_child_entry(name)
  end
  result || NonexistentFSObject.new(name, self)
end
children() click to toggle source

Override children to report your actual list of children as an array.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 110
def children
  raise NotFoundError.new(self) unless exists?

  []
end
compare_to(other) click to toggle source

Override this if you have a special comparison algorithm that can tell you whether this entry is the same as another–either a quicker or a more reliable one. Callers will use this to decide whether to upload, download or diff an object.

You should not override this if you’re going to do the standard +self.read == other.read+. If you return nil, the caller will call +other.compare_to(you)+ instead. Give them a chance :)

Parameters

  • other - the entry to compare to

Returns

  • +[ are_same, value, other_value ]+ are_same may be true, false or nil (which means “don’t know”). value and other_value must either be the text of self or other, :none (if the entry does not exist or has no value) or nil if the value was not retrieved.

  • nil if a definitive answer cannot be had and nothing was retrieved.

Example

are_same, value, other_value = entry.compare_to(other)
if are_same.nil?
  are_same, other_value, value = other.compare_to(entry)
end
if are_same.nil?
  value = entry.read if value.nil?
  other_value = entry.read if other_value.nil?
  are_same = (value == other_value)
end
# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 81
def compare_to(other)
  nil
end
create_child(name, file_contents) click to toggle source

Create a child of this entry with the given name and contents. If contents is nil, create a directory.

NOTE: create_child_from is an optional method that can also be added to your entry class, and will be called without actually reading the file_contents. This is used for knife upload /cookbooks/cookbookname.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 129
def create_child(name, file_contents)
  raise NotFoundError.new(self) unless exists?

  raise OperationNotAllowedError.new(:create_child, self)
end
delete(recurse) click to toggle source

Delete this item, possibly recursively. Entries MUST NOT delete a directory unless recurse is true.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 137
def delete(recurse)
  raise NotFoundError.new(self) unless exists?

  raise OperationNotAllowedError.new(:delete, self)
end
dir?() click to toggle source

Ask whether this entry is a directory. If not, it is a file.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 144
def dir?
  false
end
exists?() click to toggle source

Ask whether this entry exists.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 149
def exists?
  true
end
path_for_printing() click to toggle source

Printable path, generally used to distinguish paths in one root from paths in another.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 155
def path_for_printing
  if parent
    parent_path = parent.path_for_printing
    if parent_path == "."
      name
    else
      Chef::ChefFS::PathUtils.join(parent.path_for_printing, name)
    end
  else
    name
  end
end
read() click to toggle source

Read the contents of this file entry.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 173
def read
  raise NotFoundError.new(self) unless exists?

  raise OperationNotAllowedError.new(:read, self)
end
root() click to toggle source
# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 168
def root
  parent ? parent.root : self
end
write(file_contents) click to toggle source

Write the contents of this file entry.

# File lib/chef/chef_fs/file_system/base_fs_object.rb, line 180
def write(file_contents)
  raise NotFoundError.new(self) unless exists?

  raise OperationNotAllowedError.new(:write, self)
end