RubyGems - ember - Versions diffs - 0.0.0 - Mend

ember 0.0.0

Files changed (37) hide show

data/LICENSE +15 -0
data/bin/ember +47 -0
data/doc/api/classes/Ember.html +61 -0
data/doc/api/classes/Ember/Template.html +396 -0
data/doc/api/classes/Ember/Template/Program.html +497 -0
data/doc/api/created.rid +1 -0
data/doc/api/css/main.css +263 -0
data/doc/api/css/panel.css +383 -0
data/doc/api/css/reset.css +53 -0
data/doc/api/files/LICENSE.html +76 -0
data/doc/api/files/lib/ember/template_rb.html +66 -0
data/doc/api/files/lib/ember_rb.html +63 -0
data/doc/api/i/arrows.png +0 -0
data/doc/api/i/results_bg.png +0 -0
data/doc/api/i/tree_bg.png +0 -0
data/doc/api/index.html +14 -0
data/doc/api/js/jquery-1.3.2.min.js +19 -0
data/doc/api/js/jquery-effect.js +593 -0
data/doc/api/js/main.js +22 -0
data/doc/api/js/searchdoc.js +605 -0
data/doc/api/panel/index.html +63 -0
data/doc/api/panel/search_index.js +1 -0
data/doc/api/panel/tree.js +1 -0
data/doc/example.erb +2 -0
data/doc/example.txt +2 -0
data/doc/history.erb +9 -0
data/doc/index.erb +11 -0
data/doc/index.xhtml +758 -0
data/doc/intro.erb +79 -0
data/doc/setup.erb +29 -0
data/doc/usage.erb +249 -0
data/lib/ember.rb +16 -0
data/lib/ember/template.rb +586 -0
data/rakefile +14 -0
data/test/ember.rb +17 -0
data/test/ember/template.rb +141 -0
metadata +109 -0

data/LICENSE ADDED

@@ -0,0 +1,15 @@
+(the ISC license)
+Copyright 2009 Suraj N. Kurapati <sunaku@gmail.com>
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/bin/ember ADDED

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby -w
+#
+# Evaluates eRuby directives in the given eRuby template and
+# writes the result to the standard output stream (STDOUT).
+#
+#
+# Usage:
+#
+#   ember [Options] [Source]
+#
+#
+#   Source:   Path to an eRuby template file.  If this parameter is
+#             not specified, then the result of reading the standard
+#             input stream (STDIN) will be used as the eRuby template.
+#
+#
+# Options:
+#
+#--
+# Copyright 2009 Suraj N. Kurapati
+# See the LICENSE file for details.
+#++
+require 'rubygems'
+gem 'inochi', '~> 1'
+require 'inochi'
+options = Inochi.main :Ember do
+  opt :shorthand, 'Treat lines beginning with "%" as directives'
+  opt :infer_end, 'Add "end" statements based on indentation'
+  opt :unindent, 'Unindent block content hierarchically'
+  opt :compile, 'Print template program and exit'
+end
+template =
+  if source = ARGV.shift
+    Ember::Template.load_file(source, options)
+  else
+    Ember::Template.new(STDIN.read, options)
+  end
+if options[:compile]
+  puts template.program
+else
+  puts template.render
+end

data/doc/api/classes/Ember.html ADDED

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Ember</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
+    <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Module</span>
+            Ember
+        </h1>
+        <ul class="files">
+            <li><a href="../files/lib/ember/template_rb.html">lib/ember/template.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="sectiontitle">Classes and Modules</div>
+    <ul>
+        <li><span class="type">CLASS</span> <a href="Ember/Template.html">Ember::Template</a></li>
+    </ul>
+</div>
+    </div>
+  </body>
+</html>

data/doc/api/classes/Ember/Template.html ADDED

@@ -0,0 +1,396 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Ember::Template</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
+    <script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Ember::Template
+                <span class="parent">&lt;
+                    Object
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../files/lib/ember/template_rb.html">lib/ember/template.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>L</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000003">load_file</a></li>
+            </ul>
+        </dd>
+        <dt>N</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000000">new</a></li>
+            </ul>
+        </dd>
+        <dt>P</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000001">program</a></li>
+            </ul>
+        </dd>
+        <dt>R</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000004">read_file</a>,</li>
+                <li><a href="#M000002">render</a></li>
+            </ul>
+        </dd>
+    </dl>
+    <div class="sectiontitle">Classes and Modules</div>
+    <ul>
+        <li><span class="type">CLASS</span> <a href="Template/Program.html">Ember::Template::Program</a></li>
+    </ul>
+    <div class="sectiontitle">Constants</div>
+    <table border='0' cellpadding='5'>
+        <tr valign='top'>
+            <td class="attr-name">OPERATION_EVAL_EXPRESSION</td>
+            <td>=</td>
+            <td class="attr-value">'='</td>
+        </tr>
+        <tr valign='top'>
+            <td class="attr-name">OPERATION_COMMENT_LINE</td>
+            <td>=</td>
+            <td class="attr-value">'#'</td>
+        </tr>
+        <tr valign='top'>
+            <td class="attr-name">OPERATION_BEGIN_LAMBDA</td>
+            <td>=</td>
+            <td class="attr-value">'|'</td>
+        </tr>
+        <tr valign='top'>
+            <td class="attr-name">OPERATION_EVAL_TEMPLATE_FILE</td>
+            <td>=</td>
+            <td class="attr-value">'+'</td>
+        </tr>
+        <tr valign='top'>
+            <td class="attr-name">OPERATION_EVAL_TEMPLATE_STRING</td>
+            <td>=</td>
+            <td class="attr-value">'~'</td>
+        </tr>
+        <tr valign='top'>
+            <td class="attr-name">OPERATION_INSERT_PLAIN_FILE</td>
+            <td>=</td>
+            <td class="attr-value">'&lt;'</td>
+        </tr>
+    </table>
+            <div class="sectiontitle">Class Public methods</div>
+            <div class="method">
+                <div class="title" id="M000003">
+                    <a name="M000003"></a><b>load_file</b>(path, options = {})
+                </div>
+                <div class="description">
+                  <p>
+Builds a template whose body is read from the given source.
+</p>
+<p>
+If the source is a relative path, it will be resolved relative to
+options[:source_file] if that is a valid path.
+</p>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000003_source')" id="l_M000003_source">show</a>
+                    </p>
+                    <div id="M000003_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/ember/template.rb, line 93</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_file</span> <span class="ruby-identifier">path</span>, <span class="ruby-identifier">options</span> = {}
+        <span class="ruby-identifier">path</span> = <span class="ruby-identifier">resolve_path</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">options</span>)
+        <span class="ruby-identifier">new</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">:source_file</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">path</span>)
+      <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+            <div class="method">
+                <div class="title" id="M000000">
+                    <a name="M000000"></a><b>new</b>(input, options = {})
+                </div>
+                <div class="description">
+                  <p>
+Builds a processor that evaluates eRuby directives in the given input
+according to the given options.
+</p>
+<p>
+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.
+</p>
+<p>
+eRuby directives that contribute to the output of the given template are
+called &#8220;vocal&#8221; directives. Those that do not are called
+&#8220;silent&#8221; directives.
+</p>
+<h4>Options</h4>
+<dl>
+<dt>:result_variable</dt><dd>Name of the variable which stores the result of template evaluation during
+template evaluation.
+<p>
+The default value is &#8220;_erbout&#8221;.
+</p>
+</dd>
+<dt>:continue_result</dt><dd>Append to the result variable if it already exists?
+<p>
+The default value is false.
+</p>
+</dd>
+<dt>:source_file</dt><dd>Name of the file which contains the given input. This is shown in stack
+traces when reporting error messages.
+<p>
+The default value is &#8220;SOURCE&#8221;.
+</p>
+</dd>
+<dt>:source_line</dt><dd>Line number at which the given input exists in the :source_file. This is
+shown in stack traces when reporting error messages.
+<p>
+The default value is 1.
+</p>
+</dd>
+<dt>:shorthand</dt><dd>Treat lines beginning with &#8220;%&#8221; as eRuby directives?
+<p>
+The default value is false.
+</p>
+</dd>
+<dt>:<a href="Template.html#M000009">infer_end</a></dt><dd>Add missing <% end %> statements based on indentation?
+<p>
+The default value is false.
+</p>
+</dd>
+<dt>:unindent</dt><dd>Unindent the content of eRuby blocks (everything between <% do %> &#8230;
+<% end %>) hierarchically?
+<p>
+The default value is false.
+</p>
+</dd>
+</dl>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000000_source')" id="l_M000000_source">show</a>
+                    </p>
+                    <div id="M000000_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/ember/template.rb, line 63</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">input</span>, <span class="ruby-identifier">options</span> = {}
+      <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
+      <span class="ruby-ivar">@compile</span> = <span class="ruby-identifier">compile</span>(<span class="ruby-identifier">input</span>.<span class="ruby-identifier">to_s</span>)
+    <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+            <div class="method">
+                <div class="title" id="M000004">
+                    <a name="M000004"></a><b>read_file</b>(path, options = {})
+                </div>
+                <div class="description">
+                  <p>
+Returns the contents of the given file, which can be relative to the
+current template in which this command is being executed.
+</p>
+<p>
+If the source is a relative path, it will be resolved relative to
+options[:source_file] if that is a valid path.
+</p>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000004_source')" id="l_M000004_source">show</a>
+                    </p>
+                    <div id="M000004_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/ember/template.rb, line 105</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_file</span> <span class="ruby-identifier">path</span>, <span class="ruby-identifier">options</span> = {}
+        <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span> <span class="ruby-identifier">resolve_path</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">options</span>)
+      <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+            <div class="sectiontitle">Instance Public methods</div>
+            <div class="method">
+                <div class="title" id="M000001">
+                    <a name="M000001"></a><b>program</b>()
+                </div>
+                <div class="description">
+                  <p>
+Ruby source code assembled from the eRuby template provided as input to the
+constructor of this class.
+</p>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000001_source')" id="l_M000001_source">show</a>
+                    </p>
+                    <div id="M000001_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/ember/template.rb, line 72</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">program</span>
+      <span class="ruby-ivar">@compile</span>
+    <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+            <div class="method">
+                <div class="title" id="M000002">
+                    <a name="M000002"></a><b>render</b>(context = TOPLEVEL_BINDING)
+                </div>
+                <div class="description">
+                  <p>
+Returns the result of executing the Ruby program for this template
+(provided by the to_s() method) inside the given context binding.
+</p>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000002_source')" id="l_M000002_source">show</a>
+                    </p>
+                    <div id="M000002_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/ember/template.rb, line 80</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render</span>(<span class="ruby-identifier">context</span> = <span class="ruby-constant">TOPLEVEL_BINDING</span>)
+      <span class="ruby-identifier">eval</span> <span class="ruby-ivar">@compile</span>, <span class="ruby-identifier">context</span>,
+        (<span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:source_file</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:SOURCE</span>).<span class="ruby-identifier">to_s</span>,
+        (<span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:source_line</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>).<span class="ruby-identifier">to_i</span>
+    <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+</div>
+    </div>
+  </body>
+</html>