PageTemplate 1.1.2 → 1.2.0

data/doc/fr_method_index.html

@@ -20,60 +20,63 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/PageTemplate.html#M000014">[] (PageTemplate)</a><br />
-    <a href="classes/Namespace.html#M000033">[] (Namespace)</a><br />
-    <a href="classes/Namespace.html#M000032">[]= (Namespace)</a><br />
-    <a href="classes/PageTemplate.html#M000013">[]= (PageTemplate)</a><br />
+    <a href="classes/Namespace.html#M000036">[] (Namespace)</a><br />
+    <a href="classes/PageTemplate.html#M000016">[] (PageTemplate)</a><br />
+    <a href="classes/Namespace.html#M000035">[]= (Namespace)</a><br />
+    <a href="classes/PageTemplate.html#M000015">[]= (PageTemplate)</a><br />
     <a href="classes/BlockCommand.html#M000007">add (BlockCommand)</a><br />
-    <a href="classes/Syntax/Parser.html#M000050">build (Syntax::Parser)</a><br />
-    <a href="classes/Syntax/CachedParser.html#M000046">build (Syntax::CachedParser)</a><br />
-    <a href="classes/PageTemplate.html#M000016">clearFile (PageTemplate)</a><br />
-    <a href="classes/Syntax/Parser.html#M000054">compile (Syntax::Parser)</a><br />
-    <a href="classes/Namespace.html#M000035">get (Namespace)</a><br />
-    <a href="classes/PageTemplate.html#M000012">getParameter (PageTemplate)</a><br />
+    <a href="classes/PageTemplate.html#M000011">add_path (PageTemplate)</a><br />
+    <a href="classes/Syntax/Parser.html#M000053">build (Syntax::Parser)</a><br />
+    <a href="classes/Syntax/CachedParser.html#M000049">build (Syntax::CachedParser)</a><br />
+    <a href="classes/PageTemplate.html#M000018">clearFile (PageTemplate)</a><br />
+    <a href="classes/Syntax/Parser.html#M000057">compile (Syntax::Parser)</a><br />
+    <a href="classes/Namespace.html#M000038">get (Namespace)</a><br />
+    <a href="classes/PageTemplate.html#M000014">getParameter (PageTemplate)</a><br />
     <a href="classes/BlockCommand.html#M000006">length (BlockCommand)</a><br />
-    <a href="classes/PageTemplate.html#M000010">load (PageTemplate)</a><br />
-    <a href="classes/Syntax/Glossary.html#M000048">lookup (Syntax::Glossary)</a><br />
-    <a href="classes/TextCommand.html#M000042">new (TextCommand)</a><br />
-    <a href="classes/PageTemplate.html#M000009">new (PageTemplate)</a><br />
-    <a href="classes/IncludeCommand.html#M000017">new (IncludeCommand)</a><br />
-    <a href="classes/Syntax/CachedParser.html#M000045">new (Syntax::CachedParser)</a><br />
-    <a href="classes/IfCommand.html#M000039">new (IfCommand)</a><br />
-    <a href="classes/LoopElseCommand.html#M000020">new (LoopElseCommand)</a><br />
-    <a href="classes/Syntax/Glossary.html#M000047">new (Syntax::Glossary)</a><br />
-    <a href="classes/BlockCommand.html#M000004">new (BlockCommand)</a><br />
-    <a href="classes/IfElseCommand.html#M000023">new (IfElseCommand)</a><br />
-    <a href="classes/Syntax/Parser.html#M000049">new (Syntax::Parser)</a><br />
-    <a href="classes/Namespace.html#M000031">new (Namespace)</a><br />
-    <a href="classes/ValueCommand.html#M000026">new (ValueCommand)</a><br />
+    <a href="classes/PageTemplate.html#M000012">load (PageTemplate)</a><br />
+    <a href="classes/Syntax/Glossary.html#M000051">lookup (Syntax::Glossary)</a><br />
+    <a href="classes/ValueCommand.html#M000029">new (ValueCommand)</a><br />
     <a href="classes/LoopCommand.html#M000001">new (LoopCommand)</a><br />
-    <a href="classes/ValueCommand.html#M000027">output (ValueCommand)</a><br />
-    <a href="classes/Command.html#M000029">output (Command)</a><br />
-    <a href="classes/TextCommand.html#M000044">output (TextCommand)</a><br />
-    <a href="classes/PageTemplate.html#M000015">output (PageTemplate)</a><br />
-    <a href="classes/IfElseCommand.html#M000024">output (IfElseCommand)</a><br />
-    <a href="classes/Syntax/Parser.html#M000051">output (Syntax::Parser)</a><br />
-    <a href="classes/IncludeCommand.html#M000018">output (IncludeCommand)</a><br />
-    <a href="classes/LoopElseCommand.html#M000021">output (LoopElseCommand)</a><br />
-    <a href="classes/BlockCommand.html#M000008">output (BlockCommand)</a><br />
-    <a href="classes/IfCommand.html#M000040">output (IfCommand)</a><br />
+    <a href="classes/PageTemplate.html#M000010">new (PageTemplate)</a><br />
+    <a href="classes/IncludeCommand.html#M000019">new (IncludeCommand)</a><br />
+    <a href="classes/TextCommand.html#M000045">new (TextCommand)</a><br />
+    <a href="classes/IfCommand.html#M000042">new (IfCommand)</a><br />
+    <a href="classes/LoopElseCommand.html#M000022">new (LoopElseCommand)</a><br />
+    <a href="classes/Namespace.html#M000034">new (Namespace)</a><br />
+    <a href="classes/Syntax/CachedParser.html#M000048">new (Syntax::CachedParser)</a><br />
+    <a href="classes/IfElseCommand.html#M000025">new (IfElseCommand)</a><br />
+    <a href="classes/BlockCommand.html#M000004">new (BlockCommand)</a><br />
+    <a href="classes/Syntax/Parser.html#M000052">new (Syntax::Parser)</a><br />
+    <a href="classes/Syntax/Glossary.html#M000050">new (Syntax::Glossary)</a><br />
+    <a href="classes/UnlessCommand.html#M000028">output (UnlessCommand)</a><br />
+    <a href="classes/ValueCommand.html#M000030">output (ValueCommand)</a><br />
+    <a href="classes/IfElseCommand.html#M000026">output (IfElseCommand)</a><br />
+    <a href="classes/Command.html#M000032">output (Command)</a><br />
     <a href="classes/LoopCommand.html#M000002">output (LoopCommand)</a><br />
-    <a href="classes/Syntax/Parser.html#M000053">parse (Syntax::Parser)</a><br />
-    <a href="classes/Namespace.html#M000038">pop (Namespace)</a><br />
-    <a href="classes/Namespace.html#M000037">push (Namespace)</a><br />
-    <a href="classes/Syntax/Parser.html#M000052">reset (Syntax::Parser)</a><br />
-    <a href="classes/Namespace.html#M000034">set (Namespace)</a><br />
-    <a href="classes/PageTemplate.html#M000011">setParameter (PageTemplate)</a><br />
-    <a href="classes/IfCommand.html#M000041">to_s (IfCommand)</a><br />
-    <a href="classes/TextCommand.html#M000043">to_s (TextCommand)</a><br />
-    <a href="classes/IncludeCommand.html#M000019">to_s (IncludeCommand)</a><br />
-    <a href="classes/BlockCommand.html#M000005">to_s (BlockCommand)</a><br />
+    <a href="classes/LoopElseCommand.html#M000023">output (LoopElseCommand)</a><br />
+    <a href="classes/CommentCommand.html#M000009">output (CommentCommand)</a><br />
+    <a href="classes/BlockCommand.html#M000008">output (BlockCommand)</a><br />
+    <a href="classes/Syntax/Parser.html#M000054">output (Syntax::Parser)</a><br />
+    <a href="classes/TextCommand.html#M000047">output (TextCommand)</a><br />
+    <a href="classes/IncludeCommand.html#M000020">output (IncludeCommand)</a><br />
+    <a href="classes/IfCommand.html#M000043">output (IfCommand)</a><br />
+    <a href="classes/PageTemplate.html#M000017">output (PageTemplate)</a><br />
+    <a href="classes/Syntax/Parser.html#M000056">parse (Syntax::Parser)</a><br />
+    <a href="classes/Namespace.html#M000041">pop (Namespace)</a><br />
+    <a href="classes/Namespace.html#M000040">push (Namespace)</a><br />
+    <a href="classes/Syntax/Parser.html#M000055">reset (Syntax::Parser)</a><br />
+    <a href="classes/Namespace.html#M000037">set (Namespace)</a><br />
+    <a href="classes/PageTemplate.html#M000013">setParameter (PageTemplate)</a><br />
+    <a href="classes/IfElseCommand.html#M000027">to_s (IfElseCommand)</a><br />
+    <a href="classes/ValueCommand.html#M000031">to_s (ValueCommand)</a><br />
+    <a href="classes/TextCommand.html#M000046">to_s (TextCommand)</a><br />
     <a href="classes/LoopCommand.html#M000003">to_s (LoopCommand)</a><br />
-    <a href="classes/Command.html#M000030">to_s (Command)</a><br />
-    <a href="classes/LoopElseCommand.html#M000022">to_s (LoopElseCommand)</a><br />
-    <a href="classes/IfElseCommand.html#M000025">to_s (IfElseCommand)</a><br />
-    <a href="classes/ValueCommand.html#M000028">to_s (ValueCommand)</a><br />
-    <a href="classes/Namespace.html#M000036">true? (Namespace)</a><br />
+    <a href="classes/Command.html#M000033">to_s (Command)</a><br />
+    <a href="classes/IfCommand.html#M000044">to_s (IfCommand)</a><br />
+    <a href="classes/IncludeCommand.html#M000021">to_s (IncludeCommand)</a><br />
+    <a href="classes/BlockCommand.html#M000005">to_s (BlockCommand)</a><br />
+    <a href="classes/LoopElseCommand.html#M000024">to_s (LoopElseCommand)</a><br />
+    <a href="classes/Namespace.html#M000039">true? (Namespace)</a><br />
   </div>
 </div>
 </body>

data/lib/CVS/Entries

@@ -0,0 +1,2 @@
+/PageTemplate.rb/1.14/Fri Mar 11 19:04:23 2005//
+D

data/lib/CVS/Repository

@@ -0,0 +1 @@
+PageTemplate/lib

data/lib/CVS/Root

@@ -0,0 +1 @@
+/home/wisti/CVS

data/lib/PageTemplate.rb

@@ -55,11 +55,11 @@ class Namespace
     
     @nSpaces.reverse.each do |ns|
 
-      if ns.class.method_defined?(":#{key}")
+      if ns.respond_to?(":#{key}")
         value = ns.send(":#{key}")
-      elsif ns.class.method_defined?("#{key}")
+      elsif ns.respond_to?("#{key}")
         value = ns.send(key)
-      elsif ns.class.method_defined?("[]")
+      elsif ns.respond_to?("[]")
         value = ns[key]
       end
       
@@ -117,6 +117,16 @@ class Command
   end
 end
 
+# CommentCommand provides a mechanism for ignoring the contents
+# of a block.
+class CommentCommand < Command
+
+  def output(namespace = nil)
+    return nil
+  end
+
+end
+
 # BlockCommand provides a single interface to multiple Command
 # objects.
 class BlockCommand < Command
@@ -237,6 +247,17 @@ class IfCommand < ValueCommand
   end
 end
 
+# An UnlessCommand simplifies templates that need to use
+# a Block only if a condition is false
+class UnlessCommand < IfCommand
+  # If +namespace+ does not have a true value for this Command's flag, returns
+  # the output generated by the CommandBlock. Otherwise, returns nil.
+  def output(namespace)
+    unless namespace.true?(@value)
+      return @commands.output(namespace)
+    end
+  end
+end
 
 # An IfCommand with an alternate BlockCommand to use if the 
 # flag variable if false.
@@ -299,10 +320,19 @@ class LoopCommand < ValueCommand
     
     result = ""
     
-    items.each do |item|
+    items.each_with_index do |item, index|
+      metavariables = Namespace.new()
+      metavariables['__FIRST__'] = true if index == 0
+      metavariables['__LAST__'] = true if index == items.length - 1
+      # Even-numbered index means an odd-numbered iteration. 
+      # Gotta love zero-based indexes.
+      metavariables['__ODD__'] = true if index % 2 == 0
+
+      namespace.push(metavariables)
       namespace.push(item)
       result += @commands.output(namespace)
       namespace.pop()
+      namespace.pop()
     end
     
     return result
@@ -379,6 +409,8 @@ module Syntax
     # * ifopen
     # * ifclose
     # * ifbranch
+    # * unlessopen
+    # * unlessclose
     # * loopopen
     # * loopclose
     # * loopbranch
@@ -420,6 +452,7 @@ module Syntax
     def checkGlossary(glossary)
       %w[ value 
 		ifopen ifclose ifbranch 
+                unlessopen unlessclose
 		loopopen loopclose loopbranch
 		].each do |key|
         unless glossary.has_key?(key)
@@ -438,10 +471,13 @@ module Syntax
   # Here are the keys and patterns associated with Syntax::DEFAULT
   
   # * directive: /\[%(.+)%\]/
+  # * comment: /--.+?--/
   # * value: /var (\w+)/
   # * ifopen: /if (\w+)/
   # * ifclose: /endif/
   # * ifbranch: /else/
+  # * unlessopen: /unless (\w+)/
+  # * unlessclose: /endunless/
   # * loopopen: /in (\w+)/
   # * loopclose: /endin/
   # * loopbranch: /no/
@@ -456,9 +492,12 @@ module Syntax
 
   DEFAULT = Syntax::Glossary.new( /\[%(.+?)%\]/,
                                   'value'      => /^\s*var (\w+)\s*$/,
+                                  'comment'    => /^\s*--.+?--\s*$/,
                                   'ifopen'     => /^\s*if (\w+)\s*$/,
                                   'ifclose'    => /^\s*endif\s*$/,
                                   'ifbranch'   => /^\s*else\s*$/,
+                                  'unlessopen' => /^\s*unless (\w+)\s*$/,
+                                  'unlessclose'=> /^\s*endunless\s*$/,
                                   'loopopen'   => /^\s*in (\w+)\s*$/,
                                   'loopclose'  => /^\s*endin\s*$/,
                                   'loopbranch' => /^\s*no\s*$/,
@@ -483,6 +522,7 @@ module Syntax
 
     # Parse and compile a file containing PageTemplate directives.
     def build(filename)
+      filename.untaint
       if File.exists?(filename)
         file = File.new(filename)
       else
@@ -589,6 +629,8 @@ module Syntax
             command = ValueCommand.new(value)
           elsif directive == "include"
             command = IncludeCommand.new(value, @path)
+          elsif directive == "comment"
+            command = CommentCommand.new()
           elsif directive =~ /^(\w+?)open$/
             mainBlock = nil
             branchBlock = nil
@@ -613,7 +655,7 @@ module Syntax
                 mainBlock = compile(mainLines)
               end
             else
-              raise "#{@file}:#{line[0]} - " + 
+              raise "#{filename}:#{line[0]} - " + 
                       "#{block} #{value} doesn't close"
             end
             
@@ -624,6 +666,8 @@ module Syntax
               elsif mainBlock
                 command = IfCommand.new(value, mainBlock)
               end
+            elsif block == "unless"
+              command = UnlessCommand.new(value, mainBlock)
             elsif block == "loop"
               if mainBlock and branchBlock
                 command = LoopElseCommand.new(value,
@@ -639,15 +683,15 @@ module Syntax
             # Skip to the line after the block closer.
             i = close
           elsif %Q[
-			ifbranch ifclose loopbranch loopclose
+			ifbranch ifclose loopbranch loopclose unlessclose
 			].include?(directive)
-            raise "#{@file}:#{line[0]} - #{directive}" +
+            raise "#{filename}:#{line[0]} - #{directive}" +
                         " without corresponding opening directive"
           else
-            raise "#{@file}:#{line[0]} - Unknown command #{directive}"
+            raise "#{filename}:#{line[0]} - Unknown command #{directive}"
           end
         else
-          raise "#{@file}: Unknown instruction in line #{line}"
+          raise "#{filename}: Unknown instruction in line #{line}"
         end
         
         commands.add(command)
@@ -720,6 +764,7 @@ module Syntax
       saveCache = false
       
       # See if cache exists and is newer than source.
+      cacheFile.untaint
       if File.exists?(cacheFile)
         cacheStat = File.stat(cacheFile)
         if cacheStat.mtime > File.stat(filename).mtime
@@ -765,6 +810,7 @@ end
 # PageTemplate is the primary user Class for this package.
 class PageTemplate
   attr_reader :file, :syntax, :parser
+  attr_accessor :path
 
   # Creates a new PageTemplate object, using +args+ to provide 
   # optional initialization.
@@ -772,7 +818,8 @@ class PageTemplate
   # ==== Possible Keys For Args
   #
   # [:include_path]
-  #     The directory that PageTemplate will look for template files in.
+  #     Additional directories that PageTemplate will look for template files in.
+  #     - May be a string or Array
   #
   # [:filename]
   #	The name of a text file to use for a template.
@@ -798,10 +845,13 @@ class PageTemplate
       @syntax = Syntax::DEFAULT
     end
 
-    if args['include_path']
-      @path = args['include_path']
-    else
-      @path = Dir.getwd()
+    @path = [ Dir.getwd() ]
+    if pathInfo = args['include_path']
+      if pathInfo.class == Array
+        @path = @path + pathInfo
+      else
+        @path.push(pathInfo)
+      end
     end
     
     if args['use_cache']
@@ -818,6 +868,11 @@ class PageTemplate
     end
 
   end
+
+  # Add a path to the search path for loading includes.
+  def add_path(path)
+    @path.push(path)
+  end
   
   # Open +file+ and parse its contents so they will be ready
   # for template generation.
@@ -880,22 +935,36 @@ class PageTemplate
 end
 
 # IncludeCommand allows including text from external files.
+class IncludeCommandError < RuntimeError
+  # Adding nothing, I just want the class name
+end
+
 class IncludeCommand < Command
 
-  def initialize(filename, path = Dir.getwd)
+  def initialize(filename, path = nil)
     super()
     @filename = filename
-    @path = path
+    @path = [ Dir.getwd() ]
+    
+    if path then
+      @path = @path + path
+    end
+
     @parser = Syntax::Parser.new(Syntax::DEFAULT, @path)
   end
 
   def output(ns=nil)
     # First check to see if the file exists in the current working directory
     # or as an absolute filename.
-    file = determine_file(ns)
-    text = File.open(file).read()
-    @parser.build(file)
-    @parser.output(ns)
+    text = ""
+    begin
+      file = determine_file(ns)
+      @parser.build(file)
+      text = @parser.output(ns)
+    rescue IncludeCommandError => error
+      text = error
+    end
+    return text
   end
 
   def to_s
@@ -904,17 +973,25 @@ class IncludeCommand < Command
 
   private
   def determine_file(ns)
-    path = @path
+    file = nil
+
     if ns
       base = ns.get(@filename) || @filename
     else
       base = @filename
     end
-    f = File.expand_path(File.join(path, base))
-    if File.exists?(f)
-      file = f
-    else
-      raise RuntimeError, "Cannot find #{base} in include path (#{path})"
+
+    @path.each do |p|
+      f = File.expand_path(File.join(p, base))
+      f.untaint
+      if File.exists?(f)
+        file = f
+        break
+      end
+    end
+
+    unless file
+      raise IncludeCommandError, "File #{base} not found."
     end
 
     return file