ruby-handlebars 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae92539214ecdf59a678a44935f42fdb2f2264a6
-  data.tar.gz: 6e0da52049ff769f168933b3fd8b0f0832c42e8a
+SHA256:
+  metadata.gz: 5bb7ada122dcffa528888da4c6a4b1e2822cbecd5626d14e559081a8881670b8
+  data.tar.gz: aeed1a35e4a57bee75e9fa0f67ddfd0c26a07fd33c613608974492f258eb6c06
 SHA512:
-  metadata.gz: 8931ee0570230133d9f0f09fb38595e5362a01412890c4ce43d35be5b9335d5dc15ba7c0c09e465c50bdf2e46dedbbe758c1fbd6ce169cb31cb182224ee788f5
-  data.tar.gz: fe7e970a5d0626e90044268ccaf4e5c1aa8380a77bb2f5f9782d422e129d9c3ad098b66db0f3638157db620bb52b885e7def81ca02a4e441c4a5ecb5d19407dc
+  metadata.gz: 6505f37bb31fbdd0d344d5404c1bc5b5a6259e97120039037dc9ae2aa45635cfa2f7b2c40be1c4b5faced929dab3404665a451e495465c94e446c66dbb0362bf
+  data.tar.gz: ca528f8a90911381216fa5af4fe7aba5d36ca83c84dd88f084023860fe3dc6067970f5b5155f9a296ee2baf814024ff32b5fcdc14edc120f75b4257ef6220e0b

data/README.md

@@ -105,9 +105,7 @@ Limitations and roadmap
 
 This gem does not reuse the real Handlebars code (the JS one) and not everything is handled yet (but it will be someday ;) ):
 
- - there is no escaping, all strings are considered as safe (so ``{{{ my_var }}}`` and ``{{ my_var }}``) will output the same thing
  - the parser is not fully tested yet, it may complain with spaces ...
- - curly bracket are __not__ usable in the template content yet. one workaround is to create simple helpers to generate them
  - parsing errors are, well, not helpful at all
 
 Aknowledgements
@@ -115,3 +113,5 @@ Aknowledgements
 
 This gem would simply not exist if the handlebars team was not here. Thanks a lot for this awesome templating system.
 Thanks a lot to @cowboyd for the [handlebars.rb](https://github.com/cowboyd/handlebars.rb) gem. We used it for a while and it's great (and as told at the beginning of the README, if you do not need any Windows support, use handlebars.rb instead ;) )
+
+Thanks a lot to the contributors @mvz and @schuetzm for making it a way better Handlebars renderer :)

data/lib/ruby-handlebars.rb

@@ -2,15 +2,18 @@ require_relative 'ruby-handlebars/parser'
 require_relative 'ruby-handlebars/tree'
 require_relative 'ruby-handlebars/template'
 require_relative 'ruby-handlebars/helper'
+require_relative 'ruby-handlebars/escapers/html_escaper'
 
 module Handlebars
   class Handlebars
     include Context
+    attr_reader :escaper
 
-    def initialize
+    def initialize()
       @helpers = {}
       @partials = {}
       register_default_helpers
+      set_escaper
     end
 
     def compile(template)
@@ -37,6 +40,10 @@ module Handlebars
       @data = ctx
     end
 
+    def set_escaper(escaper = nil)
+      @escaper = escaper || Escapers::HTMLEscaper
+    end
+
     private
 
     PARSER = Parser.new
@@ -67,20 +74,18 @@ module Handlebars
 
     def register_each_helper
       register_helper('each') do |context, items, block, else_block|
-        current_this = context.get('this')
-
         if (items.nil? || items.empty?)
           if else_block
             result = else_block.fn(context)
           end
         else
-          result = items.map do |item|
-            context.add_item(:this, item)
-            block.fn(context)
-          end.join('')
+          context.with_temporary_context(:this => nil, :@index => 0, :@first => false, :@last => false) do
+            result = items.each_with_index.map do |item, index|
+              context.add_items(:this => item, :@index => index, :@first => (index == 0), :@last => (index == items.length - 1))
+              block.fn(context)
+            end.join('')
+          end
         end
-
-        context.add_item(:this, current_this)
         result
       end
     end

data/lib/ruby-handlebars/context.rb

@@ -2,8 +2,12 @@ module Handlebars
   module Context
     def get(path)
       items = path.split('.'.freeze)
+      if locals.key? items.first.to_sym
+        current = locals
+      else
+        current = @data
+      end
 
-      current = @data
       until items.empty?
         current = get_attribute(current, items.shift)
       end
@@ -12,16 +16,32 @@ module Handlebars
     end
 
     def add_item(key, value)
-      @data[key] = value
+      locals[key.to_sym] = value
+    end
+
+    def add_items(hash)
+      hash.map { |k, v| add_item(k, v) }
+    end
+
+    def with_temporary_context(args = {})
+      saved = args.keys.collect { |key| [key, get(key.to_s)] }.to_h
+
+      add_items(args)
+      yield
+      locals.merge!(saved)
     end
 
     private
 
+    def locals
+      @locals ||= {}
+    end
+
     def get_attribute(item, attribute)
       sym_attr = attribute.to_sym
       str_attr = attribute.to_s
 
-      if item.respond_to?(:[])
+      if item.respond_to?(:[]) && item.respond_to?(:has_key?)
         if item.has_key?(sym_attr)
           return item[sym_attr]
         elsif item.has_key?(str_attr)
@@ -29,10 +49,6 @@ module Handlebars
         end
       end
 
-      if item.instance_variables.include?("@#{attribute}")
-        return item.instance_variable_get("@#{attribute}")
-      end
-
       if item.respond_to?(sym_attr)
         return item.send(sym_attr)
       end

data/lib/ruby-handlebars/escapers/dummy_escaper.rb

@@ -0,0 +1,9 @@
+module Handlebars
+  module Escapers
+    class DummyEscaper
+      def self.escape(value)
+        value
+      end
+    end
+  end
+end

data/lib/ruby-handlebars/escapers/html_escaper.rb

@@ -0,0 +1,9 @@
+module Handlebars
+  module Escapers
+    class HTMLEscaper
+      def self.escape(value)
+        CGI::escapeHTML(value)
+      end
+    end
+  end
+end

data/lib/ruby-handlebars/parser.rb

@@ -13,24 +13,37 @@ module Handlebars
 
     rule(:docurly)     { ocurly >> ocurly }
     rule(:dccurly)     { ccurly >> ccurly }
+    rule(:tocurly)     { ocurly >> ocurly >> ocurly }
+    rule(:tccurly)     { ccurly >> ccurly >> ccurly }
 
-    rule(:identifier)  { match['a-zA-Z0-9_\?'].repeat(1) }
+    rule(:identifier)  { match['@a-zA-Z0-9_\?'].repeat(1) }
     rule(:path)        { identifier >> (dot >> identifier).repeat }
 
-    rule(:template_content) { match('[^{}]').repeat(1).as(:template_content) }
+    rule(:nocurly)     { match('[^{}]') }
+    rule(:eof)         { any.absent? }
+    rule(:template_content) {
+      (
+        ocurly >> nocurly | # Opening curly that doesn't start a {{}}
+        ocurly >> eof     | # Opening curly that doesn't start a {{}} because it's the end
+        ccurly            | # Closing curly that is not inside a {{}}
+        nocurly
+      ).repeat(1).as(:template_content) }
 
-    rule(:replacement) { docurly >> space? >> path.as(:replaced_item) >> space? >> dccurly}
-    rule(:safe_replacement) { ocurly >> replacement >> ccurly }
+    rule(:unsafe_replacement) { docurly >> space? >> path.as(:replaced_unsafe_item) >> space? >> dccurly }
+    rule(:safe_replacement) { tocurly >> space? >> path.as(:replaced_safe_item) >> space? >> tccurly }
 
-    rule(:sq_string)   { match("'") >> match("[^']").repeat(1).as(:str_content) >> match("'") }
-    rule(:dq_string)   { match('"') >> match('[^"]').repeat(1).as(:str_content) >> match('"') }
+    rule(:sq_string)   { match("'") >> match("[^']").repeat.maybe.as(:str_content) >> match("'") }
+    rule(:dq_string)   { match('"') >> match('[^"]').repeat.maybe.as(:str_content) >> match('"') }
     rule(:string)      { sq_string | dq_string }
 
-    rule(:parameter)   { (path | string).as(:parameter_name) }
+    rule(:parameter)   {
+      (path | string).as(:parameter_name) |
+      (str('(') >> space? >> identifier.as(:safe_helper_name) >> (space? >> parameters.as(:parameters)).maybe >> space? >> str(')'))
+    }
     rule(:parameters)  { parameter >> (space >> parameter).repeat }
 
-    rule(:unsafe_helper) { docurly >> space? >> identifier.as(:helper_name) >> (space? >> parameters.as(:parameters)).maybe >> space? >> dccurly}
-    rule(:safe_helper) { ocurly >> helper >> ccurly }
+    rule(:unsafe_helper) { docurly >> space? >> identifier.as(:unsafe_helper_name) >> (space? >> parameters.as(:parameters)).maybe >> space? >> dccurly }
+    rule(:safe_helper) { tocurly >> space? >> identifier.as(:safe_helper_name) >> (space? >> parameters.as(:parameters)).maybe >> space? >> tccurly }
 
     rule(:helper) { unsafe_helper | safe_helper }
 
@@ -58,8 +71,8 @@ module Handlebars
       dccurly
     }
 
-    rule(:block) { (template_content | replacement | safe_replacement | helper | partial | block_helper ).repeat.as(:block_items) }
+    rule(:block) { (template_content | unsafe_replacement | safe_replacement | helper | partial | block_helper ).repeat.as(:block_items) }
 
     root :block
   end
-end
+end

data/lib/ruby-handlebars/template.rb

@@ -7,12 +7,12 @@ module Handlebars
       @ast = ast
     end
 
-    def call(args)
-      if args.is_a? Hash
+    def call(args = nil)
+      if args
         @hbs.set_context(args)
       end
 
       @ast.eval(@hbs)
     end
   end
-end
+end

data/lib/ruby-handlebars/tree.rb

@@ -1,5 +1,3 @@
-require 'colorize'
-
 module Handlebars
   module Tree
     class TreeItem < Struct
@@ -28,6 +26,12 @@ module Handlebars
       end
     end
 
+    class EscapedReplacement < Replacement
+      def _eval(context)
+        context.escaper.escape(super(context).to_s)
+      end
+    end
+
     class String < TreeItem.new(:content)
       def _eval(context)
         return content
@@ -50,9 +54,15 @@ module Handlebars
       end
     end
 
+    class EscapedHelper < Helper
+      def _eval(context)
+        context.escaper.escape(super(context).to_s)
+      end
+    end
+
     class Partial < TreeItem.new(:partial_name)
       def _eval(context)
-        context.get_partial(partial_name.to_s).call(context)
+        context.get_partial(partial_name.to_s).call
       end
     end
 
@@ -70,12 +80,19 @@ module Handlebars
 
   class Transform < Parslet::Transform
     rule(template_content: simple(:content)) {Tree::TemplateContent.new(content)}
-    rule(replaced_item: simple(:item)) {Tree::Replacement.new(item)}
+    rule(replaced_unsafe_item: simple(:item)) {Tree::EscapedReplacement.new(item)}
+    rule(replaced_safe_item: simple(:item)) {Tree::Replacement.new(item)}
     rule(str_content: simple(:content)) {Tree::String.new(content)}
     rule(parameter_name: simple(:name)) {Tree::Parameter.new(name)}
 
     rule(
-      helper_name: simple(:name),
+      unsafe_helper_name: simple(:name),
+      parameters: subtree(:parameters)
+    ) {
+      Tree::EscapedHelper.new(name, parameters)
+    }
+    rule(
+      safe_helper_name: simple(:name),
       parameters: subtree(:parameters)
     ) {
       Tree::Helper.new(name, parameters)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-handlebars
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Vincent Pretre
@@ -9,88 +9,68 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.2
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.5
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.5
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.9.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.9.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.9.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,62 +95,62 @@ dependencies:
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.3
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.3
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.3
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.6
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.6
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.6
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 description: 
 email: v.pretre@hiptest.net
 executables: []
@@ -183,6 +163,8 @@ files:
 - README.md
 - lib/ruby-handlebars.rb
 - lib/ruby-handlebars/context.rb
+- lib/ruby-handlebars/escapers/dummy_escaper.rb
+- lib/ruby-handlebars/escapers/html_escaper.rb
 - lib/ruby-handlebars/helper.rb
 - lib/ruby-handlebars/parser.rb
 - lib/ruby-handlebars/template.rb
@@ -205,8 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Pure Ruby library for Handlebars templates