mustache 0.1.0 → 0.1.1

data/.gitignore

@@ -1 +1 @@
-doc
+docs

data/README.md

@@ -23,7 +23,7 @@ We call the Ruby class the "view" and the HTML template the
 
 All your logic, decisions, and code is contained in your view. All
 your markup is contained in your template. The template does nothing
-but reference methods in your view. 
+but reference methods in your view.
 
 This strict separation makes it easier to write clean templates,
 easier to test your views, and more fun to work on your app's front end.
@@ -41,6 +41,13 @@ in my HTML, or putting JavaScript in my HTML.
 Usage
 -----
 
+Quick example:
+
+    >> require 'mustache'
+    => true
+    >> Mustache.render("Hello {{planet}}", :planet => "World!")
+    => "Hello World!"
+
 We've got an `examples` folder but here's the canonical one:
 
     class Simple < Mustache
@@ -100,7 +107,7 @@ no `name` method, an exception will be raised.
 
 All variables are HTML escaped by default. If you want, for some
 reason, to return unescaped HTML you can use the triple mustache:
-`{{{name}}}`. 
+`{{{name}}}`.
 
 ### Boolean Sections
 
@@ -118,7 +125,7 @@ between the pound and slash will be rendered and displayed.
 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. 
+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
@@ -144,7 +151,7 @@ the database.
 Comments begin with a bang and are ignored. The following template:
 
     <h1>Today{{! ignore me }}.</h1>
-    
+
 Will render as follows:
 
     <h1>Today.</h1>
@@ -173,14 +180,14 @@ Given this template (dict.html):
     You have just won ${{value}}!
 
 We can fill in the values at will:
-    
+
     dict = Dict.new
     dict[:name] = 'George'
     dict[:value] = 100
     dict.to_html
 
 Which returns:
-    
+
     Hello George
     You have just won $100!
 
@@ -200,7 +207,7 @@ on disk by searching for an HTML file in the current directory that
 follows the classic Ruby naming convention.
 
     TemplatePartial => ./template_partial.html
-    
+
 You can set the search path using `Mustache.path`. It can be set on a
 class by class basis:
 
@@ -216,7 +223,7 @@ If you want to just change what template is used you can set
 `Mustache.template_file` directly:
 
     Simple.template_file = './blah.html'
-    
+
 You can also go ahead and set the template directly:
 
     Simple.template = 'Hi {{person}}!'
@@ -232,7 +239,7 @@ Helpers
 -------
 
 What about global helpers? Maybe you have a nifty `gravatar` function
-you want to use in all your views? No problem. 
+you want to use in all your views? No problem.
 
 This is just Ruby, after all.
 
@@ -251,7 +258,7 @@ This is just Ruby, after all.
       end
     end
 
-Then just include it:    
+Then just include it:
 
     class Simple < Mustache
       include ViewHelpers
@@ -297,11 +304,33 @@ Now:
 Convoluted but you get the idea.
 
 
+Installation
+------------
+
+### [Gemcutter](http://gemcutter.org/)
+
+    $ gem install mustache
+
+### [Rip](http://hellorip.com)
+
+    $ rip install git://github.com/defunkt/mustache.git
+
+
+Acknowledgements
+----------------
+
+Thanks to [Tom Preston-Werner](http://github.com/mojombo) for showing
+me ctemplate and [Leah Culver](http://github.com/leah) for the name "Mustache."
+
+
 Meta
 ----
 
 * Code: `git clone git://github.com/defunkt/mustache.git`
+* Home: <http://github.com/defunkt/mustache>
+* Docs: <http://defunkt.github.com/mustache>
 * Bugs: <http://github.com/defunkt/mustache/issues>
 * List: <http://groups.google.com/group/mustache-rb>
 * Test: <http://runcoderun.com/defunkt/mustache>
+* Gems: <http://gemcutter.org/gems/mustache>
 * Boss: Chris Wanstrath :: <http://github.com/defunkt>

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require 'rake/rdoctask'
 
 task :default => :test
 
@@ -25,12 +26,8 @@ rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-desc "Build sdoc documentation"
-task :doc do
-  File.open('README.html', 'w') do |f|
-    require 'rdiscount'
-    f.puts Markdown.new(File.read('README.md')).to_html
-  end
-
-  exec "sdoc -N --main=README.html README.html LICENSE lib"
+begin
+  require 'sdoc_helpers'
+rescue LoadError
+  puts "sdoc support not enabled. Please gem install sdoc-helpers."
 end

data/benchmarks/speed.rb

@@ -10,14 +10,14 @@ require 'complex_view'
 template = File.read(File.dirname(__FILE__) + '/complex.erb')
 
 unless ENV['NOERB']
-  bench 'ERB w/o caching' do
-    ERB.new(template).result(ComplexView.new.send(:binding))
-  end
-
   erb =  ERB.new(template)
   bench 'ERB w/ caching' do
     erb.result(ComplexView.new.send(:binding))
   end
+
+  bench 'ERB w/o caching' do
+    ERB.new(template).result(ComplexView.new.send(:binding))
+  end
 end
 
 ## mustache
@@ -39,8 +39,11 @@ bench '{ w/ caching' do
   tpl.to_html
 end
 
+content = File.read(ComplexView.template_file)
+
 bench '{ w/o caching' do
   tpl = ComplexView.new
+  tpl.template = content
   tpl[:item] = items
   tpl.to_html
 end

data/examples/passenger.conf

@@ -0,0 +1,5 @@
+<VirtualHost *>
+  ServerName {{server}}
+  DocumentRoot {{deploy_to}}
+  RailsEnv {{stage}}
+</VirtualHost>

data/examples/passenger.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'mustache'
+
+class Passenger < Mustache
+
+  self.path = File.dirname(__FILE__)
+  self.template_extension = 'conf'
+
+  def server
+    "example.com"
+  end
+
+  def deploy_to
+    "/var/www/example.com"
+  end
+
+  def stage
+    "production"
+  end
+
+  def timestamp
+    Time.now.strftime('%Y%m%d%H%M%S')
+  end
+
+end
+
+if $0 == __FILE__
+  puts Passenger.to_text
+end

data/lib/mustache.rb

@@ -22,7 +22,8 @@ class Mustache
       "\"#{compile_sections(src)}\""
     end
 
-  private
+  ## private
+
     # {{#sections}}okay{{/sections}}
     #
     # Sections can return true, false, or an enumerable.
@@ -73,7 +74,7 @@ class Mustache
     def compile_partial(name)
       klass = Mustache.classify(name)
       if Object.const_defined?(klass)
-        ev("#{klass}.to_html")
+        ev("#{klass}.render")
       else
         src = File.read(@template_path + '/' + name + '.html')
         compile(src)[1..-2]
@@ -120,8 +121,13 @@ class Mustache
   end
 
   # Helper method for quickly instantiating and rendering a view.
-  def self.to_html
-    new.to_html
+  def self.render(*args)
+    new.render(*args)
+  end
+
+  class << self
+    alias_method :to_html, :render
+    alias_method :to_text, :render
   end
 
   # The path informs your Mustache subclass where to look for its
@@ -134,11 +140,11 @@ class Mustache
     @path || '.'
   end
 
-  # Templates are self.class.name.underscore + '.html' -- a class of
+  # Templates are self.class.name.underscore + extension -- a class of
   # Dashboard would have a template (relative to the path) of
   # dashboard.html
   def self.template_file
-    @template_file ||= path + '/' + underscore(to_s) + '.html'
+    @template_file ||= path + '/' + underscore(to_s) + '.' + template_extension
   end
 
   def self.template_file=(template_file)
@@ -149,6 +155,15 @@ class Mustache
     @template ||= templateify(File.read(template_file))
   end
 
+  # Default extension is 'html'
+  def self.template_extension
+    @template_extension ||= 'html'
+  end
+
+  def self.template_extension=(template_extension)
+    @template_extension = template_extension
+  end
+
   # template_partial => TemplatePartial
   def self.classify(underscored)
     underscored.split(/[-_]/).map { |part| part[0] = part[0].chr.upcase; part }.join
@@ -204,15 +219,11 @@ class Mustache
     context[key.to_sym] = value
   end
 
-  # How we turn a view object into HTML. The main method, if you will.
-  def to_html
-    render template
-  end
-
-  # Parses our fancy pants template HTML and returns normal HTML with
+  # Parses our fancy pants template file and returns normal file with
   # all special {{tags}} and {{#sections}}replaced{{/sections}}.
-  def render(html, ctx = {})
-    html = self.class.templateify(html)
-    html.render(context.update(ctx))
+  def render(data = template, ctx = {})
+    self.class.templateify(data).render(context.update(ctx))
   end
+  alias_method :to_html, :render
+  alias_method :to_text, :render
 end

data/lib/mustache/sinatra.rb

@@ -1,29 +1,28 @@
-=begin
-Support for Mustache in your Sinatra app.
-
-  require 'mustache/sinatra'
-
-  class App < Sinatra::Base
-    helpers Mustache::Sinatra
-
-    get '/stats' do
-      mustache :stats
-    end
-  end
-
-If a `Views::Stats` class exists in the above example,
-Mustache will try to instantiate and use it for the rendering.
-
-If no `Views::Stats` class exists Mustache will render the template
-file directly.
-
-You can indeed use layouts with this library. Where you'd normally
-<%= yield %> you instead {{yield}} - the body of the subview is
-set to the `yield` variable and made available to you.
-=end
+require 'sinatra/base'
 require 'mustache'
 
 class Mustache
+  # Support for Mustache in your Sinatra app.
+  #
+  #   require 'mustache/sinatra'
+  #
+  #   class App < Sinatra::Base
+  #     helpers Mustache::Sinatra
+  #
+  #     get '/stats' do
+  #       mustache :stats
+  #     end
+  #   end
+  #
+  # If a `Views::Stats` class exists in the above example,
+  # Mustache will try to instantiate and use it for the rendering.
+  #
+  # If no `Views::Stats` class exists Mustache will render the template
+  # file directly.
+  #
+  # You can indeed use layouts with this library. Where you'd normally
+  # <%= yield %> you instead {{{yield}}} - the body of the subview is
+  # set to the `yield` variable and made available to you.
   module Sinatra
     # Call this in your Sinatra routes.
     def mustache(template, options={}, locals={})
@@ -41,6 +40,10 @@ class Mustache
         instance = Mustache.new
       end
 
+      instance_variable_names.each do |name|
+        instance.instance_variable_set(name, instance_variable_get(name))
+      end
+
       locals.each do |local, value|
         instance[local] = value
       end
@@ -54,3 +57,5 @@ class Mustache
     end
   end
 end
+
+Sinatra.helpers Mustache::Sinatra

data/lib/mustache/version.rb

@@ -0,0 +1,3 @@
+class Mustache
+  Version = '0.1.1'
+end

data/test/mustache_test.rb

@@ -8,8 +8,20 @@ require 'template_partial'
 require 'escaped'
 require 'unescaped'
 require 'comments'
+require 'passenger'
 
 class MustacheTest < Test::Unit::TestCase
+
+  def test_passenger
+    assert_equal <<-end_passenger, Passenger.to_text
+<VirtualHost *>
+  ServerName example.com
+  DocumentRoot /var/www/example.com
+  RailsEnv production
+</VirtualHost>
+end_passenger
+  end
+
   def test_complex_view
     assert_equal <<-end_complex, ComplexView.to_html
 <h1>Colors</h1>
@@ -108,4 +120,27 @@ end_partial
   def test_namespaced_underscore
     assert_equal 'stat_stuff', Mustache.underscore('Views::StatStuff')
   end
-end
+
+  def test_render
+    assert_equal 'Hello World!', Mustache.render('Hello World!')
+  end
+
+  def test_render_with_params
+    assert_equal 'Hello World!', Mustache.render('Hello {{planet}}!', :planet => 'World')
+  end
+
+  def test_render_from_file
+    expected = <<-data
+<VirtualHost *>
+  ServerName example.com
+  DocumentRoot /var/www/example.com
+  RailsEnv production
+</VirtualHost>
+data
+    template = File.read("examples/passenger.conf")
+    assert_equal expected, Mustache.render(template, :stage => 'production', 
+                                                     :server => 'example.com', 
+                                                     :deploy_to => '/var/www/example.com' )
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mustache
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-05 00:00:00 -07:00
+date: 2009-10-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,8 @@ files:
 - examples/escaped.html
 - examples/escaped.rb
 - examples/inner_partial.html
+- examples/passenger.conf
+- examples/passenger.rb
 - examples/simple.html
 - examples/simple.rb
 - examples/template_partial.html
@@ -48,6 +50,7 @@ files:
 - examples/view_partial.rb
 - lib/mustache.rb
 - lib/mustache/sinatra.rb
+- lib/mustache/version.rb
 - test/mustache_test.rb
 has_rdoc: true
 homepage: http://github.com/defunkt/mustache
@@ -82,6 +85,7 @@ test_files:
 - examples/comments.rb
 - examples/complex_view.rb
 - examples/escaped.rb
+- examples/passenger.rb
 - examples/simple.rb
 - examples/template_partial.rb
 - examples/unescaped.rb