mustache 0.5.0 → 0.6.0

data/man/mustache.5.ron

@@ -0,0 +1,220 @@
+mustache(5) -- Logic-less templates.
+====================================
+
+## SYNOPSIS
+
+A typical Mustache template:
+
+    Hello {{name}}
+    You have just won ${{value}}!
+    {{#in_ca}}
+    Well, ${{taxed_value}}, after taxes.
+    {{/in_ca}}
+
+Given the following hash:
+
+    {
+      "name": "Chris",
+      "value": 10000,
+      "taxed_value": 10000 - (10000 * 0.4),
+      "in_ca": true
+    }
+
+Will produce the following:
+
+    Hello Chris
+    You have just won $10000!
+    Well, $6000.0, after taxes.
+
+
+## DESCRIPTION
+
+Mustache can be used for HTML, config files, source code -
+anything. It works by expanding tags in a template using values
+provided in a hash or object.
+
+We call it "logic-less" because there are no if statements, else
+clauses, or for loops. Instead there are only tags. Some tags are
+replaced with a value, some nothing, and others a series of
+values. This document explains the different types of Mustache tags.
+
+
+## TAG TYPES
+
+Tags are indicated by the double mustaches. `{{name}}` is a tag. Let's
+talk about the different types of tags.
+
+
+### Variables
+
+The most basic tag is the variable. A `{{name}}` tag in a basic
+template will try to call the `name` method on your view. If there is
+no `name` method, an exception will be raised.
+
+All variables are HTML escaped by default. If you want to return
+unescaped HTML, use the triple mustache: `{{{name}}}`.
+
+By default a variable "miss" returns an empty string. This can usually
+be configured in your Mustache library.
+
+Template:
+
+    * {{name}}
+    * {{age}}
+    * {{company}}
+    * {{{company}}}
+
+Hash:
+
+    {
+      "name": "Chris",
+      "company": "<b>GitHub</b>"
+    }
+
+Output:
+
+    * Chris
+    *
+    * &lt;b&gt;GitHub&lt;/b&gt;
+    * <b>GitHub</b>
+
+### Boolean Sections
+
+A section begins with a pound and ends with a slash. That is,
+`{{#person}}` begins a "person" section while `{{/person}}` ends it.
+
+If the `person` key exists and calling it returns false, the HTML
+between the pound and slash will not be displayed.
+
+If the `person` method exists and calling it returns true, the HTML
+between the pound and slash will be rendered and displayed.
+
+Template:
+
+    {{#person}}
+      Shown!
+    {{/person}}
+    {{#anything_else}}
+      Never shown!
+    {{/anything_else}}
+
+Hash:
+
+    {
+      "person": true
+    }
+
+Output:
+
+    Shown!
+
+### Enumerable Sections
+
+Enumerable sections are syntactically identical to boolean sections in
+that they begin with a pound and end with a slash. The difference,
+however, is in the view: if the method called returns an enumerable,
+the section is repeated as the enumerable is iterated over.
+
+Each item in the enumerable is expected to be a hash which will then
+become the context of the corresponding iteration. In this way we can
+construct loops.
+
+Template:
+
+    {{#repo}}
+      <b>{{name}}</b>
+    {{/repo}}
+
+Hash:
+
+    {
+      "repo": [
+        { "name": "resque" },
+        { "name": "hub" },
+        { "name": "rip" },
+      ]
+    }
+
+Output:
+
+    <b>resque</b>
+    <b>hub</b>
+    <b>rip</b>
+
+
+### Comments
+
+Comments begin with a bang and are ignored. The following template:
+
+    <h1>Today{{! ignore me }}.</h1>
+
+Will render as follows:
+
+    <h1>Today.</h1>
+
+
+### Partials
+
+Partials begin with a greater than sign, like `{{> box}}`.
+
+It is useful to think of partials as a "template expansion" - that is,
+the actual partial tag will be replaced with the content of the
+partial. Therefor partials share the current context.
+
+For example, this template and partial:
+
+    base.mustache:
+    <h2>Names</h2>
+    {{# names }}
+      {{> user }}
+    {{/ names }}
+
+    user.mustache:
+    <strong>{{ name }}</strong>
+
+Can be thought of as a single, expanded template:
+
+    <h2>Names</h2>
+    {{# names }}
+      <strong>{{ name }}</strong>
+    {{/ names }}
+
+
+### Set Delimiter
+
+Set Delimiter tags start with an equal sign and change the tag
+delimiters from {{ and }} to custom strings.
+
+Consider the following contrived example:
+
+    * {{ default_tags }}
+    {{=<% %>=}}
+    * <% erb_style_tags %>
+    <%={{ }}=%>
+    * {{ default_tags_again }}
+
+Here we have a list with three items. The first item uses the default
+tag style, the second uses erb style as defined by the Set Delimiter
+tag, and the third returns to the default style after yet another Set
+Delimiter declaration.
+
+According to [ctemplates][ct], this "is useful for languages like TeX, where
+double-braces may occur in the text and are awkward to use for
+markup."
+
+Custom delimiters may not contain whitespace or the equals sign.
+
+[ct]: http://google-ctemplate.googlecode.com/svn/trunk/doc/howto.html
+
+
+## COPYRIGHT
+
+Mustache is Copyright (C) 2009 Chris Wanstrath
+
+Original CTemplate by Google
+
+
+## SEE ALSO
+
+mustache(1), mustache(7), gem(1),
+<http://defunkt.github.com/mustache/>

data/test/helper.rb

@@ -11,3 +11,4 @@ require 'comments'
 require 'passenger'
 require 'delimiters'
 require 'double_section'
+require 'nested_objects'

data/test/mustache_test.rb

@@ -21,17 +21,17 @@ end_passenger
     <li><a href="#Blue">blue</a></li>
     </ul>
 end_complex
+  end
 
-# TODO: Preserve indentation
-# http://github.com/defunkt/mustache/issues#issue/2
-#     assert_equal <<-end_complex, ComplexView.render
-# <h1>Colors</h1>
-#   <ul>
-#       <li><strong>red</strong></li>
-#       <li><a href="#Green">green</a></li>
-#       <li><a href="#Blue">blue</a></li>
-#   </ul>
-# end_complex
+  def test_nested_objects
+    assert_equal <<-end_complex, NestedObjects.render
+<h1>Colors</h1>
+<ul>
+  <li><strong>red</strong></li>
+    <li><a href="#Green">green</a></li>
+    <li><a href="#Blue">blue</a></li>
+    </ul>
+end_complex
   end
 
   def test_single_line_sections
@@ -125,6 +125,12 @@ end_section
     assert_equal "<h1>A Comedy of Errors</h1>\n", Comments.render
   end
 
+  def test_multi_linecomments
+    view = Comments.new
+    view.template = "<h1>{{title}}{{! just something interesting... \n#or not... }}</h1>\n"
+    assert_equal "<h1>A Comedy of Errors</h1>\n", view.render
+  end
+
   def test_escaped
     assert_equal '<h1>Bear &gt; Shark</h1>', Escaped.render
   end
@@ -172,14 +178,17 @@ data
                                                      :deploy_to => '/var/www/example.com' )
   end
 
-  def test_reports_type_errors_in_sections
+  def test_doesnt_execute_what_it_doesnt_need_to
     instance = Mustache.new
-    instance[:list] = [ :item, 1234 ]
-    instance.template = '{{#list}} <li>{{item}}</li> {{/list}}'
-
-    assert_raise TypeError do
-      instance.render
+    instance[:show] = false
+    instance.instance_eval do
+      def die
+        raise "bummer"
+      end
     end
+    instance.template = '{{#show}} <li>{{die}}</li> {{/show}} yay'
+
+    assert_equal "yay", instance.render
   end
 
   def test_reports_unclosed_sections

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mustache
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,68 +9,49 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-23 00:00:00 -08:00
-default_executable: mustache
+date: 2010-03-08 00:00:00 -08:00
+default_executable: 
 dependencies: []
 
-description: Mustache is a framework-agnostic way to render logic-free views.
+description: |
+  Inspired by ctemplate, Mustache is a framework-agnostic way to render
+  logic-free views.
+  
+  As ctemplates says, "It emphasizes separating logic from presentation:
+  it is impossible to embed application logic in this template
+  language.
+  
+  Think of Mustache as a replacement for your views. Instead of views
+  consisting of ERB or HAML with random helpers and arbitrary logic,
+  your views are broken into two parts: a Ruby class and an HTML
+  template.
+
 email: chris@ozmm.org
 executables: 
 - mustache
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.md
+extra_rdoc_files: []
+
 files: 
-- .gitignore
-- .kick
-- CONTRIBUTORS
-- HISTORY.md
-- LICENSE
 - README.md
 - Rakefile
-- benchmarks/complex.erb
-- benchmarks/complex.haml
-- benchmarks/helper.rb
-- benchmarks/simple.erb
-- benchmarks/speed.rb
-- bin/mustache
-- contrib/mustache.vim
-- contrib/tpl-mode.el
-- examples/comments.mustache
-- examples/comments.rb
-- examples/complex_view.mustache
-- examples/complex_view.rb
-- examples/delimiters.mustache
-- examples/delimiters.rb
-- examples/double_section.mustache
-- examples/double_section.rb
-- examples/escaped.mustache
-- examples/escaped.rb
-- examples/inner_partial.mustache
-- examples/inner_partial.txt
-- examples/namespaced.mustache
-- examples/namespaced.rb
-- examples/partial_with_module.mustache
-- examples/partial_with_module.rb
-- examples/passenger.conf
-- examples/passenger.rb
-- examples/simple.mustache
-- examples/simple.rb
-- examples/template_partial.mustache
-- examples/template_partial.rb
-- examples/template_partial.txt
-- examples/unescaped.mustache
-- examples/unescaped.rb
-- lib/mustache.rb
+- LICENSE
 - lib/mustache/context.rb
 - lib/mustache/sinatra.rb
 - lib/mustache/template.rb
 - lib/mustache/version.rb
-- lib/rack/bug/panels/mustache_panel.rb
+- lib/mustache.rb
 - lib/rack/bug/panels/mustache_panel/mustache_extension.rb
 - lib/rack/bug/panels/mustache_panel/view.mustache
+- lib/rack/bug/panels/mustache_panel.rb
+- bin/mustache
+- man/mustache.1
+- man/mustache.1.html
+- man/mustache.1.ron
+- man/mustache.5
+- man/mustache.5.html
+- man/mustache.5.ron
 - test/autoloading_test.rb
 - test/helper.rb
 - test/mustache_test.rb
@@ -80,8 +61,8 @@ homepage: http://github.com/defunkt/mustache
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -103,19 +84,5 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Mustache is a framework-agnostic way to render logic-free views.
-test_files: 
-- test/autoloading_test.rb
-- test/helper.rb
-- test/mustache_test.rb
-- test/partial_test.rb
-- examples/comments.rb
-- examples/complex_view.rb
-- examples/delimiters.rb
-- examples/double_section.rb
-- examples/escaped.rb
-- examples/namespaced.rb
-- examples/partial_with_module.rb
-- examples/passenger.rb
-- examples/simple.rb
-- examples/template_partial.rb
-- examples/unescaped.rb
+test_files: []
+

data/.gitignore

@@ -1 +0,0 @@
-docs

data/.kick

@@ -1,26 +0,0 @@
-# take control of the growl notifications
-module GrowlHacks
-  def growl(type, subject, body, *args, &block)
-    case type
-    when Kicker::GROWL_NOTIFICATIONS[:succeeded]
-      puts subject = "Success"
-      body = body.split("\n").last
-    when Kicker::GROWL_NOTIFICATIONS[:failed]
-      subject = "Failure"
-      puts body
-      body = body.split("\n").last
-    else
-      return nil
-    end
-    super(type, subject, body, *args, &block)
-  end
-end
-
-Kicker.send :extend, GrowlHacks
-
-# no logging
-Kicker::Utils.module_eval do
-  def log(message)
-    nil
-  end
-end

data/CONTRIBUTORS

@@ -1,6 +0,0 @@
-* Chris Wanstrath
-* Francesc Esplugas
-* Magnus Holm
-* Nicolas Sanguinetti
-* Jan-Erik Rediger
-* Aaron Patterson

data/HISTORY.md

@@ -1,70 +0,0 @@
-## 0.5.0 (2009-11-23)
-
-* Partial classes are no longer supported. Use modules!
-* Added `mustache` script for rendering templates on the command line.
-* ctemplate compat: Partials are indicated by >, not <
-* Bugfix: Context miss should return nil, not empty string. Fixes 1.9.x
-
-## 0.4.2 (2009-10-28)
-
-* Bugfix: Ignore bad constant names when autoloading
-
-## 0.4.1 (2009-10-27)
-
-* Partials now respect the `view_namespace` setting.
-* Added tpl-mode.el to contrib/ for us Emacs users.
-* Rack::Bug bugfix: ensure benchmark is required before using it
-* Rack::Bug: truncate too-large variables (click expands them)
-
-## 0.4.0 (2009-10-27)
-
-* Stopped raising context miss exceptions by default
-* Added `Mustache.raise_on_context_miss` setting (defaults to false)
-* Throw Mustache::ContextMiss when raise_on_context_miss is true and
-  we encounter a miss.
-* The default template extension is now "mustache" (instead of "html").
-* Added the `view_namespace` and `view_path` settings to `Mustache`
-* Added `Mustache.view_class` method which autoloads a class using the
-  new `view_namespace` and `view_path` settings. Should be used by
-  plugin developers.
-* Updated the Sinatra extension to use the new `view_class` method
-* Unclosed sections now throw a helpful error message
-* Report line numbers on unclosed section errors
-* Added Rack::Bug panel
-
-## 0.3.2 (2009-10-19)
-
-* Bugfix: Partials in Sinatra were using the wrong path.
-
-## 0.3.1 (2009-10-19)
-
-* Added mustache.vim to contrib/ (Thanks Juvenn Woo!)
-* Support string keys in contexts (not just symbol keys).
-* Bugfix: # and / were not permitted in tag names. Now they are.
-* Bugfix: Partials in Sinatra needed to know their extension and path
-* Bugfix: Using the same boolean section twice was failing
-
-## 0.3.0 (2009-10-14)
-
-* Set Delimiter tags are now supported. See the README
-* Improved error message when an enumerable section did not return all
-  hashes.
-* Added a shortcut: if a section's value is a single hash, treat is as
-  a one element array whose value is the hash.
-* Bugfix: String templates set at the class level were not compiled
-* Added a class-level `compiled?` method for checking if a template
-  has been compiled.
-* Added an instance-level `compiled?` method.
-* Cache template compilation in Sinatra
-
-## 0.2.2 (2009-10-11)
-
-* Improved documentation
-* Fixed single line sections
-* Broke preserved indentation (issue #2)
-
-## 0.2.1 (2009-10-11)
-
-* Mustache.underscore can now be called without an argument
-* Settings now mostly live at the class level, excepting `template`
-* Any setting changes causes the template to be recompiled

data/benchmarks/complex.erb

@@ -1,15 +0,0 @@
-<h1><%= header %></h1>
-<% if not item.empty? %>
-  <ul>
-  <% for i in item %>
-    <% if i[:current] %>
-      <li><strong><%= i[:name] %></strong></li>
-    <% else %>
-      <li><a href="<%= i[:url] %>"><%= i[:name] %></a></li>
-    <% end %>
-  <% end %>
-  </ul>
-<% end %>
-<% if item.empty? %>
-  <p>The list is empty.</p>
-<% end %>

data/benchmarks/complex.haml

@@ -1,10 +0,0 @@
-%h1= header
-- item.each do |i|
-  %ul
-    - if i[:current]
-      %li= i[:name]
-    - else
-      %li
-        %a{:href => i[:url]}= i[:name]
-- if item.empty?
-  %p= The list is empty.

data/benchmarks/helper.rb

@@ -1,20 +0,0 @@
-require 'benchmark'
-
-count = (ENV['COUNT'] || 5000).to_i
-
-$benches = []
-def bench(name, &block)
-  $benches.push([name, block])
-end
-
-at_exit do
-  Benchmark.bmbm do |x|
-    $benches.each do |name, block|
-      x.report name.to_s do
-        count.times do
-          block.call
-        end
-      end
-    end
-  end
-end

data/benchmarks/simple.erb

@@ -1,5 +0,0 @@
-Hello <%= name %>
-You have just won $<%= value %>!
-<% if in_ca %>
-Well, $<%= taxed_value %>, after taxes.
-<% end %>

data/benchmarks/speed.rb

@@ -1,76 +0,0 @@
-require 'erb'
-
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require 'helper'
-
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../examples'
-require 'complex_view'
-
-## erb
-template = File.read(File.dirname(__FILE__) + '/complex.erb')
-
-unless ENV['NOERB']
-  erb =  ERB.new(template)
-  scope = ComplexView.new.send(:binding)
-  bench 'ERB  w/ caching' do
-    erb.result(scope)
-  end
-
-  unless ENV['CACHED']
-    scope = ComplexView.new.send(:binding)
-    bench 'ERB  w/o caching' do
-      ERB.new(template).result(scope)
-    end
-  end
-end
-
-
-## haml
-require 'haml'
-template = File.read(File.dirname(__FILE__) + '/complex.haml')
-
-unless ENV['NOHAML']
-  haml = Haml::Engine.new(template)
-  scope = ComplexView.new.send(:binding)
-  bench 'HAML w/ caching' do
-    haml.render(scope)
-  end
-
-  unless ENV['CACHED']
-    scope = ComplexView.new.send(:binding)
-    bench 'HAML w/o caching' do
-      Haml::Engine.new(template).render(scope)
-    end
-  end
-end
-
-
-## mustache
-tpl = ComplexView.new
-tpl.template
-
-tpl[:header] = 'Chris'
-tpl[:empty] = false
-tpl[:list] = true
-
-items = []
-items << { :name => 'red', :current => true, :url => '#Red' }
-items << { :name => 'green', :current => false, :url => '#Green' }
-items << { :name => 'blue', :current => false, :url => '#Blue' }
-
-tpl[:item] = items
-
-bench '{{   w/ caching' do
-  tpl.to_html
-end
-
-content = File.read(ComplexView.template_file)
-
-unless ENV['CACHED']
-  bench '{{   w/o caching' do
-    ctpl = ComplexView.new
-    ctpl.template = content
-    ctpl[:item] = items
-    ctpl.to_html
-  end
-end