sitebuilder 0.0.1

data/COPYING

@@ -0,0 +1,32 @@
+SiteBuilder Licence
+ 
+COPYRIGHT AND PERMISSION NOTICE
+ 
+Copyright (c) 2009  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,28 @@
+= SiteBuilder
+SiteBuilder is a rule-based static website generator. It performs an inorder traversal of each
+file and directory in a source directory, applying exactly one transformation action per file.
+
+Each transformation action gets the opportunity to write output to a corresponding directory in
+a subdirectory of a destination directory.
+
+* The action to be used on each file or directory is determined by file extension.
+* Actions should not depend on the order in which they run, or on the output of other actions.
+* Actions may use any part of the source directory.
+* No action should change the source directory or its contents.
+
+= How to use it
+* Just a core object model & tests right now... needs to be completed.
+ 
+== RDOC API
+The rdoc can be found at http://www.greenbarsoft.co.uk/software/sitebuilder/rdoc/
+
+== 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 Green Bar Software Limited, UK

data/TODO.rdoc

@@ -0,0 +1,9 @@
+== todo
+* make template action
+* merge a text formatter into template action
+* make copy action
+* make index action
+* work out how to handle cross references
+* work out how to handle non-fatal errors
+* work out how to handle fatal errors
+* integrate SemanticText action

data/lib/sitebuilder/array.rb

@@ -0,0 +1,24 @@
+class Array
+
+  # execute block for each element of array, passing the element as the block
+  # parameter until the block returns true
+  def each_until(&block)
+    return false if empty?
+    for i in 0..size 
+      result_true = block.call(self[i]) 
+      break if result_true
+    end
+    if result_true
+        return true
+      else
+        return false
+    end
+  end
+
+  # return a subarray consisting of elements 2..n of the array 
+  # (i.e. all except the first element)
+  def tail
+    return self[1,size-1] if size>1
+    return []
+  end
+end

data/lib/sitebuilder/filesystem.rb

@@ -0,0 +1,95 @@
+require 'FileUtils'
+module SiteBuilder
+  
+  # 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/sitebuilder/gen.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+require 'sitebuilder/sitegenerator'
+module SiteBuilder
+
+swapout = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','source')
+replace = File.join(ENV['SANDBOX'],'sitebuilder','examples','homepage','dest')
+
+s = SiteGenerator.new(swapout,replace)
+s.add_action('.art') {|s,r| `cp #{s.path} #{r}`; puts      "article template #{s.path}\n\t\t #{r}"} 
+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}"}
+
+DirEntry.new(swapout).traverse(s)
+
+end

data/lib/sitebuilder/sitegenerator.rb

@@ -0,0 +1,45 @@
+require 'sitebuilder/filesystem'
+require 'sitebuilder/string'
+
+module SiteBuilder
+  
+  # I generate a target website directory from a source website directory
+  # using mapping rules that determine what should be done for each file
+  # of the source website directory.
+  class SiteGenerator < Traverser
+    
+    # I set up the source website directory and the destination website directory.
+    def initialize(source, destination)
+      @swapout = source
+      @replace = destination
+      @actions = {}
+      @actions.default=Proc.new {|s,r| puts "default action source:#{s.path}\n\t\t destination:#{r}"}
+    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}`
+    end
+    
+    # internal callback used to handle a source file
+    def traverse_file(file_entry)
+      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)
+      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
+    end
+  end
+
+end

data/lib/sitebuilder/string.rb

@@ -0,0 +1,40 @@
+class String
+  
+  # return true iff string commences with target
+  def begins_with(target)
+    self[0,target.size]==target
+  end
+
+  # return true iff string ends with target
+  def ends_with(target)
+    target_size = target.size
+    target==self[-target_size,target_size]
+  end
+
+  # return true iff string ends with target
+  # Case insensitive version.  
+  def case_ends_with(target)
+    target_size = target.size
+    target.upcase==self.upcase[-target_size,target_size]
+  end
+
+  # iff string begins_with prefix, replace it with new_prefix
+  def substitute_prefix!(prefix,new_prefix)
+    return self if prefix != self[0,prefix.size]
+    self[0,prefix.size] = new_prefix
+    self
+  end
+
+  # iff string begins_with prefix, return a clone on which the
+  # new_prefix has been substituted for prefix
+  def substitute_prefix(prefix,new_prefix)
+    result =self.clone
+    result.substitute_prefix!(prefix,new_prefix)
+  end
+
+  # returns substring to the righthand side of the rightmost occurrence of token
+  def rightmost_of_token(token) 
+     rightmost_index = rindex(token)
+     rightmost_index.nil? ? '' : self[rightmost_index+1,size-rightmost_index]
+  end
+end

data/lib/sitebuilder.rb

@@ -0,0 +1,4 @@
+require 'sitebuilder/array'
+require 'sitebuilder/filesystem'
+require 'sitebuilder/sitegenerator'
+require 'sitebuilder/string'

data/test/array_test.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'test/unit'
+require 'sitebuilder/array'
+
+class ArrayTest < Test::Unit::TestCase
+
+def test_tail
+  assert_equal([],[].tail);
+  assert_equal([],[1].tail);
+  assert_equal([2],[1,2].tail);
+  assert_equal([2,3],[1,2,3].tail);
+end
+
+def test_each_until_empty
+  result = [].each_until {|i| true}
+  assert !result, "empty array should return false"
+end
+
+def test_each_until_found
+  unit = [1,2,3,4,5]
+  pass_count = 0
+  result = unit.each_until {|i| pass_count=pass_count+1; true if i==3}
+  assert_equal(true, result, 'should return true')
+  assert_equal(3, pass_count,'should have traversed elements 1, 2 and 3')
+end
+
+def test_each_until_not_found
+  unit = [1,2,33,4,5]
+  pass_count = 0
+  result = unit.each_until {|i| pass_count=pass_count+1; true if i==3}
+  assert_equal(false, result, 'should return false')
+  assert_equal(unit.length+1, pass_count,'should have traversed elements 1, 2 and 33')
+end
+
+end

data/test/data/testfile.txt

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

data/test/filesystem_test.rb

@@ -0,0 +1,104 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'sitebuilder/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       = SiteBuilder::FsEntry.new('/this/that/foo.txt')
+  another_file = SiteBuilder::FsEntry.new('/this/that/foo.txt')
+  different_file=SiteBuilder::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', SiteBuilder::FsEntry.new('/this/that/foo.txt').extname)
+  assert_equal('', SiteBuilder::FsEntry.new('/this/that/foo.').extname)
+  assert_equal('', SiteBuilder::FsEntry.new('/this/that/foo').extname)
+  assert_equal('', SiteBuilder::FsEntry.new('/this/that/.foo').extname)  
+end
+
+def test_extnless
+  assert_equal('foo', SiteBuilder::FsEntry.new('/this/that/foo.txt').extnless)
+  assert_equal('foo.',SiteBuilder::FsEntry.new('/this/that/foo.').extnless)
+  assert_equal('foo', SiteBuilder::FsEntry.new('/this/that/foo').extnless)
+  assert_equal('.foo',SiteBuilder::FsEntry.new('/this/that/.foo').extnless)
+end
+
+def test_basename
+  assert_equal('foo.txt', SiteBuilder::FsEntry.new('/this/that/foo.txt').basename)
+  assert_equal('foo.txt', SiteBuilder::FsEntry.new('/foo.txt').basename)
+end
+
+def test_dirname
+  assert_equal('/this/that', SiteBuilder::FsEntry.new('/this/that/foo.txt').dirname)
+  assert_equal('/this/that', SiteBuilder::FsEntry.new('/this/that/foo/').dirname)
+end
+
+def test_ctime
+  assert_equal(File::ctime(TEST_FILEPATH), SiteBuilder::FsEntry.new(TEST_FILEPATH).ctime)
+  assert SiteBuilder::FsEntry.new(TEST_FILEPATH).ctime.to_i > 0 
+end
+
+def test_size
+  assert_equal(28, SiteBuilder::FsEntry.new(TEST_FILEPATH).size) 
+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
+end
+
+def test_instance_fs_entry_from
+  instance = SiteBuilder::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 = SiteBuilder::Traverser.new
+  traverser.expects(:traverse_file).once().with do |file| 
+    SiteBuilder::FileEntry==file.class && 'testfile.txt'==file.basename
+  end
+  traverser.expects(:traverse_dir).never()
+
+  file = SiteBuilder::FsEntry.fs_entry_from(TEST_FILEPATH)
+  file.traverse(traverser)
+end
+
+end
+
+class DirEntryTest < Test::Unit::TestCase
+  
+  def test_traverse
+    traverser = SiteBuilder::Traverser.new
+    traverser.expects(:traverse_file).once().with do |file| 
+      SiteBuilder::FileEntry==file.class && 'testfile.txt'==file.basename
+    end
+    traverser.expects(:traverse_dir).once().with do |dir| 
+      SiteBuilder::DirEntry==dir.class && TESTDATA_DIR==dir.path
+    end
+
+    file = SiteBuilder::FsEntry.fs_entry_from(TESTDATA_DIR)
+    file.traverse(traverser)
+  end
+
+end

data/test/string_test.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'test/unit'
+require 'sitebuilder/string'
+
+class ArrayTest < Test::Unit::TestCase
+
+def test_begins_with
+  assert "This is an arbitrary string.".begins_with('')
+  assert "This is an arbitrary string.".begins_with('T')
+  assert "This is an arbitrary string.".begins_with('This is ')
+  assert !("This is an arbitrary string.".begins_with('This xis '))
+end
+
+def test_ends_with
+  assert "This is an arbitrary string.".ends_with('ing.')
+  assert "This is an arbitrary string.".ends_with('')
+  assert !("This is an arbitrary string.".ends_with('ingx.'))
+end
+
+def test_case_ends_with
+  assert "This is an arbitrary string.".case_ends_with('ing.')
+  assert "This is an arbitrary string.".case_ends_with('')
+  assert !("This is an arbitrary string.".case_ends_with('ingx.'))
+
+  assert "This is an arbitrary striNg.".case_ends_with('ing.')
+  assert "This is an arbitrary string.".case_ends_with('iNg.')
+  assert !("This is an arbitrary string.".case_ends_with('ingX.'))
+end
+
+def test_substitute_prefix_exclamation
+  unit = "This is an arbitrary string."
+  unit.substitute_prefix!("This is an","This is a very")
+  assert_equal "This is a very arbitrary string.", unit
+end
+
+def test_substitute_prefix_exclamation_when_prefix_doesnt_match
+  unit = "The cat sat on the mat."
+  unit.substitute_prefix!("This is an","This is a very")
+  assert_equal "The cat sat on the mat.", unit
+end
+
+def test_substitute_prefix_exclamation_when_prefix_doesnt_match_and_string_empty
+  unit = ""
+  unit.substitute_prefix!("This is an","This is a very")
+  assert_equal "", unit
+end
+
+def test_substitute_prefix_exclamation_when_prefix_match_is_empty
+  unit = "This is an arbitrary string."
+  unit.substitute_prefix!("","This is a very")
+  assert_equal "This is a veryThis is an arbitrary string.", unit
+end
+
+################
+
+def test_substitute_prefix
+  unit = "This is an arbitrary string."
+  assert_equal "This is a very arbitrary string.", unit.substitute_prefix("This is an","This is a very")
+  assert_equal "This is an arbitrary string.", unit
+end
+
+def test_substitute_prefix_when_prefix_doesnt_match
+  unit = "The cat sat on the mat."
+  assert_equal "The cat sat on the mat.", unit.substitute_prefix("This is an","This is a very")
+end
+
+def test_substitute_prefix_when_prefix_doesnt_match_and_string_empty
+  assert_equal "", "".substitute_prefix("This is an","This is a very")
+end
+
+def test_substitute_prefix_when_prefix_match_is_empty
+  unit = "This is an arbitrary string."
+  assert_equal "This is a veryThis is an arbitrary string.", unit.substitute_prefix("","This is a very")
+end
+
+def test_rightmost_of_token
+  assert_equal 'ring.', "This is an arbitrary string.".rightmost_of_token('t')
+  assert_equal '', "This is an arbitrary string.".rightmost_of_token('x')
+end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: sitebuilder
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dafydd Rees
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-03 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Static website generator using rule-based translation.
+email: os@greenbarsoft.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- COPYING
+- README.rdoc
+- TODO.rdoc
+files: 
+- lib/sitebuilder/array.rb
+- lib/sitebuilder/filesystem.rb
+- lib/sitebuilder/gen.rb
+- lib/sitebuilder/sitegenerator.rb
+- lib/sitebuilder/string.rb
+- lib/sitebuilder.rb
+- test/array_test.rb
+- test/data/testfile.txt
+- test/filesystem_test.rb
+- test/string_test.rb
+- CHANGELOG
+- COPYING
+- README.rdoc
+- TODO.rdoc
+has_rdoc: true
+homepage: http://www.greenbarsoft.co.uk/software/sitebuilder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Static site generator
+test_files: 
+- ./test/array_test.rb
+- ./test/filesystem_test.rb
+- ./test/string_test.rb