RubyGems - flott - Versions diffs - 1.0.0 - Mend

flott 1.0.0

Files changed (31) hide show

data/.gitignore +5 -0
data/.travis.yml +16 -0
data/Gemfile +9 -0
data/README.rdoc +76 -0
data/Rakefile +25 -0
data/VERSION +1 -0
data/benchmarks/data/.keep +0 -0
data/benchmarks/flott_benchmark.rb +165 -0
data/benchmarks/runner.rb +6 -0
data/doc-main.txt +76 -0
data/flott.gemspec +41 -0
data/install.rb +16 -0
data/lib/flott.rb +1016 -0
data/lib/flott/cache.rb +99 -0
data/lib/flott/version.rb +8 -0
data/make_doc.rb +5 -0
data/tests/templates/header +8 -0
data/tests/templates/subdir/deeptemplate +6 -0
data/tests/templates/subdir/included +9 -0
data/tests/templates/subdir/subdir2/deepincluded2 +2 -0
data/tests/templates/subdir/subdir2/included2 +1 -0
data/tests/templates/subdir/subdir3/included3 +1 -0
data/tests/templates/template +12 -0
data/tests/templates/template2 +6 -0
data/tests/templates/toplevel +2 -0
data/tests/templates/toplevel2 +1 -0
data/tests/test_cache.rb +70 -0
data/tests/test_flott.rb +200 -0
data/tests/test_flott_file.rb +155 -0
data/tests/test_helper.rb +3 -0
metadata +153 -0

data/lib/flott/cache.rb ADDED Viewed

@@ -0,0 +1,99 @@
+module Flott
+  class Cache
+    # A Page object that encapsulates a compiled template.
+    class Page
+      # Creates a Page object for the template that can be found at
+      # path _path_.
+      def initialize(cache, path)
+        @cache  = cache
+        @path   = path
+        compile
+      end
+      # Returns the compiled template or nil if the template
+      # hasn't been compiled.
+      attr_reader :template
+      # If the file at _path_ has changed this method
+      # returns true. It always returns true, if the attribute
+      # _reload_time_ is set to a value < 0. If
+      # _reload_time_ is set to a value >= 0, it will
+      # return true only after _reload_time_ seconds (before that
+      # time has passed nil is returned), even if the file has changed.
+      def changed?
+        return true if @cache.reload_time and @cache.reload_time < 0
+        if @cache.reload_time and Time.now - @template.mtime < @cache.reload_time
+          return
+        end
+        @template.mtime != @mtime
+      end
+      # Returns the path to this page, with the prepended rootdir of the Cache
+      # instance of this page.
+      def rootpath
+        File.join(@cache.rootdir, @path)
+      end
+      # Compile the file at _path_ with a Flott instance and return it. This
+      # implies that the _template_ attribute is set to the return value for
+      # later reuse without compiling.
+      def compile
+        @template = Flott.compile(File.read(rootpath), File.dirname(rootpath), @cache.rootdir, rootpath)
+        @template.page_cache = @cache
+        @mtime    = @template.mtime
+        @template
+      end
+    end
+    # Creates a Cache that compiles and caches the template files under
+    # _rootdir_. If _reload_time_ in seconds is given,
+    # the template files are only reloaded after _reload_time_
+    # seconds even if changed. Negative _reload_time_ means, reload
+    # the file always, even if unchanged. (This is good for development, think
+    # of changed included templates.)
+    def initialize(rootdir, reload_time = nil)
+      @rootdir      = rootdir
+      @reload_time  = reload_time
+      @pages        = {}
+    end
+    # Reload time in seconds for the template files of this Cache.
+    attr_accessor :reload_time
+    attr_reader :rootdir
+    # Return the page that was compiled and/or cached with the name
+    # _name_. If block is given the page is yielded to instead.
+    def get(name)
+      page = @pages[name]
+      if page
+        if page.changed?
+          page.compile
+        end
+      else
+        page = Page.new(self, name)
+        page.compile
+        put(name, page)
+      end
+      if block_given?
+        yield page.template
+        self
+      else
+        return page.template
+      end
+    rescue Errno::ENOENT, Errno::EISDIR
+    end
+    # Return the cached page _name_, evaluated in the Environment _env_.
+    def evaluate(name, env = Environment.new)
+      get(name) { |template| template.evaluate(env) } or return
+      self
+    end
+    # Puts _page_ into the cache using the key _name_.
+    def put(name, page)
+      @pages[name] = page
+    end
+    private :put
+  end
+end

data/lib/flott/version.rb ADDED Viewed

@@ -0,0 +1,8 @@
+module Flott
+  # Flott version
+  VERSION         = '1.0.0'
+  VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
+  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+end

data/make_doc.rb ADDED Viewed

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$outdir = 'doc/'
+puts "Creating documentation in '#$outdir'."
+system "rdoc -m doc-main.txt -o #$outdir doc-main.txt lib/flott.rb lib/flott/*.rb"

data/tests/templates/header ADDED Viewed

@@ -0,0 +1,8 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+   "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+ <head>
+  <title>Hello [=@name]!</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-15">
+ </head>
+ <body>

data/tests/templates/subdir/deeptemplate ADDED Viewed

@@ -0,0 +1,6 @@
+<html>
+<body>
+[^subdir2/deepincluded2]
+[include 'subdir2/deepincluded2']
+[include '/toplevel2']</body>
+</html>

data/tests/templates/subdir/included ADDED Viewed

@@ -0,0 +1,9 @@
+Workdir 1 (included): [=workdir]
+[^/toplevel]
+Workdir 2 (included): [=workdir]
+[^subdir2/included2]
+Workdir 3 (included): [=workdir]
+[include "subdir3/included3"]
+Workdir 4 (included): [=workdir]
+[include "/toplevel"]
+Workdir 5 (included): [=workdir]

data/tests/templates/subdir/subdir2/deepincluded2 ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ [^/toplevel2]
2	+ (deepincluded2)

data/tests/templates/subdir/subdir2/included2 ADDED Viewed

	@@ -0,0 +1 @@
1	+ Workdir (included2): [=workdir]

data/tests/templates/subdir/subdir3/included3 ADDED Viewed

	@@ -0,0 +1 @@
1	+ Workdir (included3): [=workdir]

data/tests/templates/template ADDED Viewed

@@ -0,0 +1,12 @@
+[^header]
+ <h1>Hello [=@name]\[!</h1>
+ [for i in 1..6
+   if i % 2 == 0]
+     <b>Hello [=@name + "\]"]!</b>
+   [else]
+     <i>Hello [!@name + "\]"]!</i>
+   [end
+ end]
+ [a = [1, "\[", 3]]
+ </body>[#Commented out] ]
+</html>

data/tests/templates/template2 ADDED Viewed

@@ -0,0 +1,6 @@
+[^header-]
+Workdir before (template2): [=workdir]
+[^subdir/included]
+Workdir after (template2): [=workdir]
+</body>
+</html>

data/tests/templates/toplevel ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ Toplevel
2	+ Workdir (toplevel): [=workdir]

data/tests/templates/toplevel2 ADDED Viewed

	@@ -0,0 +1 @@
1	+ Toplevel2

data/tests/test_cache.rb ADDED Viewed

@@ -0,0 +1,70 @@
+require 'test_helper'
+require 'flott'
+require 'stringio'
+require 'fileutils'
+class TC_Cache < Test::Unit::TestCase
+  include FileUtils
+  include Flott
+  TEMPLATES_DIR = File.join(File.dirname(__FILE__), 'templates')
+  def setup
+    @cache = Cache.new(TEMPLATES_DIR, 2)
+  end
+  def test_kind
+    assert_kind_of Cache, @cache
+  end
+  def test_get
+    template = @cache.get('template')
+    assert_kind_of Template, template
+    assert_equal template, @cache.get('template')
+    assert_equal template, @cache.get('template')
+  end
+  def test_reload
+    template = @cache.get('template')
+    assert_equal template, @cache.get('template')
+    assert_equal template, @cache.get('template')
+    sleep 1.0
+    touch File.join(TEMPLATES_DIR, 'template')
+    assert_equal template, @cache.get('template')
+    sleep 3.0
+    assert template != @cache.get('template')
+    template = @cache.get('template')
+    touch File.join(TEMPLATES_DIR, 'template')
+    assert_equal template, @cache.get('template')
+    template2 = @cache.get('template2')
+    assert_kind_of Template, template2
+    assert_equal template2, @cache.get('template2')
+    @cache.reload_time = -1
+    template = @cache.get('template')
+    assert template != @cache.get('template')
+  end
+  def test_get_deep
+    template = @cache.get('subdir/deeptemplate')
+    assert_kind_of Template, template
+    assert_equal template, @cache.get('subdir/deeptemplate')
+    assert_equal template, @cache.get('subdir/deeptemplate')
+    output = ''
+    template.evaluate(Environment.new(output))
+    assert_equal <<__EOT, output
+<html>
+<body>
+Toplevel2
+(deepincluded2)
+Toplevel2
+(deepincluded2)
+Toplevel2
+</body>
+</html>
+__EOT
+  end
+end

data/tests/test_flott.rb ADDED Viewed

@@ -0,0 +1,200 @@
+require 'test_helper'
+require 'flott'
+require 'stringio'
+class TC_Flott < Test::Unit::TestCase
+  include Flott
+  def assert_template_equal(expected, template, hash = {})
+    output = ''
+    env = Environment.new(output)
+    env.update hash
+    parser = Parser.new(template)
+    parser.evaluate(env)
+    assert_equal expected, output
+  end
+  def test_error
+    assert_raises(CallError) do
+      Parser.new('<bla>[= [^/bla>').evaluate
+    end
+    assert_raises(CallError) do
+      Parser.new('<bla>[^/bla>').evaluate
+    end
+    assert_raises(CompileError) do
+      Parser.new('<bla>[^does_not_exist]</bla>').evaluate
+    end
+  end
+  def test_for_errors
+    assert_template_equal 'puts "\n"', 'puts "\n"'
+    if RUBY_VERSION =~ /\A1.[0-8]/
+      assert_template_equal "123\n", '[print [1, 2, "3"], "\n" ]'
+    else
+      assert_template_equal "[1, 2, &quot;3&quot;]\n", '[print [1, 2, "3"], "\n" ]'
+    end
+    assert_template_equal "a\b", '[print "a\b" ]' # 1
+    assert_template_equal "a\b", '[print "a\\b" ]' # 2
+    assert_template_equal "a\\b", '[print "a\\\b" ]' # 3
+    assert_template_equal "a\\b", '[print "a\\\\b" ]' # 4
+    assert_template_equal "a\\\b", '[print "a\\\\\b" ]' # 5
+    assert_template_equal "a\\\b", '[print "a\\\\\\b" ]' # 6
+    assert_template_equal "a\\\\b", '[print "a\\\\\\\\b" ]' # 7
+    assert_template_equal "a\\\\\b", '[print "a\\\\\\\\\b" ]' # 8
+    assert_template_equal "a\\\\\b", '[print "a\\\\\\\\\\b" ]' # 9
+    assert_template_equal "puts [1, 2, '3']", "puts \\[1, 2, '3']"
+    assert_template_equal "puts {1, 2}", "puts {1, 2}"
+    assert_template_equal "puts {1, 2}", "puts {1, [=1+1]}"
+    assert_template_equal "puts {'1', 2}", "puts {'1', [=1+1]}"
+    assert_template_equal "lambda { |x| '", "lambda { |x| '"
+    assert_template_equal "}", "}"
+    assert_template_equal "{}}", "{}}"
+    assert_template_equal "", "[lambda {}]"
+    assert_template_equal "foo", "[=lambda {:foo}.call]"
+  end
+  def test_fun
+    assert_template_equal("\nAAA3628800BBB\n", <<__EOT)
+[fun :fac do |n|
+  if n < 2
+    1
+  else
+    n * fac(n - 1)
+  end
+end]
+AAA[=fac(10)]BBB
+__EOT
+    assert_template_equal("false\n\ntrue\n", <<__EOT)
+[=respond_to? :foobar]
+[=fun :foobar do end]
+[=respond_to? :foobar]
+__EOT
+  end
+  def test_environment_instance_variables
+    env = Environment.new
+    env.output = output = ''
+    assert_equal ["@__escape__", "@__output__"].sort,
+      env.instance_variables.map { |x| x.to_s }.sort
+    env[:foo] = :foo
+    assert_equal ["@__escape__", "@__output__", "@foo"].sort,
+      env.instance_variables.map { |x| x.to_s }.sort
+    assert_equal env[:foo], :foo
+    assert_equal env[:@foo], :foo
+    env[:@bar] = :bar
+    assert_equal ["@__escape__", "@__output__", "@bar", "@foo"].sort,
+      env.instance_variables.map { |x| x.to_s }.sort
+    assert_equal env[:bar], :bar
+    assert_equal env[:@bar], :bar
+    env.update({ :baz => :baz })
+    assert_equal ["@__escape__", "@__output__", "@bar", "@baz", "@foo"].sort,
+      env.instance_variables.map { |x| x.to_s }.sort
+    assert_equal env[:baz], :baz
+    assert_equal env[:@baz], :baz
+    assert_equal env[:__output__], output
+    assert_equal env.output, output
+  end
+  class MyEnvironment < Array
+    include Flott::EnvironmentMixin
+    # or explicitly:
+    #def initialize(*)
+    #  super
+    #end
+  end
+  def test_my_environment
+    env = MyEnvironment.new
+    assert_kind_of Array, env
+    assert_kind_of Flott::EnvironmentMixin, env
+  end
+  def test_p
+    assert_template_equal %Q'AAA[1, :foo, &quot;bar&quot;]\nBBB', 'AAA[p [1, :foo, "bar"]]BBB'
+  end
+  def test_p_bang
+    assert_template_equal %Q'AAA[1, :foo, "bar"]\nBBB', 'AAA[p! [1, :foo, "bar"]]BBB'
+  end
+  def test_pp
+    assert_template_equal %Q'AAA[1, :foo, &quot;bar&quot;]\nBBB', 'AAA[pp [1, :foo, "bar"]]BBB'
+  end
+  def test_pp_bang
+    assert_template_equal %Q'AAA[1, :foo, "bar"]\nBBB', 'AAA[pp! [1, :foo, "bar"]]BBB'
+  end
+  def test_puts_bang
+    assert_template_equal %Q'AAA<BBB>\nCCC', 'AAA[puts! "<BBB>"]CCC'
+  end
+  def test_puts
+    assert_template_equal %Q'AAA&lt;BBB&gt;\nCCC', 'AAA[puts "<BBB>"]CCC'
+  end
+  def test_putc_bang
+    assert_template_equal %Q'AAA<CCC', 'AAA[putc! "<BBB>"]CCC'
+    assert_template_equal %Q'AAA<CCC', 'AAA[putc! ?<]CCC'
+  end
+  def test_putc
+    assert_template_equal %Q'AAA&lt;CCC', 'AAA[putc "<BBB>"]CCC'
+    assert_template_equal %Q'AAA&lt;CCC', 'AAA[putc ?<]CCC'
+  end
+  def test_printf_bang
+    assert_template_equal %Q'AAA<B42BB>CCC', 'AAA[printf! "<B%xBB>", 66]CCC'
+  end
+  def test_printf
+    assert_template_equal %Q'AAA&lt;B42BB&gt;CCC', 'AAA[printf "<B%xBB>", 66]CCC'
+  end
+  def test_print_bang
+    assert_template_equal %Q'AAA<BBB>CCC', 'AAA[print! "<BBB>"]CCC'
+  end
+  def test_print
+    assert_template_equal %Q'AAA&lt;BBB&gt;CCC', 'AAA[print "<BBB>"]CCC'
+  end
+  def test_write_bang
+    assert_template_equal %Q'AAA<BBB>CCC', 'AAA[write! "<BBB>"]CCC'
+  end
+  def test_write
+    assert_template_equal %Q'AAA&lt;BBB&gt;CCC', 'AAA[write "<BBB>"]CCC'
+  end
+  def test_minus
+    assert_template_equal "a\nb\nc", "a\n[print 'b']\nc"
+    assert_template_equal "a \t b \t c", "a \t [print 'b'] \t c"
+    assert_template_equal "a\nb\nc", "a\n \t [-print 'b']\nc"
+    assert_template_equal "a\nb \t c", "a\n \t [-print 'b'] \t c"
+    assert_template_equal "a\n \t bc", "a\n \t [print 'b'-] \t \nc"
+    assert_template_equal "abc", "a \t [-print 'b'-]\nc"
+    assert_template_equal "a\n&lt;bc", "a\n \t [-='<b'-] \t \nc"
+    assert_template_equal "a\n<bc", "a\n \t [-!'<b'-] \t \nc"
+    assert_template_equal "a\nc", "a\n \t [-#'<b'-] \t \nc"
+    assert_template_equal <<DST, <<SRC
+<ul>
+  <li>1</li>
+  <li>2</li>
+  <li>3</li>
+</ul>
+DST
+<ul>
+  [-3.times do |i|-]
+  <li>[=i + 1]</li>
+  [-end-]
+</ul>
+SRC
+  end
+  def test_function
+    assert_template_equal "AAABB", "[=function :multiple do |x, n| x * n end;multiple 'A', 3][=multiple 'B', 2]"
+    assert_template_equal "AAABB", "[=function :multiple, :memoize => 3 do |x, n| x * n end;multiple 'A', 3][=multiple 'B', 2]"
+  end
+end