jekyll-taxonomy-redirects 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65035b0cb53fc93b7f29fca64e8fb109e8ea6abff3278a348da6d32eb8297def
+  data.tar.gz: 8d46bee87ae966574ee0b55b33e6eb9cae0e7cd644aca5dd09be47e06a2def20
+SHA512:
+  metadata.gz: 0c37a948918a5a9acb6458d29f92ff3e611377b8f36e4c95d8f1b9a50ac4a5033ac405caa0b23e0af28b706cfc509121db4a21c51847ace6bfb06de23c31dcf9
+  data.tar.gz: a77062f884247c4b0e14a7b2b9125db332ced70791bf6b3a69f302e1d7cb73a01a6a7ac77dd4ca1d485ebd080fd86c217c575c54e828589bc55868306ae96c34

data/LICENSE

@@ -0,0 +1,21 @@
+MIT Licence
+
+Copyright (c) 2025 Dave Cross
+
+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,207 @@
+# jekyll-taxonomy-redirects
+
+Generate **legacy taxonomy redirects** for Jekyll sites. Handy when migratingi
+from WordPress (or any site) where you used paths like `/category/:slug/` and
+`/tags/:slug/`, but your new site uses `/venues/:slug/` and `/acts/:slug/`
+(or any other mapping).
+
+The plugin emits tiny, portable HTML redirect stubs at build time. It works
+with GitHub Pages when you **build in CI** (Actions) and deploy `_site/`.
+
+---
+
+## Features
+
+* Generate redirects for **category** and **tag** taxonomies (slugs from your content)
+* Configurable **from** → **to** mappings (e.g. `/category` → `/venues`)
+* Optional root redirects (e.g. `/category/` → `/venues/`)
+* Portable HTML stubs using `<meta refresh>` + `location.replace()`
+* Optional `<link rel="canonical">` for crawlers
+* Works alongside `jekyll-archives` and `jekyll-redirect-from`
+
+---
+
+## Installation
+
+Add the gem to your site’s `Gemfile`:
+
+```ruby
+# Gemfile
+source "https://rubygems.org"
+
+group :jekyll_plugins do
+  gem "jekyll-taxonomy-redirects", "~> 0.1"
+end
+```
+
+Enable the plugin in `_config.yml`:
+
+```yml
+# _config.yml
+plugins:
+  - jekyll-taxonomy-redirects
+```
+
+> **GitHub Pages:** If you deploy with GitHub Pages, build the site in GitHub
+> Actions (or another CI) and deploy the generated `_site/` artifact. The
+> hosted Pages builder won’t run third‑party plugins.
+
+---
+
+## Configuration
+
+Add a `taxonomy_redirects:` block to `_config.yml`.
+
+```yml
+taxonomy_redirects:
+  # Optional: roots redirect to the new sections
+  roots:
+    - from: "/category"
+      to:   "/venues"
+    - from: "/tags"
+      to:   "/acts"
+
+  # Per‑slug redirects driven by your content’s taxonomies
+  maps:
+    - type: "category"   # or "tag"
+      from: "/category"
+      to:   "/venues"
+    - type: "tag"
+      from: "/tags"
+      to:   "/acts"
+
+  # HTML output tweaks
+  emit_canonical: true    # add <link rel="canonical" href="…"> (default: true)
+```
+
+### What gets generated
+
+With the configuration above, the plugin creates:
+
+* `/category/`  → `/venues/`
+* `/tags/`      → `/acts/`
+* `/category/<slug>/` → `/venues/<slug>/`
+* `/tags/<slug>/`     → `/acts/<slug>/`
+
+It discovers the `<slug>` values from `site.categories.keys` and
+`site.tags.keys` at build time.
+
+The plugin runs late (`priority :low`) so taxonomies from your content are
+available.
+
+---
+
+## How it works
+
+For each redirect, the plugin writes a minimal `index.html` containing:
+
+```html
+<!doctype html>
+<meta http-equiv="refresh" content="0; url=/new/path/">
+<link rel="canonical" href="/new/path/">
+<script>location.replace('/new/path/');</script>
+<p>Moved to <a href="/new/path/">/new/path/</a>.</p>
+```
+
+This approach is **portable** across static hosts (including GitHub Pages).
+If your host supports server‑side rules (e.g. Netlify), you can keep using
+this, or open an issue to add an optional provider file emitter.
+
+---
+
+## Example: WordPress → Jekyll (venues/acts)
+
+```yml
+# _config.yml
+plugins:
+  - jekyll-archives
+  - jekyll-taxonomy-redirects
+
+jekyll-archives:
+  enabled: [categories, tags]
+  layouts: { category: venue, tag: act }
+  permalinks:
+    category: /venues/:name/
+    tag: /acts/:name/
+
+taxonomy_redirects:
+  roots:
+    - { from: "/category", to: "/venues" }
+    - { from: "/tags",     to: "/acts"   }
+  maps:
+    - { type: "category", from: "/category", to: "/venues" }
+    - { type: "tag",      from: "/tags",     to: "/acts"   }
+```
+
+Now the old `/category/foo/` and `/tags/bar/` URLs redirect to `/venues/foo/`
+and `/acts/bar/`.
+
+---
+
+## Compatibility
+
+* **Jekyll:** 4.x
+* **Hosts:** Any static host. For GitHub Pages, build the site yourself (Actions) and deploy `_site/`.
+* **Works with:** `jekyll-archives`, `jekyll-redirect-from` (for per‑document redirects).
+
+---
+
+## Development
+
+Clone and run against a test site:
+
+```bash
+bundle install
+bundle exec jekyll build --trace
+```
+
+While developing in the same repo as your site, you can point Bundler at the
+local gem:
+
+```ruby
+# Gemfile in your site
+group :jekyll_plugins do
+  gem "jekyll-taxonomy-redirects", path: "../jekyll-taxonomy-redirects"
+end
+```
+
+### Tests
+
+TBD – a minimal fixture site that asserts redirect stubs are created for
+sample slugs.
+
+---
+
+## Contributing
+
+PRs welcome! Please:
+
+* Keep the code tiny and dependency‑free
+* Add/update docs for any new options
+* Consider hosts with no server‑side redirect support (keep HTML stubs working)
+
+---
+
+## Versioning & Licence
+
+* Versioned with SemVer (`0.y.z` until the API stabilises)
+* © 2025 Dave Cross — Released under the **MIT Licence**
+
+---
+
+## FAQ
+
+**Why not `jekyll-redirect-from`?**
+That plugin reads front‑matter on individual documents. Archive pages aren’t
+documents, so there’s nothing to attach front‑matter to. This plugin generates
+the required stubs for the archive‑style URLs.
+
+**Can this emit server 301 rules?**
+On hosts that support provider files (e.g. Netlify `_redirects`), yes in theory
+— open an issue. On GitHub Pages, server rules aren’t available, so HTML is the
+portable choice.
+
+**Will this slow down my build?**
+It’s O(N) in the number of category/tag slugs. For typical blogs that’s
+negligible.
+

data/lib/jekyll/taxonomy_redirects/version.rb

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

data/lib/jekyll/taxonomy_redirects.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Jekyll plugin: generates legacy taxonomy redirect stubs, e.g.
+#   /category/:slug/ -> /venues/:slug/
+#   /tags/:slug/     -> /acts/:slug/
+#
+# Works with any taxonomy provider (core categories/tags or jekyll-archives),
+# because it only needs the slug lists (site.categories.keys / site.tags.keys).
+#
+# Add to Gemfile and enable in _config.yml under `plugins:` then configure:
+#
+# taxonomy_redirects:
+#   roots:
+#     - { from: "/category", to: "/venues" }
+#     - { from: "/tags",     to: "/acts"   }
+#   maps:
+#     - { type: "category", from: "/category", to: "/venues" }
+#     - { type: "tag",      from: "/tags",     to: "/acts"   }
+#   emit_canonical: true
+#
+module Jekyll
+  module TaxonomyRedirects
+    class RedirectPage < Jekyll::Page
+      def initialize(site, from_path, dest_url, emit_canonical: true)
+        @site = site
+        @base = site.source
+        @dir  = from_path # e.g. "category/union-chapel"
+        @name = "index.html"
+        process(@name)
+
+        self.data = { "layout" => nil, "sitemap" => false }
+        self.content = template(dest_url, emit_canonical)
+      end
+
+      def template(dest_url, emit_canonical)
+        canonical = emit_canonical ? %(<link rel="canonical" href="#{dest_url}">\n) : ""
+        <<~HTML
+          <!doctype html><meta charset="utf-8">
+          <meta http-equiv="refresh" content="0; url=#{dest_url}">
+          #{canonical}<title>Moved</title>
+          <p>Moved to <a href="#{dest_url}">#{dest_url}</a>.</p>
+          <script>location.replace(#{dest_url.to_json});</script>
+        HTML
+      end
+    end
+
+    class Generator < Jekyll::Generator
+      safe true
+      priority :low
+
+      def generate(site)
+        cfg   = site.config["taxonomy_redirects"] || {}
+        roots = Array(cfg["roots"])
+        maps  = Array(cfg["maps"])
+        emit_canonical = cfg.key?("emit_canonical") ? !!cfg["emit_canonical"] : true
+
+        # Root redirects like /category/ -> /venues/
+        roots.each do |r|
+          from = trim_slashes(r["from"].to_s)
+          to   = ensure_trailing_slash(r["to"].to_s)
+          next if from.empty? || to.empty?
+          site.pages << RedirectPage.new(site, from, to, emit_canonical: emit_canonical)
+        end
+
+        # Map per-slug redirects
+        maps.each do |m|
+          type = m["type"].to_s # "category" or "tag"
+          from = trim_slashes(m["from"].to_s)
+          to   = trim_slashes(m["to"].to_s)
+          next if type.empty? || from.empty? || to.empty?
+
+          slugs = case type
+                  when "category" then site.categories.keys
+                  when "tag"      then site.tags.keys
+                  else []
+                  end
+
+          slugs.each do |slug|
+            from_path = File.join(from, slug)         # e.g. "category/union-chapel"
+            dest_url  = "/" + File.join(to, slug, "") # e.g. "/venues/union-chapel/"
+            site.pages << RedirectPage.new(site, from_path, dest_url, emit_canonical: emit_canonical)
+          end
+        end
+      end
+
+      private
+
+      def trim_slashes(s)
+        s.sub(%r!\A/+, "").sub(%r!/+\z!, "")
+      end
+
+      def ensure_trailing_slash(s)
+        s.end_with?("/") ? s : "#{s}/"
+      end
+    end
+  end
+end
+

data/lib/jekyll-taxonomy-redirects.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require "jekyll/taxonomy_redirects"
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-taxonomy-redirects
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Cross
+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 generator that outputs static redirect stubs for legacy taxonomy
+  paths. Useful when migrating from WordPress or changing tag/category permalink structures.
+  Plays nicely with jekyll-archives.
+email:
+- dave@davecross.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-taxonomy-redirects.rb
+- lib/jekyll/taxonomy_redirects.rb
+- lib/jekyll/taxonomy_redirects/version.rb
+homepage: https://github.com/davorg/jekyll-taxonomy-redirects
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Generate legacy taxonomy redirects (e.g. /category/:slug -> /venues/:slug)
+  for Jekyll.
+test_files: []