oofile 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== 0.0.1
+

data/COPYING

@@ -0,0 +1,32 @@
+SiteBuilder Licence
+ 
+COPYRIGHT AND PERMISSION NOTICE
+ 
+Copyright (c) 2011  Green Bar Software Limited, UK
+ 
+All rights reserved.
+ 
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, and/or sell copies of the Software, and to permit persons
+to whom the Software is furnished to do so, provided that the above
+copyright notice(s) and this permission notice appear in all copies of
+the Software and that both the above copyright notice(s) and this
+permission notice appear in supporting documentation.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
+INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
+FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
+WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ 
+Except as contained in this notice, the name of a copyright holder
+shall not be used in advertising or otherwise to promote the sale, use
+or other dealings in this Software without prior written authorization
+of the copyright holder.

data/README.rdoc

@@ -0,0 +1,19 @@
+== OOFile
+oofile is an object-oriented way of accessing the filesystem.
+
+=== How to use it
+* 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.
+
+=== Compatibility
+This project is being developed on OS X. Automated testing for Linux will be included in future releases.
+ 
+=== Licence
+This is open source software and comes with no warranty. See COPYING for details.
+ 
+http://www.greenbarsoft.co.uk
+
+Copyright 2009-2011 Green Bar Software Limited, UK

data/TODO.rdoc

@@ -0,0 +1,2 @@
+== todo
+

data/doc/demo.rdoc

@@ -0,0 +1,70 @@
+== 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.fs_entry_from(file_string)
+    => #<OOFile::FileEntry:0x1016a34f0 @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.fs_entry_from(file_string)
+    => true
+    >> 
+    ?> # directories
+    ?> 
+    ?>  d= OOFile::FsEntry.fs_entry_from(dir_string)
+    => #<OOFile::DirEntry:0x10168a5b8 @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
+
+
+ oofile 0.0.1

data/doc/demo.script

@@ -0,0 +1,43 @@
+require 'oofile'
+
+dir_string = File.join(ENV['SANDBOX'],'oofile','test','data')
+file_string = File.join(dir_string,'testfile.txt')
+
+file_string
+
+dir_string
+
+f = OOFile::FsEntry.fs_entry_from(file_string)
+
+f.extname
+
+f.extnless
+
+f.basename
+
+f.dirname
+
+f.ctime
+
+f.size
+
+# equality comparison
+f == OOFile::FsEntry.fs_entry_from(file_string)
+
+# directories
+
+ d= OOFile::FsEntry.fs_entry_from(dir_string)
+
+d.extname
+
+d.extnless
+
+d.basename
+
+d.dirname
+
+d.ctime
+
+d.size
+
+

data/lib/oofile/filesystem.rb

@@ -0,0 +1,95 @@
+#require 'FileUtils'
+module OOFile
+  
+  # Abstract class which is the abstract base class for file system instances
+  class FsEntry 
+    # This is the canonical path to the file system entry
+    attr_reader :path
+
+    def initialize(path)
+      @path = File.expand_path(path)
+    end
+  
+    def ==(other)
+      self.path==(other.path)
+    end
+
+    def extname
+      File::extname(@path)
+    end
+
+    # the bare filename without the file extension
+    def extnless
+      b = basename
+      b[0,b.size-extname.size]
+    end
+
+    def basename
+      File::basename(@path)
+    end
+
+    def dirname
+      File::dirname(@path)
+    end
+  
+    def ctime
+      File::ctime(@path)
+    end
+
+    def size
+      File.size(@path)
+    end
+  
+    # creates a file system entry for a fully qualified pathname
+    def self.fs_entry_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))
+    end
+
+  end
+
+  # I represent a file in the filesystem
+  class FileEntry < FsEntry
+    
+    # I am visitable with a traverser.
+    def traverse(traverser)
+      traverser.traverse_file(self)
+    end
+  end
+
+  # I represent filesystem entries that have been detected but aren't supported.
+  class UnknownEntry < FsEntry
+  end
+
+  # I represent directories in the filesystem.
+  class DirEntry < FsEntry	
+
+    # I am visitable with a Traverser. I perform inorder traversal of FsEntries.
+    def traverse(traverser)
+      traverser.traverse_dir(self)
+      Dir.new(@path).each do |stringpath|
+        subentry = fs_entry_from(stringpath)
+        subentry.traverse(traverser) unless stringpath=='.' || stringpath=='..' 
+      end
+    end
+
+  end
+
+  # Visitor for traversing a filesystem
+  class Traverser
+    # callback when traversing a DirEntry object 
+    def traverse_dir(dir_entry)
+    end
+    
+    # callback when traversing a FileEntry object
+    def traverse_file(file_entry)
+    end
+  end
+
+end

data/lib/oofile.rb

@@ -0,0 +1,2 @@
+require 'oofile/filesystem'
+

data/test/data/testfile.txt

@@ -0,0 +1 @@
+My ctime is used for tests.

data/test/filesystem_test.rb

@@ -0,0 +1,106 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'oofile/filesystem'
+
+
+FS = File::SEPARATOR
+TEST_DIRNAME = 'data'
+TESTDATA_DIR = ENV['SANDBOX']+FS+'sitebuilder'+FS+'test'+FS+TEST_DIRNAME
+TEST_FILENAME = 'testfile.txt'
+TEST_FILEPATH = TESTDATA_DIR+FS+TEST_FILENAME
+
+class FsEntryTest < Test::Unit::TestCase
+  
+def test_instances_and_equality
+  a_file       = OOFile::FsEntry.new('/this/that/foo.txt')
+  another_file = OOFile::FsEntry.new('/this/that/foo.txt')
+  different_file=OOFile::FsEntry.new('/this/that/other.txt')
+  
+  assert_equal(another_file, a_file)
+  assert_equal(a_file, another_file)
+  assert_not_equal(a_file, different_file)
+  assert_not_equal(another_file, different_file)
+end
+
+def test_extname
+  assert_equal('.txt', OOFile::FsEntry.new('/this/that/foo.txt').extname)
+  assert_equal('', OOFile::FsEntry.new('/this/that/foo.').extname)
+  assert_equal('', OOFile::FsEntry.new('/this/that/foo').extname)
+  assert_equal('', OOFile::FsEntry.new('/this/that/.foo').extname)  
+end
+
+def test_extnless
+  assert_equal('foo', OOFile::FsEntry.new('/this/that/foo.txt').extnless)
+  assert_equal('foo.',OOFile::FsEntry.new('/this/that/foo.').extnless)
+  assert_equal('foo', OOFile::FsEntry.new('/this/that/foo').extnless)
+  assert_equal('.foo',OOFile::FsEntry.new('/this/that/.foo').extnless)
+end
+
+def test_basename
+  assert_equal('foo.txt', OOFile::FsEntry.new('/this/that/foo.txt').basename)
+  assert_equal('foo.txt', OOFile::FsEntry.new('/foo.txt').basename)
+end
+
+def test_dirname
+  assert_equal('/this/that', OOFile::FsEntry.new('/this/that/foo.txt').dirname)
+  assert_equal('/this/that', OOFile::FsEntry.new('/this/that/foo/').dirname)
+end
+
+def test_ctime
+  assert_equal(File::ctime(TEST_FILEPATH), OOFile::FsEntry.new(TEST_FILEPATH).ctime)
+  assert OOFile::FsEntry.new(TEST_FILEPATH).ctime.to_i > 0 
+end
+
+def test_size
+  assert_equal(28, OOFile::FsEntry.new(TEST_FILEPATH).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
+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('.')
+
+  assert_equal instance.path+FS+TEST_FILENAME, file_result.path
+  assert_equal instance.path, dir_result.path
+end
+
+end
+
+class FileEntryTest < Test::Unit::TestCase
+  
+def test_traverse
+  traverser = OOFile::Traverser.new
+  traverser.expects(:traverse_file).once().with do |file| 
+    OOFile::FileEntry==file.class && 'testfile.txt'==file.basename
+  end
+  traverser.expects(:traverse_dir).never()
+
+  file = OOFile::FsEntry.fs_entry_from(TEST_FILEPATH)
+  file.traverse(traverser)
+end
+
+end
+
+class DirEntryTest < Test::Unit::TestCase
+  
+  def test_traverse
+    traverser = OOFile::Traverser.new
+    traverser.expects(:traverse_file).once().with do |file| 
+      OOFile::FileEntry==file.class && 'testfile.txt'==file.basename
+    end
+    traverser.expects(:traverse_dir).once().with do |dir| 
+      OOFile::DirEntry==dir.class && TESTDATA_DIR==dir.path
+    end
+
+    file = OOFile::FsEntry.fs_entry_from(TESTDATA_DIR)
+    file.traverse(traverser)
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: oofile
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dafydd Rees
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-26 00:00:00 +00:00
+default_executable: 
+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
+description: Object-oriented access to the filesystem.
+email: os@greenbarsoft.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- 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
+homepage: http://www.greenbarsoft.co.uk/software/oofile
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Static site generator
+test_files: 
+- ./test/filesystem_test.rb