mustache 0.99.4 → 1.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf066480926aaca95b8ebbb4e45de15a11cae753e407be03a8059bee4deb9837
+  data.tar.gz: a334278f764909eb095bed8bf31132af6c61d6dffadbf5688cd745e85517a7a6
+SHA512:
+  metadata.gz: 571c5ff585457d1073fa4de0d506073b55a7c3409967d39a488b71fe38b03e7074312ad5e9e379d0f654043dc8be7ffdba4e1cb3b6df4ba6e884920885064ecd
+  data.tar.gz: cb3b39d80301b99e13e4cf412e5da3065ecf5215d7b7bece535c032e6cec5c452a0d44f43363d4d35a06a2267e67945325c177ae8631f8b19bac8f344fad2768

data/README.md

@@ -1,5 +1,7 @@
-Mustache
-=========
+# Mustache
+
+[![Gem Version](https://badge.fury.io/rb/mustache.svg)](http://badge.fury.io/rb/mustache)
+[![Test](https://github.com/mustache/mustache/actions/workflows/test.yml/badge.svg)](https://github.com/mustache/mustache/actions/workflows/test.yml)
 
 Inspired by [ctemplate][1] and [et][2], Mustache is a
 framework-agnostic way to render logic-free views.
@@ -8,11 +10,10 @@ As ctemplates says, "It emphasizes separating logic from presentation:
 it is impossible to embed application logic in this template language."
 
 For a list of implementations (other than Ruby) and tips, see
-<http://mustache.github.com/>.
+<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 +31,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,35 +39,49 @@ 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 `Gemfile`:
+
+```ruby
+gem "mustache", "~> 1.0"
+```
+
+
+## Usage
 
 Quick example:
 
     >> require 'mustache'
     => true
-    >> Mustache.render("Hello {{planet}}", :planet => "World!")
+    >> Mustache.render("Hello {{planet}}", planet: "World!")
     => "Hello World!"
 
 We've got an `examples` folder but here's the canonical one:
 
-    class Simple < Mustache
-      def name
-        "Chris"
-      end
+```ruby
+class Simple < Mustache
+  def name
+    "Chris"
+  end
 
-      def value
-        10_000
-      end
+  def value
+    10_000
+  end
 
-      def taxed_value
-        value * 0.6
-      end
+  def taxed_value
+    value * 0.6
+  end
 
-      def in_ca
-        true
-      end
-    end
+  def in_ca
+    true
+  end
+end
+```
 
 We simply create a normal Ruby class and define methods. Some methods
 reference others, some return values, some return only booleans.
@@ -82,9 +96,9 @@ Now let's write the template:
 
 This template references our view methods. To bring it all together,
 here's the code to render actual HTML;
-
-    Simple.render
-
+```ruby
+Simple.render
+```
 Which returns the following:
 
     Hello Chris
@@ -94,29 +108,26 @@ 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.com/mustache.5.html>.
+<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: `& \ " < >`. To
-disable escaping, simply use tripple mustaches like
-`{{{unescaped_variable}}}`.
+Mustache syntax. Characters which will be escaped: `& \ " < >` (as
+well as `'` in Ruby `>= 2.0`). To disable escaping, simply use triple
+mustaches like `{{{unescaped_variable}}}`.
 
 Example: Using `{{variable}}` inside a template for `5 > 2` will
 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
@@ -129,11 +140,12 @@ Given this template (winner.mustache):
 
 We can fill in the values at will:
 
-    view = Winner.new
-    view[:name] = 'George'
-    view[:value] = 100
-    view.render
-
+```ruby
+view = Winner.new
+view[:name] = 'George'
+view[:value] = 100
+view.render
+```
 Which returns:
 
     Hello George
@@ -141,14 +153,12 @@ Which returns:
 
 We can re-use the same object, too:
 
-    view[:name] = 'Tony'
-    view.render
-    Hello Tony
-    You have just won 100 bucks!
-
+```ruby
+view[:name] = 'Tony'
+view.render # => Hello Tony\nYou 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
@@ -156,42 +166,47 @@ follows the classic Ruby naming convention.
 
     TemplatePartial => ./template_partial.mustache
 
-You can set the search path using `Mustache.template_path`. It can be set on a
-class by class basis:
-
-    class Simple < Mustache
-      self.template_path = File.dirname(__FILE__)
-      ... etc ...
-    end
+You can set the search path using `Mustache.template_path`. Search multiple
+paths by delimiting them with your platform's 'path separator' (colon on Unix).
+It can be set on a class by class basis:
 
+```ruby
+class Simple < Mustache
+  self.template_path = __dir__
+end
+```
 Now `Simple` will look for `simple.mustache` in the directory it resides
 in, no matter the cwd.
 
 If you want to just change what template is used you can set
 `Mustache.template_file` directly:
 
-    Simple.template_file = './blah.mustache'
-
+```ruby
+Simple.template_file = './blah.mustache'
+```
 Mustache also allows you to define the extension it'll use.
 
-    Simple.template_extension = 'xml'
-
+```ruby
+Simple.template_extension = 'xml'
+```
 Given all other defaults, the above line will cause Mustache to look
 for './blah.xml'
 
 Feel free to set the template directly:
 
-    Simple.template = 'Hi {{person}}!'
+```ruby
+Simple.template = 'Hi {{person}}!'
+```
 
 Or set a different template for a single instance:
-
-    Simple.new.template = 'Hi {{person}}!'
+```ruby
+Simple.new.template = 'Hi {{person}}!'
+```
 
 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,75 +214,80 @@ 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.
 
 This is just Ruby, after all.
 
-    module ViewHelpers
-      def gravatar
-        gravatar_id = Digest::MD5.hexdigest(self[:email].to_s.strip.downcase)
-        gravatar_for_id(gravatar_id)
-      end
+```ruby
+module ViewHelpers
+  def gravatar
+    gravatar_id = Digest::MD5.hexdigest(self[:email].to_s.strip.downcase)
+    gravatar_for_id(gravatar_id)
+  end
 
-      def gravatar_for_id(gid, size = 30)
-        "#{gravatar_host}/avatar/#{gid}?s=#{size}"
-      end
+  def gravatar_for_id(gid, size = 30)
+    "#{gravatar_host}/avatar/#{gid}?s=#{size}"
+  end
 
-      def gravatar_host
-        @ssl ? 'https://secure.gravatar.com' : 'http://www.gravatar.com'
-      end
-    end
+  def gravatar_host
+    @ssl ? 'https://secure.gravatar.com' : 'http://www.gravatar.com'
+  end
+end
+```
 
 Then just include it:
 
-    class Simple < Mustache
-      include ViewHelpers
+```ruby
+class Simple < Mustache
+  include ViewHelpers
 
-      def name
-        "Chris"
-      end
+  def name
+    "Chris"
+  end
 
-      def value
-        10_000
-      end
+  def value
+    10_000
+  end
 
-      def taxed_value
-        value * 0.6
-      end
+  def taxed_value
+    value * 0.6
+  end
 
-      def in_ca
-        true
-      end
+  def in_ca
+    true
+  end
 
-      def users
-        User.all
-      end
-    end
+  def users
+    User.all
+  end
+end
+```
 
 Great, but what about that `@ssl` ivar in `gravatar_host`? There are
 many ways we can go about setting it.
 
-Here's on example which illustrates a key feature of Mustache: you
+Here's an example which illustrates a key feature of Mustache: you
 are free to use the `initialize` method just as you would in any
 normal class.
 
-    class Simple < Mustache
-      include ViewHelpers
-
-      def initialize(ssl = false)
-        @ssl = ssl
-      end
+```ruby
+class Simple < Mustache
+  include ViewHelpers
 
-      ... etc ...
-    end
+  def initialize(ssl = false)
+    @ssl = ssl
+  end
+end
+```
 
 Now:
 
-    Simple.new(request.ssl?).render
+```ruby
+Simple.new(request.ssl?).render
+```
 
 Finally, our template might look like this:
 
@@ -278,98 +298,76 @@ Finally, our template might look like this:
     </ul>
 
 
-Sinatra
--------
+## Integrations
 
-Mustache ships with Sinatra integration. Please see
-`lib/mustache/sinatra.rb` or
-<http://github.com/defunkt/mustache/blob/master/lib/mustache/sinatra.rb>
-for complete documentation.
+### Sinatra
+
+Sinatra integration is available with the
+[mustache-sinatra gem](https://github.com/mustache/mustache-sinatra).
 
 An example Sinatra application is also provided:
-<http://github.com/defunkt/mustache-sinatra-example>
+<https://github.com/defunkt/mustache-sinatra-example>
 
 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](http://gist.github.com/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
+```ruby
+require 'rack/bug/panels/mustache_panel'
+use Rack::Bug::MustachePanel
+```
 
 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]
+```ruby
+require 'rack/bug/panels/mustache_panel'
+config.middleware.use "Rack::Bug::MustachePanel"
+```
 
+![Rack::Bug][5]
 
-Vim
----
 
-Thanks to [Juvenn Woo](http://github.com/juvenn) for mustache.vim. It
-is included under the contrib/ directory.
+### Vim
 
-See <http://gist.github.com/323622> for installation instructions.
+vim-mustache-handlebars is available at [mustache/vim-mustache-handlebars][vim]
 
+### Emacs
 
-Emacs
------
+mustache-mode.el is available at [mustache/emacs][emacs]
 
-mustache-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.
 
-See <http://gist.github.com/323619> for installation instructions.
+### TextMate
 
+[Mustache.tmbundle][tmbundle]
 
-TextMate
---------
+See <https://gist.github.com/defunkt/323624> for installation instructions.
 
-[Mustache.tmbundle](http://github.com/defunkt/Mustache.tmbundle)
 
-See <http://gist.github.com/323624> for installation instructions.
+### Command Line
 
-
-Command Line
-------------
-
-See `mustache(1)` man page or
-<http://mustache.github.com/mustache.1.html>
+See `mustache(1)` man page or <http://mustache.github.io/mustache.1.html>
 for command line docs.
 
 
-Installation
-------------
+## Acknowledgements
 
-### [RubyGems](http://rubygems.org/)
-
-    $ gem install mustache
-
-
-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."
+Thanks to [Tom Preston-Werner](https://github.com/mojombo) for showing
+me ctemplate and [Leah Culver](https://github.com/leah) for the name "Mustache."
 
 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:
 
@@ -379,37 +377,39 @@ 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
+~~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.
+including unsubscribe information.~~
 
-The archive can be found at <http://librelist.com/browser/>.
+~~The archive can be found at <http://librelist.com/browser/mustache/>.~~
 
+The mailing list hasn't been updated in quite a while, please join us on Gitter
+or IRC:
 
-Meta
-----
+[![Join the chat at https://gitter.im/mustache/mustache](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mustache/mustache?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-* Code: `git clone git://github.com/defunkt/mustache.git`
-* Home: <http://mustache.github.com>
-* Bugs: <http://github.com/defunkt/mustache/issues>
-* List: <mustache@librelist.com>
-* Test: <http://runcoderun.com/defunkt/mustache>
-* Gems: <http://rubygems.org/gems/mustache>
+[#{ on Freenode][irc]
+
+## Meta
 
-You can also find us in `#{` on irc.freenode.net.
+* Code: `git clone https://github.com/mustache/mustache.git`
+* Home: <http://mustache.github.io>
+* Bugs: <https://github.com/mustache/mustache/issues>
+* List: <mustache@librelist.com>
+* Gems: <https://rubygems.org/gems/mustache>
 
-[1]: http://code.google.com/p/google-ctemplate/
+[1]: https://github.com/olafvdspek/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]: http://github.com/brynary/rack-bug/
+[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]: http://github.com/defunkt/mustache/issues
+[fk]: https://help.github.com/forking/
+[is]: https://github.com/mustache/mustache/issues
+[irc]: irc://irc.freenode.net/#{
+[vim]: https://github.com/mustache/vim-mustache-handlebars
+[emacs]: https://github.com/mustache/emacs
+[tmbundle]: https://github.com/defunkt/Mustache.tmbundle
+[diff]: https://gist.github.com/defunkt/345490

data/Rakefile

@@ -1,5 +1,5 @@
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 #
 # Helpers
@@ -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
 
 
@@ -43,7 +35,7 @@ if command? :ronn
 
   desc "Build the manual"
   task "man:build" do
-    sh "ronn -br5 --organization=DEFUNKT --manual='Mustache Manual' man/*.ron"
+    sh "ronn-ng -br5 --organization=DEFUNKT --manual='Mustache Manual' man/*.ron"
   end
 end
 

data/bin/mustache

@@ -11,7 +11,7 @@ class Mustache
     # Return a structure describing the options.
     def self.parse_options(args)
       opts = OptionParser.new do |opts|
-        opts.banner = "Usage: mustache [-c] [-t] [-r library] FILE ..."
+        opts.banner = "Usage: mustache [-c] [-t] [-l level] [-e] [-r library] FILE ..."
 
         opts.separator " "
 
@@ -42,6 +42,16 @@ class Mustache
           exit
         end
 
+        opts.on("-l", "--level",
+          "Provide a context access security level.") do |level|
+          Mustache.context_access_security_level = level.to_i
+        end
+
+        opts.on("-e", "--error",
+          "Raise an error on context misses.") do |e|
+          Mustache.raise_on_context_miss = true
+        end
+
         opts.on('-r', '--require LIB', 'Require a Ruby library before running.') do |lib|
           require lib
         end
@@ -49,7 +59,7 @@ class Mustache
         opts.separator "Common Options:"
 
         opts.on("-v", "--version", "Print the version") do |v|
-          puts "Mustache v#{Mustache::Version}"
+          puts "Mustache v#{Mustache::VERSION}"
           exit
         end
 
@@ -64,20 +74,24 @@ class Mustache
       opts.parse!(args)
     end
 
-    # Does the dirty work of reading files from STDIN and the command
-    # line then processing them. The meat of this script, if you will.
-    def self.process_files(input_stream)
-      doc = input_stream.read
+    # Does the dirty work of reading files from the command line then
+    # processing them. The meat of this script, if you will.
+    def self.process_files(input_files)
+      doc = input_files.file.read
 
-      if doc =~ /^(\s*---(.+)---\s*)/m
-        yaml = $2.strip
-        template = doc.sub($1, '')
+      yaml = nil
+      begin
+        yaml = YAML.load_stream(doc)
+      rescue
+        abort "Unable to parse yaml!"
+      end
 
-        YAML.each_document(yaml) do |data|
-          puts Mustache.render(template, data)
-        end
-      else
+      if yaml.nil?
         puts Mustache.render(doc)
+      else
+        template = input_files.skip.file.read
+
+        puts Mustache.render template, yaml.compact.reduce(&:merge)
       end
     end
   end
@@ -89,6 +103,6 @@ ARGV << '-h' if ARGV.empty? && $stdin.tty?
 # Process options
 Mustache::CLI.parse_options(ARGV) if $stdin.tty?
 
-# Still here - process ARGF
+# Still here - process rest of ARGF
 Mustache::CLI.process_files(ARGF)