trmnl_preview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7db91035d25c8dc02576fa945d520f09a65faace724c38e419070c7c7c44d10e
+  data.tar.gz: 43f5bc530d71e08fde73546a5d0a8010dbd6282dd05925da4e46d74874b4b8ab
+SHA512:
+  metadata.gz: e6540892b142f4dc9414a2daae31fa8b062845a792c730d5b369025b0cc73d1fce374b833402bd1598cba162a07064c3de17460a0305492f912e2310ffe32f85
+  data.tar.gz: 0a89a7cafcbd6621e8b6f64af93d744e4673590b02380e6869b8d90c56036fa9e36dfe2468ef6d465b6ad4ac2af61faa4ad687c7246bec8bc78bc8149f3a0d5a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,43 @@
+# trmnl_preview
+
+A little self-hosted web server to ease the development and sharing of [TRMNL](https://usetrmnl.com/) plugins.
+
+## Prerequisites
+
+- Ruby 3.x
+
+## Getting Started
+
+Clone a fork of https://github.com/schrockwell/trmnl-hello.
+
+Run `bundle`.
+
+Modify `config.toml` (see below for reference).
+
+Modify the four view templates in `views/*.liquid`
+
+Run `trmnlp` to start the local web server.
+
+Browse it locally at http://127.0.0.1:4567/
+
+## Usage Notes
+
+Simply refresh the page to re-render.
+
+When the polling strategy is "polling", the specified URL will be fetched once when the server starts.
+
+When the polling strategy is "webhook", you can POST payloads to the `/webhook` endpoint. They are saved to `tmp/data.json` for future renders.
+
+## `config.toml` Reference
+
+- `strategy` - Either "polling" or "webhook"
+- `url` - The URL from which to fetch JSON data (polling strategy only)
+- `[polling_headers]` - A section of headers to append to the HTTP poll request (polling strategy only)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/schrockwell/trmnl_preview.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/trmnlp

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require_relative '../lib/trmnl_preview'
+
+TRMNLPreview::App.run!

data/lib/trmnl_preview/app.rb

@@ -0,0 +1,97 @@
+require 'json'
+require 'liquid'
+require 'open-uri'
+require 'sinatra'
+require 'sinatra/base'
+require 'toml'
+
+require_relative '../trmnl_preview'
+require_relative 'liquid_filters'
+
+class TRMNLPreview::App < Sinatra::Base
+  set :views, File.join(File.dirname(__FILE__), '..', '..', 'views')
+  
+  # Constants
+  VIEWS = %w{full half_horizontal half_vertical quadrant}
+  CONFIG_PATH = File.join(Dir.pwd, 'config.toml')
+  USER_VIEWS_DIR = File.join(Dir.pwd, 'views')
+  TEMP_DIR = File.join(Dir.pwd, 'tmp')
+  DATA_JSON_PATH = File.join(TEMP_DIR, 'data.json')
+
+  unless File.exist?(CONFIG_PATH)
+    puts "No config.toml found in #{Dir.pwd}"
+    exit 1
+  end
+
+  unless Dir.exist?(USER_VIEWS_DIR)
+    puts "No views found at #{USER_VIEWS_DIR}"
+    exit 1
+  end
+
+  FileUtils.mkdir_p(TEMP_DIR)
+
+  config = TOML.load_file(CONFIG_PATH)
+  strategy = config['strategy']
+
+  unless ['polling', 'webhook'].include?(strategy)
+    puts "Invalid strategy: #{strategy} (must be 'polling' or 'webhook')"
+    exit 1
+  end
+
+  url = config['url']
+  polling_headers = config['polling_headers'] || {}
+
+  if strategy == 'polling'
+    if url.nil?
+      puts "URL is required for polling strategy"
+      exit 1
+    end
+
+    print "Fetching #{url}... "
+    payload = URI.open(url, polling_headers).read
+    File.write(DATA_JSON_PATH, payload)
+    puts "got #{payload.size} bytes"
+  end
+
+  environment = Liquid::Environment.build do |env|
+    env.register_filter(TRMNLPreview::LiquidFilters)
+  end
+
+  get '/' do
+    redirect '/full'
+  end
+
+  if config['strategy'] == 'webhook'
+    post '/webhook' do
+      body = request.body.read
+      File.write(DATA_JSON_PATH, body)
+      "OK"
+    end
+
+    puts "Listening for POSTs to /webhook"
+  end
+
+  VIEWS.each do |view|
+    get "/render/#{view}" do
+      path = File.join(USER_VIEWS_DIR, "#{view}.liquid")
+      unless File.exist?(path)
+        halt 404, "Plugin template not found: views/#{view}.liquid"
+      end
+
+      user_template = Liquid::Template.parse(File.read(path), environment: environment)
+
+      @view = view
+      erb :render_view do
+        data = JSON.parse(File.read(DATA_JSON_PATH))
+        data = { data: data } if data.is_a?(Array) # per TRMNL docs, bare array is wrapped in 'data' key
+
+        user_template.render(data)
+      end
+    end
+
+    get "/#{view}" do
+      @view = view
+      erb :index
+    end
+  end
+end

data/lib/trmnl_preview/liquid_filters.rb

@@ -0,0 +1,6 @@
+module TRMNLPreview::LiquidFilters
+  def number_with_delimiter(number)
+    # TODO: Replace with ActiveSupport's number_with_delimiter
+    number.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+  end
+end

data/lib/trmnl_preview/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TRMNLPreview
+  VERSION = "0.1.0"
+end

data/lib/trmnl_preview.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TRMNLPreview; end
+
+require_relative "trmnl_preview/app"
+require_relative "trmnl_preview/liquid_filters"
+require_relative "trmnl_preview/version"
+
+module TRMNLPreview
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/trmnl_preview.rbs

@@ -0,0 +1,4 @@
+module TRMNLPreview
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/trmnl_preview.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/trmnl_preview/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "trmnl_preview"
+  spec.version = TRMNLPreview::VERSION
+  spec.authors = ["Rockwell Schrock"]
+  spec.email = ["rockwell@schrock.me"]
+
+  spec.summary = "Local web server to preview TRMNL plugins"
+  spec.description = "Automatically rebuild and preview TRNML plugins in multiple views"
+  spec.homepage = "https://github.com/schrockwell/trmnl_preview"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/schrockwell/trmnl_preview"
+
+  # 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.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = ["trmnlp"]
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "sinatra", "~> 4.1"
+  spec.add_dependency "rackup", "~> 2.2"
+  spec.add_dependency "puma", "~> 6.5"
+  spec.add_dependency "liquid", "~> 5.6"
+  spec.add_dependency "toml-rb", "~> 3.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/views/index.erb

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>TRMNL Preview</title>
+    <style>
+        body {
+            font-family: sans-serif;
+            background: #eee;
+        }
+        .menu {
+            margin-bottom: 1em;
+        }
+        .menu a {
+            padding: 0.5em 1em;
+            background: #ddd;
+            border-radius: 0.5em;
+            display: inline-block;
+            text-decoration: none;
+            color: black;
+        }
+        .menu a:hover {
+            background: #ccc;
+        }
+        .menu a.active {
+            background: #333;
+            color: white;
+        }
+    </style>
+</head>
+<body>
+    <div class="menu">
+        <a class="<%= 'active' if @view == 'full' %>" href="/full">Full</a>
+        <a class="<%= 'active' if @view == 'half_horizontal' %>" href="/half_horizontal">Half Horizontal</a>
+        <a class="<%= 'active' if @view == 'half_vertical' %>" href="/half_vertical">Half Vertical</a>
+        <a class="<%= 'active' if @view == 'quadrant' %>" href="/quadrant">Quadrant</a>
+    </div>
+
+    <iframe src="/render/<%= @view %>" width="800" height="480"></iframe>
+</body>
+</html>

data/views/render_view.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link rel="stylesheet" href="https://usetrmnl.com/css/latest/plugins.css" />
+    <script src="https://usetrmnl.com/js/latest/plugins.js"></script>
+
+    <!-- Begin Inter font -->
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap" rel="stylesheet">
+    <!-- End Inter font -->
+  </head>
+  <body class="environment trmnl">
+    <div class="screen">
+      <div class="view view--<%= @view %>">
+        <%= yield %>
+      </div>
+    </div>
+  </body>
+</html>

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: trmnl_preview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rockwell Schrock
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-05 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: 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: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Automatically rebuild and preview TRNML plugins in multiple views
+email:
+- rockwell@schrock.me
+executables:
+- trmnlp
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/trmnlp
+- lib/trmnl_preview.rb
+- lib/trmnl_preview/app.rb
+- lib/trmnl_preview/liquid_filters.rb
+- lib/trmnl_preview/version.rb
+- sig/trmnl_preview.rbs
+- trmnl_preview.gemspec
+- views/index.erb
+- views/render_view.erb
+homepage: https://github.com/schrockwell/trmnl_preview
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/schrockwell/trmnl_preview
+  source_code_uri: https://github.com/schrockwell/trmnl_preview
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Local web server to preview TRMNL plugins
+test_files: []