jekyll-documents 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6c0e2569d3772c02fe174700001a8290d7b313e7b068781d21627172d9e785
-  data.tar.gz: 407cc042bf5b2de1fe1b01cf9c9043bd961c811de7d0e6ee2dc896b1ab29e1dc
+  metadata.gz: c690ba4e56790f19326b49d3476839028784f9da66b4d46d5a18680cac0ba927
+  data.tar.gz: 6007f855de36ef230b789fdab081877f19c9be15c583a342e669eaa811898317
 SHA512:
-  metadata.gz: d9016ce9608b013d8b0b6ac4d3756512d99a17cb55d5c2d2d67e096ccb5175e07ca40a17c68629dd09c684b5291fcad0ea1b876d74e7e58b0fedff0a7d1b97c7
-  data.tar.gz: f13021dccbed117f29e6c3f2c3d70f9ba9c499f3008ba30083f69c710ba3b30753a72009e3b84fa7fed64c3c73e8a85d20630cbe26de46623a38fb7766cd3986
+  metadata.gz: ecc1cbd701f3b07f70694dd0a9f7314d7d65bb2b2040ad0af3658d763ad540bb40daf90e1494100e49ab72a10540377786d793a2416536cc055f85a16983fcb7
+  data.tar.gz: dbab2960b310640f780b3d88695ec16cbdf1902fba99019736bedf7ab3ecf0a6f956c370b9b3c8858ad559f4f40fe7a6f354843a7ceef790e97010f751c898cc

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # 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

data/README.md

@@ -8,6 +8,7 @@
 [![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/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
 
@@ -34,7 +35,7 @@ module Jekyll
       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?
 
@@ -54,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)
@@ -88,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|
@@ -137,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
 
@@ -37,7 +38,7 @@ module Jekyll
       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?
 
@@ -48,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
@@ -62,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
@@ -87,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"
@@ -133,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,21 +10,29 @@ 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"]
-
-        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)
+        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.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 { |doc| out << list_item(doc) }
@@ -40,21 +48,9 @@ module Jekyll
         %(<li><a href="#{url}">#{title}</a> <small>(#{date})</small></li>\n)
       end
 
-      def escape_html(text)
-        return "" unless text
-
-        text.to_s.gsub(/[&<>"']/, {
-                         "&" => "&amp;",
-                         "<" => "&lt;",
-                         ">" => "&gt;",
-                         '"' => "&quot;",
-                         "'" => "&#39;"
-                       })
-      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.3"
+    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.3
+  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