mote 0.0.2 → 0.1.0.rc1

data/AUTHORS

@@ -0,0 +1,3 @@
+* Bruno Deferrari (tizoc)
+* Cyril David (cyx)
+* Michel Martens (soveran)

data/README.markdown

@@ -6,11 +6,8 @@ Minimum Operational Template.
 Description
 -----------
 
-Mote is the little brother of ERB. It only provides a subset of ERB's
-features, but praises itself of being simple--both internally and externally--
-and super fast. It was born out of experimentations while discussing
-[NOLATE](https://github.com/antirez/nolate), another small library with the
-same goals and more features.
+Mote is very simple and fast template engine that praises itself of being
+simple--both internally and externally-- and super fast.
 
 Usage
 -----
@@ -23,92 +20,59 @@ Usage is very similar to that of ERB:
 Silly example, you may say, and I would agree. What follows is a short list of
 the different use cases you may face:
 
+
+    % if user == "Bruno"
+      ${user} rhymes with Piano
+    % elsif user == "Brutus"
+      ${user} rhymes with Opus
+    % end
+
+## Control flow
+
+Lines that start with `%` are evaluated as Ruby code.
+
 ## Assignment
 
-    example = Mote.parse("<%= \"***\" %>")
-    assert_equal "***", example.call
+Whatever it is between `${` and `}` gets printed in the template.
 
-## Comment
+## Comments
 
-    example = Mote.parse("*<%# \"*\" %>*")
-    assert_equal "**", example.call
+There's nothing special about comments, it's just a `#` inside your Ruby code:
 
-## Control flow
+    % # This is a comment.
 
-    example = Mote.parse("<% if false %>*<% else %>***<% end %>")
-    assert_equal "***", example.call
 
 ## Block evaluation
 
-    example = Mote.parse("<% 3.times { %>*<% } %>")
-    assert_equal "***", example.call
+As with control instructions, it happens naturally:
+
+    % 3.times do |i|
+      ${i}
+    % end
 
 ## Parameters
 
-    example = Mote.parse("<% params[:n].times { %>*<% } %>")
-    assert_equal "***", example[n: 3]
-    assert_equal "****", example[n: 4]
+The values passed to the template are available as local variables:
 
-Two things are worth noting in the last example: the first is that as the
-returned value is a `Proc`, you can call it with square brackets and anything
-you put inside becomes a parameter. Second, that within the template you have
-access to those parameters through the `params` hash, instead of the usual
-approach of converting each key to a local variable.
+    example = Mote.parse("Hello ${name}")
+    assert_equal "Hello world", example.call(name: "world")
+    assert_equal "Hello Bruno", example.call(name: "Bruno")
 
 # Helpers
 
-There are a couple helpers available in the `Mote::Helpers` module, and you are
+There's a helper available in the `Mote::Helpers` module, and you are
 free to include it in your code. To do it, just type:
 
     include Mote::Helpers
 
-Here are the available helpers:
-
 ## mote
 
-The `mote` helper receives a template string and returns the rendered version
-of it:
-
-    assert_equal "1 2 3", mote("1 <%= 2 %> 3")
-
-It works with parameters too:
-
-    assert_equal "1 2 3", mote("1 <%= params[:n] %> 3", :n => 2)
+The `mote` helper receives a file name and a hash and returns the rendered
+version of its content. The compiled template is cached for subsequent calls.
 
-## mote_file
-
-The `mote_file` helper receives a file name and returns the rendered version of
-its content. The compiled template is cached for subsequent calls.
-
-    assert_equal "***\n", mote_file("test/basic.erb", :n => 3)
+    assert_equal "***\n", mote("test/basic.erb", n: 3)
 
 Installation
 ------------
 
     $ gem install mote
-
-License
--------
-
-Copyright (c) 2011 Michel Martens
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.

data/lib/mote.rb

@@ -18,19 +18,22 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 class Mote
-  VERSION = "0.0.2"
+  VERSION = "0.1.0.rc1"
 
-  def self.parse(template, context = self)
-    terms = template.split(/(<%[=#]?)\s*(.*?)\s*%>/)
+  def self.parse(template, context = self, vars = [])
+    terms = template.split(/^\s*(%)(.*?)$|(\$\{)(.*?)\}/)
 
     parts = "Proc.new do |params, __o|\n params ||= {}; __o ||= ''\n"
 
+    vars.each do |var|
+      parts << "%s = params[:%s]\n" % [var, var]
+    end
+
     while term = terms.shift
       case term
-      when "<%#" then terms.shift # skip
-      when "<%"  then parts << "#{terms.shift}\n"
-      when "<%=" then parts << "__o << (#{terms.shift}).to_s\n"
-      else            parts << "__o << #{term.inspect}\n"
+      when "%"  then parts << "#{terms.shift}\n"
+      when "${" then parts << "__o << (#{terms.shift}).to_s\n"
+      else           parts << "__o << #{term.inspect}\n"
       end
     end
 
@@ -40,22 +43,13 @@ class Mote
   end
 
   module Helpers
-    def mote(template, params = {})
-      mote_cache[template] ||= Mote.parse(template)
-      mote_cache[template][params]
-    end
-
-    def mote_file(filename, params = {})
-      mote_files[filename] ||= Mote.parse(File.read(filename))
-      mote_files[filename][params]
+    def mote(filename, params = {})
+      mote_cache[filename] ||= Mote.parse(File.read(filename), self, params.keys)
+      mote_cache[filename][params]
     end
 
     def mote_cache
-      @_mote_cache ||= {}
-    end
-
-    def mote_files
-      @_mote_files ||= {}
+      Thread.current[:_mote_cache] ||= {}
     end
   end
 end

data/mote.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage          = "http://github.com/soveran/mote"
   s.files = Dir[
     "LICENSE",
+    "AUTHORS",
     "README.markdown",
     "Rakefile",
     "lib/**/*.rb",

data/test/mote_test.rb

@@ -2,33 +2,59 @@ require File.expand_path("../lib/mote", File.dirname(__FILE__))
 
 scope do
   test "assignment" do
-    example = Mote.parse("<%= \"***\" %>")
+    example = Mote.parse("${ \"***\" }")
     assert_equal "***", example.call
   end
 
   test "comment" do
-    example = Mote.parse("*<%# \"*\" %>*")
-    assert_equal "**", example.call
+    template = (<<-EOT).gsub(/ {4}/, "")
+    *
+    % # "*"
+    *
+    EOT
+
+    example = Mote.parse(template)
+    assert_equal "*\n*\n", example.call.squeeze("\n")
   end
 
   test "control flow" do
-    example = Mote.parse("<% if false %>*<% else %>***<% end %>")
-    assert_equal "***", example.call
+    template = (<<-EOT).gsub(/ {4}/, "")
+    % if false
+      *
+    % else
+      ***
+    % end
+    EOT
+
+    example = Mote.parse(template)
+    assert_equal "\n  ***\n\n", example.call
   end
 
   test "block evaluation" do
-    example = Mote.parse("<% 3.times { %>*<% } %>")
-    assert_equal "***", example.call
+    template = (<<-EOT).gsub(/ {4}/, "")
+    % 3.times {
+    *
+    % }
+    EOT
+
+    example = Mote.parse(template)
+    assert_equal "\n*\n\n*\n\n*\n\n", example.call
   end
 
   test "parameters" do
-    example = Mote.parse("<% params[:n].times { %>*<% } %>")
-    assert_equal "***", example[:n => 3]
-    assert_equal "****", example[:n => 4]
+    template = (<<-EOT).gsub(/ {4}/, "")
+    % params[:n].times {
+    *
+    % }
+    EOT
+
+    example = Mote.parse(template)
+    assert_equal "\n*\n\n*\n\n*\n\n", example[:n => 3]
+    assert_equal "\n*\n\n*\n\n*\n\n*\n\n", example[:n => 4]
   end
 
   test "multiline" do
-    example = Mote.parse("The\nMan\nAnd\n<%=\n\"The\"\n%>\nSea")
+    example = Mote.parse("The\nMan\nAnd\n${\"The\"}\nSea")
     assert_equal "The\nMan\nAnd\nThe\nSea", example[:n => 3]
   end
 
@@ -36,20 +62,27 @@ scope do
     example = Mote.parse("'foo' 'bar' 'baz'")
     assert_equal "'foo' 'bar' 'baz'", example.call
   end
-end
 
-include Mote::Helpers
+  test "context" do
+    context = Object.new
+    context.instance_variable_set(:@user, "Bruno")
 
-scope do
-  test do
-    assert_equal "1 2 3", mote("1 <%= 2 %> 3")
+    example = Mote.parse("${ @user }", context)
+    assert_equal "Bruno", example.call
   end
 
-  test do
-    assert_equal "1 2 3", mote("1 <%= params[:n] %> 3", :n => 2)
+  test "locals" do
+    context = Object.new
+
+    example = Mote.parse("${ user }", context, [:user])
+    assert_equal "Bruno", example.call(user: "Bruno")
   end
+end
 
-  test do
-    assert_equal "***\n", mote_file("test/basic.erb", :n => 3)
+include Mote::Helpers
+
+scope do
+  test "helpers" do
+    assert_equal "\n  *\n\n  *\n\n  *\n\n", mote("test/basic.erb", :n => 3)
   end
 end

metadata

@@ -1,70 +1,67 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mote
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc1
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-21 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: cutest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157905920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Mote is the little brother of ERB. It only provides a subset of ERB's features, but praises itself of being simple--both internally and externally--and super fast.
-email: 
+  prerelease: false
+  version_requirements: *2157905920
+description: Mote is the little brother of ERB. It only provides a subset of ERB's
+  features, but praises itself of being simple--both internally and externally--and
+  super fast.
+email:
 - michel@soveran.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE
+- AUTHORS
 - README.markdown
 - Rakefile
 - lib/mote.rb
 - mote.gemspec
 - test/mote_test.rb
+has_rdoc: true
 homepage: http://github.com/soveran/mote
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Minimum Operational Template.
 test_files: []
-