mustache 0.4.2 → 0.5.0

data/CONTRIBUTORS

@@ -3,3 +3,4 @@
 * Magnus Holm
 * Nicolas Sanguinetti
 * Jan-Erik Rediger
+* Aaron Patterson

data/HISTORY.md

@@ -1,3 +1,10 @@
+## 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

data/README.md

@@ -176,13 +176,32 @@ Will render as follows:
 
 ### Partials
 
-Partials begin with a less than sign, like `{{< box}}`.
+Partials begin with a greater than sign, like `{{> box}}`.
 
-If a partial's view is loaded, we use that to render the HTML. If
-nothing is loaded we render the template directly using our current context.
+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.
 
-In this way partials can reference variables or sections the calling
-view defines.
+For example, this template and partial:
+
+    base.mustache
+    Names:
+    {{# names }}
+      {{> user }}
+    {{/ names }}
+
+    user.mustache:
+    <strong>{{ name }}</strong>
+
+Can be thought of as a single, expanded template:
+
+    Names:
+    {{# names }}
+      <strong>{{ name }}</strong>
+    {{/ names }}
+
+Have partial-specific code you want to share between view classes?
+Consider using a module and including it.
 
 
 ### Set Delimiter
@@ -376,7 +395,7 @@ An example Sinatra application is also provided:
 
 
 [Rack::Bug][4]
----------
+--------------
 
 Mustache also ships with a `Rack::Bug` panel. In your `config.ru` add
 the following code:
@@ -400,13 +419,63 @@ is included under the contrib/ directory.
 
 
 Emacs
-----
+-----
 
 tpl-mode.el is included under the contrib/ directory for any Emacs users.
 Based on Google's tpl-mode for ctemplates, it adds support for Mustache's
 more lenient tag values and includes a few commands for your editing pleasure.
 
 
+TextMate
+--------
+
+Check out Tekkub's
+[Mustache.tmbundle](http://github.com/tekkub/Mustache.tmbundle).
+
+
+Command Line
+------------
+
+Mustache includes a `mustache` script for rendering templates on the
+command line. This can be useful when designing HTML that will
+eventually be included in a website: instead of having to format the
+HTML as Mustache later, you can do it now!
+
+The script expects a Mustache template on STDIN with YAML
+frontmatter. An example looks like this:
+
+    $ cat complete.mustache
+    ---
+    names: [ {name: chris}, {name: mark}, {name: scott} ]
+    ---
+    {{#names}}
+      Hi {{name}}!
+    {{/names}}
+
+    $ cat complete.mustache | mustache
+    Hi chris!
+    Hi mark!
+    Hi scott!
+
+It's probably more useful to keep the YAML and HTML in separate files,
+though. Luckily `cat` works great for this, too:
+
+    $ 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!
+
+
 Installation
 ------------
 

data/Rakefile

@@ -15,7 +15,7 @@ task :gem => [ :gemspec, :build ]
 desc "Launch Kicker (like autotest)"
 task :kicker do
   puts "Kicking... (ctrl+c to cancel)"
-  exec "kicker -e rake test lib"
+  exec "kicker -e rake test lib examples"
 end
 
 begin
@@ -46,6 +46,7 @@ desc "Push a new version to Gemcutter"
 task :publish => [ :test, :gemspec, :build ] do
   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"
   exec "rake pages"

data/bin/mustache

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'mustache'
+require 'yaml'
+
+if STDIN.stat.size > 0
+  doc = STDIN.read
+  if doc =~ /^(\s*---(.*)---\s*)/m
+    data = YAML.load($2.strip)
+    puts Mustache.render(doc.sub($1, ''), data)
+  else
+    puts doc
+  end
+else
+  puts <<-usage
+Usage: cat data.yml template.mustache | mustache
+
+Expects a single Mustache template on STDIN complete with YAML
+frontmatter.
+
+Runs template.mustache through Mustache, using the data in data.yml to
+replace sections and variables. Useful when developing templates
+before hooking them into your website or whatnot.
+
+The data.yml file should start with --- on a single line and end with
+--- on a single line, e.g.
+
+    ---
+    names: [ {name: chris}, {name: mark}, {name: scott} ]
+    ---
+
+The converted document will be printed on STDOUT.
+usage
+end

data/examples/namespaced.rb

@@ -11,14 +11,11 @@ module TestViews
   end
 
   class NamespacedWithPartial < Mustache
-    self.template = "My opinion: {{<MyPartial}}"
-  end
-
-  class MyPartial < Mustache
-    self.template = "{{exclamation}}!"
+    self.path = File.dirname(__FILE__)
+    self.template = "My opinion: {{>inner_partial}}"
 
-    def exclamation
-      :Victory
+    def title
+      "Victory"
     end
   end
 end

data/examples/partial_with_module.mustache

@@ -0,0 +1,3 @@
+<h1>{{greeting}}</h1>
+{{>simple}}
+<h3>{{farewell}}</h3>

data/examples/partial_with_module.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'mustache'
+
+module SimpleView
+  def name
+    "Bob"
+  end
+
+  def value
+    100_000
+  end
+
+  def taxed_value
+    value - (value * 0.4)
+  end
+
+  def in_ca
+    false
+  end
+end
+
+class PartialWithModule < Mustache
+  include SimpleView
+  self.path = File.dirname(__FILE__)
+
+  def greeting
+    "Welcome"
+  end
+
+  def farewell
+    "Fair enough, right?"
+  end
+end
+
+if $0 == __FILE__
+  puts PartialWithModule.to_html
+end

data/examples/template_partial.mustache

@@ -1,2 +1,2 @@
 <h1>{{title}}</h1>
-{{<inner_partial}}
+{{>inner_partial}}

data/examples/template_partial.txt

@@ -1,4 +1,4 @@
 {{title}}
 {{title_bars}}
 
-{{<inner_partial}}
+{{>inner_partial}}

data/lib/mustache/context.rb

@@ -27,7 +27,7 @@ class Mustache
       elsif @mustache.raise_on_context_miss?
         raise ContextMiss.new("Can't find #{name} in #{@mustache.inspect}")
       else
-        ''
+        nil
       end
     end
   end

data/lib/mustache/template.rb

@@ -103,10 +103,10 @@ class Mustache
     # 1. Escaped variable tags - {{var}}
     # 2. Unescaped variable tags - {{{var}}}
     # 3. Comment variable tags - {{! comment}
-    # 4. Partial tags - {{< partial_name }}
+    # 4. Partial tags - {{> partial_name }}
     def compile_tags(src)
       res = ""
-      while src =~ /#{otag}(#|=|!|<|\{)?(.+?)\1?#{ctag}+/
+      while src =~ /#{otag}(#|=|!|<|>|\{)?(.+?)\1?#{ctag}+/
         res << str($`)
         case $1
         when '#'
@@ -117,7 +117,7 @@ class Mustache
           # ignore comments
         when '='
           self.otag, self.ctag = $2.strip.split(' ', 2)
-        when '<'
+        when '>', '<'
           res << compile_partial($2.strip)
         when '{'
           res << utag($2.strip)
@@ -131,13 +131,8 @@ class Mustache
 
     # Partials are basically a way to render views from inside other views.
     def compile_partial(name)
-      klass = Mustache.view_class(name)
-      if klass != Mustache
-        ev("#{klass}.render")
-      else
-        src = File.read("#{@template_path}/#{name}.#{@template_extension}")
-        compile(src)[1..-2]
-      end
+      src = File.read("#{@template_path}/#{name}.#{@template_extension}")
+      compile(src)[1..-2]
     end
 
     # Generate a temporary id, used when compiling code.

data/lib/mustache/version.rb

@@ -1,3 +1,3 @@
 class Mustache
-  Version = '0.4.2'
+  Version = '0.5.0'
 end

data/test/autoloading_test.rb

@@ -1,4 +1,5 @@
-require 'test/unit'
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'helper'
 
 module TestViews; end
 
@@ -41,7 +42,7 @@ end_render
     klass = Mustache.view_class(:namespaced_with_partial)
     assert_equal TestViews::NamespacedWithPartial, klass
     assert_equal <<-end_render.strip, klass.render
-My opinion: Victory!
+My opinion: Again, Victory!
 end_render
   end
 

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'test/unit'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../examples'
+require 'simple'
+require 'complex_view'
+require 'partial_with_module'
+require 'template_partial'
+require 'escaped'
+require 'unescaped'
+require 'comments'
+require 'passenger'
+require 'delimiters'
+require 'double_section'

data/test/mustache_test.rb

@@ -1,16 +1,5 @@
-require 'test/unit'
-
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../examples'
-require 'simple'
-require 'complex_view'
-require 'view_partial'
-require 'template_partial'
-require 'escaped'
-require 'unescaped'
-require 'comments'
-require 'passenger'
-require 'delimiters'
-require 'double_section'
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'helper'
 
 class MustacheTest < Test::Unit::TestCase
   def test_passenger
@@ -113,46 +102,15 @@ end_simple
     assert_equal 'Hi mom!', view.render
   end
 
-  def test_view_partial
-    assert_equal <<-end_partial.strip, ViewPartial.render
-<h1>Welcome</h1>
-Hello Chris
-You have just won $10000!
-Well, $6000.0, after taxes.
-
-<h3>Fair enough, right?</h3>
-end_partial
-  end
-
-  def test_template_partial
-    assert_equal <<-end_partial.strip, TemplatePartial.render
-<h1>Welcome</h1>
-Again, Welcome!
-end_partial
-  end
-
-  def test_template_partial_with_custom_extension
-    partial = Class.new(TemplatePartial)
-    partial.template_extension = 'txt'
-    partial.template_path = File.dirname(__FILE__) + '/../examples'
-
-    assert_equal <<-end_partial.strip, partial.render.strip
-Welcome
--------
-
-## Again, Welcome! ##
-end_partial
-  end
-
   def test_delimiters
-    assert_equal <<-end_partial, Delimiters.render
+    assert_equal <<-end_template, Delimiters.render
 
 * It worked the first time.
 
 * And it worked the second time.
 
 * Then, surprisingly, it worked the third time.
-end_partial
+end_template
   end
 
   def test_double_section

data/test/partial_test.rb

@@ -0,0 +1,80 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'helper'
+
+class PartialTest < Test::Unit::TestCase
+  def test_view_partial
+    assert_equal <<-end_partial.strip, PartialWithModule.render
+<h1>Welcome</h1>
+Hello Bob
+You have just won $100000!
+
+<h3>Fair enough, right?</h3>
+end_partial
+  end
+
+  def test_view_partial_inherits_context
+    klass = Class.new(TemplatePartial)
+    klass.template_path = File.dirname(__FILE__) + '/../examples'
+    view = klass.new
+    view[:titles] = [{:title => :One}, {:title => :Two}]
+    view.template = <<-end_template
+<h1>Context Test</h1>
+<ul>
+{{#titles}}
+<li>{{>inner_partial}}</li>
+{{/titles}}
+</ul>
+end_template
+    assert_equal <<-end_partial, view.render
+<h1>Context Test</h1>
+<ul>
+<li>Again, One!</li>
+<li>Again, Two!</li>
+</ul>
+end_partial
+  end
+
+  def test_view_partial_inherits_context_of_class_methods
+    klass = Class.new(TemplatePartial)
+    klass.template_path = File.dirname(__FILE__) + '/../examples'
+    klass.send(:define_method, :titles) do
+      [{:title => :One}, {:title => :Two}]
+    end
+    view = klass.new
+    view.template = <<-end_template
+<h1>Context Test</h1>
+<ul>
+{{#titles}}
+<li>{{>inner_partial}}</li>
+{{/titles}}
+</ul>
+end_template
+    assert_equal <<-end_partial, view.render
+<h1>Context Test</h1>
+<ul>
+<li>Again, One!</li>
+<li>Again, Two!</li>
+</ul>
+end_partial
+  end
+
+  def test_template_partial
+    assert_equal <<-end_partial.strip, TemplatePartial.render
+<h1>Welcome</h1>
+Again, Welcome!
+end_partial
+  end
+
+  def test_template_partial_with_custom_extension
+    partial = Class.new(TemplatePartial)
+    partial.template_extension = 'txt'
+    partial.template_path = File.dirname(__FILE__) + '/../examples'
+
+    assert_equal <<-end_partial.strip, partial.render.strip
+Welcome
+-------
+
+## Again, Welcome! ##
+end_partial
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mustache
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,14 +9,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-28 00:00:00 -07:00
-default_executable: 
+date: 2009-11-23 00:00:00 -08:00
+default_executable: mustache
 dependencies: []
 
 description: Mustache is a framework-agnostic way to render logic-free views.
 email: chris@ozmm.org
-executables: []
-
+executables: 
+- mustache
 extensions: []
 
 extra_rdoc_files: 
@@ -35,6 +35,7 @@ files:
 - benchmarks/helper.rb
 - benchmarks/simple.erb
 - benchmarks/speed.rb
+- bin/mustache
 - contrib/mustache.vim
 - contrib/tpl-mode.el
 - examples/comments.mustache
@@ -51,6 +52,8 @@ files:
 - 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
@@ -60,8 +63,6 @@ files:
 - examples/template_partial.txt
 - examples/unescaped.mustache
 - examples/unescaped.rb
-- examples/view_partial.mustache
-- examples/view_partial.rb
 - lib/mustache.rb
 - lib/mustache/context.rb
 - lib/mustache/sinatra.rb
@@ -71,7 +72,9 @@ files:
 - lib/rack/bug/panels/mustache_panel/mustache_extension.rb
 - lib/rack/bug/panels/mustache_panel/view.mustache
 - test/autoloading_test.rb
+- test/helper.rb
 - test/mustache_test.rb
+- test/partial_test.rb
 has_rdoc: true
 homepage: http://github.com/defunkt/mustache
 licenses: []
@@ -102,15 +105,17 @@ 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
-- examples/view_partial.rb

data/examples/view_partial.mustache

@@ -1,3 +0,0 @@
-<h1>{{greeting}}</h1>
-{{<simple}}
-<h3>{{farewell}}</h3>

data/examples/view_partial.rb

@@ -1,18 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'mustache'
-
-class ViewPartial < Mustache
-  self.path = File.dirname(__FILE__)
-
-  def greeting
-    "Welcome"
-  end
-
-  def farewell
-    "Fair enough, right?"
-  end
-end
-
-if $0 == __FILE__
-  puts ViewPartial.to_html
-end