jekyll-client-search 0.1.0

data/lib/jekyll/client_search/runtime_config_page.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ClientSearch
+    # Generates browser runtime settings shared by all search adapters.
+    class RuntimeConfigPage < Jekyll::PageWithoutAFile
+      def initialize(site, configuration)
+        super(site, site.source, "assets", "search-runtime-config.js")
+        self.data = { "layout" => nil, "sitemap" => false }
+        defaults = {
+          "indexUrl" => index_url(site, configuration.output),
+          "liveSearch" => configuration.live_search_config
+        }
+        defaults["relatedUrl"] = index_url(site, configuration.related_output) if configuration.related_enabled?
+        json = JSON.generate(defaults)
+        self.content = "window.clientSearchConfig = (function (generated, existing) {" \
+                       "var liveSearch = Object.assign({}, generated.liveSearch, existing.liveSearch || {});" \
+                       "return Object.assign(generated, existing, { liveSearch: liveSearch });" \
+                       "}(#{json}, window.clientSearchConfig || {}));\n"
+      end
+
+      private
+
+      def index_url(site, output)
+        parts = [site.baseurl, output].map { |part| part.to_s.gsub(%r{\A/+|/+$}, "") }.reject(&:empty?)
+        "/#{parts.join('/')}"
+      end
+    end
+  end
+end

data/lib/jekyll/client_search/search_index_page.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ClientSearch
+    # A Jekyll page that renders the search documents as JSON at the
+    # configured output path.
+    class SearchIndexPage < Jekyll::PageWithoutAFile
+      def initialize(site, output, documents)
+        super(site, site.source, File.dirname(output), File.basename(output))
+        self.data = { "layout" => nil, "sitemap" => false }
+        self.content = JSON.generate(documents)
+      end
+    end
+  end
+end

data/lib/jekyll/client_search/search_tag.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ClientSearch
+    # Liquid tag that renders the search form, status/results containers,
+    # and all runtime scripts in one line — config-driven so changing engines
+    # in _config.yml requires zero template changes.
+    #
+    #   {% search_form %}
+    #   {% search_form scripts_only %}  — just scripts (custom form HTML)
+    #   {% search_form no_scripts %}    — just form HTML (user loads scripts)
+    #
+    # When client_search is disabled the tag renders nothing.
+    class SearchTag < Liquid::Tag
+      SYNTAX = /\A\s*(scripts_only|no_scripts)?\s*\z/
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @markup = markup.to_s
+        unless (match = @markup.match(SYNTAX))
+          raise Liquid::SyntaxError,
+                "search_form: invalid syntax. Use {% search_form %}, " \
+                "{% search_form scripts_only %}, or {% search_form no_scripts %}"
+        end
+
+        @mode = match[1] || "full"
+      end
+
+      def render(context)
+        site = context.registers[:site]
+        config_hash = site&.config&.fetch("client_search", {})
+        return "" unless config_hash["enabled"] != false
+
+        configuration = Configuration.new(site)
+        baseurl = site.config["baseurl"].to_s.gsub(%r{\A/+|/+$}, "")
+        prefix = baseurl.empty? ? "" : "/#{baseurl}"
+
+        form_html = build_form
+        return form_html if @mode == "no_scripts"
+
+        scripts = build_scripts(configuration, prefix)
+        return scripts if @mode == "scripts_only"
+
+        "#{form_html}\n#{scripts}"
+      end
+
+      private
+
+      def build_form
+        <<~HTML
+          <form id="search-form" role="search">
+            <label class="is-sr-only" for="search-query">Search</label>
+            <input id="search-query" type="search" name="q" placeholder="Search">
+            <button type="submit">Search</button>
+          </form>
+          <div id="search-status" aria-live="polite"></div>
+          <div id="search-results"></div>
+        HTML
+      end
+
+      def build_scripts(configuration, prefix)
+        scripts = []
+        engine = engine_script(configuration)
+        scripts << engine if engine
+        scripts << "<script src=\"#{prefix}/assets/search-runtime-config.js\"></script>"
+        scripts.concat(embedder_scripts(configuration, prefix))
+        scripts << "<script src=\"#{prefix}/assets/client-search-base.js\"></script>"
+        scripts << "<script src=\"#{prefix}/assets/adapters/#{configuration.engine}.js\"></script>"
+        scripts.map { |script| "  #{script}" }.join("\n")
+      end
+
+      def engine_script(configuration)
+        url = configuration.engine_url
+        return nil unless url
+
+        attrs = ["src=\"#{url}\""]
+        attrs << "crossorigin=\"#{configuration.engine_crossorigin}\"" if configuration.engine_crossorigin
+        attrs << "integrity=\"#{configuration.engine_sri}\"" if configuration.engine_sri
+        "<script #{attrs.join(' ')}></script>"
+      end
+
+      def embedder_scripts(configuration, prefix)
+        return [] unless semantic_with_embedder?(configuration)
+
+        scripts = ["<script src=\"#{prefix}/assets/search-embedder-config.js\"></script>"]
+        embedder_asset = configuration.query_embedder_asset
+        scripts << "<script src=\"#{prefix}/#{embedder_asset}\"></script>" if embedder_asset
+        scripts
+      end
+
+      def semantic_with_embedder?(configuration)
+        configuration.engine == "semantic" &&
+          configuration.embedding_enabled? &&
+          configuration.query_embedder_type != "none"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("search_form", Jekyll::ClientSearch::SearchTag)

data/lib/jekyll/client_search/tasks.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "rubygems"
+
+module Jekyll
+  module ClientSearch
+    # Rake tasks for inspecting and installing reference files.
+    #
+    # Tasks:
+    #   jekyll_client_search:reference_files — list gem reference files,
+    #     diff against site copies, offer to update
+    #   jekyll_client_search:install — copy reference files into the site's
+    #     _layouts/ and _includes/ directories
+    module Tasks
+      REFERENCE_FILES = {
+        "assets/layouts/post-with-related.html" => "_layouts/post-with-related.html",
+        "assets/includes/related-articles.html" => "_includes/related-articles.html"
+      }.freeze
+
+      class << self
+        def gem_root
+          spec = Gem::Specification.find_by_name("jekyll-client-search")
+          spec.gem_dir
+        rescue Gem::MissingSpecError
+          # Fall back to the development source directory
+          File.expand_path("../../..", __dir__)
+        end
+
+        def reference_files
+          REFERENCE_FILES
+        end
+
+        def site_root
+          Dir.pwd
+        end
+
+        def list_reference_files
+          puts "jekyll-client-search reference files:"
+          puts
+          reference_files.each do |gem_rel, site_rel|
+            gem_path = File.join(gem_root, gem_rel)
+            site_path = File.join(site_root, site_rel)
+            site_exists = File.exist?(site_path)
+
+            status = if !site_exists
+                       "not installed"
+                     elsif same_content?(gem_path, site_path)
+                       "up to date"
+                     else
+                       "modified or outdated"
+                     end
+
+            puts "  #{site_rel}"
+            puts "    gem:     #{gem_path}"
+            puts "    site:    #{site_path}"
+            puts "    status:  #{status}"
+            puts
+          end
+        end
+
+        def diff_reference_files
+          reference_files.each do |gem_rel, site_rel|
+            gem_path = File.join(gem_root, gem_rel)
+            site_path = File.join(site_root, site_rel)
+
+            unless File.exist?(site_path)
+              puts "#{site_rel}: not installed (no diff)"
+              next
+            end
+
+            if same_content?(gem_path, site_path)
+              puts "#{site_rel}: up to date"
+            else
+              puts "Diff for #{site_rel}:"
+              system("diff", "-u", site_path, gem_path)
+              puts
+            end
+          end
+        end
+
+        def install_reference_files(overwrite: false)
+          installed = []
+          skipped = []
+
+          reference_files.each do |gem_rel, site_rel|
+            result = install_file(gem_rel, site_rel, overwrite: overwrite)
+            case result
+            when :installed then installed << site_rel
+            when :skipped then skipped << site_rel
+            end
+          end
+
+          { installed: installed, skipped: skipped }
+        end
+
+        def install_file(gem_rel, site_rel, overwrite:)
+          gem_path = File.join(gem_root, gem_rel)
+          site_path = File.join(site_root, site_rel)
+
+          unless File.exist?(gem_path)
+            warn "  WARNING: gem file missing: #{gem_path}"
+            return nil
+          end
+
+          return handle_existing(site_rel, gem_path, site_path) if File.exist?(site_path) && !overwrite
+
+          copy_file(gem_path, site_path, site_rel, overwrite)
+        end
+
+        def handle_existing(site_rel, gem_path, site_path)
+          if same_content?(gem_path, site_path)
+            puts "  #{site_rel}: already up to date (skip)"
+            nil
+          else
+            puts "  #{site_rel}: exists and differs (skip — use overwrite: true to replace)"
+            :skipped
+          end
+        end
+
+        def copy_file(gem_path, site_path, site_rel, overwrite)
+          FileUtils.mkdir_p(File.dirname(site_path))
+          FileUtils.cp(gem_path, site_path)
+          action = overwrite ? "updated" : "installed"
+          puts "  #{site_rel}: #{action}"
+          :installed
+        end
+
+        def same_content?(path_a, path_b)
+          File.read(path_a) == File.read(path_b)
+        rescue Errno::ENOENT
+          false
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/client_search/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ClientSearch
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/client_search.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "cgi/escape"
+require "json"
+require "jekyll"
+require "pathname"
+require "time"
+require_relative "client_search/version"
+require_relative "client_search/embedding_configuration"
+require_relative "client_search/live_search_configuration"
+require_relative "client_search/related_configuration"
+require_relative "client_search/query_embedder_configuration"
+require_relative "client_search/configuration_accessors"
+require_relative "client_search/configuration"
+require_relative "client_search/document_builder"
+require_relative "client_search/search_index_page"
+require_relative "client_search/runtime_config_page"
+require_relative "client_search/related_analyzer"
+require_relative "client_search/related_page"
+require_relative "client_search/embedder_config_page"
+require_relative "client_search/index_cache"
+require_relative "client_search/ollama_embedding_adapter"
+require_relative "client_search/generator"
+require_relative "client_search/related_tag"
+require_relative "client_search/search_tag"

data/lib/jekyll-client-search.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "jekyll/client_search"

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-client-search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Svend Gundestrup
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A Jekyll plugin that generates a configurable JSON search index with
+  pluggable browser runtime adapters for client-side JavaScript search engines.
+email:
+- svend@gundestrup.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- NOTICE
+- README.developer.md
+- README.md
+- assets/adapters/elasticlunr.js
+- assets/adapters/minisearch.js
+- assets/adapters/semantic.js
+- assets/client-search-base.js
+- assets/client-search-related.js
+- assets/includes/related-articles.html
+- assets/layouts/post-with-related.html
+- assets/query-embedders/ollama-api.js
+- assets/query-embedders/transformers-worker.js
+- assets/query-embedders/transformers.js
+- docs/assets/icon-256.png
+- docs/assets/icon.svg
+- lib/jekyll-client-search.rb
+- lib/jekyll/client_search.rb
+- lib/jekyll/client_search/configuration.rb
+- lib/jekyll/client_search/configuration_accessors.rb
+- lib/jekyll/client_search/document_builder.rb
+- lib/jekyll/client_search/embedder_config_page.rb
+- lib/jekyll/client_search/embedding_configuration.rb
+- lib/jekyll/client_search/generator.rb
+- lib/jekyll/client_search/index_cache.rb
+- lib/jekyll/client_search/live_search_configuration.rb
+- lib/jekyll/client_search/ollama_embedding_adapter.rb
+- lib/jekyll/client_search/query_embedder_configuration.rb
+- lib/jekyll/client_search/related_analyzer.rb
+- lib/jekyll/client_search/related_configuration.rb
+- lib/jekyll/client_search/related_page.rb
+- lib/jekyll/client_search/related_tag.rb
+- lib/jekyll/client_search/runtime_config_page.rb
+- lib/jekyll/client_search/search_index_page.rb
+- lib/jekyll/client_search/search_tag.rb
+- lib/jekyll/client_search/tasks.rb
+- lib/jekyll/client_search/version.rb
+homepage: https://github.com/gundestrup/jekyll-client-search
+licenses:
+- AGPL-3.0-or-later
+metadata:
+  homepage_uri: https://github.com/gundestrup/jekyll-client-search
+  source_code_uri: https://github.com/gundestrup/jekyll-client-search/tree/main
+  changelog_uri: https://github.com/gundestrup/jekyll-client-search/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/gundestrup/jekyll-client-search/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Build client-side search indexes for Jekyll sites
+test_files: []