nagoro 2009.05 → 2013.03

data/MANIFEST

@@ -1,3 +1,4 @@
+AUTHORS
 CHANGELOG
 MANIFEST
 README.markdown
@@ -39,12 +40,10 @@ spec/nagoro/pipe/tidy.rb
 spec/nagoro/template.rb
 spec/nagoro/template/full.nag
 spec/nagoro/template/hello.nag
+tasks/authors.rake
 tasks/bacon.rake
 tasks/changelog.rake
 tasks/gem.rake
-tasks/gem_installer.rake
-tasks/grancher.rake
-tasks/install_dependencies.rake
 tasks/manifest.rake
 tasks/rcov.rake
 tasks/release.rake

data/README.markdown

@@ -3,14 +3,17 @@
 
 # About Nagoro
 
-Nagoro is a templating engine for XHTML based on different parsing engines.
-It featues a modular code layout and is used in the Ramaze web framework.
+Nagoro is a templating engine for HTML and XML, consequently also for XHTML.
 
 Nagoro consists of a series of so-called pipes to produce valid ruby from the
 templates that are eventually evaluated with custom binding.
 
 All functionality of Nagoro is carefully tested by a series of specs to avoid
-breakage and give a good overview of nagoros capabilities.
+breakage and give a good overview of Nagoro's capabilities.
+
+Parsing is done by a fine-tuned StringScanner that avoids actually checking
+validity of the documents, this way you can use Ruby interpolation without
+having to enclose it into CDATA sections.
 
 # Features Overview
 
@@ -157,6 +160,55 @@ And of course the same works for `Nagoro::render`.
 Examples can be found in the /example directory.
 
 
+# Future plans
+
+## Various backends
+
+Using Nokogiri, Hpricot, REXML, or libxml-ruby as backends for Nagoro.
+
+I actually implemented backends in REXML and libxml-ruby in previous versions
+of Nagoro, but their insistence on well-formed markup made them unsuitable for
+the style of interpolation required.
+
+As a quick example, given a document that contains `<h1>#{1 < 10}</h1>`.
+
+Nokogiri would produce `<h1>#{1</h1>` in HTML mode. In XML mode it will produce
+`<h1>#{1  10}</h1>`. Both are useless interpretations of the document.
+
+The libxml-ruby binding doesn't allow for relaxed parsing, and will fail to
+parse. Since it's just a thin binding, there is no way to monkeypatch the
+underlying parser, while it might still be possible to achieve something
+similar using FFI or DL, the way that Nokogiri parses leaves me little hope
+that I could actually bend it to my will.
+
+REXML usually fails as well, and the monkeypatching required to make it parse
+the input document would far exceed the amount of code required for our custom
+parser, not to mention that the speed of REXML would still be very hard to
+tolerate, the only argument for it seems to be that it's in stdlib.
+
+Hpricot on the other hand doesn't provide a SaX API, and so isn't suited very
+well to the pipe style of Nagoro, but is still the best candidate as it will
+parse Nagoro documents correctly (in most cases).
+
+That's just a quick run-down, I spent almost 2 weeks banging my head against
+REXML and libxml-ruby.
+The reason I avoided Hpricot is that I don't want to have a full Node
+representation in memory, it's already questionable if having the whole
+document as a String in memory is a good design choice.
+
+## Stream parsing
+
+This is impossible with StringScanner, it is hard-wired to check that you
+actually give it a String (in C via the StringValue macro).
+It would be possible with real SaX parser, but due to their limitations pointed
+out above, we cannot use them.
+
+An option would be to implement a parser in pure Ruby.
+I will leave that to other people, the documents I process fit comfortably into
+memory, and if you are processing larger documents, you will most likely have
+to utilize something like XSLT.
+
+
 # And thanks to...
 
 This list is by no means a full listing of all these people, but I try to
@@ -174,7 +226,7 @@ get a good coverage despite that.
 * George Moschovitis a.k.a. gmosx
 
   For the Nitro web framework. Its templating engine has been the inspiration
-  for nagoro.
+  for Nagoro.
 
 * Jonathan Buch a.k.a. Kashia
 

data/Rakefile

@@ -1,12 +1,11 @@
-require 'rake'
 require 'rake/clean'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 require 'time'
 require 'date'
 
 PROJECT_SPECS = Dir['spec/{nagoro,example}/**/*.rb']
 PROJECT_MODULE = 'Nagoro'
-PROJECT_VERSION = ENV['VERSION'] || Date.today.strftime("%Y.%m.%d")
+PROJECT_VERSION = (ENV['VERSION'] || Date.today.strftime('%Y.%m.%d')).dup
 
 GEMSPEC = Gem::Specification.new{|s|
   s.name         = 'nagoro'

data/example/morpher.nag

@@ -6,12 +6,12 @@
     <?r list = [true, false, true] ?>
 
     True items in list:
-    <div for="cond in list">
+    <div foreach="cond in list">
       <h1 if="cond">#{cond}</h1>
     </div>
 
     False items in list:
-    <div for="cond in list">
+    <div foreach="cond in list">
       <h1 unless="cond">#{cond}</h1>
     </div>
 

data/lib/nagoro/pipe/base.rb

@@ -1,9 +1,6 @@
 module Nagoro
   module Pipe
     class Base
-      EMPTY_TAG = %w[ area base basefont br col frame hr
-                      img input isindex link meta param ]
-
       def initialize(io)
         @body, @stack = [], []
         @scanner = Scanner.new(io, self)
@@ -14,21 +11,16 @@ module Nagoro
         @body.join
       end
 
+      def tag(tag, original_attrs, value_attrs)
+        append "#{tag_with(tag, original_attrs)} />"
+      end
+
       def tag_start(tag, original_attrs, value_attrs)
-        case tag
-        when *EMPTY_TAG
-          append "#{tag_with(tag, original_attrs)} />"
-        else
-          append "#{tag_with(tag, original_attrs)}>"
-        end
+        append "#{tag_with(tag, original_attrs)}>"
       end
 
       def tag_end(tag)
-        case tag
-        when *EMPTY_TAG
-        else
-          append "</#{tag}>"
-        end
+        append "</#{tag}>"
       end
 
       def text(string)
@@ -44,7 +36,7 @@ module Nagoro
       end
 
       def tag_with(tag, hash)
-        "<#{tag}#{hash.map{|k,v| %( #{k}=#{v}) }.join}"
+        "<#{tag}#{hash.map{|k,v| (v == nil) ? %( #{k}) : %( #{k}=#{v}) }.join}"
       end
 
       def doctype(string)

data/lib/nagoro/pipe/element.rb

@@ -14,6 +14,29 @@ module Nagoro
       class ElementStruct < Struct.new(:tag, :attrs, :element, :content)
       end
 
+      def tag(tag, original_attrs, value_attrs)
+        if element = ELEMENTS[tag]
+          estruct = ElementStruct.new(tag, value_attrs, element, [])
+        elsif tag =~ /^[A-Z]/
+          warn "Element: '<#{tag}>' not found."
+          super
+        else
+          super
+        end
+
+        if estruct
+          attrs, element, content = estruct.values_at(1..3)
+
+          if element.respond_to?(:call)
+            append element.call(content.join, attrs)
+          else
+            instance = element.new(content.join)
+            instance.params = translate_attrs(instance, estruct.attrs)
+            append instance.render
+          end
+        end
+      end
+
       def tag_start(tag, original_attrs, value_attrs)
         if element = ELEMENTS[tag]
           @stack << ElementStruct.new(tag, value_attrs, element, [])

data/lib/nagoro/pipe/include.rb

@@ -12,6 +12,15 @@ module Nagoro
     #   <include src="some_file.xhtml" />
 
     class Include < Base
+      def tag(tag, original_attrs, value_attrs)
+        if tag == 'include'
+          filename = value_attrs['href'] || value_attrs.fetch('src')
+          append contents(filename)
+        else
+          super
+        end
+      end
+
       def tag_start(tag, original_attrs, value_attrs)
         if tag == 'include'
           filename = value_attrs['href'] || value_attrs.fetch('src')

data/lib/nagoro/pipe/morph.rb

@@ -49,7 +49,7 @@ module Nagoro
       MORPHS = {
         'each'    => [ '<?r %expression.%morph do |_e| ?>', '<?r end ?>' ],
         'times'   => [ '<?r %expression.%morph do |_t| ?>', '<?r end ?>' ],
-        'filter'  => [ '<?o %expression(%<', '>) ?>' ],
+        'filter'  => [ '<?r %expression(%<', '>) ?>' ],
         'if'      => [ '<?r %morph %expression ?>', '<?r end ?>' ],
         'unless'  => [ '<?r %morph %expression ?>', '<?r end ?>' ],
         'foreach' => [ '<?r for %expression ?>', '<?r end ?>' ],

data/lib/nagoro/scanner.rb

@@ -2,14 +2,16 @@ require 'strscan'
 
 module Nagoro
   class Scanner < StringScanner
-    TEXT = /[^<>]+/m
+    TEXT = /[^<>#]+/m
+    HASH_TEXT = /#[^\{<]#{TEXT}/m
+    HASH_CHAR = /#/
     DOCTYPE = /<!DOCTYPE([^>]+)>/m
 
     TAG_START       = /<([^\s>]+)/
     TAG_END         = /<\/([^>]*)>/
     TAG_OPEN_END    = /\s*>/
     TAG_CLOSING_END = /\s*\/>/
-    TAG_PARAMETER   = /\s*([^\s]*)=((['"])(.*?)\3)/um
+    TAG_PARAMETER   = /\s*([^\s=]*)=((['"])(.*?)\3)/um
 
     INSTRUCTION_START = /<\?(\S+)/
     INSTRUCTION_END   = /(.*?)(\?>)/um
@@ -18,6 +20,7 @@ module Nagoro
     RUBY_INTERP_TEXT  = /[^\{\}]+/m
     RUBY_INTERP_NEST  = /\{[^\}]*\}/m
     RUBY_INTERP_END   = /(?=\})/
+    RUBY_TAG_INTERP   = /\s*(#\{.*?\})/m
 
     COMMENT = /<!--.*?-->/m
 
@@ -42,6 +45,7 @@ module Nagoro
       elsif scan(RUBY_INTERP_START); ruby_interp(matched)
       elsif scan(TAG_START        ); tag_start(self[1])
       elsif scan(TEXT             ); text(matched)
+      elsif scan(HASH_CHAR        ); hash_char(matched)
       end
     end
 
@@ -70,14 +74,22 @@ module Nagoro
       original_attrs = {}
       value_attrs = {}
 
-      while scan(TAG_PARAMETER)
-        original_attrs[self[1]] = self[2] # <a href="foo"> gives 'href'=>'"foo"'
-        value_attrs[   self[1]] = self[4] # <a href="foo"> gives 'href'=>'foo'
+      done = false
+      while not done
+        if scan(RUBY_TAG_INTERP)
+          original_attrs[self[1]] = nil
+          value_attrs[self[1]] = nil
+        elsif scan(TAG_PARAMETER)
+          original_attrs[self[1]] = self[2] # <a href="foo"> gives 'href'=>'"foo"'
+          value_attrs[   self[1]] = self[4] # <a href="foo"> gives 'href'=>'foo'
+        elsif scan(TAG_CLOSING_END)
+          @callback.tag(name, original_attrs, value_attrs)
+          done = true
+        elsif scan(TAG_OPEN_END)
+          @callback.tag_start(name, original_attrs, value_attrs)
+          done = true
+        end
       end
-
-      @callback.tag_start(name, original_attrs, value_attrs)
-      return @callback.tag_end(name) if scan(TAG_CLOSING_END)
-      scan(TAG_OPEN_END)
     end
 
     def tag_end(name)
@@ -85,6 +97,13 @@ module Nagoro
     end
 
     def text(string)
+      if scan(HASH_TEXT)
+        string << matched
+      end
+      @callback.text(string)
+    end
+
+    def hash_char(string)
       @callback.text(string)
     end
 

data/lib/nagoro/template.rb

@@ -50,6 +50,8 @@ module Nagoro
       @pipes.each do |pipe|
         if pipe.respond_to?(:new)
           io = pipe.new(io).result
+        elsif pipe.respond_to?(:call)
+          io = pipe.call(io)
         else
           io = Pipe.const_get(pipe).new(io).result
         end
@@ -67,10 +69,9 @@ module Nagoro
 
       if vars = @variables
         obj = eval('self', @binding)
-        obj.instance_variable_set('@_nagoro_ivs', vars)
-        eval(%q(
-          @_nagoro_ivs.each{|key, value| instance_variable_set("@#{key}", value) }
-        ), @binding)
+        vars.each do |key, value|
+          obj.instance_variable_set("@#{key}", value)
+        end
       end
 
       eval(@compiled, @binding, @file, @line).strip

data/lib/nagoro/version.rb

@@ -1,3 +1,3 @@
 module Nagoro
-  VERSION = "2009.05"
+  VERSION = "2013.03"
 end

data/nagoro.gemspec

@@ -1,26 +1,24 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{nagoro}
-  s.version = "2009.05"
+  s.name = "nagoro"
+  s.version = "2013.03"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael 'manveru' Fellinger"]
-  s.date = %q{2009-05-07}
-  s.description = %q{An extendible and fast templating engine in pure ruby.}
-  s.email = %q{m.fellinger@gmail.com}
-  s.files = ["CHANGELOG", "MANIFEST", "README.markdown", "Rakefile", "bin/nagoro", "doc/COPYING", "doc/GPL", "doc/LEGAL", "example/element/Html.nage", "example/hello.nag", "example/morpher.nag", "lib/nagoro.rb", "lib/nagoro/binding.rb", "lib/nagoro/element.rb", "lib/nagoro/pipe.rb", "lib/nagoro/pipe/base.rb", "lib/nagoro/pipe/compile.rb", "lib/nagoro/pipe/element.rb", "lib/nagoro/pipe/include.rb", "lib/nagoro/pipe/instruction.rb", "lib/nagoro/pipe/localization.rb", "lib/nagoro/pipe/morph.rb", "lib/nagoro/pipe/tidy.rb", "lib/nagoro/scanner.rb", "lib/nagoro/template.rb", "lib/nagoro/tidy.rb", "lib/nagoro/version.rb", "nagoro.gemspec", "spec/core_extensions.rb", "spec/example/hello.rb", "spec/helper.rb", "spec/nagoro/listener/base.rb", "spec/nagoro/pipe/compile.rb", "spec/nagoro/pipe/element.rb", "spec/nagoro/pipe/include.rb", "spec/nagoro/pipe/instruction.rb", "spec/nagoro/pipe/morph.rb", "spec/nagoro/pipe/tidy.rb", "spec/nagoro/template.rb", "spec/nagoro/template/full.nag", "spec/nagoro/template/hello.nag", "tasks/bacon.rake", "tasks/changelog.rake", "tasks/gem.rake", "tasks/gem_installer.rake", "tasks/grancher.rake", "tasks/install_dependencies.rake", "tasks/manifest.rake", "tasks/rcov.rake", "tasks/release.rake", "tasks/reversion.rake"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/manveru/nagoro}
+  s.date = "2013-03-22"
+  s.description = "An extendible and fast templating engine in pure ruby."
+  s.email = "m.fellinger@gmail.com"
+  s.files = ["AUTHORS", "CHANGELOG", "MANIFEST", "README.markdown", "Rakefile", "bin/nagoro", "doc/COPYING", "doc/GPL", "doc/LEGAL", "example/element/Html.nage", "example/hello.nag", "example/morpher.nag", "lib/nagoro.rb", "lib/nagoro/binding.rb", "lib/nagoro/element.rb", "lib/nagoro/pipe.rb", "lib/nagoro/pipe/base.rb", "lib/nagoro/pipe/compile.rb", "lib/nagoro/pipe/element.rb", "lib/nagoro/pipe/include.rb", "lib/nagoro/pipe/instruction.rb", "lib/nagoro/pipe/localization.rb", "lib/nagoro/pipe/morph.rb", "lib/nagoro/pipe/tidy.rb", "lib/nagoro/scanner.rb", "lib/nagoro/template.rb", "lib/nagoro/tidy.rb", "lib/nagoro/version.rb", "nagoro.gemspec", "spec/core_extensions.rb", "spec/example/hello.rb", "spec/helper.rb", "spec/nagoro/listener/base.rb", "spec/nagoro/pipe/compile.rb", "spec/nagoro/pipe/element.rb", "spec/nagoro/pipe/include.rb", "spec/nagoro/pipe/instruction.rb", "spec/nagoro/pipe/morph.rb", "spec/nagoro/pipe/tidy.rb", "spec/nagoro/template.rb", "spec/nagoro/template/full.nag", "spec/nagoro/template/hello.nag", "tasks/authors.rake", "tasks/bacon.rake", "tasks/changelog.rake", "tasks/gem.rake", "tasks/manifest.rake", "tasks/rcov.rake", "tasks/release.rake", "tasks/reversion.rake"]
+  s.homepage = "http://github.com/manveru/nagoro"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.2}
-  s.summary = %q{An extendible and fast templating engine in pure ruby.}
+  s.rubygems_version = "1.8.25"
+  s.summary = "An extendible and fast templating engine in pure ruby."
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/spec/example/hello.rb

@@ -1,4 +1,4 @@
-require 'spec/helper'
+require File.expand_path('../../helper', __FILE__)
 
 describe "example/hello.nag" do
   behaves_like 'xpath'

data/spec/helper.rb

@@ -1,5 +1,5 @@
-require 'lib/nagoro'
-require 'spec/core_extensions'
+require File.expand_path('../../lib/nagoro', __FILE__)
+require File.expand_path('../core_extensions', __FILE__)
 
 require 'stringio'
 require 'rexml/document'

data/spec/nagoro/listener/base.rb

@@ -1,4 +1,4 @@
-require 'spec/helper'
+require File.expand_path('../../../helper', __FILE__)
 
 describe "Nagoro::Listener::Base" do
   def base(string)

data/spec/nagoro/pipe/compile.rb

@@ -1,4 +1,4 @@
-require 'spec/helper'
+require File.expand_path('../../../helper', __FILE__)
 
 describe "Nagoro::Pipe::Compile" do
   def render(obj)
@@ -28,4 +28,22 @@ describe "Nagoro::Pipe::Compile" do
   should 'not fail on > inside ruby instruction' do
     render('#{{:hi => :there}[:hi]}').should == 'there'
   end
+
+  should 'compile #<tag>' do
+    render('#<br />').should == '#<br />'
+  end
+
+  should 'compile interpreter inside tag' do
+    tag = %q~<option value="a" #{'selected="selected"'}>A</option>~
+    res = render(tag)
+    res.should =~ /^<option /
+    res.should =~ />A<\/option>/
+    res.should =~ /value="a"/
+    res.should =~ /selected="selected"/
+  end
+
+  should 'compile #< in the middle of a text' do
+    render('Article number: #<br />').should == 'Article number: #<br />'
+  end
+
 end

data/spec/nagoro/pipe/element.rb

@@ -1,4 +1,4 @@
-require 'spec/helper'
+require File.expand_path('../../../helper', __FILE__)
 
 describe "Nagoro::Pipe::Element" do
   behaves_like 'xpath'
@@ -37,6 +37,11 @@ describe "Nagoro::Pipe::Element" do
       should == '(Page: "(SideBar: \\"\\")")'
   end
 
+  it 'should compile nested instructions in the middle of a text' do
+    compile('<Page> x #{test :x => 1}</Page>').
+      should == '(Page: " x \\#{test :x => 1}")'
+  end
+
   it 'should render file-elements' do
     doc = compile(File.read('example/hello.nag'))
     doc.should.not.be.empty