ruby-handlebars 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab18e04aceeade619546191a66499ee4d7c1bab5
-  data.tar.gz: 83080df33384b570dc88269960ee29929eb1b47a
+  metadata.gz: c95697b3d0cf8b3500b7249cb254cfb97eb38bf2
+  data.tar.gz: 9e1549cddad55b384bcda6fda8e9284c158159de
 SHA512:
-  metadata.gz: 1f2a8eac8b1c767a7f33f68c375751b27d54676cd65aa9ed641301ebce1e17a0fd55bc40619544eb691e43449f1231d205cbe6f931a22bfb6d2b28ac6ed201cd
-  data.tar.gz: 5d814478c5fa2112446ab1263c548596e6d27cf9a78325cc9e83e1dfab677ca83cf04d21285ecf8ad712fee483d712d20880f0bf485c763bc468ba2e0898d387
+  metadata.gz: 6f602263f74b2a2cbc186643288f6b7c636969bb3ce07480de9a0f3c7ec00064d7df5c86138764c32c640781f07686099b7abadfbeb8f4d1a8da926240ac76c4
+  data.tar.gz: bb6ff52d41ae7c6b1f8d9dbb2c8b0a54370c3f483457eef30e86e692166b2151993354c39d6765db854e7ac77711feb2275a7549431e546c53f979e77174f500

data/README.md

@@ -82,22 +82,49 @@ hbs.compile(template).call({description: my_description})
 # Output will depend on the validity of the 'my_description' variable
 ```
 
-Two default helpers are provided: ``each`` and ``if``. It is not yet possible to name the current item in an each loop and ``this`` must be used to reference it.
+Default helpers:
+----------------
 
-```ruby
-template = [
-  "{{#each items}}",
-  "  {{{ this }}}",
-  "{{else}}",
-  "  No items",
-  "{{/each}}",
-  "",
-  "{{#if my_condition}}",
-  "  It's ok",
-  "{{else}}",
-  "  or maybe not",
-  "{{/if}}",
-].join("\n")
+Three default helpers are provided: ``each``, ``if`` and ``unless``.
+
+The each helper let you walk through a list. You can either use the basic notation and referencing the current item as ``this``:
+
+```
+  {{#each items}}
+    {{{ this }}}
+  {{else}}
+    No items
+  {{/each}}
+```
+
+or the "as |name|" notation:
+
+```
+  {{#each items as |item| }}
+    {{{ item }}}
+  {{else}}
+    No items
+  {{/each}}
+```
+
+The ``if`` helper can be used to write conditionnal templates:
+
+```
+  {{#if my_condition}}
+    It's ok
+  {{else}}
+    or maybe not
+  {{/if}}
+```
+
+The ``unless`` helper works the opposite way to ``if``:
+
+```
+  {{#unless my_condition}}
+    It's not ok
+  {{else}}
+    or maybe it is
+  {{/unless}}
 ```
 
 Currently, if you call an unknown helper, it will raise an exception. You can override that by registering your own version of the ``helperMissing`` helper. Note that only the name of the missing helper will be provided.
@@ -124,4 +151,4 @@ 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 :)
+Thanks a lot to the contributors @mvz, @schuetzm and @stewartmckee for making it a way better Handlebars renderer :)

data/lib/ruby-handlebars.rb

@@ -11,6 +11,7 @@ module Handlebars
     attr_reader :escaper
 
     def initialize()
+      @as_helpers = {}
       @helpers = {}
       @partials = {}
       register_default_helpers
@@ -25,10 +26,18 @@ module Handlebars
       @helpers[name.to_s] = Helper.new(self, fn)
     end
 
+    def register_as_helper(name, &fn)
+      @as_helpers[name.to_s] = Helper.new(self, fn)
+    end
+
     def get_helper(name)
       @helpers[name.to_s]
     end
 
+    def get_as_helper(name)
+      @as_helpers[name.to_s]
+    end
+
     def register_partial(name, content)
       @partials[name.to_s] = Template.new(self, template_to_ast(content))
     end

data/lib/ruby-handlebars/helper.rb

@@ -14,6 +14,14 @@ module Handlebars
       @fn.call(*args)
     end
 
+    def apply_as(context, arguments = [], as_arguments = [], block = [], else_block = [])
+      arguments = [arguments] unless arguments.is_a? Array
+      as_arguments = [as_arguments] unless as_arguments.is_a? Array
+      args = [context] + arguments.map {|arg| arg.eval(context)} + as_arguments.map(&:name) + split_block(block, else_block)
+
+      @fn.call(*args)
+    end
+
     private
 
     def split_block(block, else_block)

data/lib/ruby-handlebars/helpers/default_helper.rb

@@ -4,7 +4,11 @@ module Handlebars
       def self.register(hbs)
         hbs.register_helper(self.registry_name) do |context, parameters, block, else_block|
           self.apply(context, parameters, block, else_block)
-        end
+        end if self.respond_to?(:apply)
+
+        hbs.register_as_helper(self.registry_name) do |context, parameters, as_names, block, else_block|
+          self.apply_as(context, parameters, as_names, block, else_block)
+        end if self.respond_to?(:apply_as)
       end
 
       # Should be implemented by sub-classes
@@ -15,6 +19,10 @@ module Handlebars
       # def self.apply(context, parameters, block, else_block)
       #   # Do things and stuff
       # end
+
+      # def self.apply_as(context, parameters, as_names, block, else_block)
+      #   # Do things and stuffa, but with 'as |param| notation'
+      # end
     end
   end
 end

data/lib/ruby-handlebars/helpers/each_helper.rb

@@ -8,14 +8,18 @@ module Handlebars
       end
 
       def self.apply(context, items, block, else_block)
+        self.apply_as(context, items, :this, block, else_block)
+      end
+
+      def self.apply_as(context, items, name, block, else_block)
         if (items.nil? || items.empty?)
           if else_block
             result = else_block.fn(context)
           end
         else
-          context.with_temporary_context(:this => nil, :@index => 0, :@first => false, :@last => false) do
+          context.with_temporary_context(name => 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))
+              context.add_items(name => item, :@index => index, :@first => (index == 0), :@last => (index == items.length - 1))
               block.fn(context)
             end.join('')
           end

data/lib/ruby-handlebars/parser.rb

@@ -10,6 +10,8 @@ module Handlebars
     rule(:slash)       { str('/')}
     rule(:ocurly)      { str('{')}
     rule(:ccurly)      { str('}')}
+    rule(:pipe)        { str('|')}
+
 
     rule(:docurly)     { ocurly >> ocurly }
     rule(:dccurly)     { ccurly >> ccurly }
@@ -17,6 +19,8 @@ module Handlebars
     rule(:tccurly)     { ccurly >> ccurly >> ccurly }
 
     rule(:else_kw)     { str('else') }
+    rule(:as_kw)       { str('as') }
+
     rule(:identifier)  { (else_kw >> space? >> dccurly).absent? >> match['@\-a-zA-Z0-9_\?'].repeat(1) }
     rule(:path)        { identifier >> (dot >> (identifier | else_kw)).repeat }
 
@@ -38,8 +42,11 @@ module Handlebars
     rule(:string)      { sq_string | dq_string }
 
     rule(:parameter)   {
-      (path | string).as(:parameter_name) |
-      (str('(') >> space? >> identifier.as(:safe_helper_name) >> (space? >> parameters.as(:parameters)).maybe >> space? >> str(')'))
+      (as_kw >> space? >> pipe).absent? >>
+      (
+        (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 }
 
@@ -48,6 +55,25 @@ module Handlebars
 
     rule(:helper) { unsafe_helper | safe_helper }
 
+    rule(:as_block_helper) {
+      docurly >>
+      hash >>
+      identifier.capture(:helper_name).as(:helper_name) >>
+      space >> parameters.as(:parameters) >>
+      space >> as_kw >> space >> pipe >> space? >> parameters.as(:as_parameters) >> space? >> pipe >>
+      space? >>
+      dccurly >>
+      scope {
+        block
+      } >>
+      scope {
+        docurly >> space? >> else_kw >> space? >> dccurly >> scope { block_item.repeat.as(:else_block_items) }
+      }.maybe >>
+      dynamic { |src, scope|
+        docurly >> slash >> str(scope.captures[:helper_name]) >> dccurly
+      }
+    }
+
     rule(:block_helper) {
       docurly >>
       hash >>
@@ -75,7 +101,7 @@ module Handlebars
       dccurly
     }
 
-    rule(:block_item) { (template_content | unsafe_replacement | safe_replacement | helper | partial | block_helper ) }
+    rule(:block_item) { (template_content | unsafe_replacement | safe_replacement | helper | partial | block_helper | as_block_helper) }
     rule(:block) { block_item.repeat.as(:block_items) }
 
     root :block

data/lib/ruby-handlebars/tree.rb

@@ -55,6 +55,17 @@ module Handlebars
       end
     end
 
+    class AsHelper < TreeItem.new(:name, :parameters, :as_parameters, :block, :else_block)
+      def _eval(context)
+        helper = context.get_as_helper(name.to_s)
+        if helper.nil?
+          context.get_helper('helperMissing').apply(context, String.new(name.to_s))
+        else
+          helper.apply_as(context, parameters, as_parameters, block, else_block)
+        end
+      end
+    end
+
     class EscapedHelper < Helper
       def _eval(context)
         context.escaper.escape(super(context).to_s)
@@ -133,6 +144,25 @@ module Handlebars
       Tree::Helper.new(name, parameters, block_items, else_block_items)
     }
 
+    rule(
+      helper_name: simple(:name),
+      parameters: subtree(:parameters),
+      as_parameters: subtree(:as_parameters),
+      block_items: subtree(:block_items),
+    ) {
+      Tree::AsHelper.new(name, parameters, as_parameters, block_items)
+    }
+
+    rule(
+      helper_name: simple(:name),
+      parameters: subtree(:parameters),
+      as_parameters: subtree(:as_parameters),
+      block_items: subtree(:block_items),
+      else_block_items: subtree(:else_block_items)
+    ) {
+      Tree::AsHelper.new(name, parameters, as_parameters, block_items, else_block_items)
+    }
+
     rule(partial_name: simple(:partial_name)) {Tree::Partial.new(partial_name)}
     rule(block_items: subtree(:block_items)) {Tree::Block.new(block_items)}
     rule(else_block_items: subtree(:else_block_items)) {Tree::Block.new(block_items)}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-handlebars
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vincent Pretre
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-30 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet