PageTemplate 2.1.7 → 2.2.0

data/lib/PageTemplate.rb

@@ -29,7 +29,7 @@ require 'PageTemplate/commands'
 # It is a class so that programmers are not confused by being able to
 # do .new on a module
 class PageTemplate
-  VERSION = "2.1.7"
+  VERSION = "2.2.0"
 
   # Passes arguments straight to Parser.new
   #

data/lib/PageTemplate/commands.rb

@@ -84,7 +84,7 @@ class PageTemplate
   # branch in the logic: such as If, Loop, etcetera.
   #
   # Any child that wants to do more than stand alone must inherit from
-  # StackableCommand. Also recommended is setting @called_as, so 
+  # StackableCommand. We recommend setting @called_as, so 
   # all of StackableCommand's ways of closing blocks work.
   class StackableCommand < Command
     @modifier = nil
@@ -209,6 +209,50 @@ class PageTemplate
     end
   end
 
+  # DefineCommand will set a variable within the enclosing namespace
+  class DefineCommand < Command
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+
+    # Doesn't return any output
+    def output(namespace)
+      namespace[@name] = @value
+      return
+    end
+  end
+
+  # FilterCommand filters its block through a preprocessor
+  #  [% filter :processor %]text[% end %]
+  class FilterCommand < StackableCommand
+    @closer = :end
+    def initialize(filter)
+      @called_as = "filter"
+      @processor = filter
+      @text = []
+    end
+
+    def add(line)
+      @text.push(line)
+    end
+
+    def output(namespace=nil)
+      parser = namespace.parser if namespace
+      parser = Parser.recent_parser unless parser
+      namespace ||= parser
+      preprocessor = parser.preprocessor
+      processor = @processor || parser.default_processor
+      text = ""
+      @text.each { |c| text += c.output(namespace) }
+      if preprocessor.respond_to?(processor)
+        preprocessor.send(processor, text)
+      else
+        "[ ValueCommand: unknown preprocessor #{@processor} ]"
+      end
+    end
+  end
+
   # ValueCommand will print out a variable name, possibly passing its
   # value through a preprocessor.
   #
@@ -217,8 +261,8 @@ class PageTemplate
   # +variable+ is first plucked out of the Namespace,
   #
   # The to_s of the output from Namespace#get is passed through
-  # parser's preprocessor. If :processor is defined, then it is
-  # parser.preprocessor.send(:processor,body) is called, allowing the
+  # parser's preprocessor. If :processor is defined, then 
+  # parser.preprocessor.send(:processor,body) is called. This allows the
   # designer to choose a particular format for the output. If
   # :processor is not given, then parser's default processor is used.
   class ValueCommand < Command
@@ -498,8 +542,8 @@ class PageTemplate
         body.output(namespace)
       elsif body
         cmds = parser.parse(body)
-	parser.source.cache(fn,cmds)
-	cmds.output(namespace)
+        parser.source.cache(fn,cmds)
+        cmds.output(namespace)
       else
         "[ Template '#{fn}' not found ]"
       end

data/lib/PageTemplate/parser.rb

@@ -160,11 +160,21 @@ class PageTemplate
 
   class Namespace
     include NamespaceItem
+
     def initialize(parent=nil,object=nil)
       @values = Hash.new
       @parent = parent
       @object = object
     end
+
+    # Create a new top-level Namespace with a Hash-like object
+    def Namespace.construct_from(arg)
+      ns = Namespace.new()
+      arg.each { |k, v|
+        ns[k] = v
+      }
+      return ns
+    end
   end
 
   # A Source is a source from which templates are drawn.
@@ -172,14 +182,32 @@ class PageTemplate
   # Source#get(name) must return the body of the template that is to
   # be parsed, or nil if it doesn't exist.
   class Source
+
     def initialize(args = {})
       @args  = args
     end
-    def get(name)
+
+    def get(name=nil)
       name
     end
   end
 
+  # A StringSource is created with a raw string, which is returned on any
+  # call to 'get'.
+  class StringSource < Source
+    def initialize(args)
+      if args.class == String
+        @source = args
+      else
+        @args = args
+        @source = args["source"]
+      end
+    end
+    def get()
+      return @source
+    end
+  end
+
   # FileSource provides access to files within the 'include_paths'
   # argument.
   #
@@ -212,15 +240,15 @@ class PageTemplate
       fn = get_filename(name)
       begin
         case
-	when fn.nil?
-	  nil
-        when @cache.has_key?(fn) && (@mtime[fn] > File.mtime(fn).to_i)
-          cmds = @cache[fn]
-	  cmds.clear_cache
-	  cmds
-        else
-          IO.read(fn)
-        end
+      when fn.nil?
+        nil
+      when @cache.has_key?(fn) && (@mtime[fn] > File.mtime(fn).to_i)
+        cmds = @cache[fn]
+        cmds.clear_cache
+        cmds
+      else
+        IO.read(fn)
+      end
       rescue Exception => er
         return "[ Unable to open file #{fn} because of #{er.message} ]"
       end
@@ -231,6 +259,12 @@ class PageTemplate
       @mtime[fn] = Time.now.to_i
     end
     def get_filename(file)
+      # Check for absolute filepaths
+      if file == File.expand_path(file)
+        if File.exists?(file)
+          return file
+        end
+      end
       file = file.gsub(/\.\.\//,'') 
       @paths.each do |path|
         fn = File.join(path,file)
@@ -327,6 +361,14 @@ class PageTemplate
       CommentCommand.new(match[1])
     }
 
+    define(/^define (\w+)\s+?(.+)$/i) { |match|
+      DefineCommand.new(match[1], match[2])
+    }
+
+    define(/^filter :(\w+)$/i) { |match|
+      FilterCommand.new(match[1])
+    }
+
     define(/^(if|unless) ((\w+)(\.\w+\??)*)$/i) { |match|
       # Called_As, Value
       IfCommand.new(match[1],match[2])
@@ -481,6 +523,11 @@ class PageTemplate
       @@recent_parser = self
       @args         = args # For sub-commands
       @parent       = args['namespace'] || nil
+      if @parent
+        unless @parent.is_a? Namespace then
+          @parent = Namespace.construct_from(args['namespace'])
+        end
+      end
       @glossary     = args['glossary'] || DefaultGlossary
       @preprocessor = args['preprocessor'] || DefaultPreprocessor
       @default_processor = args['default_processor'] || :unescaped

data/tdata/include.txt

@@ -0,0 +1,3 @@
+A
+[%include file%]
+B

data/tdata/include2.txt

@@ -0,0 +1,3 @@
+A
+[%include dummy.txt%]
+B

data/tdata/variable.txt

@@ -0,0 +1 @@
+Hello, [%var name %]!

data/test.rb

@@ -159,12 +159,29 @@ module TestPageTemplate
     end
   end
 
+  class TestDefine < Test::Unit::TestCase
+    def setup
+      @@p = PageTemplate::Parser.new('empty_is_true' => false)
+    end
+
+    def test_output
+      template = @@p.parse("[%define zero 0%]Zero is [%var zero%]")
+      assert_equal("Zero is 0", template.output,
+                   "define command allows you to set values in a template")
+    end
+  end
+
   class TestFileSource < Test::Unit::TestCase
     def setup
       @@args = {}
       @@fs = PageTemplate::FileSource.new(@@args)
-      @@filename = 'tdata/dummy.txt'
-      @@location = File.join(Dir.getwd, @@filename)
+      # Construct an absolute path, whatever it looks like on our platform
+      require 'pathname'
+      cwd = Dir.getwd
+      directory = "tdata"
+      file = "dummy.txt"
+      @@filename = File.join(directory, file)
+      @@location = File.join(cwd, directory, file)
       @@text = IO.read(@@location)
     end
 
@@ -210,15 +227,29 @@ module TestPageTemplate
     end
   end
 
+  class TestFilterCommand < Test::Unit::TestCase
+    def setup
+      @@p = PageTemplate::Parser.new()
+    end
+
+    def test_filter
+      source = "[%filter :reverse %]foo[%end%]"
+      assert_equal("oof", @@p.parse(source).output,
+                   "FilterCommands can be used to filter raw template text.")
+      @@p["f"] = "boy"
+      source = "[%filter :reverse %][%var f%][%end%]"
+      assert_equal("yob", @@p.parse(source).output,
+                   "Commands in a FilterCommand are parsed before filtering")
+    end
+  end
+
   class TestIfCommand < Test::Unit::TestCase
     def setup
-      parser = PageTemplate::Parser.new()
       @@if     = PageTemplate::IfCommand.new("if", "flag")
       @@unless = PageTemplate::IfCommand.new("unless", "flag")
     end
 
     def test_initialize
-      parser = PageTemplate::Parser.new
       good_1 = "if flag"
       good_2 = "unless flag"
       bad_1  = "heck no"
@@ -299,13 +330,29 @@ module TestPageTemplate
   end
 
   class TestIncludeCommand < Test::Unit::TestCase
-    def test_output
+    def test_simple_output
       parser = PageTemplate::Parser.new()
-      parser['dummy'] = '/tdata/dummy.txt'
+      parser['dummy'] = File.join("tdata", "dummy.txt")
       i = PageTemplate::IncludeCommand.new('dummy')
       parser.load('tdata/dummy.txt')
       assert_equal(parser.output, i.output(parser))
     end
+
+    def test_include_template
+      pt = PageTemplate::Parser.new("include_path" => "tdata/")
+      pt.load("include.txt")
+      pt["file"] = "variable.txt"
+      pt["name"] = "Phil"
+      assert(pt.output =~ /Hello, Phil!/,
+             "Included files are parsed as templates.")
+    end
+
+    def test_include_literal
+      pt = PageTemplate::Parser.new("include_path" => "tdata")
+      pt.load("include2.txt")
+      assert(pt.output =~ /get_filename/,
+             "Include Commands can be handed a filename directly")
+    end
   end
 
   class TestLoopCommand < Test::Unit::TestCase
@@ -554,6 +601,20 @@ module TestPageTemplate
       assert_equal({}, @@p.args)
     end
 
+    def test_namespace_arg
+      require 'yaml'
+      ns = PageTemplate::Namespace.new()
+      ns['oompa'] = 'loompa'
+      p = PageTemplate::Parser.new('namespace' => ns)
+      assert_equal('loompa', p['oompa'])
+      p = PageTemplate::Parser.new('namespace' => { 'oompa' => 'loompa' })
+      assert_equal('loompa', p['oompa'])
+      # This assertion is just for my own peace of mind.
+      y = YAML::load({ 'doompity' => 'doo' }.to_yaml)
+      p = PageTemplate::Parser.new('namespace' => y)
+      assert_equal('doo', p['doompity'])
+    end
+
     def test_clearCommands
       @@p.clearCommands
       assert_equal(nil, @@p.commands)
@@ -607,6 +668,18 @@ module TestPageTemplate
     end
   end
 
+  class TestStringSource < Test::Unit::TestCase
+    def test_get
+      str = "John Jacob Jingleheimer Smith"
+      ss = PageTemplate::StringSource.new(str)
+      assert_equal(str, ss.get,
+                   "StringSource holds a simple String")
+      ss = PageTemplate::StringSource.new("source" => str)
+      assert_equal(str, ss.get,
+                   "StringSource holds a simple String")
+    end
+  end
+
   class TestSyntaxGlossary < Test::Unit::TestCase
     # Test modifications by gmillam
     def setup
@@ -723,13 +796,16 @@ module TestPageTemplate
       assert_equal('4',w.output(p.namespace))
       assert_equal('',v.output(p.namespace))
     end
+
     def test_raise_on_error
       p = PageTemplate::Parser.new
       template = p.parse("[% var foo.bar %]")
       foo = "hello"
+
       def foo.bar
         asdf # method unknown error
       end
+
       template["foo"] = foo
       assert_equal(
         template.output,
@@ -743,6 +819,7 @@ module TestPageTemplate
     rescue Exception => er
       puts "error: #{er.class}"
     end
+
   end
 end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: PageTemplate
 version: !ruby/object:Gem::Version 
-  version: 2.1.7
-date: 2006-02-20 00:00:00 -08:00
+  version: 2.2.0
+date: 2006-03-02 00:00:00 -08:00
 summary: A simple templating system for Web sites.
 require_paths: 
 - lib
@@ -29,6 +29,7 @@ authors:
 - Brian Wisti
 files: 
 - Changes
+- doc
 - lib
 - MANIFEST
 - Rakefile
@@ -39,6 +40,159 @@ files:
 - tdata
 - test-install.rb
 - test.rb
+- doc/classes
+- doc/created.rid
+- doc/files
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/rdoc-style.css
+- doc/classes/PageTemplate
+- doc/classes/PageTemplate.html
+- doc/classes/PageTemplate.src
+- doc/classes/PageTemplate/BlockCommand.html
+- doc/classes/PageTemplate/BlockCommand.src
+- doc/classes/PageTemplate/CaseCommand.html
+- doc/classes/PageTemplate/CaseCommand.src
+- doc/classes/PageTemplate/Command.html
+- doc/classes/PageTemplate/Command.src
+- doc/classes/PageTemplate/CommentCommand.html
+- doc/classes/PageTemplate/CommentCommand.src
+- doc/classes/PageTemplate/DefaultGlossary.html
+- doc/classes/PageTemplate/DefaultPreprocessor.html
+- doc/classes/PageTemplate/DefaultPreprocessor.src
+- doc/classes/PageTemplate/DefineCommand.html
+- doc/classes/PageTemplate/DefineCommand.src
+- doc/classes/PageTemplate/FileSource.html
+- doc/classes/PageTemplate/FileSource.src
+- doc/classes/PageTemplate/FilterCommand.html
+- doc/classes/PageTemplate/FilterCommand.src
+- doc/classes/PageTemplate/HTGlossary.html
+- doc/classes/PageTemplate/IfCommand.html
+- doc/classes/PageTemplate/IfCommand.src
+- doc/classes/PageTemplate/IncludeCommand.html
+- doc/classes/PageTemplate/IncludeCommand.src
+- doc/classes/PageTemplate/LoopCommand.html
+- doc/classes/PageTemplate/LoopCommand.src
+- doc/classes/PageTemplate/Namespace.html
+- doc/classes/PageTemplate/Namespace.src
+- doc/classes/PageTemplate/NamespaceItem.html
+- doc/classes/PageTemplate/NamespaceItem.src
+- doc/classes/PageTemplate/Parser.html
+- doc/classes/PageTemplate/Parser.src
+- doc/classes/PageTemplate/Preprocessor.html
+- doc/classes/PageTemplate/Source.html
+- doc/classes/PageTemplate/Source.src
+- doc/classes/PageTemplate/StackableCommand.html
+- doc/classes/PageTemplate/StackableCommand.src
+- doc/classes/PageTemplate/StringSource.html
+- doc/classes/PageTemplate/StringSource.src
+- doc/classes/PageTemplate/SyntaxGlossary.html
+- doc/classes/PageTemplate/SyntaxGlossary.src
+- doc/classes/PageTemplate/Template.html
+- doc/classes/PageTemplate/Template.src
+- doc/classes/PageTemplate/TextCommand.html
+- doc/classes/PageTemplate/TextCommand.src
+- doc/classes/PageTemplate/UnknownCommand.html
+- doc/classes/PageTemplate/UnknownCommand.src
+- doc/classes/PageTemplate/ValueCommand.html
+- doc/classes/PageTemplate/ValueCommand.src
+- doc/classes/PageTemplate/BlockCommand.src/M000020.html
+- doc/classes/PageTemplate/BlockCommand.src/M000021.html
+- doc/classes/PageTemplate/BlockCommand.src/M000022.html
+- doc/classes/PageTemplate/BlockCommand.src/M000023.html
+- doc/classes/PageTemplate/BlockCommand.src/M000024.html
+- doc/classes/PageTemplate/CaseCommand.src/M000085.html
+- doc/classes/PageTemplate/CaseCommand.src/M000086.html
+- doc/classes/PageTemplate/CaseCommand.src/M000087.html
+- doc/classes/PageTemplate/CaseCommand.src/M000088.html
+- doc/classes/PageTemplate/CaseCommand.src/M000089.html
+- doc/classes/PageTemplate/CaseCommand.src/M000090.html
+- doc/classes/PageTemplate/Command.src/M000045.html
+- doc/classes/PageTemplate/Command.src/M000046.html
+- doc/classes/PageTemplate/CommentCommand.src/M000028.html
+- doc/classes/PageTemplate/CommentCommand.src/M000029.html
+- doc/classes/PageTemplate/CommentCommand.src/M000030.html
+- doc/classes/PageTemplate/DefaultPreprocessor.src/M000074.html
+- doc/classes/PageTemplate/DefaultPreprocessor.src/M000075.html
+- doc/classes/PageTemplate/DefaultPreprocessor.src/M000076.html
+- doc/classes/PageTemplate/DefaultPreprocessor.src/M000077.html
+- doc/classes/PageTemplate/DefaultPreprocessor.src/M000078.html
+- doc/classes/PageTemplate/DefineCommand.src/M000079.html
+- doc/classes/PageTemplate/DefineCommand.src/M000080.html
+- doc/classes/PageTemplate/FileSource.src/M000016.html
+- doc/classes/PageTemplate/FileSource.src/M000017.html
+- doc/classes/PageTemplate/FileSource.src/M000018.html
+- doc/classes/PageTemplate/FileSource.src/M000019.html
+- doc/classes/PageTemplate/FilterCommand.src/M000065.html
+- doc/classes/PageTemplate/FilterCommand.src/M000066.html
+- doc/classes/PageTemplate/FilterCommand.src/M000067.html
+- doc/classes/PageTemplate/IfCommand.src/M000059.html
+- doc/classes/PageTemplate/IfCommand.src/M000060.html
+- doc/classes/PageTemplate/IfCommand.src/M000061.html
+- doc/classes/PageTemplate/IfCommand.src/M000062.html
+- doc/classes/PageTemplate/IfCommand.src/M000063.html
+- doc/classes/PageTemplate/IfCommand.src/M000064.html
+- doc/classes/PageTemplate/IncludeCommand.src/M000039.html
+- doc/classes/PageTemplate/IncludeCommand.src/M000040.html
+- doc/classes/PageTemplate/IncludeCommand.src/M000041.html
+- doc/classes/PageTemplate/LoopCommand.src/M000011.html
+- doc/classes/PageTemplate/LoopCommand.src/M000012.html
+- doc/classes/PageTemplate/LoopCommand.src/M000013.html
+- doc/classes/PageTemplate/LoopCommand.src/M000014.html
+- doc/classes/PageTemplate/LoopCommand.src/M000015.html
+- doc/classes/PageTemplate/Namespace.src/M000057.html
+- doc/classes/PageTemplate/Namespace.src/M000058.html
+- doc/classes/PageTemplate/NamespaceItem.src/M000002.html
+- doc/classes/PageTemplate/NamespaceItem.src/M000004.html
+- doc/classes/PageTemplate/NamespaceItem.src/M000006.html
+- doc/classes/PageTemplate/NamespaceItem.src/M000008.html
+- doc/classes/PageTemplate/NamespaceItem.src/M000009.html
+- doc/classes/PageTemplate/NamespaceItem.src/M000010.html
+- doc/classes/PageTemplate/Parser.src/M000031.html
+- doc/classes/PageTemplate/Parser.src/M000032.html
+- doc/classes/PageTemplate/Parser.src/M000033.html
+- doc/classes/PageTemplate/Parser.src/M000034.html
+- doc/classes/PageTemplate/Parser.src/M000035.html
+- doc/classes/PageTemplate/Parser.src/M000036.html
+- doc/classes/PageTemplate/Parser.src/M000037.html
+- doc/classes/PageTemplate/Parser.src/M000038.html
+- doc/classes/PageTemplate/Source.src/M000055.html
+- doc/classes/PageTemplate/Source.src/M000056.html
+- doc/classes/PageTemplate/StackableCommand.src/M000081.html
+- doc/classes/PageTemplate/StackableCommand.src/M000082.html
+- doc/classes/PageTemplate/StackableCommand.src/M000083.html
+- doc/classes/PageTemplate/StackableCommand.src/M000084.html
+- doc/classes/PageTemplate/StringSource.src/M000053.html
+- doc/classes/PageTemplate/StringSource.src/M000054.html
+- doc/classes/PageTemplate/SyntaxGlossary.src/M000047.html
+- doc/classes/PageTemplate/SyntaxGlossary.src/M000048.html
+- doc/classes/PageTemplate/SyntaxGlossary.src/M000049.html
+- doc/classes/PageTemplate/SyntaxGlossary.src/M000050.html
+- doc/classes/PageTemplate/SyntaxGlossary.src/M000051.html
+- doc/classes/PageTemplate/SyntaxGlossary.src/M000052.html
+- doc/classes/PageTemplate/Template.src/M000071.html
+- doc/classes/PageTemplate/Template.src/M000072.html
+- doc/classes/PageTemplate/Template.src/M000073.html
+- doc/classes/PageTemplate/TextCommand.src/M000068.html
+- doc/classes/PageTemplate/TextCommand.src/M000069.html
+- doc/classes/PageTemplate/TextCommand.src/M000070.html
+- doc/classes/PageTemplate/UnknownCommand.src/M000025.html
+- doc/classes/PageTemplate/UnknownCommand.src/M000026.html
+- doc/classes/PageTemplate/UnknownCommand.src/M000027.html
+- doc/classes/PageTemplate/ValueCommand.src/M000042.html
+- doc/classes/PageTemplate/ValueCommand.src/M000043.html
+- doc/classes/PageTemplate/ValueCommand.src/M000044.html
+- doc/classes/PageTemplate.src/M000001.html
+- doc/files/lib
+- doc/files/README_txt.html
+- doc/files/lib/PageTemplate
+- doc/files/lib/PageTemplate_rb.html
+- doc/files/lib/PageTemplate/case_rb.html
+- doc/files/lib/PageTemplate/commands_rb.html
+- doc/files/lib/PageTemplate/htglossary_rb.html
+- doc/files/lib/PageTemplate/parser_rb.html
 - lib/PageTemplate
 - lib/PageTemplate.rb
 - lib/PageTemplate/case.rb
@@ -72,6 +226,9 @@ files:
 - site/src/SiteMap
 - site/src/version2
 - tdata/dummy.txt
+- tdata/include.txt
+- tdata/include2.txt
+- tdata/variable.txt
 test_files: 
 - test.rb
 rdoc_options: []