jekyll-documents 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884c3afc18e96312dcd25a2328f652ec8cb1417ad8ec26337b4aa4ee2f175517
-  data.tar.gz: 29e0d75b6b50c68acb124e0b31123cc85c3810789c39d562beb8da00c5c50a87
+  metadata.gz: c690ba4e56790f19326b49d3476839028784f9da66b4d46d5a18680cac0ba927
+  data.tar.gz: 6007f855de36ef230b789fdab081877f19c9be15c583a342e669eaa811898317
 SHA512:
-  metadata.gz: c50ee45d94b33d62b344dadda31c9cf865d8d175de1b00e7c7f92aaeb046f0cef7fec3835de627e68ec0ce9849d925b8fbacb3012be5a5face435822c173b9c3
-  data.tar.gz: 3a28dee0ff0b8078cac42e4097676a991496e8510a38518bd7d6ea013275f2f9f804b15b5f4ab46e846f6ab2a5eaa8e72dfd4a535ed8a1b9c7cf338671a64019
+  metadata.gz: ecc1cbd701f3b07f70694dd0a9f7314d7d65bb2b2040ad0af3658d763ad540bb40daf90e1494100e49ab72a10540377786d793a2416536cc055f85a16983fcb7
+  data.tar.gz: dbab2960b310640f780b3d88695ec16cbdf1902fba99019736bedf7ab3ecf0a6f956c370b9b3c8858ad559f4f40fe7a6f354843a7ceef790e97010f751c898cc

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## [Unreleased]
+
+## [0.7.4] - 2026-09-18
+
+### Added
+- Added Codecov coverage reporting: CI uploads Cobertura XML (via `simplecov-cobertura`) after the Ruby quality suite, with `codecov.yml` status checks (98% project / 90% patch targets)
+
+### Changed
+- Auto-update `Gemfile.lock` on `rake version:bump` via `bundle lock` (use `SKIP_LOCK=1` to skip)
+- Further reduced `latest_documents.rb` `render` complexity by extracting `resolve_count` and `select_documents`
+- Extracted shared `TagHelpers` module (markup parsing, document collection access, path normalization, HTML escaping) used by `doc_link`, `doc_category`, `document_icon`, and `latest_documents` tags — removes SonarCloud-flagged duplication
+- Extracted shared `liquid tag helpers` spec context (`spec/support/shared_context_tags.rb`) for tag spec setup
+- Added `.sonarcloud.properties` excluding `spec/fixtures/` from SonarCloud duplication analysis (fixture templates intentionally mirror shipped includes/layouts)
+
+## [0.7.3] - 2026-09-10
+
+### Added
+- Added Semgrep CE security scanning with a custom ReDoS detection rule for pre-commit and CI
+- Added CodeFactor code quality analysis badge and integration
+- Added SEMGREP_APP_TOKEN integration for Cloud dashboard sync from CI
+- Added `rake version:pre_release` task for pre-release security gate with FORCE=1 override
+
+### Changed
+- Updated CI to Node.js 26 and current Node 24-based GitHub Actions runtimes
+- Pinned all GitHub Actions to commit SHAs to prevent supply-chain attacks
+- Added cooldown period to Dependabot configuration
+- Pinned Lunr.js CDN to version 2.3.9 with SRI integrity hash
+- Bumped actions/checkout to v7.0.1 (SHA-pinned)
+- Reduced method complexity across 6 flagged CodeFactor findings:
+  - `generator.rb`: Extracted `process_file` and `merge_passthrough_fields` from `generate` and `configure_client_search`
+  - `doc_link.rb`: Extracted `match_documents` and `report_ambiguous` from `find_document`
+  - `doc_category.rb`: Extracted `match_categories` and `report_ambiguous_category` from `resolve_category`
+  - `latest_documents.rb`: Extracted `render_list` and `list_item` from `render`
+  - `options_parser.rb`: Extracted `read_value` from `parse_options`
+
+### Fixed
+- Replaced dangerous subshell in system spec with Open3.capture2
+
 ## [0.7.2] - 2026-09-09
 
 ### Fixed

data/README.md

@@ -6,6 +6,9 @@
 [![Gem Downloads](https://img.shields.io/gem/dt/jekyll-documents)](https://rubygems.org/gems/jekyll-documents)
 [![License: AGPL-3.0-only](https://img.shields.io/badge/license-AGPL--3.0--only-blue)](LICENSE)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/gundestrup/jekyll-documents)
+[![CodeFactor](https://www.codefactor.io/repository/github/gundestrup/jekyll-documents/badge)](https://www.codefactor.io/repository/github/gundestrup/jekyll-documents)
+[![Semgrep CE](https://img.shields.io/badge/Semgrep_CE-security-success)](https://github.com/gundestrup/jekyll-documents/security/code-scanning)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gundestrup_jekyll-documents&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gundestrup_jekyll-documents)
 
 Turn files in `assets/documents/` into browsable document pages.
 

data/_includes/documents_search.html

@@ -9,6 +9,8 @@
   window.__jekyllDocumentsIndexPath = {{ index_path | relative_url | jsonify }};
   window.__jekyllDocumentsBaseurl = {{ site.baseurl | jsonify }};
 </script>
-<script src="https://unpkg.com/lunr/lunr.js"></script>
+<script src="https://unpkg.com/lunr@2.3.9/lunr.js"
+        integrity="sha384-Mrc0XsDxndfJgV5jLnEeThch4j9dNEXAE1vbWeyzmERxSvF8siQfuEczzgUelQQH"
+        crossorigin="anonymous"></script>
 <script src="{{ '/assets/js/documents-search.js' | relative_url }}"></script>
 {% endif %}

data/lib/jekyll/documents/generator.rb

@@ -43,39 +43,10 @@ module Jekyll
         Dir.glob("#{root}/**/*").each do |path|
           next unless File.file?(path)
 
-          source_extension = File.extname(path)
-          ext = source_extension.downcase
-          if @config["strict_extensions"] && !@config["include_extensions"].include?(ext)
-            ::Jekyll.logger.abort_with "jekyll-documents",
-                                       "Unsupported file type: #{path} (#{ext})"
-          end
-          next unless @config["include_extensions"].include?(ext)
+          doc, rel_path = process_file(path, root, collection)
+          next unless doc
 
-          source_path = source_path_for(path, root)
-          category_path = document_category_path(source_path)
-          category = remap_category(category_path)
-          rel_path = normalize_path(File.join(@config["root"], source_path))
           current_paths << rel_path
-          basename = File.basename(path, source_extension)
-
-          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}"
-          end
-
-          doc = ::Jekyll::Document.new(
-            source_stub_for(source_path),
-            site: site,
-            collection: collection
-          )
-          file_info = {
-            title: title, date: date, category: category, category_path: category_path,
-            category_slug: slugify(category, "uncategorized"), source_path: source_path,
-            rel_path: rel_path, ext: ext, file_type: ext.delete_prefix("."),
-            icon_set: @config["icon_set"], slug: build_slug(basename), path: path
-          }
-          bake_document_data(doc, file_info)
           collection.docs << doc
           generated_docs << doc
         end
@@ -87,6 +58,42 @@ module Jekyll
 
       private
 
+      def process_file(path, root, collection)
+        source_extension = File.extname(path)
+        ext = source_extension.downcase
+        if @config["strict_extensions"] && !@config["include_extensions"].include?(ext)
+          ::Jekyll.logger.abort_with "jekyll-documents",
+                                     "Unsupported file type: #{path} (#{ext})"
+        end
+        return [nil, nil] unless @config["include_extensions"].include?(ext)
+
+        source_path = source_path_for(path, root)
+        rel_path = normalize_path(File.join(@config["root"], source_path))
+        basename = File.basename(path, source_extension)
+
+        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}"
+        end
+
+        category_path = document_category_path(source_path)
+        category = remap_category(category_path)
+        doc = ::Jekyll::Document.new(
+          source_stub_for(source_path),
+          site: @site,
+          collection: collection
+        )
+        file_info = {
+          title: title, date: date, category: category, category_path: category_path,
+          category_slug: slugify(category, "uncategorized"), source_path: source_path,
+          rel_path: rel_path, ext: ext, file_type: ext.delete_prefix("."),
+          icon_set: @config["icon_set"], slug: build_slug(basename), path: path
+        }
+        bake_document_data(doc, file_info)
+        [doc, rel_path]
+      end
+
       # Auto-injects passthrough_fields into client_search config when the
       # documents collection is indexed. Only acts if client_search is already
       # configured with +documents+ in its collections list — does nothing if
@@ -96,13 +103,17 @@ module Jekyll
         return unless search_config.is_a?(Hash)
         return unless Array(search_config["collections"]).include?("documents")
 
+        merge_passthrough_fields(search_config)
+        search_config["icon_field"] = "icon_url" unless search_config.key?("icon_field")
+      end
+
+      def merge_passthrough_fields(search_config)
         fields = search_config["passthrough_fields"] || []
         existing = fields.flat_map { |f| f.is_a?(Hash) ? f.keys : [f.to_s] }
         %w[file_type icon_url icon_set].each do |field|
           fields << field unless existing.include?(field)
         end
         search_config["passthrough_fields"] = fields
-        search_config["icon_field"] = "icon_url" unless search_config.key?("icon_field")
       end
 
       # Ensures a collection exists and is configured for output

data/lib/jekyll/documents/options_parser.rb

@@ -27,17 +27,21 @@ module Jekyll
           scanner.skip(/\s*/)
           next unless scanner.scan(":")
 
-          scanner.skip(/\s*/)
-          value = if scanner.scan(/'([^']*)'/) || scanner.scan(/"([^"]*)"/)
-                    scanner[1]
-                  else
-                    scanner.scan(/\S+/)
-                  end
+          value = read_value(scanner)
           options[key] = value unless value.nil?
         end
 
         options
       end
+
+      def read_value(scanner)
+        scanner.skip(/\s*/)
+        if scanner.scan(/'([^']*)'/) || scanner.scan(/"([^"]*)"/)
+          scanner[1]
+        else
+          scanner.scan(/\S+/)
+        end
+      end
     end
   end
 end

data/lib/jekyll/documents/tag_helpers.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Documents
+    # Shared markup parsing, document collection access, path
+    # normalization, and HTML escaping for the Liquid tags.
+    module TagHelpers
+      private
+
+      def parse_markup(markup)
+        text = markup.to_s
+        target, remainder = extract_target(text)
+        options = extract_options(remainder)
+        [target, options]
+      end
+
+      def extract_target(text)
+        return [nil, text] if text.strip.match?(/\Apath\s*:/)
+
+        quoted = text.match(/\A["']([^"']+)["']/)
+        return [quoted[1], text[quoted.end(0)..]] if quoted
+
+        bare = text.strip.match(/\A([^\s]+)/)
+        return [nil, ""] unless bare
+
+        [bare[1], text[bare.end(0)..]]
+      end
+
+      def extract_options(text)
+        OptionsParser.parse_options(text)
+      end
+
+      def documents_from(context)
+        site = context.registers[:site]
+        site.collections["documents"]&.docs || []
+      end
+
+      def normalize_tag_path(path)
+        path.to_s.strip.tr("\\", "/").squeeze("/").delete_prefix("./").delete_prefix("/")
+            .delete_suffix("/")
+      end
+
+      def escape_html(value)
+        value.to_s.gsub(/[&<>"']/,
+                        "&" => "&amp;",
+                        "<" => "&lt;",
+                        ">" => "&gt;",
+                        '"' => "&quot;",
+                        "'" => "&#39;")
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ module Jekyll
   module Documents
     module CategoryResolver
       include ResolutionReporter
+      include TagHelpers
 
       private
 
@@ -13,22 +14,28 @@ module Jekyll
         normalized = query.to_s.strip.downcase
         return nil if normalized.empty?
 
-        exact = categories.select do |category|
-          category_values(category).include?(normalized)
-        end
-        matches = exact.empty? ? partial_categories(categories, normalized) : exact
+        matches = match_categories(categories, normalized)
         aggregate = options["aggregate"] == "true" && options["list"] == "true"
         return matches if matches.one? || (aggregate && matches.any?)
         return nil if matches.empty?
 
+        report_ambiguous_category(site, query, matches)
+        nil
+      end
+
+      def match_categories(categories, normalized)
+        exact = categories.select { |cat| category_values(cat).include?(normalized) }
+        exact.empty? ? partial_categories(categories, normalized) : exact
+      end
+
+      def report_ambiguous_category(site, query, matches)
         paths = matches.map { |category| category["path"] }.sort.join(", ")
         message = "Ambiguous doc_category #{query.inspect}; matches: #{paths}. Rendering nothing."
         report_resolution_issue(site, message)
-        nil
       end
 
       def resolve_category_path(path, categories, site)
-        normalized = normalize_category_path(path)
+        normalized = normalize_tag_path(path)
         matches = categories.select { |category| category["path"] == normalized }
         return matches if matches.one?
 
@@ -48,17 +55,13 @@ module Jekyll
         leaf = category["path"].split("/").last.to_s.downcase
         [category["category"], category["slug"], leaf].map { |value| value.to_s.downcase }.uniq
       end
-
-      def normalize_category_path(path)
-        path.to_s.strip.tr("\\", "/").squeeze("/").delete_prefix("./").delete_prefix("/")
-            .delete_suffix("/")
-      end
     end
 
     class DocCategoryTag < Liquid::Tag
       public_class_method :new
 
       include CategoryResolver
+      include TagHelpers
       include Jekyll::Filters::URLFilters
 
       def initialize(tag_name, markup, tokens)
@@ -82,11 +85,6 @@ module Jekyll
 
       private
 
-      def documents_from(context)
-        site = context.registers[:site]
-        site.collections["documents"]&.docs || []
-      end
-
       def available_categories(docs)
         categories = docs.group_by { |doc| doc.data["category_path"] || doc.data["category"] }
                          .map do |path, matches|
@@ -131,38 +129,6 @@ module Jekyll
           out << %(<li><a href="#{url}">#{title}</a> <small>(#{date})</small></li>\n)
         end
       end
-
-      def parse_markup(markup)
-        text = markup.to_s
-        category, remainder = extract_category(text)
-        options = extract_options(remainder)
-        [category, options]
-      end
-
-      def extract_category(text)
-        return [nil, text] if text.strip.match?(/\Apath\s*:/)
-
-        quoted = text.match(/\A["']([^"']+)["']/)
-        return [quoted[1], text[quoted.end(0)..]] if quoted
-
-        bare = text.strip.match(/\A([^\s]+)/)
-        return [nil, ""] unless bare
-
-        [bare[1], text[bare.end(0)..]]
-      end
-
-      def extract_options(text)
-        OptionsParser.parse_options(text)
-      end
-
-      def escape_html(value)
-        value.to_s.gsub(/[&<>"']/,
-                        "&" => "&amp;",
-                        "<" => "&lt;",
-                        ">" => "&gt;",
-                        '"' => "&quot;",
-                        "'" => "&#39;")
-      end
     end
   end
 end

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

@@ -4,6 +4,7 @@ module Jekyll
   module Documents
     module DocumentResolver
       include ResolutionReporter
+      include TagHelpers
 
       private
 
@@ -13,25 +14,31 @@ module Jekyll
         normalized = query.to_s.strip.downcase
         return nil if normalized.empty?
 
-        exact = docs.select { |doc| document_values(doc).include?(normalized) }
-        matches = if exact.empty?
-                    docs.select do |doc|
-                      document_values(doc).any? { |value| value.include?(normalized) }
-                    end
-                  else
-                    exact
-                  end
+        matches = match_documents(docs, normalized)
         return matches.first if matches.one?
         return nil if matches.empty?
 
+        report_ambiguous(site, query, matches)
+        nil
+      end
+
+      def match_documents(docs, normalized)
+        exact = docs.select { |doc| document_values(doc).include?(normalized) }
+        return exact unless exact.empty?
+
+        docs.select do |doc|
+          document_values(doc).any? { |value| value.include?(normalized) }
+        end
+      end
+
+      def report_ambiguous(site, query, matches)
         paths = matches.map { |doc| doc.data["source_path"] || doc.path }.sort.join(", ")
         message = "Ambiguous doc_link #{query.inspect}; matches: #{paths}. Rendering nothing."
         report_resolution_issue(site, message)
-        nil
       end
 
       def find_document_by_path(docs, path, site)
-        normalized = normalize_identifier_path(path)
+        normalized = normalize_tag_path(path)
         matches = docs.select { |doc| doc.data["source_path"].to_s == normalized }
         return matches.first if matches.one?
 
@@ -42,11 +49,6 @@ module Jekyll
         nil
       end
 
-      def normalize_identifier_path(path)
-        path.to_s.strip.tr("\\", "/").squeeze("/").delete_prefix("./").delete_prefix("/")
-            .delete_suffix("/")
-      end
-
       def document_values(doc)
         [doc.data["title"], doc.data["slug"]].map { |value| value.to_s.downcase }
       end
@@ -56,6 +58,7 @@ module Jekyll
       public_class_method :new
 
       include DocumentResolver
+      include TagHelpers
       include Jekyll::Filters::URLFilters
 
       SIZE_UNITS = %w[B KB MB GB].freeze
@@ -81,11 +84,6 @@ module Jekyll
 
       private
 
-      def documents_from(context)
-        site = context.registers[:site]
-        site.collections["documents"]&.docs || []
-      end
-
       def build_link(doc, url, text)
         inner = +""
         inner << icon_html(doc) if @options["icon"] != "false"
@@ -127,38 +125,6 @@ module Jekyll
           value /= 1024
         end
       end
-
-      def parse_markup(markup)
-        text = markup.to_s
-        query, remainder = extract_query(text)
-        options = extract_options(remainder)
-        [query, options]
-      end
-
-      def extract_query(text)
-        return [nil, text] if text.strip.match?(/\Apath\s*:/)
-
-        quoted = text.match(/\A["']([^"']+)["']/)
-        return [quoted[1], text[quoted.end(0)..]] if quoted
-
-        bare = text.strip.match(/\A([^\s]+)/)
-        return [nil, ""] unless bare
-
-        [bare[1], text[bare.end(0)..]]
-      end
-
-      def extract_options(text)
-        OptionsParser.parse_options(text)
-      end
-
-      def escape_html(value)
-        value.to_s.gsub(/[&<>"']/,
-                        "&" => "&amp;",
-                        "<" => "&lt;",
-                        ">" => "&gt;",
-                        '"' => "&quot;",
-                        "'" => "&#39;")
-      end
     end
   end
 end

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

@@ -5,6 +5,7 @@ module Jekyll
     class DocumentIconTag < Liquid::Tag
       public_class_method :new
 
+      include TagHelpers
       include Jekyll::Filters::URLFilters
 
       def initialize(tag_name, markup, tokens)
@@ -47,15 +48,6 @@ module Jekyll
         expression = markup.to_s.strip[/\A[^\s]+/]
         [expression, OptionsParser.parse_options(markup)]
       end
-
-      def escape_html(value)
-        value.to_s.gsub(/[&<>"']/,
-                        "&" => "&amp;",
-                        "<" => "&lt;",
-                        ">" => "&gt;",
-                        '"' => "&quot;",
-                        "'" => "&#39;")
-      end
     end
   end
 end

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

@@ -10,45 +10,47 @@ module Jekyll
 
       public_class_method :new
 
+      include TagHelpers
+
       def render(context)
         site = context.registers[:site]
         cfg  = Configuration.read(site)
-        count = (@args["count"] || cfg["latest_default_count"] || 5).to_i
-        category = @args["category"]
+        count = resolve_count(cfg)
+        docs = select_documents(site, @args["category"], count)
+
+        render_list(docs)
+      end
 
+      private
+
+      def resolve_count(cfg)
+        (@args["count"] || cfg["latest_default_count"] || 5).to_i
+      end
+
+      def select_documents(site, category, count)
         docs = site.collections["documents"]&.docs || []
         docs = docs.select { |doc| doc.data["category"] == category } if category
-        docs = docs.sort_by { |doc| doc.data["date"] || Time.at(0) }.reverse.first(count)
+        docs.sort_by { |doc| doc.data["date"] || Time.at(0) }.reverse.first(count)
+      end
 
+      def render_list(docs)
         out = +"<ul class=\"latest-documents\">\n"
-        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
+        docs.each { |doc| out << list_item(doc) }
         out << "</ul>\n"
         out
       end
 
-      private
-
-      def escape_html(text)
-        return "" unless text
-
-        text.to_s.gsub(/[&<>"']/, {
-                         "&" => "&amp;",
-                         "<" => "&lt;",
-                         ">" => "&gt;",
-                         '"' => "&quot;",
-                         "'" => "&#39;"
-                       })
+      def list_item(doc)
+        data = doc.data
+        title = escape_html(data["title"])
+        url   = escape_html(doc.url)
+        date  = (data["date"] || Time.at(0)).strftime("%Y-%m-%d")
+        %(<li><a href="#{url}">#{title}</a> <small>(#{date})</small></li>\n)
       end
 
       # supports: count:5 category:'referat'
       def parse_args(markup)
-        OptionsParser.parse_options(markup)
+        extract_options(markup)
       end
     end
   end

data/lib/jekyll/documents/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Documents
-    VERSION = "0.7.2"
+    VERSION = "0.7.4"
   end
 end

data/lib/jekyll-documents.rb

@@ -12,6 +12,7 @@ require_relative "jekyll/documents/assets_generator"
 require_relative "jekyll/documents/json_index_generator"
 require_relative "jekyll/documents/layout_registrar"
 require_relative "jekyll/documents/options_parser"
+require_relative "jekyll/documents/tag_helpers"
 
 # Liquid tag(s)
 require_relative "jekyll/documents/tags/latest_documents"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-documents
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.4
 platform: ruby
 authors:
 - Svend Gundestrup
@@ -155,6 +155,7 @@ files:
 - lib/jekyll/documents/json_index_generator.rb
 - lib/jekyll/documents/layout_registrar.rb
 - lib/jekyll/documents/options_parser.rb
+- lib/jekyll/documents/tag_helpers.rb
 - lib/jekyll/documents/tags/doc_category.rb
 - lib/jekyll/documents/tags/doc_link.rb
 - lib/jekyll/documents/tags/document_icon.rb