handlebarsjs 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c79e4eeab6a4fd09c9bd0cea9e7026915b0ebda02cb674f5b6f9452cebbdfb
-  data.tar.gz: d6585183a584d0547012feebb57c8e2fb80168bc91d1e7a153022f71c7c346e4
+  metadata.gz: 6264c529d68086fcf2d2abc20838e7c46ff5a2cb176ebf211d5f44f32b15c5bd
+  data.tar.gz: 05726eb4303fc7b54e5fe8a07afd5392f1f48c2efadedcbb12d99dc3a88b11a2
 SHA512:
-  metadata.gz: 0be0808881aa15b12ffecce41193bb6a293440e71f0b197c8f2844cba51c635080e13db93bf445a97fb462811404a14733c8ee46b58eb7aa41b669630ab87f54
-  data.tar.gz: 4c5c159dec697cf909c17eb5e28582f6eb04d87381444c8c963b024bbfd62517dbe98c561c98b5dbe4d09835281c6e992154bdbf11ca90e60aa9e385ec273936
+  metadata.gz: 4d28aa4b1af80536b8a9e26390a5e0e926568bc4fb82bc9d08d5d1509dfc00ba6a017e25b9d52d219fd4baf70b17de5d8d4a7426feef5248d1246f04e45e03e9
+  data.tar.gz: 61ab8b27c8a27326d91ae3726d348aa987825db3a1638e5807949055819e073073a564cf6fcb042ea44d603bc3f38332c3557797c340f48859fa46320af83633

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [0.5.0](https://github.com/klueless-io/handlebarsjs/compare/v0.4.0...v0.5.0) (2022-07-06)
+
+
+### Features
+
+* add base_helper ([d2900ae](https://github.com/klueless-io/handlebarsjs/commit/d2900ae6c2ce27a7a8ac4c92d219f0e9150354f5))
+
+# [0.4.0](https://github.com/klueless-io/handlebarsjs/compare/v0.3.0...v0.4.0) (2022-07-06)
+
+
+### Features
+
+* add handlebars add_helper support ([19a5636](https://github.com/klueless-io/handlebarsjs/commit/19a5636698515c6c3128040d708d54527ba62dec))
+
+# [0.3.0](https://github.com/klueless-io/handlebarsjs/compare/v0.2.0...v0.3.0) (2022-07-06)
+
+
+### Features
+
+* refactor snapshot builder to handlebars snapshot ([bc6d079](https://github.com/klueless-io/handlebarsjs/commit/bc6d079d12b87f0198ae2a32c94c6349929c8c70))
+
 # [0.2.0](https://github.com/klueless-io/handlebarsjs/compare/v0.1.2...v0.2.0) (2022-07-02)
 
 

data/lib/handlebarsjs/base_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Handlebarsjs
+  # Extend base helper for each of your custom handlebars-helpers
+  class BaseHelper
+    # All child classes will generally implement this method
+    def parse(value)
+      value
+    end
+
+    # If you need to wrap the return value in a specific
+    # Handlebars Type, eg. SafeString, then you can override this method
+    def wrapper(value)
+      value
+    end
+
+    # Wrap the parse method in a handlebars context aware block
+    # and return as a lambda/proc so that it is available to the
+    # Handlebars template engine
+    def to_proc
+      ->(value, _opts) { wrapper(parse(value)) }
+    end
+  end
+end

data/lib/handlebarsjs/handlebars_snapshot.rb

@@ -22,11 +22,14 @@ module Handlebarsjs
       add_script(name, 'snippet', script: script, path: path)
     end
 
-    def add_helper(name, callback)
-      @helpers << {
-        name: name,
-        callback: callback
-      }
+    def add_helper(name, helper)
+      callback = nil
+      callback = helper if helper.is_a?(Proc)
+      callback = helper.to_proc if callback.nil? && helper.respond_to?(:to_proc)
+
+      raise Handlebarsjs::Error, 'helper must be a callback or implement to_proc method' if callback.nil?
+
+      add_helper_callback(name, callback)
     end
 
     def register_helper(name)
@@ -41,6 +44,20 @@ module Handlebarsjs
       @snapshot ||= MiniRacer::Snapshot.new(script)
     end
 
+    # rubocop:disable Style/DocumentDynamicEvalDefinition
+    def new_context
+      context = MiniRacer::Context.new(snapshot: snapshot)
+
+      helpers.each do |helper|
+        context.attach("ruby_#{helper[:name]}", helper[:callback])
+        context.eval("Handlebars.registerHelper('#{helper[:name]}', ruby_#{helper[:name]})")
+      end
+
+      context
+    end
+    # rubocop:enable Style/DocumentDynamicEvalDefinition
+
+    # not currently used
     def dirty?
       @snapshot.nil?
     end
@@ -59,6 +76,13 @@ module Handlebarsjs
       add_script_item(name, type, script, path)
     end
 
+    def add_helper_callback(name, callback)
+      @helpers << {
+        name: name,
+        callback: callback
+      }
+    end
+
     def add_script_item(name, type, script, path = nil)
       @snapshot = nil
       scripts << {

data/lib/handlebarsjs/javascript.rb

@@ -25,7 +25,7 @@ module Handlebarsjs
 
     def context
       puts 'Snapshot and context are out of date, calls to snapshot should happen before any calls to context' if !@context.nil? && handlebars_snapshot.dirty?
-      @context ||= MiniRacer::Context.new(snapshot: handlebars_snapshot.snapshot)
+      @context ||= handlebars_snapshot.new_context
     end
   end
 end

data/lib/handlebarsjs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Handlebarsjs
-  VERSION = '0.3.0'
+  VERSION = '0.5.1'
 end

data/lib/handlebarsjs.rb

@@ -5,6 +5,7 @@ require_relative 'handlebarsjs/version'
 require_relative 'handlebarsjs/javascript'
 require_relative 'handlebarsjs/handlebars_snapshot'
 require_relative 'handlebarsjs/handlebars'
+require_relative 'handlebarsjs/base_helper'
 
 module Handlebarsjs
   HANDLEBARS_LIBRARY_PATH = 'lib/handlebarsjs/javascript/handlebars-4.7.7.js'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "handlebarsjs",
-  "version": "0.3.0",
+  "version": "0.5.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "handlebarsjs",
-      "version": "0.3.0",
+      "version": "0.5.1",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "handlebarsjs",
-  "version": "0.3.0",
+  "version": "0.5.1",
   "description": "handlebarsjs GEM wraps the handlebars.js library and provides ruby/javascript interoperability",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handlebarsjs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - David Cruwys
@@ -71,9 +71,9 @@ files:
 - docs/project-plan/project_in_progress.svg
 - lib/handlebarsjs.rb
 - lib/handlebarsjs/api.rb
+- lib/handlebarsjs/base_helper.rb
 - lib/handlebarsjs/handlebars.rb
 - lib/handlebarsjs/handlebars_snapshot.rb
-- lib/handlebarsjs/helpers/comparison/and.rb
 - lib/handlebarsjs/javascript.rb
 - lib/handlebarsjs/javascript/handlebars-4.7.7.js
 - lib/handlebarsjs/javascript/handlebars-api.js

data/lib/handlebarsjs/helpers/comparison/and.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# reference: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb
-# require 'active_support/core_ext/string'
-
-# require 'handlebars/helpers/base_helper'
-
-module Handlebarsjs
-  module Helpers
-    # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
-    module Comparison
-      # And: Block helper that renders a block if **all of** the given values are truthy. If an inverse block is specified it will be rendered when falsy.
-      # < Handlebars::Helpers::BaseHelper
-      class And
-        # Parse will And: Block helper that renders a block if **all of** the given values are truthy. If an inverse block is specified it will be rendered when falsy.
-        #
-        # @example
-        #
-        # {{#if (and p1 p2 p3 p4 p5)}}
-        #   found
-        # {{/if}}
-        #
-        # @example
-        #
-        # @example
-        # {{#if (and name age)}}
-        #   {{name}}-{{age}}
-        # {{else}}
-        #   no name or age
-        # {{/if}}
-        #
-        # @param values list of values (via *splat) to be checked via AND condition
-        # @return [String] return block when every value is truthy
-        def parse(values)
-          values.all? { |value| value }
-        end
-
-        def handlebars_helper
-          # Exclude last paramater which is the context V8::Object
-          proc { |_context, *values| wrapper(parse(values[0..-2])) }
-        end
-      end
-    end
-  end
-end