trmnl_preview 0.30.4 → 0.31.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19d57b76b4b9fac2e897d2b4f18459bce312329e9ed647cb950781e5834387e6
-  data.tar.gz: 3f12fe83acc40963e8a36a218275e42713aa5211ea80761cb46a44d72889de01
+  metadata.gz: b21d300476e67904c34d0187c12b11c59904e67429ead767147d24d50ca1db9d
+  data.tar.gz: 5e77e6666b47b187f558d04c158907cc0441e90899f7e444cea1cc136a49a6cd
 SHA512:
-  metadata.gz: ec019e1a423c47855cd9a96b1ef39578135e99aa9fb8b2b807e67f919b08884d360a180bc4619dcbdace7bf99095eeea4d1a69d672f6821a66ea3d33a78ee9c7
-  data.tar.gz: 4bb9acf58ffd364b56a265a16e4a4d2cafa48847cc763c27f7d74d0fd0b261cc69fca465e6af327cfbdd7fb8e116cff46f9fff372e636b9733679af875834758
+  metadata.gz: eedd5d2c1275ac5f7a8dbc4767472e0dc5e1ff456ea352e3bbb6373190c0f98b04d8fe56f14cddcc8a2982ec57dd1ec21037d5a0c3d37b856c98830db5f81826
+  data.tar.gz: 7e9e0209e2102edf63ccc05efe67ed69912b206cae2f4c8e33d8bc67b8f83349cc8b1f35e2694b3246e6179c487e15368746ebfa259495db9306361dca834559

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 
 # Changelog
 
+## 0.31.1
+
+- A view with no `.liquid` file draws the shared markup alone, as TRMNL does when a recipe keeps all of its markup in shared. Before, trmnlp drew "Missing template" there, so `trmnlp test` showed a blank screen for a recipe that draws on TRMNL. A view with no file and no shared markup still says "Missing template".
+
+- `trmnlp test` mocks the HTTPS requests of a Python transform on Python 3.13 and newer, which the Docker image ships. Before, Python 3.13 refused the test proxy's certificate ("Missing Authority Key Identifier"), so every request failed and the screens showed the transform's error path.
+
+- A Python transform can `import requests`, as on TRMNL, where it is installed. When the Python on your PATH does not have it, trmnlp makes a virtual environment with it in `~/.cache/trmnl/python` the first time and runs Python transforms there. Before, such a transform failed with `No module named 'requests'` and `trmnlp test` drew its error screen. The Docker image now has it installed.
+
+## 0.31.0
+
+- `trmnlp test`'s publishable recipe draws the full view with each boolean field on and off, as `"true"` and `"false"`, the strings TRMNL saves. Before, only select fields were drawn with each option, so a recipe that breaks or goes blank with a switch off passed.
+- `option_screens:` draws those options on the screens you name, such as `[{ device: 'og_png' }, { device: 'v2' }]` to try each one on the TRMNL X too. It defaults to the first screen, as before.
+- `trmnlp serve`'s HTML preview draws a device TRMNL scales at its CSS size again, so a TRMNL X fits its 1040 by 780 frame. Since 0.16.0 it drew 1872 by 1404 and ran past the frame. PNG renders and `trmnlp test` are unchanged.
+
 ## 0.30.4
 
 - `trmnlp lint` reports a margin, padding, gap or position class with a leading minus (`no_negative_spacing`), such as `-mt--2` or `lg:-top--1`. Tailwind writes negative values this way, but no Framework release defines a class that starts with a minus, so TRMNL ignores it and says nothing: an icon nudged up with `-mt--1` stays where it was.

data/db/data/framework_versions.yml

@@ -1,6 +1,6 @@
 # Mirrored from the TRMNL design-system source.
 # Refresh with `rake framework:sync` — do not edit manually.
-latest: 3.4.2
+latest: 3.4.3
 versions:
 - number: 0.0.1
   released_at: '2024-06-22'
@@ -98,3 +98,5 @@ versions:
   released_at: '2026-10-14'
 - number: 3.4.2
   released_at: '2026-10-14'
+- number: 3.4.3
+  released_at: '2026-10-15'

data/lib/trmnlp/renderer.rb

@@ -63,7 +63,9 @@ module TRMNLP
     # of 500-ing. Anything that's not a RenderError bubbles up as a bug.
     def render_liquid_template(view, device: {})
       template_path = paths.template(view)
-      raise RenderError, "Missing template: #{template_path}" unless template_path.exist?
+      unless template_path.exist? || paths.shared_template.exist?
+        raise RenderError, "Missing template: #{template_path}"
+      end
 
       parse_and_render(template_path, device:)
     end
@@ -89,8 +91,7 @@ module TRMNLP
     end
 
     def full_markup(template_path)
-      shared = paths.shared_template
-      shared.exist? ? shared.read + template_path.read : template_path.read
+      [paths.shared_template, template_path].select(&:exist?).map(&:read).join
     end
 
     def liquid_environment

data/lib/trmnlp/screenshot.rb

@@ -69,9 +69,13 @@ module TRMNLP
       })();
     JS
 
+    # The preview frame has the device's CSS size, so the screen stays unscaled there.
+    LIVE_PREVIEW_SIZE_STYLE = '<style>.trmnl .screen { --pixel-ratio: 1 !important; }</style>'
+
     def self.live_preview(html)
       timeout = html.match?(MAPS_DOCUMENT_PATTERN) ? READINESS_TIMEOUT_WITH_MAPS_SECONDS : READINESS_TIMEOUT_SECONDS
-      html.sub('</head>', "#{LAYOUT_PASS_STYLE}<script>#{format(SETTLE_LIVE_PREVIEW, timeout)}</script></head>")
+      script = "<script>#{format(SETTLE_LIVE_PREVIEW, timeout)}</script>"
+      html.sub('</head>', "#{LIVE_PREVIEW_SIZE_STYLE}#{LAYOUT_PASS_STYLE}#{script}</head>")
     end
 
     def initialize(pool:, viewport_timeout: 5, fonts_timeout: FONTS_TIMEOUT_SECONDS)

data/lib/trmnlp/testing/certificate_authority.rb

@@ -57,6 +57,8 @@ module TRMNLP
 
       def add_extensions(certificate, authority, host)
         factory = OpenSSL::X509::ExtensionFactory.new(authority ? certificate : @certificate, certificate)
+        certificate.add_extension(factory.create_extension('subjectKeyIdentifier', 'hash'))
+        certificate.add_extension(factory.create_extension('authorityKeyIdentifier', 'keyid:always'))
         if authority
           certificate.add_extension(factory.create_extension('basicConstraints', 'CA:TRUE', true))
           certificate.add_extension(factory.create_extension('keyUsage', 'keyCertSign,cRLSign', true))

data/lib/trmnlp/testing/publishable_recipe.rb

@@ -25,21 +25,29 @@ module TRMNLP
     # Share of an image's ink its dark mode render must keep: lost icons kept 0%, the lowest one shown 17% (10-14).
     DARK_MODE_MIN_IMAGE_INK_KEPT = 0.05
 
-    # Each select field's keyname and the values its options save, from the plugin's settings.yml.
-    def self.select_field_values
+    # Each select and boolean field's keyname and the values it can save, from the plugin's settings.yml.
+    def self.option_field_values
       path = File.join(plugin_dir, 'src', 'settings.yml')
       fields = File.exist?(path) ? Array(YAML.safe_load_file(path, aliases: true)&.dig('custom_fields')) : []
-      fields.select { it['field_type'] == 'select' }.to_h do |field|
-        values = SelectFieldChoices.new(field).pairs.map { it.last.to_s }
+      fields.select { %w[select boolean].include?(it['field_type']) }.to_h do |field|
+        # TRMNL saves a boolean field as the string "true" or "false".
+        values = if field['field_type'] == 'boolean' then %w[true false]
+                 else SelectFieldChoices.new(field).pairs.map { it.last.to_s }
+                 end
         [field['keyname'], values.size > PUBLISHABLE_RECIPE_MAX_OPTIONS ? values.values_at(0, -1) : values]
       end
     end
+
+    def self.screen_name(screen)
+      device = screen[:device].is_a?(Hash) ? screen[:device][:model] : screen[:device]
+      [device, screen[:orientation], screen[:palette], ('dark mode' if screen[:dark_mode])].compact.join(' ')
+    end
   end
 end
 
 # rubocop:disable-next Metrics/BlockLength -- one shared group, one check per example
 RSpec.shared_examples 'a publishable recipe' do |screens: TRMNLP::Testing::PUBLISHABLE_RECIPE_SCREENS,
-                                                 dark_mode_screen: { device: 'v2' }|
+                                                 dark_mode_screen: { device: 'v2' }, option_screens: screens.first(1)|
   let(:recipe_inputs) do
     { mocks: respond_to?(:mocks) ? mocks : {}, custom_fields: respond_to?(:custom_fields) ? custom_fields : {},
       variables: respond_to?(:variables) ? variables : {}, now: respond_to?(:now) ? now : nil,
@@ -52,11 +60,7 @@ RSpec.shared_examples 'a publishable recipe' do |screens: TRMNLP::Testing::PUBLI
   end
 
   TRMNLP::Testing::PUBLISHABLE_RECIPE_VIEWS.product(screens).each do |view, screen|
-    device = screen[:device].is_a?(Hash) ? screen[:device][:model] : screen[:device]
-    dark_mode = 'dark mode' if screen[:dark_mode]
-    screen_name = [device, screen[:orientation], screen[:palette], dark_mode].compact.join(' ')
-
-    it "draws the #{view} view on #{screen_name} without page errors" do
+    it "draws the #{view} view on #{TRMNLP::Testing.screen_name(screen)} without page errors" do
       expect(trmnl.render(view:, **screen, **recipe_inputs)).to draw_cleanly
     end
   end
@@ -76,11 +80,11 @@ RSpec.shared_examples 'a publishable recipe' do |screens: TRMNLP::Testing::PUBLI
     end
   end
 
-  TRMNLP::Testing.select_field_values.each do |keyname, values|
-    values.each do |value|
-      it "draws the full view with #{keyname} set to #{value}" do
+  TRMNLP::Testing.option_field_values.each do |keyname, values|
+    option_screens.product(values).each do |screen, value|
+      it "draws the full view on #{TRMNLP::Testing.screen_name(screen)} with #{keyname} set to #{value}" do
         custom_fields = recipe_inputs[:custom_fields].merge(keyname => value)
-        expect(trmnl.render(**screens.first, **recipe_inputs, custom_fields:)).to draw_cleanly
+        expect(trmnl.render(**screen, **recipe_inputs, custom_fields:)).to draw_cleanly
       end
     end
   end

data/lib/trmnlp/transform_backend/python.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'xdg'
+
+module TRMNLP
+  module TransformBackend
+    # TRMNL's serverless Python has requests installed. A Python without it runs transforms from a
+    # virtual environment in the cache that has it, made once; if that fails, the Python runs as it is.
+    module Python
+      module_function
+
+      def interpreter(python, venv_dir: XDG.new.cache_home.join('trmnl', 'python'))
+        resolved[python] ||= imports_requests?(python) ? python : venv_python(python, venv_dir)
+      end
+
+      def venv_python(python, venv_dir)
+        venv_dir.dirname.mkpath
+        venv = venv_dir.join(Gem.win_platform? ? 'Scripts/python.exe' : 'bin/python').to_s
+        created = File.open("#{venv_dir}.lock", File::RDWR | File::CREAT) do |lock|
+          lock.flock(File::LOCK_EX)
+          imports_requests?(venv) || created_venv?(python, venv_dir, venv)
+        end
+        created ? venv : python
+      end
+
+      def created_venv?(python, venv_dir, venv)
+        succeeds?(python, '-m', 'venv', '--clear', venv_dir.to_s) && succeeds?(venv, '-m', 'pip', 'install', 'requests')
+      end
+
+      def imports_requests?(python) = succeeds?(python, '-c', 'import requests')
+
+      def succeeds?(*command) = system(*command, out: File::NULL, err: File::NULL) == true
+
+      def resolved = @resolved ||= {}
+    end
+  end
+end

data/lib/trmnlp/transform_backend/subprocess.rb

@@ -4,6 +4,7 @@ require 'open3'
 require 'tmpdir'
 
 require_relative '../transform_client'
+require_relative 'python'
 require_relative 'which'
 require_relative 'wrapper'
 
@@ -52,7 +53,9 @@ module TRMNLP
           output_path = File.join(dir, 'output.json')
           src_path = File.join(dir, "transform.#{spec[:ext]}")
           File.write(src_path, Wrapper.for(language, code, sink_for(language, output_path)))
-          run_process(Which.resolve(spec[:cmds]), src_path, stdin, timeout_seconds, output_path)
+          command = Which.resolve(spec[:cmds])
+          command = Python.interpreter(command) if language == 'python'
+          run_process(command, src_path, stdin, timeout_seconds, output_path)
         end
       rescue Errno::ENOENT, Errno::EACCES => e
         failure("interpreter not available: #{e.message}")

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.30.4'
+  VERSION = '0.31.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.30.4
+  version: 0.31.1
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -500,6 +500,7 @@ files:
 - lib/trmnlp/testing/snapshot.rb
 - lib/trmnlp/testing/text_ink.rb
 - lib/trmnlp/transform_backend/http.rb
+- lib/trmnlp/transform_backend/python.rb
 - lib/trmnlp/transform_backend/subprocess.rb
 - lib/trmnlp/transform_backend/which.rb
 - lib/trmnlp/transform_backend/wrapper.rb