handlebarsjs 0.6.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83ccfdd308c499bfbbb4127a52fa9af19aa1f1cc8d7326b371c16da0f0e45400
-  data.tar.gz: 60eea0159f3065bf24798a096298706a13d568fe5417690c1edb46ecedaa4ee5
+  metadata.gz: 58a93fc0ff8ee926166b36c99e17e122d5a021a47baeb8333723d92a14afdbf8
+  data.tar.gz: 5f63d1066db8a9d0163b46b43a54ac59536d3e06e2bd2297cf53291c01d69a1b
 SHA512:
-  metadata.gz: bcee4752350cb7d5e2ee11c8ef0a7ca373589b60d9252497e125a815d234582585e0b94be3868505a6aca7bf60c25de6c1b8e98ff0a371c0cd744772c39edaa5
-  data.tar.gz: 17ffdd8d6c166a37fcd714c72eec08ca181a76aa2c8e7151d97a07b5feec9c3ef749632a3817b889dfd3366ad65a0156c44fcc178ff8193fc5afd78048aa9521
+  metadata.gz: 32659c1788e4a22ce665315bfcf893333d3fa07510eda438d8bba3c007acf3501ab08dfe73d153517c2e2515b5eefa398a16551d5eccc60e69654a970c7d0951
+  data.tar.gz: 8ffda416eda0a82362b6cac19ca52a2260aa768d62bb9926b8ca0abd54d81e42acf18b6780a122141abd0c68a1559e770d3e558b7c89ab8c2025ea0464a50d7f

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [0.8.0](https://github.com/klueless-io/handlebarsjs/compare/v0.7.0...v0.8.0) (2022-07-16)
+
+
+### Bug Fixes
+
+* test gha tests ([d4d8c9c](https://github.com/klueless-io/handlebarsjs/commit/d4d8c9c6802fc9ea2543f72a22718dac4b424b90))
+* test gha tests ([d3284d8](https://github.com/klueless-io/handlebarsjs/commit/d3284d8d0049a38c0aa9f72adde07d2d8c4b8229))
+
+
+### Features
+
+* add safe support ([83a81c7](https://github.com/klueless-io/handlebarsjs/commit/83a81c751e3acb69a9befb88b86122fcf1a20abc))
+* add safe support ([c458f6d](https://github.com/klueless-io/handlebarsjs/commit/c458f6d3e1d0101840af6898ea3067ad828fb5fb))
+
+# [0.7.0](https://github.com/klueless-io/handlebarsjs/compare/v0.6.3...v0.7.0) (2022-07-15)
+
+
+### Features
+
+* add alias support ([ae81c61](https://github.com/klueless-io/handlebarsjs/commit/ae81c61d569dd44e9ae50832f69a0f29d30e9523))
+
+## [0.6.3](https://github.com/klueless-io/handlebarsjs/compare/v0.6.2...v0.6.3) (2022-07-14)
+
+
+### Bug Fixes
+
+* add_all_defaults to configuration ([5755639](https://github.com/klueless-io/handlebarsjs/commit/575563988b17eb17807ce7b7b2ca76e06eba796d))
+
 ## [0.6.2](https://github.com/klueless-io/handlebarsjs/compare/v0.6.1...v0.6.2) (2022-07-13)
 
 

data/lib/_.rb

@@ -31,3 +31,4 @@ require_relative 'handlebarsjs/helpers/inflection/pluralize'
 require_relative 'handlebarsjs/helpers/inflection/pluralize_number'
 require_relative 'handlebarsjs/helpers/inflection/pluralize_number_word'
 require_relative 'handlebarsjs/helpers/inflection/singularize'
+require_relative 'handlebarsjs/helpers/misc/safe'

data/lib/handlebarsjs/base_helper.rb

@@ -4,20 +4,27 @@ module Handlebarsjs
   # Extend base helper for each of your custom handlebars-helpers
   class BaseHelper
     attr_reader :cmdlet
+    attr_reader :safe
+    attr_reader :parameter_names
 
     # Preferred way to register the internal command is via register_cmdlet
     # but you can also register the command directly in the initializer and
     # that can be handy if you use a custom configured cmdlet
-    def initialize(cmdlet = nil)
-      @cmdlet = cmdlet
-      @cmdlet = self.class.cmdlet.new if @cmdlet.nil? && self.class.cmdlet
+    def initialize(cmdlet = nil, safe: nil, parameter_names: nil)
+      initialize_cmdlet(cmdlet)
+      initialize_safe(safe)
+      initialize_parameter_names(parameter_names)
     end
 
     class << self
       attr_reader :cmdlet
+      attr_reader :safe
+      attr_reader :parameter_names
 
-      def register_cmdlet(cmdlet)
+      def register_cmdlet(cmdlet, safe: false, parameter_names: [])
         @cmdlet = cmdlet
+        @safe = safe
+        @parameter_names = parameter_names
       end
     end
 
@@ -33,5 +40,24 @@ module Handlebarsjs
     def to_proc
       ->(value, _opts) { wrapper(cmdlet.call(value)) }
     end
+
+    private
+
+    def initialize_cmdlet(cmdlet)
+      @cmdlet = cmdlet
+      @cmdlet = self.class.cmdlet.new if @cmdlet.nil? && self.class.cmdlet
+    end
+
+    def initialize_safe(safe)
+      @safe = safe
+      @safe = self.class.safe if @safe.nil? && self.class.safe
+      @safe = false if @safe.nil?
+    end
+
+    def initialize_parameter_names(parameter_names)
+      @parameter_names = parameter_names
+      @parameter_names = self.class.parameter_names if parameter_names.nil? && self.class.parameter_names
+      @parameter_names = [] if @parameter_names.nil?
+    end
   end
 end

data/lib/handlebarsjs/handlebars.rb

@@ -10,6 +10,24 @@ module Handlebarsjs
       add_configured_helpers
     end
 
+    class << self
+      def register_helper_script(name)
+        <<-JAVASCRIPT
+          Handlebars.registerHelper('#{name}', ruby_#{name})
+        JAVASCRIPT
+      end
+
+      def register_safe_string_helper_script(name, parameter_names)
+        parameters = (parameter_names + ['_opts']).join(', ')
+
+        <<-JAVASCRIPT
+          Handlebars.registerHelper('#{name}', function (#{parameters}) {
+            return new Handlebars.SafeString(ruby_#{name}(#{parameters}));
+          })
+        JAVASCRIPT
+      end
+    end
+
     def process_template(template, options = {})
       # TODO: process template function may be improved with some type of caching
       context.call('process_template', template, options)

data/lib/handlebarsjs/handlebars_configuration.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 module Handlebarsjs
-  # handlebars.handlebars_snapshot.add_helper(helper_name, helper)
-  # Structure for storing Cmdlet configuration
+  # Configuration data such has helpers for handlebarsjs
   class HandlebarsConfiguration
     include KLog::Logging
 
@@ -16,8 +15,13 @@ module Handlebarsjs
 
     HelperConfig = Struct.new(:name, :helper)
 
-    def helper(name, helper)
-      @helpers << HelperConfig.new(name, helper)
+    def helper(name, helper, aliases: [])
+      names = [name.to_sym]
+      names = (names + aliases.map(&:to_sym)).uniq
+
+      names.each do |helper_name|
+        @helpers << HelperConfig.new(helper_name, helper)
+      end
     end
   end
 end

data/lib/handlebarsjs/handlebars_configuration_defaults.rb

@@ -8,31 +8,32 @@ module Handlebarsjs
       add_case_defaults
       add_comparison_defaults
       add_inflection_defaults
+      add_misc_defaults
     end
 
     def add_array_defaults
       KConfig.configure do |config|
         config.handlebars.helper(:join, Handlebarsjs::Helpers::Array::Join.new)
-        config.handlebars.helper(:join_pre, Handlebarsjs::Helpers::Array::JoinPre.new)
         config.handlebars.helper(:join_post, Handlebarsjs::Helpers::Array::JoinPost.new)
+        config.handlebars.helper(:join_pre, Handlebarsjs::Helpers::Array::JoinPre.new)
       end
     end
 
     def add_case_defaults
       KConfig.configure do |config|
-        config.handlebars.helper(:back_slash, Handlebarsjs::Helpers::Case::BackSlash.new)
-        config.handlebars.helper(:camel, Handlebarsjs::Helpers::Case::Camel.new)
-        config.handlebars.helper(:constant, Handlebarsjs::Helpers::Case::Constant.new)
-        config.handlebars.helper(:dash, Handlebarsjs::Helpers::Case::Dash.new)
-        config.handlebars.helper(:dot, Handlebarsjs::Helpers::Case::Dot.new)
+        config.handlebars.helper(:back_slash, Handlebarsjs::Helpers::Case::BackSlash.new, aliases: %i[backward_slash slash_backward])
+        config.handlebars.helper(:camel, Handlebarsjs::Helpers::Case::Camel.new, aliases: %i[camel_upper camelUpper camelU pascalcase])
+        config.handlebars.helper(:constant, Handlebarsjs::Helpers::Case::Constant.new, aliases: %i[constantize])
+        config.handlebars.helper(:dash, Handlebarsjs::Helpers::Case::Dash.new, aliases: %i[dasherize dashify dashcase hyphenate])
+        config.handlebars.helper(:dot, Handlebarsjs::Helpers::Case::Dot.new, aliases: %i[dotirize dotify dotcase hyphenate])
         config.handlebars.helper(:double_colon, Handlebarsjs::Helpers::Case::DoubleColon.new)
-        config.handlebars.helper(:human, Handlebarsjs::Helpers::Case::Human.new)
-        config.handlebars.helper(:lamel, Handlebarsjs::Helpers::Case::Lamel.new)
-        config.handlebars.helper(:lower, Handlebarsjs::Helpers::Case::Lower.new)
-        config.handlebars.helper(:slash, Handlebarsjs::Helpers::Case::Slash.new)
+        config.handlebars.helper(:human, Handlebarsjs::Helpers::Case::Human.new, aliases: %i[humanize sentence])
+        config.handlebars.helper(:lamel, Handlebarsjs::Helpers::Case::Lamel.new, aliases: %i[camel_lower camelLower camelL])
+        config.handlebars.helper(:lower, Handlebarsjs::Helpers::Case::Lower.new, aliases: %i[lowercase downcase])
+        config.handlebars.helper(:slash, Handlebarsjs::Helpers::Case::Slash.new, aliases: %i[forward_slash slash_forward])
         config.handlebars.helper(:snake, Handlebarsjs::Helpers::Case::Snake.new)
-        config.handlebars.helper(:title, Handlebarsjs::Helpers::Case::Title.new)
-        config.handlebars.helper(:upper, Handlebarsjs::Helpers::Case::Upper.new)
+        config.handlebars.helper(:title, Handlebarsjs::Helpers::Case::Title.new, aliases: %i[titleize])
+        config.handlebars.helper(:upper, Handlebarsjs::Helpers::Case::Upper.new, aliases: %i[upcase uppercase])
       end
     end
 
@@ -60,5 +61,11 @@ module Handlebarsjs
         config.handlebars.helper(:singularize, Handlebarsjs::Helpers::Inflection::Singularize.new)
       end
     end
+
+    def add_misc_defaults
+      KConfig.configure do |config|
+        config.handlebars.helper(:safe, Handlebarsjs::Helpers::Misc::Safe.new)
+      end
+    end
   end
 end

data/lib/handlebarsjs/handlebars_snapshot.rb

@@ -25,10 +25,23 @@ module Handlebarsjs
     end
 
     def add_helper(name, helper)
-      return add_helper_entry(name, callback: helper) if helper.is_a?(Proc)
-      return add_helper_entry(name, helper: helper, callback: helper.to_proc) if helper.respond_to?(:to_proc)
+      add_helper_entry(
+        name: name,
+        helper: helper,
+        callback: helper.to_proc,
+        safe: helper.safe,
+        parameters: helper.parameter_names
+      )
+    end
 
-      raise Handlebarsjs::Error, 'helper must be a callback or implement to_proc method' if callback.nil?
+    def add_callback(name, callback, safe, parameters)
+      add_helper_entry(
+        name: name,
+        helper: nil,
+        callback: callback,
+        safe: safe,
+        parameters: parameters
+      )
     end
 
     def register_helper(name)
@@ -43,18 +56,16 @@ 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]})")
+      helpers.each do |helper_entry|
+        attach_ruby(context, helper_entry)
+        eval_register_helper(context, helper_entry)
       end
 
       context
     end
-    # rubocop:enable Style/DocumentDynamicEvalDefinition
 
     # not currently used
     def dirty?
@@ -66,6 +77,19 @@ module Handlebarsjs
       log.structure(data)
     end
 
+    def debug_register_scripts
+      register_scripts = helpers.map do |helper|
+        # Handlebarsjs::Handlebars.register_safe_string_helper_script(
+        #   helper[:name]
+        # )
+        # helper[:helper].build_register_helper_script(
+        #   helper[:name],
+        #   safe: helper[:safe]
+        # )
+      end
+      puts register_scripts.join("\n")
+    end
+
     private
 
     def add_script(name, type, script: nil, path: nil)
@@ -76,12 +100,18 @@ module Handlebarsjs
       add_script_item(name, type, script, path)
     end
 
-    def add_helper_entry(name, helper: nil, callback: nil)
-      @helpers << {
-        name: name,
-        helper: helper,
-        callback: callback
+    def add_helper_entry(**args)
+      entry = {
+        name: args[:name],
+        helper: args[:helper],
+        callback: args[:callback],
+        safe: args[:safe],
+        parameters: args[:parameters]
       }
+
+      @helpers << entry
+
+      entry
     end
 
     def add_script_item(name, type, script, path = nil)
@@ -93,5 +123,29 @@ module Handlebarsjs
         path: path
       }
     end
+
+    # This context should be on handlebars, not snapshot (I THINK)
+    def attach_ruby(context, helper_entry)
+      name = helper_entry[:name]
+      callback = helper_entry[:callback]
+
+      context.attach("ruby_#{name}", callback)
+    end
+
+    def eval_register_helper(context, helper_entry)
+      script = if helper_entry[:safe]
+                 Handlebarsjs::Handlebars.register_safe_string_helper_script(helper_entry[:name], helper_entry[:parameters])
+               else
+                 Handlebarsjs::Handlebars.register_helper_script(helper_entry[:name])
+               end
+
+      context.eval(script)
+    end
+
+    def build_register_helper_script(helper_entry)
+      return Handlebarsjs::Handlebars.register_safe_string_helper_script(helper_entry[:name], helper_entry[:parameters]) if helper_entry[:safe]
+
+      Handlebarsjs::Handlebars.register_helper_script(helper_entry[:name])
+    end
   end
 end

data/lib/handlebarsjs/helpers/misc/safe.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Handlebarsjs
+  module Helpers
+    # Miscellaneous cmdlets
+    module Misc
+      # Safe: pass through the value with <> and single and double quotes left as is
+      class Safe < Handlebarsjs::BaseHelper
+        register_cmdlet(Cmdlet::Misc::Safe, safe: true, parameter_names: [:value])
+
+        def to_proc
+          ->(value, _opts) { wrapper(cmdlet.call(value)) }
+        end
+      end
+    end
+  end
+end

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

@@ -314,6 +314,23 @@ return /******/ (function(modules) { // webpackBootstrap
 	  logger: _logger2['default'],
 	  log: _logger2['default'].log,
 
+
+    // Handlebars.registerHelper('encodeMyString',function(inputData){
+    //   return new Handlebars.SafeString(inputData);
+    // });
+    // safeStringHelper: safeStringHelper(name, fn)
+
+    // How do I write a callback function to wrap a callback function in javascript
+    // registerSafeHelper: function registerSafeHelper(name, fn) {
+    //   new_function: function(fn) {
+    //     return function(context, options) {
+    //       return new Handlebars.SafeString(fn(context, options)); "<hello />"
+    //     };
+    //   }
+    //   registerHelper(name, new_function)
+    // },
+
+
 	  registerHelper: function registerHelper(name, fn) {
 	    if (_utils.toString.call(name) === objectType) {
 	      if (fn) {

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

@@ -1,3 +1,12 @@
 Handlebars.registerHelper('loud', function (input) {
   return input.toUpperCase()
-})
+})
+
+Handlebars.registerHelper('allow_html', function (some_html) {
+  return new Handlebars.SafeString(some_html);
+})
+
+// Handlebars.registerHelper('i_am_safe_xxx', function (some_html) {
+//   some_html = "doe some thing"
+//   return new Handlebars.SafeString(some_html);
+// })

data/lib/handlebarsjs/version.rb

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

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "handlebarsjs",
-  "version": "0.6.3",
+  "version": "0.9.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "handlebarsjs",
-      "version": "0.6.3",
+      "version": "0.9.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.6.3",
+  "version": "0.9.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.6.3
+  version: 0.9.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdlet
@@ -128,6 +128,7 @@ files:
 - lib/handlebarsjs/helpers/inflection/pluralize_number.rb
 - lib/handlebarsjs/helpers/inflection/pluralize_number_word.rb
 - lib/handlebarsjs/helpers/inflection/singularize.rb
+- lib/handlebarsjs/helpers/misc/safe.rb
 - lib/handlebarsjs/javascript.rb
 - lib/handlebarsjs/javascript/handlebars-4.7.7.js
 - lib/handlebarsjs/javascript/handlebars-api.js