trmnl_preview 0.19.0 → 0.21.0

data/templates/init/bin/trmnlp

@@ -4,10 +4,23 @@
 # Use this opportunity to set up environment variables, install dependencies, etc.
 #
 
-if command -v trmnlp &> /dev/null
+# Saved on the PATH as `trmnlp`, this script is what `command -v trmnlp` finds: not a gem.
+GEM="$(command -v trmnlp)"
+if [ -n "$GEM" ] && ! [ "$GEM" -ef "$0" ]
 then
-    trmnlp "$@"
-    exit
+    exec "$GEM" "$@"
+fi
+
+if ! command -v docker &> /dev/null
+then
+    echo "Install the trmnl_preview gem:
+
+  gem install trmnl_preview
+
+Or install Docker:
+
+    https://docs.docker.com/get-docker/"
+    exit 1
 fi
 
 # Determine XDG config directory on host OS
@@ -17,28 +30,64 @@ else
     CONFIG_DIR="$HOME/.config/trmnlp"
 fi
 
-if [ ! -d "$CONFIG_DIR" ]; then
-    mkdir -p "$CONFIG_DIR"
+# What trmnlp caches is kept as well: a plugin's OAuth tokens, its saved data and transform state.
+CACHE_DIR="${XDG_CACHE_HOME:-$HOME/.cache}/trmnl"
+
+mkdir -p "$CONFIG_DIR" "$CACHE_DIR"
+
+# Add a tag to stay on one release: trmnl/trmnlp:v0.20.0
+IMAGE=trmnl/trmnlp
+
+# A newer release is pulled once a day. With no network, the image already here runs.
+PULLED_AT="$CACHE_DIR/image_pulled"
+if [ -z "$(find "$PULLED_AT" -mtime -1 2> /dev/null)" ]; then
+    docker pull --quiet "$IMAGE" > /dev/null 2>&1
+    touch "$PULLED_AT"
 fi
 
-if command -v docker &> /dev/null
+# On Linux the container's root is the host's root, and the files trmnlp writes (snapshots, _build,
+# a pulled plugin) would be root's. So trmnlp runs as you, with a home of its own to write in.
+# Docker Desktop and rootless Docker hand the files to you already.
+CONTAINER_HOME=/root
+SECURITY="$(docker info --format '{{.SecurityOptions}}' 2> /dev/null)"
+if [ "$(uname)" = Linux ] && [ "$(id -u)" != 0 ] && [ -n "$SECURITY" ] && [[ "$SECURITY" != *rootless* ]]
 then
-    docker run \
-        -it \
-        --rm \
-        --publish 4567:4567 \
-        --volume "$(pwd):/plugin" \
-        --volume "$CONFIG_DIR:/root/.config/trmnlp" \
-        trmnl/trmnlp "$@"
-    exit
+    CONTAINER_HOME=/tmp/home
+    # .config and .cache are made for you as well: Docker would make them root's to mount the
+    # folders below into them, and Firefox hangs when it cannot write there.
+    ARGS=(
+        --user "$(id -u):$(id -g)"
+        --env HOME=/tmp/home
+        --tmpfs "/tmp/home:exec,uid=$(id -u),gid=$(id -g)"
+        --tmpfs "/tmp/home/.config:uid=$(id -u),gid=$(id -g)"
+        --tmpfs "/tmp/home/.cache:exec,uid=$(id -u),gid=$(id -g)"
+    )
 fi
 
-echo "Install the trmnl_preview gem:
-
-  gem install trmnl_preview
-
-Or install Docker:
+# A terminal only when there is one: CI and scripts have none.
+if [ -t 0 ] && [ -t 1 ]; then
+    ARGS+=(--tty)
+fi
 
-    https://docs.docker.com/get-docker/"
+# Only serve listens, so every other command can run next to it.
+if [ "$1" = serve ]; then
+    PORT=4567
+    for ARG in "$@"; do
+        case "$PREVIOUS" in -p | --port) PORT="$ARG" ;; esac
+        case "$ARG" in --port=*) PORT="${ARG#--port=}" ;; esac
+        PREVIOUS="$ARG"
+    done
+    ARGS+=(--publish "$PORT:$PORT")
+fi
 
-exit 1
+exec docker run \
+    --rm \
+    --init \
+    --interactive \
+    "${ARGS[@]}" \
+    --env CI \
+    --env TRMNL_API_KEY \
+    --volume "$CONFIG_DIR:$CONTAINER_HOME/.config/trmnlp" \
+    --volume "$CACHE_DIR:$CONTAINER_HOME/.cache/trmnl" \
+    --volume "$(pwd):/plugin" \
+    "$IMAGE" "$@"

data/templates/init/tests/plugin_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'My Plugin' do
   # The values of the custom fields in src/settings.yml to test with.
   let(:custom_fields) { {} }
 
-  # Every view on TRMNL's devices, a failing API and every select option, checked for overflow and errors.
+  # Every view on TRMNL's devices, a failing API and every select option, checked for page errors and leaked values.
   it_behaves_like 'a publishable recipe'
 
   # A picture of the full view, compared pixel for pixel on every run. Record it once with

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -433,6 +433,7 @@ files:
 - lib/trmnlp/lint/checks/no_custom_filters.rb
 - lib/trmnlp/lint/checks/no_opacity.rb
 - lib/trmnlp/lint/checks/no_size_classes.rb
+- lib/trmnlp/lint/checks/no_unknown_filters.rb
 - lib/trmnlp/lint/checks/recipe_overview_length.rb
 - lib/trmnlp/lint/checks/title_casing.rb
 - lib/trmnlp/lint/checks/title_length.rb
@@ -450,7 +451,7 @@ files:
 - lib/trmnlp/outbound_request.rb
 - lib/trmnlp/paths.rb
 - lib/trmnlp/poller.rb
-- lib/trmnlp/qr_code_intrinsic_size.rb
+- lib/trmnlp/qr_code.rb
 - lib/trmnlp/rails_helpers.rb
 - lib/trmnlp/renderer.rb
 - lib/trmnlp/reporter.rb
@@ -462,13 +463,14 @@ files:
 - lib/trmnlp/testing/certificate_authority.rb
 - lib/trmnlp/testing/device_models.rb
 - lib/trmnlp/testing/frozen_clock.rb
-- lib/trmnlp/testing/inline_stylesheets.rb
 - lib/trmnlp/testing/memory_sampler.rb
 - lib/trmnlp/testing/mock_proxy.rb
 - lib/trmnlp/testing/mock_table.rb
 - lib/trmnlp/testing/node_version.rb
+- lib/trmnlp/testing/page_server.rb
 - lib/trmnlp/testing/plugin.rb
 - lib/trmnlp/testing/publishable_recipe.rb
+- lib/trmnlp/testing/qr_scanner.rb
 - lib/trmnlp/testing/report.html.erb
 - lib/trmnlp/testing/report.rb
 - lib/trmnlp/testing/rspec.rb
@@ -482,6 +484,7 @@ files:
 - lib/trmnlp/transform_client.rb
 - lib/trmnlp/transform_pipeline.rb
 - lib/trmnlp/transform_state.rb
+- lib/trmnlp/update_check.rb
 - lib/trmnlp/user_data_assembler.rb
 - lib/trmnlp/version.rb
 - lib/trmnlp/watcher.rb

data/lib/trmnlp/qr_code_intrinsic_size.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'trmnl/liquid'
-
-module TRMNLP
-  # Mirrors core's config/initializers/trmnl_liquid_qr_code_intrinsic_size.rb: a view box alone
-  # gives the code no size of its own, so it renders at zero width in a shrink-to-fit container.
-  module QrCodeIntrinsicSize
-    def qr_code(data, size = 11, level = '', view = 'responsive')
-      svg = super
-      root_element = svg[/<svg[^>]*>/].to_s
-      return svg if root_element.include?('width=')
-
-      side_length = root_element[/viewBox="0 0 (\d+)/, 1]
-      return svg unless side_length
-
-      svg.sub('<svg ', %(<svg width="#{side_length}" height="#{side_length}" style="max-width:100%;height:auto" ))
-    end
-  end
-end
-
-TRMNL::Liquid::Filters.prepend(TRMNLP::QrCodeIntrinsicSize)

data/lib/trmnlp/testing/inline_stylesheets.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-require 'uri'
-
-module TRMNLP
-  module Testing
-    # Puts a page's linked stylesheets in the page itself. A page written with document.write, as TRMNL and
-    # trmnlp write theirs, runs its scripts without waiting for linked stylesheets, so a script that
-    # measures text (a layout solver, say) raced them and drew a different board from run to run.
-    module InlineStylesheets
-      LINK = /<link\b[^>]*\brel=["']stylesheet["'][^>]*>/i
-      SCRIPT = %r{<script\b.*?</script>}im
-      HREF = /\bhref=["'](https?:[^"']+)["']/i
-      CSS_URL = /url\(\s*(['"]?)(?!data:|https?:|#)([^'")]+)\1\s*\)/i
-
-      module_function
-
-      def call(html)
-        html.gsub(Regexp.union(SCRIPT, LINK)) do |tag|
-          next tag if tag.match?(/\A<script/i)
-
-          url = tag[HREF, 1]
-          css = url && stylesheet(url)
-          css ? "<style data-href=\"#{url}\">#{css}</style>" : tag
-        end
-      end
-
-      # nil when the stylesheet cannot be fetched: the page keeps its link.
-      def stylesheet(url)
-        cache.fetch(url) do
-          response = Faraday.get(url)
-          cache[url] = response.success? ? absolute_urls(response.body, url) : nil
-        end
-      rescue Faraday::Error
-        nil
-      end
-
-      def absolute_urls(css, base) = css.gsub(CSS_URL) { "url(\"#{URI.join(base, Regexp.last_match(2))}\")" }
-
-      def cache = @cache ||= {}
-    end
-  end
-end