jekyll-pagefind 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7354120e9ae2690548d13b7f1caca98d7d9565b3326c1dca67ec417c82c0be12
-  data.tar.gz: cb762ce2575300b20c80cba8c99e6dd3cc2981af14101b3f8e657679b9ed5197
+  metadata.gz: c6a6ae1c10bcf3ddee440029416aa37c11b0d70e5f90a59e1685691f0a87f65e
+  data.tar.gz: 145d9445e2fcbf64a2671ede567f55aedd69c97431c29032add38fd29593ae91
 SHA512:
-  metadata.gz: 4110df9a227f32c095f5b569a59b103794c842f935ecb5ef717daa20cc87398ff8d1480a518601728bcc69ad9d3779e5fc3cb489fdac65d14561b50dfafcca65
-  data.tar.gz: 90a8d55735e526c12fed6cae896a9c1c03b19bd547a6c04c1039c216b34a851fbeed0846ad8603e7ebc270f774bca1c01732cf0669b2ff8174f1005cbf86fc57
+  metadata.gz: e0ae99d131a81b48e55c73f01c63bf17dfdf1badea3a66244d2fce2d563610e20af64d3bf1d73636e20bd4d4012ad70784f7df6db66b5f9876ea1b76427a09ea
+  data.tar.gz: c8d0cc4a8cc1ac8ce6b36b7f4c96150f30e37cbf7c4e43d4e41ef10d7fff85f50ee7638b2c2544a84681352a8efb89896f22ec957244845ba2ada14c86bba995

data/README.md

@@ -38,6 +38,9 @@ If Bundler is not being used to manage dependencies, install the gem by running:
 gem install jekyll-pagefind
 ```
 
+RubyGems will install the platform-specific package that matches the host OS and CPU.
+If no matching platform gem is selected, the generic `ruby` gem raises a clear error telling the user to add the deploy platform to `Gemfile.lock`.
+
 ## Use
 
 ### Jekyll site configuration
@@ -176,12 +179,60 @@ For dark mode:
 }
 ```
 
-For more details, see [Using the Default UI](https://pagefind.app/docs/search-ui/).
+For more details, see [Pagefind Component UI](https://pagefind.app/docs/search-ui/).
 
 ---
 
 ## Contributing
 
+## Maintainer Release Notes
+
+This gem is published as platform-specific packages so users only download the binary for their host OS.
+
+Build the current host variant:
+
+```sh
+make build
+```
+
+Run the fixture-based smoke test:
+
+```sh
+make smoke-test
+```
+
+Build every supported variant:
+
+```sh
+make build-all
+```
+
+Publish the built platform gems for a version:
+
+```sh
+make publish
+```
+
+GitHub Actions trusted publishing is supported.
+
+To enable it on RubyGems.org for this repo:
+
+1. Open the `jekyll-pagefind` gem page.
+2. Go to `Trusted publishers`.
+3. Create a publisher with repository `phothinmg/jekyll-pagefind`, workflow filename `release.yml`, and environment `release`.
+
+After that, pushing a tag like `v0.3.2` will run `.github/workflows/release.yml` and publish all built gems without a stored API token or manual OTP entry.
+
+`bin/build-platform-gems` currently maps these asset folders to RubyGems platforms:
+
+- `ruby` -> `ruby` (generic fallback gem with no bundled binary)
+- `assets/linux-x64` -> `x86_64-linux-gnu`, `x86_64-linux-musl`
+- `assets/linux-arm64` -> `aarch64-linux-gnu`, `aarch64-linux-musl`
+- `assets/macos-x64` -> `x86_64-darwin`
+- `assets/macos-arm64` -> `arm64-darwin`
+- `assets/windows-x64` -> `x64-mingw32`, `x64-mingw-ucrt`
+- `assets/windows-arm64` -> `arm64-mingw32`, `arm64-mingw-ucrt`
+
 Bug reports and pull requests are welcome on GitHub at <https://github.com/phothinmg/jekyll-pagefind>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/phothinmg/jekyll-pagefind/blob/master/CODE_OF_CONDUCT.md).
 
 ## License

data/jekyll-pagefind.gemspec

@@ -1,10 +1,30 @@
 # frozen_string_literal: true
 
+require "rbconfig"
 require_relative "lib/version"
 
+host_os = RbConfig::CONFIG["host_os"]
+host_cpu = RbConfig::CONFIG["host_cpu"]
+
+default_pagefind_asset_directory = case host_os
+                                   when /darwin|mac os/i
+                                     host_cpu =~ /arm64|aarch64/i ? "assets/macos-arm64" : "assets/macos-x64"
+                                   when /linux/i
+                                     host_cpu =~ /arm64|aarch64/i ? "assets/linux-arm64" : "assets/linux-x64"
+                                   when /mswin|msys|mingw|cygwin|bccwin/i
+                                     host_cpu =~ /arm64|aarch64/i ? "assets/windows-arm64" : "assets/windows-x64"
+                                   else
+                                     raise "Unable to determine a default Pagefind asset directory for host environment: #{host_os} (#{host_cpu})" # rubocop:disable Layout/LineLength
+                                   end
+
+pagefind_asset_directory = ENV.fetch("PAGEFIND_ASSET_DIR", default_pagefind_asset_directory)
+pagefind_gem_platform = ENV.fetch("PAGEFIND_GEM_PLATFORM", Gem::Platform::RUBY)
+pagefind_include_assets = ENV.fetch("PAGEFIND_INCLUDE_ASSETS", "true") == "true"
+
 Gem::Specification.new do |spec|
   spec.name = "jekyll-pagefind"
   spec.version = Jekyll::Pagefind::VERSION
+  spec.platform = Gem::Platform.new(pagefind_gem_platform)
   spec.authors = ["phothinmg"]
   spec.email = ["phothinmg@disroot.org"]
 
@@ -13,12 +33,15 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://rubygems.org/gems/jekyll-pagefind"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/phothinmg/jekykll-pagefind"
   spec.metadata["changelog_uri"] = "https://github.com/phothinmg/jekykll-pagefind/blob/main/CHANGELOG.md"
 
   spec.files = Dir.chdir(__dir__) do
-    Dir["README.md", "LICENSE.txt", "lib/**/*", "assets/**/*", "jekyll-pagefind.gemspec"]
+    files = ["README.md", "LICENSE.txt", "lib/**/*", "jekyll-pagefind.gemspec"]
+    files << "#{pagefind_asset_directory}/**/*" if pagefind_include_assets
+    Dir[*files]
   end
   spec.require_paths = ["lib"]
   spec.add_dependency "jekyll", "~> 4.4"

data/lib/jekyll-pagefind.rb

@@ -3,6 +3,7 @@
 require "rbconfig"
 require "open3"
 require "jekyll"
+require "shellwords"
 
 require_relative "version"
 
@@ -46,7 +47,7 @@ module Jekyll
     end
 
     # valid the cli flag
-    def self.valid_args(arg)
+    def self.valid_arg?(arg)
       %w[output_subdir exclude_selectors keep_index_url quiet].include?(arg)
     end
 
@@ -56,7 +57,7 @@ module Jekyll
       args = []
 
       plugin_config.each do |key, value|
-        next unless valid_args(key)
+        next unless valid_arg?(key)
 
         # Transform snake_case keys to kebab-case (e.g., keep_index_url -> keep-index-url)
         flag_name = key.to_s.gsub("_", "-")
@@ -79,7 +80,7 @@ module Jekyll
       args.join(" ")
     end
 
-    def self.run_pagefind(site_destination, extra_arguments = "") # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def self.run_pagefind(site_destination, extra_arguments = "") # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
       binary = pagefind_binary_path
 
       # Force execution bits on UNIX hosts because gem unpacking can reset permissions flags
@@ -89,14 +90,20 @@ module Jekyll
       end
 
       # Combine the mandatory --site parameter with any user-defined configuration flags
-      full_command = "#{binary} --site \"#{site_destination}\" #{extra_arguments}".strip
+      full_command = [
+        Shellwords.escape(binary),
+        "--site",
+        Shellwords.escape(site_destination),
+        extra_arguments
+      ].join(" ").strip
+      started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
-      Jekyll.logger.info "Jekyll-Pagefind:", "Running command: #{full_command}"
-      stdout, stderr, status = Open3.capture3(full_command)
+      Jekyll.logger.info "Jekyll-Pagefind:", "Running Pagefind..."
+      _stdout, stderr, status = Open3.capture3(full_command)
 
       if status.success?
-        Jekyll.logger.info "Jekyll-Pagefind:", "Indexing finished successfully!"
-        puts stdout
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at
+        Jekyll.logger.info "Jekyll-Pagefind:", format("Done in %.2fs", elapsed)
       else
         Jekyll.logger.error "Jekyll-Pagefind Error:", stderr
         raise "Pagefind binary exited with non-zero status code: #{status.exitstatus}"
@@ -107,8 +114,8 @@ end
 
 # Hook ensures Jekyll is entirely done writing HTML pages to disk
 Jekyll::Hooks.register :site, :post_write do |site|
-  # 1. Parse your plugin settings out of site.config
+  # Parse plugin settings out of site.config
   custom_flags = Jekyll::Pagefind.build_cli_arguments(site.config)
-  # 2. Run Pagefind with the compiled flags
+  # Run Pagefind with the compiled flags
   Jekyll::Pagefind.run_pagefind(site.dest, custom_flags)
 end

data/lib/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Pagefind
-    VERSION = "0.3.0"
+    VERSION = "0.3.3"
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pagefind
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - phothinmg
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -46,12 +47,6 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- assets/linux-arm64/pagefind
-- assets/linux-x64/pagefind
-- assets/macos-arm64/pagefind
-- assets/macos-x64/pagefind
-- assets/windows-arm64/pagefind.exe
-- assets/windows-x64/pagefind.exe
 - jekyll-pagefind.gemspec
 - lib/jekyll-pagefind.rb
 - lib/version.rb
@@ -59,9 +54,11 @@ homepage: https://rubygems.org/gems/jekyll-pagefind
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   homepage_uri: https://rubygems.org/gems/jekyll-pagefind
   source_code_uri: https://github.com/phothinmg/jekykll-pagefind
   changelog_uri: https://github.com/phothinmg/jekykll-pagefind/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,7 +73,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Pagefind plugin for Jekyll
 test_files: []