jekyll-documents 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 518470aad866ef5e32081999ae94d7d8bc3ab87a1f19240a66a2152b13a7db87
-  data.tar.gz: 392d655c0163d3274b3b9e679009aa66d89ab87802e359a5c520b05fdb666897
+  metadata.gz: 3865d4ab22aa0cf85e53ad31d222e4e4d025f7f53fb1271a949d326ee8ad60a3
+  data.tar.gz: 483721501a072d99ade0088e958b52e02583b4d13de7ee26ecd74bc7141b9c87
 SHA512:
-  metadata.gz: c1152712cbdef7b491ab32618bee51ffc7fa02d45f92eff6e92c1d5fc07ba7b00f787550e18a0554e3909b0e96cfb64edb6102a9b5477f9e1da40b44df4f4a76
-  data.tar.gz: 40b4cc7ff588faf52d29b59229c82f3088d1063495640c3a86c3bbb1b7e1d042a2f1014b065bf6bd3e0713c760d772245f37e3491bdb3cc44e56d37030cddbe5
+  metadata.gz: c923ebb2b6e801ab1449b76ed999e8408d234ddb03c03c5b6bf21086c54a49a6fbc7d74b258049248ae53c159c81814d7f23ee44e1f590d9c89f49814bf56630
+  data.tar.gz: 639afd3c1abce1196a31b7fb7e34acc197d681f5dc863c53b480f7d127b104db0e27c9adb02c88889dcc62977f4d86162bfade3a077ea269f811e0f24a6da3da

data/CHANGELOG.md

@@ -1,5 +1,77 @@
 # Changelog
 
+
+## [0.3.0] - 2026-07-23
+
+### Added
+- **Baked icon data**: Generator now bakes `icon_url` and `icon_set` into each document's data at build time, eliminating the need for Liquid context in filters
+- **`FileTypeIcons.icon_for` class method**: Allows icon URL resolution without a Liquid context (used by generator)
+- **Search JavaScript wired up**: `_includes/documents_search.html` now loads Lunr.js and `documents-search.js` for out-of-the-box client-side search
+- **jekyll-sitemap integration**: `TextStaticFile` exposes `sitemap: false` data to exclude generated JSON index from sitemap
+- **Unit tests for `FileTypeIcons.icon_for`**: 5 new tests covering all icon sets, fallbacks, and nil handling
+- **Generator tests for icon data**: Tests verifying `icon_url` and `icon_set` are correctly baked into document data
+- **System test for full build pipeline**: End-to-end test covering generator → JSON index → tag rendering
+
+### Changed
+- **Minimum Ruby version**: Bumped from `>= 2.7` to `>= 3.1` (Ruby 2.7 EOL March 2023, 3.0 EOL April 2024)
+- **RuboCop `TargetRubyVersion`**: Updated from `2.7` to `3.1` to match gemspec
+- **Templates use baked icon data**: `latest_documents.html`, `documents_list.html`, `document.html` now use `{{ doc.icon_url }}` instead of the broken `file_type_icon_tag` filter
+- **`category_list.html` icon set**: Now reads `icon_set` from first document's baked data instead of non-functional `site.documents.icon_set`
+- **`latest_documents.html` count fallback**: Simplified to `| default: 5` since `site.config` is inaccessible in Liquid
+- **Reek configuration**: Updated `.reek.yml` with targeted exclusions for design-inherent warnings
+- **Code quality**: Renamed uncommunicative variables (`s` → `slug`/`result`, `d` → `doc`, `m` → `match`, `y/m/d` → `year/month/day`) across all source files
+- **Reduced duplicate method calls**: Extracted `data = doc.data` locals in generator, JSON index generator, and latest documents tag
+- **Simplified `get_icon_set`**: Reduced from 6 statements to 3 using safe navigation with `dig`
+- **Test suite**: 167 examples (up from 79), 100% line coverage (212/212 lines)
+- **RuboCop**: 0 offenses (24 files inspected)
+- **Reek**: 0 warnings (7 files inspected)
+
+### Fixed
+- **Icon set config ignored in templates** (High): `file_type_icon_tag` filter never received Liquid context, causing `icon_set` config to be silently ignored — always fell back to `"color"`. Fixed by baking icon URLs into document data at generation time
+- **`rel_path` slicing** (Low): Replaced fragile `path[(site.source.length + 1)..]` with `String#delete_prefix` for robustness
+- **`Date.parse` in `parse_filename`** (Low): Replaced with `Date.new(year, month, day)` using integer-converted regex captures for clarity
+- **`category_list.html` folder icon** (Low): `site.documents.icon_set` always resolved to `nil` since `site.documents` is an array — now reads from baked document data
+- **Search include missing JavaScript** (Medium): `documents_search.html` had input/results elements but no script tags — now loads Lunr.js and search JS
+- **No active jekyll-sitemap integration** (Low): JSON index file now flagged with `sitemap: false` to exclude it from sitemap
+
+## [0.2.0] - 2026-03-12
+
+### Added
+- **Comprehensive code quality tools** (RuboCop, Reek, Bundler Audit, SimpleCov)
+- **98.99% test coverage** with integration tests for Liquid tags
+- **Enhanced release automation** with 10 safety checks and validations
+- **Pre-commit hooks** for automatic quality checks
+- **Dry-run mode** for release preview
+- **Rollback capability** for undoing releases
+- **Automated CHANGELOG templates** when bumping versions
+- **Release notes generator** with clipboard integration
+- **Git status and dependency checks** before release
+- **Version consistency validation** across files
+- **Post-release verification** with helpful links
+
+### Changed
+- **Consolidated documentation** (README.Development.md combines all dev docs)
+- **Simplified README.md** with KISS approach
+- **Improved Rake tasks** with better organization and help system
+- **Enhanced test suite** with 79 passing tests
+- **Better error handling** in release scripts
+
+### Fixed
+- **Liquid tag testing** through integration tests (resolves 98% coverage)
+- **Keyword argument compatibility** in filters
+- **Release script safety** with comprehensive validation
+- **Documentation consistency** across all markdown files
+
+### Development
+- **Quality metrics**: 98.99% coverage • 0 vulnerabilities • 3 RuboCop offenses
+- **Release workflow**: Fully automated with rollback capability
+- **Testing**: 79 examples, 0 failures, integration tests for all features
+
+## [0.1.2] - 2026-03-09
+
+### Added
+- **Release automation scripts**
+
 ## [0.1.1] - 2026-03-09
 
 ### Added

data/README.md

@@ -1,13 +1,8 @@
 # jekyll-documents
 
-Turn files in `assets/documents/` into browsable document pages with icons, categories, and search.
+Turn files in `assets/documents/` into browsable document pages.
 
-**Features:**
-- Auto-collection from files
-- File type icons (4 styles)
-- Categories from folders
-- Client-side search
-- Strict validation
+**Features**: Auto-collection • File icons • Categories • Search
 
 ## Quick Start
 
@@ -38,89 +33,67 @@ assets/documents/minutes/2026-02-15_Board_Meeting.docx
 {% include category_list.html %}
 ```
 
-## Requirements
-
-Ruby >= 2.7, Jekyll >= 4.0
 ## File Naming
 
-**Format:** `YYYY-MM-DD_Title_With_Underscores.ext`
+**Format**: `YYYY-MM-DD_Title.ext`
 
 ```
 assets/documents/reports/2026-03-01_Annual_Report.pdf
-assets/documents/minutes/2026-02-15_Board_Meeting.docx
 ```
 
-- Date: `YYYY-MM-DD`
-- Title: Underscores → spaces
-- Category: From folder name
-
-  
-
-## File Type Icons
-
-The plugin automatically displays file type icons for all supported formats. Icons are included in the gem and based on designs from [svgrepo.com](https://www.svgrepo.com/).
+Date → `YYYY-MM-DD` • Title → underscores to spaces • Category → folder name
 
-**Icon Sets:** color (default), lines, minimal, ultra-minimal
+## Icons
 
-**Supported:** PDF, DOCX, XLSX, PPTX, ODT, ODS, ODP, TXT, ZIP, MP3, MP4, JPG, PNG, HTML, XML, CSV, RTF
+4 icon sets: `color` (default), `lines`, `minimal`, `ultra-minimal`
 
-**Configuration:**
 ```yaml
 documents:
-  icon_set: "color"  # color, lines, minimal, ultra-minimal
+  icon_set: "color"
 ```
 
-**Icons appear in:** document pages, lists, search results, category folders
-
-**Liquid filters:**
 ```liquid
 {{ page.file_type | file_type_icon_tag }}
-{{ page.file_type | file_type_icon }}
 ```
 
-*Icons from [svgrepo.com](https://www.svgrepo.com/)*
-
-## Includes
+## Usage
 
 ```liquid
 {% include latest_documents.html count=5 %}
 {% include documents_list.html %}
-{% include category_list.html %}
 {% include documents_search.html %}
 ```
 
-## Search
-
-```html
-<script src="https://unpkg.com/lunr/lunr.js"></script>
-<script src="{{ '/assets/js/documents-search.js' | relative_url }}"></script>
-```
 ## Configuration
 
 ```yaml
 documents:
   root: "assets/documents"
-  permalink: "/documents/:category/:slug/"
-  icon_set: "color"  # color, lines, minimal, ultra-minimal
-  include_extensions: [".pdf", ".docx", ".pptx", ".xlsx"]
+  icon_set: "color"
   strict_filename: true
-  json_index: true
 ```
 
 See [configuration.rb](lib/jekyll/documents/configuration.rb) for all options.
+
 ## Development
 
 ```bash
-bundle install
-bundle exec rspec       # Run tests
-bundle exec rake doc    # Generate docs
-cd example && bundle exec jekyll serve  # Example site
+rake              # All quality checks
+rake quick        # Fast check
+rake help         # Show commands
 ```
 
-## License
+**Quality**: 98.99% coverage • 0 vulnerabilities • RuboCop • Reek
+
+See [README.Development.md](README.Development.md) for details.
 
-AGPL-3.0-only
+## Release
 
-## Attribution
+```bash
+./bump_version.sh patch
+./release.sh
+```
+
+## License
 
-Icons by [SVG Repo](https://www.svgrepo.com)
+AGPL-3.0-only • Icons by [SVG Repo](https://www.svgrepo.com)

data/_includes/category_list.html

@@ -1,8 +1,10 @@
+{% assign first_doc = site.documents | first %}
+{% assign icon_set = first_doc.icon_set | default: 'color' %}
 {% assign cats = site.documents | map: "category" | uniq | sort %}
 <ul class="documents-category-list">
   {% for cat in cats %}
     <li>
-      <img src="/assets/icons/{{ site.documents.icon_set | default: 'color' }}/folder-svgrepo-com.svg" alt="Folder" class="folder-icon" />
+      <img src="{{ '/assets/icons/' | append: icon_set | append: '/folder-svgrepo-com.svg' | relative_url }}" alt="Folder" class="folder-icon" />
       <span class="category-name">{{ cat }}</span>
       <span class="category-count">({{ site.documents | where: "category", cat | size }})</span>
     </li>

data/_includes/documents_list.html

@@ -2,7 +2,7 @@
 <ul class="documents-list">
   {% for doc in docs %}
     <li>
-      {{ doc.file_type | file_type_icon_tag }}
+      <img src="{{ doc.icon_url | relative_url }}" alt="{{ doc.file_type | upcase }} file" class="file-icon" />
       <a href="{{ doc.url | relative_url }}">{{ doc.title }}</a>
       <small>({{ doc.date | date: "%Y-%m-%d" }}, {{ doc.category }})</small>
     </li>

data/_includes/documents_search.html

@@ -2,3 +2,5 @@
   <input id="doc-search-input" type="search" placeholder="Search documents…" aria-label="Search documents" />
   <div id="doc-search-results" class="documents-search-results"></div>
 </div>
+<script src="https://unpkg.com/lunr/lunr.js"></script>
+<script src="{{ '/assets/js/documents-search.js' | relative_url }}"></script>

data/_includes/latest_documents.html

@@ -1,9 +1,9 @@
-{% assign count = include.count | default: site.config.documents.latest_default_count | default: 5 %}
+{% assign count = include.count | default: 5 %}
 {% assign docs = site.documents | sort: "date" | reverse | slice: 0, count %}
 <ul class="latest-documents">
   {% for doc in docs %}
     <li>
-      {{ doc.file_type | file_type_icon_tag }}
+      <img src="{{ doc.icon_url | relative_url }}" alt="{{ doc.file_type | upcase }} file" class="file-icon" />
       <a href="{{ doc.url | relative_url }}">{{ doc.title }}</a>
       <small>({{ doc.date | date: "%Y-%m-%d" }}, {{ doc.category }})</small>
     </li>

data/_layouts/document.html

@@ -13,7 +13,7 @@ layout: default
 
   <p>
     <a href="{{ page.file_url | relative_url }}" class="document-download">
-      {{ page.file_type | file_type_icon_tag }}
+      <img src="{{ page.icon_url | relative_url }}" alt="{{ page.file_type | upcase }} file" class="file-icon" />
       Download ({{ page.extension | remove: "." | upcase }})
     </a>
   </p>

data/jekyll-documents.gemspec

@@ -3,25 +3,42 @@
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-documents"
   spec.version       = File.read(File.expand_path("lib/jekyll/documents/version.rb", __dir__))
-                         .match(/VERSION\s*=\s*"([^"]+)"/)[1]
+                           .match(/VERSION\s*=\s*"([^"]+)"/)[1]
   spec.authors       = ["Svend Gundestrup"]
   spec.email         = ["no-reply@borg-collective.eu"]
 
-  spec.summary       = "Auto-generate Jekyll pages for documents (PDF/DOCX/...) with category/date/title parsing."
-  spec.description   = "A Jekyll plugin + theme that scans assets/documents/**, creates a collection item per file, " \
-                       "adds metadata (title/date/category), outputs pages, generates a JSON index for Lunr, and integrates with jekyll-sitemap."
+  spec.summary       = "Auto-generate Jekyll pages for documents (PDF/DOCX/...) " \
+                       "with category/date/title parsing."
+  spec.description   = "A Jekyll plugin + theme that scans assets/documents/**, " \
+                       "creates a collection item per file, adds metadata " \
+                       "(title/date/category), outputs pages, generates " \
+                       "a JSON index for Lunr, and integrates with jekyll-sitemap."
   spec.homepage      = "https://github.com/gundestrup/jekyll-documents"
   spec.license       = "AGPL-3.0-only"
 
-  spec.required_ruby_version = ">= 2.7"
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/gundestrup/jekyll-documents",
+    "bug_tracker_uri" => "https://github.com/gundestrup/jekyll-documents/issues",
+    "changelog_uri" => "https://github.com/gundestrup/jekyll-documents/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/gundestrup/jekyll-documents",
+    "homepage_uri" => "https://github.com/gundestrup/jekyll-documents",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.required_ruby_version = ">= 3.1"
 
   spec.files         = Dir.glob("{lib,assets,_includes,_layouts}/**/*") +
                        ["README.md", "CHANGELOG.md", "LICENSE", "jekyll-documents.gemspec"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "jekyll", ">= 4.0"
-  
-  spec.add_development_dependency "rspec", "~> 3.12"
+
+  spec.add_development_dependency "bundler-audit", "~> 0.9"
   spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "reek", "~> 6.1"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rubocop", "~> 1.60"
+  spec.add_development_dependency "rubocop-performance", "~> 1.20"
+  spec.add_development_dependency "simplecov", "~> 1.0"
   spec.add_development_dependency "yard", "~> 0.9"
 end

data/lib/jekyll/documents/file_type_icons.rb

@@ -95,6 +95,18 @@ module Jekyll
         }
       }.freeze
 
+      # Returns the icon URL for a given file type and explicit icon set
+      # @param file_type [String] the file extension (e.g., 'pdf', 'docx')
+      # @param icon_set [String] the icon set name (defaults to 'color')
+      # @return [String] the icon file URL
+      # @example
+      #   FileTypeIcons.icon_for('pdf', 'lines') #=> "/assets/icons/lines/pdf-svgrepo-com.svg"
+      def self.icon_for(file_type, icon_set = "color")
+        icons = ICON_MAP[icon_set] || ICON_MAP["color"]
+        icons[file_type.to_s.downcase] ||
+          "/assets/icons/#{icon_set}/unknown-document-svgrepo-com.svg"
+      end
+
       # Returns the icon URL for a given file type using configured icon set
       # @param file_type [String] the file extension (e.g., 'pdf', 'docx')
       # @param context [Liquid::Context] the Liquid context for accessing site config
@@ -102,9 +114,7 @@ module Jekyll
       # @example
       #   file_type_icon('pdf') #=> "/assets/icons/color/pdf.svg"
       def file_type_icon(file_type, context = nil)
-        icon_set = get_icon_set(context)
-        icons = ICON_MAP[icon_set] || ICON_MAP["color"]
-        icons[file_type.to_s.downcase] || "/assets/icons/#{icon_set}/unknown-document-svgrepo-com.svg"
+        Jekyll::Documents::FileTypeIcons.icon_for(file_type, get_icon_set(context))
       end
 
       # Returns an HTML img tag for the file type icon
@@ -114,10 +124,11 @@ module Jekyll
       # @param context [Liquid::Context] the Liquid context for accessing site config
       # @return [String] HTML img tag
       # @example
-      #   file_type_icon_tag('pdf') #=> '<img src="/assets/icons/color/pdf.svg" alt="PDF file" class="file-icon" />'
+      #   file_type_icon_tag('pdf') #=> \
+      #     '<img src="/assets/icons/color/pdf.svg" alt="PDF file" class="file-icon" />'
       def file_type_icon_tag(file_type, css_class: "file-icon", alt: nil, context: nil)
         url = file_type_icon(file_type, context)
-        alt_text = alt || "#{file_type.upcase} file"
+        alt_text = alt || "#{file_type.to_s.upcase} file"
         %(<img src="#{url}" alt="#{alt_text}" class="#{css_class}" />)
       end
 
@@ -128,13 +139,11 @@ module Jekyll
       # @return [String] the icon set name
       def get_icon_set(context)
         return "color" unless context
-        
-        site_config = context.registers[:site]&.config
-        documents_config = site_config["documents"] if site_config
-        icon_set = documents_config["icon_set"] if documents_config
-        
-        # Validate icon set exists
+
+        site = context.registers[:site]
+        icon_set = site&.config&.dig("documents", "icon_set")
         return "color" unless icon_set && ICON_MAP.key?(icon_set)
+
         icon_set
       end
     end

data/lib/jekyll/documents/filters.rb

@@ -9,18 +9,19 @@ module Jekyll
       }.freeze
 
       # Slugify while handling Danish letters and basic punctuation cleanup.
-      def documents_slugify(input, downcase = true, danish_map = true)
-        s = input.to_s.dup
-        s = s.gsub(/[æøåÆØÅ]/) { |ch| DANISH_MAP[ch] } if danish_map
-        s = s.strip.gsub(/[^\p{Alnum}\-_\s]/u, "")
-        s = s.tr(" ", "-").gsub(/-+/, "-")
-        s = s.gsub(/[æøåÆØÅ]/, "") unless danish_map  # Remove Danish chars if mapping disabled
-        s = s.downcase if downcase
-        s
+      def documents_slugify(input, downcase: true, danish_map: true)
+        result = input.to_s.dup
+        result = result.gsub(/[æøåÆØÅ]/) { |ch| DANISH_MAP[ch] } if danish_map
+        result = result.strip.gsub(/[^\p{Alnum}\-_\s]/u, "")
+        result = result.tr(" ", "-").squeeze("-")
+        result = result.gsub(/[æøåÆØÅ]/, "") unless danish_map
+        result = result.downcase if downcase
+        result
       end
 
       # Title from filename e.g. "2026-03-01_Title_Here" -> "Title Here"
       def documents_title_from_filename(basename)
+        basename = basename.to_s
         if basename =~ /^\d{4}-\d{2}-\d{2}_(.+)$/
           Regexp.last_match(1).tr("_", " ")
         else

data/lib/jekyll/documents/generator.rb

@@ -35,17 +35,19 @@ module Jekyll
           end
           next unless @config["include_extensions"].include?(ext)
 
-          rel_path = path.start_with?(site.source) ? path[(site.source.length + 1)..-1] : path
+          rel_path = path.delete_prefix("#{site.source}/")
           category = infer_category_from(rel_path)
           basename = File.basename(path, ext)
 
           date, title, valid = parse_filename(basename)
           if !valid && @config["strict_filename"]
             ::Jekyll.logger.abort_with "jekyll-documents",
-              "Filename must be 'YYYY-MM-DD_Title.ext' → #{rel_path}"
+                                       "Filename must be 'YYYY-MM-DD_Title.ext' → #{rel_path}"
           end
 
           slug = build_slug(basename)
+          file_type = ext.sub(".", "").downcase
+          icon_set = @config["icon_set"]
 
           doc = ::Jekyll::Document.new(
             source_stub_for(basename, category),
@@ -53,17 +55,20 @@ module Jekyll
             collection: collection
           )
 
-          doc.data["layout"]     = @config["layout"]
-          doc.data["title"]      = title
-          doc.data["date"]       = date || File.mtime(path)
-          doc.data["category"]   = remap_category(category)
-          doc.data["file_url"]   = "/" + rel_path
-          doc.data["extension"]  = ext
-          doc.data["file_type"]  = ext.sub(".", "").downcase
-          doc.data["slug"]       = slug
-          doc.data["permalink"]  = @config["permalink"]
-            .gsub(":category", doc.data["category"].to_s)
-            .gsub(":slug", slug)
+          data = doc.data
+          data["layout"]     = @config["layout"]
+          data["title"]      = title
+          data["date"]       = date || File.mtime(path)
+          data["category"]   = remap_category(category)
+          data["file_url"]   = "/#{rel_path}"
+          data["extension"]  = ext
+          data["file_type"]  = file_type
+          data["icon_set"]   = icon_set
+          data["icon_url"]   = Jekyll::Documents::FileTypeIcons.icon_for(file_type, icon_set)
+          data["slug"]       = slug
+          data["permalink"]  = @config["permalink"]
+                               .gsub(":category", data["category"].to_s)
+                               .gsub(":slug", slug)
 
           doc.content = "Auto-generated document page."
 
@@ -99,7 +104,8 @@ module Jekyll
       # @return [String] the category name
       def infer_category_from(rel_path)
         return "uncategorized" unless @config["categories_from_path"]
-        category_dir = File.dirname(rel_path).sub("#{@config['root']}", "")
+
+        category_dir = File.dirname(rel_path).sub(@config["root"].to_s, "")
         category_dir.split("/").reject(&:empty?).last || "uncategorized"
       end
 
@@ -116,7 +122,10 @@ module Jekyll
       # @return [Array<Date, String, Boolean>] date, title, and validity flag
       def parse_filename(basename)
         if basename =~ /^(\d{4})-(\d{2})-(\d{2})_(.+)$/
-          date = Date.parse("#{Regexp.last_match(1)}-#{Regexp.last_match(2)}-#{Regexp.last_match(3)}")
+          year = Regexp.last_match(1).to_i
+          month = Regexp.last_match(2).to_i
+          day = Regexp.last_match(3).to_i
+          date = Date.new(year, month, day)
           title = Regexp.last_match(4).tr("_", " ")
           [date, title, true]
         else
@@ -130,12 +139,16 @@ module Jekyll
       # @param basename [String] the filename without extension
       # @return [String] the generated slug
       def build_slug(basename)
-        s = basename.sub(/^\d{4}-\d{2}-\d{2}_/, "")
-        s = s.gsub(/[æøåÆØÅ]/, {"æ"=>"ae","ø"=>"oe","å"=>"aa","Æ"=>"Ae","Ø"=>"Oe","Å"=>"Aa"}) if @config["slug_danish_map"]
-        s = s.downcase if @config["slug_downcase"]
-        s = s.gsub(/[^\p{Alnum}\-_\s]/u, "").tr("_ ", "--").gsub(/-+/, "-")
-        s = s.sub(/^-+/, "").sub(/-+$/, "")  # Remove leading/trailing hyphens
-        s.empty? ? "untitled" : s
+        slug = basename.sub(/^\d{4}-\d{2}-\d{2}_/, "")
+        if @config["slug_danish_map"]
+          slug = slug.gsub(/[æøåÆØÅ]/,
+                           { "æ" => "ae", "ø" => "oe", "å" => "aa", "Æ" => "Ae", "Ø" => "Oe",
+                             "Å" => "Aa" })
+        end
+        slug = slug.downcase if @config["slug_downcase"]
+        slug = slug.gsub(/[^\p{Alnum}\-_\s]/u, "").tr("_ ", "--").squeeze("-")
+        slug = slug.sub(/^-+/, "").sub(/-+$/, "")
+        slug.empty? ? "untitled" : slug
       end
     end
   end

data/lib/jekyll/documents/json_index_generator.rb

@@ -16,15 +16,16 @@ module Jekyll
         docs = site.collections["documents"]&.docs || []
         return if docs.empty?
 
-        items = docs.map do |d|
+        items = docs.map do |doc|
+          data = doc.data
           {
-            "url"       => d.url,
-            "title"     => d.data["title"],
-            "category"  => d.data["category"],
-            "date"      => (d.data["date"] || Time.at(0)).strftime("%Y-%m-%d"),
-            "slug"      => d.data["slug"],
-            "file_type" => d.data["file_type"],
-            "extension" => d.data["extension"]
+            "url" => doc.url,
+            "title" => data["title"],
+            "category" => data["category"],
+            "date" => (data["date"] || Time.at(0)).strftime("%Y-%m-%d"),
+            "slug" => data["slug"],
+            "file_type" => data["file_type"],
+            "extension" => data["extension"]
           }
         end
 

data/lib/jekyll/documents/tags/latest_documents.rb

@@ -7,7 +7,7 @@ module Jekyll
         super
         @args = parse_args(markup)
       end
-      
+
       public_class_method :new
 
       def render(context)
@@ -17,14 +17,15 @@ module Jekyll
         category = @args["category"]
 
         docs = site.collections["documents"]&.docs || []
-        docs = docs.select { |d| d.data["category"] == category } if category
-        docs = docs.sort_by { |d| d.data["date"] || Time.at(0) }.reverse.first(count)
+        docs = docs.select { |doc| doc.data["category"] == category } if category
+        docs = docs.sort_by { |doc| doc.data["date"] || Time.at(0) }.reverse.first(count)
 
         out = +"<ul class=\"latest-documents\">\n"
-        docs.each do |d|
-          title = escape_html(d.data["title"])
-          url   = escape_html(d.url)
-          date  = (d.data["date"] || Time.at(0)).strftime("%Y-%m-%d")
+        docs.each do |doc|
+          data = doc.data
+          title = escape_html(data["title"])
+          url   = escape_html(doc.url)
+          date  = (data["date"] || Time.at(0)).strftime("%Y-%m-%d")
           out << %(<li><a href="#{url}">#{title}</a> <small>(#{date})</small></li>\n)
         end
         out << "</ul>\n"
@@ -35,23 +36,26 @@ module Jekyll
 
       def escape_html(text)
         return "" unless text
+
         text.to_s.gsub(/[&<>"']/, {
-          "&" => "&amp;",
-          "<" => "&lt;",
-          ">" => "&gt;",
-          '"' => "&quot;",
-          "'" => "&#39;"
-        })
+                         "&" => "&amp;",
+                         "<" => "&lt;",
+                         ">" => "&gt;",
+                         '"' => "&quot;",
+                         "'" => "&#39;"
+                       })
       end
 
       def parse_args(markup)
         # supports: count:5 category:'referat'
         args = {}
-        markup.scan(/(\w+)\s*:\s*'([^']*)'|(\w+)\s*:\s*([^\s]+)/).each do |m|
-          if m[0]
-            args[m[0]] = m[1]
+        # Safe: markup comes from Jekyll template authors (trusted), not end users
+        # Runs only during static site generation, not on user requests
+        markup.scan(/(\w+)\s*:\s*'([^']*)'|(\w+)\s*:\s*([^\s]+)/).each do |match|
+          if match[0]
+            args[match[0]] = match[1]
           else
-            args[m[2]] = m[3]
+            args[match[2]] = match[3]
           end
         end
         args
@@ -61,4 +65,3 @@ module Jekyll
 end
 
 Liquid::Template.register_tag("latest_documents", Jekyll::Documents::LatestDocumentsTag)
-

data/lib/jekyll/documents/utils.rb

@@ -4,12 +4,15 @@ module Jekyll
   module Documents
     # A tiny StaticFile subclass for writing text files during build.
     class TextStaticFile < ::Jekyll::StaticFile
+      attr_reader :data
+
       def initialize(site, base, rel_dest, content)
         @site = site
         @base = base
         @dir  = File.dirname(rel_dest)
         @name = File.basename(rel_dest)
         @content = content
+        @data = { "sitemap" => false }
         super(site, base, @dir, @name)
       end
 

data/lib/jekyll/documents/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Documents
-    VERSION = "0.1.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-documents
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Svend Gundestrup
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +52,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +264,14 @@ files:
 homepage: https://github.com/gundestrup/jekyll-documents
 licenses:
 - AGPL-3.0-only
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/gundestrup/jekyll-documents
+  bug_tracker_uri: https://github.com/gundestrup/jekyll-documents/issues
+  changelog_uri: https://github.com/gundestrup/jekyll-documents/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/gundestrup/jekyll-documents
+  homepage_uri: https://github.com/gundestrup/jekyll-documents
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,14 +279,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Auto-generate Jekyll pages for documents (PDF/DOCX/...) with category/date/title
   parsing.