trmnl_preview 0.14.0 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e1959e442066534a715efcc371a9c7d4cb41c7dda22727712b12b7b1eb90af
-  data.tar.gz: fbf07c5d835d4981b0380ce774fdfb74edab699c16772e187776ba58a1aee152
+  metadata.gz: 2dabcf8ddd9b11d8ce8fc76e389820c7cd4f2d3b48db7aa7848896f9dfb6ec59
+  data.tar.gz: 467322fc910fdfed1ed5c37bb9773a7256d3d8f1f44683e2c9e4f3882b4ab7df
 SHA512:
-  metadata.gz: 8caa7eeef62cb562df06f7e0b3e1fcbf025cabe1f98fcda83fc365a0ee0fa9d8ce70fca9a3c16514a8ce3c320296c234e96e358d45cf3481e2b0451772e8866a
-  data.tar.gz: 01b1248e629516ab0c1857138807a27066f7b4e97be26024dd5e3365152d399e3e301fefcb864eb8e355546a5d5d6149f7c9851a345a3c8f09819099cd54c5bc
+  metadata.gz: 75747b93b8aa45ac964b1ae87ef0dd50134c836bf5bc4bef19e47f166132b1dfca6edf8744f967702be6ffdc4c80c7b9b725646443053708f2d74df37a8537e9
+  data.tar.gz: b6fa8f755ab31f3dae9a3c2773ced039f646c7363288ae27512d0e3a95e72143093ca2869cb26a402084dd1b66c6c2dfc29a022ef8fed84bbb6e18fa5ffed347

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 
 # Changelog
 
+## 0.14.2
+
+- A failed transform prints its stderr once. The `transform failed:` line repeated the whole stack trace that the `transform stderr:` line had just printed; it now names only the exit code. The preview page still shows the full error. (#148)
+- When a polling URL answers 401 and an OAuth account is connected, trmnlp refreshes the token and polls once more, as the hosted service does. Before, it refreshed only once the stored expiry had passed, so a token the provider revoked early kept failing until you reconnected. (#150)
+- A polling response that is not a 200 still reaches the markup and the transform, as on the hosted service, with a warning for a status outside 2xx. trmnlp replaced it with `{}`, so a transform that follows a 202 "pending job" body (`job_id`, `poll`) got nothing locally. (#146)
+- `trmnlp lint` reports bracketed Framework classes the Framework never generates, such as `w--[192px]` (sizes stop at 128px), `gap--[60px]` and `rounded--[51px]` (both stop at 50px), `h--[6cqw]` (height takes `cqh`) and, from 3.2.0, a screen-prefixed `md:gap--[20px]`. They match no CSS rule, so they do nothing: a flag sized `lg:w--[192px]` stayed at its smaller width on the X with no warning. The ranges are checked against every 3.x `plugins.css`, and plugins on Framework 2 or earlier are skipped, since v2 generated wider sizes. (#149)
+
+## 0.14.1
+
+- `trmnlp lint` reports a `recipe_overview` under 100 words. Below that, TRMNL serves the public recipe page with `robots: noindex`, so the recipe never appears in Google or other search engines, and nothing said so: the page looked fine, and only its HTML gave it away. A blank overview still passes, since private plugins have none. (#144)
+
 ## 0.14.0
 
 - `trmnlp serve` and `build` print what the transform writes to stdout and stderr (`console.log`, `print`, `puts`), one `transform stdout:` / `transform stderr:` line each, so a transform can be debugged without returning its logs in the data. (#128)

data/README.md

@@ -434,7 +434,7 @@ The `settings.yml` file is part of the plugin definition, and is uploaded and do
 
 `description:` is an optional one-line summary of the plugin, up to 35 characters. `trmnlp lint` reports anything longer, and `trmnlp list` shows it next to each plugin name.
 
-`recipe_overview:` is optional free text for a published recipe, with no length limit. TRMNL shows it on the public recipe page with its line breaks kept, and its first 120 characters feed the page's link preview. An overview of at least 100 words lets the recipe appear in Google and other search engines. Put credits and links in an About This Plugin field instead. Leave the key out to keep the overview already on TRMNL; an empty value clears it.
+`recipe_overview:` is optional free text for a published recipe, with no length limit. TRMNL shows it on the public recipe page with its line breaks kept, and its first 120 characters feed the page's link preview. An overview of at least 100 words lets the recipe appear in Google and other search engines; `trmnlp lint` reports one that is shorter. Put credits and links in an About This Plugin field instead. Leave the key out to keep the overview already on TRMNL; an empty value clears it.
 
 See [TRMNL documentation](https://help.trmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0) for details on this file's contents.
 

data/lib/trmnlp/lint/checks/arbitrary_values_in_range.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../check'
+
+module TRMNLP
+  module Lint
+    module Checks
+      # Reports bracketed Framework classes the Framework never generates, one
+      # finding per class. They match no rule, so they do nothing, and nothing
+      # says so: `lg:w--[192px]` leaves the element at its smaller width.
+      #
+      # The ranges mirror the loops in the Framework's utilities/_size.scss,
+      # _gap.scss and _rounded.scss, and hold for every 3.x release's
+      # plugins.css. v2 generated wider sizes, so earlier versions are skipped;
+      # prefixed gaps (`md:gap--[20px]`) existed until 3.2.0. There is no
+      # upstream file to sync from, so update this by hand when the Framework
+      # changes, the same way db/data/form_fields.yml is kept current.
+      class ArbitraryValuesInRange < Check
+        # Each family as written before the bracket: `w--[Npx]`, `w--max-[Npx]`.
+        SIZE_FAMILIES = %w[w-- h-- w--min- w--max- h--min- h--max-].freeze
+
+        # family => { unit => max }. Every range starts at 0 and steps by 1.
+        RANGES = SIZE_FAMILIES.to_h do |family|
+          [family, { 'px' => 128, (family.start_with?('w') ? 'cqw' : 'cqh') => 100 }]
+        end.merge('gap--' => { 'px' => 50 }, 'rounded--' => { 'px' => 50 }).freeze
+
+        # `gap--[Npx]` and `rounded--[Npx]` exist only without a screen prefix.
+        PREFIXABLE = SIZE_FAMILIES
+
+        FIRST_VERSION = Gem::Version.new('3.0.0')
+        UNPREFIXED_GAP_VERSION = Gem::Version.new('3.2.0')
+
+        PATTERN = /
+          (?<![\w:-])
+          (?<prefix>(?:[a-z0-9-]+:)*)
+          (?<family>w--min-|w--max-|h--min-|h--max-|w--|h--|gap--|rounded--)
+          \[(?<value>[\d.]+)(?<unit>[a-z]+)\]
+        /x
+
+        def issues
+          return [] if version < FIRST_VERSION
+
+          source.all_markup.scan(PATTERN).uniq.filter_map do |prefix, family, value, unit|
+            css_class = "#{prefix}#{family}[#{value}#{unit}]"
+            reason = problem(prefix, family, value, unit)
+            { message: "'#{css_class}' has no effect: #{reason}." } if reason
+          end
+        end
+
+        private
+
+        def version = @version ||= Gem::Version.new(source.framework_version.number)
+
+        def problem(prefix, family, value, unit)
+          max = RANGES.dig(family, unit)
+          return "the Framework has no '#{unit}' values for '#{family}'" unless max
+          return "'#{family}[Npx]' takes no screen prefix" if prefix_unsupported?(prefix, family)
+          return nil if value.match?(/\A\d+\z/) && value.to_i <= max
+
+          "the Framework generates '#{family}[N#{unit}]' from 0 to #{max} in whole numbers"
+        end
+
+        def prefix_unsupported?(prefix, family)
+          !prefix.empty? && !PREFIXABLE.include?(family) &&
+            (family == 'rounded--' || version >= UNPREFIXED_GAP_VERSION)
+        end
+      end
+    end
+  end
+end

data/lib/trmnlp/lint/checks/recipe_overview_length.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../check'
+
+module TRMNLP
+  module Lint
+    module Checks
+      # Below this many words the hosted service serves the public recipe page
+      # with `robots: noindex`, so search engines drop it. The overview is
+      # optional (private plugins never show one), so a blank value passes.
+      # Words are counted on whitespace; there is no upstream count to match.
+      class RecipeOverviewLength < Check
+        MIN_WORDS = 100
+        MESSAGE = "Recipe overview should be at least #{MIN_WORDS} words long " \
+                  'for the recipe page to appear in Google and other search engines.'.freeze
+
+        private
+
+        def pass?
+          words = source.recipe_overview.split.size
+          words.zero? || words >= MIN_WORDS
+        end
+      end
+    end
+  end
+end

data/lib/trmnlp/lint/source.rb

@@ -17,6 +17,8 @@ module TRMNLP
 
       def plugin_name = settings['name'].to_s
       def plugin_description = settings['description'].to_s
+      def recipe_overview = settings['recipe_overview'].to_s
+      def framework_version = config.plugin.framework_version
       def settings = config.plugin.settings
       def custom_field_values = config.project.custom_fields
       def custom_field_definitions = config.plugin.custom_field_definitions

data/lib/trmnlp/lint.rb

@@ -5,11 +5,13 @@ require_relative 'lint/source'
 require_relative 'lint/checks/title_casing'
 require_relative 'lint/checks/title_length'
 require_relative 'lint/checks/description_length'
+require_relative 'lint/checks/recipe_overview_length'
 require_relative 'lint/checks/layouts_have_content'
 require_relative 'lint/checks/no_async_functions'
 require_relative 'lint/checks/waits_for_dom_load'
 require_relative 'lint/checks/limited_inline_styles'
 require_relative 'lint/checks/no_size_classes'
+require_relative 'lint/checks/arbitrary_values_in_range'
 require_relative 'lint/checks/no_opacity'
 require_relative 'lint/checks/highcharts_animations_disabled'
 require_relative 'lint/checks/highcharts_elements_unique'
@@ -25,11 +27,13 @@ module TRMNLP
       Checks::TitleCasing,
       Checks::TitleLength,
       Checks::DescriptionLength,
+      Checks::RecipeOverviewLength,
       Checks::LayoutsHaveContent,
       Checks::NoAsyncFunctions,
       Checks::WaitsForDomLoad,
       Checks::LimitedInlineStyles,
       Checks::NoSizeClasses,
+      Checks::ArbitraryValuesInRange,
       Checks::NoOpacity,
       Checks::HighchartsAnimationsDisabled,
       Checks::HighchartsElementsUnique,

data/lib/trmnlp/oauth/session.rb

@@ -45,6 +45,12 @@ module TRMNLP
 
       def disconnect = token_store.clear
 
+      # For a token the provider rejected before its expiry. nil when there is nothing to refresh.
+      def force_refresh!
+        stored = token_store.read
+        refreshed(stored) if stored&.access_token && stored.refresh_token
+      end
+
       private
 
       attr_reader :provider, :token_store, :client

data/lib/trmnlp/poller.rb

@@ -43,21 +43,28 @@ module TRMNLP
     attr_reader :config, :paths, :oauth_session, :reporter
 
     def aggregate_responses
-      # Resolve once per poll (it refreshes as a side effect), then share across
-      # every URL, header, and body render.
-      oauth_variables = oauth_session.liquid_variables
-      urls = config.plugin.polling_urls(extra_variables: oauth_variables)
-      responses = urls.map { |url| fetch_one(url, oauth_variables) }
+      fetched = fetch_all
+      # Like the hosted service: a token rejected before its expiry gets one refresh and retry.
+      fetched = fetch_all if fetched.any? { |_url, response| response.status == 401 } && oauth_session.force_refresh!
+      responses = fetched.map { |url, response| parse_response(response, url) }
       return responses.first if responses.size == 1
 
       responses.each_with_index.with_object({}) { |(r, i), h| h["IDX_#{i}"] = r }
     end
 
+    def fetch_all
+      # Resolve once per attempt (it refreshes as a side effect), then share across
+      # every URL, header, and body render.
+      oauth_variables = oauth_session.liquid_variables
+      urls = config.plugin.polling_urls(extra_variables: oauth_variables)
+      urls.map { |url| [url, fetch_one(url, oauth_variables)] }
+    end
+
     def fetch_one(url, oauth_variables)
       verb = config.plugin.polling_verb.upcase
       response = perform_request(url, verb, oauth_variables)
       reporter.info("#{verb} #{url} — received #{response.body.length} bytes (#{response.status} status)")
-      parse_response(response)
+      response
     end
 
     def perform_request(url, verb, oauth_variables)
@@ -69,17 +76,13 @@ module TRMNLP
       end
     end
 
-    def parse_response(response)
-      return parse_failure(response.body) unless response.status == 200
-
+    # Like the hosted service: an error status is reported, but its body still reaches the data.
+    def parse_response(response, url)
+      success = (200..299).cover?(response.status)
+      reporter.info(reporter.yellow("warning: HTTP #{response.status} from #{url}")) unless success
       parse_body(response.body, response.headers['content-type'])
     end
 
-    def parse_failure(body)
-      reporter.info(body)
-      {}
-    end
-
     def parse_body(body, content_type_header)
       content_type = content_type_header&.split(';')&.first&.strip
       case content_type

data/lib/trmnlp/transform_pipeline.rb

@@ -55,7 +55,7 @@ module TRMNLP
 
     def record_failure(result, fallback)
       @error = result.error || "transform exited #{result.exit_code}: #{result.stderr.strip}"
-      reporter.info("transform failed: #{@error}")
+      reporter.info("transform failed: #{result.error || "exited #{result.exit_code}"}")
       fallback
     end
 

data/lib/trmnlp/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.2
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -304,6 +304,7 @@ files:
 - lib/trmnlp/image_quantizer.rb
 - lib/trmnlp/lint.rb
 - lib/trmnlp/lint/check.rb
+- lib/trmnlp/lint/checks/arbitrary_values_in_range.rb
 - lib/trmnlp/lint/checks/custom_fields_used.rb
 - lib/trmnlp/lint/checks/description_length.rb
 - lib/trmnlp/lint/checks/form_fields_valid.rb
@@ -315,6 +316,7 @@ files:
 - lib/trmnlp/lint/checks/no_async_functions.rb
 - lib/trmnlp/lint/checks/no_opacity.rb
 - lib/trmnlp/lint/checks/no_size_classes.rb
+- lib/trmnlp/lint/checks/recipe_overview_length.rb
 - lib/trmnlp/lint/checks/title_casing.rb
 - lib/trmnlp/lint/checks/title_length.rb
 - lib/trmnlp/lint/checks/waits_for_dom_load.rb