mustache 0.99.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d833a2b9076086446f4ee505f0b05cd069028a99
-  data.tar.gz: 911b43c7a69bf4694d0198945bfb9ca2005acb7c
+  metadata.gz: a9a22c993556413f34a18b5f74023dbf1dfbdd92
+  data.tar.gz: 28b5ac5ef50228c3bc860762c6a70e546022dd3d
 SHA512:
-  metadata.gz: e8bc8262ef5e651d643116de6038312ccfc35880e02bfbc3e9a93f3c0c37d0de59991e32533dfc8f87fac9a95ea24306bc5f57130f6f5ceae4c1cba67f334331
-  data.tar.gz: c55226cd631a7d314e16cc2fc39424458f17f4cc77c65004256d28589cdf8866a5841b4640702c7924efccd2de3f32518ee11cb4a314dd447f4c0fa474d794c1
+  metadata.gz: 0dcaecf69cf26d4a540f5e47d862b5bb318114e74f9885a03f180c510ed5fcff53d91ba56d8a97bd6b45fa8e1272c761230f9fb71c76fca8dd3332a0e1a8e900
+  data.tar.gz: b1bb13fd0e318e55aa037616b86629a00fa3a2b54b350b93d4df738d9de816e9e145804da3519c145c49c2db142a5ff748b24c661d7133565da0ad3683d4c946

data/README.md

@@ -1,5 +1,4 @@
-Mustache
-=========
+# Mustache
 
 Inspired by [ctemplate][1] and [et][2], Mustache is a
 framework-agnostic way to render logic-free views.
@@ -11,8 +10,7 @@ For a list of implementations (other than Ruby) and tips, see
 <http://mustache.github.io/>.
 
 
-Overview
---------
+## Overview
 
 Think of Mustache as a replacement for your views. Instead of views
 consisting of ERB or HAML with random helpers and arbitrary logic,
@@ -30,8 +28,7 @@ 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.
 
 
-Why?
-----
+## Why?
 
 I like writing Ruby. I like writing HTML. I like writing JavaScript.
 
@@ -39,8 +36,18 @@ I don't like writing ERB, Haml, Liquid, Django Templates, putting Ruby
 in my HTML, or putting JavaScript in my HTML.
 
 
-Usage
------
+## Installation
+
+Install the gem locally with:
+
+    $ gem install mustache
+    
+Or add it to your `gemspec`:
+
+    s.add_dependency "mustache", "~> 1.0"
+
+
+## Usage
 
 Quick example:
 
@@ -94,16 +101,14 @@ Which returns the following:
 Simple.
 
 
-Tag Types
----------
+## Tag Types
 
 For a language-agnostic overview of Mustache's template syntax, see
 the `mustache(5)` manpage or
 <http://mustache.github.io/mustache.5.html>.
 
 
-Escaping
---------
+## Escaping
 
 Mustache does escape all values when using the standard double
 Mustache syntax. Characters which will be escaped: `& \ " < >` (as 
@@ -115,8 +120,7 @@ result in `5 &gt; 2`, where as the usage of `{{{variable}}}` will
 result in `5 > 2`.
 
 
-Dict-Style Views
-----------------
+## Dict-Style Views
 
 ctemplate and friends want you to hand a dictionary to the template
 processor. Mustache supports a similar concept. Feel free to mix the
@@ -147,8 +151,7 @@ We can re-use the same object, too:
     You have just won 100 bucks!
 
 
-Templates
----------
+## Templates
 
 A word on templates. By default, a view will try to find its template
 on disk by searching for an HTML file in the current directory that
@@ -190,8 +193,7 @@ Or set a different template for a single instance:
 Whatever works.
 
 
-Views
------
+## Views
 
 Mustache supports a bit of magic when it comes to views. If you're
 authoring a plugin or extension for a web framework (Sinatra, Rails,
@@ -199,8 +201,7 @@ etc), check out the `view_namespace` and `view_path` settings on the
 `Mustache` class. They will surely provide needed assistance.
 
 
-Helpers
--------
+## Helpers
 
 What about global helpers? Maybe you have a nifty `gravatar` function
 you want to use in all your views? No problem.
@@ -278,12 +279,13 @@ Finally, our template might look like this:
     </ul>
 
 
-Sinatra
--------
+## Integrations
+
+### Sinatra
 
-Mustache ships with Sinatra integration. Please see
+Mustache provides Sinatra integration. Please see
 `lib/mustache/sinatra.rb` or
-<https://github.com/defunkt/mustache/blob/master/lib/mustache/sinatra.rb>
+<https://github.com/mustache/mustache/blob/master/lib/mustache/sinatra.rb>
 for complete documentation.
 
 An example Sinatra application is also provided:
@@ -292,16 +294,15 @@ An example Sinatra application is also provided:
 If you are upgrading to Sinatra 1.0 and Mustache 0.9.0+ from Mustache
 0.7.0 or lower, the settings have changed. But not that much.
 
-See [this diff](https://gist.github.com/defunkt/345490) for what you need to
+See [this diff][diff] for what you need to
 do. Basically, things are named properly now and all should be
 contained in a hash set using `set :mustache, hash`.
 
 
-[Rack::Bug][4]
---------------
+### [Rack::Bug][4]
 
-Mustache also ships with a `Rack::Bug` panel. In your `config.ru` add
-the following code:
+Mustache also provides a `Rack::Bug` panel.
+First you have to install the `rack-bug-mustache_panel` gem, then in your `config.ru` add  the following code:
 
     require 'rack/bug/panels/mustache_panel'
     use Rack::Bug::MustachePanel
@@ -311,46 +312,32 @@ Using Rails? Add this to your initializer or environment file:
     require 'rack/bug/panels/mustache_panel'
     config.middleware.use "Rack::Bug::MustachePanel"
 
-[![Rack::Bug](http://img.skitch.com/20091027-xyf4h1yxnefpp7usyddrcmc7dn.png)][5]
+![Rack::Bug][5]
 
 
-Vim
----
+### Vim
 
-vim-mustache-handlebars is available at https://github.com/mustache/vim-mustache-handlebars
+vim-mustache-handlebars is available at [mustache/vim-mustache-handlebars][vim]
 
-Emacs
------
+### Emacs
 
-mustache-mode.el is available at https://github.com/mustache/emacs
+mustache-mode.el is available at [mustache/emacs][emacs]
 
 
-TextMate
---------
+### TextMate
 
-[Mustache.tmbundle](https://github.com/defunkt/Mustache.tmbundle)
+[Mustache.tmbundle][tmbundle]
 
 See <https://gist.github.com/defunkt/323624> for installation instructions.
 
 
-Command Line
-------------
+### Command Line
 
-See `mustache(1)` man page or
-<http://mustache.github.io/mustache.1.html>
+See `mustache(1)` man page or <http://mustache.github.io/mustache.1.html>
 for command line docs.
 
 
-Installation
-------------
-
-### [RubyGems](http://rubygems.org/)
-
-    $ gem install mustache
-
-
-Acknowledgements
-----------------
+## Acknowledgements
 
 Thanks to [Tom Preston-Werner](https://github.com/mojombo) for showing
 me ctemplate and [Leah Culver](https://github.com/leah) for the name "Mustache."
@@ -359,8 +346,7 @@ Special thanks to [Magnus Holm](http://judofyr.net/) for all his
 awesome work on Mustache's parser.
 
 
-Contributing
-------------
+## Contributing
 
 Once you've made your great commits:
 
@@ -370,36 +356,36 @@ Once you've made your great commits:
 4. Create an [Issue][is] with a link to your branch
 5. That's it!
 
-You might want to checkout Resque's [Contributing][cb] wiki page for information
-on coding standards, new features, etc.
-
 
-Mailing List
-------------
+## Mailing List
 
 To join the list simply send an email to <mustache@librelist.com>. This
 will subscribe you and send you information about your subscription,
 including unsubscribe information.
 
-The archive can be found at <http://librelist.com/browser/>.
+The archive can be found at <http://librelist.com/browser/mustache/>.
 
 
-Meta
-----
+## Meta
 
-* Code: `git clone https://github.com/defunkt/mustache.git`
+* Code: `git clone https://github.com/mustache/mustache.git`
 * Home: <http://mustache.github.io>
-* Bugs: <https://github.com/defunkt/mustache/issues>
+* Bugs: <https://github.com/mustache/mustache/issues>
 * List: <mustache@librelist.com>
 * Gems: <http://rubygems.org/gems/mustache>
 
-You can also find us in `#{` on irc.freenode.net.
+You can also find us in #{ on [irc.freenode.net][irc].
+
 
 [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
 [4]: https://github.com/brynary/rack-bug/
 [5]: http://img.skitch.com/20091027-n8pxwwx8r61tc318a15q1n6m14.png
-[cb]: http://wiki.github.com/defunkt/resque/contributing
 [fk]: http://help.github.com/forking/
 [is]: https://github.com/defunkt/mustache/issues
+[irc]: irc://irc.freenode.net/#{
+[vim]: https://github.com/mustache/vim-mustache-handlebars
+[emacs]: https://github.com/mustache/vim-mustache-handlebars
+[tmbundle]: https://github.com/defunkt/Mustache.tmbundle
+[diff]: https://gist.github.com/defunkt/345490

data/Rakefile

@@ -16,18 +16,10 @@ end
 
 task :default => :test
 
-if command? :turn
-  desc "Run tests"
-  task :test do
-    suffix = "-n #{ENV['TEST']}" if ENV['TEST']
-    sh "turn test/*.rb #{suffix}"
-  end
-else
-  Rake::TestTask.new do |t|
-    t.libs << 'lib'
-    t.pattern = 'test/**/*_test.rb'
-    t.verbose = false
-  end
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
 end
 
 

data/lib/mustache.rb

@@ -73,46 +73,43 @@ require 'mustache/settings'
 #
 class Mustache
 
-  #
-  # Public API
-  #
-
   # Instantiates an instance of this class and calls `render` with
   # the passed args.
   #
-  # Returns a rendered String version of a template
+  # @return A rendered String version of a template.
   def self.render(*args)
     new.render(*args)
   end
 
-  class << self
-    alias_method :to_html, :render
-    alias_method :to_text, :render
-  end
-
   # Parses our fancy pants template file and returns normal file with
   # all special {{tags}} and {{#sections}}replaced{{/sections}}.
   #
-  # data - A String template or a Hash context. If a Hash is given,
-  #        we'll try to figure out the template from the class.
-  #  ctx - A Hash context if `data` is a String template.
-  #
   # Examples
   #
-  #   @view.render("Hi {{thing}}!", :thing => :world)
+  #     @view.render("Hi {{thing}}!", :thing => :world)
   #
-  #   View.template = "Hi {{thing}}!"
-  #   @view = View.new
-  #   @view.render(:thing => :world)
+  #     View.template = "Hi {{thing}}!"
+  #     @view = View.new
+  #     @view.render(:thing => :world)
   #
-  # Returns a rendered String version of a template
+  # @param [String,Hash] data A String template or a Hash context.
+  #                           If a Hash is given, we'll try to figure
+  #                           out the template from the class.
+  # @param [Hash] ctx A Hash context if `data` is a String template.
+  #
+  # @return [String] Returns a rendered version of a template.
   def render(data = template, ctx = {})
-    tpl = case data
+    case data
     when Hash
       ctx = data
-      templateify(template)
     when Symbol
       self.template_name = data
+    end
+
+    tpl = case data
+    when Hash
+      templateify(template)
+    when Symbol
       templateify(template)
     else
       templateify(data)
@@ -128,15 +125,13 @@ class Mustache
     end
   end
 
-  alias_method :to_html, :render
-  alias_method :to_text, :render
-
   # Context accessors.
   #
-  # view = Mustache.new
-  # view[:name] = "Jon"
-  # view.template = "Hi, {{name}}!"
-  # view.render # => "Hi, Jon!"
+  # Example:
+  #     view = Mustache.new
+  #     view[:name] = "Jon"
+  #     view.template = "Hi, {{name}}!"
+  #     view.render # => "Hi, Jon!"
   def [](key)
     context[key.to_sym]
   end
@@ -182,21 +177,29 @@ class Mustache
 
   # Override this to provide custom escaping.
   #
-  # class PersonView < Mustache
-  #   def escapeHTML(str)
-  #     my_html_escape_method(str)
+  # Example:
+  #
+  #   class PersonView < Mustache
+  #     def escapeHTML(str)
+  #       my_html_escape_method(str)
+  #     end
   #   end
-  # end
   #
-  # Returns a String
+  # @param [String] str String to escape.
+  #
+  # @return [String] Escaped HTML.
   def escapeHTML(str)
     CGI.escapeHTML(str)
   end
 
+  # Has this instance or its class already compiled a template?
+  def compiled?
+    (@template && @template.is_a?(Template)) || self.class.compiled?
+  end
+
+
+  private
 
-  #
-  # Private API
-  #
 
   # When given a symbol or string representing a class, will try to produce an
   # appropriate view class.
@@ -207,55 +210,46 @@ class Mustache
     name = classify(name.to_s)
 
     # Emptiness begets emptiness.
-    return Mustache if name.to_s == ''
+    return Mustache if name.to_s.empty?
 
-    file_name = underscore(name)
     name = "#{view_namespace}::#{name}"
+    const = rescued_const_get(name)
 
-    if const = const_get!(name)
-      const
-    elsif File.exists?(file = "#{view_path}/#{file_name}.rb")
-      require "#{file}".chomp('.rb')
-      const_get!(name) || Mustache
-    else
-      Mustache
-    end
+    return const if const
+
+    const_from_file(name)
   end
 
-  # Supercharged version of Module#const_get.
-  #
-  # Always searches under Object and can find constants by their full name,
-  #   e.g. Mustache::Views::Index
-  #
-  # name - The full constant name to find.
-  #
-  # Returns the constant if found
-  # Returns nil if nothing is found
-  def self.const_get!(name)
-    name.split('::').reduce(Object) do |klass, cname|
-      klass.const_get(cname)
-    end
+  def self.rescued_const_get name
+    const_get(name, true) || Mustache
   rescue NameError
     nil
   end
 
+  def self.const_from_file name
+    file_name = underscore(name)
+    file_path = "#{view_path}/#{file_name}.rb"
+
+    return Mustache unless File.exists?(file_path)
+
+    require file_path.chomp('.rb')
+    rescued_const_get(name)
+  end
+
   # Has this template already been compiled? Compilation is somewhat
   # expensive so it may be useful to check this before attempting it.
   def self.compiled?
     @template.is_a? Template
   end
 
-  # Has this instance or its class already compiled a template?
-  def compiled?
-    (@template && @template.is_a?(Template)) || self.class.compiled?
-  end
 
   # template_partial => TemplatePartial
   # template/partial => Template::Partial
   def self.classify(underscored)
     underscored.split('/').map do |namespace|
       namespace.split(/[-_]/).map do |part|
-        part[0] = part[0].chr.upcase; part
+        part[0] = part.chars.first.upcase
+        part
       end.join
     end.join('::')
   end
@@ -264,21 +258,19 @@ class Mustache
   # Template::Partial => template/partial
   # Takes a string but defaults to using the current class' name.
   def self.underscore(classified = name)
-    classified = name if classified.to_s.empty?
     classified = superclass.name if classified.to_s.empty?
 
     string = classified.dup.split("#{view_namespace}::").last
 
     string.split('::').map do |part|
-      part[0] = part[0].chr.downcase
-      part.gsub(/[A-Z]/) { |s| "_#{s.downcase}"}
+      part[0] = part[0].downcase
+      part.gsub(/[A-Z]/) { |s| "_" << s.downcase }
     end.join('/')
   end
 
-  # Turns a string into a Mustache::Template. If passed a Template,
-  # returns it.
+  # @param [Template,String] obj Turns `obj` into a template
   def self.templateify(obj)
-    obj.is_a?(Template) ? obj : Template.new(obj.to_s)
+    obj.is_a?(Template) ? obj : Template.new(obj)
   end
 
   def templateify(obj)
@@ -288,10 +280,12 @@ class Mustache
   # Return the value of the configuration setting on the superclass, or return
   # the default.
   #
-  # attr_name - Symbol name of the attribute.  It should match the instance variable.
-  # default   - Default value to use if the superclass does not respond.
+  # @param [Symbol] attr_name Name of the attribute. It should match
+  #                           the instance variable.
+  # @param [Object] default Default value to use if the superclass does
+  #                         not respond.
   #
-  # Returns the inherited or default configuration setting.
+  # @return Inherited or default configuration setting.
   def self.inheritable_config_for(attr_name, default)
     superclass.respond_to?(attr_name) ? superclass.send(attr_name) : default
   end