trmnl_preview 0.5.5 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16a333009aab09891c12d6fe7bf3b8662912cd6e376f31c1a4997de5a6c93314
-  data.tar.gz: cf57e05fa4ba41059e55fb7281d7644ee07772459b63503ebe4a4023fae14085
+  metadata.gz: 4f3284ba2c2879994af5aabd394416875771b008510fffb27798551e3a9c85ad
+  data.tar.gz: 9f664bc7134763f88dab40b5075aa77bf08892bf68b1f1e29771cc47a3f2b95e
 SHA512:
-  metadata.gz: 43048f869b37533061b92b7e06b2623b8d47e35098942f535301655727efc726f09c004330f277fb1ee7d0a73f3b5785283846b1404e0d8a6b92cec4f94b9105
-  data.tar.gz: 3a8672a65e06a537fef9c51e759657076bcda0a320cc4f2ee8a211c27bad31bcab09993ab592c520c3103805e2077a5f907c67c2423184688fd612d0c307e276
+  metadata.gz: 9e5685d0a9359f229087bbc1d59e2969e87cb54251eb90ca73787f4731ce6b085c829428721838543596f3cfd1c1d7958b363fcd8f3b2d5d0f981490c14bfdd3
+  data.tar.gz: 372e8d359ee7ef461ccffb12f8dd6d8a328e0c4d32178e62d4e3e358f38f3ac40b971d25ac63c1cf3b97388b3f483b0c814568f40c4c8d30169e6dfdc9a95811

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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
+- Fixed bug creating upload.zip after previous upload had failed
+- Added support to read API key fromk `TRMNL_API_KEY` environment variable (@andi4000)
+- Fixed `init` command in Docker container (@jbarreiros)
+- Automatically remove ephemeral Docker container after exit (@andi4000)
+
 ## 0.5.5
 
 - Added dark mode (@stephenyeargin)

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)
@@ -31,11 +33,11 @@ This is the structure of a plugin project:
 You can start building a plugin locally, then `push` it to the TRMNL server for display on your device.
 
 ```sh
-trmnlp init my_plugin  # generate
-cd my_plugin
-trmnlp serve           # develop locally
-trmnlp login           # authenticate
-trmnlp push            # upload
+trmnlp init [my_plugin]  # generate
+cd [my_plugin]
+trmnlp serve             # develop locally
+trmnlp login             # authenticate
+trmnlp push              # upload
 ```
 
 ## Modifying an Existing Plugin
@@ -43,13 +45,19 @@ trmnlp push            # upload
 If you have built a plugin with the web-based editor, you can `clone` it, work on it locally, and `push` changes back to the server.
 
 ```sh
-trmnlp login                 # authenticate
-trmnlp clone my_plugin [id]  # first download
-cd my_plugin
-trmnlp serve                 # develop locally
-trmnlp push                  # upload
+trmnlp login                   # authenticate
+trmnlp clone [my_plugin] [id]  # first download
+cd [my_plugin]
+trmnlp serve                   # develop locally
+trmnlp push                    # upload
 ```
 
+## Authentication
+
+The `trmnlp login` command saves your API key to `~/.config/trmnlp/config.yml`.
+
+If an environment variable is more convenient (for example in a CI/CD pipeline), you can set `$TRMNL_API_KEY` instead.
+
 ## Running trmnlp
 
 The `bin/trmnlp` script is provided as a convenience. It will use the local Ruby gem if available, falling back to the `trmnl/trmnlp` Docker image.

data/lib/trmnlp/api_client.rb

@@ -53,6 +53,16 @@ module TRMNLP
       end
     end
 
+    def delete_plugin_setting(id)
+      response = conn.delete("plugin_settings/#{id}")
+
+      if response.status == 204
+        true
+      else
+        raise Error, "failed to delete plugin setting: #{response.status} #{response.body}"
+      end
+    end
+
     private
   
     attr_reader :config

data/lib/trmnlp/commands/login.rb

@@ -6,7 +6,9 @@ module TRMNLP
       def call
         if config.app.logged_in?
           anonymous_key = config.app.api_key[0..10] + '*' * (config.app.api_key.length - 11)
-          output "Currently authenticated as: #{anonymous_key}" 
+          output "Currently authenticated as: #{anonymous_key}"
+          confirm = prompt("You are already authenticated. Do you want to re-authenticate? (y/N): ")
+          return unless confirm.strip.downcase == 'y'
         end
 
         output "Please visit #{config.app.account_uri} to grab your API key, then paste it here."

data/lib/trmnlp/commands/push.rb

@@ -11,6 +11,7 @@ module TRMNLP
         authenticate!
 
         is_new = false
+        zip_path = 'upload.zip'
 
         api = APIClient.new(config)
 
@@ -27,10 +28,7 @@ module TRMNLP
           raise Error, 'aborting' unless answer == 'y' || answer == 'yes'
         end
 
-        size = 0
-
-        zip_path = 'upload.zip'
-        f = Zip::File.open(zip_path, Zip::File::CREATE) do |zip_file|
+        Zip::File.open(zip_path, Zip::File::CREATE) do |zip_file|
           paths.src_files.each do |file|
             zip_file.add(File.basename(file), file)
           end
@@ -40,7 +38,6 @@ module TRMNLP
         paths.plugin_config.write(response.dig('data', 'settings_yaml'))
 
         size = File.size(zip_path)
-        File.delete(zip_path)
         
         output <<~HEREDOC
         Uploaded plugin (#{size} bytes)
@@ -55,6 +52,15 @@ module TRMNLP
               #{config.app.playlists_uri}
           HEREDOC
         end
+      rescue
+        if is_new && plugin_settings_id
+          output 'Error during creation, cleaning up...'
+          api.delete_plugin_setting(plugin_settings_id)
+        end
+
+        raise
+      ensure
+        File.delete(zip_path) if File.exist?(zip_path)
       end
     end
   end

data/lib/trmnlp/config/app.rb

@@ -17,7 +17,11 @@ module TRMNLP
       def logged_in? = api_key && !api_key.empty?
       def logged_out? = !logged_in?
 
-      def api_key = @config['api_key']
+      def api_key
+        env_api_key = ENV['TRMNL_API_KEY']
+        return env_api_key if env_api_key && !env_api_key.empty?
+        @config['api_key']
+      end
 
       def api_key=(key)
         @config['api_key'] = key

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.5".freeze
+  VERSION = "0.5.7".freeze
 end

data/templates/init/bin/trmnlp

@@ -13,6 +13,7 @@ fi
 if command -v docker &> /dev/null
 then
     docker run \
+        --rm \
         --publish 4567:4567 \
         --volume "$(pwd):/plugin" \
         trmnl/trmnlp "$@"
@@ -27,4 +28,4 @@ Or install Docker:
 
     https://docs.docker.com/get-docker/"
 
-exit 1
+exit 1

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.5
+  version: 0.5.7
 platform: ruby
 authors:
 - Rockwell Schrock
 bindir: bin
 cert_chain: []
-date: 2025-06-27 00:00:00.000000000 Z
+date: 2025-08-19 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