sitebuilder 0.0.4 → 0.0.5

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 0.0.5
+     2010-01-28: refactored use of procs into explicit actions
+     2009-12-19:simplified initiation of sitebuilder - just call "generate" method on a sitebuilder object
 == 0.0.4
      2009-12-13:added spike of how to use erb and semantictext gem
      2009-12-13:added explicit runtime dependency on semantictext

data/README.rdoc

@@ -14,7 +14,6 @@ a subdirectory of a destination directory.
 * Install with:
     gem install sitebuilder 
 * Basic operation can be seen in demo.rdoc
-* Just a core object model & tests right now... needs to be completed.
 * *rdoc*  http://www.greenbarsoft.co.uk/software/sitebuilder/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.

data/TODO.rdoc

@@ -1,8 +1,8 @@
 == todo
 * make template action - with erb and semantictext
 * merge a text formatter into template action
-* work out how to map file paths to URLs
 * make copy action
+* work out how to map file paths to URLs
 * make index action
 * work out how to handle cross references
 * work out how to handle non-fatal errors
@@ -10,4 +10,5 @@
 * integrate SemanticText action
 
 == DONE
+* acquire test coverage on SiteBuilder::SiteGenerator#traverse_dir
 * fix "warning: already initialized constant"

data/doc/demo.rdoc

@@ -17,50 +17,54 @@ If using sitebuilder from a gem, remember to "require 'rubygems'"...
     demo.script(main):010:1> end
     => nil
     demo.script(main):011:0> 
-    demo.script(main):012:0* def mapit(src, tmpl, dst)
-    demo.script(main):013:1>   template = ''
-    demo.script(main):014:1>   File.open(tmpl) do |f|
-    demo.script(main):015:2*     f.readlines.each {|l| template += l }
-    demo.script(main):016:2>   end
-    demo.script(main):017:1>   content = ''
-    demo.script(main):018:1>   File.open(src) do |c|
-    demo.script(main):019:2*     c.readlines.each {|l| content += l }
-    demo.script(main):020:2>   end
-    demo.script(main):021:1>   e = ERB.new template
-    demo.script(main):022:1>   document = Document.new(content)
-    demo.script(main):023:1>   File.open(dst,'w') do |f|
-    demo.script(main):024:2*     f.puts e.result(binding)
-    demo.script(main):025:2>   end
-    demo.script(main):026:1> end
-    => nil
-    demo.script(main):027:0> templatepath = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','template.rhtml')
-    => "/Users/daf/macbook/workspace/sitebuilder/examples/homepage/template.rhtml"
-    demo.script(main):028:0> swapout = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','source')
+    demo.script(main):012:0* @templatepath = 
+    demo.script(main):013:0* swapout = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','source')
     => "/Users/daf/macbook/workspace/sitebuilder/examples/homepage/source"
-    demo.script(main):029:0> replace = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','dest')
+    demo.script(main):014:0> replace = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','dest')
     => "/Users/daf/macbook/workspace/sitebuilder/examples/homepage/dest"
-    demo.script(main):030:0> 
-    demo.script(main):031:0* s = SiteBuilder::SiteGenerator.new(swapout,replace)
-    => #<SiteBuilder::SiteGenerator:0x6bf300 @actions={}, @replace="/Users/daf/macbook/workspace/sitebuilder/examples/homepage/dest", @swapout="/Users/daf/macbook/workspace/sitebuilder/examples/homepage/source">
-    demo.script(main):032:0> s.add_action('.art') do |s,r| 
-    demo.script(main):033:1*   mapit(s.path,templatepath,File.join(r,s.extnless+'.html'))
-    demo.script(main):034:1> end 
-    => #<Proc:0x006a8aec@/Users/daf/macbook/workspace/sitebuilder/doc/demo.script:32>
-    demo.script(main):035:0> 
-    demo.script(main):036:0* s.add_action('.idx') {|s,r| `cp #{s.path} #{r}`; puts      "index template   #{s.path}\n\t\t #{r}"} 
-    => #<Proc:0x006908fc@/Users/daf/macbook/workspace/sitebuilder/doc/demo.script:36>
-    demo.script(main):037:0> s.add_action('.png') {|s,r| `cp #{s.path} #{r}`; puts      "png copy         #{s.path}\n\t\t #{r}"}
-    => #<Proc:0x0067a174@/Users/daf/macbook/workspace/sitebuilder/doc/demo.script:37>
-    demo.script(main):038:0> s.add_action('.css') {|s,r| `cp #{s.path} #{r}`; puts      "css copy         #{s.path}\n\t\t #{r}"}
-    => #<Proc:0x0064aca8@/Users/daf/macbook/workspace/sitebuilder/doc/demo.script:38>
+    demo.script(main):015:0> 
+    demo.script(main):016:0* #This is just a templating action - for real use, you'd need to process markup from "content" as well...
+    demo.script(main):017:0* class TemplateAction < SiteBuilder::Action
+    demo.script(main):018:1>   def mapit(src, tmpl, dst)
+    demo.script(main):019:2>     template = ''
+    demo.script(main):020:2>     File.open(tmpl) do |f|
+    demo.script(main):021:3*       f.readlines.each {|l| template += l }
+    demo.script(main):022:3>     end
+    demo.script(main):023:2>     content = ''
+    demo.script(main):024:2>     File.open(src) do |c|
+    demo.script(main):025:3*       c.readlines.each {|l| content += l }
+    demo.script(main):026:3>     end
+    demo.script(main):027:2>     e = ERB.new template
+    demo.script(main):028:2>     document = Document.new(content)
+    demo.script(main):029:2>     File.open(dst,'w') do |f|
+    demo.script(main):030:3*       f.puts e.result(binding)
+    demo.script(main):031:3>     end
+    demo.script(main):032:2>   end
+    demo.script(main):033:1>   
+    demo.script(main):034:1*   def convert(s, r)
+    demo.script(main):035:2>     templatepath = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','template.rhtml')
+    demo.script(main):036:2>     mapit(s.path, templatepath, File.join(r,s.extnless+'.html'))    
+    demo.script(main):037:2>   end
+    demo.script(main):038:1> end
+    => nil
     demo.script(main):039:0> 
-    demo.script(main):040:0* SiteBuilder::DirEntry.new(swapout).traverse(s)
-    css copy         /Users/daf/macbook/workspace/sitebuilder/examples/homepage/source/homepage.css
-    		 /Users/daf/macbook/workspace/sitebuilder/examples/homepage/dest
-    => #<Dir:0x6403d4>
-    demo.script(main):041:0> 
-    demo.script(main):042:0* demo.script(main):042:0> 
+    demo.script(main):040:0* s = SiteBuilder::SiteGenerator.new(swapout,replace)
+    => #<SiteBuilder::SiteGenerator:0x63c61c @swapout="/Users/daf/macbook/workspace/sitebuilder/examples/homepage/source", @actions={}, @replace="/Users/daf/macbook/workspace/sitebuilder/examples/homepage/dest">
+    demo.script(main):041:0> s.add_action('.art', TemplateAction.new)
+    => #<TemplateAction:0x6336e8>
+    demo.script(main):042:0> 
+    demo.script(main):043:0* s.add_action('.idx', SiteBuilder::CopyAction.new)
+    => #<SiteBuilder::CopyAction:0x627938>
+    demo.script(main):044:0> s.add_action('.png', SiteBuilder::CopyAction.new)
+    => #<SiteBuilder::CopyAction:0x620994>
+    demo.script(main):045:0> s.add_action('.css', SiteBuilder::CopyAction.new)
+    => #<SiteBuilder::CopyAction:0x618384>
+    demo.script(main):046:0> s.generate
+    cp /Users/daf/macbook/workspace/sitebuilder/examples/homepage/source/homepage.css /Users/daf/macbook/workspace/sitebuilder/examples/homepage/dest
+    => #<Dir:0x615a94>
+    demo.script(main):047:0> 
+    demo.script(main):048:0* demo.script(main):048:0> 
 
 
- Sitebuilder 0.0.3
+ Sitebuilder 0.0.4
 

data/doc/demo.script

@@ -9,33 +9,39 @@ class Document
   end
 end
 
-def mapit(src, tmpl, dst)
-  template = ''
-  File.open(tmpl) do |f|
-    f.readlines.each {|l| template += l }
-  end
-  content = ''
-  File.open(src) do |c|
-    c.readlines.each {|l| content += l }
+@templatepath = 
+swapout = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','source')
+replace = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','dest')
+
+#This is just a templating action - for real use, you'd need to process markup from "content" as well...
+class TemplateAction < SiteBuilder::Action
+  def mapit(src, tmpl, dst)
+    template = ''
+    File.open(tmpl) do |f|
+      f.readlines.each {|l| template += l }
+    end
+    content = ''
+    File.open(src) do |c|
+      c.readlines.each {|l| content += l }
+    end
+    e = ERB.new template
+    document = Document.new(content)
+    File.open(dst,'w') do |f|
+      f.puts e.result(binding)
+    end
   end
-  e = ERB.new template
-  document = Document.new(content)
-  File.open(dst,'w') do |f|
-    f.puts e.result(binding)
+  
+  def convert(s, r)
+    templatepath = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','template.rhtml')
+    mapit(s.path, templatepath, File.join(r,s.extnless+'.html'))    
   end
 end
-templatepath = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','template.rhtml')
-swapout = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','source')
-replace = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','dest')
 
 s = SiteBuilder::SiteGenerator.new(swapout,replace)
-s.add_action('.art') do |s,r| 
-  mapit(s.path,templatepath,File.join(r,s.extnless+'.html'))
-end 
-
-s.add_action('.idx') {|s,r| `cp #{s.path} #{r}`; puts      "index template   #{s.path}\n\t\t #{r}"} 
-s.add_action('.png') {|s,r| `cp #{s.path} #{r}`; puts      "png copy         #{s.path}\n\t\t #{r}"}
-s.add_action('.css') {|s,r| `cp #{s.path} #{r}`; puts      "css copy         #{s.path}\n\t\t #{r}"}
+s.add_action('.art', TemplateAction.new)
 
-SiteBuilder::DirEntry.new(swapout).traverse(s)
+s.add_action('.idx', SiteBuilder::CopyAction.new)
+s.add_action('.png', SiteBuilder::CopyAction.new)
+s.add_action('.css', SiteBuilder::CopyAction.new)
+s.generate
 

data/lib/sitebuilder/actions.rb

@@ -0,0 +1,21 @@
+module SiteBuilder
+  class Action    
+    def convert(source, destination)
+      throw Exception.new("should implement Action#convert")
+    end
+  end
+  
+  class CopyAction < Action
+    def convert(source, destination)
+      `cp #{source.path} #{destination}`
+      puts "cp #{source.path} #{destination}"
+    end
+  end
+  
+  class NullAction < Action
+    def convert(source, destionation)
+    end
+  end
+  
+  
+end

data/lib/sitebuilder/sitegenerator.rb

@@ -1,5 +1,7 @@
 require 'sitebuilder/filesystem'
 require 'sitebuilder/string'
+require 'sitebuilder/actions'
+require 'fileutils'
 
 module SiteBuilder
   
@@ -9,18 +11,18 @@ module SiteBuilder
   class SiteGenerator < Traverser
     
     # I set up the source website directory and the destination website directory.
-    def initialize(source, destination)
+    def initialize(source, destination, default_action=NullAction.new) 
       @swapout = source
       @replace = destination
       @actions = {}
-      @actions.default=Proc.new {|s,r| puts "default action source:#{s.path}\n\t\t destination:#{r}"}
+      @actions.default = default_action
     end
     
     # internal callback used to handle a source directory
     def traverse_dir(dir_entry)
         converted_path = dir_entry.path.clone
         converted_path.substitute_prefix!(@swapout, @replace)
-        `mkdir #{converted_path}`
+        FileUtils.mkdir_p(converted_path)
     end
     
     # internal callback used to handle a source file
@@ -28,17 +30,17 @@ module SiteBuilder
       if !file_entry.path.index('.svn')
         converted_path = file_entry.dirname
         converted_path.substitute_prefix!(@swapout, @replace) #BUG? - no clone here?
-        @actions[file_entry.extname].call(file_entry, converted_path)
+        @actions[file_entry.extname].convert(file_entry, converted_path)
       end
     end
-  
-    # Add an action for a given source file extension. The action is given by a block which
-    # will be executed when traversal finds a matching file system entry matching the
-    # extension. The block is takes 2 arguments, first the FsEntry representing the source
-    # file system entry, and the second, a String which is the path to the destination 
-    # directory.
-    def add_action(extension, &proc) 
-      @actions[extension]=proc
+
+    def add_action(extension, action) 
+      @actions[extension]=action
+    end
+    
+    # Initiate site generation
+    def generate
+      DirEntry.new(@swapout).traverse(self)
     end
   end
 

data/test/filesystem_test.rb

@@ -58,6 +58,7 @@ end
 def test_fs_entry_from
   assert_equal SiteBuilder::FileEntry, SiteBuilder::FsEntry.fs_entry_from(TEST_FILEPATH).class
   assert_equal SiteBuilder::DirEntry,  SiteBuilder::FsEntry.fs_entry_from(TESTDATA_DIR).class
+  assert_equal SiteBuilder::UnknownEntry, SiteBuilder::FsEntry.fs_entry_from('/dev/null').class
 end
 
 def test_instance_fs_entry_from

data/test/sitegenerator_test.rb

@@ -0,0 +1,49 @@
+require 'sitebuilder/sitegenerator'
+require 'sitebuilder/filesystem'
+require 'sitebuilder/actions'
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'fileutils'
+
+class SitebuilderTest< Test::Unit::TestCase
+
+def test_traverse_file_traverses_on_matching_file_extension
+  mock_action = mock("an action")
+  fixture_file_entry = SiteBuilder::FileEntry.new('/path/to/source/foo/testfilename.test')
+  mock_action.expects(:convert).once().with(fixture_file_entry, '/path/to/dest/foo')
+  
+  unit = SiteBuilder::SiteGenerator.new('/path/to/source','/path/to/dest')  
+  unit.add_action('.test', mock_action)  
+  unit.traverse_file(fixture_file_entry)
+end
+
+def test_traverse_file_doesnt_traverse_on_nonmatching_file_extension
+  fixture_file_entry = SiteBuilder::FileEntry.new('/path/to/source/foo/testfilename.nomatch')
+  mock_default_action_to_be_called = mock("default action")
+  mock_default_action_to_be_called.expects(:convert).once().with(fixture_file_entry, '/path/to/dest/foo')
+  mock_action_not_to_be_called = mock("an action")
+  
+  unit = SiteBuilder::SiteGenerator.new('/path/to/source','/path/to/dest', mock_default_action_to_be_called)  
+  
+  unit.add_action('.test', mock_action_not_to_be_called)
+  unit.traverse_file(fixture_file_entry)
+end
+
+def test_traverse_dir_creates_corresponding_directory
+  FileUtils.expects(:mkdir_p).once().with('/path/to/dest/foo')
+  fixture_dir_entry = SiteBuilder::DirEntry.new('/path/to/source/foo')
+  unit = SiteBuilder::SiteGenerator.new('/path/to/source','/path/to/dest')  
+  unit.traverse_dir(fixture_dir_entry)  
+end
+
+def test_generate_initiates_sitebuilder_conversion
+  unit = SiteBuilder::SiteGenerator.new('/path/to/source','/path/to/dest')  
+  mock_dir_entry = mock("a mock DirEntry")
+  mock_dir_entry.expects(:traverse).once().with(unit)
+  SiteBuilder::DirEntry.expects(:new).once().with('/path/to/source').returns(mock_dir_entry)
+
+  unit.generate
+end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sitebuilder
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Dafydd Rees
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-13 00:00:00 +00:00
+date: 2010-01-28 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.8
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
 description: Static website generator using rule-based translation.
 email: os@greenbarsoft.co.uk
 executables: []
@@ -45,8 +55,8 @@ extra_rdoc_files:
 - doc/demo.rdoc
 - TODO.rdoc
 files: 
-- doc/complex.script
 - doc/demo.script
+- lib/sitebuilder/actions.rb
 - lib/sitebuilder/array.rb
 - lib/sitebuilder/filesystem.rb
 - lib/sitebuilder/sitegenerator.rb
@@ -55,6 +65,7 @@ files:
 - test/array_test.rb
 - test/data/testfile.txt
 - test/filesystem_test.rb
+- test/sitegenerator_test.rb
 - test/string_test.rb
 - CHANGELOG.rdoc
 - COPYING
@@ -92,4 +103,5 @@ summary: Static site generator
 test_files: 
 - ./test/array_test.rb
 - ./test/filesystem_test.rb
+- ./test/sitegenerator_test.rb
 - ./test/string_test.rb

data/doc/complex.script

@@ -1,42 +0,0 @@
-require 'sitebuilder'
-require 'rubygems'
-require 'semantictext'
-require 'erb'
-
-class Document
-  attr_reader :content
-  def initialize(c)
-    @content=c
-  end
-end
-
-def mapit(src, tmpl, dst)
-  template = ''
-  File.open(tmpl) do |f|
-    f.readlines.each {|l| template += l }
-  end
-  content = ''
-  File.open(src) do |c|
-    c.readlines.each {|l| content += l }
-  end
-  e = ERB.new template
-  document = Document.new(content)
-  File.open(dst,'w') do |f|
-    f.puts e.result(binding)
-  end
-end
-templatepath = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','template.rhtml')
-swapout = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','source')
-replace = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','dest')
-
-s = SiteBuilder::SiteGenerator.new(swapout,replace)
-s.add_action('.art') do |s,r| 
-  mapit(s.path,templatepath,File.join(r,s.extnless+'.html'))
-end 
-
-s.add_action('.idx') {|s,r| `cp #{s.path} #{r}`; puts      "index template   #{s.path}\n\t\t #{r}"} 
-s.add_action('.png') {|s,r| `cp #{s.path} #{r}`; puts      "png copy         #{s.path}\n\t\t #{r}"}
-s.add_action('.css') {|s,r| `cp #{s.path} #{r}`; puts      "css copy         #{s.path}\n\t\t #{r}"}
-
-SiteBuilder::DirEntry.new(swapout).traverse(s)
-