rote 0.3.2.2 → 0.3.4

data/CONTRIBUTORS

@@ -14,3 +14,5 @@ suck like a hoover.
 * The whole dependency caching / file-based block memoize thing!
 * _Many_ other suggestions for improvements
 
+===== Suraj Kurapati
+* RedCloth_WithToc filter.

data/README

@@ -132,10 +132,5 @@ probably be totally useless to anyone but me. Keeping a list like this
 accurate and up to date is a recipe for disaster, so I'll take the safe 
 option and say 'thanks, everyone' :)
 
-Thanks also to Yukihiro Matsumoto for a remarkable platform, Masatoshi Seki for 
-embedding it in text, Jim Weirich for an elegant build tool, and Dean Allen 
-for making markup easy in Ruby. Thanks to the authors of all the libraries and
-tools used by Rote, and thanks too to the many people who've contributed
-and improved these things over the years - as ever, we stand on the shoulders
-of giants.
-
+Thanks also to Yukihiro Matsumoto for a remarkable platform, and all those
+who write and contribute to the libraries Rote depends on.

data/Rakefile

@@ -6,7 +6,7 @@
 # This Rakefile is heavily based on Rake's own Rakefile.
 # Portions copyright (c)2003, 2004 Jim Weirich (jim <AT> weirichhouse.org)
 #
-# $Id: Rakefile 171 2006-01-12 00:16:17 +0000 (Thu, 12 Jan 2006) roscopeco $
+# $Id: Rakefile 185 2006-10-26 19:41:31Z roscopeco $
 #
 
 begin
@@ -19,7 +19,6 @@ end
 require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
-
 # 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
@@ -31,6 +30,7 @@ require 'rote/filters/redcloth'
 require 'rote/filters/syntax'
 require 'rote/filters/tidy'
 require 'rote/format/html'
+require 'rote/extratasks'
 include Rote
 
 CLEAN.include('tidy.log')
@@ -108,7 +108,7 @@ end
 # Website / Doc tasks ------------------------------------------------
 
 # Create a task to build the RDOC documentation tree.
-rd = Rake::RDocTask.new("rdoc") { |rdoc|
+rd = Rake::RDocTask.new(:rdoc) { |rdoc|
   rdoc.rdoc_dir = 'html/rdoc'
 #  rdoc.template = 'kilmer'
 #  rdoc.template = 'css2'
@@ -121,6 +121,14 @@ rd = Rake::RDocTask.new("rdoc") { |rdoc|
   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'
+}
+
 # Create a task build the website / docs
 ws = Rote::DocTask.new(:doc) { |site| 
   site.output_dir = 'html'
@@ -148,8 +156,8 @@ ws = Rote::DocTask.new(:doc) { |site|
   site.res.include('**/*.css')
 }
 
-# add rdoc dep to doc task
-task :doc => [:rdoc]
+# add rdoc/rcov deps to doc task
+task :doc => [:rdoc, :rcov]
 
 desc "Publish the documentation and web site"
 task :doc_upload => [ :doc ] do
@@ -161,7 +169,7 @@ task :doc_upload => [ :doc ] do
       "html"
     ).upload
   else
-    raise "Skipping documentation upload - Need to set RUBYFORGE_ACCT to your rubyforge.org user name"
+    $stderr << "Skipping documentation upload - Need to set RUBYFORGE_ACCT to your rubyforge.org user name"
   end
 end
 

data/TODO

@@ -8,7 +8,10 @@ Send any suggestions or patches (preferably as/with tests) to:
 == For 0.3.x
 * Plugins, maybe allow pseudo-sections to be created 
   in COMMON.rb, that get their pages from some supplied code.	
-  Anything else then stays out of Rote, which is what's needed.	
+  Anything else then stays out of Rote, which is what's needed.
+
+* Add ability to use external sources in syntax plugin, e.g.
+  with a 'source' arg to macro.	
 
 == For 0.3.x or 0.4
 * Ability to have multiple views of a section, e.g. user guide (separate

data/doc/pages/guide/index.html

@@ -599,6 +599,22 @@ doc.ext_mapping(/(html)/, '$1') do |page|
 end
 #:code#
 
+Extension mappings also support per-extension output directories, which
+can be supplied as a third parameter to the @ext_mapping@ method:
+
+doc.output_dir = 'html'
+
+#:code#ruby#
+doc.ext_mapping(/ttxt/, 'txt', 'plaintext') do |page|
+
+  # do stuff
+  
+end
+#:code#
+
+Where no output directory is supplied, the default output directory will
+be used.
+
 <%= section 4, 'Defining additional tasks' %>
 
 The command-line build will automatically look for a file in the top-level

data/doc/pages/index.html

@@ -50,6 +50,6 @@ A link to the latest stable release can be found from the "project page":http://
 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 
+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.

data/lib/rote.rb

@@ -1,6 +1,6 @@
 # rote.rb - main Rote module  
-# Copyright (c) 2005 Ross Bamford (and contributors)
-# $Id: rote.rb 172 2006-01-12 00:21:40 +0000 (Thu, 12 Jan 2006) roscopeco $
+# Copyright (c) 2005, 2006 Ross Bamford (and contributors)
+# $Id: rote.rb 186 2006-10-26 19:44:00Z roscopeco $
 #
 # 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.2.2'
+ROTEVERSION = '0.3.4'
 
 #####
 ## *Rote* is a Rake (http://rake.rubyforge.org) based build tool for static

data/lib/rote/app.rb

@@ -2,7 +2,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: app.rb 121 2005-12-11 06:18:12 +0000 (Sun, 11 Dec 2005) roscopeco $
+# $Id: app.rb 128 2005-12-12 02:45:24Z roscopeco $
 require 'getoptlong'
 
 module Rote

data/lib/rote/cache.rb

@@ -4,7 +4,7 @@
 # (c)2005, 2006 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: cache.rb 170 2006-01-11 23:38:51 +0000 (Wed, 11 Jan 2006) roscopeco $
+# $Id: cache.rb 179 2006-02-28 18:33:54Z roscopeco $
 #++
 # This file adds dynamic dependency tracking and caching for 
 # incremental builds, by adding methods to the Rake module 
@@ -58,23 +58,27 @@ module Rake
       end
     end
   end
+
+  # Patch load_imports so cached dependencies will be loaded
+  # after the main rakefile but before the tasks are executed
+  class Application
+    old_load_imports = instance_method(:load_imports)
+    define_method(:load_imports) do
+      Rake.load_cached_dependencies
+      old_load_imports.bind(self).call
+    end
+  end
   
   class Task
-    alias :pre_autodep_invoke :invoke
+    old_execute = instance_method(:execute)    
     
-    # Invoke the task, loading cached dependencies if not already
-    # loaded, and handling the task stack. The argument controls
-    # whether or not cached dependencies are loaded and should not
-    # be set false except in testing.
-    def invoke
-      # Invoke patched to record task stack and
-      # load cached dependencies on first go.
-      Rake.load_cached_dependencies if Rake.cache_enabled?
-      
+    # Execute the task, loading cached dependencies if not already
+    # loaded, and handling the task stack.
+    define_method(:execute) do      
       begin
         Rake.task_stack << self        
         Rake.cached_dependencies[name] = [] if Rake.cached_dependencies[name]         
-        pre_autodep_invoke
+        old_execute.bind(self).call
       ensure
         Rake.task_stack.pop
       end
@@ -120,7 +124,7 @@ module Rake
   # An at_exit handler is installed to save the dependencies
   # when rake exits.
   def self.load_cached_dependencies
-    return if $CACHEDEPS_LOADED
+    return unless !$CACHEDEPS_LOADED and Rake.cache_enabled?    
     
     at_exit { self.save_cached_dependencies }
 

data/lib/rote/extratasks.rb

@@ -0,0 +1,105 @@
+#--
+# Extra bonus Rake tasklibs for Rote and elsewhere
+# (c)2005, 2006 Ross Bamford (and contributors)
+#
+# See 'rote.rb' or LICENSE for licence information.
+# $Id$
+#++
+require 'rake'
+
+module Rote
+  #####
+  ## Rake task library that allows code-coverage reports to be 
+  ## generated using RCov (http://eigenclass.org/hiki.rb?rcov).
+  class RCovTask < Rake::TaskLib
+    # The base name for the generated task [:rcov]
+    attr_reader :taskname
+    
+    # The command that runs RCov ['rcov']
+    attr_accessor :rcov_cmd
+    
+    # A +Rake::FileList+ holding unit-test filenames and globs.
+    # RCov will execute these to generate the report.
+    attr_accessor :test_files
+    
+    # A +Rake::FileList+ holding Ruby source filenames that are
+    # included in the coverage report. This is *optional* - RCov
+    # finds sources by running them. However, if you do specify
+    # your files here then the coverage report will only be 
+    # generated when they change.
+    attr_accessor :source_files
+    
+    # The path to which RCov should generate output [./coverage]
+    attr_accessor :output_dir
+    
+    # Extra load-paths that should be appended to $: when running
+    # the test cases. [none]
+    attr_accessor :load_paths
+    
+    # If true, RCov will generate colorblind-safe output. [false]
+    attr_accessor :no_color
+    
+    # Set of glob patterns that should be excluded from the test
+    # run. [none]
+    attr_accessor :excludes
+    
+    # Determines whether bogo-profiling is enabled [false]
+    attr_accessor :profile
+    
+    # The color scale range for profiling output (dB) [not used]
+    attr_accessor :range
+    
+    # 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?      
+      @taskname = name
+      @rcov_cmd = 'rcov'
+      @test_files = Rake::FileList.new
+      @source_files = Rake::FileList.new
+      @load_paths = []
+      @excludes = []      
+      @output_dir = './coverage'
+      
+      yield self if block_given?
+
+      define(name)
+    end
+
+    private 
+    
+    def define(name)
+      unless @test_files.empty?
+        if defined? CLOBBER
+          CLOBBER.include @output_dir 
+        elsif defined? CLEAN
+          CLEAN.include @output_dir
+        end
+        
+        (@test_files + @source_files).each { |fn| file fn }        
+        
+        file @output_dir => (@test_files + @source_files) do
+          cmd = "#{rcov_cmd}" <<
+                "#{" -o #{@output_dir}" if @output_dir}" <<
+                "#{" -I #{@load_paths.join(':')}" unless @load_paths.empty?}" << 
+                "#{" -n" if @no_color}" << 
+                "#{" -x #{@excludes.join(':')}" unless @excludes.empty?}" << 
+                "#{" -p" if @profile}" << 
+                "#{" -r #{@range}" if @range}" <<
+                " " << @test_files.join(' ')
+
+          puts cmd
+          unless system(cmd)
+            fail "RCov command '#{rcov_cmd}' failed (status #{$?.exitstatus})" 
+          end
+        end
+        
+        task name => @output_dir
+      end
+    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 156 2006-01-05 01:13:43 +0000 (Thu, 05 Jan 2006) roscopeco $
+# $Id: filters.rb 163 2006-01-05 21:15:54Z roscopeco $
 #++
 
 # 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 135 2005-12-12 15:01:07 +0000 (Mon, 12 Dec 2005) roscopeco $
+# $Id: base.rb 144 2005-12-14 19:17:21Z roscopeco $
 #++
 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 155 2006-01-05 00:50:32 +0000 (Thu, 05 Jan 2006) roscopeco $
+# $Id: bluecloth.rb 160 2006-01-05 21:05:44Z roscopeco $
 #++
 
 require 'bluecloth'

data/lib/rote/filters/rdoc.rb

@@ -3,9 +3,10 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: rdoc.rb 119 2005-12-11 02:18:37 +0000 (Sun, 11 Dec 2005) roscopeco $
+# $Id: rdoc.rb 177 2006-02-26 19:59:11Z roscopeco $
 #++
 
+require 'rote/filters/base'
 require 'rdoc/markup/simple_markup'
 require 'rdoc/markup/simple_markup/to_html'
 

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 155 2006-01-05 00:50:32 +0000 (Thu, 05 Jan 2006) roscopeco $
+# $Id: redcloth.rb 180 2006-10-26 19:38:30Z roscopeco $
 #++
 
 require 'redcloth'
@@ -37,6 +37,46 @@ module Rote
         rc.to_html(*@redcloth_opts) 
       end      
     end    
+    
+    # Redcloth filter that adds a table of contents at the top of the given text 
+    # and sufficent hyperlinks to access the various headings in the text. This
+    # can be used instead of the standard TOC filter to get TOC capabilities 
+    # during page (rather than layout) rendering.
+    # 
+    # Contributed by Suraj Kurapati.
+    class RedCloth_WithToc < RedCloth
+      Heading = Struct.new(:depth, :anchor, :title) unless const_defined?(:Heading)
+ 
+      def handler text, *args
+        # determine structure of content and insert anchors where necessary
+          headings = []
+ 
+          text = text.gsub /^(\s*h(\d))(.*?)(\.(.*))$/ do
+          target = $~.dup
+ 
+           if target[3] =~ /#([^#]+)\)/
+             anchor = $1
+             result = target.to_s
+           else
+             anchor = headings.length
+             result = "#{target[1]}#{target[3]}(##{anchor})#{target[4]}"
+           end
+ 
+           headings << Heading.new( target[2].to_i, anchor, target[5] )
+           result
+         end
+ 
+         # add table of contents at top of text
+         toc = headings.map do |h|
+           %{#{'*' * h.depth} "#{h.title}":##{h.anchor}}
+         end.join("\n")
+ 
+         text.insert 0, "\n\n\n"
+         text.insert 0, toc
+ 
+         super text, *args
+       end
+     end    
   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:51 +0000 (Wed, 11 Jan 2006) roscopeco $
+# $Id: syntax.rb 170 2006-01-11 23:38:51Z roscopeco $
 #++
   
 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 125 2005-12-12 02:27:41 +0000 (Mon, 12 Dec 2005) roscopeco $
+# $Id: tidy.rb 128 2005-12-12 02:45:24Z roscopeco $
 #++
 
 module Rote

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:51 +0000 (Wed, 11 Jan 2006) roscopeco $
+# $Id: toc.rb 170 2006-01-11 23:38:51Z roscopeco $
 #++
 
 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 120 2005-12-11 06:05:48 +0000 (Sun, 11 Dec 2005) roscopeco $
+# $Id: format.rb 128 2005-12-12 02:45:24Z roscopeco $
 #++
 
 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 113 2005-12-09 01:28:21 +0000 (Fri, 09 Dec 2005) roscopeco $
+# $Id: html.rb 128 2005-12-12 02:45:24Z roscopeco $
 #++
 require 'erb'
 

data/lib/rote/page.rb

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

data/lib/rote/project/Rakefile

@@ -1,7 +1,7 @@
 # Standard Rakefile for custom Rote build
 #
 # Generated from:
-# $Id: Rakefile 150 2006-01-02 00:39:41 +0000 (Mon, 02 Jan 2006) roscopeco $
+# $Id: Rakefile 160 2006-01-05 21:05:44Z roscopeco $
 # 
 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 170 2006-01-11 23:38:51 +0000 (Wed, 11 Jan 2006) roscopeco $
+# $Id: rotetasks.rb 182 2006-10-26 19:40:08Z roscopeco $
 #++
 require 'rake'
 require 'rake/tasklib'
@@ -127,7 +127,10 @@ module Rote
     attr_reader :name
     
     # Base directories used by the task.
-    attr_accessor :output_dir, :layout_dir
+    attr_accessor :default_output_dir, :layout_dir
+    
+    alias :output_dir :default_output_dir 
+    alias :output_dir= :default_output_dir=
     
     # Globs for the +FileList+ that supplies the pages to transform. You 
     # should configure the +pages_dir+ and +include+ at least one entry
@@ -149,8 +152,8 @@ module Rote
     # file extensions. Keys are regexps that are matched in order 
     # against the search key.
     #
-    # The values are [extension, ({ |page| ...})] . If a mapping has a 
-    # block, it is executed when pages with a matching extension are,
+    # The values are [extension, ({ |page| ...}), out_dir] . If a mapping 
+    # has a block, it is executed when pages with a matching extension are,
     # instantiated (before common and page code). It can be used to apply
     # filters, for example, on a per-extension basis. 
     attr_reader :ext_mappings
@@ -158,8 +161,12 @@ module Rote
     # Define an extension mapping for the specified regex, which will 
     # be replaced with the specified extension. If a block is supplied
     # it will be called with each matching +Page+ as it's created.
-    def ext_mapping(match, extension, &block)
-      @ext_mappings[match] = [extension,block]      
+    # 
+    # Extension mappings also allow the output directory to be specified
+    # on a per-extension basis. If no output directory is specified, the
+    # default output directory is used.
+    def ext_mapping(match, extension, output_dir = self.default_output_dir, &block)
+      @ext_mappings[match] = [extension,block,output_dir]      
     end
     
     # If +show_page_tasks+ is +true+, then the file tasks created for each
@@ -211,10 +218,9 @@ module Rote
     #
     # Returns [target_fn, ({ |page| ...})]
     def target_fn(dir_rx, fn)
+      ext = File.extname(fn).sub(/^\./,'') # strip leading dot                  
+      new_ext, blk, output_dir = ext_mappings[ext] || [ext,nil,self.default_output_dir]               
       tfn = fn.sub(dir_rx, output_dir)      
-      ext = File.extname(tfn)
-      ext.sub!(/^\./,'') # strip leading dot                  
-      new_ext, blk = ext_mappings[ext] || [ext,nil]               
       [tfn.sub(/#{ext}$/,new_ext),blk]
     end
     

data/test/test_filters.rb

@@ -9,13 +9,7 @@ $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
 
 require 'test/unit'
 require 'rote/page'
-require 'rote/filters/redcloth'
-require 'rote/filters/bluecloth'
-require 'rote/filters/rdoc'
-require 'rote/filters/toc'
-require 'rote/filters/syntax'
-require 'rote/filters/exec'
-require 'rote/filters/eval'
+require 'rote/filters'
 
 SYNTEST = <<-EOM  
   <p>Non-code</p>

data/test/test_page.rb

@@ -200,7 +200,7 @@ module Rote
       assert_equal 'layout some text and some other text for a change.', t
     end    
     
-    def test_render_layout_code  
+    def test_render_layout_nested  
       t = new_test_page('nestedlayout').render.chomp
       assert_equal "layout with nested: 'some text and some other text' for a change.", t
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: rote
 version: !ruby/object:Gem::Version 
-  version: 0.3.2.2
-date: 2006-01-12 00:00:00 +00:00
+  version: 0.3.4
+date: 2006-10-26 00:00:00 +01:00
 summary: Adds template-based doc support to Rake.
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Ross Bamford
 files: 
@@ -37,6 +38,7 @@ files:
 - CONTRIBUTORS
 - bin/rote
 - lib/rote.rb
+- lib/rote/extratasks.rb
 - lib/rote/rotetasks.rb
 - lib/rote/page.rb
 - lib/rote/cache.rb