folio 0.1.0 → 0.2.0

data/doc/ri/Enumerator/cdesc-Enumerator.yaml

@@ -0,0 +1,15 @@
+--- !ruby/object:RI::ClassDescription 
+attributes: []
+
+class_methods: []
+
+comment: 
+constants: []
+
+full_name: Enumerator
+includes: []
+
+instance_methods: []
+
+name: Enumerator
+superclass: Object

data/doc/ri/Folio/Directory/%2f-i.yaml

@@ -5,7 +5,7 @@ aliases:
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Join paths.
+  body: Join path and return new file object.
 full_name: Folio::Directory#/
 is_singleton: false
 name: /

data/doc/ri/Folio/Directory/cdesc-Directory.yaml

@@ -29,14 +29,22 @@ instance_methods:
   name: cp_r
 - !ruby/object:RI::MethodSummary 
   name: delete
+- !ruby/object:RI::MethodSummary 
+  name: directories
 - !ruby/object:RI::MethodSummary 
   name: directory?
+- !ruby/object:RI::MethodSummary 
+  name: directory_entries
+- !ruby/object:RI::MethodSummary 
+  name: document_entries
+- !ruby/object:RI::MethodSummary 
+  name: documents
 - !ruby/object:RI::MethodSummary 
   name: entries
 - !ruby/object:RI::MethodSummary 
-  name: foreach
+  name: files
 - !ruby/object:RI::MethodSummary 
-  name: paths
+  name: foreach
 - !ruby/object:RI::MethodSummary 
   name: rm_r
 - !ruby/object:RI::MethodSummary 

data/doc/ri/Folio/Directory/chdir-i.yaml

@@ -3,7 +3,9 @@ aliases:
 - !ruby/object:RI::AliasName 
   name: cd
 block_params: 
-comment: ""
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Change into this directory.
 full_name: Folio::Directory#chdir
 is_singleton: false
 name: chdir

data/doc/ri/Folio/Directory/chmod_r-i.yaml

@@ -3,6 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Change the mode of this directory and all it's content recursively.
 full_name: Folio::Directory#chmod_r
 is_singleton: false
 name: chmod_r

data/doc/ri/Folio/Directory/chown_r-i.yaml

@@ -4,7 +4,7 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: alias_method :chmod_R, :chmod_r
+  body: Change the owner of this directory and all it's content recursively.
 full_name: Folio::Directory#chown_r
 is_singleton: false
 name: chown_r

data/doc/ri/Folio/Directory/chroot-i.yaml

@@ -3,6 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Make this directory the file system root.
 full_name: Folio::Directory#chroot
 is_singleton: false
 name: chroot

data/doc/ri/Folio/Directory/cp_r-i.yaml

@@ -4,7 +4,7 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Copy recursively.
+  body: Copy this directory recursively to destination.
 full_name: Folio::Directory#cp_r
 is_singleton: false
 name: cp_r

data/doc/ri/Folio/Directory/directories-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Returns an Enumerator over all directories in the directory.
+full_name: Folio::Directory#directories
+is_singleton: false
+name: directories
+params: ()
+visibility: public

data/doc/ri/Folio/Directory/directory_entries-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Returns a list of directory names. This does not include '.' or '..'.
+full_name: Folio::Directory#directory_entries
+is_singleton: false
+name: directory_entries
+params: ()
+visibility: public

data/doc/ri/Folio/Directory/document_entries-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Returns a list of document names.
+full_name: Folio::Directory#document_entries
+is_singleton: false
+name: document_entries
+params: ()
+visibility: public

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

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Returns an Enumerator over all documents in the directory.
+full_name: Folio::Directory#documents
+is_singleton: false
+name: documents
+params: ()
+visibility: public

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

@@ -4,7 +4,7 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Directory entries. This returns a list of file names.
+  body: This returns a list of file names. Unlike traditional Dir.entries method, this does not include '.' or '..'.
 full_name: Folio::Directory#entries
 is_singleton: false
 name: entries

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

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Returns an Enumerator over all file objects in the directory.
+full_name: Folio::Directory#files
+is_singleton: false
+name: files
+params: ()
+visibility: public

data/doc/ri/Folio/Directory/foreach-i.yaml

@@ -3,6 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Loop over the entries (this does includes '.' and '..').
 full_name: Folio::Directory#foreach
 is_singleton: false
 name: foreach

data/doc/ri/Folio/Directory/rm_r-i.yaml

@@ -3,6 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Remove this directory and all it's content.
 full_name: Folio::Directory#rm_r
 is_singleton: false
 name: rm_r

data/doc/ri/Folio/Directory/rm_rf-i.yaml

@@ -3,6 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Remove this directory and all it's content forcefully.
 full_name: Folio::Directory#rm_rf
 is_singleton: false
 name: rm_rf

data/doc/ri/Folio/Directory/rmdir-i.yaml

@@ -6,6 +6,8 @@ aliases:
   name: delete
 block_params: 
 comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Remove this directory. Fails if not empty.
 full_name: Folio::Directory#rmdir
 is_singleton: false
 name: rmdir

data/doc/ri/Folio/Document/%3c%3c-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #append"
+full_name: Folio::Document#<<
+is_singleton: false
+name: "<<"
+params: (string)
+visibility: public

data/doc/ri/Folio/{Prompt/paths-i.yaml → Document/%3c-i.yaml}

@@ -4,9 +4,9 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Directory entries.
-full_name: Folio::Prompt#paths
+  body: "Alias for #write"
+full_name: Folio::Document#<
 is_singleton: false
-name: paths
-params: ()
+name: <
+params: (string)
 visibility: public

data/doc/ri/Folio/Document/append-i.yaml

@@ -0,0 +1,13 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: "<<"
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Replace contents of file with string.
+full_name: Folio::Document#append
+is_singleton: false
+name: append
+params: (string)
+visibility: public

data/doc/ri/Folio/Document/cdesc-Document.yaml

@@ -10,14 +10,20 @@ full_name: Folio::Document
 includes: []
 
 instance_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: <
+- !ruby/object:RI::MethodSummary 
+  name: "<<"
+- !ruby/object:RI::MethodSummary 
+  name: append
 - !ruby/object:RI::MethodSummary 
   name: delete
+- !ruby/object:RI::MethodSummary 
+  name: document?
 - !ruby/object:RI::MethodSummary 
   name: executable?
 - !ruby/object:RI::MethodSummary 
   name: executable_real?
-- !ruby/object:RI::MethodSummary 
-  name: file?
 - !ruby/object:RI::MethodSummary 
   name: intialize
 - !ruby/object:RI::MethodSummary 
@@ -30,5 +36,7 @@ instance_methods:
   name: truncate
 - !ruby/object:RI::MethodSummary 
   name: unlink
+- !ruby/object:RI::MethodSummary 
+  name: write
 name: Document
 superclass: FileObject

data/doc/ri/Folio/{Directory/paths-i.yaml → Document/document%3f-i.yaml}

@@ -4,9 +4,9 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: "TODO: use enumerator (?)"
-full_name: Folio::Directory#paths
+  body: def file? ; true ; end
+full_name: Folio::Document#document?
 is_singleton: false
-name: paths
+name: document?
 params: ()
 visibility: public

data/doc/ri/Folio/Document/write-i.yaml

@@ -0,0 +1,13 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: <
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Replace contents of file with string.
+full_name: Folio::Document#write
+is_singleton: false
+name: write
+params: (string)
+visibility: public

data/doc/ri/Folio/FileObject/cdesc-FileObject.yaml

@@ -56,14 +56,14 @@ instance_methods:
   name: directory?
 - !ruby/object:RI::MethodSummary 
   name: dirname
+- !ruby/object:RI::MethodSummary 
+  name: document?
 - !ruby/object:RI::MethodSummary 
   name: exist?
 - !ruby/object:RI::MethodSummary 
   name: exists?
 - !ruby/object:RI::MethodSummary 
   name: extname
-- !ruby/object:RI::MethodSummary 
-  name: file?
 - !ruby/object:RI::MethodSummary 
   name: fnmatch
 - !ruby/object:RI::MethodSummary 

data/doc/ri/Folio/FileObject/{file%3f-i.yaml → document%3f-i.yaml}

@@ -3,8 +3,10 @@ aliases: []
 
 block_params: 
 comment: 
-full_name: Folio::FileObject#file?
+- !ruby/struct:SM::Flow::P 
+  body: def file? ; stat.file? ; end
+full_name: Folio::FileObject#document?
 is_singleton: false
-name: file?
+name: document?
 params: ()
 visibility: public

data/doc/ri/Folio/Prompt/{pwd-i.yaml → %5b%5d-i.yaml}

@@ -3,8 +3,10 @@ aliases: []
 
 block_params: 
 comment: 
-full_name: Folio::Prompt#pwd
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #file"
+full_name: Folio::Prompt#[]
 is_singleton: false
-name: pwd
-params: ()
+name: "[]"
+params: (name)
 visibility: public

data/doc/ri/Folio/Prompt/cdesc-Prompt.yaml

@@ -2,7 +2,9 @@
 attributes: 
 - !ruby/object:RI::Attribute 
   comment: 
-  name: path
+  - !ruby/struct:SM::Flow::P 
+    body: "@work store the present working directory as a Directory object."
+  name: work
   rw: R
 class_methods: 
 - !ruby/object:RI::MethodSummary 
@@ -23,6 +25,8 @@ instance_methods:
   name: +
 - !ruby/object:RI::MethodSummary 
   name: /
+- !ruby/object:RI::MethodSummary 
+  name: "[]"
 - !ruby/object:RI::MethodSummary 
   name: cd
 - !ruby/object:RI::MethodSummary 
@@ -39,6 +43,12 @@ instance_methods:
   name: cp_r
 - !ruby/object:RI::MethodSummary 
   name: directories
+- !ruby/object:RI::MethodSummary 
+  name: directory_entries
+- !ruby/object:RI::MethodSummary 
+  name: document_entries
+- !ruby/object:RI::MethodSummary 
+  name: documents
 - !ruby/object:RI::MethodSummary 
   name: entries
 - !ruby/object:RI::MethodSummary 
@@ -69,10 +79,6 @@ instance_methods:
   name: mode
 - !ruby/object:RI::MethodSummary 
   name: mv
-- !ruby/object:RI::MethodSummary 
-  name: paths
-- !ruby/object:RI::MethodSummary 
-  name: pwd
 - !ruby/object:RI::MethodSummary 
   name: rm
 - !ruby/object:RI::MethodSummary 

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

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

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

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

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

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