Contents

# Equivalent to a header guard in C/C++
# Used to prevent the class/module from being loaded more than once
unless defined? Castanaut

  # The Castanaut module. For orienting yourself within the code, it's
  # recommended you begin with the documentation for the Movie class,
  # which is the big one.
  #
  # Execution typically begins with the Main class.
  module Castanaut

    # :stopdoc:
    VERSION = '1.1.1'
    LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
    PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR

    FILE_RUNNING = "/tmp/castanaut.running"
    FILE_APPLESCRIPT = "/tmp/castanaut.scpt"
    # :startdoc:

    # Returns the version string for the library.
    #
    def self.version
      VERSION
    end

    # Returns the library path for the module. If any arguments are given,
    # they will be joined to the end of the libray path using
    # <tt>File.join</tt>.
    #
    def self.libpath( *args )
      args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
    end

    # Returns the lpath for the module. If any arguments are given,
    # they will be joined to the end of the path using
    # <tt>File.join</tt>.
    #
    def self.path( *args )
      args.empty? ? PATH : ::File.join(PATH, *args)
    end

    # Utility method used to rquire all files ending in .rb that lie in the
    # directory below this file that has the same name as the filename passed
    # in. Optionally, a specific _directory_ name can be passed in such that
    # the _filename_ does not have to be equivalent to the directory.
    #
    def self.require_all_libs_relative_to( fname, dir = nil )
      dir ||= ::File.basename(fname, '.*')
      search_me = ::File.expand_path(
          ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

      Dir.glob(search_me).sort.each {|rb| require rb}
    end

  end  # module Castanaut

  Castanaut.require_all_libs_relative_to __FILE__

end  # unless defined?

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
castanaut-1.1.1	lib/castanaut.rb