sitepress-pagefind 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db070f8c3379862fe48bc773ac0e7fdb00844f2511720788f11f46d05ba90e96
+  data.tar.gz: 26bb73b6d8e5d7efc4770973838d222f1e033a2d3c3e3f82c9ed375e3c0e8174
+SHA512:
+  metadata.gz: a66f5bf3f6f3c2d20c5fb2eb185f4a25ce691219358927e5415bf6f94af64a39f70d299fe852da43470eb3f3f4e7e41ffc27869ec981f445c24186640e67dc4e
+  data.tar.gz: 6203881e2551d8db8f9b2d294ca33445f3c8da357336c5eee737bb442ddeb0656cac5bc67121036593981efd3d01ee4ce14d60f78071fb4c716439a0b4b73370

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Julian Rubisch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Sitepress::Pagefind
+A [Pagefind](https://pagefind.app/) integration for [Sitepress-Rails](https://sitepress.cc/getting-started/rails)
+
+> [!IMPORTANT]
+> For now, this plugin is intended to be used with a mounted Sitepress installation (i.e. `sitepress-rails`)
+
+> [!CAUTION]
+> For now the only tested case is one where no dynamic parts (i.e. those pertaining to a logged in user) are embedded in the static Sitepress pages.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sitepress-pagefind"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Then run the installer:
+
+```bash
+$ bin/rails g sitepress:pagefind:install
+```
+
+This installs
+- the `@pagefind/default-ui` JavaScript package
+- a Stimulus controller attachable to a `<dialog>`
+- a template `_search` partial for your convenience.
+
+## Usage
+To compile a Pagefind index, run the following rake task:
+
+```bash
+$ bin/rails sitepress:pagefind:build
+```
+
+
+This task will also be invoked by `assets:precompile` so you don't have to alter your build scripts. 
+
+> [!TIP]
+> If you want to opt out of this behavior, just set the `SKIP_SITEPRESS_PAGEFIND_BUILD` environment variable.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/sitepress/pagefind/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/sitepress/pagefind/install/install_generator.rb

@@ -0,0 +1,24 @@
+class Sitepress::Pagefind::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def install_javascript_deps
+    # stimulus?
+    if File.exist? Rails.root.join("config", "importmap.rb")
+      say "Pinning @pagefind/default-ui"
+      run "bin/importmap pin @pagefind/default-ui"
+    else
+      say "Installing @pagefind/default-ui"
+      run "yarn add @pagefind/default-ui"
+    end
+  end
+
+  def copy_search_controller
+    say "Copying the Stimulus search controller"
+    copy_file "search_controller.js", "app/javascript/controllers/search_controller.js"
+  end
+
+  def copy_search_partial
+    say "Copying the template search partial"
+    copy_file "_search.html.erb", "app/views/pagefind/_search.html.erb"
+  end
+end

data/lib/generators/sitepress/pagefind/install/install_generator.rb~

@@ -0,0 +1,3 @@
+class Sitepress::Pagefind::InstallGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+end

data/lib/generators/sitepress/pagefind/install/templates/_search.html.erb

@@ -0,0 +1,20 @@
+<div data-controller="search">
+  <div data-search-target="button">
+    <div role="button" data-action="click->search#open keydown.meta+k@document->search#open keydown.ctrl+k@document->search#open" class="outline secondary search">
+      <span>Search</span>
+      <kbd>Cmd/Ctrl+K</kbd>
+    </div>
+
+    <dialog data-search-target="dialog">
+      <article>
+        <header>
+          <button aria-label="Close" rel="prev" data-action="search#close"></button>
+          <p>
+            <strong>Global Site Search</strong>
+          </p>
+        </header>
+        <div data-search-target="search"></div>
+      </article>
+    </dialog>
+  </div>
+</div>

data/lib/generators/sitepress/pagefind/install/templates/_search.html.erb~

@@ -0,0 +1,21 @@
+<li data-controller="search">
+  <div data-search-target="button">
+    <div role="button" data-action="click->search#open keydown.meta+k@document->search#open keydown.ctrl+k@document->search#open" class="outline secondary search">
+      <%= heroicon "magnifying-glass" %>
+      <span>Search</span>
+      <kbd>Cmd/Ctrl+K</kbd>
+    </div>
+
+    <dialog data-search-target="dialog">
+      <article>
+        <header>
+          <button aria-label="Close" rel="prev" data-action="search#close"></button>
+          <p>
+            <strong>Global Site Search</strong>
+          </p>
+        </header>
+        <div data-search-target="search"></div>
+      </article>
+    </dialog>
+  </div>
+</li>

data/lib/generators/sitepress/pagefind/install/templates/search_controller.js

@@ -0,0 +1,28 @@
+import { Controller } from "@hotwired/stimulus";
+import { PagefindUI } from "@pagefind/default-ui";
+
+// Connects to data-controller="search"
+export default class extends Controller {
+  static targets = ["button", "dialog", "search"];
+
+  connect() {
+    this.search = new PagefindUI({
+      element: this.searchTarget,
+      highlightParam: "highlight",
+      autofocus: true,
+      showImages: false,
+    });
+  }
+
+  disconnect() {
+    this.search.destroy();
+  }
+
+  open() {
+    this.dialogTarget.showModal();
+  }
+
+  close() {
+    this.dialogTarget.close();
+  }
+}

data/lib/sitepress/pagefind/engine.rb

@@ -0,0 +1,6 @@
+module Sitepress
+  module Pagefind
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/sitepress/pagefind/railtie.rb

@@ -0,0 +1,9 @@
+module Sitepress
+  module Pagefind
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load "tasks/sitepress/pagefind_tasks.rake"
+      end
+    end
+  end
+end

data/lib/sitepress/pagefind/railtie.rb~

@@ -0,0 +1,6 @@
+module Sitepress
+  module Pagefind
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/sitepress/pagefind/version.rb

@@ -0,0 +1,5 @@
+module Sitepress
+  module Pagefind
+    VERSION = "0.1.0"
+  end
+end

data/lib/sitepress/pagefind.rb

@@ -0,0 +1,8 @@
+require "sitepress/pagefind/version"
+require "sitepress/pagefind/engine"
+
+module Sitepress
+  module Pagefind
+    # Your code goes here...
+  end
+end

data/lib/sitepress/pagefind.rb~

@@ -0,0 +1,8 @@
+require "sitepress/pagefind/version"
+require "sitepress/pagefind/railtie"
+
+module Sitepress
+  module Pagefind
+    # Your code goes here...
+  end
+end

data/lib/tasks/sitepress/pagefind_tasks.rake

@@ -0,0 +1,41 @@
+namespace :sitepress do
+  namespace :pagefind do
+    desc "Compile the sitepress site and build a pagefind index"
+    task build: :environment do
+      site = Sitepress::Site.new(root_path: "app/content")
+      build_path = Rails.root.join("tmp/sitepress")
+      pagefind_output_path = Rails.root.join("public/pagefind")
+
+      if File.exist? build_path
+        puts "Purging output directory"
+        FileUtils.rm_r build_path 
+      end
+
+      compiler = Sitepress::Compiler::Files.new(root_path: build_path, site:)
+
+      compiler.compile
+
+      puts <<~END
+
+      Building Pagefind Index
+
+      END
+
+      system "npx pagefind --site #{build_path} --output-path #{pagefind_output_path}"
+    end
+  end
+end
+
+unless ENV["SKIP_SITEPRESS_PAGEFIND_BUILD"]
+  if Rake::Task.task_defined?("assets:precompile")
+    Rake::Task["assets:precompile"].enhance(["sitepress:pagefind:build"])
+  end
+
+  if Rake::Task.task_defined?("test:prepare")
+    Rake::Task["test:prepare"].enhance(["sitepress:pagefind:build"])
+  elsif Rake::Task.task_defined?("spec:prepare")
+    Rake::Task["spec:prepare"].enhance(["sitepress:pagefind:build"])
+  elsif Rake::Task.task_defined?("db:test:prepare")
+    Rake::Task["db:test:prepare"].enhance(["sitepress:pagefind:build"])
+  end
+end

data/lib/tasks/sitepress/pagefind_tasks.rake~

@@ -0,0 +1,39 @@
+namespace :sitepress do
+  namespace :pagefind do
+    desc "Compile the sitepress site and build a pagefind index"
+    task build: :environment do
+      site = Sitepress::Site.new(root_path: "app/content")
+      build_path = Rails.root.join("tmp/sitepress")
+      pagefind_output_path = Rails.root.join("public/pagefind")
+
+      puts "Purging output directory"
+      FileUtils.rm_r build_path
+
+      compiler = Sitepress::Compiler::Files.new(root_path: build_path, site:)
+
+      compiler.compile
+
+      puts <<~END
+
+      Building Pagefind Index
+
+      END
+
+      system "npx pagefind --site #{build_path} --output-path #{pagefind_output_path}"
+    end
+  end
+end
+
+unless ENV["SKIP_SITEPRESS_BUILD"]
+  if Rake::Task.task_defined?("assets:precompile")
+    Rake::Task["assets:precompile"].enhance(["sitepress:pagefind:build"])
+  end
+
+  if Rake::Task.task_defined?("test:prepare")
+    Rake::Task["test:prepare"].enhance(["sitepress:pagefind:build"])
+  elsif Rake::Task.task_defined?("spec:prepare")
+    Rake::Task["spec:prepare"].enhance(["sitepress:pagefind:build"])
+  elsif Rake::Task.task_defined?("db:test:prepare")
+    Rake::Task["db:test:prepare"].enhance(["sitepress:pagefind:build"])
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: sitepress-pagefind
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Rubisch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: sitepress-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: ''
+email:
+- julian@julianrubisch.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/sitepress_pagefind_manifest.js
+- config/routes.rb
+- lib/generators/sitepress/pagefind/install/USAGE
+- lib/generators/sitepress/pagefind/install/install_generator.rb
+- lib/generators/sitepress/pagefind/install/install_generator.rb~
+- lib/generators/sitepress/pagefind/install/templates/_search.html.erb
+- lib/generators/sitepress/pagefind/install/templates/_search.html.erb~
+- lib/generators/sitepress/pagefind/install/templates/search_controller.js
+- lib/sitepress/pagefind.rb
+- lib/sitepress/pagefind.rb~
+- lib/sitepress/pagefind/engine.rb
+- lib/sitepress/pagefind/railtie.rb
+- lib/sitepress/pagefind/railtie.rb~
+- lib/sitepress/pagefind/version.rb
+- lib/tasks/sitepress/pagefind_tasks.rake
+- lib/tasks/sitepress/pagefind_tasks.rake~
+homepage: https://github.com/julianrubisch/sitepress-pagefind
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/julianrubisch/sitepress-pagefind
+  source_code_uri: https://github.com/julianrubisch/sitepress-pagefind
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: A Pagefind integration for Sitepress
+test_files: []