Merge pull request #6 from MakeNowJust/version/2.0.0

Release version 2.0.0

Author: makenowjust

CHANGELOG.md

@@ -1,3 +1,16 @@
+## v2.0.0 (2016-02-09)
+
+Features:
+
+  - Support compile time template parsing.
+  - Added `Crustache::parse_file_static` to parse Mustache file on compile time.
+  - Added `Crustache::loader` to create `FileSystem` object to use `Crustache::Engine`.
+  - Added `Crustache::loader_static`, it is compile time version of `Crustache::loader`.
+
+Changes:
+
+  - Add type annotation to class constructors for Crystal next compiler.
+
 ## v1.0.2 (2016-01-13)
 
 Changes:

shard.yml

@@ -1,5 +1,5 @@
 name: crustache
-version: 1.0.2
+version: 2.0.0
 
 authors:
   - TSUYUSATO Kitsune <make.just.on@gmail.com>

spec/crustache_spec.cr

@@ -19,7 +19,62 @@ describe Crustache do
 
   describe "#parse_file" do
     it "should parse a file" do
-      Crustache.parse_file("#{__DIR__}/view/template.mustache").should be_truthy
+      tmpl = Crustache.parse_file("#{__DIR__}/view/template.mustache")
+      tmpl.should be_a Crustache::Template
+    end
+  end
+
+  describe "#parse_file_static" do
+    it "should parse a file on compile time" do
+      tmpl = Crustache.parse_file_static("#{__DIR__}/view/template.mustache")
+      tmpl.should be_a Crustache::Template
+    end
+  end
+
+  describe "#loader" do
+    it "should create loader object" do
+      loader = Crustache.loader "#{__DIR__}/view/"
+
+      loader.load("template").should be_a Crustache::Template
+      loader.load("template.mustache").should be_a Crustache::Template
+      loader.load("template_html").should be_a Crustache::Template
+      loader.load("template_html.html").should be_a Crustache::Template
+      loader.load("template_test").should be_a Crustache::Template
+      loader.load("template_test.html").should be_a Crustache::Template
+    end
+
+    it "should create loader object" do
+      loader = Crustache.loader "#{__DIR__}/view"
+
+      loader.load("template").should be_a Crustache::Template
+      loader.load("template.mustache").should be_a Crustache::Template
+      loader.load("template_html").should be_a Crustache::Template
+      loader.load("template_html.html").should be_a Crustache::Template
+      loader.load("template_test").should be_a Crustache::Template
+      loader.load("template_test.html").should be_a Crustache::Template
+    end
+  end
+  describe "#loader_static" do
+    it "should create loader object on compile time" do
+      loader = Crustache.loader_static "#{__DIR__}/view/"
+
+      loader.load("template").should be_a Crustache::Template
+      loader.load("template.mustache").should be_a Crustache::Template
+      loader.load("template_html").should be_a Crustache::Template
+      loader.load("template_html.html").should be_a Crustache::Template
+      loader.load("template_test").should be_a Crustache::Template
+      loader.load("template_test.html").should be_a Crustache::Template
+    end
+
+    it "should create loader object on compile time" do
+      loader = Crustache.loader_static "#{__DIR__}/view"
+
+      loader.load("template").should be_a Crustache::Template
+      loader.load("template.mustache").should be_a Crustache::Template
+      loader.load("template_html").should be_a Crustache::Template
+      loader.load("template_html.html").should be_a Crustache::Template
+      loader.load("template_test").should be_a Crustache::Template
+      loader.load("template_test.html").should be_a Crustache::Template
     end
   end
 

spec/view/template.mustache

@@ -1 +1,13 @@
 Hello {{Mustache}} World!
+
+{{#Cond}}
+  {{.}}
+{{/Cond}}
+{{^Inv}}
+  {{.}}
+{{/Inv}}
+{{!Comment}}
+{{{Raw}}}
+{{&Raw}}
+{{>Partial}}
+{{=de lim=}}

src/crustache.cr

@@ -1 +1,46 @@
-require "./crustache/*"
+require "./crustache/**"
+
+module Crustache
+  # :nodoc:
+  OPEN_TAG = "{{".to_slice
+  # :nodoc:
+  CLOSE_TAG = "}}".to_slice
+
+  DEFAULT_FILENAME = "__str__"
+
+  alias Template = Syntax::Template
+
+  def self.parse(io : IO, filename = DEFAULT_FILENAME, row = 1)
+    Parser.new(OPEN_TAG, CLOSE_TAG, io, filename, row).parse
+  end
+
+  def self.parse(string : String, filename = DEFAULT_FILENAME, row = 1)
+    self.parse MemoryIO.new(string), filename, row
+  end
+
+  def self.parse_file(filename)
+    self.parse(File.new(filename), filename, 1)
+  end
+
+  macro parse_file_static(filename)
+    {{ run("./parse_file_static.cr", filename) }}
+  end
+
+  def self.loader(basedir, extension = ViewLoader::EXTENSION)
+    ViewLoader.new basedir, extension: extension
+  end
+
+  macro loader_static(basedir, extension = [".mustache", ".html", ""])
+    {{ run("./loader_static.cr", basedir, extension.join("/")) }}
+  end
+
+  def self.render(tmpl, model, fs = HashFileSystem.new)
+    String.build do |io|
+      self.render tmpl, model, fs, io
+    end
+  end
+
+  def self.render(tmpl, model, fs, io)
+    tmpl.visit Renderer.new OPEN_TAG, CLOSE_TAG, Context.new(model), fs, io
+  end
+end

src/crustache/context.cr

@@ -0,0 +1,52 @@
+# :nodoc:
+class Crustache::Context(T)
+  getter parent
+
+  def initialize(@context : T, @parent = nil : Context?); end
+
+  def lookup(key)
+    if key == "."
+      return @context
+    end
+
+    ctx = @context
+
+    keys = key.split(".")
+    size = keys.size
+
+    i = 0
+    while i < size
+      k = keys[i]
+      case
+        # TODO:
+        # this code dose not works in Crystal v0.7.7:
+        #   when ctx.responds_to?(:has_key?) && ctx.responds_to?(:[])
+        # Perhaps it is the Crystal's bug.
+      when ctx.responds_to?(:has_key?)
+        if ctx.has_key?(k)
+          if ctx.responds_to?(:[])
+            ctx = ctx[k]
+          else
+            break
+          end
+        else
+          break
+        end
+
+      else
+        break
+      end
+      i += 1
+    end
+
+    if i == size
+      return ctx
+    end
+
+    if p = @parent
+      p.lookup key
+    else
+      nil
+    end
+  end
+end

src/crustache/filesystem.cr

@@ -1,7 +1,9 @@
 require "./syntax"
 
 module Crustache
-  module FileSystem
+  abstract class FileSystem
+    abstract def load(value) : Syntax::Template
+
     def load!(value)
       if tmpl = self.load value
         return tmpl
@@ -11,9 +13,7 @@ module Crustache
     end
   end
 
-  class HashFileSystem
-    include FileSystem
-
+  class HashFileSystem < FileSystem
     def initialize
       @tmpls = {} of String => Syntax::Template
     end
@@ -27,12 +27,10 @@ module Crustache
     end
   end
 
-  class ViewLoader
-    include FileSystem
-
+  class ViewLoader < FileSystem
     EXTENSION = [".mustache", ".html", ""]
 
-    def initialize(@basedir, @use_cache = false, @extension = EXTENSION)
+    def initialize(@basedir : String, @use_cache = false, @extension = EXTENSION : Array(String))
       @cache = {} of String => Syntax::Template?
     end
 

src/crustache/indent_io.cr

@@ -0,0 +1,45 @@
+require "./parser"
+
+# :nodoc:
+class Crustache::IndentIO
+  include IO
+
+  def initialize(@indent : String, @io : IO)
+    @indent_flag = 0
+    @eol_flag = true
+  end
+
+  def indent_flag_on
+    @indent_flag -= 1
+  end
+
+  def indent_flag_off
+    @indent_flag += 1
+  end
+
+  def read(s : Slice(UInt8))
+    raise "Unsupported"
+  end
+
+  def write(s)
+    start = 0
+    size = Util.size(s)
+    i = 0
+    while i < size
+      if @eol_flag
+        @io.write s[start, i - start]
+        @io << @indent
+        @eol_flag = false
+        start = i
+      end
+
+      if s[i] == Parser::NEWLINE_N && @indent_flag == 0
+        @eol_flag = true
+      end
+
+      i += 1
+    end
+
+    @io.write s[start, i - start]
+  end
+end

src/crustache/parse_error.cr

@@ -3,7 +3,7 @@ module Crustache
     getter filename
     getter row
 
-    def initialize(@msg, @filename, @row); super(message) end
+    def initialize(@msg : String, @filename : String, @row : Int32); super(message) end
 
     def message
       "#{@filename.inspect} line at #{@row}: #{@msg}"