trmnl_preview 0.5.6 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abf6757d447adc5c12e7eed3baa049bc80757bc536f0da60af8ccb624d4216d4
-  data.tar.gz: a533ae492f2ea9b71a55130977a88988ec3767c1393b2ebbbf618364a5a0f53b
+  metadata.gz: a9fb3cbe39aa3d0e8677b94b1bf224296d09ba045fac80e34b4d7438838a7c9c
+  data.tar.gz: 290000660480be5eca61e6a100dd9d737460e41daccdc2bbaa1088c330a3968c
 SHA512:
-  metadata.gz: a88985299e6c183a0ee61fa609f117dffad48b42e1abdd4c2ea8303051725f44fc411870d9b5999d0ce7b1f78e6923d10974cf79ea79787ed61212eed36c3aa4
-  data.tar.gz: bbdd8ac78d326b086eb56c8a66cf2aaf96096e1beb879ee951cda37b6f699cf14fc5d796fac34d4711b20c8d750075f38c1110d2829d0ebe1ed0d5fafa44c9c3
+  metadata.gz: '078876141ae2f419ae91dc343a2375a0aee31fcb18eb127324d280c0286dfab6b1785f4a79d92a06ed3c4bdece76f8d989d4d92b1dba928c2948b75cb4a374f7'
+  data.tar.gz: fb0fb7099bdb48ed80568448fa322f202e593d7089f4504546c38c6dade57929a580384a307203225a018abf45a7f1187c577391c64df25cd6a36f6e881a5ff9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.8
+
+- Improve Docker commands in `bin/trmnlp` (@jrand0m, @jbarreiros)
+
+## 0.5.7
+
+- Use the `trmnl-liquid` gem so tags and filters stay up-to-date with the core offering
+
 ## 0.5.6
 
 - Fixed bug that left blank plugins on server after upload failed

data/README.md

@@ -4,6 +4,8 @@ A basic self-hosted web server to ease the development and sharing of [TRMNL](ht
 
 [Liquid](https://shopify.github.io/liquid/) templates are rendered leveraging the [TRMNL Design System](https://usetrmnl.com/framework). They may be generated as HTML (faster, and a good approximation of the final result) or as PNG images (slower, but more accurate).
 
+Custom Liquid filters and tags are provided by the [trmnl-liquid](https://github.com/usetrmnl/trmnl-liquid) gem.
+
 The server watches the filesystem for changes to the Liquid templates, seamlessly updating the preview without the need to refresh.
 
 ![Screenshot](docs/preview.png)
@@ -81,7 +83,7 @@ trmnlp serve
 ```sh
 docker run \
     --publish 4567:4567 \
-    --volume ".:/plugin" \
+    --volume "$(pwd):/plugin" \
     trmnl/trmnlp serve
 ```
 

data/lib/trmnlp/config/project.rb

@@ -1,3 +1,4 @@
+require 'trmnl/liquid'
 require 'yaml'
 
 module TRMNLP
@@ -33,7 +34,7 @@ module TRMNLP
       # for interpolating custom_fields into polling_* options
       def with_custom_fields(value)
         custom_fields_with_env = custom_fields.transform_values { |v| with_env(v) }
-        Liquid::Template.parse(value).render(custom_fields_with_env)
+        parse_liquid(value).render(custom_fields_with_env)
       end
 
       def time_zone = @config['time_zone'] || 'UTC'
@@ -42,7 +43,11 @@ module TRMNLP
 
       # for interpolating ENV vars into custom_fields
       def with_env(value)
-        Liquid::Template.parse(value).render({ 'env' => ENV.to_h })
+        parse_liquid(value).render({ 'env' => ENV.to_h })
+      end
+
+      def parse_liquid(contents)
+        Liquid::Template.parse(contents, environment: TRMNL::Liquid.build_environment)
       end
     end
   end

data/lib/trmnlp/context.rb

@@ -3,11 +3,10 @@ require 'erb'
 require 'faraday'
 require 'filewatcher'
 require 'json'
-require 'liquid'
+require 'trmnl/liquid'
 
 require_relative 'config'
 require_relative 'paths'
-require_relative '../markup/template'
 
 module TRMNLP
   class Context
@@ -129,7 +128,7 @@ module TRMNLP
         full_markup = template_path.read
       end
 
-      user_template = Markup::Template.parse(full_markup, environment: liquid_environment)
+      user_template = Liquid::Template.parse(full_markup, environment: liquid_environment)
       user_template.render(user_data)
     rescue StandardError => e
       e.message
@@ -206,10 +205,7 @@ module TRMNLP
     end
 
     def liquid_environment
-      @liquid_environment ||= Liquid::Environment.build do |env|
-        env.register_filter(Markup::CustomLiquidFilters)
-        env.register_tag('template', Markup::TemplateTag)
-
+      @liquid_environment ||= TRMNL::Liquid.build_environment do |env|
         config.project.user_filters.each do |module_name, relative_path|
           require paths.root_dir.join(relative_path)
           env.register_filter(Object.const_get(module_name))

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = "0.5.6".freeze
+  VERSION = "0.5.8".freeze
 end

data/templates/init/bin/trmnlp

@@ -10,12 +10,25 @@ then
     exit
 fi
 
+# Determine XDG config directory on host OS
+if [ -n "$XDG_CONFIG_HOME" ]; then
+    CONFIG_DIR="$XDG_CONFIG_HOME/trmnlp"
+else
+    CONFIG_DIR="$HOME/.config/trmnlp"
+fi
+
+if [ ! -d "$CONFIG_DIR" ]; then
+    mkdir -p "$CONFIG_DIR"
+fi
+
 if command -v docker &> /dev/null
 then
     docker run \
+        -it \
         --rm \
         --publish 4567:4567 \
         --volume "$(pwd):/plugin" \
+        --volume "$CONFIG_DIR:/root/.config/trmnlp" \
         trmnl/trmnlp "$@"
     exit
 fi

data/trmnl_preview.gemspec

@@ -43,9 +43,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faye-websocket", "~> 0.11.3"
 
   # HTML rendering
-  spec.add_dependency "liquid", "~> 5.6"
   spec.add_dependency "activesupport", "~> 8.0"
-  spec.add_dependency "actionview", "~> 8.0"
+  spec.add_dependency "trmnl-liquid", "~> 0.2.0"
 
   # PNG rendering
   spec.add_dependency 'puppeteer-ruby', '~> 0.45.6'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.8
 platform: ruby
 authors:
 - Rockwell Schrock
 bindir: bin
 cert_chain: []
-date: 2025-07-10 00:00:00.000000000 Z
+date: 2025-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -65,20 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.3
-- !ruby/object:Gem::Dependency
-  name: liquid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -94,19 +80,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: actionview
+  name: trmnl-liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: puppeteer-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -260,10 +246,6 @@ files:
 - README.md
 - bin/rake
 - bin/trmnlp
-- lib/markup/custom_liquid_filters.rb
-- lib/markup/inline_templates_file_system.rb
-- lib/markup/template.rb
-- lib/markup/template_tag.rb
 - lib/trmnlp.rb
 - lib/trmnlp/api_client.rb
 - lib/trmnlp/app.rb

data/lib/markup/custom_liquid_filters.rb

@@ -1,36 +0,0 @@
-require 'action_view'
-require 'singleton'
-
-module Markup
-  module CustomLiquidFilters
-    class ActionViewHelpers
-      include Singleton
-      include ActionView::Helpers
-    end
-
-    def number_with_delimiter(number, delimiter = ',', separator = ',')
-      ActionViewHelpers.instance.number_with_delimiter(number, delimiter:, separator:)
-    end
-
-    def number_to_currency(number, unit = '$', delimiter = ',', separator = '.')
-      ActionViewHelpers.instance.number_to_currency(number, unit: unit, delimiter:, separator:)
-    end
-
-    def l_word(word, locale)
-      I18n.t("custom_plugins.#{word}", locale: locale)
-    end
-
-    def l_date(date, format, locale = 'en')
-      format = format.to_sym unless format.include?('%')
-      I18n.l(date.to_datetime, :format => format, locale: locale)
-    end
-
-    def pluralize(singular, count)
-      ActionViewHelpers.instance.pluralize(count, singular)
-    end
-
-    def json(obj)
-      JSON.generate(obj)
-    end
-  end
-end

data/lib/markup/inline_templates_file_system.rb

@@ -1,19 +0,0 @@
-module Markup
-  # This in-memory "file system" is the backing storage for custom templates defined {% template [name] %} tags.
-  class InlineTemplatesFileSystem < 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

data/lib/markup/template.rb

@@ -1,17 +0,0 @@
-# get all files in the current directory as this file
-Pathname.new(__dir__).glob('*.rb').each { |file| require file }
-
-module Markup
-  # 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] = InlineTemplatesFileSystem.new
-
-      template
-    end
-  end
-end

data/lib/markup/template_tag.rb

@@ -1,31 +0,0 @@
-module Markup
-  # 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