ember 0.0.0 → 0.0.1

data/doc/intro.erb

@@ -1,15 +1,31 @@
 %#--
-%# Copyright 2009 Suraj N. Kurapati
-%# See the LICENSE file for details.
+%# Copyright protects this work.
+%# See LICENSE file for details.
 %#++
 
 % api_url = './api/index.html'
-% repo_url = 'http://github.com/sunaku/' + $program
-% repo_scm = '[Git](http://git-scm.com)'
+% src_url = 'http://github.com/sunaku/' + $program
+% src_scm = '[Git](http://git-scm.com)'
+
 
 %|chapter "Introduction"
+
+
   %|project
-    <%= $project %> is an [eRuby template](http://en.wikipedia.org/wiki/ERuby) processsor that facilitates debugging, reduces markup, and improves composability of eRuby templates.
+
+    <%= $project %> is an [eRuby template](http://en.wikipedia.org/wiki/ERuby) processsor that allows debugging, reduces markup, and improves composability of eRuby templates.
+
+
+  * <%= xref "History", "What's new?" %> --- history of project releases.
+  * [Source code](<%= src_url %>) --- obtain via <%= src_scm %> or browse online.
+  * [API reference](<%= api_url %>) --- documentation for source code.
+  * [Project home](<%= $website %>) --- the <%= $project %> project home page.
+
+  To get help or provide feedback, simply
+  <%= xref "License", "contact the author(s)" %>.
+
+
+  %|section "Features"
 
     <%= $project %> is exciting because:
     * It reports correct line numbers in stack traces.
@@ -18,62 +34,20 @@
     * It completely silences code-only eRuby directives.
     * It is implemented in <%= `sloccount lib`[/^\d+/] %> lines of pure Ruby.
 
-    These features distinguish <%= $project %> from the competition:
+
+  %|section "Etymology"
+
+    <%= $project %> stands for *embe*dded *r*uby.
+
+
+  %|section "License"
+
+    %< "../LICENSE"
+
+
+  %|section "Related works"
+
     * [Erubis](http://www.kuwata-lab.com/erubis/)
     * [eruby](http://modruby.net/en/)
     * [ERB](http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/)
 
-  %|paragraph "Etymology"
-    <%= $project %> stands for *embe*dded *r*uby.
-
-  %|section "Logistics"
-    * <%= xref "History", "Release notes" %> --- history of project releases.
-    * [Source code](<%= repo_url %>) --- obtain via <%= repo_scm %> or browse online.
-    * [API reference](<%= api_url %>) --- documentation for source code.
-    * [Project home](<%= $website %>) --- the <%= $project %> project home page.
-
-    To get help or provide feedback, simply
-    <%= xref "License", "contact the author(s)" %>.
-
-    %|paragraph "Version numbers"
-      <%= $project %> releases are numbered in *major.minor.patch*
-      form according to the [RubyGems rational versioning
-      policy](http://www.rubygems.org/read/chapter/7), which
-      can be summarized thus:
-
-      <table markdown="1">
-        <thead>
-          <tr>
-            <td rowspan="2">What increased in the version number?</td>
-            <td colspan="3">The increase indicates that the release:</td>
-          </tr>
-          <tr>
-            <th>Is backward compatible?</th>
-            <th>Has new features?</th>
-            <th>Has bug fixes?</th>
-          </tr>
-        </thead>
-        <tbody>
-          <tr>
-            <th>major</th>
-            <td style="background-color: #FFE4E1;">No</td>
-            <td>Yes</td>
-            <td>Yes</td>
-          </tr>
-          <tr>
-            <th>minor</th>
-            <td>Yes</td>
-            <td>Yes</td>
-            <td>Yes</td>
-          </tr>
-          <tr>
-            <th>patch</th>
-            <td>Yes</td>
-            <td style="background-color: #FFE4E1;">No</td>
-            <td>Yes</td>
-          </tr>
-        </tbody>
-      </table>
-
-    %|paragraph "License"
-      %< "../LICENSE"

data/doc/setup.erb

@@ -1,10 +1,14 @@
 %#--
-%# Copyright 2009 Suraj N. Kurapati
-%# See the LICENSE file for details.
+%# Copyright protects this work.
+%# See LICENSE file for details.
 %#++
 
+
 %|chapter "Setup"
+
+
   %|section "Requirements"
+
     Your system needs the following software to run <%= $project %>.
 
     | Software                        | Description               | Notes                                                          |
@@ -12,7 +16,9 @@
     | [Ruby](http://ruby-lang.org)    | Ruby language interpreter | Version 1.8.6, 1.8.7, and 1.9.1 have been tested successfully. |
     | [RubyGems](http://rubygems.org) | Ruby packaging system     | Version 1.3.1 or newer is required.                            |
 
+
   %|section "Installation"
+
     You can install <%= $project %> by running this command:
 
         gem install <%= $program %>
@@ -27,3 +33,46 @@
 
     If you do not see such output, you may
     <%= xref "License", "ask the author(s)" %> for help.
+
+
+  %|section "Version numbers"
+
+    <%= $project %> releases are numbered in *major.minor.patch*
+    form according to the [RubyGems rational versioning
+    policy](http://www.rubygems.org/read/chapter/7), which
+    can be summarized thus:
+
+    <table markdown="1">
+      <thead>
+        <tr>
+          <td rowspan="2">What increased in the version number?</td>
+          <td colspan="3">The increase indicates that the release:</td>
+        </tr>
+        <tr>
+          <th>Is backward compatible?</th>
+          <th>Has new features?</th>
+          <th>Has bug fixes?</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <th>major</th>
+          <td style="background-color: #FFE4E1;">No</td>
+          <td>Yes</td>
+          <td>Yes</td>
+        </tr>
+        <tr>
+          <th>minor</th>
+          <td>Yes</td>
+          <td>Yes</td>
+          <td>Yes</td>
+        </tr>
+        <tr>
+          <th>patch</th>
+          <td>Yes</td>
+          <td style="background-color: #FFE4E1;">No</td>
+          <td>Yes</td>
+        </tr>
+      </tbody>
+    </table>
+

data/doc/usage.erb

@@ -1,10 +1,14 @@
 %#--
-%# Copyright 2009 Suraj N. Kurapati
-%# See the LICENSE file for details.
+%# Copyright protects this work.
+%# See LICENSE file for details.
 %#++
 
+
 %|chapter "Usage"
+
+
   %|section "Command-line interface"
+
     When you run this command:
 
         <%= $program %> --help
@@ -13,7 +17,9 @@
 
     <pre><%= verbatim `ruby bin/#{$program} --help` %></pre>
 
+
   %|section "Ruby library interface"
+
     Begin by loading <%= $project %> into Ruby:
 
     <code>
@@ -44,7 +50,9 @@
 
     See the [API documentation](<%= api_url %>) for details and examples.
 
+
   %|section "eRuby template directives", "Directives"
+
     eRuby templates are plain-text documents that contain special processing instructions known as **directives**.  Directives may be expressed using either **standard** or **shorthand** notation:
 
     | Notation  | Directive | Head | Operation | Body | Tail |
@@ -58,7 +66,9 @@
 
     In any case, directives are atomic constructs; they may not be nested.
 
+
     %|section "Operations"
+
       The first character that follows the head of a directive is known as an **operation**.  Operations specify how the directive should be processed:
 
       | Operation                                              | Effect                                                                                                                                                                                                                                                                                                                                                                                                            | Example                                   |
@@ -105,12 +115,16 @@
         end
       %>
 
+
       %|example "An empty template"
+
         Begin with an empty template:
 
-        <%= template_example.call "", {} %>
+        %= template_example.call "", {}
+
 
       %|example "Comment directives"
+
         Add comment directives:
 
         <%=
@@ -122,7 +136,9 @@
           }, :shorthand => true
         %>
 
+
       %|example "Escaped directives"
+
         Add escaped directives:
 
         <%=
@@ -134,7 +150,9 @@
           }, :shorthand => true
         %>
 
+
       %|example "Vocal directives"
+
         Add vocal directives, which produce output:
 
         <%=
@@ -145,7 +163,9 @@
           }, :shorthand => true
         %>
 
+
       %|example "Silent directives"
+
         Add silent directives, which do not produce output:
 
         <%=
@@ -159,7 +179,9 @@
           }, :shorthand => true
         %>
 
+
       %|example "Block directives"
+
         Add some Ruby blocks:
 
         <%=
@@ -181,7 +203,9 @@
           }, :shorthand => true
         %>
 
+
       %|example "Infer block endings"
+
         Omit <tt><%= standard_directive[' end'] %></tt> directives from the template:
 
         <%=
@@ -200,7 +224,9 @@
           }, :shorthand => true, :infer_end => true
         %>
 
+
       %|example "Raw file inclusion"
+
         When <tt>doc/example.txt</tt> contains:
 
         <pre><%< "example.txt" %></pre>
@@ -218,7 +244,9 @@
           }, :shorthand => true, :source_file => __FILE__
         %>
 
+
       %|example "Template file inclusion"
+
         When <tt>doc/example.erb</tt> contains:
 
         <code lang="rhtml"><%< "example.erb" %></code>
@@ -236,7 +264,9 @@
           }, :shorthand => true, :source_file => __FILE__
         %>
 
+
       %|example "Dynamic template evaluation"
+
         <%=
           example = %{~ "#{shorthand_directive['= 2 + 2']}"}
 
@@ -247,3 +277,4 @@
 
           }, :shorthand => true
         %>
+

data/lib/ember.rb

@@ -1,6 +1,6 @@
 #--
-# Copyright 2009 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'rubygems'
@@ -8,9 +8,9 @@ gem 'inochi', '~> 1'
 require 'inochi'
 
 Inochi.init :Ember,
-  :version => '0.0.0',
-  :release => '2009-05-02',
-  :website => 'http://snk.tuxfamily.org/lib/ember',
+  :version => '0.0.1',
+  :release => '2009-10-03',
+  :website => 'http://snk.tuxfamily.org/lib/ember/',
   :tagline => 'eRuby template processor'
 
 require 'ember/template'

data/lib/ember/template.rb

@@ -1,6 +1,6 @@
 #--
-# Copyright 2009 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'pathname'
@@ -11,9 +11,10 @@ module Ember
     # Builds a processor that evaluates eRuby directives
     # in the given input according to the given options.
     #
-    # This processor transforms the given input into an
-    # executable Ruby program (provided by the #to_s() method)
-    # which is then executed by the #render() method on demand.
+    # This processor transforms the given input
+    # into an executable Ruby program (provided
+    # by the #program() method) which is then
+    # executed by the #render() method on demand.
     #
     # eRuby directives that contribute to the output of
     # the given template are called "vocal" directives.
@@ -62,6 +63,7 @@ module Ember
     #
     def initialize input, options = {}
       @options = options
+      @render_context_id = object_id
       @compile = compile(input.to_s)
     end
 
@@ -73,14 +75,22 @@ module Ember
       @compile
     end
 
+    @@contexts = {}
+
     ##
     # Returns the result of executing the Ruby program for this template
-    # (provided by the #to_s() method) inside the given context binding.
+    # (provided by the #program() method) inside the given context binding.
     #
-    def render(context = TOPLEVEL_BINDING)
-      eval @compile, context,
+    def render context = TOPLEVEL_BINDING, parent_context_id = nil
+      context ||= @@contexts[parent_context_id] # inherit parent context
+      @@contexts[@render_context_id] = context  # provide to children
+
+      result = eval @compile, context,
         (@options[:source_file] || :SOURCE).to_s,
         (@options[:source_line] || 1).to_i
+
+      @@contexts.delete @render_context_id      # free the memory
+      result
     end
 
     class << self
@@ -323,7 +333,7 @@ module Ember
 
         # content + after_spacing
         content_line.gsub! '<%%', '<%' # unescape escaped directives
-        @program.text content_line
+        @program.emit_text content_line
 
         # after_newline
         @program.new_line if content_line =~ /\n\z/
@@ -359,28 +369,28 @@ module Ember
           arguments =~ BLOCK_END_REGEXP ||
           arguments =~ BLOCK_CONTINUE_REGEXP
 
-        @program.text unindent(before_spacing) if is_vocal
+        @program.emit_text unindent(before_spacing) if is_vocal
 
       # directive
         template_class_name  = '::Ember::Template'
         nested_template_args = "(#{arguments}), #{@options.inspect}"
 
         nest_template_with = lambda do |meth|
-          @program.code "#{template_class_name}.#{meth}(#{
+          @program.emit_code "#{template_class_name}.#{meth}(#{
             nested_template_args
-          }.merge!(:continue_result => true)).render(binding)"
+          }.merge!(:continue_result => true)).render(nil, #{@render_context_id.inspect})"
         end
 
         case operation
         when OPERATION_EVAL_EXPRESSION
-          @program.expr arguments
+          @program.emit_expr arguments
 
         when OPERATION_COMMENT_LINE
-          @program.code directive.gsub(/\S/, ' ')
+          @program.emit_code directive.gsub(/\S/, ' ')
 
         when OPERATION_BEGIN_LAMBDA
           arguments =~ /(\bdo\b)?\s*(\|[^\|]*\|)?\s*\z/
-          @program.code "#{$`} #{$1 || 'do'} #{$2}"
+          @program.emit_code "#{$`} #{$1 || 'do'} #{$2}"
 
           p :begin => directive if $DEBUG
           open_block.call
@@ -392,10 +402,10 @@ module Ember
           nest_template_with[:load_file]
 
         when OPERATION_INSERT_PLAIN_FILE
-          @program.expr "#{template_class_name}.read_file(#{nested_template_args})"
+          @program.emit_expr "#{template_class_name}.read_file(#{nested_template_args})"
 
         else
-          @program.code arguments
+          @program.emit_code arguments
 
           unless arguments =~ /\n/ # don't bother parsing multi-line directives
             case arguments
@@ -417,14 +427,14 @@ module Ember
         end
 
       # after_spacing
-        @program.text after_spacing if is_vocal || after_newline.empty?
+        @program.emit_text after_spacing if is_vocal || after_newline.empty?
 
       # after_newline
-        @program.text after_newline if is_vocal
+        @program.emit_text after_newline if is_vocal
         @program.new_line unless after_newline.empty?
     end
 
-    class Program
+    class Program #:nodoc:
       ##
       # Transforms this program into Ruby code which uses
       # the given variable name as the evaluation buffer.
@@ -465,7 +475,7 @@ module Ember
       # Schedules the given text to be inserted verbatim
       # into the evaluation buffer when this program is run.
       #
-      def text value
+      def emit_text value
         # don't bother emitting empty strings
         return if value.empty?
 
@@ -481,7 +491,7 @@ module Ember
       # Schedules the given Ruby code to be
       # evaluated when this program is run.
       #
-      def code value
+      def emit_code value
         statement :code, value
       end
 
@@ -489,7 +499,7 @@ module Ember
       # Schedules the given Ruby code to be evaluated and inserted
       # into the evaluation buffer when this program is run.
       #
-      def expr value
+      def emit_expr value
         statement :expr, value
       end