Contents

require 'fileutils'
module R10K
module Util
module Purgeable
  # Mixin for purging stale directory contents.
  #
  # @abstract Classes using this mixin need to implement {#managed_directory} and
  #   {#desired_contents}

  # @!method desired_contents
  #   @abstract Including classes must implement this method to list the
  #     expected filenames of managed_directory
  #   @return [Array<String>] A list of directory contents that should be present

  # @!method managed_directory
  #   @abstract Including classes must implement this method to return the
  #     path to the directory that can be purged
  #   @return [String] The path to the directory to be purged

  # @return [Array<String>] The present directory entries in `self.managed_directory`
  def current_contents
    dir = self.managed_directory
    glob_exp = File.join(dir, '*')

    Dir.glob(glob_exp).map do |fname|
      File.basename fname
    end
  end

  # @return [Array<String>] Directory contents that are expected but not present
  def pending_contents
    desired_contents - current_contents
  end

  # @return [Array<String>] Directory contents that are present but not expected
  def stale_contents
    current_contents - desired_contents
  end

  # Forcibly remove all unmanaged content in `self.managed_directory`
  def purge!
    stale_contents.each do |fname|
      fpath = File.join(self.managed_directory, fname)
      FileUtils.rm_rf fpath, :secure => true
    end
  end

end
end
end

Version data entries

26 entries across 26 versions & 1 rubygems

Version	Path
r10k-1.1.0rc1	lib/r10k/util/purgeable.rb
r10k-1.0.0	lib/r10k/util/purgeable.rb
r10k-1.0.0rc4	lib/r10k/util/purgeable.rb
r10k-1.0.0rc3	lib/r10k/util/purgeable.rb
r10k-1.0.0rc2	lib/r10k/util/purgeable.rb
r10k-1.0.0rc1	lib/r10k/util/purgeable.rb