rote 0.3.6 → 0.4.0

data/doc/pages/index.html

@@ -1,11 +1,4 @@
-*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 build for your pages, with page 
-rendering (optionally supporting RDoc formatting, Textile and Markdown with 
-"RedCloth":http://redcloth.rubyforge.org/ and ruby code with
-"ERB":http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html), layout,
-and general documentation / website build tasks.
+*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 build for your pages, with page rendering (optionally supporting RDoc formatting, Textile and Markdown with "RedCloth":http://redcloth.rubyforge.org/ and ruby code with "ERB":http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html), layout, and general documentation / website build tasks.
 
 h3. Features
 
@@ -15,25 +8,18 @@ Rote offers the following major features:
 	* ERB, Textile, Markdown and RDoc supported out of the box.
 	* Multiple configurable layouts apply boilerplate to your pages.
 	* Apply arbitrary Ruby code across all documentation, a subset, or individual pages.
-	* Can be used standalone (from the command-line) or within "Rake":http://rake.rubyforge.org
-	  as a custom task library.
-	* Supports any (text-based) format, while providing utilities and helpers for
-	  common formats.
-	* Flexible filtering with several standard filters and the ability to
-	  implement your own in a few lines of Ruby.
-	* Low-overhead monitoring functionality allows documentation to be automatically
-	  re-rendered, and custom processing done, whenever the source changes.
-
-Rote is somewhat similar to "WebGen":http://webgen.rubyforge.org in intent, though the two
-are quite different in implementation. WebGen provides a richer environment geared more 
-toward end-user websites and content publishing, whereas Rote's implementation as an 
-extension to Rake reflects a bias toward software documentation and general textual templating.
+	* Can be used standalone (from the command-line) or within "Rake":http://rake.rubyforge.org as a custom task library.
+	* Supports any (text-based) format, while providing utilities and helpers for common formats.
+	* Flexible filtering with several standard filters and the ability to implement your own in a few lines of Ruby.
+	* Low-overhead monitoring functionality allows documentation to be automatically re-rendered, and custom processing done, whenever the source changes.
+
+Rote is somewhat similar to "WebGen":http://webgen.rubyforge.org in intent, though the two are quite different in implementation. WebGen provides a richer environment geared more toward end-user websites and content publishing, whereas Rote's implementation as an extension to Rake reflects a bias toward software documentation and general textual templating.
 
 See the "User guide":<%= link_rel '/guide' %> and "RDoc":<%= link_rel '/rdoc' %> for usage information.
 
 h3. Download?
 
-You can get Rote via "RubyGems":http://rubyforge.org/projects/rubygems if you have it:
+You can get Rote via "RubyGems":http://rubygems.org if you have it:
 
 	* <strong><code>gem install -r rote</code></strong>
 
@@ -41,15 +27,9 @@ Alternatively, you can download tarball / zip packages if you don't:
 
   * <strong>"http://rubyforge.org/frs/?group_id=1120":http://rubyforge.org/frs/?group_id=1120</strong>
 
-You can also grab the latest code from "SVN":http://rubyforge.org/plugins/scmsvn/viewcvs.php/?root=rote
 
-h4. From Subversion
+h4. From Git
 
-A link to the latest stable release can be found from the "project page":http://rubyforge.org/projects/rote .
+You can also grab the latest code from "our GitHub page":http://github.com/roscopeco/rote .
 
-You can also grab the latest code from Subversion . The trunk always has the most up to date development code 
-while the latest release, while can be found on the appropriate tag for that version. Although every effort 
-is made to ensure that this development code works, it cannot of course be guaranteed to be complete or bug 
-free. If that's okay with you (maybe you're pretty happy-go-lucky in general...) then see our 
-"SCM page":http://rubyforge.org/scm/?group_id=1120 at Rubyforge for everything you need to get going with 
-the SVN version.
+The master branch has the most up to date working development code while the latest release can be found on the appropriate tag for that version. Although every effort is made to ensure that this development code works, it cannot of course be guaranteed to be complete or bug free. If that's okay with you (maybe you're pretty happy-go-lucky in general...) then see our "GitHub page":http://github.com/roscopeco/rote for everything you need to get going with the Git version.

data/doc/pages/license.html

@@ -3,7 +3,7 @@
 <ul>
 <pre>
 <code>
-Copyright (c) 2005 Ross Bamford (and contributors)
+Copyright (c) 2005-2013 Ross Bamford (and contributors)
 
 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/lib/rote.rb

@@ -1,6 +1,6 @@
 # rote.rb - main Rote module  
-# Copyright (c) 2005, 2006 Ross Bamford (and contributors)
-# $Id: rote.rb 192 2009-11-04 12:53:03Z roscopeco $
+# Copyright (c) 2005-2012 Ross Bamford (and contributors)
+# $Id$
 #
 # 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 
@@ -41,7 +41,7 @@ end
 require 'rake'
 
 # Master Rote version. Manage this from the Rake release support.
-ROTEVERSION = '0.3.6'
+ROTEVERSION = '0.4.0'
 
 #####
 ## *Rote* is a Rake (http://rake.rubyforge.org) based build tool for static

data/lib/rote/app.rb

@@ -1,8 +1,8 @@
 # Rote application class
-# (c)2005 Ross Bamford (and contributors)
+# (c)2005, 2012 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: app.rb 128 2005-12-12 02:45:24Z roscopeco $
+# $Id$
 require 'getoptlong'
 
 module Rote
@@ -35,7 +35,7 @@ module Rote
       raise "Missing builtin.rf (expected at '#{@rakefile}')!" unless File.exists?(@rakefile)
       
       @rakeopts = ENV['RAKE_OPTS'] || ''
-      @rake = ENV['RAKE_CMD'] || (PLATFORM =~ /mswin/ ? 'rake.cmd' : 'rake')
+      @rake = ENV['RAKE_CMD'] || (RUBY_PLATFORM =~ /mswin/ ? 'rake.cmd' : 'rake')
       
       process_args
       
@@ -90,7 +90,7 @@ module Rote
 Usage: rote [options] [task1] .. [taskN]
 
 Where [taskN] is a valid task or target name for the current project. 
-Rite generates targets for each page source, and also defines a number
+Rote generates targets for each page source, and also defines a number
 of top-level tasks for various things. Use the '--tasks' option to get
 a list of valid tasks.
 

data/lib/rote/cache.rb

@@ -1,10 +1,10 @@
 # Dependency caching / memoize to disk for Rake / Rote
 # Contributed by Jonathan Paisley (very slightly modified)
 #--
-# (c)2005, 2006 Ross Bamford (and contributors)
+# (c)2005, 2006, 2012 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: cache.rb 190 2009-11-04 12:52:05Z roscopeco $
+# $Id$
 #++
 # This file adds dynamic dependency tracking and caching for 
 # incremental builds, by adding methods to the Rake module 
@@ -17,14 +17,15 @@
 #
 # Eventually this registration may become implicit with layout.
 
-require 'md5'
+require 'digest/md5'
 require 'yaml'
 require 'pathname'
 require 'rake'
 
-module Rake
-  
+module Rake 
   class << self
+    include Rake::DSL
+    
     # Directory for storing Rake dependency cache
     def cache_dir=(val); @cache_dir = val; end
     def cache_dir; @cache_dir ||= ".rake_cache"; end
@@ -54,7 +55,7 @@ module Rake
       task = (current_task.name if current_task) unless task
       if task then
         file task => deps
-        (cached_dependencies[task] ||= []) << deps
+         (cached_dependencies[task] ||= []) << deps
       end
     end
   end
@@ -74,11 +75,11 @@ module Rake
     
     # Execute the task, loading cached dependencies if not already
     # loaded, and handling the task stack.
-    define_method(:execute) do      
+    define_method(:execute) do |*args|     
       begin
         Rake.task_stack << self        
         Rake.cached_dependencies[name] = [] if Rake.cached_dependencies[name]         
-        old_execute.bind(self).call({ })
+        old_execute.bind(self).call(*args)
       ensure
         Rake.task_stack.pop
       end

data/lib/rote/extratasks.rb

@@ -1,6 +1,6 @@
 #--
 # Extra bonus Rake tasklibs for Rote and elsewhere
-# (c)2005, 2006 Ross Bamford (and contributors)
+# (c)2005, 2006, 2012 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
 # $Id$
@@ -49,13 +49,16 @@ module Rote
     # The color scale range for profiling output (dB) [not used]
     attr_accessor :range
     
+    # If +false+, the task will emit a warning rather than failing when Rcov command fails. [true]
+    attr_accessor :failonerror
+    
     # Create a new RCovTask, using the supplied block for configuration,
     # and define tasks with the specified base-name within Rake.
     #
     # Note that the named task just invokes a file task for the output
     # directory, which is dependent on test (and source, if specified)
     # file changes.
-    def initialize(name = :rcov) # :yield: self if block_given?      
+    def initialize(name = :rcov, failonerror = true) # :yield: self if block_given?      
       @taskname = name
       @rcov_cmd = 'rcov'
       @test_files = Rake::FileList.new
@@ -63,6 +66,7 @@ module Rote
       @load_paths = []
       @excludes = []      
       @output_dir = './coverage'
+      @failonerror = true
       
       yield self if block_given?
 
@@ -93,7 +97,11 @@ module Rote
 
           puts cmd
           unless system(cmd)
-            fail "RCov command '#{rcov_cmd}' failed (status #{$?.exitstatus})" 
+            if failonerror
+              fail "RCov command '#{rcov_cmd}' failed (status #{$?.exitstatus})" 
+            else 
+              warn "RCov command '#{rcov_cmd}' failed (status #{$?.exitstatus})" 
+            end
           end
         end
         

data/lib/rote/filters.rb

@@ -3,7 +3,7 @@
 # (c)2005, 2006 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: filters.rb 163 2006-01-05 21:15:54Z roscopeco $
+# $Id$
 #++
 
 # Everyone requires this, we need to get it loaded first.

data/lib/rote/filters/base.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: base.rb 144 2005-12-14 19:17:21Z roscopeco $
+# $Id$
 #++
 module Rote
   module Filters

data/lib/rote/filters/bluecloth.rb

@@ -3,7 +3,7 @@
 # (c)2006 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: bluecloth.rb 160 2006-01-05 21:05:44Z roscopeco $
+# $Id$
 #++
 
 require 'bluecloth'

data/lib/rote/filters/rdoc.rb

@@ -3,12 +3,12 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: rdoc.rb 177 2006-02-26 19:59:11Z roscopeco $
+# $Id$
 #++
 
 require 'rote/filters/base'
-require 'rdoc/markup/simple_markup'
-require 'rdoc/markup/simple_markup/to_html'
+require 'rdoc/markup'
+require 'rdoc/markup/to_html'
 
 module Rote
   module Filters
@@ -16,10 +16,9 @@ module Rote
     #####
     ## Page filter supporting RDoc markup.     
     class RDoc < TextFilter
-      def initialize(markup = SM::SimpleMarkup.new, output = SM::ToHtml.new)
+      def initialize(markup = ::RDoc::Markup::ToHtml.new)
         @markup = markup
-        @output = output
-        self.handler_blk = proc { |text,page| @markup.convert(text, @output) }
+        self.handler_blk = proc { |text,page| @markup.convert(text) }
       end      
     end
   end

data/lib/rote/filters/redcloth.rb

@@ -3,7 +3,7 @@
 # (c)2005, 2006 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: redcloth.rb 191 2009-11-04 12:52:38Z roscopeco $
+# $Id$
 #++
 
 require 'redcloth'
@@ -31,10 +31,8 @@ module Rote
       end      
       
       def handler(text,page)
-        rc = ::RedCloth.new(text)        
-        # hack around a RedCloth warning
-        rc.instance_eval { @lite_mode = false }  
-        rc.to_html(*@redcloth_opts) 
+        rc = ::RedCloth.new(text, @redcloth_opts)
+        rc.to_html 
       end      
     end    
     

data/lib/rote/filters/syntax.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: syntax.rb 170 2006-01-11 23:38:51Z roscopeco $
+# $Id$
 #++
   
 require 'syntax'

data/lib/rote/filters/tidy.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: tidy.rb 128 2005-12-12 02:45:24Z roscopeco $
+# $Id$
 #++
 
 module Rote
@@ -25,7 +25,7 @@ module Rote
       # Create a new filter instance, using the specified output format,
       # and optionally a custom 'tidy' command and options.    
       def initialize(format = :xhtml, tidycmd = nil, tidyopts = '-q') 
-        @tidycmd = tidycmd || ENV['TIDYCMD'] || (PLATFORM =~ /mswin/ ? 'tidy.exe' : 'tidy')
+        @tidycmd = tidycmd || ENV['TIDYCMD'] || (RUBY_PLATFORM =~ /mswin/ ? 'tidy.exe' : 'tidy')
           # TODO windows 'tidy.exe' correct?
           
         @tidyopts = tidyopts

data/lib/rote/filters/toc.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: toc.rb 170 2006-01-11 23:38:51Z roscopeco $
+# $Id$
 #++
 
 module Rote

data/lib/rote/format.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: format.rb 128 2005-12-12 02:45:24Z roscopeco $
+# $Id$
 #++
 
 Dir[File.join(File.dirname(__FILE__), 'format/*.rb')].each { |f| require f }

data/lib/rote/format/html.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: html.rb 128 2005-12-12 02:45:24Z roscopeco $
+# $Id$
 #++
 require 'erb'
 

data/lib/rote/page.rb

@@ -1,9 +1,9 @@
 #--
 # Rote page class
-# (c)2005, 2006 Ross Bamford (and contributors)
+# (c)2005, 2006, 2012 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: page.rb 170 2006-01-11 23:38:51Z roscopeco $
+# $Id$
 #++
 
 require 'erb'
@@ -150,7 +150,7 @@ module Rote
     #
     # *Deprecated* This has no knowledge of nested layout,
     # and operates only on the innermost layout.
-    attr_reader :layout_text    # Deprecated vv0.3.2 v-0.4    
+    attr_reader :layout_text    # layout_text is deprecated (doesn't work with nested layout) vv0.3.2 v-0.4    
     
     # The basename from which this page's template was read, 
     # relative to the +base_path+.
@@ -389,7 +389,7 @@ module Rote
       @layout_names.each do |fn|
         txt = load_layout(fn)
         
-        @layout_text ||= txt    # legacy support    vv0.3.2 v-0.4
+        @layout_text ||= txt    # layout_text legacy support    vv0.3.2 v-0.4
         
         # render into the layout if supplied.
         if txt

data/lib/rote/project/Rakefile

@@ -1,7 +1,7 @@
 # Standard Rakefile for custom Rote build
 #
 # Generated from:
-# $Id: Rakefile 160 2006-01-05 21:05:44Z roscopeco $
+# $Id$
 # 
 begin 
   require 'rubygems'

data/lib/rote/rotetasks.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: rotetasks.rb 190 2009-11-04 12:52:05Z roscopeco $
+# $Id$
 #++
 require 'rake'
 require 'rake/tasklib'
@@ -230,7 +230,7 @@ module Rote
       tasks = res_fl.select { |fn| not File.directory?(fn) }.map do |fn|
         tfn, = target_fn(/^#{res.dir}/, fn)
         
-        desc "#{fn} => #{tfn}" #if show_file_tasks?
+        desc "#{fn} => #{tfn}" if show_file_tasks?
         file tfn => [fn] do
           dn = File.dirname(tfn)
           mkdir_p dn unless File.exists?(dn)
@@ -250,7 +250,7 @@ module Rote
       gen_files = pages_fl.select { |fn| not File.directory?(fn) }.map do |fn|
         tfn, blk = target_fn(/^#{pages.dir}/, fn) 
                  
-        desc "#{fn} => #{tfn}" #if show_file_tasks?
+        desc "#{fn} => #{tfn}" if show_file_tasks?
         file tfn => [fn] do
           dn = File.dirname(tfn)
           mkdir_p dn unless File.exists?(dn)

data/test/test_cache.rb

@@ -8,12 +8,15 @@ $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
 
 require 'rake'
 require 'rote/cache'
+require 'test/unit'
 
 Rake.cache_enabled = false
 
 module Rote  
   class TestCache < Test::Unit::TestCase
 
+    include Rake::DSL
+
     def test_rake_cache_dir
       assert_equal '.rake_cache', Rake.cache_dir
       Rake.cache_dir = './.cache'

data/test/test_filters.rb

@@ -109,7 +109,7 @@ module Rote
       t = Filters::RedCloth.new.filter('*Textile* _Test_', nil)
       assert_equal '<p><strong>Textile</strong> <em>Test</em></p>', t
 
-      t = Filters::RedCloth.new(:textile).filter('*Textile* _Test_', nil)
+      t = Filters::RedCloth.new.filter('*Textile* _Test_', nil)
       assert_equal '<p><strong>Textile</strong> <em>Test</em></p>', t
     end
 
@@ -135,7 +135,7 @@ module Rote
     unless defined?(TEST_FROM_GEM)
       def test_render_rdoc
         t = Filters::RDoc.new.filter("== RDoc\n=== Markup",nil)
-        assert_equal "<h2>RDoc</h2>\n<h3>Markup</h3>\n", t
+        assert_equal "\n<h2>RDoc</h2>\n\n<h3>Markup</h3>\n", t
       end
     end