folio 0.2.0 → 0.3.0

data/lib/folio/directory.rb

@@ -11,6 +11,11 @@ module Folio
 
     def directory?   ; true  ; end
 
+    # Opens up a Folio prompt at this directory.
+    def prompt
+      Folio::Prompt.new(self)
+    end
+
     # We have to use FileUtils here b/c of some obscure
     # secutiry issues.
 
@@ -101,17 +106,17 @@ module Folio
 
     # Returns an Enumerator over all file objects in the directory.
     def files
-      entries.to_enum(:each){ |f| FileObject[path, f] }
+      entries.map{ |f| FileObject[path, f] }
     end
 
     # Returns an Enumerator over all documents in the directory.
     def documents
-      document_entries.to_enum(:each){ |f| FileObject[path, f] }
+      document_entries.map{ |f| FileObject[path, f] }
     end
 
     # Returns an Enumerator over all directories in the directory.
     def directories
-      directory_entries.to_enum(:each){ |f| FileObject[path, f] }
+      directory_entries.map{ |f| FileObject[path, f] }
     end
 
     # Join path and return new file object.

data/lib/folio/document.rb

@@ -2,6 +2,10 @@ require 'folio/fileobject'
 
 module Folio
 
+  # = Document
+  #
+  # The Document class represents a FileObject.
+  #
   class Document < FileObject
 
     def intialize(path)

data/lib/folio/errors.rb

@@ -3,5 +3,8 @@ module Folio
   class FileNotFound < ::IOError
   end
 
+  class LinkNotFound < ::IOError
+  end
+
 end
 

data/lib/folio/fileobject.rb

@@ -1,9 +1,9 @@
 require 'enumerator'
 require 'fileutils'
 
-class Enumerator
-  alias_method :list, :to_a
-end
+#class Enumerator
+#  alias_method :list, :to_a
+#end
 
 
 module Folio
@@ -11,7 +11,7 @@ module Folio
   # = File Object
   #
   # Base class for all folio objects.
-  #
+
   class FileObject
 
     Separator = ::File::Separator
@@ -20,7 +20,7 @@ module Folio
     def self.[](*path)
       path = ::File.join(*path)
 
-      raise FileNotFound unless ::File.exist?(path)
+      raise FileNotFound, "#{path}" unless ::File.exist?(path)
 
       case ::File.ftype(path)
       when 'file'
@@ -45,15 +45,19 @@ module Folio
   private
 
     def initialize(path)
-      raise FileNotFound unless ::File.exist?(path)
-      @relpath = path
-      @path    = ::File.expand_path(path)
+      raise FileNotFound, "#{path}" unless ::File.exist?(path)
+      @path = ::File.expand_path(path)
     end
 
   public
 
     attr :path
-    attr :relpath
+
+    def ==(other)
+#p @path, other.path
+      return false unless FileObject===other
+      @path == other.path
+    end
 
     # This will alwasy be true, EXCEPT when
     # #rm, #delete or #unlink have been used.
@@ -62,6 +66,11 @@ module Folio
     end
     alias_method :exists?, :exist?
 
+    # Returns the parent directory object.
+    def parent
+      self.class[File.dirname(path)]
+    end
+
     #--
     # File Manipulation
     #++
@@ -90,7 +99,6 @@ module Folio
 
     def rename(dest)
       ::File.rename(path, dest)
-      @relpath = dest
       @path = ::File.expand_path(dest)
     end
     alias_method :mv, :rename
@@ -137,6 +145,7 @@ module Folio
       util.install(path, dest, mode)
     end
 
+    #
     def touch
       util.touch(path)
     end

data/lib/folio/link.rb

@@ -6,11 +6,17 @@ module Folio
 
     def initialize(path)
       super
-      raise FileNotFound unless ::File.symlink?(@path)
+      raise LinkNotFound, "#{path}" unless ::File.symlink?(@path)
 
-      @folio = Folio.new(::File.readlink(path))
+      dir  = ::File.dirname(@path)
+      name = ::File.readlink(@path)
+      file = File.join(dir, name)
+
+      @target = Folio.file(file)
     end
 
+    attr :target
+
     #--
     # Am I write to think any file object can be linked?
     #++
@@ -39,9 +45,9 @@ module Folio
       ::File.lstat(path)
     end
 
-    #    
+    #
     def method_missing(s, *a, &b)
-      @folio.send(s, *a, &b)
+      @target.send(s, *a, &b)
     end
 
   end

data/lib/folio/pipe.rb

@@ -2,6 +2,10 @@ require 'folio/fileobject'
 
 module Folio
 
+  # = Pipe
+  #
+  # Is this the same as a FIFO?
+  #
   class Pipe < FileObject
 
     def initialize(path)

data/lib/folio/{prompt.rb → shell.rb}

@@ -1,22 +1,13 @@
-=begin
-
-= Folio Prompt
-
-A Folio Prompt object emulates a file system shell prompt in code.
-
-=end
-
 module Folio
+  require 'folio/xdg'
 
   # = Prompt class
   #
-  class Prompt
-
-    # @work store the present working directory
-    # as a Directory object.
-    attr :work
+  # A Folio Shell object provides a limited file system shell in code.
+  #
+  class Shell
 
-    #
+    # New Shell object.
     def initialize(*path)
       opts = (Hash===path.last ? path.pop : {})
       mode(opts)
@@ -27,10 +18,10 @@ module Folio
         path = File.join(*path)
       end
 
-      raise FileNotFound unless ::File.exist?(path)
-      raise FileNotFound unless ::File.directory?(path)
+      raise FileNotFound, "#{path}" unless ::File.exist?(path)
+      raise FileNotFound, "#{path}" unless ::File.directory?(path)
 
-      @path = Directory.new(path)
+      @work = Directory.new(path)
     end
 
     # Opertaton mode. This can be :noop, :verbose or :dryrun.
@@ -50,12 +41,31 @@ module Folio
       end
     end
 
+    # String representation is work directory path.
     def to_s ; work.to_s ; end
 
+    # Present working directory as a Directory object.
+    attr :work
+
+    # Home location.
+    def home ; file('~') ; end
+
+    # Root location.
+    def root ; file('/') ; end
+
+    # Return a new prompt with the same location.
+    # NOTE: Use #dup or #clone ?
+    #def new ; Prompt.new(work) ; end
+
     # Get the FileObject for the given file name.
+    #
+    # TODO: Should there be methods like this for each
+    #       type, and raise an error if not the right type?
+    #
     def file(name)
-      FileObject(name)
+      FileObject[name]
     end
+
     alias_method :[], :file
 
     # Join paths.
@@ -96,6 +106,7 @@ module Folio
       ::Dir.glob(pattern, opts).each{ |f| FileObject[f] }
     end
 
+    # Chage working directory.
     def cd(dir, &block)
       #dir = localize(dir)
       if block
@@ -105,10 +116,11 @@ module Folio
       end
     end
 
-    #--
-    # fileutils
-    #++
+    #############
+    # FileUtils #
+    #############
 
+    #
     def mkdir(dir, options)
       dir = localize(dir)
       fileutils.mkdir(dir, options)
@@ -213,6 +225,65 @@ module Folio
       fileutils.touch(list, options)
     end
 
+    #################
+    # XDG locations #
+    #################
+
+    # Look up a config file.
+    def config(path)
+      file(XDG.xdg_config_file(path))
+    end
+
+    # Look up a data file.
+    def data(path)
+      file(XDG.xdg_data_file(path))
+    end
+
+    # Look up a cache file.
+    def cache(path)
+      file(XDG.xdg_cache_file(path))
+    end
+
+    # Return a enumertor of system config directories.
+    def root_config() #_directories
+      XDG.xdg_config_dirs.to_enum(:each){ |f| file(f) }
+    end
+
+    # Return a enumertor of system data directories.
+    def root_data() #_directories
+      XDG.xdg_data_dirs.to_enum(:each){ |f| file(f) }
+    end
+
+    # Return the home config directory.
+    def home_config
+      file(XDG.xdg_config_home)
+    end
+
+    # Return the home data directory.
+    def home_data
+      file(XDG.xdg_data_home)
+    end
+
+    # Return the home cache directory.
+    def home_cache
+      file(XDG.xdg_cache_home)
+    end
+
+    # Return the home config directory.
+    def work_config
+      file(XDG.xdg_config_work)
+    end
+
+    # Return the home data directory.
+    def work_data
+      file(XDG.xdg_data_work)
+    end
+
+    # Return the home cache directory.
+    def work_cache
+      file(XDG.xdg_cache_work)
+    end
+
   private
 
     def localize(local_path)

data/lib/folio/xdg.rb

@@ -0,0 +1,136 @@
+# :Title: Folio XDG
+# :Author: &trans;
+# :Copyright: (c)2008 Tiger Ops
+# :License: GPLv3
+
+module Folio
+
+  # = XDG Base Directory Standard
+  #
+  # This provides a conveient library for conforming to the
+  # XDG Base Directory Standard.
+  #
+  #   http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
+  #
+  # Some important clarifications, not made clear by the
+  # above specification. 
+  #
+  # The data directories are for "read-only" files. In other words once
+  # something is put there, it should only be read, never written to
+  # by a program. (Generally speaking only users or pacakge mangers should
+  # be adding, changing or removing files from the data locations.
+  #
+  # The config locations are where you should store files that may change,
+  # and effect operations depending one there content. This is like etc/
+  # in the FHS, but alterable by end users and and end user programs,
+  # not just root and sudo admin scripts.
+  #
+  # The cache location stores files that could judt as well be deleted
+  # and everyihtng still works find. This is for variable and temporary
+  # files. Like var/ in FHS.
+  #
+  # This module returns paths as strings.
+  #
+  module XDG
+
+    ###############
+    module_function
+    ###############
+
+    def home
+      ENV['HOME'] || File.expand_path('~')
+    end
+
+    # Location of user's personal config directory.
+    def xdg_config_home
+      File.expand_path(
+        ENV['XDG_CONFIG_HOME'] || File.join(home, '.config')
+      )
+    end
+
+    # List of user's shared config directories.
+    def xdg_config_dirs
+      dirs = ENV['XDG_CONFIG_DIRS'].split(/[:;]/)
+      if dirs.empty?
+        dirs = %w{/etc/xdg}
+      end
+      dir.collect{ |d| File.expand_path(d) }
+    end
+
+    # Location of user's personal data directory.
+    def xdg_data_home
+      File.expand_path(
+        ENV['XDG_DATA_HOME'] || File.join(home, '.local', 'share')
+      )
+    end
+
+    # List of user's shared data directores.
+    def xdg_data_dirs
+      dirs = ENV['XDG_DATA_DIRS'].split(/[:;]/)
+      if dirs.empty?
+        dirs = %w{/usr/local/share/ /usr/share/}
+      end
+      dir.collect{ |d| File.expand_path(d) }
+    end
+
+    # Location of user's personal cache directory.
+    def xdg_cache_home
+      File.expand_path(
+        ENV['XDG_CACHE_HOME'] || File.join(home, '.cache')
+      )
+    end
+
+    # Find a file or directory in data dirs.
+    def xdg_data_file(file)
+      [data_home, *data_dirs].each do |dir|
+        path = File.join(dir,file)
+        break path if File.exist?(path)
+      end
+    end
+
+    # Find a file or directory in config dirs.
+    def xdg_config_file(file)
+      [config_home, *config_dirs].each do |dir|
+        path = File.join(dir,file)
+        break path if File.exist?(path)
+      end
+    end
+
+    # Find a file or directory in the user cache.
+    def xdg_cache_file(file)
+      File.join(cache_home,file)
+    end
+
+    ############################################
+    # The following are not strictly XDG spec, #
+    # but are useful in the same respect.      #
+    ############################################
+
+    # Location of working config directory.
+    def xdg_config_work
+      File.expand_path(
+        #ENV['XDG_CONFIG_WORK'] || File.join(Dir.pwd, '.config')
+        File.join(Dir.pwd, '.config')
+      )
+    end
+
+    # Location of working data directory.
+    def xdg_data_work
+      File.expand_path(
+        #ENV['XDG_DATA_WORK'] || File.join(Dir.pwd, '.share')
+        File.join(Dir.pwd, '.share')
+      )
+    end
+
+    # Location of working cache directory.
+    def xdg_cache_work
+      File.expand_path(
+        #ENV['XDG_CACHE_WORK'] || File.join(Dir.pwd, '.cache')
+        File.join(Dir.pwd, '.cache')
+      )
+    end
+
+  end # module XDG
+
+end # module Folio
+