RubyGems - jekyll-documents - Versions diffs - 0.1.1 → 0.2.0 - Mend

jekyll-documents 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +38 -0
data/README.md +24 -51
data/jekyll-documents.gemspec +23 -6
data/lib/jekyll/documents/file_type_icons.rb +7 -4
data/lib/jekyll/documents/filters.rb +3 -3
data/lib/jekyll/documents/generator.rb +16 -10
data/lib/jekyll/documents/json_index_generator.rb +5 -5
data/lib/jekyll/documents/tags/latest_documents.rb +10 -8
data/lib/jekyll/documents/version.rb +1 -1
metadata +86 -7

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 518470aad866ef5e32081999ae94d7d8bc3ab87a1f19240a66a2152b13a7db87
-  data.tar.gz: 392d655c0163d3274b3b9e679009aa66d89ab87802e359a5c520b05fdb666897
+  metadata.gz: d806534ca1d7d2b56106885f003e99845646369f842d03a01ac330a5f8dbaacc
+  data.tar.gz: 50ff80ef20340823fd852265f87f90d6eb630aa56e3795cfc2ca3a58b94fb612
 SHA512:
-  metadata.gz: c1152712cbdef7b491ab32618bee51ffc7fa02d45f92eff6e92c1d5fc07ba7b00f787550e18a0554e3909b0e96cfb64edb6102a9b5477f9e1da40b44df4f4a76
-  data.tar.gz: 40b4cc7ff588faf52d29b59229c82f3088d1063495640c3a86c3bbb1b7e1d042a2f1014b065bf6bd3e0713c760d772245f37e3491bdb3cc44e56d37030cddbe5
+  metadata.gz: cf282187748db50d46e256dcee6f2f9b8b7e34f5e265acf35b4b1d4a5bda55950b66a668000f58aacad9195241c0b8e30e84fd06ad493be2cbc4f238cb3b28ed
+  data.tar.gz: 95bd40229f6c2cd987e35bf6fab49d89f09a6070bbacf2bb5cedf412866bc368f458e367804a19e4f2fa1479cd2cfdbfab13acfce0ccc9af69aee9fa9be2b294

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,43 @@
 # Changelog
+## [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 CHANGED Viewed

@@ -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/jekyll-documents.gemspec CHANGED Viewed

@@ -3,16 +3,28 @@
 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.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 = ">= 2.7"
   spec.files         = Dir.glob("{lib,assets,_includes,_layouts}/**/*") +
@@ -20,8 +32,13 @@ Gem::Specification.new do |spec|
   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", "~> 0.22"
   spec.add_development_dependency "yard", "~> 0.9"
 end

data/lib/jekyll/documents/file_type_icons.rb CHANGED Viewed

@@ -104,7 +104,8 @@ module Jekyll
       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"
+        icons[file_type.to_s.downcase] ||
+          "/assets/icons/#{icon_set}/unknown-document-svgrepo-com.svg"
       end
       # Returns an HTML img tag for the file type icon
@@ -114,7 +115,8 @@ 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"
@@ -128,13 +130,14 @@ 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
         return "color" unless icon_set && ICON_MAP.key?(icon_set)
         icon_set
       end
     end

data/lib/jekyll/documents/filters.rb CHANGED Viewed

@@ -9,12 +9,12 @@ module Jekyll
       }.freeze
       # Slugify while handling Danish letters and basic punctuation cleanup.
-      def documents_slugify(input, downcase = true, danish_map = true)
+      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.tr(" ", "-").squeeze("-")
+        s = s.gsub(/[æøåÆØÅ]/, "") unless danish_map # Remove Danish chars if mapping disabled
         s = s.downcase if downcase
         s
       end

data/lib/jekyll/documents/generator.rb CHANGED Viewed

@@ -35,14 +35,14 @@ 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.start_with?(site.source) ? path[(site.source.length + 1)..] : path
           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)
@@ -57,13 +57,13 @@ module Jekyll
           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["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)
+                                   .gsub(":category", doc.data["category"].to_s)
+                                   .gsub(":slug", slug)
           doc.content = "Auto-generated document page."
@@ -99,7 +99,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 +117,8 @@ 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)}")
+          date = Date.parse("#{Regexp.last_match(1)}-#{Regexp.last_match(2)}-" \
+                            "#{Regexp.last_match(3)}")
           title = Regexp.last_match(4).tr("_", " ")
           [date, title, true]
         else
@@ -131,10 +133,14 @@ module Jekyll
       # @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"]
+        if @config["slug_danish_map"]
+          s = s.gsub(/[æøåÆØÅ]/,
+                     { "æ" => "ae", "ø" => "oe", "å" => "aa", "Æ" => "Ae", "Ø" => "Oe",
+                       "Å" => "Aa" })
+        end
         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 = s.gsub(/[^\p{Alnum}\-_\s]/u, "").tr("_ ", "--").squeeze("-")
+        s = s.sub(/^-+/, "").sub(/-+$/, "") # Remove leading/trailing hyphens
         s.empty? ? "untitled" : s
       end
     end

data/lib/jekyll/documents/json_index_generator.rb CHANGED Viewed

@@ -18,11 +18,11 @@ module Jekyll
         items = docs.map do |d|
           {
-            "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"],
+            "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"]
           }

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

@@ -7,7 +7,7 @@ module Jekyll
         super
         @args = parse_args(markup)
       end
       public_class_method :new
       def render(context)
@@ -35,18 +35,21 @@ 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 = {}
+        # 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 |m|
           if m[0]
             args[m[0]] = m[1]
@@ -61,4 +64,3 @@ module Jekyll
 end
 Liquid::Template.register_tag("latest_documents", Jekyll::Documents::LatestDocumentsTag)

data/lib/jekyll/documents/version.rb CHANGED Viewed

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

metadata CHANGED Viewed

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-documents
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.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: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !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
@@ -208,7 +286,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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.