trmnl_preview 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f442804907f15903eb4e5f543ad94eb18fdef92f82d191e67c4554621ca3c74
-  data.tar.gz: 0e8df9b455430254cc007c28e9799155b6e75cccc675fd9790e9a260e998c84a
+  metadata.gz: d37a034edabdffdea4cfd43b0a768f43955d0d1d41d8b7d5d49a8c30de676525
+  data.tar.gz: cc6e4d027d53e52e4c05b1a1f35ddafbbf136fa3467c5b1015d5813397935b49
 SHA512:
-  metadata.gz: ae89a85a00a4b5719128dc4e198cda157085c905b914a3f30ebf14b17f7c2ff3d3c4f87552e0c455d0691671998c003b019cf34dd5f948859f64749f05b615c0
-  data.tar.gz: 59642ee5f4741bf88fbcedcdcc8af927ed80127b044afdc464144e660a283c055dd395d8e579d97b58b001e7f441ecafe63a838bb90f9ea6cc2ed4ea3f8aff69
+  metadata.gz: c55ca2009766d890fbfc851752281d587ee4f76d48df50eb144e4aff113f8ae7255c1003a9519f2182151b1dd8294edb566462306c5d7777661ef60ba0bd831e
+  data.tar.gz: 5060f91212a819e479a12ddf72d44e970d098781abdacedd994a1716bb2642201dc5c753b09ee1da3c69de2b3a6acf191cd847967c6ae412f53f08042eca1557

data/bin/trmnlp

@@ -1,17 +1,19 @@
-#! /usr/bin/env ruby
+#!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'thor'
+warn <<~MESSAGE
+  trmnlp requires Ruby 4.0 or newer.
 
-require_relative '../lib/trmnlp/cli'
+  You are running Ruby #{RUBY_VERSION}. RubyGems installed this notice
+  instead of trmnlp, because the current release cannot run on your Ruby.
 
-# Force UTC to match trmnl.com server time zone
-ENV['TZ'] = 'UTC'
+  To use trmnlp, either:
 
-begin
-  TRMNLP::CLI.start
-rescue TRMNLP::Error => e
-  puts "Error: #{e.message}"
-  exit 1
-rescue Interrupt
-  exit 1
-end
+    * Upgrade to Ruby 4.0 or newer, then run:
+        gem install trmnl_preview
+
+    * Or run it through Docker, no Ruby needed:
+        https://github.com/usetrmnl/trmnlp#installing-via-docker
+MESSAGE
+
+exit 1

metadata

@@ -1,267 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Rockwell Schrock
 bindir: bin
 cert_chain: []
-date: 2026-02-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: rackup
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: puma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.5'
-- !ruby/object:Gem::Dependency
-  name: faye-websocket
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.3
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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: trmnl-liquid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.39'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.39'
-- !ruby/object:Gem::Dependency
-  name: mini_magick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.12.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.12.0
-- !ruby/object:Gem::Dependency
-  name: filewatcher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: faraday-multipart
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: xdg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.1'
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.16.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.16.9
-- !ruby/object:Gem::Dependency
-  name: tzinfo-data
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2025'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2025'
-- !ruby/object:Gem::Dependency
-  name: pathname
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rexml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-description: Automatically rebuild and preview TRNML plugins in multiple views
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: This version is not trmnlp. It is a notice published for Ruby installs
+  too old to run trmnlp, which would otherwise silently receive an outdated release.
+  Upgrade to Ruby 4.0 or newer and reinstall.
 email:
 - rockwell@schrock.me
 executables:
@@ -269,55 +19,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- LICENSE.txt
-- README.md
-- bin/rake
 - bin/trmnlp
-- lib/trmnlp.rb
-- lib/trmnlp/api_client.rb
-- lib/trmnlp/app.rb
-- lib/trmnlp/cli.rb
-- lib/trmnlp/commands.rb
-- lib/trmnlp/commands/base.rb
-- lib/trmnlp/commands/build.rb
-- lib/trmnlp/commands/clone.rb
-- lib/trmnlp/commands/init.rb
-- lib/trmnlp/commands/login.rb
-- lib/trmnlp/commands/pull.rb
-- lib/trmnlp/commands/push.rb
-- lib/trmnlp/commands/serve.rb
-- lib/trmnlp/config.rb
-- lib/trmnlp/config/app.rb
-- lib/trmnlp/config/plugin.rb
-- lib/trmnlp/config/project.rb
-- lib/trmnlp/context.rb
-- lib/trmnlp/paths.rb
-- lib/trmnlp/screen_generator.rb
-- lib/trmnlp/version.rb
-- templates/init/.trmnlp.yml
-- templates/init/bin/trmnlp
-- templates/init/src/full.liquid
-- templates/init/src/half_horizontal.liquid
-- templates/init/src/half_vertical.liquid
-- templates/init/src/quadrant.liquid
-- templates/init/src/settings.yml
-- templates/init/src/shared.liquid
-- trmnl_preview.gemspec
-- web/public/highlight/highlight.min.js
-- web/public/highlight/styles/atom-one-dark.min.css
-- web/public/index.css
-- web/public/index.js
-- web/public/trmnl-picker.js
-- web/views/index.erb
-- web/views/render_html.erb
 homepage: https://github.com/usetrmnl/trmnlp
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/usetrmnl/trmnlp
   source_code_uri: https://github.com/usetrmnl/trmnlp
+  rubygems_mfa_required: 'true'
+post_install_message: |
+  This is not trmnlp. It is a notice.
+
+  trmnlp requires Ruby 4.0 or newer, and your Ruby is older, so RubyGems
+  selected this version. Upgrade to Ruby 4.0 or newer and run
+  `gem install trmnl_preview` again, or run trmnlp through Docker:
+  https://github.com/usetrmnl/trmnlp#installing-via-docker
 rdoc_options: []
 require_paths:
 - lib
@@ -325,14 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Local web server to preview TRMNL plugins
+summary: 'Notice: trmnlp requires Ruby 4.0 or newer'
 test_files: []

data/CHANGELOG.md

@@ -1,139 +0,0 @@
-
-# Changelog
-
-## 0.7.0
-
-- Switch from Puppeteer + CDP to Selenium + WebDriver BiDi (@SorceressLyra)
-
-## 0.6.1
-
-- Update trmnl-liquid to 0.4.0
-
-## 0.6.0
-
-- Drop trmnl-component in lieu of plain iframe
-- Add [trmnl-picker](https://github.com/usetrmnl/trmnl-picker) to support new TRMNL and BYOD screens
-- Fix mashup layout previews
-
-## 0.5.10
-
-- Fix interpolation of multi-line polling URLs with custom fields
-
-## 0.5.9
-
-- Add `pathname` dependency
-
-## 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
-- 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)
-- Added override for `polling_url` in project config (@heroheman)
-- Reworked `bin/dev` into more generic `bin/trmnlp`
-- Fixed pull, push, and clone commands on Windows (@eugenio)
-
-## 0.5.4
-
-- Added `shared.liquid` file to template (@mariovisic)
-- Stringified custom field values to match production (@mariovisic)
-- Optimized image generation (@sd416)
-- Fixed preview from growing when JSON data becomes too wide (@stephenyeargin)
-
-## 0.5.3
-
-- Added support for [reusable markup](https://docs.trmnl.com/go/reusing-markup) in `shared.liquid`
-- Replaced custom case images with [\<trmnl-frame\> component](https://github.com/usetrmnl/trmnl-component)
-- Updated custom Liquid filters
-- Added API key validation during `trmnlp login`
-
-## 0.5.2
-
-- Added `time_zone` project config option, which is injected into `trmnl.user` variables
-- Fixed time zone to always be UTC, matching trmnl.com servers (#38)
-
-## 0.5.1
-
-- Fixed `trmnl init`
-
-## 0.5.0
-
-- Added `trmlnp init` command
-- Added `trmnlp clone` command
-- Improved `trmnlp push` to create remote plugin on first publish
-- Changed syntax of `trmnlp push` and `trmnlp pull` commands
-- Added `oj` gem for JSON parsing (#32)
-
-## 0.4.0
-
-### Plugin Migration Strategy
-
-The plugin directory structure has changed to better align with the [plugin archive format](https://help.trmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0). 
-
-Here is a migration strategy for existing plugin repositories:
-
-1. Create `.trmnlp.yml` and bring over preview settings from `config.toml` - [see README](README.md)
-2. Rename directory `views/` to `src/`
-3. Create `src/settings.yml` and bring over plugin settings from `config.toml` - [see TRMNL docs](https://help.trmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0)
-4. Delete `config.toml`
-
-### Changes
-
-- Change plugin directory structure (see README for details)
-- Add `login`, `push`, and `pull` commands
-- Bring up-to-date with latest private plugin features:
-  - Add `static` strategy
-  - Add polling features: multiple URLs, new verbs, and request body
-  - Add settings `dark_mode`, `no_screen_padding`, `custom_fields`
-  - Add interpolation of custom fields in `polling\_\*` options
-  - Add `{{ trmnl }}` variables 
-- Add `watch` config
-- Add interpolation of environment variables in `.trmnlp.yml` via `{{ env }}`
-- Add auto-reload when `.trmnlp.yml` or `settings.yml` changes
-- Add variable display
-- Fix crash when #poll_data fails (#12)
-- Fix git runtime error in Docker container (#12)
-
-
-
-## 0.3.2
-
-- Add bitmap rendering
-- Add TRMNL's [custom plugin filters](https://help.trmnl.com/en/articles/10347358-custom-plugin-filters)
-- Add support for user-supplied custom filters
-
-## 0.3.1
-
-- Add live render
-
-## 0.3.0
-
-- Add poll button
-- Add case image overlays
-- Add `trmnlp build` command
-- Add support for `url` pointing to a local JSON data file
-
-## 0.2.0
-
-- Add "commands" concept to `trmnlp` executable
-- `trmnlp serve` improvements
-  - Add argument for plugin directory
-  - Add options `-b` and `-p` for host bind and port, respectively
-- Add Dockerfile
-
-## 0.1.2
-
-- Initial working release

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 Rockwell Schrock
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/README.md

@@ -1,144 +0,0 @@
-# trmnlp
-
-A basic self-hosted web server to ease the development and sharing of [TRMNL](https://trmnl.com/) plugins.
-
-[Liquid](https://shopify.github.io/liquid/) templates are rendered leveraging the [TRMNL Design System](https://trmnl.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)
-
-## Project Structure
-
-This is the structure of a plugin project:
-
-```
-.
-├── .trmnlp.yml
-├── bin
-│   └── dev
-└── src
-    ├── full.liquid
-    ├── half_horizontal.liquid
-    ├── half_vertical.liquid
-    ├── quadrant.liquid
-    ├── shared.liquid
-    └── settings.yml
-```
-
-## Creating a New Plugin
-
-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
-```
-
-## Modifying an Existing Plugin
-
-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
-```
-
-## 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.
-
-You can modify the `bin/trmnlp` script to set up environment variables (plugin secrets, etc.) before running the server.
-
-### Installing via RubyGems
-
-Prerequisites:
-
-- Ruby 3.x
-- For PNG rendering (optional):
-  - Firefox
-  - ImageMagick
-
-```sh
-gem install trmnl_preview
-trmnlp serve
-```
-
-### Installing via Docker
-
-```sh
-docker run \
-    --publish 4567:4567 \
-    --volume "$(pwd):/plugin" \
-    trmnl/trmnlp serve
-```
-
-## `.trmnlp.yml` Reference - Project Config
-
-The `.trmnlp.yml` file lives in the root of the plugin project, and is for configuring the local dev server.
-
-System environment variables are made available in the `{{ env }}` Liquid varible in this file only. This can be used to safely
-supply plugin secrets, like API keys.
-
-All fields are optional.
-
-```yaml
----
-# auto-reload when files change (`watch: false` to disable)
-watch:
-  - src
-  - .trmnlp.yml
-
-# values of custom fields (defined in src/settings.yml)
-custom_fields:
-  station: "{{ env.ICAO }}" # interpolate $IACO environment variable
-
-# Time zone IANA identifier to inject into trmnl.user; see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-time_zone: America/New_York
-
-# override variables
-variables:
-  trmnl:
-    user:
-      name: Peter Quill
-    plugin_settings:
-      instance_name: Kevin Bacon Facts
-
-```
-
-## `src/settings.yml` Reference (Plugin Config)
-
-The `settings.yml` file is part of the plugin definition. 
-
-See [TRMNL documentation](https://help.trmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0) for details on this file's contents.
-
-
-## Tests
-
-To test, run:
-
-```sh
-bin/rake
-```
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/usetrmnl/trmnlp.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).