Contents

# Cotta module that contains all the classes used for file operations
# see link:files/README.html
# There are also four methods on the module for the most common ways to
# start with Cotta API
module Cotta
  # Creates CottaFile repersenting physical file
  def self::file(path)
    FileFactory.file(path)
  end

  # Creates CottaDir representing physical directory
  def self::dir(path)
    FileFactory.dir(path)
  end

  # Creates CottaDir that is the parent of the path
  # This is typically used with __FILE__
  # e.g. dir = Cotta.parent_dir(__FILE__)
  def self.parent_dir(path)
    FileFactory.parent_dir(path)
  end

  # Returns the file facotry backed by physical system
  def self::physical
    FileFactory.physical
  end

  # Returns the file factory backed by in-memory system
  def self::in_memory
    FileFactory.in_memory
  end

  # returns the file factory backed by the given system
  def self::factory(system)
    FileFactory.new(system)
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
cotta-1.0.0	lib/cotta/cotta.rb