pandorga 1.11.0 → 1.13.0

data/lib/pandorga/thumbnail_variants.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+require "date"
+require "fileutils"
+require "open3"
+require "pathname"
+require "set"
+require "time"
+require "yaml"
+
+require_relative "registry"
+
+module Pandorga
+  # Generates 16:9 center-cropped width variants for local project thumbnails
+  # and computes their srcset strings.
+  # Refs: PLT-AC-44
+  module ThumbnailVariants
+    WIDTHS = [480, 960, 1440].freeze
+    IMAGE_EXTENSIONS = %w[.jpg .jpeg .png .webp].freeze
+    QUALITY = 82
+
+    module_function
+
+    def generate(site_root)
+      root = Pathname.new(site_root).expand_path
+      content_root = resolve_content_root(root)
+      sources = project_thumbnail_sources(root, content_root)
+
+      summary = { sources: sources.length, written: 0, skipped: 0, failed: 0 }
+      return summary if sources.empty?
+
+      bins = resolve_imagemagick
+      unless bins
+        warn "warning: ImageMagick (magick or convert) not found; skipping project thumbnail variants"
+        return summary
+      end
+
+      sources.each do |src|
+        src_width = identify_width(bins[:identify], src)
+        unless src_width && src_width.positive?
+          # An unreadable image keeps its original and must not stop the export.
+          warn "warning: cannot read #{src}; skipping its thumbnail variants"
+          summary[:failed] += 1
+          next
+        end
+
+        stem = src.basename(src.extname).to_s
+        variants_dir = src.dirname.join("variants")
+        src_mtime = src.mtime
+
+        WIDTHS.each do |width|
+          if width > src_width
+            summary[:skipped] += 1
+            next
+          end
+
+          dest = variants_dir.join("#{stem}-#{width}.jpg")
+          if dest.file? && dest.mtime >= src_mtime
+            summary[:skipped] += 1
+            next
+          end
+
+          begin
+            write_variant(bins[:convert], src, dest, width)
+            summary[:written] += 1
+          rescue StandardError => e
+            warn "warning: #{e.message.lines.first.to_s.strip}; keeping the original only"
+            summary[:failed] += 1
+          end
+        end
+      end
+
+      summary
+    end
+
+    def srcset_for(site_root, thumbnail_path)
+      media_rel = normalize_local_media_path(thumbnail_path)
+      return nil unless media_rel
+
+      ext = File.extname(media_rel).downcase
+      return nil unless IMAGE_EXTENSIONS.include?(ext)
+
+      root = Pathname.new(site_root).expand_path
+      content_root = resolve_content_root(root)
+      src = content_root.join(media_rel.delete_prefix("/"))
+      return nil unless src.file?
+
+      stem = src.basename(src.extname).to_s
+      variants_dir = src.dirname.join("variants")
+      return nil unless variants_dir.directory?
+
+      url_dir = File.dirname(media_rel)
+      parts = WIDTHS.filter_map do |width|
+        variant = variants_dir.join("#{stem}-#{width}.jpg")
+        next unless variant.file?
+
+        "#{url_dir}/variants/#{stem}-#{width}.jpg #{width}w"
+      end
+      return nil if parts.empty?
+
+      parts.join(", ")
+    end
+
+    def resolve_content_root(root)
+      candidate = root.join("content")
+      return candidate if candidate.directory?
+      return root if root.join("collections").directory? || root.join("media").directory?
+
+      candidate
+    end
+
+    def project_collections(root)
+      config_path = root.join("_config.yml")
+      config = if config_path.file?
+                 YAML.safe_load(config_path.read, permitted_classes: [Date, Time], aliases: true) || {}
+               else
+                 {}
+               end
+      pages = PandorgaRegistry.pages(config)
+      names = pages.filter_map do |page|
+        next unless page.is_a?(Hash) && page["template"].to_s == "portfolio"
+
+        col = page["collection"].to_s.strip
+        col = page.dig("collections", "projects").to_s.strip if col.empty? && page["collections"].is_a?(Hash)
+        col unless col.empty?
+      end.uniq
+      names.empty? ? ["projects"] : names
+    rescue StandardError
+      ["projects"]
+    end
+
+    def project_thumbnail_sources(root, content_root)
+      seen = Set.new
+      sources = []
+
+      project_collections(root).each do |collection|
+        dir = content_root.join("collections", collection)
+        next unless dir.directory?
+
+        dir.glob("**/*.{md,markdown}").sort.each do |md_path|
+          fm = read_front_matter(md_path)
+          next if fm["published"] == false && ENV["CONTENT_EXPORT_INCLUDE_UNPUBLISHED"] != "1"
+
+          media_rel = normalize_local_media_path(fm["thumbnail"])
+          next unless media_rel
+          next unless IMAGE_EXTENSIONS.include?(File.extname(media_rel).downcase)
+
+          src = content_root.join(media_rel.delete_prefix("/"))
+          next unless src.file?
+
+          key = src.expand_path.to_s
+          next if seen.include?(key)
+
+          seen << key
+          sources << src
+        end
+      end
+
+      sources
+    end
+
+    def normalize_local_media_path(path)
+      value = path.to_s.strip
+      return nil if value.empty?
+      return nil if value.match?(%r{\Ahttps?://}i)
+
+      if value.start_with?("/content/media/")
+        "/media/#{value.delete_prefix("/content/media/")}"
+      elsif value.start_with?("content/media/")
+        "/media/#{value.delete_prefix("content/media/")}"
+      elsif value.start_with?("/media/")
+        value
+      elsif value.start_with?("media/")
+        "/#{value}"
+      end
+    end
+
+    def read_front_matter(path)
+      text = path.read.sub(/\A\xEF\xBB\xBF/, "")
+      return {} unless text.start_with?("---\n") || text.start_with?("---\r\n")
+
+      parts = text.split(/^---\s*$\r?\n?/, 3)
+      return {} unless parts.length == 3
+
+      YAML.safe_load(parts[1], permitted_classes: [Date, Time], aliases: true) || {}
+    rescue StandardError
+      {}
+    end
+
+    def resolve_imagemagick
+      override = ENV["PANDORGA_IMAGEMAGICK"].to_s.strip
+      unless override.empty?
+        return nil unless executable_available?(override)
+
+        return {
+          convert: [override],
+          identify: File.basename(override) == "magick" ? [override, "identify"] : [ resolve_companion_identify(override) ]
+        }
+      end
+
+      if executable_available?("magick")
+        { convert: ["magick"], identify: ["magick", "identify"] }
+      elsif executable_available?("convert") && executable_available?("identify")
+        { convert: ["convert"], identify: ["identify"] }
+      end
+    end
+
+    def resolve_companion_identify(convert_bin)
+      sibling = File.join(File.dirname(convert_bin), "identify")
+      return sibling if File.executable?(sibling) && !File.directory?(sibling)
+
+      "identify"
+    end
+
+    def executable_available?(bin)
+      return false if bin.to_s.empty?
+
+      if bin.include?("/")
+        File.executable?(bin) && !File.directory?(bin)
+      else
+        ENV.fetch("PATH", "").split(File::PATH_SEPARATOR).any? do |dir|
+          next false if dir.empty?
+
+          candidate = File.join(dir, bin)
+          File.executable?(candidate) && !File.directory?(candidate)
+        end
+      end
+    end
+
+    def identify_width(identify_cmd, src)
+      cmd = [*identify_cmd, "-ping", "-format", "%w", "#{src}[0]"]
+      out, _err, status = Open3.capture3(*cmd)
+      return nil unless status.success?
+
+      out.to_s.strip.to_i
+    rescue StandardError
+      nil
+    end
+
+    def write_variant(convert_cmd, src, dest, width)
+      height = (width * 9) / 16
+      FileUtils.mkdir_p(dest.dirname)
+      tmp = dest.dirname.join(".#{dest.basename}.tmp-#{Process.pid}")
+      cmd = [
+        *convert_cmd,
+        "#{src}[0]",
+        "-auto-orient",
+        "-resize", "#{width}x#{height}^",
+        "-gravity", "center",
+        "-extent", "#{width}x#{height}",
+        "-strip",
+        "-interlace", "JPEG",
+        "-sampling-factor", "4:2:0",
+        "-quality", QUALITY.to_s,
+        "jpeg:#{tmp}"
+      ]
+      out, err, status = Open3.capture3(*cmd)
+      unless status.success? && tmp.file?
+        FileUtils.rm_f(tmp)
+        raise "ImageMagick failed for #{src} (#{width}w): #{out}\n#{err}"
+      end
+      File.rename(tmp.to_s, dest.to_s)
+    ensure
+      FileUtils.rm_f(tmp) if tmp && tmp.exist?
+    end
+  end
+end

data/lib/pandorga/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pandorga
-  VERSION = "1.11.0"
+  VERSION = "1.13.0"
 end

data/lib/pandorga.rb

@@ -14,6 +14,7 @@ module Pandorga
 end
 
 require_relative "pandorga/registry"
+require_relative "pandorga/thumbnail_variants"
 
 # Jekyll loads this file as a plugin when `plugins: [pandorga]`.
 require_relative "pandorga/jekyll" if defined?(Jekyll)

data/scripts/content/export-content-json.rb

@@ -21,6 +21,7 @@ require_relative "../lib/content_license"
 require_relative "../lib/writing_index_contract"
 require_relative "band_art"
 require_relative "hero_portraits"
+require_relative "../../lib/pandorga/thumbnail_variants"
 
 REPO_ROOT = Pathname.new(ENV.fetch("PANDORGA_SITE_ROOT", Dir.pwd)).expand_path
 CONTENT_ROOT = Pathname.new(ARGV[0] || "content").expand_path
@@ -121,6 +122,16 @@ def rewrite_media_references(text)
   rewrite_media_attribute_paths(rewrite_markdown_media_paths(text))
 end
 
+def rewrite_srcset_media_urls(srcset)
+  return nil unless srcset.is_a?(String) && !srcset.strip.empty?
+
+  srcset.split(",").map do |candidate|
+    url, descriptor = candidate.strip.split(/\s+/, 2)
+    resolved = resolve_media_url(url)
+    descriptor ? "#{resolved} #{descriptor}" : resolved
+  end.join(", ")
+end
+
 def rewrite_front_matter_media!(front_matter)
   return front_matter unless front_matter.is_a?(Hash)
 
@@ -360,6 +371,11 @@ def export_markdown_tree(source_dir, output_dir, type)
     end
 
     apply_git_chronology!(front_matter, repo_relative_path, type)
+    if type == "project"
+      raw_srcset = Pandorga::ThumbnailVariants.srcset_for(REPO_ROOT, front_matter["thumbnail"])
+      rewritten_srcset = rewrite_srcset_media_urls(raw_srcset)
+      front_matter["thumbnail_srcset"] = rewritten_srcset if rewritten_srcset
+    end
     rewrite_front_matter_media!(front_matter)
 
     if ContentKeys::KEYED_TYPES.include?(type)
@@ -594,7 +610,7 @@ def writing_index_entry_from_export(payload, content_root, collection)
   end
 
   legacy = File.basename(source_path, File.extname(source_path))
-  {
+  entry = {
     "slug" => slug,
     "key" => key,
     "title" => title,
@@ -630,6 +646,9 @@ def writing_index_entry_from_export(payload, content_root, collection)
       "path_segment" => slug
     )
   }
+  exported_srcset = payload.dig("front_matter", "thumbnail_srcset").to_s
+  entry["thumbnail_srcset"] = exported_srcset unless exported_srcset.empty?
+  entry
 end
 
 def export_derived_data(content_root, output_root)
@@ -710,6 +729,8 @@ def export_collection_trees
   trees
 end
 
+Pandorga::ThumbnailVariants.generate(REPO_ROOT)
+
 files = export_collection_trees
 files["page_fragments"] = export_page_fragments(CONTENT_ROOT.join("pages"), OUTPUT_ROOT.join("pages"))
 files["page_headers"] = export_page_headers(CONTENT_ROOT, OUTPUT_ROOT) << export_hero_portraits(CONTENT_ROOT, OUTPUT_ROOT)

data/scripts/test/fixtures/studio-taxonomy/page-local/_config.yml

@@ -0,0 +1,9 @@
+pandorga:
+  pages:
+    - key: articles
+      template: articles
+      collection: articles
+      path: /pages/articles/
+      taxonomy:
+        tags: [Notes]
+        max: 1

data/scripts/test/fixtures/studio-taxonomy/top-level/_config.yml

@@ -0,0 +1,9 @@
+pandorga:
+  taxonomies:
+    articles:
+      tags: [Design, Organizations]
+      max: 2
+      min: 1
+    posts:
+      tags: [alpha, beta, gamma]
+      max: 3

data/scripts/test/test-poster-srcset.mjs

@@ -0,0 +1,159 @@
+#!/usr/bin/env node
+// Refs: PLT-AC-44
+// Executes the real renderPosterMedia sliced out of
+// _includes/content-runtime/43-blocks.html rather than a copy of it.
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..');
+const utilsSource = fs.readFileSync(
+  path.join(root, '_includes/content-runtime/10-utils.html'),
+  'utf8'
+);
+const blocksSource = fs.readFileSync(
+  path.join(root, '_includes/content-runtime/43-blocks.html'),
+  'utf8'
+);
+
+const escStart = utilsSource.indexOf('function escapeHtml');
+const escEnd = utilsSource.indexOf('function shellOrigin');
+if (escStart < 0 || escEnd <= escStart) {
+  console.error('FAIL test-poster-srcset: escapeHtml/escapeAttr missing from 10-utils.html');
+  process.exit(1);
+}
+const escSlice = utilsSource.slice(escStart, escEnd);
+
+const posterStart = blocksSource.indexOf('function renderPosterMedia');
+const posterEnd = blocksSource.indexOf('function twoDigits');
+if (posterStart < 0 || posterEnd <= posterStart) {
+  console.error('FAIL test-poster-srcset: renderPosterMedia missing from 43-blocks.html');
+  process.exit(1);
+}
+const posterSlice = blocksSource.slice(posterStart, posterEnd);
+
+const renderPosterMedia = new Function(
+  `${escSlice}\n${posterSlice}\nreturn renderPosterMedia;`
+)();
+
+let failed = 0;
+
+function check(condition, message) {
+  if (!condition) {
+    console.error(`FAIL test-poster-srcset: ${message}`);
+    failed += 1;
+  }
+}
+
+function same(got, expected, message) {
+  check(got === expected, `${message}: got ${JSON.stringify(got)}, want ${JSON.stringify(expected)}`);
+}
+
+// 1. Without srcset/sizes: byte-identical to today's output
+const expectedPlain = [
+  '<div class="ledger-poster">',
+  '<img src="/media/images/covers/wide.jpg" alt="Wide Project" loading="lazy" decoding="async"',
+  ' onerror="var p=this.closest(\'.ledger-poster\'); if (p) p.remove();">',
+  '</div>'
+].join('');
+
+same(
+  renderPosterMedia('/media/images/covers/wide.jpg', 'Wide Project'),
+  expectedPlain,
+  'plain image without options'
+);
+same(
+  renderPosterMedia('/media/images/covers/wide.jpg', 'Wide Project', {}),
+  expectedPlain,
+  'plain image with empty options'
+);
+same(
+  renderPosterMedia('/media/images/covers/wide.jpg', 'Wide Project', {
+    srcset: '   ',
+    sizes: '(min-width: 900px) 35vw, 100vw'
+  }),
+  expectedPlain,
+  'empty srcset omits both srcset and sizes'
+);
+
+// 2. With srcset + sizes: img has src = original, srcset and sizes attributes (escaped)
+const srcsetVal = '/media/images/covers/variants/wide-480.jpg 480w, /media/images/covers/variants/wide-960.jpg 960w';
+const sizesVal = '(min-width: 900px) 35vw, 100vw';
+const withSrcset = renderPosterMedia('/media/images/covers/wide.jpg', 'Wide "Quote"', {
+  srcset: srcsetVal,
+  sizes: sizesVal
+});
+
+const expectedWithSrcset = [
+  '<div class="ledger-poster">',
+  '<img src="/media/images/covers/wide.jpg"',
+  ' srcset="/media/images/covers/variants/wide-480.jpg 480w, /media/images/covers/variants/wide-960.jpg 960w"',
+  ' sizes="(min-width: 900px) 35vw, 100vw"',
+  ' alt="Wide &quot;Quote&quot;" loading="lazy" decoding="async"',
+  ' onerror="var p=this.closest(\'.ledger-poster\'); if (p) p.remove();">',
+  '</div>'
+].join('');
+
+same(withSrcset, expectedWithSrcset, 'image with srcset and sizes');
+
+// Escaping inside srcset and sizes
+const escaped = renderPosterMedia('/media/a.jpg', 'Alt', {
+  srcset: '/media/a.jpg?x=1&y="2" 480w',
+  sizes: '(max-width: 600px) 100vw, "50vw"'
+});
+check(
+  escaped.includes('srcset="/media/a.jpg?x=1&amp;y=&quot;2&quot; 480w"'),
+  'srcset attribute is escaped'
+);
+check(
+  escaped.includes('sizes="(max-width: 600px) 100vw, &quot;50vw&quot;"'),
+  'sizes attribute is escaped'
+);
+
+// 3. Video URLs ignore srcset and sizes
+const expectedVideo = [
+  '<div class="ledger-poster">',
+  '<video src="/media/clips/demo.mp4" controls preload="none" ',
+  'playsinline aria-label="Demo"></video>',
+  '</div>'
+].join('');
+
+same(
+  renderPosterMedia('/media/clips/demo.mp4', 'Demo', {
+    srcset: srcsetVal,
+    sizes: sizesVal
+  }),
+  expectedVideo,
+  'video URL ignores srcset and sizes'
+);
+
+// 4. Inspect 43-blocks.html call sites for renderSystemCard and renderProjectSpecimen
+const sysCardStart = blocksSource.indexOf('function renderSystemCard');
+const sysCardEnd = blocksSource.indexOf('function renderProjectLinks');
+const specStart = blocksSource.indexOf('function renderProjectSpecimen');
+check(sysCardStart > 0 && sysCardEnd > sysCardStart, 'renderSystemCard found in 43-blocks.html');
+check(specStart > 0, 'renderProjectSpecimen found in 43-blocks.html');
+
+const sysCardBody = blocksSource.slice(sysCardStart, sysCardEnd);
+const specBody = blocksSource.slice(specStart);
+
+check(
+  sysCardBody.includes('renderPosterMedia') &&
+    sysCardBody.includes('fm.thumbnail_srcset') &&
+    sysCardBody.includes('sizes'),
+  'renderSystemCard passes fm.thumbnail_srcset and sizes to renderPosterMedia'
+);
+
+check(
+  specBody.includes('renderPosterMedia') &&
+    specBody.includes('fm.thumbnail_srcset') &&
+    specBody.includes('sizes'),
+  'renderProjectSpecimen passes fm.thumbnail_srcset and sizes to renderPosterMedia'
+);
+
+if (failed) {
+  console.error(`test-poster-srcset: ${failed} failure(s)`);
+  process.exit(1);
+}
+console.log('PASS test-poster-srcset');