trmnl_preview 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cee09b6deb0fc063e5358d6d636536513dc31cba86f0fe4e71ee4d2e1d3a7a5
-  data.tar.gz: 7b421d7ae1ace73b2e7370191e853946a857278f4f17332ace859bcf9581822a
+  metadata.gz: c67d7a534ea6adba08ab5b46d40f60ec8e505123136916ba98e43991c6877f58
+  data.tar.gz: 5a22288cb32a76b2b8cb8d8163a38c964736e6fd7c067da6f76f9fe8c7401ec1
 SHA512:
-  metadata.gz: 5d97a1e0f9c461796aa141b88d7c4c2826e2693764c5cdba9013260162b9dad16220b47bd49b36b2f8cbbaeb2c985d1851f3780b33326bd9f518f1d9604774eb
-  data.tar.gz: 16a38e4c92c20db294e80e6c729a3e7f12cdf5667785d80baabeb4ab93720a56b02a3346cb6efdae01d5d715b1919eab1d7fb4f34f40ffee2c7e96ce80158a69
+  metadata.gz: 9df016907e67d1cdc0b771299162b769c83b2bb2c7d9ab4b0e5bd77cf8db3f6a8f15db93ad4a00810e0fd224cb2e3dbee1876c9fe416854f26f239704a28537a
+  data.tar.gz: bc4e3d5c46fc64d25a3791c77c0e43af5a84875c2ad2853742e3ba31cf7a5bbdef5a548d92a4bab4b27b048e089eae4e712cd99eec43ad1ee0902f27e39a364c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.5.2
+
+- Added `time_zone` project config option, which is injected into `trmnl.user` variables
+- Fixed time zone to always be UTC, matching usetrmnl.com servers (#38)
+
 ## 0.5.1
 
 - Fixed `trmnl init`

data/README.md

@@ -22,6 +22,7 @@ This is the structure of a plugin project:
     ├── half_horizontal.liquid
     ├── half_vertical.liquid
     ├── quadrant.liquid
+    ├── shared.liquid
     └── settings.yml
 ```
 
@@ -94,6 +95,9 @@ watch:
 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:

data/bin/trmnlp

@@ -1,9 +1,12 @@
 #! /usr/bin/env ruby
 
-require "thor"
+require 'thor'
 
 require_relative '../lib/trmnlp/cli'
 
+# Force UTC to match usetrmnl.com server time zone
+ENV['TZ'] = 'UTC'
+
 begin
   TRMNLP::CLI.start
 rescue TRMNLP::Error => e

data/lib/markup/custom_liquid_filters.rb

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

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

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

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

data/lib/trmnlp/commands/login.rb

@@ -13,6 +13,7 @@ module TRMNLP
         
         api_key = prompt("API Key: ")
         raise Error, "API key cannot be empty" if api_key.empty?
+        raise Error, "Invalid API key; did you copy it from the right place?" unless api_key.start_with?("user_")
         
         config.app.api_key = api_key
         config.app.save

data/lib/trmnlp/config/project.rb

@@ -36,6 +36,8 @@ module TRMNLP
         Liquid::Template.parse(value).render(custom_fields_with_env)
       end
 
+      def time_zone = @config['time_zone'] || 'UTC'
+
       private
 
       # for interpolating ENV vars into custom_fields

data/lib/trmnlp/context.rb

@@ -1,3 +1,4 @@
+require 'active_support/time'
 require 'erb'
 require 'faraday'
 require 'filewatcher'
@@ -5,8 +6,8 @@ require 'json'
 require 'liquid'
 
 require_relative 'config'
-require_relative 'custom_filters'
 require_relative 'paths'
+require_relative '../markup/template'
 
 module TRMNLP
   class Context
@@ -121,7 +122,14 @@ module TRMNLP
       template_path = paths.template(view)
       return "Missing template: #{template_path}" unless template_path.exist?
 
-      user_template = Liquid::Template.parse(template_path.read, environment: liquid_environment)
+      shared_template_path = paths.shared_template
+      if shared_template_path.exist?
+        full_markup = shared_template_path.read + template_path.read
+      else
+        full_markup = template_path.read
+      end
+
+      user_template = Markup::Template.parse(full_markup, environment: liquid_environment)
       user_template.render(user_data)
     rescue StandardError => e
       e.message
@@ -159,6 +167,11 @@ module TRMNLP
     end
 
     def base_trmnl_data
+      tz = ActiveSupport::TimeZone.find_tzinfo(config.project.time_zone)
+      time_zone_iana = tz.name
+      time_zone_name = ActiveSupport::TimeZone::MAPPING.invert[time_zone_iana] || time_zone_iana
+      utc_offset = tz.utc_offset
+
       {
         'trmnl' => {
           'user' => {
@@ -166,9 +179,9 @@ module TRMNLP
             'first_name' => 'first_name',
             'last_name' => 'last_name',
             'locale' => 'en',
-            'time_zone' => 'Eastern Time (US & Canada)',
-            'time_zone_iana' => 'America/New_York',
-            'utc_offset' => -14400
+            'time_zone' => time_zone_name,
+            'time_zone_iana' => time_zone_iana,
+            'utc_offset' => utc_offset,
           },
           'device' => {
             'friendly_id' => 'ABC123',
@@ -194,7 +207,8 @@ module TRMNLP
 
     def liquid_environment
       @liquid_environment ||= Liquid::Environment.build do |env|
-        env.register_filter(CustomFilters)
+        env.register_filter(Markup::CustomLiquidFilters)
+        env.register_tag('template', Markup::TemplateTag)
 
         config.project.user_filters.each do |module_name, relative_path|
           require paths.root_dir.join(relative_path)

data/lib/trmnlp/paths.rb

@@ -36,6 +36,8 @@ module TRMNLP
     def plugin_config = src_dir.join('settings.yml')
       
     def template(view) = src_dir.join("#{view}.liquid")
+
+    def shared_template = template('shared')
       
     def app_config = app_config_dir.join('config.yml')
 

data/lib/trmnlp/version.rb

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

data/trmnl_preview.gemspec

@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   # HTML rendering
   spec.add_dependency "liquid", "~> 5.6"
   spec.add_dependency "activesupport", "~> 8.0"
+  spec.add_dependency "actionview", "~> 8.0"
 
   # BMP rendering
   spec.add_dependency "ferrum", "~> 0.16"
@@ -59,6 +60,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rubyzip", "~> 2.3.0"
   spec.add_dependency "thor", "~> 1.3"
   spec.add_dependency "oj", "~> 3.16.9"
+  spec.add_dependency "tzinfo-data", "~> 1.2025"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/web/public/index.css

@@ -34,51 +34,6 @@ menu a.active {
   color: white;
 }
 
-.case {
-  width: 1000px;
-  height: 680px;
-  position: relative;
-}
-
-iframe {
-  position: absolute;
-  border: none;
-  left: 98px;
-  top: 65px;
-  filter: grayscale(100%);
-}
-
-.case .case-overlay {
-  position: absolute;
-  width: 100%;
-  height: 100%;
-  top: 0;
-  left: 0;
-  background-size: cover;
-  mix-blend-mode: multiply;
-  pointer-events: none;
-}
-
-.case--none .case-overlay {
-  background: none;
-}
-
-.case--white .case-overlay {
-  background-image: url("white-case.jpg");
-}
-
-.case--black .case-overlay {
-  background-image: url("black-case.jpg");
-}
-
-.case--clear .case-overlay {
-  background-image: url("clear-case.jpg");
-}
-
-.case--none iframe {
-  border: 1px solid black;
-}
-
 .spinner {
   width: 22px;
   height: 22px;

data/web/public/index.js

@@ -11,7 +11,7 @@ trmnlp.connectLiveRender = function () {
     const payload = JSON.parse(msg.data);
 
     if (payload.type === "reload") {
-      trmnlp.setIframeSrc(trmnlp.iframe.src);
+      trmnlp.setFrameSrc(trmnlp.frame._src);
       trmnlp.userData.textContent = JSON.stringify(payload.user_data, null, 2);
     }
   };
@@ -22,9 +22,9 @@ trmnlp.connectLiveRender = function () {
   };
 };
 
-trmnlp.setCaseImage = function () {
+trmnlp.setFrameColor = function () {
   const value = trmnlp.caseSelect.value;
-  document.querySelector(".case").className = `case case--${value}`;
+  document.querySelector("trmnl-frame").setAttribute("color", value);
   localStorage.setItem("trmnlp-case", value);
 };
 
@@ -32,17 +32,17 @@ trmnlp.setPreviewFormat = function () {
   const value = trmnlp.formatSelect.value;
   localStorage.setItem("trmnlp-format", value);
 
-  trmnlp.setIframeSrc(`/render/${trmnlp.view}.${value}`);
+  trmnlp.setFrameSrc(`/render/${trmnlp.view}.${value}`);
 };
 
-trmnlp.setIframeSrc = function (src) {
+trmnlp.setFrameSrc = function (src) {
   document.querySelector(".spinner").style.display = "inline-block";
-  trmnlp.iframe.src = src;
+  trmnlp.frame.setSrc(src);
 };
 
 document.addEventListener("DOMContentLoaded", function () {
   trmnlp.view = document.querySelector("meta[name='trmnl-view']").content;
-  trmnlp.iframe = document.querySelector("iframe");
+  trmnlp.frame = document.querySelector("trmnl-frame");
   trmnlp.caseSelect = document.querySelector(".select-case");
   trmnlp.formatSelect = document.querySelector(".select-format");
   trmnlp.userData = document.getElementById("user-data");
@@ -58,7 +58,7 @@ document.addEventListener("DOMContentLoaded", function () {
 
   trmnlp.caseSelect.value = caseValue;
   trmnlp.caseSelect.addEventListener("change", () => {
-    trmnlp.setCaseImage();
+    trmnlp.setFrameColor();
   });
 
   trmnlp.formatSelect.value = formatValue;
@@ -66,10 +66,15 @@ document.addEventListener("DOMContentLoaded", function () {
     trmnlp.setPreviewFormat();
   });
 
-  trmnlp.iframe.addEventListener("load", () => {
+  trmnlp.frame._iframe.addEventListener("load", () => {
     document.querySelector(".spinner").style.display = "none";
+
+    // On page load, trmnl-frame loads "about:blank", so wait for that to load
+    // before updating the src to the preview.
+    if (trmnlp.frame._src === null) {
+      trmnlp.setPreviewFormat();
+    }
   });
 
-  trmnlp.setCaseImage();
-  trmnlp.setPreviewFormat();
+  trmnlp.setFrameColor();
 });