jekyll-documents 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2e673dc309679ea3bc1ce25687bb9fbf52901f27b7b29517c63ef9337291e82
-  data.tar.gz: f89cef0e3d22c85665b516bd52da7f137b612c62c21f24e22ef33dc7a10170a8
+  metadata.gz: 76640be0741d32137905f8281bc4e83e4e895971a9ad39e7f360bccf06ba5eef
+  data.tar.gz: 93ac35f0606b84b474ef6aff260e21c7dab78ce5e4a8f7f80b4b97493755ae8d
 SHA512:
-  metadata.gz: 956c33415793dd9e285f9e81874b612278c188d0dd39237a1bbdeea7964af1d784655b171d7efbf485b37dfa948c02ade3703b4e82e1b411a90d9c2049cb0f65
-  data.tar.gz: c6069125baef1f06acbd58124f5993881b2e595a60b02e470fb0a8a3a94a764f62b0bbd8ad53320b325d614590aa494fb469f83674145f1924db945e1afc0e46
+  metadata.gz: db8fa1ad5fd90e910238d8b3b41427d8eeb8451ba70ca095cd610e26b56db88ae564e32856b6890c8c1e8af7b4a294fa8a9a9e7219fdd157bc7b0d80aa0c4181
+  data.tar.gz: a19a1da88694fd8282f3040a3bdad01ca5627667a116a984d16d916a875a346bb156bb371374b6b0ae241b6cbe2a97c8ecfc8cb40a1728960243ce1359e60e97

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-08-26
+
+### Added
+- `categories` array baked into each document's data (in addition to the existing singular `category`) for compatibility with search plugins like `jekyll-client-search` that expect the plural Jekyll convention
+- Searchable content string (title, category, file type, date) set as document content so client-side search engines can index uploaded documents
+
+### Changed
+- Refactored `Generator#generate` by extracting `bake_document_data` and `searchable_content` helper methods to keep method length within RuboCop limits
+
+### Changed
+- Simplified release workflow to tag-push trigger (`push: tags: v*`) — no manual `gh release create` needed
+- Switched to RubyGems trusted publishing (`rubygems/release-gem@v1` with OIDC)
+- Centralized version in `version.rb` as single source of truth — removed `version` field from `package.json` (was drifted to 0.3.1)
+- Added `rake version:bump` and `rake version:check_changelog` tasks
+- Added CHANGELOG gate to release workflow (fails if entry missing for the version)
+- Added `npm audit` and `npm outdated` (non-blocking) to CI
+- Replaced `setup_hooks.sh` with `bin/install-hooks.sh` (pre-commit: rubocop only, pre-push: rubocop + rspec)
+- Dropped reek from gemspec, Rakefile, and deleted `.reek.yml` (KISS)
+- Deleted `bump_version.sh`, `release.sh`, `rollback.sh` — replaced by rake tasks and release workflow
+- Renamed `AI_INSTRUCTIONS.md` to `AGENTS.md` (agents.md open convention)
+- Updated `CLAUDE.md` and `.windsurfrules` to point to `AGENTS.md`
+
 ## [0.3.3] - 2026-08-12
 
 ### Added

data/README.md

@@ -139,8 +139,13 @@ See [README.Development.md](README.Development.md) for details.
 ## Release
 
 ```bash
-./bump_version.sh patch
-./release.sh
+bundle exec rake "version:bump[patch]"
+# Edit CHANGELOG.md
+git add lib/jekyll/documents/version.rb CHANGELOG.md
+git commit -m "Release X.Y.Z: summary"
+git tag -a vX.Y.Z -m "Release X.Y.Z"
+git push origin main
+git push origin vX.Y.Z
 ```
 
 ## License

data/jekyll-documents.gemspec

@@ -35,7 +35,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler-audit", "~> 0.9"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "reek", "~> 6.5"
   spec.add_development_dependency "rspec", "~> 3.13"
   spec.add_development_dependency "rubocop", "~> 1.88"
   spec.add_development_dependency "rubocop-performance", "~> 1.26"

data/lib/jekyll/documents/generator.rb

@@ -55,24 +55,10 @@ module Jekyll
             collection: collection
           )
 
-          data = doc.data
-          data["layout"]     = @config["layout"]
-          data["title"]      = title
-          data["date"]       = date ? date.to_time : 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["file_size"]  = File.size(path)
-          data["slug"]       = slug
-          data["permalink"]  = @config["permalink"]
-                               .gsub(":category", data["category"].to_s)
-                               .gsub(":slug", slug)
-
-          doc.content = "Auto-generated document page."
-
+          file_info = { title: title, date: date, category: category,
+                        rel_path: rel_path, ext: ext, file_type: file_type,
+                        icon_set: icon_set, slug: slug, path: path }
+          bake_document_data(doc, file_info)
           collection.docs << doc
         end
       end
@@ -92,6 +78,33 @@ module Jekyll
         site.collections[label]
       end
 
+      def searchable_content(title, data, file_type)
+        date_str = data["date"].strftime("%Y-%m-%d")
+        "#{title} #{data['category']} #{file_type} #{date_str}"
+      end
+
+      def bake_document_data(doc, info)
+        data = doc.data
+        category = remap_category(info[:category])
+        data["layout"]     = @config["layout"]
+        data["title"]      = info[:title]
+        data["date"]       = info[:date] ? info[:date].to_time : File.mtime(info[:path])
+        data["category"]   = category
+        data["categories"] = [category] if category
+        data["file_url"]   = "/#{info[:rel_path]}"
+        data["extension"]  = info[:ext]
+        data["file_type"]  = info[:file_type]
+        data["icon_set"]   = info[:icon_set]
+        icon = FileTypeIcons.icon_for(info[:file_type], info[:icon_set])
+        data["icon_url"]   = icon
+        data["file_size"]  = File.size(info[:path])
+        data["slug"]       = info[:slug]
+        data["permalink"]  = @config["permalink"]
+                             .gsub(":category", category.to_s)
+                             .gsub(":slug", info[:slug])
+        doc.content = searchable_content(info[:title], data, info[:file_type])
+      end
+
       # Creates a virtual source path for the document
       # @param basename [String] the file basename
       # @param category [String] the document category

data/lib/jekyll/documents/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Documents
-    VERSION = "0.3.3"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-documents
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Svend Gundestrup
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,20 +57,6 @@ 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.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -282,7 +267,6 @@ metadata:
   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
@@ -297,8 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Auto-generate Jekyll pages for documents (PDF/DOCX/...) with category/date/title
   parsing.