rote 0.3.0 → 0.3.0.2

data/TODO

@@ -16,3 +16,6 @@ Send any suggestions or patches (preferably as/with tests) to:
   pages) and user guide (one page) generated from same source.
 ** Maybe in concert with plugins?
 * (maybe?) Rant integration
+* Macro that evaluates it's body
+* Macro/method to run external commands and capture the output.
+* Deprecate 'rote' command supporting Rake tasks.

data/lib/rote.rb

@@ -1,6 +1,6 @@
 # rote.rb - main Rote module  
 # Copyright (c) 2005 Ross Bamford (and contributors)
-# $Id: rote.rb,v 1.21 2005/12/12 02:47:47 roscopeco Exp $
+# $Id: rote.rb,v 1.22 2005/12/14 19:19:58 roscopeco Exp $
 #
 # 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.0'
+ROTEVERSION = '0.3.0.2'
 
 #####
 ## *Rote* is a Rake (http://rake.rubyforge.org) based build tool for static

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,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: base.rb,v 1.3 2005/12/14 19:17:21 roscopeco Exp $
 #++
 module Rote
   module Filters
@@ -15,7 +15,8 @@ module Rote
     #   #code# 
     #
     # to :code, args, body
-    MACRO_RE = /^\s*\#\:([a-z]+)(?:\#([a-z]*))?\#\s*^(.*?)$\s*\#\:\1\#(?:\2\#)?\s*$/m
+    MACRO_RE = /^\s*\#\:([a-z]+)(?:\#([a-z]*))?\#\s*?\n?(.*?)\s*\#\:\1\#(?:\2\#)?\s*$/m
+    PLACEHOLDER_RE = /(?:<[^>]*>)?xmxmxmacro(\d+)orcamxmxmx(?:<[^>]*>)?/
     
     #####
     ## Baseclass from which Rote filters can be derived if
@@ -26,7 +27,7 @@ module Rote
     ## are replaced with the corresponding (numbered) original
     ## macro body. 
     class TextFilter
-      attr_accessor :handler_blk, :macro_data
+      attr_accessor :handler_blk, :macros
       
       # Create a new TextFilter. The supplied block will be called
       # with the text to be rendered, with all macros replaced
@@ -35,14 +36,14 @@ module Rote
       #   { |text, page| "replacement" }
       def initialize(&handler)
         @handler_blk = handler
-        @macro_data = []
+        @macros = []
       end
     
       def filter(text, page)
         # we need to remove any macros to stop them being touched
         n = -1        
         tmp = text.gsub(MACRO_RE) do
-          macro_data << $&
+          macros << $&
           # we need make the marker a 'paragraph'
           "\nxmxmxmacro#{n += 1}orcamxmxmx\n"
         end
@@ -51,7 +52,7 @@ module Rote
       
         # Match the placeholder, including any (and greedily all) markup that's
         # been placed before or after it, and put the macro text back.
-        tmp.gsub(/(?:<.*>)?xmxmxmacro(\d+)orcamxmxmx(?:<.*>)?/) { @macro_data[$1.to_i] }      
+        tmp.gsub(PLACEHOLDER_RE) { macros[$1.to_i] }      
       end  
       
       protected
@@ -66,17 +67,31 @@ module Rote
     #####
     ## Baseclass from which Rote filters can be derived if
     ## you want some help with macro replacement.
+    ##
+    ## There are three ways to make a macro filter:
+    ##
+    ## * Subclass this class, and provide +macro_name+ 
+    ##   methods where +name+ is the macro name. These
+    ##   methods receive args (args, body, raw_macro)    
+    ##
+    ## * Create an instance of this class with a block
+    ##   taking up to four arguments
+    ##   (name,args,body,raw_macro)
+    ##
+    ## * Subclass this class and override the +handler+
+    ##   method to process all macros.
+    ##
     class MacroFilter
     
       # An array of macro names supported by this filter.
       # This can be used to selectively disable individual
       # macro support.
-      attr_accessor :macros
+      attr_accessor :names
       
       # Block that will be called for each supported macro
       # in the filtered text. Like:
       #
-      #   { |macro, args, body| "replacement" }
+      #   { |macro, args, body, raw_macro| "replacement" }
       #
       # The presence of a block precludes the use of any
       # +macro_xxxx+ methods on the subclass.      
@@ -88,45 +103,25 @@ module Rote
       # as methods (e.g. +macro_code+). If an array of names isn't
       # passed, a search such methods will be used to populate
       # the names array.
-      def initialize(macros = nil, code_re = MACRO_RE, &handler_blk)
-        @handler_blk = handler_blk
-        @macros = macros || reflect_macro_names
+      def initialize(names = [], code_re = MACRO_RE, &block)
+        @names = (names || []).map { |n| n.to_s }
+        @block = block
         @code_re = code_re
-      end      
-           
-      def filter(text,page)
-        # Just go through, subbing with block if this is
-        # our macro, or with the original match if not.
-        text.gsub(@code_re) do
-          if macros.detect { |it| it.to_s == $1 }
-            # Handler might refuse the macro (bad args, etc)
-            handler($1,$2,$3) || $&
-          else
-            $&
-          end        
-        end
       end
-      
-      protected
-      
-      # Calls the handler block, or attempts to call a method named
-      # 'macro_XXXX' where 'XXXX' is the name of the macro.
-      # Macro methods take two arguments -args and body. 
-      # Name is implied by method that is invoked.
-      def handler(macro,args,body)
-        if handler_blk
-          handler_blk[macro,args,body] 
-        elsif respond_to?(meth = "macro_#{macro}")
-          send(meth, args, body)            # name implied by method
-        end          
+     
+      def filter(text,page)
+        text.gsub(@code_re) { handler($1,$2,$3,$&) || $& }
       end
       
-      private
-      
-      # inits the macro array from defined 'macro_' methods if no array is passed.
-      def reflect_macro_names
-        [methods, private_methods, singleton_methods, protected_methods].inject([]) do |arr,m|
-          arr += m.grep(/macro_([a-z0-9]+)/) { $1 } 
+      # You may override this method if you want to completely
+      # override the standard macro dispatch.      
+      def handler(macro,args,body,all)
+        if @names.include?(macro) then
+          @block[macro,args,body,all]
+        elsif respond_to?(meth = "macro_#{macro}") then
+          self.send(meth,args,body,all)
+        else
+          nil
         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,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: syntax.rb,v 1.3 2005/12/14 19:17:21 roscopeco Exp $
 #++
   
 require 'syntax'
@@ -26,10 +26,10 @@ module Rote
     ##  
     class Syntax < MacroFilter
       def initialize(macro_re = MACRO_RE)
-        super([:code],macro_re)
+        super([],macro_re)
       end      
       
-      def macro_code(lang,body)
+      def macro_code(lang,body,raw)
         converter = ::Syntax::Convertors::HTML.for_syntax(lang)
         "<pre class='#{lang}'><code>#{converter.convert(body,false)}</code></pre>"
       end      

data/lib/rote/page.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: page.rb,v 1.10 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: page.rb,v 1.11 2005/12/14 19:01:05 roscopeco Exp $
 #++
 
 require 'erb'
@@ -60,6 +60,7 @@ module Rote
         resolve_common_rubys(parent,arr) unless parent == dir # at root    
         fn = File.join(dir,'COMMON.rb')    
         arr << fn if (File.exists?(fn) && File.readable?(fn))
+        arr
       end  
     end
     

data/lib/rote/project/Rakefile

@@ -1,16 +1,21 @@
 # Standard Rakefile for custom Rote build
 #
 # Generated from:
-# $Id: Rakefile,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: Rakefile,v 1.3 2005/12/14 19:01:05 roscopeco Exp $
 # 
 begin 
   require 'rubygems'
 rescue LoadError
   nil # optional
 end
+
 require 'rake'
 require 'rake/clean'
 require 'rote'
+require 'rote/filters/redcloth'
+require 'rote/filters/rdoc'
+require 'rote/format/html'
+
 include Rote
 
 # Create a set of tasks with the prefix 'doc' to  build the
@@ -40,18 +45,17 @@ ws = Rote::DocTask.new(:doc) do |site|
   site.res.dir = 'doc/res'
   site.res.include('**/*')
   
-  # TODO need to figure out what default mappings should be
-  site.ext_mapping(/(thtml)/, 'html') do |page|
+  site.ext_mapping(/thtml|textile/, 'html') do |page|
     page.extend Format::HTML
     page.page_filter Filters::RedCloth.new(:textile)
   end    
   
-  site.ext_mapping(/mhtml/, 'html') do |page|
+  site.ext_mapping(/mhtml|markdown/, 'html') do |page|
     page.extend Format::HTML
     page.page_filter Filters::RedCloth.new(:markdown)
   end      
   
-  site.ext_mapping(/rdoc/, 'html') do |page|
+  site.ext_mapping(/rdhtml|rdoc/, 'html') do |page|
     page.extend Format::HTML
     page.page_filter Filters::RDoc.new
   end      

data/lib/rote/project/doc/pages/COMMON.rb

@@ -1,7 +1,9 @@
-# Shared code for all pages in this directory.
-
+# Shared code for all pages below this directory.
+#
 # This is executed for every file transformed, in the binding of 
 # the appropriate Rote::Page instance. Individual page sources
 # ([pagename].rb) override anything defined here.
-
+#
+# Any COMMON.rb files found in directories above this will also
+# be loaded.
 @site_title = "My site"

data/lib/rote/project/doc/pages/index.rb

@@ -2,9 +2,6 @@
 # set layout and formatting, and then create a custom variable
 # for use in the layout.
 
-# This page uses Textile
-format_opts << :textile
-
 # Apply the 'normal' layout
 layout 'normal'
 

data/test/test_formatting.rb

@@ -8,7 +8,6 @@ require 'test/unit'
 require 'rote/page'
 require 'rote/filters/redcloth'
 require 'rote/filters/rdoc'
-require 'rote/filters/proc'
 require 'rote/filters/toc'
 require 'rote/filters/syntax'
 
@@ -87,30 +86,8 @@ module Rote
       end
     end
     
-    ############## filters/proc #################
-    # FIXME Fails under Gem install, but passes when run normally (???)
-    def test_proc_no_block
-      begin
-        Filters::Proc.new
-      rescue ArgumentError => ex
-        assert_equal 'No block given', ex.message
-      end      
-    end
+    ############## filters #################
     
-    def test_render_with_proc
-      f = Filters::Proc.new { |text, page| text + page }
-      assert_equal f.filter('some text ', 'fake page'), 'some text fake page'      
-
-      # equivalent
-      f = Filters::Proc.with do |text, page| 
-        text + page 
-      end      
-      assert_equal f.filter('some text ', 'fake page'), 'some text fake page'      
-    end
-    
-    # Toc filter is a non-output filter - it's used to get a list of links in 
-    # the page, from layout code. It should output it's input directly, so
-    # that it doesn't matter where in the chain it is.
     def test_toc_filter
       # default RE
       toc = Filters::TOC::new
@@ -128,13 +105,16 @@ module Rote
     
     def test_syntax_filter
       # bad
-      assert_equal '', Filters::Syntax.new.filter('', nil)    
-      assert_equal 'Has no source', Filters::Syntax.new.filter('Has no source', nil)    
+      assert_equal '', Filters::Syntax.new.filter('',nil)    
+      assert_equal 'Has no source', Filters::Syntax.new.filter('Has no source',nil)    
       
       # good
-      assert_equal SYNEXPECT.chomp, Filters::Syntax.new.filter(SYNTEST, nil)    
+      assert_equal SYNEXPECT.chomp, Filters::Syntax.new.filter(SYNTEST,nil)    
     end
+    # TODO test macro stuff etc.
+    
   end
   
+  
 end    
   

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rote
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2005-12-12 00:00:00 +00:00
+  version: 0.3.0.2
+date: 2005-12-14 00:00:00 +00:00
 summary: Adds template-based doc support to Rake.
 require_paths: 
 - lib
@@ -60,8 +60,8 @@ files:
 - lib/rote/project/doc/layouts
 - lib/rote/project/doc/res/images
 - lib/rote/project/doc/res/images/rote-tiny.png
-- lib/rote/project/doc/pages/index.html
-- lib/rote/project/doc/layouts/normal.html
+- lib/rote/project/doc/pages/index.thtml
+- lib/rote/project/doc/layouts/normal.thtml
 - test/test_formatting.rb
 - test/test_page.rb
 - test/pages