porthole 0.99.4

data/lib/porthole/version.rb

@@ -0,0 +1,3 @@
+class Porthole
+  Version = VERSION = '0.99.4'
+end

data/lib/rack/bug/panels/mustache_panel.rb

@@ -0,0 +1,81 @@
+module Rack
+  module Bug
+    # PortholePanel is a Rack::Bug panel which tracks the time spent rendering
+    # Porthole views as well as all the variables accessed during view
+    # rendering.
+    #
+    # It can be used to track down slow partials and ensure you're only
+    # generating data you need.
+    #
+    # Also, it's fun.
+    class PortholePanel < Panel
+      require "rack/bug/panels/porthole_panel/porthole_extension"
+
+      # The view is responsible for rendering our panel. While Rack::Bug
+      # takes care of the nav, the content rendered by View is used for
+      # the panel itself.
+      class View < Porthole
+        self.path = ::File.dirname(__FILE__) + '/porthole_panel'
+
+        # We track the render times of all the Porthole views on this
+        # page load.
+        def times
+          PortholePanel.times.map do |key, value|
+            { :key => key, :value => value }
+          end
+        end
+
+        # Any variables used in this page load are collected and displayed.
+        def variables
+          vars = PortholePanel.variables.sort_by { |key, _| key.to_s }
+          vars.map do |key, value|
+            # Arrays can get too huge. Just show the first 10 to give you
+            # some idea.
+            if value.is_a?(Array) && value.size > 10
+              size = value.size
+              value = value.first(10)
+              value << "...and #{size - 10} more"
+            end
+
+            { :key => key, :value => value.inspect }
+          end
+        end
+      end
+
+      # Clear out our page load-specific variables.
+      def self.reset
+        Thread.current["rack.bug.porthole.times"] = {}
+        Thread.current["rack.bug.porthole.vars"] = {}
+      end
+
+      # The view render times for this page load
+      def self.times
+        Thread.current["rack.bug.porthole.times"] ||= {}
+      end
+
+      # The variables used on this page load
+      def self.variables
+        Thread.current["rack.bug.porthole.vars"] ||= {}
+      end
+
+      # The name of this Rack::Bug panel
+      def name
+        "porthole"
+      end
+
+      # The string used for our tab in Rack::Bug's navigation bar
+      def heading
+        "{{%.2fms}}" % self.class.times.values.inject(0.0) do |sum, obj|
+          sum + obj
+        end
+      end
+
+      # The content of our Rack::Bug panel
+      def content
+        View.render
+      ensure
+        self.class.reset
+      end
+    end
+  end
+end

data/lib/rack/bug/panels/mustache_panel/mustache_extension.rb

@@ -0,0 +1,27 @@
+if defined? Porthole
+  require 'benchmark'
+
+  Porthole.class_eval do
+    alias_method :real_render, :render
+
+    def render(*args, &block)
+      out = ''
+      Rack::Bug::PortholePanel.times[self.class.name] = Benchmark.realtime do
+        out = real_render(*args, &block)
+      end
+      out
+    end
+
+    alias_method :to_html, :render
+    alias_method :to_text, :render
+  end
+
+  Porthole::Context.class_eval do
+    alias_method :real_get, :[]
+
+    def [](name)
+      return real_get(name) if name == :yield || !@porthole.respond_to?(name)
+      Rack::Bug::PortholePanel.variables[name] = real_get(name)
+    end
+  end
+end

data/lib/rack/bug/panels/mustache_panel/view.mustache

@@ -0,0 +1,46 @@
+<script type="text/javascript">
+$(function() {
+  $('#porthole_variables .variable').each(function() {
+    var el = $(this)
+    if (el.text().length > 500) {
+      var txt = el.text()
+      el.click(function() {
+        $(this).text(txt)
+      }).text( el.text().slice(0, 500) + '...' )
+    }
+  })
+});
+</script>
+
+<h3>Render Times</h3>
+
+<table>
+  <tr>
+    <th>View</th>
+    <th>Render Time</th>
+  </tr>
+
+  {{# times }}
+    <tr>
+      <td>{{ key }}</td>
+      <td>{{ value }}</td>
+    </tr>
+  {{/ times }}
+</table>
+
+<h3>Variables</h3>
+
+<table id="porthole_variables">
+  <tr>
+    <th>Name</th>
+    <th>Value</th>
+  </tr>
+
+  {{# variables }}
+    <tr>
+      <td>{{ key }}</td>
+      <td class="variable">{{ value }}</td>
+    </tr>
+  {{/ variables }}
+</table>
+

data/man/porthole.1

@@ -0,0 +1,165 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "MUSTACHE" "1" "August 2011" "DEFUNKT" "Porthole Manual"
+.
+.SH "NAME"
+\fBporthole\fR \- Porthole processor
+.
+.SH "SYNOPSIS"
+.
+.nf
+
+porthole <YAML> <FILE>
+porthole \-\-compile <FILE>
+porthole \-\-tokens <FILE>
+.
+.fi
+.
+.SH "DESCRIPTION"
+Porthole is a logic\-less templating system for HTML, config files, anything\.
+.
+.P
+The \fBporthole\fR command processes a Porthole template preceded by YAML frontmatter from standard input and prints one or more documents to standard output\.
+.
+.P
+YAML frontmatter beings with \fB\-\-\-\fR on a single line, followed by YAML, ending with another \fB\-\-\-\fR on a single line, e\.g\.
+.
+.IP "" 4
+.
+.nf
+
+\-\-\-
+names: [ {name: chris}, {name: mark}, {name: scott} ]
+\-\-\-
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If you are unfamiliar with YAML, it is a superset of JSON\. Valid JSON should work fine\.
+.
+.P
+After the frontmatter should come any valid Porthole template\. See porthole(5) for an overview of Porthole templates\.
+.
+.P
+For example:
+.
+.IP "" 4
+.
+.nf
+
+{{#names}}
+  Hi {{name}}!
+{{/names}}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Now let\'s combine them\.
+.
+.IP "" 4
+.
+.nf
+
+$ cat data\.yml
+\-\-\-
+names: [ {name: chris}, {name: mark}, {name: scott} ]
+\-\-\-
+
+$ cat template\.porthole
+{{#names}}
+  Hi {{name}}!
+{{/names}}
+
+$ cat data\.yml template\.porthole | porthole
+Hi chris!
+Hi mark!
+Hi scott!
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If you provide multiple YAML documents (as delimited by \fB\-\-\-\fR), your template will be rendered multiple times\. Like a mail merge\.
+.
+.P
+For example:
+.
+.IP "" 4
+.
+.nf
+
+$ cat data\.yml
+\-\-\-
+name: chris
+\-\-\-
+name: mark
+\-\-\-
+name: scott
+\-\-\-
+
+$ cat template\.porthole
+Hi {{name}}!
+
+$ cat data\.yml template\.porthole | porthole
+Hi chris!
+Hi mark!
+Hi scott!
+.
+.fi
+.
+.IP "" 0
+.
+.SH "OPTIONS"
+By default \fBporthole\fR will try to render a Porthole template using the YAML frontmatter you provide\. It can do a few other things, however\.
+.
+.TP
+\fB\-c\fR, \fB\-\-compile\fR
+Print the compiled Ruby version of a given template\. This is the code that is actually used when rendering a template into a string\. Useful for debugging but only if you are familiar with Porthole\'s internals\.
+.
+.TP
+\fB\-t\fR, \fB\-\-tokens\fR
+Print the tokenized form of a given Porthole template\. This can be used to understand how Porthole parses a template\. The tokens are handed to a generator which compiles them into a Ruby string\. Syntax errors and confused tags, therefor, can probably be identified by examining the tokens produced\.
+.
+.SH "INSTALLATION"
+If you have RubyGems installed:
+.
+.IP "" 4
+.
+.nf
+
+gem install porthole
+.
+.fi
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+.
+.nf
+
+$ porthole data\.yml template\.porthole
+$ cat data\.yml | porthole \- template\.porthole
+$ porthole \-c template\.porthole
+$ cat <<data | ruby porthole \- template\.porthole
+\-\-\-
+name: Bob
+age: 30
+\-\-\-
+data
+.
+.fi
+.
+.SH "COPYRIGHT"
+Porthole is Copyright (C) 2009 Chris Wanstrath
+.
+.P
+Original CTemplate by Google
+.
+.SH "SEE ALSO"
+porthole(5), gem(1), \fIhttp://porthole\.github\.com/\fR

data/man/porthole.1.html

@@ -0,0 +1,213 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>porthole(1) - Porthole processor</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#INSTALLATION">INSTALLATION</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#COPYRIGHT">COPYRIGHT</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>porthole(1)</li>
+    <li class='tc'>Porthole Manual</li>
+    <li class='tr'>porthole(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>porthole</code> - <span class="man-whatis">Porthole processor</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<pre><code>porthole &lt;YAML> &lt;FILE>
+porthole --compile &lt;FILE>
+porthole --tokens &lt;FILE>
+</code></pre>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Porthole is a logic-less templating system for HTML, config files,
+anything.</p>
+
+<p>The <code>porthole</code> command processes a Porthole template preceded by YAML
+frontmatter from standard input and prints one or more documents to
+standard output.</p>
+
+<p>YAML frontmatter beings with <code>---</code> on a single line, followed by YAML,
+ending with another <code>---</code> on a single line, e.g.</p>
+
+<pre><code>---
+names: [ {name: chris}, {name: mark}, {name: scott} ]
+---
+</code></pre>
+
+<p>If you are unfamiliar with YAML, it is a superset of JSON. Valid JSON
+should work fine.</p>
+
+<p>After the frontmatter should come any valid Porthole template. See
+<a href="porthole.5.ron.html" class="man-ref">porthole<span class="s">(5)</span></a> for an overview of Porthole templates.</p>
+
+<p>For example:</p>
+
+<pre><code>{{#names}}
+  Hi {{name}}!
+{{/names}}
+</code></pre>
+
+<p>Now let's combine them.</p>
+
+<pre><code>$ cat data.yml
+---
+names: [ {name: chris}, {name: mark}, {name: scott} ]
+---
+
+$ cat template.porthole
+{{#names}}
+  Hi {{name}}!
+{{/names}}
+
+$ cat data.yml template.porthole | porthole
+Hi chris!
+Hi mark!
+Hi scott!
+</code></pre>
+
+<p>If you provide multiple YAML documents (as delimited by <code>---</code>), your
+template will be rendered multiple times. Like a mail merge.</p>
+
+<p>For example:</p>
+
+<pre><code>$ cat data.yml
+---
+name: chris
+---
+name: mark
+---
+name: scott
+---
+
+$ cat template.porthole
+Hi {{name}}!
+
+$ cat data.yml template.porthole | porthole
+Hi chris!
+Hi mark!
+Hi scott!
+</code></pre>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>By default <code>porthole</code> will try to render a Porthole template using the
+YAML frontmatter you provide. It can do a few other things, however.</p>
+
+<dl>
+<dt><code>-c</code>, <code>--compile</code></dt><dd><p>Print the compiled Ruby version of a given template. This is the
+code that is actually used when rendering a template into a
+string. Useful for debugging but only if you are familiar with
+Porthole's internals.</p></dd>
+<dt><code>-t</code>, <code>--tokens</code></dt><dd><p>Print the tokenized form of a given Porthole template. This can be
+used to understand how Porthole parses a template. The tokens are
+handed to a generator which compiles them into a Ruby
+string. Syntax errors and confused tags, therefor, can probably be
+identified by examining the tokens produced.</p></dd>
+</dl>
+
+
+<h2 id="INSTALLATION">INSTALLATION</h2>
+
+<p>If you have RubyGems installed:</p>
+
+<pre><code>gem install porthole
+</code></pre>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<pre><code>$ porthole data.yml template.porthole
+$ cat data.yml | porthole - template.porthole
+$ porthole -c template.porthole
+$ cat &lt;&lt;data | ruby porthole - template.porthole
+---
+name: Bob
+age: 30
+---
+data
+</code></pre>
+
+<h2 id="COPYRIGHT">COPYRIGHT</h2>
+
+<p>Porthole is Copyright (C) 2009 Chris Wanstrath</p>
+
+<p>Original CTemplate by Google</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><a href="porthole.5.ron.html" class="man-ref">porthole<span class="s">(5)</span></a>, <span class="man-ref">gem<span class="s">(1)</span></span>,
+<a href="http://porthole.github.com/" data-bare-link="true">http://porthole.github.com/</a></p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'>DEFUNKT</li>
+    <li class='tc'>August 2011</li>
+    <li class='tr'>porthole(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>