trmnl-liquid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71c903fca7e32e8b95b094e74dc73fcda3321abb23304adb0ed0f2df2873a24c
+  data.tar.gz: d2da61eec30c53e924dce31ec7a8a021a531b7318738005f656f84a25568925e
+SHA512:
+  metadata.gz: c97a0eefc2eb7cfba1438b3c862bf17709ec953228ac2ba96e273b0d4298d767a358c95ad4b62a986559fb4719dc4305c3670ffcd414ae7df5d75180b0b5a19e
+  data.tar.gz: 77f741d77b3cbeeae0c20e15124b5075c2d302b208f628152bfd2fedc2b702832e42775c7c741a7ae853280d92329548725e5a988dfada2baceae7741a063b5d

data/lib/trmnl/liquid/filters.rb

@@ -0,0 +1,108 @@
+require 'action_view'
+require 'date'
+require 'redcarpet'
+require 'tzinfo'
+
+begin
+  require 'i18n'
+rescue LoadError
+  nil
+end
+
+module TRMNL
+  module Liquid
+    module Filters
+      def append_random(var)
+        "#{var}#{SecureRandom.hex(2)}"
+      end
+
+      def days_ago(num, tz = 'Etc/UTC')
+        tzinfo = TZInfo::Timezone.get(tz)
+        tzinfo.now.to_date - num.to_i
+      end
+
+      def group_by(collection, key)
+        collection.group_by { |obj| obj[key] }
+      end
+
+      def find_by(collection, key, value, fallback = nil)
+        collection.find { |obj| obj[key] == value } || fallback
+      end
+
+      def markdown_to_html(markdown)
+        markdown ||= ''
+        renderer = Redcarpet::Render::HTML.new(_render_options = {})
+        service = Redcarpet::Markdown.new(renderer, _extensions = {})
+        service.render(markdown)
+      end
+
+      def number_with_delimiter(number, delimiter = ',', separator = ',')
+        helpers.number_with_delimiter(number, delimiter: delimiter, separator: separator)
+      end
+
+      def number_to_currency(number, unit_or_locale = '$', delimiter = ',', separator = '.')
+        cur_switcher = with_i18n(:unit) do |i18n|
+          i18n.available_locales.include?(unit_or_locale.to_sym) ? :locale : :unit
+        end
+        opts = { delimiter:, separator: }.merge(cur_switcher => unit_or_locale)
+        helpers.number_to_currency(number, **opts)
+      end
+
+      def l_word(word, locale)
+        with_i18n("custom_plugins.#{word}") do |i18n|
+          i18n.t("custom_plugins.#{word}", locale: locale)
+        end
+      end
+
+      def l_date(date, format, locale = 'en')
+        with_i18n(date.to_s) do |i18n|
+          format = format.to_sym unless format.include?('%')
+          i18n.l(to_datetime(date), format: format, locale: locale)
+        end
+      end
+
+      def pluralize(singular, count)
+        helpers.pluralize(count, singular)
+      end
+
+      def json(obj)
+        JSON.generate(obj)
+      end
+
+      def sample(array) = array.sample
+
+      private
+
+      def with_i18n(fallback, &block)
+        if defined?(::I18n)
+          block.call(::I18n)
+        else
+          fallback
+        end
+      end
+
+      def to_datetime(obj)
+        case obj
+        when DateTime
+          obj
+        when Date
+          obj.to_datetime
+        when Time
+          DateTime.parse(obj.iso8601)
+        else
+          DateTime.parse(obj.to_s)
+        end
+      end
+
+      def helpers
+        @helpers ||= begin
+          mod = Module.new do
+            include ::ActionView::Helpers::NumberHelper
+            include ::ActionView::Helpers::TextHelper
+          end
+          Object.new.extend(mod)
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/liquid/template/file_system.rb

@@ -0,0 +1,23 @@
+module TRMNL
+  module Liquid
+    class Template < ::Liquid::Template
+      # This in-memory "file system" is the backing storage for custom templates defined {% template [name] %} tags.
+      class FileSystem < ::Liquid::BlankFileSystem
+        def initialize
+          super
+          @templates = {}
+        end
+
+        # called by Markup::LiquidTemplateTag to save users' custom shared templates via our custom {% template %} tag
+        def register(name, body)
+          @templates[name] = body
+        end
+
+        # called by ::Liquid::Template for {% render 'foo' %} when rendering screen markup
+        def read_template_file(name)
+          @templates[name] || raise(::Liquid::FileSystemError, "Template not found: #{name}")
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/liquid/template/template_tag.rb

@@ -0,0 +1,35 @@
+module TRMNL
+  module Liquid
+    class Template < ::Liquid::Template
+      # The {% template [name] %} tag block is used in conjunction with InlineTemplatesFileSystem to allow users to define
+      # custom templates within the context of the current Liquid template. Generally speaking, they will define their own
+      # templates in the "shared" markup content, which is prepended to the individual screen templates before rendering.
+      class TemplateTag < ::Liquid::Block
+        NAME_REGEX = %r{\A[a-zA-Z0-9_/]+\z}
+
+        def initialize(tag_name, markup, options)
+          super
+          @name = markup.strip
+        end
+
+        def parse(tokens)
+          @body = ""
+          while (token = tokens.shift)
+            break if token.strip == "{% endtemplate %}"
+
+            @body << token
+          end
+        end
+
+        def render(context)
+          unless @name =~ NAME_REGEX
+            return "Liquid error: invalid template name #{@name.inspect} - template names must contain only letters, numbers, underscores, and slashes"
+          end
+
+          context.registers[:file_system].register(@name, @body.strip)
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/liquid/template.rb

@@ -0,0 +1,21 @@
+require 'liquid'
+
+require_relative 'template/file_system'
+require_relative 'template/template_tag'
+
+module TRMNL
+  module Liquid
+    # A very thin wrapper around Liquid::Template with TRMNL-specific functionality.
+    class Template < ::Liquid::Template
+      def self.parse(*)
+        template = super
+
+        # set up a temporary in-memory file system for custom user templates, via the magic :file_system register
+        # which will override the default file system
+        template.registers[:file_system] = FileSystem.new
+
+        template
+      end
+    end
+  end
+end

data/lib/trmnl/liquid/version.rb

@@ -0,0 +1,7 @@
+
+# frozen_string_literal: true
+module TRMNL
+  module Liquid
+    VERSION = "0.1.0"
+  end
+end

data/lib/trmnl/liquid.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'trmnl/liquid/filters'
+require 'trmnl/liquid/template'
+require 'trmnl/liquid/version'
+
+begin
+  require 'trmnl/i18n'
+rescue LoadError
+  nil
+end
+
+if defined?(::TRMNL::I18n)
+  ::TRMNL::I18n.load_locales
+end
+
+if Gem.loaded_specs['rails-i18n']
+  ::I18n.load_path += Pathname.new(Gem.loaded_specs['rails-i18n'].full_gem_path).join('rails', 'locale').glob('*.yml')
+end
+
+module TRMNL
+  module Liquid
+    # empty
+  end
+end
+
+::Liquid::Template.register_filter(TRMNL::Liquid::Filters)
+::Liquid::Template.register_tag('template', TRMNL::Liquid::Template::TemplateTag)

data/trmnl-liquid.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/trmnl/liquid/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "trmnl-liquid"
+  spec.version = TRMNL::Liquid::VERSION
+  spec.authors = ["TRMNL"]
+  spec.email = ["engineering@usetrmnl.com"]
+  spec.homepage = "https://github.com/usetrmnl/trmnl-liquid"
+
+  spec.summary = "Liquid templating engine for TRMNL plugins"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/usetrmnl/trmnl-liquid/issues",
+    "changelog_uri" => "https://github.com/usetrmnl/trmnl-liquid/tags",
+    "homepage_uri" => "https://github.com/usetrmnl/trmnl-liquid",
+    "label" => "TRMNL Liquid",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/usetrmnl/trmnl-liquid"
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionview", "~> 8.0"
+  spec.add_dependency "liquid", "~> 5.5"
+  spec.add_dependency "redcarpet", "~> 3.6"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: trmnl-liquid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TRMNL
+bindir: bin
+cert_chain: []
+date: 2025-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+email:
+- engineering@usetrmnl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/trmnl/liquid.rb
+- lib/trmnl/liquid/filters.rb
+- lib/trmnl/liquid/template.rb
+- lib/trmnl/liquid/template/file_system.rb
+- lib/trmnl/liquid/template/template_tag.rb
+- lib/trmnl/liquid/version.rb
+- trmnl-liquid.gemspec
+homepage: https://github.com/usetrmnl/trmnl-liquid
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/usetrmnl/trmnl-liquid/issues
+  changelog_uri: https://github.com/usetrmnl/trmnl-liquid/tags
+  homepage_uri: https://github.com/usetrmnl/trmnl-liquid
+  label: TRMNL Liquid
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/usetrmnl/trmnl-liquid
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Liquid templating engine for TRMNL plugins
+test_files: []