handlebarsjs 0.7.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4962fdcc88f1a68831b1907b713aa3f8996ca23dee96da1d970545a2875c0b44
-  data.tar.gz: 3eaa1ec0405fc12467286ac2e0db49af24269f7fe589e0365ce16439b43799c3
+  metadata.gz: 32d0cd3d55545bf49ae8486479829203e3216ab77a1b86604e7c2f9f50940c34
+  data.tar.gz: e9ea077cd19602f48176d3b41bf406166fa227bef848af7d2c1bd1fcc3d14e69
 SHA512:
-  metadata.gz: a5aa1c58ae7e8de87949843cd3b6d90abcc04928c55a97181fca747b64aa7e2e53af87c16ee89c05112136dc8723b521caf1058948476ce7c38db46030d6a6b9
-  data.tar.gz: f50f5ad4daff693c4c9b0ef2f3756f2073b952165178831ac0e7361986021d0d54e100aae0647fc66aa7dd58d0173dd5639901c842349a61df5ce57025525830
+  metadata.gz: 1a4ddb649bb51fe9d4c69db398359900110875c735f1cf7f173ead88ffd6efe00242805b3fabf74d29fad824803a36840d5c22baefb0cb5b50b0b811ffb71d33
+  data.tar.gz: 25f2430f5a18232d231d7f0d38b9a10c990d2ea928b5b1a44b0d232c3b4f5638bebcda09e36a49e4be7767b1bba4d1b0e50bc7f36b261fd3ac903295ddba4cde

data/.rubocop.yml

@@ -15,7 +15,7 @@ Metrics/BlockLength:
   Exclude:
     - "**/spec/**/*"
     - "*.gemspec"
-  IgnoredMethods:
+  AllowedMethods:
     - configure
     - context
     - define

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [0.9.0](https://github.com/klueless-io/handlebarsjs/compare/v0.8.0...v0.9.0) (2022-07-16)
+
+
+### Features
+
+* add safe support ([edc7062](https://github.com/klueless-io/handlebarsjs/commit/edc70623130ca6ae397b3532e4609ffd825cd7a3))
+
+# [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)
 
 

data/lib/_.rb

@@ -31,3 +31,6 @@ 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'
+require_relative 'handlebarsjs/helpers/str/padl'
+require_relative 'handlebarsjs/helpers/str/padr'

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
 

data/lib/handlebarsjs/handlebars_configuration_defaults.rb

@@ -8,6 +8,8 @@ module Handlebarsjs
       add_case_defaults
       add_comparison_defaults
       add_inflection_defaults
+      add_misc_defaults
+      add_str_defaults
     end
 
     def add_array_defaults
@@ -31,7 +33,7 @@ module Handlebarsjs
         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(: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 +62,18 @@ 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
+
+    def add_str_defaults
+      KConfig.configure do |config|
+        config.handlebars.helper(:padl, Handlebarsjs::Helpers::Str::Padl.new)
+        config.handlebars.helper(:padr, Handlebarsjs::Helpers::Str::Padr.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/helpers/str/padl.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Handlebarsjs
+  module Helpers
+    # String manipulation
+    module Str
+      # Padl: take the value and give it padding on the left hand side
+      class Padl < Handlebarsjs::BaseHelper
+        register_cmdlet(Cmdlet::Str::Padl)
+
+        def to_proc
+          ->(value, count = nil, char = nil, _opts) { wrapper(cmdlet.call(value, count, char)) }
+        end
+      end
+    end
+  end
+end

data/lib/handlebarsjs/helpers/str/padr.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Handlebarsjs
+  module Helpers
+    # String manipulation
+    module Str
+      # Padr: take the value and give it padding on the right hand side
+      class Padr < Handlebarsjs::BaseHelper
+        register_cmdlet(Cmdlet::Str::Padr)
+
+        def to_proc
+          ->(value, count = nil, char = nil, _opts) { cmdlet.call(value, count, char) }
+        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.7.0'
+  VERSION = '0.10.0'
 end

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "handlebarsjs",
-  "version": "0.7.0",
+  "version": "0.10.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "handlebarsjs",
-      "version": "0.7.0",
+      "version": "0.10.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.7.0",
+  "version": "0.10.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.7.0
+  version: 0.10.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdlet
@@ -69,7 +69,6 @@ files:
 - ".builders/director/handlebars_helper_director.rb"
 - ".builders/generators/01-bootstrap.rb"
 - ".builders/generators/domain_model.rb"
-- ".builders/generators/helpers/comparison_helpers.rb"
 - ".builders/generators/project-plan.rb"
 - ".releaserc.json"
 - ".rspec"
@@ -128,6 +127,9 @@ 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/helpers/str/padl.rb
+- lib/handlebarsjs/helpers/str/padr.rb
 - lib/handlebarsjs/javascript.rb
 - lib/handlebarsjs/javascript/handlebars-4.7.7.js
 - lib/handlebarsjs/javascript/handlebars-api.js

data/.builders/generators/helpers/comparison_helpers.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-# base_class_require    'handlebars/helpers/comparison/base_helper'
-# base_class            'Handlebars::Helpers::Comparison::BaseHelper'
-# example_input_value   'var1 and var2'
-# example_output_value  'truthy block'
-# test_input_value      'var1 and var2'
-# test_output_value     'truthy block'
-
-KManager.action :comparison_helpers do
-  action do
-    common = OpenStruct.new(
-      category_name:          'comparison',
-      category_description:   'Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.'
-    )
-    
-    HandlebarsHelperDirector
-      .init(k_builder, on_exist: :write, on_action: :execute)
-      .helper do
-        category              common.category_name
-        category_description  common.category_description
-        name                  'and'
-        description           '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.'
-        result                "return block when every value is truthy"
-        parameter('values', 'list of values (via *splat) to be checked via AND condition', splat: true)
-
-        example <<-TEXT
-          {{#if (and p1 p2 p3 p4 p5)}}
-            found
-          {{/if}}
-        TEXT
-
-        example <<-TEXT
-          {{#if (and name age)}}
-            {{name}}-{{age}}
-          {{else}}
-            no name or age
-          {{/if}}
-        TEXT
-      end
-      .build_helpers
-      .debug
-  end
-end