handlebarsjs 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 596f9e558bf5308c4fe912079507eb42a0ad15647ffb298f7400487d4d545146
-  data.tar.gz: e0b7380f763e9fbb808a0246f03c2870f608a860369f621253b5789e20122d7e
+  metadata.gz: 151163c301c19424a48a278b6685d86f01c9cde58244de9343a17834d40cef3a
+  data.tar.gz: a857eea83005555d1541e623f081950e739d394a3b511de944e62dbd8d4851b9
 SHA512:
-  metadata.gz: 665d312a9a202e08085879dd57b9ed6577318de92e29f3843297ca68f4a506c203fc082ad78dbb8574f200489dba0d835c5c32ef6e66fab083d05392b3b54525
-  data.tar.gz: a3f4b97ab1ac479428bb972c7350767a74a83337da1e03e6612bda7494ed1cac9121f02d62df2de405778c9a2909c47a029309ba0fb5d905f8613eeae8f4957e
+  metadata.gz: 7b9f7e84df1bb4afe9c3a651de43f775c27a18072ce060d4045b33b2ed0704f8992491d58c87d2d7b2b9461fdbb0a78167674963e66c1b0c9d2aa3c24ea61d62
+  data.tar.gz: dd8774994fe3dd4b2093d7cdffdf6e708de847c790e9ad44420a65b3b9430dc58369e31f5efe5bb483aa6eb3e560936d26fd07aac4855ece300e0c1c60371b31

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# [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)
+
+
+### Features
+
+* add support for basic template processing ([13d9649](https://github.com/klueless-io/handlebarsjs/commit/13d9649c03fa7de0326bed71d08441453194e4e1))
+* add support for basic template processing ([64966e5](https://github.com/klueless-io/handlebarsjs/commit/64966e5ad396910dd0e7edc11a4d8427a10cae29))
+
 ## [0.1.2](https://github.com/klueless-io/handlebarsjs/compare/v0.1.1...v0.1.2) (2022-07-01)
 
 

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
+    # 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
+
+    # 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
+  end
+end

data/lib/handlebarsjs/handlebars.rb

@@ -6,13 +6,14 @@ module Handlebarsjs
     def initialize
       super
       # Handlebars 4.7.7
-      snapshot_builder.add_library('handlebars', path: Handlebarsjs::HANDLEBARS_LIBRARY_PATH)
+      handlebars_snapshot.add_library('handlebars', path: Handlebarsjs::HANDLEBARS_LIBRARY_PATH)
 
       # Support functions for working with
-      snapshot_builder.add_library('handlebars-api', path: Handlebarsjs::HANDLEBARS_API_PATH)
+      handlebars_snapshot.add_library('handlebars-api', path: Handlebarsjs::HANDLEBARS_API_PATH)
     end
 
     def process_template(template, options = {})
+      # TODO: process template function may be improved with some type of caching
       context.call('process_template', template, options)
     end
   end

data/lib/handlebarsjs/handlebars_snapshot.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Handlebarsjs
+  # Wraps MiniRacer snapshot with specific emphasis on
+  # loading Handlebars helpers onto the MiniRacer context
+  # in the correct order. So that new contexts are preloaded
+  # with the handlebars library and the configured helpers.
+  class HandlebarsSnapshot
+    attr_reader :scripts
+    attr_reader :helpers
+
+    def initialize
+      @scripts = []
+      @helpers = []
+    end
+
+    def add_library(name, script: nil, path: nil)
+      add_script(name, 'library', script: script, path: path)
+    end
+
+    def add_snippet(name, script: nil, path: nil)
+      add_script(name, 'snippet', script: script, path: path)
+    end
+
+    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)
+      add_script(name, 'helper', script: "Handlebars.registerHelper('#{name}', ruby_#{name})")
+    end
+
+    def script
+      scripts.map { |script| "// #{script[:type]} - #{script[:name]}\n#{script[:script]}" }.join("\n\n")
+    end
+
+    def snapshot
+      @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
+
+    def debug
+      puts script
+    end
+
+    private
+
+    def add_script(name, type, script: nil, path: nil)
+      raise Handlebarsjs::Error, 'script or path is required' if script.nil? && path.nil?
+      raise Handlebarsjs::Error, 'script and path are mutually exclusive' if script && path
+
+      script ||= File.read(path)
+      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 << {
+        name: name,
+        type: type,
+        script: script,
+        path: path
+      }
+    end
+  end
+end

data/lib/handlebarsjs/javascript/handlebars-api.js

@@ -5,6 +5,7 @@
 
 // This is the main function that is called by the client.
 function process_template(template, data) {
+  // The process template function may be improved with some type of caching
   const compiled_template = Handlebars.compile(template);
   return compiled_template(data);
 }

data/lib/handlebarsjs/javascript.rb

@@ -3,10 +3,10 @@
 module Handlebarsjs
   # API for interacting with Javascript while providing native Ruby helpers
   class Javascript
-    attr_reader :snapshot_builder
+    attr_reader :handlebars_snapshot
 
     def initialize
-      @snapshot_builder = SnapshotBuilder.new
+      @handlebars_snapshot = HandlebarsSnapshot.new
     end
 
     def eval(script)
@@ -24,7 +24,8 @@ module Handlebarsjs
     private
 
     def context
-      @context ||= MiniRacer::Context.new(snapshot: snapshot_builder.build)
+      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 ||= handlebars_snapshot.new_context
     end
   end
 end

data/lib/handlebarsjs/version.rb

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

data/lib/handlebarsjs.rb

@@ -2,9 +2,10 @@
 
 require 'mini_racer'
 require_relative 'handlebarsjs/version'
-require_relative 'handlebarsjs/snapshot_builder'
 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.2.0",
+  "version": "0.5.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "handlebarsjs",
-      "version": "0.2.0",
+      "version": "0.5.0",
       "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.2.0",
+  "version": "0.5.0",
   "description": "handlebarsjs GEM wraps the handlebars.js library and provides ruby/javascript interoperability",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: handlebarsjs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_log
@@ -71,13 +71,13 @@ 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/helpers/comparison/and.rb
+- lib/handlebarsjs/handlebars_snapshot.rb
 - lib/handlebarsjs/javascript.rb
 - lib/handlebarsjs/javascript/handlebars-4.7.7.js
 - lib/handlebarsjs/javascript/handlebars-api.js
 - lib/handlebarsjs/javascript/handlebars-helpers.js
-- lib/handlebarsjs/snapshot_builder.rb
 - lib/handlebarsjs/version.rb
 - package-lock.json
 - package.json

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

data/lib/handlebarsjs/snapshot_builder.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Handlebarsjs
-  # Wraps MiniRacer snapshot and provides clean API
-  class SnapshotBuilder
-    attr_reader :scripts
-
-    def initialize
-      @scripts = []
-    end
-
-    def add_library(name, script: nil, path: nil)
-      add_script(name, 'library', script: script, path: path)
-    end
-
-    def register_helper(name)
-      add_script(name, 'helper', script: "Handlebars.registerHelper('#{name}', ruby_#{name})")
-    end
-
-    def script
-      scripts.map { |script| "// #{script[:type]} - #{script[:name]}\n#{script[:script]}" }.join("\n\n")
-    end
-
-    def build
-      @build ||= MiniRacer::Snapshot.new(script)
-    end
-
-    private
-
-    def add_script(name, type, script: nil, path: nil)
-      raise Handlebarsjs::Error, 'script or path is required' if script.nil? && path.nil?
-      raise Handlebarsjs::Error, 'script and path are mutually exclusive' if script && path
-
-      script ||= File.read(path)
-      add_script_item(name, type, script, path)
-    end
-
-    def add_script_item(name, type, script, path = nil)
-      @build = nil
-      scripts << {
-        name: name,
-        type: type,
-        script: script,
-        path: path
-      }
-    end
-  end
-end