rote 0.3.0.2 → 0.3.2

data/lib/rote/filters/rdoc.rb

@@ -3,7 +3,7 @@
 # (c)2005 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: rdoc.rb,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: rdoc.rb 128 2005-12-12 02:45:24 +0000 (Mon, 12 Dec 2005) roscopeco $
 #++
 
 require 'rdoc/markup/simple_markup'

data/lib/rote/filters/redcloth.rb

@@ -1,9 +1,9 @@
 #--
 # Rote filter for RedCloth
-# (c)2005 Ross Bamford (and contributors)
+# (c)2005, 2006 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: redcloth.rb,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: redcloth.rb 128 2005-12-12 02:45:24 +0000 (Mon, 12 Dec 2005) roscopeco $
 #++
 
 require 'redcloth'
@@ -12,20 +12,22 @@ require 'rote/filters/base'
 module Rote
   module Filters
     #####
-    ## Page filter that converts plain-text formatting to HTML using 
-    ## RedCloth. This allows both Textile and Markdown formatting
-    ## to be used with any page.
+    ## Page filter that converts Textile formatting to HTML using 
+    ## RedCloth. 
+    ##
+    ## *Note* that, although RedCloth provides partial Markdown
+    ## support, it is *highly recommended* that the BlueCloth
+    ## filter be applied to markdown pages instead of this one.
     class RedCloth < TextFilter
     
       # Create a new filter instance. The supplied options are passed
-      # directly to RedCloth. The most common are :textile and
-      # :markdown - See RedCloth docs for a full list.
+      # directly to RedCloth. See RedCloth docs for a full list.
       #
-      # If no options are supplied, :textile is assumed.
+      # If no options are supplied, full textile support is 
+      # provided.
       def initialize(*redcloth_opts)
         super()  
         @redcloth_opts = redcloth_opts
-        raise "RedCloth is not available" unless defined?(RedCloth)        
       end      
       
       def handler(text,page)

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.3 2005/12/14 19:17:21 roscopeco Exp $
+# $Id: syntax.rb 144 2005-12-14 19:17:21 +0000 (Wed, 14 Dec 2005) 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,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: tidy.rb 128 2005-12-12 02:45:24 +0000 (Mon, 12 Dec 2005) 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,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: toc.rb 128 2005-12-12 02:45:24 +0000 (Mon, 12 Dec 2005) 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,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: format.rb 128 2005-12-12 02:45:24 +0000 (Mon, 12 Dec 2005) 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,v 1.2 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: html.rb 128 2005-12-12 02:45:24 +0000 (Mon, 12 Dec 2005) roscopeco $
 #++
 require 'erb'
 

data/lib/rote/page.rb

@@ -1,15 +1,13 @@
 #--
 # Rote page class
-# (c)2005 Ross Bamford (and contributors)
+# (c)2005, 2006 Ross Bamford (and contributors)
 #
 # See 'rote.rb' or LICENSE for licence information.
-# $Id: page.rb,v 1.11 2005/12/14 19:01:05 roscopeco Exp $
+# $Id: page.rb 143 2005-12-14 19:01:05 +0000 (Wed, 14 Dec 2005) roscopeco $
 #++
 
 require 'erb'
-
-# Don't want user to have to require these in their pagecode.
-require 'rote/format/html'
+require 'rote/cache'
 
 module Rote
   STRIP_SLASHES = /^\/?(.*?)\/?$/
@@ -69,11 +67,18 @@ module Rote
 
     # The text of the layout to use for this page. This is read in
     # when (if) the page source calls layout(basename).
-    attr_reader :layout_text
+    #
+    # *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    
     
     # The names from which this page's template and layout (if any) 
-    # were read, relative to the +base_path+.
-    attr_reader :template_name, :layout_name    
+    # are read, relative to the +base_path+.
+    attr_reader :template_name, :layout_names
+    
+    # Convenience accessor for the first queued layout. This is the
+    # innermost layout, usually specified by the page itself.
+    def layout_name; layout_names.first; end   
     
     # The base paths for this page's template and layout. These point
     # to the directories configured in the Rake tasks.
@@ -100,12 +105,12 @@ module Rote
     def initialize(template_name, pages_dir = '.', layout_dir = pages_dir, &blk) 
       @template_text = nil
       @template_name = nil
-      @layout_text = nil
-      @layout_name = nil
+      @layout_names = []
       @content_for_layout = nil
       @result = nil
       @layout_defext = File.extname(template_name)
       @layout_path = layout_dir[STRIP_SLASHES,1]
+      @layout_text = nil
       @base_path = pages_dir[STRIP_SLASHES,1]
       
       @page_filters, @post_filters = [], []
@@ -130,13 +135,13 @@ module Rote
     # Returns the full filename of this Page's template. This is obtained by
     # joining the base path with template name.
     def template_filename
-      template_name ? File.join(base_path,template_name) : nil
+      File.join(base_path,template_name) if template_name
     end
     
-    # Returns the full filename of this Page's template. This is obtained by
-    # joining the base path with template name.
+    # Returns the full filename of the first queued layout. This is
+    # the innermost layout, usually specified by the page itself.
     def layout_filename
-      layout_name ? File.join(layout_path,layout_name) : nil
+      layout_fn(layout_name)
     end
     
     # Returns the full filename of this Page's ruby source. If no source is
@@ -179,11 +184,11 @@ module Rote
       @result or do_render!   # sets up result for next time...
     end
     
-    alias to_s render
+    alias :to_s :render
     
-    # Sets the layout from the specified file, or disables layout if
-    # +nil+ is passed in. The specified basename should be the name
-    # of the layout file relative to the +layout_dir+, with no extension.
+    # Adds the specified layout to those that will be rendered. The specified
+    # basename should be the name of the layout file relative to the 
+    # +layout_dir+, with no extension.
     #
     # *The* *layout* *is* *not* *read* *by* *this* *method*. It, and 
     # it's source, are loaded only at rendering time. This prevents
@@ -194,10 +199,7 @@ module Rote
     # that the instance is frozen.
     def layout(basename)
       if basename
-        # layout text
-        @layout_name = "#{basename}#{@layout_defext if File.extname(basename).empty?}"
-      else
-        @layout_name = nil
+        self.layout_names << "#{basename}#{@layout_defext if File.extname(basename).empty?}"
       end
     end    
     
@@ -224,17 +226,28 @@ module Rote
       end
     end  
     
-    def load_layout
-      if fn = layout_filename
-        raise "Layout #{fn} not found" unless File.exists?(fn)      
-        @layout_text = File.read(fn)
+    def layout_fn(fn)
+      File.join(layout_path,fn) if fn
+    end
+    
+    # Loads the layout. This method evaluates the layout code 
+    # and returns it's text. The layout (and code if found)
+    # are also registered as cached deps.
+    def load_layout(fn)
+      if fn = layout_fn(fn)
+        raise "Layout #{fn} not found" unless File.exists?(fn)
         
         # layout code     
         cfn = Page::page_ruby_filename(fn)
-        instance_eval(File.read(cfn), cfn) if File.exists?(cfn)        
+        if File.exists?(cfn)
+          instance_eval(File.read(cfn), cfn) 
+          Rake.register_dependency(cfn)  
+        end
+
+        Rake.register_dependency(fn)
+        File.read(fn)                    
       end
-    end
-    
+    end    
     
     def render_page_filters(text)
       page_filters.inject(text) { |s, f| f.filter(s, self) }      
@@ -254,19 +267,33 @@ module Rote
         @content_for_layout = render_page_filters( erb.result(binding) )
       end
       
-      # Load layout _after_ page eval, allowing page to override layout.
-      load_layout
-      
-      # render into the layout if supplied.
-      @result = if !@layout_text.nil?
-        erb = ERB.new(@layout_text)
-        erb.filename = layout_filename
-        erb.result(binding)   
-      else 
-        @content_for_layout
-      end 
+      # Do layout _after_ page eval. As we go through this, the layouts
+      # we load may add to the end of the layout names array, so nested
+      # layout is supported by just chasing the end of the array until
+      # it's empty. The process is basically
+      #
+      #    Page is loaded, calls 'layout' with it's layout.
+      #    During render, that fn is taken, and loaded. Layout code
+      #      again calls 'layout'.
+      #    On next loop iteration, that new filename is loaded, and it's
+      #    code is executed ... and so on.
+      #
+      #    Each loop puts the result into @content_for_layout, so that
+      #    nested layouts can work just the same as regular.
+      @layout_names.each do |fn|
+        txt = load_layout(fn)
+        
+        @layout_text ||= txt    # legacy support    vv0.3.2 v-0.4
+        
+        # render into the layout if supplied.
+        if txt
+          erb = ERB.new(txt)
+          erb.filename = fn
+          @content_for_layout = erb.result(binding)   
+        end
+      end
       
-      @result = render_post_filters(@result)      
+      @result = render_post_filters(@content_for_layout)      
       freeze
       
       @result 

data/lib/rote/project/Rakefile

@@ -1,7 +1,7 @@
 # Standard Rakefile for custom Rote build
 #
 # Generated from:
-# $Id: Rakefile,v 1.3 2005/12/14 19:01:05 roscopeco Exp $
+# $Id: Rakefile 143 2005-12-14 19:01:05 +0000 (Wed, 14 Dec 2005) roscopeco $
 # 
 begin 
   require 'rubygems'
@@ -12,8 +12,7 @@ end
 require 'rake'
 require 'rake/clean'
 require 'rote'
-require 'rote/filters/redcloth'
-require 'rote/filters/rdoc'
+require 'rote/filters'
 require 'rote/format/html'
 
 include Rote
@@ -47,12 +46,12 @@ ws = Rote::DocTask.new(:doc) do |site|
   
   site.ext_mapping(/thtml|textile/, 'html') do |page|
     page.extend Format::HTML
-    page.page_filter Filters::RedCloth.new(:textile)
+    page.page_filter Filters::RedCloth.new
   end    
   
   site.ext_mapping(/mhtml|markdown/, 'html') do |page|
     page.extend Format::HTML
-    page.page_filter Filters::RedCloth.new(:markdown)
+    page.page_filter Filters::BlueCloth.new
   end      
   
   site.ext_mapping(/rdhtml|rdoc/, 'html') do |page|

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,v 1.9 2005/12/12 02:45:24 roscopeco Exp $
+# $Id: rotetasks.rb 128 2005-12-12 02:45:24 +0000 (Mon, 12 Dec 2005) roscopeco $
 #++
 require 'rake'
 require 'rake/tasklib'

data/test/layouts/nestme.rb

@@ -0,0 +1,2 @@
+# try nesting this layout in 'simple'
+layout 'simple'

data/test/layouts/nestme.txt

@@ -0,0 +1 @@
+this: '<%= @content_for_layout %>'

data/test/pages/nestedlayout.rb

@@ -0,0 +1,5 @@
+# config
+layout 'nestme'
+
+# custom stuff
+@myvar = 'some text'

data/test/pages/nestedlayout.txt

@@ -0,0 +1 @@
+<%= @myvar %> and <%= @global %>

data/test/test_cache.rb

@@ -0,0 +1,67 @@
+begin
+  require 'rubygems'
+rescue LoadError
+  nil
+end
+
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
+
+require 'rake'
+require 'rote/cache'
+
+module Rote  
+  class TestCache < Test::Unit::TestCase
+
+    def test_rake_cache_dir
+      assert_equal '.rake_cache', Rake.cache_dir
+      Rake.cache_dir = './.cache'
+      assert_equal './.cache', Rake.cache_dir
+      Rake.cache_dir = nil
+      assert_equal '.rake_cache', Rake.cache_dir
+    end
+
+    def test_rake_dependencies_file
+      assert_equal '.rake_cache/dependencies.yaml', Rake.dependencies_file
+      Rake.cache_dir = './.cache'
+      assert_equal './.cache/dependencies.yaml', Rake.dependencies_file
+      Rake.cache_dir = nil
+      assert_equal '.rake_cache/dependencies.yaml', Rake.dependencies_file
+    end
+    
+    def test_rake_task_stack
+      assert_equal [], Rake.task_stack             
+      
+      outertask = task :outertask do        
+        assert_equal ['outertask'], Rake.task_stack         
+        
+        innertask = task :innertask do          
+          assert_equal ['outertask', 'innertask'], Rake.task_stack         
+        end
+        
+        assert_equal ['outertask'], Rake.task_stack         
+      end    
+      
+      assert_equal [], Rake.task_stack             
+    end
+    
+    def test_rake_register_dep_cached_deps
+      assert_equal({}, Rake.cached_dependencies)
+      
+      # should fail here, return nil, do nothing. 
+      # there's no current task
+      assert_nil Rake.register_dependency('dep')
+      assert_equal({}, Rake.cached_dependencies)
+      
+      testtask = task :test_register_dep do
+        assert_equal(['dep'], Rake.register_dependency('dep'))
+      end
+      
+      testtask.invoke(false)
+      
+      assert_equal({'test_register_dep' => ['dep']}, Rake.cached_dependencies)
+    end
+    
+    # TODO need to test load / save
+    
+  end
+end

data/test/{test_formatting.rb → test_filters.rb}

@@ -4,12 +4,18 @@ rescue LoadError
   nil
 end
 
+# make sure we're testing this version, not an installed Gem!
+$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'
 
 SYNTEST = <<-EOM  
   <p>Non-code</p>
@@ -27,6 +33,38 @@ SYNTEST = <<-EOM
 
 EOM
 
+EXECTEST = <<-EOM  
+  <p>Non-eval</p>
+  #:exec#ruby#
+  def amethod(arg)
+    puts arg
+  end
+  
+  amethod('Hello, World')  
+  #:exec#
+  <p>More non-code</p>
+  #:exec#ruby#
+  puts "Hello again!"  
+  #:exec#
+
+EOM
+
+EVALTEST = <<-EOM  
+  <p>Non-eval</p>
+  #:eval#one#
+  def amethod(arg)
+    puts arg
+  end
+  
+  amethod('Hello, World')  
+  #:eval#
+  <p>More non-code</p>
+  #:eval#one#
+  puts "Hello again!"  
+  #:eval#
+
+EOM
+
 SYNEXPECT = <<-EOM
   <p>Non-code</p>
 <pre class='ruby'><code>  <span class=\"keyword\">def </span><span class=\"method\">amethod</span><span class=\"punct\">(</span><span class=\"ident\">arg</span><span class=\"punct\">)</span>
@@ -38,6 +76,11 @@ SYNEXPECT = <<-EOM
   <span class=\"keyword\">end</span></code></pre>
 EOM
 
+EXECEXPECT = "  <p>Non-eval</p>\nHello, World\n\n  <p>More non-code</p>\nHello again!\n"
+
+EVALEXPECT = "  <p>Non-eval</p>\nHello, World\n\n  <p>More non-code</p>\nHello again!\n"
+ 
+
 TOCTEST = <<-EOM
   <h2>Section One</h2>
   <p>This is section one</p>  
@@ -60,7 +103,8 @@ TOCEXPECTALL = <<-EOM
 EOM
 
 module Rote  
-  class TestFormatting < Test::Unit::TestCase
+  class TestFilters < Test::Unit::TestCase
+    
     ############## filters/redcloth #################    
     def test_render_default     # textile
       t = Filters::RedCloth.new.filter('*Textile* _Test_', nil)
@@ -68,13 +112,28 @@ module Rote
     end
 
     def test_render_textile
+      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)
       assert_equal '<p><strong>Textile</strong> <em>Test</em></p>', t
     end
 
     def test_render_markdown
-      t = Filters::RedCloth.new(:markdown).filter("*this* is a _test_\n==================", nil)
-      assert_equal '<h1>*this* is a _test_</h1>', t
+      t = Filters::BlueCloth.new.filter("__this__ is a _test_\n==================", nil)
+      assert_equal '<h1><strong>this</strong> is a <em>test</em></h1>', t
+    end
+
+    def test_render_markdown_custom
+      f = Filters::BlueCloth.new do |bluecloth, page| 
+        assert_not_nil bluecloth
+        assert_nil page           # we pass in nil below
+
+        bluecloth.to_html
+      end
+      
+      t = f.filter("__this__ is a _test_\n==================", nil)
+      assert_equal '<h1><strong>this</strong> is a <em>test</em></h1>', t
     end
 
     ############## filters/rdoc #################
@@ -111,8 +170,27 @@ module Rote
       # good
       assert_equal SYNEXPECT.chomp, Filters::Syntax.new.filter(SYNTEST,nil)    
     end
-    # TODO test macro stuff etc.
     
+    def test_exec_filter
+      # bad
+      assert_equal '', Filters::Exec.new.filter('',nil)    
+      assert_equal 'Has no source', Filters::Exec.new.filter('Has no source',nil)    
+      
+      # good
+      assert_equal EXECEXPECT, Filters::Exec.new.filter(EXECTEST,nil)    
+    end
+    
+    def test_eval_filter
+      # bad
+      assert_equal '', Filters::Eval.new.filter('',nil)    
+      assert_equal 'Has no source', Filters::Eval.new.filter('Has no source',nil)    
+      
+      # good
+      assert_equal EVALEXPECT, Filters::Eval.new.filter(EVALTEST,nil)  
+      
+      # Make sure Stdout was returned to normal
+      assert $stdout.class != StringIO
+    end
   end