feather 0.3.1 → 0.4.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Scott Tadman
+Copyright (c) 2011-2013 Scott Tadman, The Working Group Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
 # feather
 
-A simple text template system for generating output for a variety of uses
-including plain-text, HTML, and JavaScript.
+A simple text template system inspired by Mustache for generating output for a
+variety of uses including plain-text, HTML, and JavaScript.
 
 ## Examples
 

data/RELEASES.txt

@@ -0,0 +1,19 @@
+0.4.0
+ - Made more compatible with the Mustache template library semantics.
+ - Added support for {{#...}} section definitions.
+ - Added support for {{^...}} negative definitions.
+ - Added support for {{!...}} comments.
+0.3.1
+ - Template names can be supplied as either Strings or Symbols.
+ - Variables can be defined with either String or Symbol keys.
+0.3.0
+ - Renaming library to Feather.
+0.2.2
+ - Handling nil template arguments and empty template substitutions.
+0.2.1
+ - Adding support for Hash-compatible objects to be passed in, responding to
+   the [] method is sufficient.
+0.2.0
+ - Adding ? and ?! conditional tests.
+0.1.0
+ - Initial thin prototype.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/feather.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "feather"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Tadman"]
-  s.date = "2013-01-25"
+  s.date = "2013-04-09"
   s.description = "A simple light-weight text templating system"
   s.email = "github@tadman.ca"
   s.extra_rdoc_files = [
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "LICENSE.txt",
     "README.md",
+    "RELEASES.txt",
     "Rakefile",
     "VERSION",
     "feather.gemspec",
@@ -36,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/twg/feather"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "Light-weight text tempating system"
 
   if s.respond_to? :specification_version then

data/lib/feather.rb

@@ -6,12 +6,14 @@ module Feather
 
   # == Module Methods =======================================================
 
+  # Returns the current library version
   def self.version
     @version ||= File.readlines(
       File.expand_path('../VERSION', File.dirname(__FILE__))
   ).first.chomp
   end
 
+  # Create a new template with a supplied template body and optional options.
   def self.new(*args)
     template = Feather::Template.new(*args)
 

data/lib/feather/template.rb

@@ -1,7 +1,7 @@
 class Feather::Template
   # == Constants ============================================================
   
-  TOKEN_REGEXP = /((?:[^\{]|\{[^\{]|\{\{\{)+)|\{\{\s*([\&\%\$\.\:\*\/\=]|\?\!?)?([^\}]*)\}\}/.freeze
+  TOKEN_REGEXP = /((?:[^\{]|\{[^\{]|\{\{\{)+)|\{\{\s*([\&\%\$\.\:\#\^\*\/\=\!]|\?\!?)?([^\}]*)\}\}/.freeze
   TOKEN_TRIGGER = /\{\{/.freeze
     
   TO_YAML_PROPERTIES = %w[ @content @escape_method ].freeze
@@ -29,6 +29,9 @@ class Feather::Template
   
   # == Instance Methods =====================================================
   
+  # Creates a new template with the supplied contens. Options may be specified:
+  # * :html - Automatically escape fields for HTML
+  # * :text - Default mode, render all fields literally
   def initialize(content, options = nil)
     if (options)
       if (source = options[:escape])
@@ -54,6 +57,7 @@ class Feather::Template
     yield(self) if (block_given?)
   end
 
+  # Returns a function that can be used to evaluate the template.
   def to_proc
     @_proc ||= begin
       source = ''
@@ -64,6 +68,10 @@ class Feather::Template
     end
   end
   
+  # Render the template with the given variables, templates, and parent chain.
+  # The variables are specified in a Hash, Array, or object that supports
+  # [](key). templates must be a Hash or [](key) accessible object. The parents
+  # chain is defined as an array.
   def render(variables = nil, templates = nil, parents = nil)
     variables = Feather::Support.variable_stack(variables, true)
     
@@ -138,6 +146,12 @@ class Feather::Template
   end
   alias_method :call, :render
 
+  # Compiles a template and manipulates the options strucutre passed in. Keys
+  # supported are:
+  # * :escape_method - Defines the default escape method for this template.
+  # * :templates - Hash to capture the templates referenced in this template.
+  # * :variables - Hash to capture the variables referenced in this template.
+  # * :source - String to capture the Ruby equivalent of this template.
   def compile(options)
     escape_method = options[:escape_method]
     sections = options[:sections]
@@ -165,7 +179,6 @@ class Feather::Template
           source and source << "v&&r<<h.html_escape(v[#{tag.inspect}].to_s);"
           
           variables and variables[tag] = true
-
         when '%'
           # URI escaped
           index = stack[-1][2][tag.inspect]
@@ -187,8 +200,8 @@ class Feather::Template
           source and source << "v&&r<<h.css_escape(v.is_a?(Array)?v[#{index}]:v[#{tag.inspect}]);"
 
           variables and variables[tag] = true
-        when ':'
-          # Defines start of a :section
+        when ':', '#'
+          # Defines start of a :section or #section
           index = stack[-1][2][tag.inspect]
 
           stack_variables ||= 's=[];'
@@ -198,6 +211,16 @@ class Feather::Template
           source and source << "h.iterate(v){|v|;v=h.cast_as_vars(v, s);"
           
           sections and sections[tag] = true
+        when '^'
+          # Displays if referenced variable is undefined or empty
+          index = stack[-1][2][tag.inspect]
+
+          stack_variables ||= 's=[];'
+          stack << [ :empty_section, tag, stack[-1][2] ]
+
+          source and source << "t=v.is_a?(Array)?v[#{index}]:(v.is_a?(Hash)&&v[#{tag.inspect}]);if(!t||t.respond_to?(:empty?)&&t.empty?);"
+          
+          variables and variables[tag] = true
         when '?', '?!'
           # Defines start of a ?conditional
 
@@ -222,6 +245,8 @@ class Feather::Template
             end
             
             source and source << "};v=s.pop;end;"
+          when :empty_section
+            source and source << "end;"
           when :conditional
             source and source << "end;"
           when :base
@@ -269,10 +294,12 @@ class Feather::Template
     true
   end
   
+  # For compatibility with YAML.dump
   def to_yaml_properties
     TO_YAML_PROPERTIES
   end
   
+  # For compatibility with the Psych YAML library
   def psych_to_yaml(dump)
     # Avoid serializing the generated proc by moving it to a temporary
     # variable for the duration of this operation.
@@ -285,10 +312,12 @@ class Feather::Template
     dump
   end
     
+  # For compatibility with Marshal.dump
   def marshal_dump
     [ @content, { :escape => @escape_method } ]
   end
   
+  # For compatibility with Marshal.load
   def marshal_load(dump)
     @content, options = dump
     

data/test/helper.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-
 require 'test/unit'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -14,7 +13,7 @@ class Test::Unit::TestCase
     rescue exception_class
       # Expected
     else
-      flunk message || "Did not raise #{exception_class}"
+      flunk(message || "Did not raise #{exception_class}")
     end
   end
 end

data/test/test_feather_template.rb

@@ -79,6 +79,25 @@ class TestFeatherTemplate < Test::Unit::TestCase
     assert_equal '<div></div>', template.render(:link => nil)
     assert_equal '<div></div>', template.render(:link => [ ])
   end
+
+  def test_empty_section
+    template = Feather::Template.new('<head>{{:head}}{{tag}}{{/head}}{{^head}}<title></title>{{/head}}</head>')
+
+    assert_equal '<head><title></title></head>', template.render
+    assert_equal '<head><title></title></head>', template.render(:head => nil)
+    assert_equal '<head><title></title></head>', template.render(:head => '')
+    assert_equal '<head><title></title></head>', template.render(:head => [ ])
+    assert_equal '<head><title></title></head>', template.render(:head => { })
+    assert_equal '<head>0</head>', template.render(:head => 0)
+    assert_equal '<head><test><tags></head>', template.render(:head => %w[ <test> <tags> ])
+  end
+
+  def test_comment
+    template = Feather::Template.new('<test>{{!commment with all kinds of <markup>}}</test>')
+
+    assert_equal '<test></test>', template.render
+    assert_equal '<test></test>', template.render(:comment => 'test')
+  end
   
   def test_template_with_context
     template = Feather::Template.new('{{example}}', :escape => :html)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feather
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
@@ -39,6 +39,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASES.txt
 - Rakefile
 - VERSION
 - feather.gemspec
@@ -71,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Light-weight text tempating system