handlebarsjs 0.11.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe0631f29a42a0e8a4c4d9959602af08d654577609b16e2f936c8ef0c2802dc
-  data.tar.gz: d831c82ad243c9f8868add8442d200da0a6b761077dc088cd7a81767d75f1d12
+  metadata.gz: f82a12060506efbddff4c69305414c8ad24cbecf14a897eae1805b6ae40a7fa5
+  data.tar.gz: 7d4b3aef04fd506d04fdcee4bcdc3256b6835ac92f856a1e9644ec77ff0cf194
 SHA512:
-  metadata.gz: 50b5e5ea6b0d137d29fed2bdf32d7c2336fad811a4751ce25565672eb1ea5e3388c626470aec56e23da955adb4f80c23694cb6c47459e518fb45c10e0183cb7e
-  data.tar.gz: 5e020f311152b4a30add652bc71b817b6a01f58f373d951a208a59ce7863a475e3614f08848c4a5b431ee69ea29a42b622277d7410be379ebc68ba8ecfa90545
+  metadata.gz: ed39a269924ab2d1794104373d6dbe38fd6ced1b77a32bf1982f5e7310f7929713b6005d3940ecbf57ea89db54d1709efca994f629ccf4c01f60c7ff6e2c0e36
+  data.tar.gz: 9c05a160e762f831cd667b8c4ac14e930eed9900507f66429ff25b9b6a71f1193fea05aa49bf43c9d9b8ccf8d3ed93ce97e21d01656b70410a96c3ba8c6652e0

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [0.12.0](https://github.com/klueless-io/handlebarsjs/compare/v0.11.3...v0.12.0) (2023-07-19)
+
+
+### Features
+
+* add omit ([cd516d1](https://github.com/klueless-io/handlebarsjs/commit/cd516d11c3f4e304952d6bbbcd31140c82edf11d))
+* reset version ([dff1b8e](https://github.com/klueless-io/handlebarsjs/commit/dff1b8e710a9e433610f5a4326c8b4e9d4a927b9))
+
+## [0.11.3](https://github.com/klueless-io/handlebarsjs/compare/v0.11.2...v0.11.3) (2023-07-19)
+
+
+### Bug Fixes
+
+* remove omit config ([2e16f46](https://github.com/klueless-io/handlebarsjs/commit/2e16f46ba439606475174ec4ad96d873a5c380c6))
+
 ## [0.11.2](https://github.com/klueless-io/handlebarsjs/compare/v0.11.1...v0.11.2) (2023-07-19)
 
 

data/lib/handlebarsjs/base_helper.rb

@@ -4,6 +4,7 @@ module Handlebarsjs
   # Extend base helper for each of your custom handlebars-helpers
   class BaseHelper
     attr_reader :cmdlet
+    attr_reader :block
     attr_reader :safe
     attr_reader :parameter_names
 
@@ -13,23 +14,34 @@ module Handlebarsjs
     def initialize(cmdlet = nil, safe: nil, parameter_names: nil)
       initialize_cmdlet(cmdlet)
       initialize_safe(safe)
+      initialize_block(block)
       initialize_parameter_names(parameter_names)
     end
 
     class << self
       attr_reader :cmdlet
+      attr_reader :block
       attr_reader :safe
       attr_reader :parameter_names
 
-      def register_cmdlet(cmdlet, safe: false, parameter_names: [])
+      # Register the cmdlet to be used by the helper
+      #
+      # By default, it will register an function expression helper
+      # You can use HTML by setting safe to true
+      #
+      # @param cmdlet [Handlebarsjs::Cmdlet::Base] the cmdlet to be used by the helper
+      # @param block [Boolean] whether or not this is a wrapped block
+      # @param safe [Boolean] whether or not the cmdlet should return HTML
+      # @param parameter_names [Array] the parameter names to be used by the cmdlet
+      def register_cmdlet(cmdlet, block: false, safe: false, parameter_names: [])
         @cmdlet = cmdlet
+        @block = block
         @safe = safe
         @parameter_names = parameter_names
       end
     end
 
-    # If you need to wrap the return value in a specific
-    # Handlebars Type, eg. SafeString, then you can override this method
+    # If you need to wrap the return value then you can override this method
     def wrapper(value)
       value
     end
@@ -54,6 +66,12 @@ module Handlebarsjs
       @safe = false if @safe.nil?
     end
 
+    def initialize_block(block)
+      @block = block
+      @block = self.class.block if @block.nil? && self.class.block
+      @block = false if @block.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

data/lib/handlebarsjs/handlebars.rb

@@ -11,13 +11,29 @@ module Handlebarsjs
     end
 
     class << self
-      def register_helper_script(name)
+      def register_helper_script(name, parameter_names = [], safe: false, block: false)
+        if safe && block
+          block_helper_safe(name, parameter_names)
+        elsif safe
+          # register_safe_string_helper_script(name, parameter_names)
+          function_helper_safe(name, parameter_names)
+        elsif block
+          block_helper(name, parameter_names)
+        else
+          function_helper(name)
+        end
+      end
+
+      # In handlebars, this is a simple function expression
+      def function_helper(name)
+        # Not sure why I am not using paramater names, but currently it works for the existing use cases
         <<-JAVASCRIPT
           Handlebars.registerHelper('#{name}', ruby_#{name})
         JAVASCRIPT
       end
 
-      def register_safe_string_helper_script(name, parameter_names)
+      # In handlebars, this is also a simple function expression that returns a SafeString when HTML is desired
+      def function_helper_safe(name, parameter_names)
         parameters = (parameter_names + ['_opts']).join(', ')
 
         <<-JAVASCRIPT
@@ -26,6 +42,28 @@ module Handlebarsjs
           })
         JAVASCRIPT
       end
+
+      def block_helper(name, parameter_names)
+        parameters = (parameter_names + ['opts']).join(', ')
+        ruby_parameters = parameters.length.positive? ? ", #{parameters}" : ''
+
+        <<-JAVASCRIPT
+          Handlebars.registerHelper('#{name}', function (#{parameters}) {
+            return ruby_#{name}(opts.fn(this)#{ruby_parameters});
+          })
+        JAVASCRIPT
+      end
+
+      def block_helper_safe(name, parameter_names)
+        parameters = (parameter_names + ['opts']).join(', ')
+        ruby_parameters = parameters.length.positive? ? ", #{parameters}" : ''
+
+        <<-JAVASCRIPT
+          Handlebars.registerHelper('#{name}', function (#{parameters}) {
+            return  new Handlebars.SafeString(ruby_#{name}(opts.fn(this)#{ruby_parameters}));
+          })
+        JAVASCRIPT
+      end
     end
 
     def process_template(template, options = {})
@@ -41,11 +79,15 @@ module Handlebarsjs
 
       handlebars_lib_path = File.join(gem_path, Handlebarsjs::HANDLEBARS_LIBRARY_PATH)
       handlebars_api_path = File.join(gem_path, Handlebarsjs::HANDLEBARS_API_PATH)
+      handlebars_helpers_path = File.join(gem_path, Handlebarsjs::HANDLEBARS_HELPERS_PATH)
 
       handlebars_snapshot.add_library('handlebars', path: handlebars_lib_path)
 
-      # Support functions for working with
+      # Support my custom functions from handlebars-api
       handlebars_snapshot.add_library('handlebars-api', path: handlebars_api_path)
+
+      # I have not been able to get block helpers working through ruby and so if I just need some custom JS only helpers, such as block then this is the place to do it
+      handlebars_snapshot.add_library('handlebars-helper', path: handlebars_helpers_path)
     end
 
     def add_configured_helpers

data/lib/handlebarsjs/handlebars_configuration_defaults.rb

@@ -66,6 +66,7 @@ module Handlebarsjs
     def add_misc_defaults
       KConfig.configure do |config|
         config.handlebars.helper(:format_json, Handlebarsjs::Helpers::Misc::FormatJson.new)
+        config.handlebars.helper(:omit, Handlebarsjs::Helpers::Misc::Omit.new, aliases: %i[ignore comment_out])
         config.handlebars.helper(:safe, Handlebarsjs::Helpers::Misc::Safe.new)
       end
     end

data/lib/handlebarsjs/handlebars_snapshot.rb

@@ -139,9 +139,18 @@ module Handlebarsjs
     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]
+      # When registering a helper, set the safe flag to true when you want a HTML Safe String
+      # register_cmdlet(Cmdlet::SomeHtmlCommand, safe: true, parameter_names: %i[value])
+      name = helper_entry[:name]
+      safe = helper_entry[:safe] || false
+      block = helper_entry[:block] || false
+      parameter_names = helper_entry[:parameters] || []
+
+      Handlebarsjs::Handlebars.register_helper_script(name, parameter_names, safe: safe, block: block)
+
+      #   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])
+      #   Handlebarsjs::Handlebars.register_helper_script(helper_entry[:name])
     end
   end
 end

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

@@ -6,7 +6,7 @@ module Handlebarsjs
     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])
+        register_cmdlet(Cmdlet::Misc::Safe, safe: true, parameter_names: %i[value])
 
         def to_proc
           ->(value, _opts) { wrapper(cmdlet.call(value)) }

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

@@ -1,8 +1,14 @@
-Handlebars.registerHelper('loud', function (input) {
-  return input.toUpperCase()
-})
+// Put any custom helper that you can't get to work directly with Ruby in here.
+// Exampe: I have had a lot of trouble getting the block helpers to work with Ruby
+// Handlebars.registerHelper('loud', function (input) {
+//   return input.toUpperCase()
+// })
 
-Handlebars.registerHelper('allow_html', function (some_html) {
-  return new Handlebars.SafeString(some_html);
-})
+// Handlebars.registerHelper('allow_html', function (some_html) {
+//   return new Handlebars.SafeString(some_html);
+// })
 
+Handlebars.registerHelper('omit', function (_options) {
+  // return options.fn(this)
+  return ''
+})

data/lib/handlebarsjs/version.rb

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

data/lib/handlebarsjs.rb

@@ -16,6 +16,7 @@ require_relative '_'
 module Handlebarsjs
   HANDLEBARS_LIBRARY_PATH = 'lib/handlebarsjs/javascript/handlebars-4.7.7.js'
   HANDLEBARS_API_PATH = 'lib/handlebarsjs/javascript/handlebars-api.js'
+  HANDLEBARS_HELPERS_PATH = 'lib/handlebarsjs/javascript/handlebars-helpers.js'
 
   # raise Handlebarsjs::Error, 'Sample message'
   Error = Class.new(StandardError)

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "handlebarsjs",
-  "version": "0.11.3",
+  "version": "0.13.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "handlebarsjs",
-      "version": "0.11.3",
+      "version": "0.13.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.11.3",
+  "version": "0.13.0",
   "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.11.3
+  version: 0.13.0
 platform: ruby
 authors:
 - David Cruwys