ruby-handlebars 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4850c228d3a84c6701b524aecbb493f801bc4927
+  data.tar.gz: d3d9abdc1cae0ab1a3625f500ec6f39a30c8cc75
+SHA512:
+  metadata.gz: e9e72431e3c5687b375b8064dbdb99ce089d395aca63d7d0ae09f65d75742f67f9479c91a7f5ebfa0d204f957aaca7d4b468dab2325ec1238dc42ac9f624dff4
+  data.tar.gz: c24ae4750d88e834db222b5830b242ae0a8571295aca85e3c38bc6acc895895c51f7d846608336b95573cc2304d6f784fbd3dcfe6336317d66f22cd49db2361d

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Vincent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,8 @@
+# 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)
+
+Pure Ruby library for Handlebars templates.
+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.

data/lib/ruby-handlebars.rb

@@ -0,0 +1,82 @@
+require_relative 'ruby-handlebars/parser'
+require_relative 'ruby-handlebars/tree'
+require_relative 'ruby-handlebars/template'
+require_relative 'ruby-handlebars/helper'
+
+module Handlebars
+  class Handlebars
+    include Context
+
+    def initialize
+      @helpers = {}
+      @partials = {}
+      register_default_helpers
+    end
+
+    def compile(template)
+      Template.new(self, template_to_ast(template))
+    end
+
+    def register_helper(name, &fn)
+      @helpers[name.to_s] = Helper.new(self, fn)
+    end
+
+    def get_helper(name)
+      @helpers[name.to_s]
+    end
+
+    def register_partial(name, content)
+      @partials[name.to_s] = Template.new(self, template_to_ast(content))
+    end
+
+    def get_partial(name)
+      @partials[name.to_s]
+    end
+
+    def set_context(ctx)
+      @data = ctx
+    end
+
+    private
+    def template_to_ast(content)
+      Transform.new.apply(Parser.new.parse(content))
+    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|
+        current_this = context.get('this')
+
+        if items.empty? && else_block
+          result = else_block.fn(context)
+        else
+          result = items.map do |item|
+            context.add_item(:this, item)
+            block.fn(context)
+          end.join('')
+        end
+
+        context.add_item(:this, current_this)
+        result
+      end
+    end
+  end
+end

data/lib/ruby-handlebars/context.rb

@@ -0,0 +1,41 @@
+module Handlebars
+  module Context
+    def get(path)
+      items = path.split('.')
+
+      current = @data
+      until items.empty?
+        current = get_attribute(current, items.shift)
+      end
+
+      current
+    end
+
+    def add_item(key, value)
+      @data[key] = value
+    end
+
+    private
+
+    def get_attribute(item, attribute)
+      sym_attr = attribute.to_sym
+      str_attr = attribute.to_s
+
+      if item.respond_to?('[]')
+        if item.has_key?(sym_attr)
+          return item[sym_attr]
+        elsif item.has_key?(str_attr)
+          return item[str_attr]
+        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
+    end
+  end
+end

data/lib/ruby-handlebars/helper.rb

@@ -0,0 +1,41 @@
+require_relative 'tree'
+
+module Handlebars
+  class Helper
+    def initialize(hbs, fn)
+      @hbs = hbs
+      @fn = fn
+    end
+
+    def apply(context, arguments = [], block = [])
+      arguments = [arguments] unless arguments.is_a? Array
+      args = [context] + arguments.map {|arg| arg.eval(context)} + split_block(block || [])
+
+      @fn.call(*args)
+    end
+
+    def split_block(block)
+      helper_block = Tree::Block.new([])
+      inverse_block = Tree::Block.new([])
+
+      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]
+      else
+        return [helper_block]
+      end
+    end
+  end
+end

data/lib/ruby-handlebars/parser.rb

@@ -0,0 +1,66 @@
+require 'pry'
+require 'parslet'
+
+module Handlebars
+  class Parser < Parslet::Parser
+    rule(:space)       { match('\s').repeat(1) }
+    rule(:space?)      { space.maybe }
+    rule(:dot)         { str('.') }
+    rule(:gt)          { str('>')}
+    rule(:hash)        { str('#')}
+    rule(:slash)       { str('/')}
+    rule(:ocurly)      { str('{')}
+    rule(:ccurly)      { str('}')}
+
+    rule(:docurly)     { ocurly >> ocurly }
+    rule(:dccurly)     { ccurly >> ccurly }
+
+    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(:replacement) { docurly >> space? >> path.as(:replaced_item) >> space? >> dccurly}
+    rule(:safe_replacement) { ocurly >> replacement >> ccurly }
+
+    rule(:sq_string)   { match("'") >> match("[^']").repeat(1).as(:str_content) >> match("'") }
+    rule(:dq_string)   { match('"') >> match('[^"]').repeat(1).as(:str_content) >> match('"') }
+    rule(:string)      { sq_string | dq_string }
+
+    rule(:parameter)   { (path | string).as(:parameter_name) }
+    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(:helper) { unsafe_helper | safe_helper }
+
+    rule(:block_helper) {
+      docurly >>
+      hash >>
+      identifier.capture(:helper_name).as(:helper_name) >>
+      (space >> parameters.as(:parameters)).maybe >>
+      space? >>
+      dccurly >>
+      scope {
+        block
+      } >>
+      dynamic { |src, scope|
+        docurly >> slash >> str(scope.captures[:helper_name]) >> dccurly
+      }
+    }
+
+    rule(:partial) {
+      docurly >>
+      gt >>
+      space? >>
+      identifier.as(:partial_name) >>
+      space? >>
+      dccurly
+    }
+
+    rule(:block) { (template_content | replacement | safe_replacement | helper | partial | block_helper ).repeat.as(:block_items) }
+
+    root :block
+  end
+end

data/lib/ruby-handlebars/template.rb

@@ -0,0 +1,18 @@
+require_relative 'context'
+
+module Handlebars
+  class Template
+    def initialize(hbs, ast)
+      @hbs = hbs
+      @ast = ast
+    end
+
+    def call(args)
+      if args.is_a? Hash
+        @hbs.set_context(args)
+      end
+
+      @ast.eval(@hbs)
+    end
+  end
+end

data/lib/ruby-handlebars/tree.rb

@@ -0,0 +1,102 @@
+require 'colorize'
+
+module Handlebars
+  module Tree
+    class TreeItem < Struct
+      def eval(context)
+        _eval(context)
+      end
+    end
+
+    class TemplateContent < TreeItem.new(:content)
+      def _eval(context)
+        return content
+      end
+    end
+
+    class Replacement < TreeItem.new(:item)
+      def _eval(context)
+        if context.get_helper(item.to_s).nil?
+          context.get(item.to_s)
+        else
+          context.get_helper(item.to_s).apply(context)
+        end
+      end
+
+      def is_else?
+        item.to_s == 'else'
+      end
+    end
+
+    class String < TreeItem.new(:content)
+      def _eval(context)
+        return content
+      end
+    end
+
+    class Parameter < TreeItem.new(:name)
+      def _eval(context)
+        if name.is_a?(Parslet::Slice)
+          context.get(name.to_s)
+        else
+          name._eval(context)
+        end
+      end
+    end
+
+    class Helper < TreeItem.new(:name, :parameters, :block)
+      def _eval(context)
+        context.get_helper(name.to_s).apply(context, parameters, block)
+      end
+    end
+
+    class Partial < TreeItem.new(:partial_name)
+      def _eval(context)
+        context.get_partial(partial_name.to_s).call(context)
+      end
+    end
+
+    class Block < TreeItem.new(:items)
+      def _eval(context)
+        items.map {|item| item._eval(context)}.join()
+      end
+      alias :fn :_eval
+
+      def add_item(i)
+        items << i
+      end
+    end
+  end
+
+  class Transform < Parslet::Transform
+    rule(template_content: simple(:content)) {Tree::TemplateContent.new(content)}
+    rule(replaced_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),
+      parameters: subtree(:parameters)
+    ) {
+      Tree::Helper.new(name, parameters)
+    }
+
+    rule(
+      helper_name: simple(:name),
+      block_items: subtree(:block_items)
+    ) {
+      Tree::Helper.new(name, [], block_items)
+    }
+
+    rule(
+      helper_name: simple(:name),
+      parameters: subtree(:parameters),
+      block_items: subtree(:block_items)
+    ) {
+      Tree::Helper.new(name, parameters, block_items)
+    }
+
+    rule(partial_name: simple(:partial_name)) {Tree::Partial.new(partial_name)}
+    rule(block_items: subtree(:block_items)) {Tree::Block.new(block_items)}
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: ruby-handlebars
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vincent Pretre
+- Hiptest R&D
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  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::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'
+  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::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email: v.pretre@hiptest.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/ruby-handlebars.rb
+- lib/ruby-handlebars/context.rb
+- lib/ruby-handlebars/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
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Pure Ruby library for Handlebars templates
+test_files: []