Generate & display image/PDF thumbnails for topic documents (put image_processing to use)
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 66/100
- issue の種類
- 機能追加
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 領域
- devops, full-stack, testing-qa
調査の方向性
Gemfile:13、app/views/topics/_topic.html.erb:17-38、app/helpers/topics_helper.rb から始め、topic ドキュメントの添付ファイル宣言と既存の Active Storage 設定を見つけます。完了条件は、表示可能な画像と PDF が、元のファイルへリンクするキャッシュ済みの 256x256 サムネイルを表示し、それ以外のプレビューやプレビューに失敗した場合は汎用アイコンを維持することです。必要なシステム依存関係を確認し、variant と fallback のケースのカバレッジを追加してください。
索引モデルが issue の本文から書いたものです。
説明
Background
The image_processing gem (Gemfile:13, ~> 1.14) is declared and locked (pulling in mini_magick + ruby-vips) but nothing in the app actually uses it — no Active Storage variants, previews, or representations anywhere in app/, app/views/, or config/. Topic documents are rendered as their original blobs only:
app/views/topics/_topic.html.erb:17-38— the Documents section shows a generic file icon + filename link + Download button for every document, regardless of type.app/helpers/topics_helper.rb—card_preview_mediaembeds the full-size original.
Rather than drop the gem, this issue puts it to work: generate small thumbnails for image and PDF documents and show them on the topic show page, falling back to the current icon for everything else.
This is a deliberately small, self-contained first slice. The nicer-but-heavier version (click-to-enlarge lightbox, eagerly generated variants) is captured under Future enhancements below and should be a separate follow-up.
Approach: lazy generation
Variants are generated lazily on first request (Active Storage's default) and cached. This is what keeps the task small:
- No background job — no async infrastructure to build.
- No backfill — lazy generation is the on-demand backfill. Existing documents get a thumbnail the first time someone views the topic; new ones the same way. Nothing is precomputed, so there's no "old documents lack a variant" gap and no migration/rake task.
- No conditional-on-present logic — we simply render
representation(:thumb)for representable documents and fall back to the icon for the rest.
Proposed work
1. Wiring — declare a :thumb variant on the attachment
Resize to 256x256.
- Covers raster images directly. For PDFs, use the unified
representation(:thumb)API, which routes images throughvariantand PDFs throughpreview(first page → image → resize). - Confirm
config.active_storage.variant_processor = :vips(default;ruby-vipsis already locked, so no ImageMagick dependency needed for images).
2. UI — thumbnail on the topic show page
In app/views/topics/_topic.html.erb, in the per-document block (lines 18-37), render the thumbnail in place of the generic SVG icon for representable documents, wrapped in a plain link that opens the original inline (new tab). Keep the filename link, size, and Download button exactly as they are.
3. System dependencies
- Image variants: libvips (already implied by
ruby-vips). - PDF previews:
poppler-utils(pdftoppm) ormupdfmust be present in CI and the deploy/Docker images, or PDF thumbnails fail (and fall back to the icon). webp/avif/svgsupport depends on how libvips is built. Recommend excludingimage/svg+xmlfrom thumbnail generation (vector; rasterizing needs librsvg and adds little value) and verifying webp/avif on the target image before shipping.
Acceptance criteria
- An image document on a topic shows a thumbnail on the topic show page (generated on first view, cached after).
- A PDF document shows a first-page thumbnail.
- Clicking a thumbnail opens the original image/PDF inline in a new tab.
- Non-representable types (video/audio/other) and any document whose preview can't be generated fall back to the current generic icon — no errors.
- Required system dependencies (libvips, poppler/mupdf) are available in CI and deploy images.
- Tests cover: the
:thumbvariant is declared, the view renders a thumbnail for representable documents, and non-representable documents render the fallback icon.
Known tradeoffs (acceptable for a nonessential feature)
- First-view latency — the first person to view a topic with a large image/PDF waits while the thumbnail generates; cached thereafter.
- No proactive backfill — existing documents get thumbnails on first view rather than ahead of time. This is intentional.
Future enhancements (separate follow-up)
A nicer interaction, deferred to keep this task small. It can be added later with no backfill and no confusing UI change, because lazy generation makes any new variant available uniformly for all documents (old and new) the moment its consumer ships — so every thumbnail behaves the same, and the click target simply upgrades from "open in new tab" to "open lightbox":
- Add a
:mediumvariant (e.g.resize_to_limit: [1200, 1200]) for display in a lightbox/modal, so clicking a thumbnail doesn't load the full-resolution original (documents can be up to 200 MB per theTopicsize validation). - Lightbox closes via backdrop and Esc; reuse an existing modal pattern if one exists.
- Optionally, eagerly generate variants via a background job on upload to remove first-view latency. (Note: going eager is the point at which a backfill question for old documents would reappear — staying lazy avoids it.)
- Unify
TopicsHelper#card_preview_mediato userepresentation(:thumb)for card/list previews instead of full-size originals.
- 主要言語
- Ruby
- スター
- 16
- フォーク
- 11
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
rubyforgood/skillrx のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
rubyforgood/skillrx#736 ·
-
Discrepancies between SkillRx and Azure再び着手できるかも @dcollie2 が 66 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
rubyforgood/skillrx#734 · 担当者 2 名 ·
-
Topics UI Tweaks対応中かも @LucassF5 が 130 日前に担当しました。 オープンenhancement good first issue User Interface
rubyforgood/skillrx#699 · コメント 2 件 · 担当者 1 名 ·
-
bug User Interface
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
rubyforgood/skillrx#606 ·
-
Update Website Statsオープンhelp wanted
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
rubyforgood/skillrx#588 ·
rubyforgood/skillrx の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信
-
L: javascript
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
dependabot/dependabot-core#16744 ·
メンテナーはふだん 1 日以内に返信
-
area:core-lib P2 size:S
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信