oofile 0.0.1 → 0.0.2

data/README.rdoc

@@ -5,8 +5,9 @@ oofile is an object-oriented way of accessing the filesystem.
 * Install with:
     gem install oofile
 * Basic operation can be seen in demo.rdoc
-* *source* http://github.com/dafydd/sitebuilder
-* To build me, set an environment variable called *SANDBOX* to the directory above your sitebuilder directory. The tests need this pathname to access test data.
+* *source* http://github.com/dafydd/oofile
+* *rdoc* http://www.greenbarsoft.co.uk/software/oofile/rdoc
+* To build me, set an environment variable called *SANDBOX* to the directory above your oofile top-level directory. The tests need this pathname to access test data.
 
 === Compatibility
 This project is being developed on OS X. Automated testing for Linux will be included in future releases.

data/TODO.rdoc

@@ -1,2 +1,2 @@
 == todo
-
+* exclude mocha from rcov coverage

data/doc/demo.rdoc

@@ -15,8 +15,8 @@
     ?> dir_string
     => "/Users/dev/oofile/test/data"
     >> 
-    ?> f = OOFile::FsEntry.fs_entry_from(file_string)
-    => #<OOFile::FileEntry:0x1016a34f0 @path="/Users/dev/oofile/test/data/testfile.txt">
+    ?> f = OOFile::FsEntry.from(file_string)
+    => #<OOFile::FileEntry:0x1016a37e8 @path="/Users/dev/oofile/test/data/testfile.txt">
     >> 
     ?> f.extname
     => ".txt"
@@ -37,13 +37,13 @@
     => 28
     >> 
     ?> # equality comparison
-    ?> f == OOFile::FsEntry.fs_entry_from(file_string)
+    ?> f == OOFile::FsEntry.from(file_string)
     => true
     >> 
     ?> # directories
     ?> 
-    ?>  d= OOFile::FsEntry.fs_entry_from(dir_string)
-    => #<OOFile::DirEntry:0x10168a5b8 @path="/Users/dev/oofile/test/data">
+    ?>  d= OOFile::FsEntry.from(dir_string)
+    => #<OOFile::DirEntry:0x10168b120 @path="/Users/dev/oofile/test/data">
     >> 
     ?> d.extname
     => ""

data/doc/demo.script

@@ -7,7 +7,7 @@ file_string
 
 dir_string
 
-f = OOFile::FsEntry.fs_entry_from(file_string)
+f = OOFile::FsEntry.from(file_string)
 
 f.extname
 
@@ -22,11 +22,11 @@ f.ctime
 f.size
 
 # equality comparison
-f == OOFile::FsEntry.fs_entry_from(file_string)
+f == OOFile::FsEntry.from(file_string)
 
 # directories
 
- d= OOFile::FsEntry.fs_entry_from(dir_string)
+ d= OOFile::FsEntry.from(dir_string)
 
 d.extname
 

data/lib/oofile/filesystem.rb

@@ -41,15 +41,15 @@ module OOFile
     end
   
     # creates a file system entry for a fully qualified pathname
-    def self.fs_entry_from(f) 
+    def self.from(f) 
       return FileEntry.new(f) if File.file?(f) 
       return DirEntry.new(f)  if File.directory?(f) 
       UnknownEntry.new(f)
     end
   
     # creates a file system entry for a filename in the current file system entry object
-    def fs_entry_from(fs_entry)
-       FsEntry.fs_entry_from(File.join(@path, fs_entry))
+    def from(fs_entry)
+       FsEntry.from(File.join(@path, fs_entry))
     end
 
   end
@@ -74,7 +74,7 @@ module OOFile
     def traverse(traverser)
       traverser.traverse_dir(self)
       Dir.new(@path).each do |stringpath|
-        subentry = fs_entry_from(stringpath)
+        subentry = from(stringpath)
         subentry.traverse(traverser) unless stringpath=='.' || stringpath=='..' 
       end
     end

data/test/filesystem_test.rb

@@ -6,7 +6,7 @@ require 'oofile/filesystem'
 
 FS = File::SEPARATOR
 TEST_DIRNAME = 'data'
-TESTDATA_DIR = ENV['SANDBOX']+FS+'sitebuilder'+FS+'test'+FS+TEST_DIRNAME
+TESTDATA_DIR = ENV['SANDBOX']+FS+'oofile'+FS+'test'+FS+TEST_DIRNAME
 TEST_FILENAME = 'testfile.txt'
 TEST_FILEPATH = TESTDATA_DIR+FS+TEST_FILENAME
 
@@ -57,15 +57,15 @@ def test_size
 end
 
 def test_fs_entry_from
-  assert_equal OOFile::FileEntry, OOFile::FsEntry.fs_entry_from(TEST_FILEPATH).class
-  assert_equal OOFile::DirEntry,  OOFile::FsEntry.fs_entry_from(TESTDATA_DIR).class
-  assert_equal OOFile::UnknownEntry, OOFile::FsEntry.fs_entry_from('/dev/null').class
+  assert_equal OOFile::FileEntry, OOFile::FsEntry.from(TEST_FILEPATH).class
+  assert_equal OOFile::DirEntry,  OOFile::FsEntry.from(TESTDATA_DIR).class
+  assert_equal OOFile::UnknownEntry, OOFile::FsEntry.from('/dev/null').class
 end
 
 def test_instance_fs_entry_from
-  instance = OOFile::FsEntry.fs_entry_from(TESTDATA_DIR)
-  file_result = instance.fs_entry_from(TEST_FILENAME)
-  dir_result  = instance.fs_entry_from('.')
+  instance = OOFile::FsEntry.from(TESTDATA_DIR)
+  file_result = instance.from(TEST_FILENAME)
+  dir_result  = instance.from('.')
 
   assert_equal instance.path+FS+TEST_FILENAME, file_result.path
   assert_equal instance.path, dir_result.path
@@ -82,7 +82,7 @@ def test_traverse
   end
   traverser.expects(:traverse_dir).never()
 
-  file = OOFile::FsEntry.fs_entry_from(TEST_FILEPATH)
+  file = OOFile::FsEntry.from(TEST_FILEPATH)
   file.traverse(traverser)
 end
 
@@ -99,7 +99,7 @@ class DirEntryTest < Test::Unit::TestCase
       OOFile::DirEntry==dir.class && TESTDATA_DIR==dir.path
     end
 
-    file = OOFile::FsEntry.fs_entry_from(TESTDATA_DIR)
+    file = OOFile::FsEntry.from(TESTDATA_DIR)
     file.traverse(traverser)
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oofile
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dafydd Rees
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 +00:00
+date: 2011-02-28 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,6 +107,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Static site generator
+summary: Object-oriented, traversable file system representation.
 test_files: 
 - ./test/filesystem_test.rb