oofile 0.0.3 → 0.0.4

data/TODO.rdoc

@@ -1,2 +1,14 @@
 == todo
+* rename all "traversers" to "visitors" to not be silly
+* create relative_path_from method for files and dirs
+* test OOFile::FileTraverser
+* set up hudson
+
+== done
+* added a_dir_entry.files to return array of FsFile entries i.e. the files immediately within the target dir
+* set up to run rake against Ruby 1.9 & JRuby
 * exclude mocha from rcov coverage
+* nonexistent files/dirs map to UnknownEntry and are traversable. See test_traverse_on_nonexistent_handled_as_unknown
+
+ 
+

data/doc/demo.rdoc

@@ -1,70 +1,71 @@
 == Sample output 
 
 
-    >> require 'oofile'
-    => true
-    >> 
-    ?> dir_string = File.join(ENV['SANDBOX'],'oofile','test','data')
-    => "/Users/dev/oofile/test/data"
-    >> file_string = File.join(dir_string,'testfile.txt')
-    => "/Users/dev/oofile/test/data/testfile.txt"
-    >> 
-    ?> file_string
-    => "/Users/dev/oofile/test/data/testfile.txt"
-    >> 
-    ?> dir_string
-    => "/Users/dev/oofile/test/data"
-    >> 
-    ?> f = OOFile::FsEntry.from(file_string)
-    => #<OOFile::FileEntry:0x1016a37e8 @path="/Users/dev/oofile/test/data/testfile.txt">
-    >> 
-    ?> f.extname
-    => ".txt"
-    >> 
-    ?> f.extnless
-    => "testfile"
-    >> 
-    ?> f.basename
-    => "testfile.txt"
-    >> 
-    ?> f.dirname
-    => "/Users/dev/oofile/test/data"
-    >> 
-    ?> f.ctime
-    => Sat Feb 26 01:34:57 +0000 2011
-    >> 
-    ?> f.size
-    => 28
-    >> 
-    ?> # equality comparison
-    ?> f == OOFile::FsEntry.from(file_string)
-    => true
-    >> 
-    ?> # directories
-    ?> 
-    ?>  d= OOFile::FsEntry.from(dir_string)
-    => #<OOFile::DirEntry:0x10168b120 @path="/Users/dev/oofile/test/data">
-    >> 
-    ?> d.extname
-    => ""
-    >> 
-    ?> d.extnless
-    => "data"
-    >> 
-    ?> d.basename
-    => "data"
-    >> 
-    ?> d.dirname
-    => "/Users/dev/oofile/test"
-    >> 
-    ?> d.ctime
-    => Sat Feb 26 01:34:57 +0000 2011
-    >> 
-    ?> d.size
-    => 102
-    >> 
-    ?> 
-    ?> >> => nil
+    Welcome to ruby on java
+    jruby-1.6.5 :001 > require 'oofile'
+     => true 
+    jruby-1.6.5 :002 > 
+    jruby-1.6.5 :003 >   dir_string = File.join(ENV['SANDBOX'],'oofile','test','data')
+     => "/Users/daf/github/oofile/test/data" 
+    jruby-1.6.5 :004 > file_string = File.join(dir_string,'testfile.txt')
+     => "/Users/daf/github/oofile/test/data/testfile.txt" 
+    jruby-1.6.5 :005 > 
+    jruby-1.6.5 :006 >   file_string
+     => "/Users/daf/github/oofile/test/data/testfile.txt" 
+    jruby-1.6.5 :007 > 
+    jruby-1.6.5 :008 >   dir_string
+     => "/Users/daf/github/oofile/test/data" 
+    jruby-1.6.5 :009 > 
+    jruby-1.6.5 :010 >   f = OOFile::FsEntry.from(file_string)
+     => OOFile::FileEntry(/Users/daf/github/oofile/test/data/testfile.txt) 
+    jruby-1.6.5 :011 > 
+    jruby-1.6.5 :012 >   f.extname
+     => ".txt" 
+    jruby-1.6.5 :013 > 
+    jruby-1.6.5 :014 >   f.extnless
+     => "testfile" 
+    jruby-1.6.5 :015 > 
+    jruby-1.6.5 :016 >   f.basename
+     => "testfile.txt" 
+    jruby-1.6.5 :017 > 
+    jruby-1.6.5 :018 >   f.dirname
+     => "/Users/daf/github/oofile/test/data" 
+    jruby-1.6.5 :019 > 
+    jruby-1.6.5 :020 >   f.ctime
+     => Sat Nov 19 21:45:15 +0000 2011 
+    jruby-1.6.5 :021 > 
+    jruby-1.6.5 :022 >   f.size
+     => 28 
+    jruby-1.6.5 :023 > 
+    jruby-1.6.5 :024 >   # equality comparison
+    jruby-1.6.5 :025 >   f == OOFile::FsEntry.from(file_string)
+     => true 
+    jruby-1.6.5 :026 > 
+    jruby-1.6.5 :027 >   # directories
+    jruby-1.6.5 :028 >   
+    jruby-1.6.5 :029 >    d= OOFile::FsEntry.from(dir_string)
+     => OOFile::DirEntry(/Users/daf/github/oofile/test/data) 
+    jruby-1.6.5 :030 > 
+    jruby-1.6.5 :031 >   d.extname
+     => "" 
+    jruby-1.6.5 :032 > 
+    jruby-1.6.5 :033 >   d.extnless
+     => "data" 
+    jruby-1.6.5 :034 > 
+    jruby-1.6.5 :035 >   d.basename
+     => "data" 
+    jruby-1.6.5 :036 > 
+    jruby-1.6.5 :037 >   d.dirname
+     => "/Users/daf/github/oofile/test" 
+    jruby-1.6.5 :038 > 
+    jruby-1.6.5 :039 >   d.ctime
+     => Sat Nov 19 20:07:45 +0000 2011 
+    jruby-1.6.5 :040 > 
+    jruby-1.6.5 :041 >   d.size
+     => 204 
+    jruby-1.6.5 :042 > 
+    jruby-1.6.5 :043 >   
+    jruby-1.6.5 :044 >   jruby-1.6.5 :044 >  => nil 
 
 
- oofile 0.0.1
+ oofile 0.0.4

data/lib/oofile/filesystem.rb

@@ -35,6 +35,10 @@ module OOFile
     def ctime
       File::ctime(@path)
     end
+    
+    def mtime
+      File::mtime(@path)
+    end
 
     def size
       File.size(@path)
@@ -55,6 +59,10 @@ module OOFile
     # by default we ignore entries that cannot be handled
     def traverse(entry)
     end
+    
+    def inspect
+      "#{self.class.to_s}(#{@path})"
+    end
 
   end
 
@@ -77,6 +85,11 @@ module OOFile
   # I represent directories in the filesystem.
   class DirEntry < FsEntry	
 
+    # I return the files immediately in my directory.
+    def files
+      (Dir.new(@path).entries.select {|entry| File.file?(File.join(@path,entry))}).map {|filepath| FsEntry.from(File.join(@path,filepath)) }
+    end
+    
     # I am visitable with a Traverser. I perform inorder traversal of FsEntries.
     def traverse(traverser)
       traverser.traverse_dir(self)
@@ -99,4 +112,4 @@ module OOFile
     end
   end
 
-end
+end 

data/test/data/second_testfile.txt

@@ -0,0 +1 @@
+another test file

data/test/data/subdirectory/a_nested_testfile.txt

@@ -0,0 +1 @@
+file in a subdirectory

data/test/filesystem_test.rb

@@ -52,6 +52,11 @@ def test_ctime
   assert OOFile::FsEntry.new(TEST_FILEPATH).ctime.to_i > 0 
 end
 
+def test_mtime
+  assert_equal(File::mtime(TEST_FILEPATH), OOFile::FsEntry.new(TEST_FILEPATH).mtime)
+  assert OOFile::FsEntry.new(TEST_FILEPATH).mtime.to_i > 0 
+end
+
 def test_size
   assert_equal(28, OOFile::FsEntry.new(TEST_FILEPATH).size) 
 end
@@ -90,22 +95,43 @@ end
 
 class DirEntryTest < Test::Unit::TestCase
   
+  def name_on_expected_list!(list, name)
+    return false unless list.member? name
+    list.delete(name)
+    true
+  end
+  
   def test_traverse
+    expected_files_basenames = ['testfile.txt', 'second_testfile.txt', 'a_nested_testfile.txt']
+    expected_directories = [TESTDATA_DIR, File.join(TESTDATA_DIR,'subdirectory')]
     traverser = OOFile::Traverser.new
-    traverser.expects(:traverse_file).once().with do |file| 
-      OOFile::FileEntry==file.class && 'testfile.txt'==file.basename
+    traverser.expects(:traverse_file).times(3).with do |file| 
+      puts file.basename
+      OOFile::FileEntry==file.class && name_on_expected_list!(expected_files_basenames, file.basename)
     end
-    traverser.expects(:traverse_dir).once().with do |dir| 
-      OOFile::DirEntry==dir.class && TESTDATA_DIR==dir.path
+    traverser.expects(:traverse_dir).times(2).with do |dir| 
+      OOFile::DirEntry==dir.class && name_on_expected_list!(expected_directories, dir.path) 
     end
     traverser.expects(:traverse_unknown).once().with do |unknown|
       OOFile::UnknownEntry==unknown.class && 'pipeentry'==unknown.basename
     end
 
-    file = OOFile::FsEntry.from(TESTDATA_DIR)
-    file.traverse(traverser)
+    directory = OOFile::FsEntry.from(TESTDATA_DIR)
+    assert_equal directory.class, OOFile::DirEntry
+    directory.traverse(traverser)
+    assert expected_files_basenames.empty?, "These files were expected to be traversed but remain: #{expected_files_basenames.inspect}"
+    assert expected_directories.empty?, "These dirs were expected to be traversed but remain: #{expected_directories.inspect}"
   end
 
+  def test_return_all_top_level_files
+    directory = OOFile::FsEntry.from(TESTDATA_DIR)
+    actual_files = directory.files
+    assert_equal 2, actual_files.size
+    expected_filenames = ['testfile.txt', 'second_testfile.txt']
+    actual_files.each {|actual_file| assert_equal OOFile::FileEntry, actual_file.class }
+    expected_filenames.each {|expected_filename| (actual_files.select {|file| file.basename==expected_filename}).size == 2}
+  end
+  
 end
 
 class UnknownEntryTest < Test::Unit::TestCase
@@ -117,5 +143,19 @@ class UnknownEntryTest < Test::Unit::TestCase
     file = OOFile::FsEntry.from(File.join(TESTDATA_DIR,'pipeentry'))
     file.traverse(traverser)
   end
+  
+  def test_traverse_on_nonexistent_handled_as_unknown
+    traverser= OOFile::Traverser.new
+    traverser.expects(:traverse_file).never()
+    traverser.expects(:traverse_dir).never()
+    traverser.expects(:traverse_unknown).once().with do |unknown|
+      OOFile::UnknownEntry==unknown.class && 'nonexistentfile'==unknown.basename
+    end
+
+    file = OOFile::FsEntry.from(File.join(TESTDATA_DIR,'nonexistentfile'))
+   
+    assert_equal file.class, OOFile::UnknownEntry
+    file.traverse(traverser)
+  end
 
 end

metadata

@@ -1,55 +1,39 @@
 --- !ruby/object:Gem::Specification 
 name: oofile
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors: 
-- Dafydd Rees
+  - Dafydd Rees
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-03-02 00:00:00 +00:00
-default_executable: 
+date: 2011-11-19 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
-        version: 0.9.8
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 55
-        segments: 
-        - 0
-        - 9
-        - 6
-        version: 0.9.6
-  type: :development
-  version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: mocha
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.9.8
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rcov
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.9.6
+    type: :development
+    version_requirements: *id002
 description: Object-oriented access to the filesystem.
 email: os@greenbarsoft.co.uk
 executables: []
@@ -57,24 +41,25 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- CHANGELOG.rdoc
-- COPYING
-- README.rdoc
-- doc/demo.rdoc
-- TODO.rdoc
+  - CHANGELOG.rdoc
+  - COPYING
+  - README.rdoc
+  - doc/demo.rdoc
+  - TODO.rdoc
 files: 
-- doc/demo.script
-- lib/oofile/filesystem.rb
-- lib/oofile.rb
-- test/data/testfile.txt
-- test/filesystem_test.rb
-- ./test/filesystem_test.rb
-- CHANGELOG.rdoc
-- COPYING
-- README.rdoc
-- doc/demo.rdoc
-- TODO.rdoc
-has_rdoc: true
+  - doc/demo.script
+  - lib/oofile.rb
+  - lib/oofile/filesystem.rb
+  - test/filesystem_test.rb
+  - test/data/second_testfile.txt
+  - test/data/testfile.txt
+  - test/data/subdirectory/a_nested_testfile.txt
+  - ./test/filesystem_test.rb
+  - CHANGELOG.rdoc
+  - COPYING
+  - README.rdoc
+  - doc/demo.rdoc
+  - TODO.rdoc
 homepage: http://www.greenbarsoft.co.uk/software/oofile
 licenses: []
 
@@ -82,31 +67,25 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Object-oriented, traversable file system representation.
 test_files: 
-- ./test/filesystem_test.rb
+  - ./test/filesystem_test.rb