handlebars_exec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60e887a03f7cdda968d7abee96dcc17abc299aa8
+  data.tar.gz: 6dcc67d0a537f4cd33ef5168fc0a317fdbf9c525
+SHA512:
+  metadata.gz: 3d9a4d42dac28b9b371b7186ad58de118a2ccea08a0ba3f9bfee3dc6cbf22f204940a0605633a5ab24f235efacff1d740dcf19af6aece671c713d8648f4c92ad
+  data.tar.gz: 7d868fb7d3432ba8ebe25c3cc003a17b8b2729184c0a69ce0672bd492eefd3512f920209c134cfc288286dfbff48605d70cf30f23e4d9ebc7df90312bdaabb6e

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+.DS_Store
+.ruby-version
+.*.swp
+gemfiles/*

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "mini_racer-0.1" do
+  gem "mini_racer", "0.1.3"
+end
+appraise "therubyracer-0.12" do
+  gem "therubyracer", "0.12.0"
+end
+appraise "external_js" do
+  # assumption made that node.js or other external runtime is installed
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Anthony Fojas
+
+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,54 @@
+## HandlebarsExec
+
+Bindings for [Handlebars.js][1] using [execjs][2]. Tested using [mini_racer][3], [therubyracer][4], and native [nodejs][5].
+
+## Usage
+
+### Simple Templates
+
+    handlebars = HandlebarsExec::Context.new
+    template = handlebars.compile("My Name is {{name}}")
+    template.template(name: "Slim Shady") #=> "My Name is Slim Shady"
+
+### Partials
+
+Partials can be added by either adding a string with the partial or by adding a file with the partial registration in it. Referencing a file allows you to use the same files for handlebars on the backend and frontend.
+
+    # passed as a string
+    handlebars.register_partial("my_partial", "{{foo}} {{bar}}")
+
+    # passed as a file location
+    handlebars.register_partial_file(partial_file_path)
+
+### Helpers
+
+Helpers can be added by either adding a string with the helper or by adding a file with the helper registration in it. Referencing a file allows you to use the same files for handlebars on the backend and frontend.
+
+    # passed as a string 
+    handlebars.register_helper("formatPhoneNumber", <<-HELP)
+      function(phoneNumber) {
+        phoneNumber = phoneNumber.toString();
+        return "(" + phoneNumber.substr(0,3) + ") " + phoneNumber.substr(3,3) + "-" + phoneNumber.substr(6,4);
+      }
+    HELP
+
+    # passed as a file location
+    handlebars.register_partial_file(partial_file_path)
+
+## Test
+
+Testing in different JS runtimes are handled using [Appraisal][6]. Once installed, the following will setup the different js runtime test setups
+
+    appraisal install
+
+Tests can then be run like so:
+
+    appraisal rake
+
+
+[1]: http://github.com/wycats/handlebars.js "Handlebars JavaScript templating library"
+[2]: https://github.com/rails/execjs "execjs"
+[3]: https://github.com/discourse/mini_racer "mini_racer"
+[4]: http://github.com/cowboyd/therubyracer "The Ruby Racer"
+[5]: https://nodejs.org/ "Node.js"
+[6]: https://github.com/thoughtbot/appraisal "Appraisal"

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rake'
+require 'appraisal'
+require 'pry'
+
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs.push 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.warning = true
+  t.verbose = true
+end
+ 
+task :default => :test
+ 
+desc 'Generates a coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].execute
+end
+

data/handlebars_exec.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = "handlebars_exec"
+  s.version     = '0.1.0'
+  s.authors     = ["Anthony Fojas"]
+  s.email       = "anthony.fojas@vibes.com"
+  s.summary     = "Ruby bindings for Handlebars.js"
+  s.description = "Bindings for handlebars using execjs. Tested using mini_racer, therubyracer, and native nodejs"
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "appraisal"
+  s.add_development_dependency "pry"
+
+  s.add_runtime_dependency 'execjs', '>= 2.7.0'
+  s.add_runtime_dependency 'handlebars-source'
+  s.license = 'MIT'
+end

data/lib/handlebars_exec.rb

@@ -0,0 +1,5 @@
+module HandlebarsExec
+end
+
+require 'handlebars_exec/context'
+require 'handlebars_exec/template'

data/lib/handlebars_exec/context.rb

@@ -0,0 +1,59 @@
+require "execjs"
+require "handlebars/source"
+
+module HandlebarsExec
+  class Context
+
+    attr_reader :context
+    def initialize
+      @sources= []
+      @_handlebars_source = File.read Handlebars::Source.bundled_path
+      @context = generate_context
+    end
+
+    def generate_context
+      sources = ([@_handlebars_source] + @sources).join("\n")
+      ExecJS.compile(sources)
+    end
+
+    def compile template
+      HandlebarsExec::Template.new self.context,template 
+    end
+
+    def add_file_to_context file
+      add_to_context File.read(file)
+    end
+    alias :register_helper_file :add_file_to_context
+    alias :register_partial_file :add_file_to_context
+
+    def register_partial_file name, file
+      add_to_context "Handlebars.registerPartial('#{name}', #{File.read(file).strip.inspect});"
+    end
+
+    def register_helper name, function
+      add_to_context "Handlebars.registerHelper('#{name}', #{function});"
+    end
+    def register_partial name, partial 
+      add_to_context "Handlebars.registerPartial('#{name}', #{partial.inspect});"
+    end
+
+    def add_to_context str
+      @sources.push (str)
+      if context_preserved_between_calls?
+        context.eval("(function(){ #{str}})()")
+      else
+        # ExecJS::ExternalRuntime::Context does not have a writable context
+        # the only way to attach new variables and functions is to destroy the old context
+        @context = generate_context
+      end
+    end
+
+    private
+      def context_preserved_between_calls?
+        [
+          "ExecJS::RubyRacerRuntime::Context",
+          "ExecJS::MiniRacerRuntime::Context"
+        ].include? context.class.to_s
+      end
+  end
+end

data/lib/handlebars_exec/template.rb

@@ -0,0 +1,12 @@
+module HandlebarsExec
+  class Template
+    def initialize context, template
+      @context = context
+      @template_string= template
+    end
+
+    def template variables
+      @context.eval("Handlebars.compile(#{@template_string.inspect})(#{variables.to_json})")
+    end
+  end
+end

data/spec/fixtures/partial.hbs

@@ -0,0 +1 @@
+{{name}}

data/spec/fixtures/phone_helpers.js

@@ -0,0 +1,4 @@
+Handlebars.registerHelper("formatPhoneNumber", function(phoneNumber) {
+  phoneNumber = phoneNumber.toString();
+  return "(" + phoneNumber.substr(0,3) + ") " + phoneNumber.substr(3,3) + "-" + phoneNumber.substr(6,4);
+})

data/spec/handlebars_exec/context_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe HandlebarsExec::Context do
+
+  let(:subject) { HandlebarsExec::Context.new }
+
+  describe "a simple template" do
+
+    describe "compiled" do
+      let(:compiled_template) { subject.compile("Hello {{name}}") }
+      it "compiles a template" do
+        compiled_template.must_be_instance_of HandlebarsExec::Template
+      end
+    end
+  end
+
+  describe "#register_helper_file" do
+    let(:helper_file_path) { 'spec/fixtures/phone_helpers.js' }
+    before(:context) do
+      subject.register_helper_file(helper_file_path)
+    end
+    it "has a helper" do
+      subject.context.eval('typeof Handlebars.helpers["formatPhoneNumber"]').must_equal "function"
+    end
+    it "can use a helper" do
+      subject.compile("call {{formatPhoneNumber telephone}}").template(telephone: "2813308004").must_equal "call (281) 330-8004"
+    end
+  end
+
+  describe "#register_helper" do
+    let(:helper) { File.read 'spec/fixtures/phone_helpers.js' }
+    before(:context) do
+      subject.register_helper("formatPhoneNumber", <<-HELP)
+        function(phoneNumber) {
+          phoneNumber = phoneNumber.toString();
+          return "(" + phoneNumber.substr(0,3) + ") " + phoneNumber.substr(3,3) + "-" + phoneNumber.substr(6,4);
+        }
+      HELP
+    end
+    it "has a helper" do
+      subject.context.eval('typeof Handlebars.helpers["formatPhoneNumber"]').must_equal "function"
+    end
+    it "can use a helper" do
+      subject.compile("call {{formatPhoneNumber telephone}}").template(telephone: "2813308004").must_equal "call (281) 330-8004"
+    end
+  end
+
+  describe "#register_partial_file" do
+    let(:partial_file_path) { 'spec/fixtures/partial.hbs' }
+    before(:context) do
+      subject.register_partial_file('myPartial', partial_file_path)
+    end
+    it "has a partial" do
+      subject.context.eval('typeof Handlebars.partials["myPartial"]').must_equal "string"
+    end
+    it "can parse the partial" do
+      subject.compile("Hello {{>myPartial}}").template(name: 'World').must_equal "Hello World"
+    end
+  end
+
+  describe "#register_partial" do
+    let(:partial) { File.read 'spec/fixtures/partial.hbs' }
+    before(:context) do
+      subject.register_partial('myPartial', '{{name}}')
+    end
+    it "has a partial" do
+      subject.context.eval('typeof Handlebars.partials["myPartial"]').must_equal "string"
+    end
+    it "can parse the partial" do
+      subject.compile("Hello {{>myPartial}}").template(name: 'World').must_equal "Hello World"
+    end
+  end
+end
+

data/spec/handlebars_exec/template_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe HandlebarsExec::Template do
+  let(:context) { HandlebarsExec::Context.new }
+  let(:subject) { HandlebarsExec::Template.new context.context, template_string }
+
+  describe "a simple template" do
+    let(:template_string) { "Hello {{name}}" }
+
+    it "allows simple subsitution" do
+      subject.template(name: "World").must_equal "Hello World"
+    end
+  end
+
+  describe "a template with multiple lines" do
+    let(:template_string) do
+       <<-TEMPLATE
+          Hello {{name.last}}
+      TEMPLATE
+    end
+
+    it "allows simple subsitution" do
+      subject.template(name: { last: "World"}).must_equal <<-TEMPLATE
+          Hello World
+      TEMPLATE
+    end
+  end
+
+  describe "a template with hash attributes" do
+    let(:template_string) { "Hello {{name.last}}" }
+
+    it "allows simple subsitution" do
+      subject.template(name: { last: "World"}).must_equal "Hello World"
+    end
+  end
+
+  describe "a template with an array " do
+    let(:template_string) { "Hello {{#each name}}{{this}}{{/each}}" }
+
+    it "allows simple subsitution" do
+      subject.template(name: %w(W o r l d)).must_equal "Hello World"
+    end
+  end
+
+  describe "with a helper" do
+    let(:helper) { 'spec/fixtures/phone_helpers.js' }
+    let(:template_string) { "call {{formatPhoneNumber telephone}}" }
+    before(:context) do
+      context.register_helper_file(helper)
+    end
+    it "can use a helper" do
+      subject.template(telephone: "2813308004").must_equal "call (281) 330-8004"
+    end
+  end
+
+  describe "with a partial" do
+    let(:partial) { 'spec/fixtures/partial.hbs' }
+    let(:template_string) { "Hello {{> myPartial}}" }
+    before(:context) do
+      context.register_partial_file("myPartial", partial)
+    end
+    it "can use a partial" do
+      subject.template(name: "World").must_equal "Hello World"
+    end
+  end
+end

data/spec/handlebars_exec_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe HandlebarsExec do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "minitest/autorun"
+require 'handlebars_exec'
+require "pry"

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: handlebars_exec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anthony Fojas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: appraisal
+  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
+  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: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: handlebars-source
+  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'
+description: Bindings for handlebars using execjs. Tested using mini_racer, therubyracer,
+  and native nodejs
+email: anthony.fojas@vibes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- handlebars_exec.gemspec
+- lib/handlebars_exec.rb
+- lib/handlebars_exec/context.rb
+- lib/handlebars_exec/template.rb
+- spec/fixtures/partial.hbs
+- spec/fixtures/phone_helpers.js
+- spec/handlebars_exec/context_spec.rb
+- spec/handlebars_exec/template_spec.rb
+- spec/handlebars_exec_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for Handlebars.js
+test_files:
+- spec/fixtures/partial.hbs
+- spec/fixtures/phone_helpers.js
+- spec/handlebars_exec/context_spec.rb
+- spec/handlebars_exec/template_spec.rb
+- spec/handlebars_exec_spec.rb
+- spec/spec_helper.rb