handlebarsjs 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8048e42043ef2254d3c7e271e3469f6609b19ad08c9e92cf39ac5c1419b457c6
-  data.tar.gz: 51e120956c3b647d250e0ec49a2d2ef6eb6591cdcc98c526cbf33a40726f034f
+  metadata.gz: dc03074aedaca262df64a9aeb596c892c7e77f48ead79724cda8bb85d4d0aeb9
+  data.tar.gz: 5674236c6816c6f6ce4e51c1d13f5ad5ebb097f627cb1e7c5ea6ecf1b423b780
 SHA512:
-  metadata.gz: 36ebcfef4508ed601fa5297970b7dadc17daa18da2cd65ab1345c742e0367138ccdf11d48e759efec54aad93733fba3d1564b05f451ba8536b928a428b52af52
-  data.tar.gz: 315e2de217dc22e97b6bff861ddb255ec75dfde16d76627250f01677b6e471e562b76a9be9f310dab2e90162c6c2404753ee7f97e54eec0ecd445cb1bc614596
+  metadata.gz: 0eceb601e4df54be59f5736b2f16098b9ad7b61ddc918b6f0a07593ba1373d490f312e8be92d5aa85deeac751e66ad0704edce890813506eae0bb30933a5d80f
+  data.tar.gz: e3fba2540c9dd5cabcf17b8b525e2cddd8d360a003ade9e2a578950cae139488df41fb350c771491c55f6365339de6ab26db81660ad2d137e2625745c348113a

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# [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)
+
+
+### Bug Fixes
+
+* add snapshot builder ([f4dd8e8](https://github.com/klueless-io/handlebarsjs/commit/f4dd8e8e6a1c40da3e232bce93a33f252cc02a08))
+* add snapshot builder ([c1e31c7](https://github.com/klueless-io/handlebarsjs/commit/c1e31c7e0f4402873fcbd1c3b065564bcb9457a4))
+
 ## [0.1.1](https://github.com/klueless-io/handlebarsjs/compare/v0.1.0...v0.1.1) (2022-04-17)
 
 

data/lib/handlebarsjs/handlebars.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
 module Handlebarsjs
-  class Handlebars
-    #   @helpers = {}
-    #   @partials = {}
-    #   @partial_missing = nil
-    #   @precompile = nil
-    #   @template_cache = {}
+  # API for interacting with Handlebars.js while providing native Ruby helpers
+  class Handlebars < Handlebarsjs::Javascript
+    def initialize
+      super
+      # Handlebars 4.7.7
+      handlebars_snapshot.add_library('handlebars', path: Handlebarsjs::HANDLEBARS_LIBRARY_PATH)
 
-    attr_reader :snapshot
+      # Support functions for working with
+      handlebars_snapshot.add_library('handlebars-api', path: Handlebarsjs::HANDLEBARS_API_PATH)
+    end
 
-    # def initialize
+    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
 end

data/lib/handlebarsjs/handlebars_snapshot.rb

@@ -0,0 +1,86 @@
+# 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, callback)
+      @helpers << {
+        name: name,
+        callback: 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_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

@@ -1,11 +1,11 @@
-// Is this name ok? would compile_and_process_template be better?
-// Also, should this be at the top level namespace? 
-
-function compile_template(template) {
-  return Handlebars.compile(template);
-}
+// This function will be needed in future when I can figure out how to cache templates.
+// function compile_template(template) {
+//   return Handlebars.compile(template);
+// }
 
+// 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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Handlebarsjs
+  # API for interacting with Javascript while providing native Ruby helpers
+  class Javascript
+    attr_reader :handlebars_snapshot
+
+    def initialize
+      @handlebars_snapshot = HandlebarsSnapshot.new
+    end
+
+    def eval(script)
+      context.eval(script)
+    end
+
+    def attach(script, block)
+      context.attach(script, block)
+    end
+
+    def call(function_name, *arguments)
+      context.call(function_name, *arguments)
+    end
+
+    private
+
+    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 ||= handlebars_snapshot.new_context
+    end
+  end
+end

data/lib/handlebarsjs/version.rb

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

data/lib/handlebarsjs.rb

@@ -2,11 +2,13 @@
 
 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'
 
 module Handlebarsjs
-  JAVASCRIPT_PATH = 'lib/handlebarsjs/javascript/handlebars-4.7.7.js'
+  HANDLEBARS_LIBRARY_PATH = 'lib/handlebarsjs/javascript/handlebars-4.7.7.js'
+  HANDLEBARS_API_PATH = 'lib/handlebarsjs/javascript/handlebars-api.js'
 
   # raise Handlebarsjs::Error, 'Sample message'
   Error = Class.new(StandardError)

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "handlebarsjs",
-  "version": "0.1.2",
+  "version": "0.4.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "handlebarsjs",
-      "version": "0.1.2",
+      "version": "0.4.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.1.2",
+  "version": "0.4.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.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_log
@@ -72,11 +72,12 @@ files:
 - lib/handlebarsjs.rb
 - lib/handlebarsjs/api.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
 - lib/handlebarsjs/javascript/handlebars-helpers.js
-- lib/handlebarsjs/snapshot_builder.rb
 - lib/handlebarsjs/version.rb
 - package-lock.json
 - package.json

data/lib/handlebarsjs/snapshot_builder.rb

@@ -1,51 +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_handlebars_js
-      add_script('handlebars', 'library', path: Handlebarsjs::JAVASCRIPT_PATH)
-    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
-      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)
-      scripts << {
-        name: name,
-        type: type,
-        script: script,
-        path: path
-      }
-    end
-  end
-end