rote 0.3.6 → 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGYyMGY1ZjJjYjZiZmUwYTlhMjcxYjI0ODNkODMxM2QyMmNmMTEzMA==
+  data.tar.gz: !binary |-
+    NWIyYTE0M2M0OWRlNTA4NGIwYzVhNjI2NTRjMTE2OWE4ZDk0Njk5YQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTI0ODEzMDljMmEwZWU4YzNkMzVlYzUyMjkxNTJkNmZmZjBjYmQwYTliZjBh
+    YWNhYzc2YjAzMzUzNGIxNmViN2E5ZTQ5NzNhNzNlYzExYzkzMjdiNzI4MmZi
+    OWE4YjRlYWRjMjQ5Y2U4YWIzNDk5MDUwYWE5MjIxYmI4MzUzNzY=
+  data.tar.gz: !binary |-
+    NWVjZWIzMDhhMmI3ODMxMDFmMWE4NjlhNjgyNWUwM2FjZDY5YWNkYzA5ODNk
+    NmRkY2NjMmEwZjYxNmNlNjk2ODExYjUyNGNkOTdiYzkyZDNlYzM1ODU0OGYx
+    YTVmZmM0ZTU5YTczYjRhYWE5ZWY3MTkzMWZhMmRmODYwNGRjYWQ=

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c)2005, 2006 Ross Bamford (and contributors). All rights reserved.
+Copyright (c)2005-2013 Ross Bamford (and contributors). 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 

data/{README → README.md}

@@ -1,47 +1,51 @@
-= ROTE - A static website build tool for Ruby
+ROTE - A static website build tool for Ruby
+===========================================
 
-== What is this?
+What is this?
+-------------
 
 Rote is a simple page-based template system that was written to make it
 easier to author and maintain non-dynamic websites and offline documentation. 
-Rote provides a simple commandline or Rake [http://rake.rubyforge.org] based 
+Rote provides a simple commandline or [Rake](http://rake.rubyforge.org) based
 build for your pages, with page rendering (optionally supporting Textile, RDoc, 
-Markdown, and embedded Ruby code with RedCloth [http://redcloth.rubyforge.org/]
-and ERB [http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html]), 
+Markdown, and embedded Ruby code with [RedCloth](http://redcloth.rubyforge.org/)
+and [ERB](http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html)), 
 layout, and general documentation / website build tasks.
 
-== Prerequisites
+Prerequisites
+-------------
 
 Rote requires the following (versions are as per my development environment,
 you may find you can use older versions, you may not).
 	
-* Ruby 1.8.x (http://ruby-lang.org/)
-* Rake 0.6.2 ('gem install rake')
+* Ruby 1.9.3 (http://ruby-lang.org/)
+* Rake 0.9.9.2 ('gem install rake')
 
 The following optional dependencies will be used if present:
 
-* RubyGems 0.8.11 (http://rubygems.rubyforge.org/) 
-* RedCloth 3.0.4 ('gem install RedCloth') (_Only required if Textile formatting is used_)
-* BlueCloth 1.0.0 ('gem install BlueCloth') (_Only required if Markdown or formatting is used_)
-* Syntax 1.0.0 ('gem install syntax') (_Only required if syntax highlighting formatting is used_)
-* HTMLTidy (http://tidy.sourceforge.net/) (_Only required if Tidy filter is used_)
+* RubyGems 1.8.16 (http://rubygems.rubyforge.org/) 
+* RedCloth 4.2.9 ('gem install RedCloth') (*Only required if Textile formatting is used*)
+* BlueCloth 1.0.1 ('gem install BlueCloth') (*Only required if Markdown or formatting is used*)
+* Syntax 1.0.0 ('gem install syntax') (*Only required if syntax highlighting formatting is used*)
+* HTMLTidy (http://tidy.sourceforge.net/) (*Only required if Tidy filter is used*)
 
-RubyGems [http://rubyforge.org/frs/?group_id=126] is *highly recommended*,
+[RubyGems](http://rubygems.org) is **highly recommended**,
 and makes for not only an easier install but a cleaner library path.
-Rote is tested with Gems 0.8.11.
+Rote is tested with Gems 2.0.3.
 
 Please note that Rote is written and tested on Linux - I have no facilities
 to test with, e.g. Windows, and would like very much to hear about any issues 
 that affect usage with other OSes.
 
-== Installation ... 
+Installation ... 
+-----------------
 
-=== ... with RubyGems?
+### ... with RubyGems?
 
 If you have RubyGems, you can install Rote by simply issuing the command:
-
+```
 	gem install -r rote 
-	
+```	
 Which should download the latest version and install it, including
 the 'rote' wrapper script and man pages.	If you experience problems,
 or wish to perform an offline installation, then simply download the 
@@ -52,17 +56,18 @@ directory.
 You will need to copy them to the appropriate location manually if using
 this method.
 
-=== ... with install.rb?
+### ... with install.rb?
 
 If you don't have RubyGems, you can install from one of the tarball or zip
-packages, using the following command:
-
+packages found on [our RubyForge page](http://http://rubyforge.org/frs/?group_id=1120)
+, using the following command:
+```
 	ruby install.rb
-	
+```	
 from the unpacked root directory. This will copy the libaries to the 
 appropriate	place, and set up the rote wrapper script, manpages, and so on.
 
-=== ... in my own way?
+### ... in my own way?
 
 If you're one of those people who just has to be different, then you'll be
 pleased to know you can carry on that tradition, and place the files
@@ -70,7 +75,7 @@ pretty much where you like. Simply point an environment variable,
 ROTE_LIB, at the top-level lib directory (where rote.rb is found), and
 ensure rote (or a symlink) is visible in your path. 
 
-=== Did it work?
+### Did it work?
 
 With that done, you should be able to run 
 
@@ -79,20 +84,22 @@ With that done, you should be able to run
 to verify that the command-line wrapper is working. You should of course see
 the version number of your Rote installation.
 
-*NOTE* Windows users - you may experience problems at this point, with Rote
+**NOTE** Windows users - you may experience problems at this point, with Rote
 complaining that 'rake' is an invalid command. To fix this, simply set an
 environment variable, RAKE_CMD, with the command to execute for rake
 (e.g. rake.bat).
 
-== How do I use it?
+How do I use it?
+----------------
 
 Please see the user guide for usage information. The latest version can be
-found online at http://rote.rubyforge.org/guide/ , and documentation source for
+found online at http://github.com/roscopeco/rote , and documentation source for
 a specific release is included in the release package. 
 
 See above for instructions on building the documentation set.
 
-=== A note about version numbers
+A note about version numbers
+----------------------------
 
 Rote uses odd/even numbers for development/release versions. When the final
 version component is odd, the package is an 'unofficial' build - generally
@@ -108,22 +115,25 @@ version consistency.
 If you are bundling Rote with your product, please ensure you use an official
 release version whenever possible. If you must use a developmental version,
 please modify the package version to reflect the fact that it is a custom
-build (e.g. 0.1.3-mycompany-20051021) to prevent inconsistent development
+build (e.g. 0.1.3-mycompany-20121021) to prevent inconsistent development
 packages from escaping into the wild.
 
-=== Further information
+Further information
+-------------------
 
-Rote is developed by Ross Bamford (rosco <at> roscopeco.co.uk), with help from
+Rote is developed by Ross Bamford (roscopeco at gmail dot com), with help from
 the developers listed in CONTRIBUTORS. Any bugs are probably down to Ross, 
 though, so flame him if it breaks your day ;P
 
-* Homepage - http://rote.rubyforge.org/
-* Project - http://rubyforge.org/projects/rote
-* Issues - http://rubyforge.org/tracker/?group_id=1120
+* Homepage - http://github.com/roscopeco/rote
+* Issues - https://github.com/roscopeco/rote/issues
 * Lists - rote-users@rubyforge.org, rote-devel@rubyforge.org (http://rubyforge.org/mail/?group_id=1120)
 
+Thanks
+------
+
 As you may have guessed, Rote's hosting and development services are provided
-by http://RubyForge.org .
+by a combination of [GitHub](http://github.com) and [Rubyforge](http://rubyforge.org).
 
 The people who have been instrumental in making Rote a better piece of 
 software, without direct involvement in the development process. Without the

data/Rakefile

@@ -1,24 +1,24 @@
 # Rote Rakefile (run with 'rake' command)
 #
-# Copyright 2005 Ross Bamford (and contributors). All rights reserved.
+# Copyright 2005, 2012 Ross Bamford (and contributors). All rights reserved.
 # Rote is distributed under an MIT style license.  See LICENSE for details.
 #
 # This Rakefile is heavily based on Rake's own Rakefile.
 # Portions copyright (c)2003, 2004 Jim Weirich (jim <AT> weirichhouse.org)
 #
-# $Id: Rakefile 185 2006-10-26 19:41:31Z roscopeco $
+# $Id$
 #
 
 begin
   require 'rubygems'
-  require 'rake/gempackagetask'
+  require 'rubygems/package_task'
 rescue Exception
   nil
 end
 
 require 'rake/clean'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 # This needs to go at the front of the libpath
 # Otherwise, any pre-installed rote gets found,
 # and used from there. This is only necessary
@@ -33,6 +33,23 @@ require 'rote/format/html'
 require 'rote/extratasks'
 include Rote
 
+# workaround a (possible) bug in Rake, or maybe a problem we've introduced...
+module Rake
+  class << self
+    old_rake_check_options = instance_method(:rake_check_options).bind(self)
+    old_rake_output_message = instance_method(:rake_output_message).bind(self)
+    
+    define_method(:rake_check_options) do |*args|
+      old_rake_check_options.call(*args)
+    end
+
+    define_method(:rake_output_message) do |*args|
+      old_rake_output_message.call(*args)
+    end
+  end
+end
+# end workaround 
+
 CLEAN.include('tidy.log')
 CLOBBER.include('TAGS')
 CLOBBER.include('html')
@@ -50,7 +67,7 @@ else
 end
 
 if ENV['REL']
-  PKG_VERSION = ENV['REL']
+  PKG_VERSION = ENV['REL'].dup
 else
   PKG_VERSION = CURRENT_VERSION
 end
@@ -112,22 +129,24 @@ rd = Rake::RDocTask.new(:rdoc) { |rdoc|
   rdoc.rdoc_dir = 'html/rdoc'
 #  rdoc.template = 'kilmer'
 #  rdoc.template = 'css2'
-  rdoc.template = 'doc/jamis.rb'
+#  rdoc.template = 'doc/jamis.rb'
   rdoc.title    = "Rote"
-  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README', 'LICENSE', 'TODO', 'CONTRIBUTORS')
+  rdoc.options << '--line-numbers' << '--main' << 'README.md'
+  rdoc.rdoc_files.include('README.md', 'LICENSE', 'TODO', 'CONTRIBUTORS')
   rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
   rdoc.rdoc_files.exclude(/\bcontrib\b/)
   rdoc.rdoc_files.exclude('lib/rote/project/**/*')
 }
 
 # Code coverage report
-Rote::RCovTask.new { |rcov|
-  rcov.test_files.include 'test/gem*.rb'
-  rcov.source_files.include 'lib/**/*.rb'
-  rcov.profile = true
-  rcov.output_dir = 'html/coverage'
-}
+# TODO removed for now as rcov doesn't like Ruby 1.9
+#Rote::RCovTask.new { |rcov|
+#  rcov.test_files.include 'test/gem*.rb'
+#  rcov.source_files.include 'lib/**/*.rb'
+#  rcov.profile = true
+#  rcov.output_dir = 'html/coverage'
+#  rcov.failonerror = false   # don't stop the build if rcov doesn't work...
+#}
 
 # Create a task build the website / docs
 ws = Rote::DocTask.new(:doc) { |site| 
@@ -143,10 +162,10 @@ ws = Rote::DocTask.new(:doc) { |site|
     # use 'page' layout, textile formatting, ruby syntax, Tidy to xhtml
     page.layout 'page'
 
-    page.page_filter Filters::RedCloth.new(:textile)
+    page.page_filter Filters::RedCloth.new
     page.page_filter Filters::Syntax.new
     
-    page.post_filter Filters::Tidy.new
+    #page.post_filter Filters::Tidy.new
   end
   
   site.res.dir = 'doc/res'
@@ -157,7 +176,7 @@ ws = Rote::DocTask.new(:doc) { |site|
 }
 
 # add rdoc/rcov deps to doc task
-task :doc => [:rdoc, :rcov]
+task :doc => [:rdoc]
 
 desc "Publish the documentation and web site"
 task :doc_upload => [ :doc ] do
@@ -202,6 +221,7 @@ else
     s.name = 'rote'
     s.version = PKG_VERSION
     s.summary = "Adds template-based doc support to Rake."
+    s.license = "MIT"
     s.description = <<-EOF
       Rote is a set of Rake task libraries and utilities that
       enable easy rendering of textual documentation formats
@@ -232,10 +252,8 @@ else
     s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
     s.rdoc_options <<
       '--title' <<  'Rote -- Template-based doc support for Rake' <<
-      '--main' << 'README' <<
+      '--main' << 'README.md' <<
       '--line-numbers' << 
-      '--inline-source' <<
-      '--template' << 'doc/jamis.rb'
       '-o' << 'html'      
 
     s.test_files = Dir.glob('test/gem_*.rb')
@@ -261,7 +279,7 @@ else
     end  
   end
 
-  package_task = Rake::GemPackageTask.new(spec) do |pkg|
+  package_task = Gem::PackageTask.new(spec) do |pkg|
     pkg.need_zip = true
     pkg.need_tar_gz = true
     pkg.package_dir = 'pkg'    
@@ -424,15 +442,17 @@ task :prerelease do
   end
 
   # Are all source files checked in?
-  if ENV['RELTEST']
-    announce "Release Task Testing, skipping checked-in file test"
-  else
-    announce "Checking for unchecked-in files..."
-    data = `svn status`
-    unless data =~ /^$/
-      fail "SVN status is not clean ... do you have unchecked-in files?"
-    end
-    announce "No outstanding checkins found ... OK"
+  announce "Checking for unchecked-in files..."
+  data = `git status`
+  unless data =~ /nothing to commit \(working directory clean\)/m
+    fail "GIT status is not clean ... do you have unchecked-in files?"
+  end
+  announce "No outstanding checkins found ... OK"
+    
+  # Check we're on master
+  branch = /^\*\s+(.*)$/.match(`git branch`)[1]
+  if !branch.eql? 'master'
+    fail "Please merge to master before making a release"
   end
 end
 
@@ -454,34 +474,22 @@ task :update_version => [:prerelease] do
     end
     mv "lib/rote.rb.new", "lib/rote.rb"
     if ENV['RELTEST']
-      announce "Release Task Testing, skipping commiting of new version"
+      announce "Release Task Testing; Would exec: git commit -m \"Updated to version #{PKG_VERSION}\" lib/rote.rb"
     else
-      sh %{svn commit -m "Updated to version #{PKG_VERSION}" lib/rote.rb}
+      sh %{git commit -m "Updated to version #{PKG_VERSION}" lib/rote.rb}
     end
   end
 end
 
-desc "Create a new SVN tag with the latest release number (REL=x.y.z)"
+desc "Create a new Git tag with the latest release number (REL=x.y.z)"
 task :tag => [:prerelease] do
   reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
   reltag << ENV['REUSE'].gsub(/\./, '_') if ENV['REUSE']
-  announce "Tagging CVS with [#{reltag}]"
+  announce "Tagging Git with [#{reltag}]"
   if ENV['RELTEST']
-    announce "Release Task Testing, skipping SVN tagging"
+    announce "Release Task Testing; Would exec: git tag -a #{reltag} -m \"Release #{PKG_VERSION}\""
   else
-    # need to get current base URL
-    s = `svn info`
-    if s =~ /URL:\s*([^\n]*)\n/
-      svnroot = $1
-      if svnroot =~ /^(.*)\/trunk/
-        svnbase = $1
-        sh %{svn cp #{svnroot} #{svnbase}/tags/#{reltag} -m "Release #{PKG_VERSION}"}
-      else
-        fail "Please merge to trunk before making a release"
-      end
-    else 
-      fail "Unable to determine repository URL from 'svn info' - is this a working copy?"
-    end  
+    sh %{git tag -a #{reltag} -m "Release #{PKG_VERSION}"}
   end
 end
 

data/bin/rote

@@ -1,37 +1,40 @@
 #
-# Commandline launcher for Rote, (c)2005 Ross Bamford
+# Commandline launcher for Rote, (c)2005, 2012 Ross Bamford (and contributors)
 #
 # Get set up with library paths, however we're installed.
 
-def croak
+def croak(e)
 	puts "Cannot locate Rote libraries - Do you need to set $ROTE_LIB ?"
+  p e
 	exit(1)
 end
 
-begin 
-	require 'rubygems'
-rescue LoadError
-	# just ignore, don't use gems
-end
-
 fail = false
 rote_lib = nil
 
 begin
-	require 'rote'
-	require 'rote/app'
-		
+	require 'rote.rb'
+	require 'rote/app.rb'
+
 	# find this later
 	rote_lib = nil
-rescue LoadError
-	unless fail || !(rote_lib = ENV['ROTE_LIB'])	
-		$: << rote_lib		
-		# at least we can know this now...
+rescue LoadError => e
+	unless fail 
+    if rote_lib = ENV['ROTE_LIB']
+      $:.unshift rote_lib
+    else
+      begin 
+        require 'rubygems'
+      rescue LoadError
+        # just ignore, we're clutching at straws now...
+      end
+    end
+		# at least we can know this now, or we're failing next iter anyway...
 		builtin = File.join(rote_lib,'rote/builtin.rf')
 		fail = true		# next time.
 		retry
 	else
-		croak
+		croak(e)
 	end 
 end