nagoro 2009.05

data/lib/nagoro/pipe/morph.rb

@@ -0,0 +1,95 @@
+module Nagoro
+  module Pipe
+    # Morph is a search and replace system based on parameters of opening
+    # tags.
+    #
+    # Available morphs are at the time of writing:
+    # each, filter, foreach, if, times, unless
+    #
+    # Please take care not to use multiple morphable parameters in one tag, due
+    # to restrictions of the implementation of REXML and libxml there is no way
+    # to find out which one came first and so the order would get messed up,
+    # leading to unpredictable results.
+    # You can, however, use any number of other parameter together with morphs.
+    #
+    # Example for each predefined morph:
+    #   <a if="@address" href="#@address">#@address</a>
+    #   # <?r if @address ?>
+    #   #   <a href="#@address">#@address</a>
+    #   # <?r end ?>
+    #
+    #   <a unless="logged_in?" href="/login">Login to your account</a>
+    #   # <?r unless logged_in? ?>
+    #   #   <a href="/login">Login to your account
+    #   # <?r end ?>
+    #
+    #   <div foreach="tag in @tags" class="tag">#{tag}</div>
+    #   # <?r for tag in @tags ?>
+    #   #  <div class="tag">#{tag}</div>
+    #   # <?r end ?>
+    #
+    #   <p filter="emoticonize">Hello there :)</p>
+    #   # <p>#{emoticonize(%<Hello there :)>)}</p>
+    #
+    #   <div times="10" class="shout">I am innocent!</div>
+    #   # <?r 10.times do |_t| ?>
+    #   #   <div class="shout">I am innocent!</div>
+    #   # <?r end ?>
+    #
+    #   <div each="@users">#{_e}</div>
+    #   # <?r @users.each do |_e| ?>
+    #   #   <div>#{_e}</div>
+    #   # <?r end ?>
+    #
+    # How to add new morphs:
+    #   Nagoro::Pipe::Morph['until'] = [
+    #     '<?r %morph %expression ?>', '<?r end ?>' ]
+
+    class Morph < Base
+      MORPHS = {
+        'each'    => [ '<?r %expression.%morph do |_e| ?>', '<?r end ?>' ],
+        'times'   => [ '<?r %expression.%morph do |_t| ?>', '<?r end ?>' ],
+        'filter'  => [ '<?o %expression(%<', '>) ?>' ],
+        'if'      => [ '<?r %morph %expression ?>', '<?r end ?>' ],
+        'unless'  => [ '<?r %morph %expression ?>', '<?r end ?>' ],
+        'foreach' => [ '<?r for %expression ?>', '<?r end ?>' ],
+      }
+
+      def tag_start(tag, original_attrs, value_attrs)
+        morphs = value_attrs.keys & MORPHS.keys
+        return super if morphs.empty?
+
+        if morphs.size > 1
+          raise "Cannot transform multiple morphs: #{value_attrs.inspect} in <#{tag}>"
+        elsif morphs.size == 1
+          morph = morphs.first
+          value = value_attrs.delete(morph)
+          original_attrs.delete(morph)
+          open = MORPHS[morph][0]
+
+          append open.gsub(/%morph/, morph).gsub(/%expression/, value)
+          @stack << [tag, morph]
+          super
+        end
+      end
+
+      def tag_end(tag)
+        super
+        prev, morph = @stack.last
+        return unless prev == tag
+        append(MORPHS[morph][1])
+        @stack.pop
+      end
+
+      class << self
+        def []=(key, value)
+          MORPHS[key] = value
+        end
+
+        def [](key)
+          MORPHS[key]
+        end
+      end
+    end
+  end
+end

data/lib/nagoro/pipe/tidy.rb

@@ -0,0 +1,49 @@
+require 'open3'
+
+module Nagoro
+  module Pipe
+    # Small wrapper that pipes the template through tidy.
+    #
+    # For configuration see the {Tidy::FLAGS}, it's an array of arguments
+    # passed to the tidy command.
+    #
+    # We are not using the ruby tidy library to avoid memory-leaks and
+    # dependencies. Please make sure you do have a binary called `tidy` in your
+    # `PATH` before using this library.
+    #
+    # This pipe relies on open3 from the standard library.
+    #
+    # == Regarding Windows
+    #
+    # There have been numerous reports that open3 doesn't work on Windows,
+    # since it relies on Kernel#fork, as syscall that is not supported on that
+    # platform.
+    #
+    # Two possible solutions exist:
+    # * There is a win32-popen implementation in RAA
+    # * Kernel#fork works in cygwin.
+    #
+    # I don't have a copy of windows, so it's hard for me to try either of
+    # these options.
+    # Please send me a patch if you find a cross-platform way of implementing
+    # this functionality.
+    class Tidy < Base
+      # Possible flags can be found in `tidy -help` and `tidy -help-config`
+      FLAGS = %w[-utf8 -asxhtml -quiet -indent --tidy-mark no]
+
+      def result
+        @scanner.stream
+        tidy(@body.join)
+      end
+
+      # Pipe given +string+ through the tidy binary.
+      #
+      # @param [#to_s] string
+      # @return [String]
+      # @author manveru
+      def tidy(string)
+        Nagoro::Tidy.tidy(string, FLAGS)
+      end
+    end
+  end
+end

data/lib/nagoro/scanner.rb

@@ -0,0 +1,97 @@
+require 'strscan'
+
+module Nagoro
+  class Scanner < StringScanner
+    TEXT = /[^<>]+/m
+    DOCTYPE = /<!DOCTYPE([^>]+)>/m
+
+    TAG_START       = /<([^\s>]+)/
+    TAG_END         = /<\/([^>]*)>/
+    TAG_OPEN_END    = /\s*>/
+    TAG_CLOSING_END = /\s*\/>/
+    TAG_PARAMETER   = /\s*([^\s]*)=((['"])(.*?)\3)/um
+
+    INSTRUCTION_START = /<\?(\S+)/
+    INSTRUCTION_END   = /(.*?)(\?>)/um
+
+    RUBY_INTERP_START = /\s*#\{/m
+    RUBY_INTERP_TEXT  = /[^\{\}]+/m
+    RUBY_INTERP_NEST  = /\{[^\}]*\}/m
+    RUBY_INTERP_END   = /(?=\})/
+
+    COMMENT = /<!--.*?-->/m
+
+    def initialize(string, callback)
+      @callback = callback
+      super(string)
+    end
+
+    def stream
+      until eos?
+        pos = self.pos
+        run
+        raise(Stuck, "Scanner didn't move: %p" % self) if pos == self.pos
+      end
+    end
+
+    def run
+      if    scan(DOCTYPE          ); doctype(self[1])
+      elsif scan(INSTRUCTION_START); instruction(self[1])
+      elsif scan(COMMENT          ); text(matched)
+      elsif scan(TAG_END          ); tag_end(self[1])
+      elsif scan(RUBY_INTERP_START); ruby_interp(matched)
+      elsif scan(TAG_START        ); tag_start(self[1])
+      elsif scan(TEXT             ); text(matched)
+      end
+    end
+
+    def instruction(name)
+      scan(INSTRUCTION_END)
+      @callback.instruction(name, self[1])
+    end
+
+    def ruby_interp(string)
+      done = false
+
+      until done
+        if    scan(RUBY_INTERP_TEXT)
+          string << matched
+        elsif scan(RUBY_INTERP_NEST)
+          string << matched
+        elsif scan(RUBY_INTERP_END)
+          done = true
+        end
+      end
+
+      @callback.text(string)
+    end
+
+    def tag_start(name)
+      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'
+      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)
+      @callback.tag_end(name)
+    end
+
+    def text(string)
+      @callback.text(string)
+    end
+
+    def doctype(string)
+      @callback.doctype(string)
+    end
+
+    class Stuck < Error; end
+  end
+end

data/lib/nagoro/template.rb

@@ -0,0 +1,89 @@
+require 'nagoro/scanner'
+require 'nagoro/binding'
+require 'nagoro/element'
+require 'nagoro/pipe'
+
+module Nagoro
+  DEFAULT_PIPES = [ Pipe::Element, Pipe::Morph, Pipe::Include,
+                    Pipe::Instruction, Pipe::Compile ]
+  DEFAULT_FILE = '<nagoro eval>'
+  DEFAULT_LINE = 1
+
+  class Template
+    def self.[](*pipes)
+      new(:pipes => pipes.flatten)
+    end
+
+    attr_accessor :binding, :file, :pipes, :compiled
+
+    def initialize(options = {})
+      parse_option(options)
+      @compiled = false
+    end
+
+    def parse_option(options = {})
+      @binding   = options.fetch(:binding, BindingProvider.binding)
+      @file      = options[:filename] || DEFAULT_FILE
+      @line      = options[:line] || DEFAULT_LINE
+      @pipes     = options[:pipes] || DEFAULT_PIPES
+      @variables = options[:variables]
+    end
+
+    def compile(io, options = {})
+      parse_option(options) unless options.empty?
+
+      case io
+      when String
+        io = File.read(io) if io.size < 1024 and File.file?(io)
+        @compiled = pipeline(io)
+      when StringIO, IO
+        @compiled = pipeline(io.read)
+      else
+        raise(ArgumentError, "Cannot compile %p" % io)
+      end
+
+      return self
+    end
+
+    # use inject?
+    def pipeline(io)
+      @pipes.each do |pipe|
+        if pipe.respond_to?(:new)
+          io = pipe.new(io).result
+        else
+          io = Pipe.const_get(pipe).new(io).result
+        end
+      end
+
+      return io
+    rescue Scanner::Stuck => exception
+      exception.message << " In: #{@file}"
+      puts exception
+      ''
+    end
+
+    def result(options = {})
+      parse_option(options) unless options.empty?
+
+      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)
+      end
+
+      eval(@compiled, @binding, @file, @line).strip
+    end
+
+    def tidy_result(options = {})
+      final = result(options)
+      flags = options.fetch(:flags, Tidy::FLAGS)
+      Tidy.tidy(final, flags).strip
+    end
+
+    def render(io, options = {})
+      compile(io, options).result
+    end
+  end
+end

data/lib/nagoro/tidy.rb

@@ -0,0 +1,49 @@
+require 'open3'
+
+module Nagoro
+  # Small wrapper that pipes the template through tidy.
+  #
+  # For configuration see the {Tidy::FLAGS}, it's an array of arguments
+  # passed to the tidy command.
+  #
+  # We are not using the ruby tidy library to avoid memory-leaks and
+  # dependencies. Please make sure you do have a binary called `tidy` in your
+  # `PATH` before using this library.
+  #
+  # This pipe relies on open3 from the standard library.
+  #
+  # == Regarding Windows
+  #
+  # There have been numerous reports that open3 doesn't work on Windows,
+  # since it relies on Kernel#fork, as syscall that is not supported on that
+  # platform.
+  #
+  # Two possible solutions exist:
+  # * There is a win32-popen implementation in RAA
+  # * Kernel#fork works in cygwin.
+  #
+  # I don't have a copy of windows, so it's hard for me to try either of
+  # these options.
+  # Please send me a patch if you find a cross-platform way of implementing
+  # this functionality.
+
+  module Tidy
+    # Possible flags can be found in `tidy -help` and `tidy -help-config`
+    FLAGS = %w[-utf8 -asxhtml -quiet -indent --tidy-mark no]
+
+    module_function
+
+    # Pipe given +string+ through the tidy binary.
+    #
+    # @param [#to_s] string
+    # @return [String]
+    # @author manveru
+    def tidy(string, flags = FLAGS)
+      Open3.popen3('tidy', *flags) do |stdin, stdout, stderr|
+        stdin.puts(string)
+        stdin.close
+        return stdout.read
+      end
+    end
+  end
+end

data/lib/nagoro/version.rb

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

data/nagoro.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nagoro}
+  s.version = "2009.05"
+
+  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.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{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
+    else
+    end
+  else
+  end
+end

data/spec/core_extensions.rb

@@ -0,0 +1,33 @@
+# Extensions for Kernel
+
+module Kernel
+  # This is similar to +__FILE__+ and +__LINE__+, and returns a String
+  # representing the directory of the current file is.
+  # Unlike +__FILE__+ the path returned is absolute.
+  #
+  # This method is convenience for the
+  #  File.expand_path(File.dirname(__FILE__))
+  # idiom.
+  #
+  unless defined?(__DIR__)
+    def __DIR__()
+      filename = caller[0][/(.*?):/, 1]
+      File.expand_path(File.dirname(filename))
+    end
+  end
+end
+
+# Extensions for String
+
+class String
+
+  # A convenient way to do File.join
+  #
+  # Example:
+  #   'a' / 'b'                      # -> 'a/b'
+  #   File.dirname(__FILE__) / 'bar' # -> "ramaze/snippets/string/bar"
+
+  def / obj
+    File.join(self, obj.to_s)
+  end
+end