ruby-handlebars 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2237e25fe7e159de9f12860cf7a832200e1154e5c1bf4b3ae13208d17a6d5a86
-  data.tar.gz: b98b8c72ea564f7a35bd71029ad7ff8105c42f2b464e59dde0ef13b89f9aa102
+SHA1:
+  metadata.gz: 172b5ec24e44155491b10c90400ffdfe5b194ae5
+  data.tar.gz: 7d9b4798b10bb3ef81e7544ca11b29c39b4f7138
 SHA512:
-  metadata.gz: 377a11ba8a636bb05b030509111fb35ba5a92b3662b0c6bbbebd96c05d47d906236fc5b9788e26d9ee38b4e5b9fd462b386e114e19c6fdb0816c5394294dcaa0
-  data.tar.gz: 31d29b8da30b04404a30f21d567fda3506551651092dd3b050fc072a919d7693c238eb4c45fb2f2cc7394a34d458eebe576a8ecc99cdb07176baf11131f3b98d
+  metadata.gz: 36fbea8427cbb7938bbe2f565b365f74ae74a635614a408c89b6ba251ccfac8733d08fb2933f52494a3db6ccd2ba4f67c1b6deb118310592566e1373c92182e4
+  data.tar.gz: 6053e070453271400590c0668093de272036097a9ef6edace30f67f2a58e2599e5a1665541cf86dae50f584a63b72a5c682382b76096f7e03ada8997b66d7e8d

data/README.md

@@ -1,9 +1,9 @@
 ruby-handlebars
 ===============
 
-[![Build Status](https://travis-ci.org/vincent-psarga/ruby-handlebars.svg?branch=master)](https://travis-ci.org/vincent-psarga/ruby-handlebars)
-[![Code Climate](https://codeclimate.com/github/vincent-psarga/ruby-handlebars/badges/gpa.svg)](https://codeclimate.com/github/vincent-psarga/ruby-handlebars)
-[![Test Coverage](https://codeclimate.com/github/vincent-psarga/ruby-handlebars/badges/coverage.svg)](https://codeclimate.com/github/vincent-psarga/ruby-handlebars)
+[![Build Status](https://travis-ci.org/SmartBear/ruby-handlebars.svg?branch=master)](https://travis-ci.org/SmartBear/ruby-handlebars)
+[![Maintainability](https://api.codeclimate.com/v1/badges/22dbe81de487cb27097c/maintainability)](https://codeclimate.com/github/SmartBear/ruby-handlebars/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/22dbe81de487cb27097c/test_coverage)](https://codeclimate.com/github/SmartBear/ruby-handlebars/test_coverage)
 
 Pure Ruby library for [Handlebars](http://handlebarsjs.com/) template system.
 The main goal of this library is to simplify the use of Ruby and Handlebars on Windows machine. If you do not have any need of working on Windows, take a look at [handlebars.rb](https://github.com/cowboyd/handlebars.rb) that uses the real Handlebars library.
@@ -100,6 +100,16 @@ template = [
 ].join("\n")
 ```
 
+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.
+
+For example:
+
+```ruby
+hbs.register_helper('helperMissing') do |context, name|
+  puts "No helper found with name #{name}"
+end
+```
+
 Limitations and roadmap
 -----------------------
 
@@ -114,4 +124,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 and @schuetzm for making it a way better Handlebars renderer :)

data/lib/ruby-handlebars.rb

@@ -2,6 +2,7 @@ require_relative 'ruby-handlebars/parser'
 require_relative 'ruby-handlebars/tree'
 require_relative 'ruby-handlebars/template'
 require_relative 'ruby-handlebars/helper'
+require_relative 'ruby-handlebars/helpers/register_default_helpers'
 require_relative 'ruby-handlebars/escapers/html_escaper'
 
 module Handlebars
@@ -54,40 +55,7 @@ module Handlebars
     end
 
     def register_default_helpers
-      register_if_helper
-      register_each_helper
-    end
-
-    def register_if_helper
-      register_helper('if') do |context, condition, block, else_block|
-        condition = !condition.empty? if condition.respond_to?(:empty?)
-
-        if condition
-          block.fn(context)
-        elsif else_block
-          else_block.fn(context)
-        else
-          ""
-        end
-      end
-    end
-
-    def register_each_helper
-      register_helper('each') do |context, items, 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
-            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
-        result
-      end
+      Helpers.register_default_helpers(self)
     end
   end
 end

data/lib/ruby-handlebars/helper.rb

@@ -7,35 +7,27 @@ module Handlebars
       @fn = fn
     end
 
-    def apply(context, arguments = [], block = [])
+    def apply(context, arguments = [], block = [], else_block = [])
       arguments = [arguments] unless arguments.is_a? Array
-      args = [context] + arguments.map {|arg| arg.eval(context)} + split_block(block || [])
+      args = [context] + arguments.map {|arg| arg.eval(context)} + split_block(block, else_block)
 
       @fn.call(*args)
     end
 
-    def split_block(block)
-      helper_block = Tree::Block.new([])
-      inverse_block = Tree::Block.new([])
+    private
 
-      receiver = helper_block
-      else_found = false
-
-      block.each do |item|
-        if item.is_a?(Tree::Replacement) && item.is_else?
-          receiver = inverse_block
-          else_found = true
-          next
-        end
-
-        receiver.add_item(item)
-      end
-
-      if else_found
-        return [helper_block, inverse_block]
+    def split_block(block, else_block)
+      if else_block
+        [ensure_block(block), ensure_block(else_block)]
       else
-        return [helper_block]
+        [ensure_block(block)]
       end
     end
+
+    def ensure_block(block)
+      new_block = Tree::Block.new([])
+      block.each {|item| new_block.add_item(item) } unless block.nil?
+      new_block
+    end
   end
-end
+end

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

@@ -0,0 +1,20 @@
+module Handlebars
+  module Helpers
+    class DefaultHelper
+      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
+
+      # Should be implemented by sub-classes
+      # def self.registry_name
+      #   'myHelperName'
+      # end
+
+      # def self.apply(context, parameters, block, else_block)
+      #   # Do things and stuff
+      # end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require_relative 'default_helper'
+
+module Handlebars
+  module Helpers
+    class EachHelper < DefaultHelper
+      def self.registry_name
+        'each'
+      end
+
+      def self.apply(context, items, 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
+            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
+        result
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'default_helper'
+
+module Handlebars
+  class UnknownHelper < StandardError
+  end
+
+  module Helpers
+    class HelperMissingHelper < DefaultHelper
+      def self.registry_name
+        'helperMissing'
+      end
+
+      def self.apply(context, name, block, else_block)
+        raise(::Handlebars::UnknownHelper, "Helper \"#{name}\" does not exist" )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative 'default_helper'
+
+module Handlebars
+  module Helpers
+    class IfHelper < DefaultHelper
+      def self.registry_name
+        'if'
+      end
+
+      def self.apply(context, condition, block, else_block)
+        condition = !condition.empty? if condition.respond_to?(:empty?)
+
+        if condition
+          block.fn(context)
+        elsif else_block
+          else_block.fn(context)
+        else
+          ""
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative 'each_helper'
+require_relative 'helper_missing_helper'
+require_relative 'if_helper'
+require_relative 'unless_helper'
+
+module Handlebars
+  module Helpers
+    def self.register_default_helpers(hbs)
+      EachHelper.register(hbs)
+      HelperMissingHelper.register(hbs)
+      IfHelper.register(hbs)
+      UnlessHelper.register(hbs)
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative 'default_helper'
+
+module Handlebars
+  module Helpers
+    class UnlessHelper < DefaultHelper
+      def self.registry_name
+        'unless'
+      end
+
+      def self.apply(context, condition, block, else_block)
+        condition = !condition.empty? if condition.respond_to?(:empty?)
+
+        unless condition
+          block.fn(context)
+        else
+          else_block ? else_block.fn(context) : ""
+        end
+      end
+    end
+  end
+end

data/lib/ruby-handlebars/parser.rb

@@ -16,7 +16,8 @@ module Handlebars
     rule(:tocurly)     { ocurly >> ocurly >> ocurly }
     rule(:tccurly)     { ccurly >> ccurly >> ccurly }
 
-    rule(:identifier)  { match['@a-zA-Z0-9_\?'].repeat(1) }
+    rule(:else_kw)     { str('else') }
+    rule(:identifier)  { (else_kw >> space? >> dccurly).absent? >> match['@\-a-zA-Z0-9_\?'].repeat(1) }
     rule(:path)        { identifier >> (dot >> identifier).repeat }
 
     rule(:nocurly)     { match('[^{}]') }
@@ -57,6 +58,9 @@ module Handlebars
       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
       }
@@ -71,7 +75,8 @@ module Handlebars
       dccurly
     }
 
-    rule(:block) { (template_content | unsafe_replacement | safe_replacement | helper | partial | block_helper ).repeat.as(:block_items) }
+    rule(:block_item) { (template_content | unsafe_replacement | safe_replacement | helper | partial | block_helper ) }
+    rule(:block) { block_item.repeat.as(:block_items) }
 
     root :block
   end

data/lib/ruby-handlebars/tree.rb

@@ -20,10 +20,6 @@ module Handlebars
           context.get_helper(item.to_s).apply(context)
         end
       end
-
-      def is_else?
-        item.to_s == 'else'
-      end
     end
 
     class EscapedReplacement < Replacement
@@ -48,9 +44,14 @@ module Handlebars
       end
     end
 
-    class Helper < TreeItem.new(:name, :parameters, :block)
+    class Helper < TreeItem.new(:name, :parameters, :block, :else_block)
       def _eval(context)
-        context.get_helper(name.to_s).apply(context, parameters, block)
+        helper = context.get_helper(name.to_s)
+        if helper.nil?
+          context.get_helper('helperMissing').apply(context, String.new(name.to_s))
+        else
+          helper.apply(context, parameters, block, else_block)
+        end
       end
     end
 
@@ -75,6 +76,7 @@ module Handlebars
       def add_item(i)
         items << i
       end
+
     end
   end
 
@@ -91,6 +93,7 @@ module Handlebars
     ) {
       Tree::EscapedHelper.new(name, parameters)
     }
+
     rule(
       safe_helper_name: simple(:name),
       parameters: subtree(:parameters)
@@ -100,20 +103,38 @@ module Handlebars
 
     rule(
       helper_name: simple(:name),
-      block_items: subtree(:block_items)
+      block_items: subtree(:block_items),
     ) {
       Tree::Helper.new(name, [], block_items)
     }
 
+    rule(
+      helper_name: simple(:name),
+      block_items: subtree(:block_items),
+      else_block_items: subtree(:else_block_items)
+    ) {
+      Tree::Helper.new(name, [], block_items, else_block_items)
+    }
+
     rule(
       helper_name: simple(:name),
       parameters: subtree(:parameters),
-      block_items: subtree(:block_items)
+      block_items: subtree(:block_items),
     ) {
       Tree::Helper.new(name, parameters, block_items)
     }
 
+    rule(
+      helper_name: simple(:name),
+      parameters: subtree(:parameters),
+      block_items: subtree(:block_items),
+      else_block_items: subtree(:else_block_items)
+    ) {
+      Tree::Helper.new(name, 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)}
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-handlebars
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vincent Pretre
@@ -9,68 +9,68 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-08-30 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'
     - - ">="
       - !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'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.9.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.9.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,62 +95,42 @@ dependencies:
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !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'
-    - - ">="
-      - !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'
-    - - ">="
-      - !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'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.6
+        version: 3.1.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: 
 email: v.pretre@hiptest.net
 executables: []
@@ -166,10 +146,16 @@ files:
 - lib/ruby-handlebars/escapers/dummy_escaper.rb
 - lib/ruby-handlebars/escapers/html_escaper.rb
 - lib/ruby-handlebars/helper.rb
+- lib/ruby-handlebars/helpers/default_helper.rb
+- lib/ruby-handlebars/helpers/each_helper.rb
+- lib/ruby-handlebars/helpers/helper_missing_helper.rb
+- lib/ruby-handlebars/helpers/if_helper.rb
+- lib/ruby-handlebars/helpers/register_default_helpers.rb
+- lib/ruby-handlebars/helpers/unless_helper.rb
 - lib/ruby-handlebars/parser.rb
 - lib/ruby-handlebars/template.rb
 - lib/ruby-handlebars/tree.rb
-homepage: https://github.com/vincent-psarga/ruby-handlebars
+homepage: https://github.com/smartbear/ruby-handlebars
 licenses: []
 metadata: {}
 post_install_message: 
@@ -187,7 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Pure Ruby library for Handlebars templates