handlebarsjs 0.13.1 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fb064cdd88b0ac385ee41a742f7f7e9d41f4c606fc83ea242aa92d96586382a
-  data.tar.gz: 9a8746e4dc62d26e166dda98c30123693345c55b27942c252ade1bcb3ee4cfcd
+  metadata.gz: 13125c6510ce6aa93cceea51bbc11800d005380782f8ae8e88dfc23af8eedcb3
+  data.tar.gz: 22d64cf7ef7a4d64ba4bc0ace93c675b4d354d93d98cdc1556e12da7ed1d63c9
 SHA512:
-  metadata.gz: 40c760f07ad899aa8b9b4427b101faf5e97ddfb92daac0fb71d72de5f206f988c7724349db43586fc7157e685ea83d264232ce36218581422065050e6a50f539
-  data.tar.gz: 9d52c07d1e63307dd33c565bba8f29ce8aadb55954f1a33840cec05967bcf71eb0bb49eca4d17b57953923ee4a9c0692992bc6c4fc25ee6ca6cffec2eb654914
+  metadata.gz: 1d7216230be7a97dc78f9eb95cb8d7259750ad715c8b8c0733e7d7406d0b4017c4d850e2a64b08f78056a98c0bad8669af12950ff3fc48ffc2634b098b5da3d7
+  data.tar.gz: 2d8a220a507a9e264aa7641fcf15faacaf111428f2f3d3276b9ae17175d8fbf213dd9593f7cbb478dc0e8112578e03be0441e970a0f8f9fcac901549b3c514b4

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.14.0](https://github.com/klueless-io/handlebarsjs/compare/v0.13.1...v0.14.0) (2024-10-14)
+
+
+### Features
+
+* update usage documentation ([934f252](https://github.com/klueless-io/handlebarsjs/commit/934f252e8ed3816f2d5d20272d42ea338486fbc1))
+
+## [0.13.1](https://github.com/klueless-io/handlebarsjs/compare/v0.13.0...v0.13.1) (2023-10-17)
+
+
+### Bug Fixes
+
+* update to use cmdlet 13.1 which fixes activesupport issue in 7.1.1 ([c5e438f](https://github.com/klueless-io/handlebarsjs/commit/c5e438f4e2d1727037694cae3f6bc8034bc5d4fe))
+
 # [0.13.0](https://github.com/klueless-io/handlebarsjs/compare/v0.12.0...v0.13.0) (2023-07-19)
 
 

data/README.md

@@ -33,7 +33,7 @@ See [project plan](./docs/project-plan.md)
 
 ## Usage
 
-See all [usage examples](./USAGE.md)
+See all [usage examples](./docs/ussage.md)
 
 
 

data/docs/usage.md

@@ -0,0 +1,384 @@
+# Handlebars and Ruby Helper Documentation Guide
+
+## Table of Contents
+1. [Introduction](#introduction)
+2. [Installation](#installation)
+3. [Configuration](#configuration)
+4. [Available Helpers](#available-helpers)
+   - [String Helpers](#string-helpers)
+   - [Array Helpers](#array-helpers)
+   - [Comparison Helpers](#comparison-helpers)
+   - [Inflection Helpers](#inflection-helpers)
+   - [Case Helpers](#case-helpers)
+   - [Miscellaneous Helpers](#miscellaneous-helpers)
+5. [Advanced Usage](#advanced-usage)
+6. [Troubleshooting](#troubleshooting)
+7. [Contributing](#contributing)
+
+## Introduction
+This guide provides an overview of the available helpers that can be used with Handlebars templates in combination with Ruby backends. These helpers simplify common operations like string transformations, array manipulations, and comparison logic to streamline template creation and data formatting.
+
+## Installation
+To use the helpers in your project, add the relevant gem to your `Gemfile` and install it:
+
+```ruby
+# Add this line to your Gemfile
+gem 'handlebarsjs'
+
+# Run bundle install to install the gem
+bundle install
+```
+
+## Configuration
+You can customize the helpers using a configuration block. Below is an example showing how to configure some settings for your helpers in Ruby:
+
+```ruby
+Handlebars.configure do |config|
+  config.helper_prefix = 'custom'
+  config.auto_escape = true
+  # Add other configuration options as needed
+end
+```
+
+To extend the configuration, you can also register the `HandlebarsConfigurationExtension`:
+
+```ruby
+KConfig::Configuration.register(:handlebars, Handlebarsjs::HandlebarsConfigurationExtension)
+```
+
+The `HandlebarsConfigurationDefaults` can be used to preload default helpers for each category:
+
+```ruby
+Handlebarsjs::HandlebarsConfigurationDefaults.new.add_all_defaults
+```
+
+This allows you to pre-configure helpers for arrays, strings, cases, comparisons, and other categories, providing a streamlined setup process for using helpers effectively.
+
+## Available Helpers
+
+### Miscellaneous Helpers
+
+#### Safe
+The `safe` helper allows you to output HTML or other special characters without escaping them. This is particularly useful when you want to retain tags or special symbols in your output.
+
+Usage:
+
+```handlebars
+{{safe value}}
+```
+
+**Example:**
+
+- Input: `<hello name="world" />`
+- Output: `<hello name="world" />`
+
+#### FormatJson
+The `format_json` helper is used to format a given value into pretty JSON, which is especially helpful for rendering JSON objects in a human-readable way.
+
+Usage:
+
+```handlebars
+{{format_json value}}
+```
+
+**Example:**
+
+- Input: `"<hello>World</hello>"`
+- Output: `"&quot;&lt;hello&gt;World&lt;/hello&gt;&quot;"`
+
+### Array Helpers
+
+#### JoinPost
+The `join_post` helper joins an array of elements into a single string with a separator, adding the separator at the end of the string.
+
+Usage:
+
+```handlebars
+{{join_post values}}
+```
+
+**Example:**
+
+- Input: `[1, 2, 3]`
+- Default Separator Output: `1,2,3,`
+- Custom Separator: `{{join_post values "|"}}` results in `1|2|3|`
+
+#### Join
+The `join` helper joins an array of elements into a single string with a separator.
+
+Usage:
+
+```handlebars
+{{join values}}
+```
+
+**Example:**
+
+- Input: `[1, 2, 3]`
+- Default Separator Output: `1,2,3`
+- Custom Separator: `{{join values "|"}}` results in `1|2|3`
+
+#### JoinPre
+The `join_pre` helper joins an array of elements into a single string with a separator, adding the separator at the beginning of the string.
+
+Usage:
+
+```handlebars
+{{join_pre values}}
+```
+
+**Example:**
+
+- Input: `[1, 2, 3]`
+- Default Separator Output: `,1,2,3`
+- Custom Separator: `{{join_pre values "|"}}` results in `|1|2|3`
+
+### Inflection Helpers
+
+#### Ordinal
+The `ordinal` helper adds the appropriate suffix to a number to denote its position in an ordered sequence.
+
+Usage:
+
+```handlebars
+{{ordinal value}}
+```
+
+**Example:**
+
+- Input: `1`
+- Output: `st`
+
+- Input: `2`
+- Output: `nd`
+
+#### Ordinalize
+The `ordinalize` helper converts a number to its ordinal representation.
+
+Usage:
+
+```handlebars
+{{ordinalize value}}
+```
+
+**Example:**
+
+- Input: `1`
+- Output: `1st`
+
+- Input: `2`
+- Output: `2nd`
+
+#### Singularize
+The `singularize` helper converts a word to its singular form.
+
+Usage:
+
+```handlebars
+{{singularize value}}
+```
+
+**Example:**
+
+- Input: `octopi`
+- Output: `octopus`
+
+#### Pluralize
+The `pluralize` helper converts a word to its plural form.
+
+Usage:
+
+```handlebars
+{{pluralize value}}
+```
+
+**Example:**
+
+- Input: `octopus`
+- Output: `octopi`
+
+### Case Helpers
+
+#### Lower
+The `lower` helper converts all characters in a string to lowercase.
+
+Usage:
+
+```handlebars
+{{lower value}}
+```
+
+**Example:**
+
+- Input: `THE quick BROWN fox`
+- Output: `the quick brown fox`
+
+#### Slash
+The `slash` helper converts spaces in a string to forward slashes.
+
+Usage:
+
+```handlebars
+{{slash value}}
+```
+
+**Example:**
+
+- Input: `the quick brown fox`
+- Output: `the/quick/brown/fox`
+
+#### Lamel
+The `lamel` helper converts a string to lower camel case.
+
+Usage:
+
+```handlebars
+{{lamel value}}
+```
+
+**Example:**
+
+- Input: `the quick brown fox`
+- Output: `theQuickBrownFox`
+
+### Comparison Helpers
+
+#### Lte
+The `lte` helper checks if one value is less than or equal to another.
+
+Usage:
+
+```handlebars
+{{#if (lte lhs rhs)}} ... {{/if}}
+```
+
+**Example:**
+
+- Input: `1 <= 2`
+- Output: `true`
+
+#### Eq
+The `eq` helper checks if two values are equal.
+
+Usage:
+
+```handlebars
+{{#if (eq lhs rhs)}} ... {{/if}}
+```
+
+**Example:**
+
+- Input: `'aaa' == 'aaa'`
+- Output: `true`
+
+### String Helpers
+
+#### Padl
+The `padl` helper adds padding to the left side of a string.
+
+Usage:
+
+```handlebars
+{{padl value count char}}
+```
+
+**Example:**
+
+- Input: `pad-me` with padding count of `10` and character `-`
+- Output: `----pad-me`
+
+#### Padr
+The `padr` helper adds padding to the right side of a string.
+
+Usage:
+
+```handlebars
+{{padr value count char}}
+```
+
+**Example:**
+
+- Input: `pad-me` with padding count of `10` and character `-`
+- Output: `pad-me----`
+
+## Advanced Usage
+For more advanced usage, such as creating custom helpers or extending functionality, you can use the `register_helper` method. Here’s an example to create a custom helper that returns the current date:
+
+```ruby
+handlebars.register_helper(:current_date) do |context|
+  Time.now.strftime("%Y-%m-%d")
+end
+```
+
+In Handlebars template:
+
+```handlebars
+<p>Today's Date: {{current_date}}</p>
+```
+
+## Troubleshooting
+If helpers are not behaving as expected, consider the following tips:
+
+- Ensure that all helpers are registered before compiling the template.
+- Verify the input data format matches the expected type for each helper.
+- Check for typos in the helper names used in the templates.
+
+## Contributing
+We welcome contributions to enhance the available helpers and documentation. Feel free to fork the repository and submit pull requests. Make sure to follow our contribution guidelines available in `CONTRIBUTING.md`.
+
+For any questions or issues, please create an issue on GitHub.
+
+## File Structure
+
+### lib
+
+#### handlebarsjs
+
+##### helpers
+
+###### misc
+- format_json.rb
+- safe.rb
+
+###### array
+- join_pre.rb
+- join.rb
+- join_post.rb
+
+###### inflection
+- singularize.rb
+- pluralize.rb
+- pluralize_number_word.rb
+- ordinal.rb
+- pluralize_number.rb
+- ordinalize.rb
+
+###### case
+- camel.rb
+- title.rb
+- back_slash.rb
+- dot.rb
+- constant.rb
+- lower.rb
+- snake.rb
+- dash.rb
+- human.rb
+- upper.rb
+- lamel.rb
+- slash.rb
+- double_colon.rb
+
+###### comparison
+- and.rb
+- default.rb
+- lt.rb
+- gte.rb
+- eq.rb
+- gt.rb
+- or.rb
+- ne.rb
+- lte.rb
+
+###### str
+- padl.rb
+- padr.rb

data/lib/handlebarsjs/version.rb

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

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "handlebarsjs",
-  "version": "0.13.1",
+  "version": "0.14.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "handlebarsjs",
-      "version": "0.13.1",
+      "version": "0.14.1",
       "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.13.1",
+  "version": "0.14.1",
   "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.13.1
+  version: 0.14.1
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdlet
@@ -88,6 +88,7 @@ files:
 - docs/domain_model_custom.drawio
 - docs/project-plan/project.drawio
 - docs/project-plan/project_in_progress.svg
+- docs/usage.md
 - lib/_.rb
 - lib/handlebarsjs.rb
 - lib/handlebarsjs/base_helper.rb