mustache 0.6.0 → 0.7.0

data/README.md

@@ -358,6 +358,8 @@ Meta
 * Test: <http://runcoderun.com/defunkt/mustache>
 * Gems: <http://rubygems.org/gems/mustache>
 
+You can also find us in `#{` on irc.freenode.net.
+
 [1]: http://code.google.com/p/google-ctemplate/
 [2]: http://www.ivan.fomichev.name/2008/05/erlang-template-engine-prototype.html
 [3]: http://google-ctemplate.googlecode.com/svn/trunk/doc/howto.html

data/Rakefile

@@ -14,7 +14,8 @@ task :default => :test
 if command? :turn
   desc "Run tests"
   task :test do
-    exec "turn"
+    suffix = "-n #{ENV['TEST']}" if ENV['TEST']
+    sh "turn test/*.rb #{suffix}"
   end
 else
   Rake::TestTask.new do |t|
@@ -28,7 +29,7 @@ end
 # Ron
 #
 
-if command? :ron
+if command? :ronn
   desc "Show the manual"
   task :man => "man:build" do
     exec "man man/mustache.1"
@@ -36,7 +37,7 @@ if command? :ron
 
   desc "Build the manual"
   task "man:build" do
-    sh "ron -br5 --organization=DEFUNKT --manual='Mustache Manual' man/*.ron"
+    sh "ronn -br5 --organization=DEFUNKT --manual='Mustache Manual' man/*.ron"
   end
 end
 
@@ -64,11 +65,11 @@ begin
 
   desc "Push a new version to Gemcutter and publish docs."
   task :publish => :gemcutter do
+    require File.dirname(__FILE__) + '/lib/mustache/version'
+
     system "git tag v#{Mustache::Version}"
-    system "git push origin v#{Mustache::Version}"
-    system "git push origin master"
-    system "gem push pkg/mustache-#{Mustache::Version}.gem"
-    system "git clean -fd"
+    sh "git push origin master --tags"
+    sh "git clean -fd"
     exec "rake pages"
   end
 rescue LoadError
@@ -87,7 +88,7 @@ end
 # end
 
 desc "Publish to GitHub Pages"
-task :pages => [ "build:man" ] do
+task :pages => [ "man:build" ] do
   Dir['man/*.html'].each do |f|
     cp f, File.basename(f).sub('.html', '.newhtml')
   end

data/bin/mustache

@@ -3,9 +3,41 @@
 require 'mustache'
 require 'yaml'
 
-if !$stdin.tty?
-  doc = $stdin.read
-  if doc =~ /^(\s*---(.*)---\s*)/m
+def help
+  puts <<-usage
+Usage:
+  $ cat data.yml template.mustache | mustache
+  $ mustache data.yml template.mustache
+  $ cat <<data | druby mustache - template.mustache
+---
+name: Bob
+age: 30
+---
+data
+
+See compiled Ruby string:
+  $ mustache -c FILE
+
+Help:
+  $ mustache -h
+
+See mustache(1) or http://defunkt.github.com/mustache/mustache.1.html
+for an overview.
+usage
+end
+
+if (ARGV.delete('-c') || ARGV.delete('--compile')) && (file = ARGV[0])
+  puts Mustache.compile(File.read(file))
+
+elsif ($stdin.tty? && ARGV.empty?) || ARGV.delete('-h') || ARGV.delete('--help')
+  help
+
+else
+  # Not at a terminal, read from STDIN and print rendered templates to
+  # STDOUT.
+  doc = ARGF.read
+
+  if doc =~ /^(\s*---(.+)---\s*)/m
     yaml = $2.strip
     template = doc.sub($1, '')
 
@@ -15,11 +47,5 @@ if !$stdin.tty?
   else
     puts doc
   end
-else
-  puts <<-usage
-Usage: cat data.yml template.mustache | mustache
-
-See mustache(1) or http://defunkt.github.com/mustache/mustache.1.html
-for an overview.
-usage
+  exit
 end

data/lib/mustache.rb

@@ -85,6 +85,21 @@ class Mustache
     render(*args)
   end
 
+  # Compiles a string template and returns it as a string for use as
+  # an interpolated Ruby string (not fully rendered HTML), e.g.
+  # >> Mustache.compile("Hi, {{person}}!")
+  # => "Hi, #{CGI.escapeHTML(ctx[:person].to_s)}!"
+  def self.compile(template)
+    templateify(template).to_s
+  end
+
+  # Given a file name and an optional context, attempts to load and
+  # render the file as a template.
+  def self.render_file(name, context = {})
+    data = File.read("#{template_path}/#{name}.#{template_extension}")
+    render(data, context)
+  end
+
   # The template path informs your Mustache subclass where to look for its
   # corresponding template. By default it's the current directory (".")
   def self.template_path
@@ -116,6 +131,17 @@ class Mustache
     @template = nil
   end
 
+  # The template name is the Mustache template file without any
+  # extension or other information. Defaults to `class_name`.
+  def self.template_name
+    @template_name || underscore
+  end
+
+  def self.template_name=(template_name)
+    @template_name = template_name
+    @template = nil
+  end
+
   # The template file is the absolute path of the file Mustache will
   # use as its template. By default it's ./class_name.mustache
   def self.template_file

data/lib/mustache/context.rb

@@ -18,6 +18,21 @@ class Mustache
       @stack = [@mustache]
     end
 
+    # A {{>partial}} tag translates into a call to the context's
+    # `partial` method, which would be this sucker right here.
+    #
+    # If the Mustache view handling the rendering (e.g. the view
+    # representing your profile page or some other template) responds
+    # to `partial`, we call it and use the result. Otherwise we render
+    # and compile the partial as its own view and return the result.
+    def partial(name)
+      if @mustache.respond_to? :partial
+        @mustache.partial(name)
+      else
+        @mustache.class.render_file(name, self)
+      end
+    end
+
     # Adds a new object to the context's internal stack.
     #
     # Returns the Context.
@@ -48,6 +63,14 @@ class Mustache
       fetch(name, nil)
     end
 
+    # Do we know about a particular key? In other words, will calling
+    # `context[key]` give us a result that was set. Basically.
+    def has_key?(key)
+      !!fetch(key)
+    rescue ContextMiss
+      false
+    end
+
     # Similar to Hash#fetch, finds a value by `name` in the context's
     # stack. You may specify the default return value by passing a
     # second parameter.

data/lib/mustache/template.rb

@@ -59,6 +59,7 @@ class Mustache
     def compile(src = @source)
       "\"#{compile_sections(src)}\""
     end
+    alias_method :to_s, :compile
 
     # {{#sections}}okay{{/sections}}
     #
@@ -73,7 +74,6 @@ class Mustache
         res << compile_tags($`)
         name = $1.strip.to_sym.inspect
         code = compile($2)
-        ctxtmp = "ctx#{tmpid}"
         res << ev(<<-compiled)
         if v = ctx[#{name}]
           v = [v] unless v.is_a?(Array) # shortcut when passed non-array
@@ -94,7 +94,7 @@ class Mustache
     # 4. Partial tags - {{> partial_name }}
     def compile_tags(src)
       res = ""
-      while src =~ /#{otag}(#|=|!|<|>|\{)?(.+?)\1?#{ctag}+/m
+      while src =~ /#{otag}(#|=|!|<|>|&|\{)?(.+?)\1?#{ctag}+/m
         res << str($`)
         case $1
         when '#'
@@ -107,7 +107,7 @@ class Mustache
           self.otag, self.ctag = $2.strip.split(' ', 2)
         when '>', '<'
           res << compile_partial($2.strip)
-        when '{'
+        when '{', '&'
           res << utag($2.strip)
         else
           res << etag($2.strip)
@@ -119,8 +119,8 @@ class Mustache
 
     # Partials are basically a way to render views from inside other views.
     def compile_partial(name)
-      src = File.read("#{@template_path}/#{name}.#{@template_extension}")
-      compile(src)[1..-2]
+      name = name.to_s.to_sym.inspect
+      ev("ctx.partial(#{name})")
     end
 
     # Generate a temporary id, used when compiling code.
@@ -157,6 +157,7 @@ class Mustache
     end
 
     # {{{}}} - an unescaped tag
+    # Aliased as & - {{&name}}
     def utag(s)
       ev("ctx[#{s.strip.to_sym.inspect}]")
     end

data/lib/mustache/version.rb

@@ -1,3 +1,3 @@
 class Mustache
-  Version = '0.6.0'
+  Version = '0.7.0'
 end

data/man/mustache.1

@@ -1,5 +1,5 @@
-.\" generated with Ron/v0.3
-.\" http://github.com/rtomayko/ron/
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
 .
 .TH "MUSTACHE" "1" "March 2010" "DEFUNKT" "Mustache Manual"
 .
@@ -19,16 +19,15 @@ 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.
+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
-
-\fB---
+\-\-\-
 names: [ {name: chris}, {name: mark}, {name: scott} ]
---- \fR
+\-\-\-
 .
 .fi
 .
@@ -48,10 +47,9 @@ For example:
 .IP "" 4
 .
 .nf
-
-\fB{{#names}}
+{{#names}}
   Hi {{name}}!
-{{/names}} \fR
+{{/names}}
 .
 .fi
 .
@@ -63,28 +61,25 @@ Now let's combine them.
 .IP "" 4
 .
 .nf
-
-\fB$ cat data.yml
----
+$ cat data.yml
+\-\-\-
 names: [ {name: chris}, {name: mark}, {name: scott} ]
---- 
+\-\-\-
 $ cat template.mustache
 {{#names}}
   Hi {{name}}!
 {{/names}}
-
 $ cat data.yml template.mustache | mustache
 Hi chris!
 Hi mark!
 Hi scott!
-\fR
 .
 .fi
 .
 .IP "" 0
 .
 .P
-If you provide multiple YAML documents (as delimited by \fB---\fR), your
+If you provide multiple YAML documents (as delimited by \fB\-\-\-\fR), your
 template will be rendered multiple times. Like a mail merge.
 .
 .P
@@ -93,23 +88,20 @@ For example:
 .IP "" 4
 .
 .nf
-
-\fB$ cat data.yml
----
+$ cat data.yml
+\-\-\-
 name: chris
----
+\-\-\-
 name: mark
----
+\-\-\-
 name: scott
---- 
+\-\-\-
 $ cat template.mustache
 Hi {{name}}!
-
 $ cat data.yml template.mustache | mustache
 Hi chris!
 Hi mark!
 Hi scott!
-\fR
 .
 .fi
 .
@@ -121,8 +113,7 @@ If you have RubyGems installed:
 .IP "" 4
 .
 .nf
-
-\fBgem install mustache \fR
+gem install mustache
 .
 .fi
 .

data/man/mustache.1.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta http-equiv='content-type' value='text/html;charset=utf8'>
-  <meta name='generator' value='Ron/v0.3'>
+  <meta name='generator' value='Ronn/v0.4.1'>
   <title>mustache(1) -- Mustache processor</title>
   <style type='text/css'>
     body {margin:0}
@@ -64,6 +64,7 @@
 
 <h2 id='NAME'>NAME</h2>
 <p><code>mustache</code> -- Mustache processor</p>
+
 <h2>SYNOPSIS</h2>
 
 <p><code>cat data.yml template.mustache | mustache</code></p>
@@ -157,6 +158,7 @@ Hi scott!
 <p>mustache(5), mustache(7), gem(1),
 <a href="http://defunkt.github.com/mustache/">http://defunkt.github.com/mustache/</a></p>
 
+
 <ol class='foot man'>
   <li class='tl'>DEFUNKT</li>
   <li class='tc'>March 2010</li>

data/man/mustache.5

@@ -1,5 +1,5 @@
-.\" generated with Ron/v0.3
-.\" http://github.com/rtomayko/ron/
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
 .
 .TH "MUSTACHE" "5" "March 2010" "DEFUNKT" "Mustache Manual"
 .
@@ -12,12 +12,11 @@ A typical Mustache template:
 .IP "" 4
 .
 .nf
-
-\fBHello {{name}}
+Hello {{name}}
 You have just won ${{value}}!
 {{#in_ca}}
 Well, ${{taxed_value}}, after taxes.
-{{/in_ca}} \fR
+{{/in_ca}}
 .
 .fi
 .
@@ -29,13 +28,12 @@ Given the following hash:
 .IP "" 4
 .
 .nf
-
-\fB{
+{
   "name": "Chris",
   "value": 10000,
-  "taxed_value": 10000 - (10000 * 0.4),
+  "taxed_value": 10000 \- (10000 * 0.4),
   "in_ca": true
-} \fR
+}
 .
 .fi
 .
@@ -47,10 +45,9 @@ Will produce the following:
 .IP "" 4
 .
 .nf
-
-\fBHello Chris
+Hello Chris
 You have just won $10000!
-Well, $6000.0, after taxes. \fR
+Well, $6000.0, after taxes.
 .
 .fi
 .
@@ -81,6 +78,10 @@ All variables are HTML escaped by default. If you want to return
 unescaped HTML, use the triple mustache: \fB{{{name}}}\fR.
 .
 .P
+You can also use \fB&\fR to unescape a variable: \fB{{& name}}\fR. This may be
+useful when changing delimiters (see "Set Delimter" below).
+.
+.P
 By default a variable "miss" returns an empty string. This can usually
 be configured in your Mustache library.
 .
@@ -90,11 +91,10 @@ Template:
 .IP "" 4
 .
 .nf
-
-\fB* {{name}}
+* {{name}}
 * {{age}}
 * {{company}}
-* {{{company}}} \fR
+* {{{company}}}
 .
 .fi
 .
@@ -106,11 +106,10 @@ Hash:
 .IP "" 4
 .
 .nf
-
-\fB{
+{
   "name": "Chris",
   "company": "<b>GitHub</b>"
-} \fR
+}
 .
 .fi
 .
@@ -122,11 +121,10 @@ Output:
 .IP "" 4
 .
 .nf
-
-\fB* Chris
+* Chris
 *
 * &lt;b&gt;GitHub&lt;/b&gt;
-* <b>GitHub</b> \fR
+* <b>GitHub</b>
 .
 .fi
 .
@@ -149,13 +147,12 @@ Template:
 .IP "" 4
 .
 .nf
-
-\fB{{#person}}
+{{#person}}
   Shown!
 {{/person}}
 {{#anything_else}}
   Never shown!
-{{/anything_else}} \fR
+{{/anything_else}}
 .
 .fi
 .
@@ -167,10 +164,9 @@ Hash:
 .IP "" 4
 .
 .nf
-
-\fB{
+{
   "person": true
-} \fR
+}
 .
 .fi
 .
@@ -182,8 +178,7 @@ Output:
 .IP "" 4
 .
 .nf
-
-\fBShown! \fR
+Shown!
 .
 .fi
 .
@@ -206,10 +201,9 @@ Template:
 .IP "" 4
 .
 .nf
-
-\fB{{#repo}}
+{{#repo}}
   <b>{{name}}</b>
-{{/repo}} \fR
+{{/repo}}
 .
 .fi
 .
@@ -221,14 +215,13 @@ Hash:
 .IP "" 4
 .
 .nf
-
-\fB{
+{
   "repo": [
     { "name": "resque" },
     { "name": "hub" },
     { "name": "rip" },
   ]
-} \fR
+}
 .
 .fi
 .
@@ -240,10 +233,9 @@ Output:
 .IP "" 4
 .
 .nf
-
-\fB<b>resque</b>
+<b>resque</b>
 <b>hub</b>
-<b>rip</b> \fR
+<b>rip</b>
 .
 .fi
 .
@@ -255,8 +247,7 @@ Comments begin with a bang and are ignored. The following template:
 .IP "" 4
 .
 .nf
-
-\fB<h1>Today{{! ignore me }}.</h1> \fR
+<h1>Today{{! ignore me }}.</h1>
 .
 .fi
 .
@@ -268,8 +259,7 @@ Will render as follows:
 .IP "" 4
 .
 .nf
-
-\fB<h1>Today.</h1> \fR
+<h1>Today.</h1>
 .
 .fi
 .
@@ -289,15 +279,13 @@ For example, this template and partial:
 .IP "" 4
 .
 .nf
-
-\fBbase.mustache:
+base.mustache:
 <h2>Names</h2>
 {{# names }}
   {{> user }}
-{{/ names }} 
+{{/ names }}
 user.mustache:
 <strong>{{ name }}</strong>
-\fR
 .
 .fi
 .
@@ -309,11 +297,10 @@ Can be thought of as a single, expanded template:
 .IP "" 4
 .
 .nf
-
-\fB<h2>Names</h2>
+<h2>Names</h2>
 {{# names }}
   <strong>{{ name }}</strong>
-{{/ names }} \fR
+{{/ names }}
 .
 .fi
 .
@@ -329,12 +316,11 @@ Consider the following contrived example:
 .IP "" 4
 .
 .nf
-
-\fB* {{ default_tags }}
+* {{ default_tags }}
 {{=<% %>=}}
 * <% erb_style_tags %>
 <%={{ }}=%>
-* {{ default_tags_again }} \fR
+* {{ default_tags_again }}
 .
 .fi
 .