folio 0.1.0 → 0.2.0

data/doc/ri/Folio/Prompt/documents-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Returns Enumerator of directories.
+full_name: Folio::Prompt#documents
+is_singleton: false
+name: documents
+params: ()
+visibility: public

data/doc/ri/Folio/Prompt/entries-i.yaml

@@ -5,7 +5,7 @@ aliases:
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Directory entries.
+  body: Lists all entries.
 full_name: Folio::Prompt#entries
 is_singleton: false
 name: entries

data/doc/ri/Folio/Prompt/file-i.yaml

@@ -1,10 +1,11 @@
 --- !ruby/object:RI::MethodDescription 
-aliases: []
-
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: "[]"
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Get the FileObject.
+  body: Get the FileObject for the given file name.
 full_name: Folio::Prompt#file
 is_singleton: false
 name: file

data/doc/ri/Folio/Prompt/files-i.yaml

@@ -4,7 +4,7 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Directory entries.
+  body: Returns Enumerator of files objects.
 full_name: Folio::Prompt#files
 is_singleton: false
 name: files

data/doc/ri/Folio/Prompt/fileutils-i.yaml

@@ -3,6 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Returns FileUtils module based on mode.
 full_name: Folio::Prompt#fileutils
 is_singleton: false
 name: fileutils

data/doc/ri/Folio/Prompt/mode-i.yaml

@@ -4,7 +4,7 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: opertaton mode
+  body: Opertaton mode. This can be :noop, :verbose or :dryrun. The later is the same as the first two combined.
 full_name: Folio::Prompt#mode
 is_singleton: false
 name: mode

data/doc/ri/created.rid

@@ -1 +1 @@
-Thu, 21 Aug 2008 15:20:49 -0400
+Sat, 30 Aug 2008 23:40:59 -0400

data/lib/folio.rb

@@ -15,6 +15,13 @@ require 'folio/pipe'
 
 # = Folio
 #
+# In folio the term `file` means a file object. That is to say any
+# type of file system resource: document, directory, device, etc.
+# We use the term `document` instead to mean "regular files".
+# This terminolgy was chosen for two reasons. Namely, (1) a 
+# differentiation in terms was required; and (2) a file in the
+# everyday sense is something in which one puts papars (eg. documents).
+#
 module Folio
 
   def self.file(*path)
@@ -27,53 +34,3 @@ module Folio
 
 end
 
-
-
-
-
-
-
-
-
-  #pwd()
-=begin
-    if ::File.blockdev?(path)
-      Device.new(path)
-    elsif chardev?(path)
-      Device.new(path)
-    elsif pipe?(path)
-      Device.new(path)
-    elsif ::File.socket?(path)
-      Socket.new(path)
-    elsif ::File.directory?(path)
-      Directory.new(path)
-    else
-      Document.new(path)
-    end
-  end
-=end
-
-# delegate ?
-=begin
-  def initialize(path)
-    @path = path = ::File.join(*path)
-
-    raise FileNotFound unless ::File.exist?(path)
-
-    if ::File.blockdev?(path) or chardev?(path)
-      @delegate = Device.new(path)
-    elsif ::File.link?(path)
-      @delegate = Link.new(path)
-    elsif ::File.directory?(path)
-      @delegate = Directory.new(path)
-    else
-      @delegate = Document.new(path)
-    end
-  end
-
-  def delete
-    @delegate.delete
-    @delegate = nil
-  end
-=end
-

data/lib/folio/directory.rb

@@ -12,13 +12,14 @@ module Folio
     def directory?   ; true  ; end
 
     # We have to use FileUtils here b/c of some obscure
-    # secutiry issue.
+    # secutiry issues.
 
-    # Copy recursively.
+    # Copy this directory recursively to destination.
     def cp_r(dest)
       util.cp_r(path, dest)
     end
 
+    # Remove this directory. Fails if not empty.
     def rmdir
       util.rmdir(path)
     end
@@ -26,19 +27,35 @@ module Folio
     alias_method :delete, :rmdir
     undef_method :rm
 
+    # Remove this directory and all it's content.
     def rm_r
       util.rm_r(path)
     end
 
+    # Remove this directory and all it's content forcefully.
     def rm_rf(list)
       util.rm_rf(path)
     end
 
+    # Change the mode of this directory.
+    #def chmod(mode)
+    #  util.chmod(mode, path)
+    #end
+
+    # Change the owner of this directory.
+    #def chown(user, group)
+    #  util.chown(user, group, path)
+    #end
+
+    # Change the mode of this directory and all it's content
+    # recursively.
     def chmod_r(mode)
       util.chmod_r(mode, path)
     end
     #alias_method :chmod_R, :chmod_r
 
+    # Change the owner of this directory and all it's content
+    # recursively.
     def chown_r(user, group)
       util.chown_r(user, group, path)
     end
@@ -48,33 +65,61 @@ module Folio
     # ::Dir
     #++
 
+    # Change into this directory.
     def chdir(&block)
       ::Dir.chdir(path, &block)
     end
     alias_method :cd, :chdir
 
+    # Make this directory the file system root.
     def chroot(&block)
       ::Dir.chroot(path, &block)
     end
 
-    # Directory entries. This returns a list of file names.
+    # Loop over the entries (this does includes '.' and '..').
+    def foreach(&block)
+      ::Dir.foreach(path, &block)
+    end
+
+    # This returns a list of file names. Unlike traditional
+    # Dir.entries method, this does not include '.' or '..'.
     def entries
-      ::Dir.entries(path)
+      ::Dir.entries(path) - ['.', '..']
     end
 
-    def foreach(&block)
-      ::Dir.foreach(path, &block)
+    # Returns a list of document names.
+    def document_entries
+      entries.select{|f| File.file?(File.join(path,f)) }
     end
 
-    # TODO: use enumerator (?)
-    def paths
-      (::Dir.entries(path) - ['.', '..']).collect{ |f| FileObject[path, f] }
+    # Returns a list of directory names. This does not
+    # include '.' or '..'.
+    def directory_entries
+      dirs = ::Dir.glob("#{path}/")
+      dirs.collect{ |f| f.chomp('/') }
     end
 
-    # Join paths.
+    # Returns an Enumerator over all file objects in the directory.
+    def files
+      entries.to_enum(:each){ |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] }
+    end
+
+    # Returns an Enumerator over all directories in the directory.
+    def directories
+      directory_entries.to_enum(:each){ |f| FileObject[path, f] }
+    end
+
+    # Join path and return new file object.
     def /(fname)
       FileObject[path, fname]
     end
+
+    # Same as #/.
     alias_method :+, :/
 
   end

data/lib/folio/document.rb

@@ -14,7 +14,8 @@ module Folio
     # Polymorphism
     #++
 
-    def file? ; true ; end
+    #def file? ; true ; end
+    def document? ; true ; end
 
     #--
     # FileTest::
@@ -47,6 +48,18 @@ module Folio
       ::File.open(path, 'w'){|f| f.truncate(size)}
     end
 
+    # Replace contents of file with string.
+    def write(string)
+      ::File.open(path, 'w'){|f| f.write(string)}
+    end
+    alias_method :<, :write  # NOTE: Sure about this? It means no Comparable.
+
+    # Replace contents of file with string.
+    def append(string)
+      ::File.open(path, 'a'){|f| f.write(string)}
+    end
+    alias_method :<<, :append
+
     #--  
     # Can we handle other modes besides read this way?
     #++

data/lib/folio/fileobject.rb

@@ -1,3 +1,10 @@
+require 'enumerator'
+require 'fileutils'
+
+class Enumerator
+  alias_method :list, :to_a
+end
+
 
 module Folio
 
@@ -149,7 +156,8 @@ module Folio
     end
     alias_method :stat!, :restat
 
-    def file?               ; stat.file?             ; end
+    #def file?               ; stat.file?             ; end
+    def document?           ; stat.file?             ; end
     def directory?          ; stat.directory?        ; end
     def blockdev?           ; stat.blockdev?         ; end
     def chardev?            ; stat.chardev?          ; end

data/lib/folio/prompt.rb

@@ -1,10 +1,20 @@
+=begin
+
+= Folio Prompt
+
+A Folio Prompt object emulates a file system shell prompt in code.
+
+=end
+
 module Folio
 
   # = Prompt class
   #
   class Prompt
 
-    attr :path
+    # @work store the present working directory
+    # as a Directory object.
+    attr :work
 
     #
     def initialize(*path)
@@ -23,7 +33,8 @@ module Folio
       @path = Directory.new(path)
     end
 
-    # opertaton mode
+    # Opertaton mode. This can be :noop, :verbose or :dryrun.
+    # The later is the same as the first two combined.
     def mode(opts=nil)
       return @mode unless opts
       opts.each do |key, val|
@@ -39,45 +50,45 @@ module Folio
       end
     end
 
-    def to_s ; path.to_s ; end
-    def pwd  ; path ; end
+    def to_s ; work.to_s ; end
 
-    # Get the FileObject.
+    # Get the FileObject for the given file name.
     def file(name)
       FileObject(name)
     end
-
-    #--
-    # ::Dir
-    #++
+    alias_method :[], :file
 
     # Join paths.
     def +(fname)
-      @path =+ fname
+      @work =+ fname
     end
     alias_method :/, :+
 
-    # Directory entries.
-    def paths
-      path.paths
-    end
-
-    # Directory entries.
+    # Lists all entries.
     def entries
-      path.entries
+      work.entries
     end
     alias_method :ls, :entries
 
-    # Directory entries.
-    def directories
-      path.paths.select{ |f| f.directory? }
+    # Lists directory entries.
+    def directory_entries
+      work.directory_entries
     end
 
-    # Directory entries.
-    def files
-      path.paths.select{ |f| f.file? }
+    # Lists directory entries.
+    def document_entries
+      work.document_entries
     end
 
+    # Returns Enumerator of files objects.
+    def files ; work.files ; end
+
+    # Returns Enumerator of directories.
+    def documents ; work.documents ; end
+
+    # Returns Enumerator of documents.
+    def directories ; work.directories ; end
+
     # Glob pattern.
     def glob(*patterns)
       opts = (::Integer===patterns.last ? patterns.pop : 0)
@@ -88,9 +99,9 @@ module Folio
     def cd(dir, &block)
       #dir = localize(dir)
       if block
-        @path.cd(dir, &block)
+        @work.cd(dir, &block)
       else
-        @path += dir
+        @work += dir
       end
     end
 
@@ -213,6 +224,7 @@ module Folio
       end
     end
 
+    # Returns FileUtils module based on mode.
     def fileutils
       return ::FileUtils unless @mode
       case @mode
@@ -237,3 +249,31 @@ module Folio
 
 end
 
+
+# Could the prompt act as a delegate to file objects?
+# If we did this then the file prompt could actually "cd" into a file.
+#
+=begin :nodoc:
+  def initialize(path)
+    @path = path = ::File.join(*path)
+
+    raise FileNotFound unless ::File.exist?(path)
+
+    if ::File.blockdev?(path) or chardev?(path)
+      @delegate = Device.new(path)
+    elsif ::File.link?(path)
+      @delegate = Link.new(path)
+    elsif ::File.directory?(path)
+      @delegate = Directory.new(path)
+    else
+      @delegate = Document.new(path)
+    end
+  end
+
+  def delete
+    @delegate.delete
+    @delegate = nil
+  end
+=end
+#++
+