Class R10K::Util::Basedir
In: lib/r10k/util/basedir.rb
Parent: Object

Represents a directory that can purge unmanaged contents

@todo pick a better name than basedir. Expect this class to be renamed.

@api private

Methods

desired_contents   from_deployment   managed_directory   new   purge!  

Included Modules

R10K::Util::Purgeable R10K::Logging

Public Class methods

from_deployment(path, deployment)

Create a new Basedir by selecting sources from a deployment that match the specified path.

@param path [String] @param deployment [R10K::Deployment]

@return [R10K::Util::Basedir]

new(path, sources)

@param path [String] The path to the directory to manage @param sources [Array<desired_contents>] A list of objects that may create filesystem entries

Public Instance methods

desired_contents()

List all environments that should exist in this basedir @note This implements a required method for the Purgeable mixin @return [Array<String>]

managed_directory()

Return the path of the basedir @note This implements a required method for the Purgeable mixin @return [String]

[Validate]