bridgetown-sitemap 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac539efc37311d68fe991191d98d0f88c47318128e2bf529a177af6814066a14
-  data.tar.gz: 4fed4074d7a52b2fa807b35bf9e14d29649c09d0b6e8629dad7a7a56ce21423e
+  metadata.gz: ea58bca8a2a06f1b598f9332323f91fb29891ca412339969f2d120d095bad4b4
+  data.tar.gz: b3bd5cd474d8f9a8c1134b32dbdcbba529b86139c3f5c309f4a015483323b33a
 SHA512:
-  metadata.gz: 289155d9d0827a4c257c127227666f1d489b931521876d42b031000583a524b10d87e62e46991b6cc420d6958bbd94d1a1a9a49e125691cdd101c7e89056b52d
-  data.tar.gz: ab85ae03365fa0f65e4c1a12e32bff50c21e2254e5fa067594a58ee064021c15a03b495d8f21db009cd173670b420aad1d8cffe97e88130833dff766eccc4197
+  metadata.gz: e352891416d845e32acfa8531e23478e69c86ece42221bd72d144f2df42e2281671522654d1988ded89d21c4c0b6c15464fdb07c6256f26610a562db19e1a52e
+  data.tar.gz: 9b24215ee863c2a0dbfd271921f6ee7fa462edb8301340d3455d5325d7b8e5a6af8c2b856fea78b40e2cdb501ecafbf5b713bd2495aee93b434e9bb9112851b1

data/.github/workflows/tests.yml

@@ -13,8 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby_version: [2.7.7, 3.0.5, 3.1.3, 3.2.0]
-        bridgetown_version: [1.2.0]
+        ruby_version: [3.2.4, 3.3.6, 3.4.2]
+        bridgetown_version: [1.3.4, 2.0.0.beta4]
     continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
     # Has to be top level to cache properly
     env:

data/.rubocop.yml

@@ -25,6 +25,12 @@ AllCops:
 Layout/LineLength:
   Max: 140
 
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  Enabled: false
+
 Metrics/BlockLength:
   Enabled: false
 
@@ -32,4 +38,7 @@ Bundler/OrderedGems:
   Enabled: false
 
 Style/IfUnlessModifier:
+  Enabled: false
+
+Lint/UselessConstantScoping:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # main
 
+# 3.0.0 / 24-02-2025
+
+* Add i18n support
+* Drop support for Bridgetown 1.2.x and lower
+* Drop support for Ruby 3.1.x and lower
+* Fix git error for dynamically generated resources
+
+# 2.0.2 / 27-06-2023
+
+* Add support for priority and changefreq tags.
+
 # 2.0.1 / 04-04-2023
 
 * Cache `git log` value for last modified date.

data/README.md

@@ -30,6 +30,22 @@ The `<lastmod>` tag in the `sitemap.xml` will reflect by priority:
 2. The modified date of the file as reported by `git log`.
 
 
+## `<priority>` and `<changefreq>` tag
+You can optionally specify a _priority_ and _change frequency_ for each page in your site by adding the following to the Front Matter of each page:
+
+```yml
+sitemap_priority: 0.7
+sitemap_change_frequency: weekly
+```
+
+This will add the following to the `<url>` tag in the `sitemap.xml`:
+
+```xml
+<priority>0.7</priority>
+<changefreq>weekly</changefreq>
+```
+
+
 ## Exclusions
 
 If you would like to exclude specific pages from the sitemap set the

data/bridgetown-sitemap.gemspec

@@ -16,11 +16,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.2.4"
 
-  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
+  spec.add_dependency "bridgetown", ">= 1.3.0", "< 3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rubocop-bridgetown"
 end

data/lib/bridgetown/resource/base.rb

@@ -4,27 +4,11 @@ module Bridgetown
   module Resource
     class Base
       def sitemap_last_modified_at
-        (data.last_modified_at || latest_git_commit_date || date)&.to_time
-      end
-
-      private
-
-      def latest_git_commit_date
-        return nil unless git_repo?
-
-        date = sitemap_cache.getset(id) do
-          `git log -1 --pretty="format:%cI" "#{path}"`
-        end
-
-        Time.parse(date) if date.present?
-      end
-
-      def git_repo?
-        system "git status", out: File::NULL, err: File::NULL
-      end
-
-      def sitemap_cache
-        @sitemap_cache = Bridgetown::Cache.new("sitemap")
+        (
+          data.last_modified_at ||
+          BridgetownSitemap::GitInspector.new(self).latest_git_commit_date ||
+          date
+        )&.to_time
       end
     end
   end

data/lib/bridgetown-sitemap/git_inspector.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BridgetownSitemap
+  class GitInspector
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def latest_git_commit_date
+      return nil unless git_repo?
+      return nil unless repo_origin?
+
+      date = cache.getset(@resource.id) do
+        `git log -1 --pretty="format:%cI" "#{@resource.path}"`
+      end
+
+      Time.parse(date) if date.present?
+    end
+
+    private
+
+      def repo_origin?
+        @resource.model.origin.url.scheme == "repo"
+      end
+
+      def git_repo?
+        system "git status", out: File::NULL, err: File::NULL
+      end
+
+      def cache
+        @cache ||= Bridgetown::Cache.new("sitemap")
+      end
+  end
+end

data/lib/bridgetown-sitemap/grouped_generated_pages.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BridgetownSitemap
+  class GroupedGeneratedPages
+    def initialize(generated_pages)
+      @grouped_generated_pages = \
+        generated_pages.group_by { |page| page.data.slug }.values
+    end
+
+    def each(locale:, &block)
+      @grouped_generated_pages.each do |page_group|
+        page_group = page_group.reject do |page|
+          ["sitemap.erb", "robots.liquid"].include?(page.name) ||
+            page.data.sitemap == false
+        end
+
+        default_page = page_group.detect do |page|
+          !page.data.locale || locale == page.data.locale
+        end
+
+        latest_page = page_group.max_by { |page| page.data.last_modified_at }
+
+        yield default: default_page, latest: latest_page, group: page_group
+      end
+    end
+  end
+end

data/lib/bridgetown-sitemap/grouped_resources.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BridgetownSitemap
+  class GroupedResources
+    def initialize(resources)
+      @grouped_resources = resources.group_by do |resource|
+         [resource.data.slug, resource.date]
+      end.values
+    end
+
+    def each(locale:, &block)
+      @grouped_resources.each do |resource_group|
+        resource_group = resource_group.reject do |resource|
+          resource.id == "/404" || resource.data.sitemap == false
+        end
+
+        default_resource = resource_group.detect do |resource|
+          !resource.data.locale || locale == resource.data.locale
+        end
+
+        latest_resource = resource_group.max_by { |resource| resource.data.sitemap_last_modified_at }
+
+        yield default: default_resource, latest: latest_resource, group: resource_group
+      end
+    end
+  end
+end

data/lib/bridgetown-sitemap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownSitemap
-  VERSION = "2.0.1"
+  VERSION = "3.0.0"
 end

data/lib/bridgetown-sitemap.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 require "bridgetown"
-require "bridgetown/resource/base"
 require "bridgetown-sitemap/builder"
+require "bridgetown-sitemap/git_inspector"
+require "bridgetown-sitemap/grouped_resources"
+require "bridgetown-sitemap/grouped_generated_pages"
+require "bridgetown/resource/base"
 
 Bridgetown.initializer :"bridgetown-sitemap" do |config|
   config.builder BridgetownSitemap::Builder

data/lib/sitemap.erb

@@ -4,26 +4,69 @@
   <?xml-stylesheet type="text/xsl" href="/sitemap.xsl"?>
 <% end %>
 
-<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<urlset
+  xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:xhtml="http://www.w3.org/1999/xhtml"
+  xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9
+    http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd
+    http://www.w3.org/1999/xhtml
+    http://www.w3.org/2002/08/xhtml/xhtml1-strict.xsd">
   <% output_collection_names = site.config.collections.select { |_name, data| data.output }.keys %>
 
   <% collections.slice(*output_collection_names).each do |_name, collection| %>
-    <% collection.resources.each do |resource| %>
-      <% next if resource.id == "/404" || resource.data.sitemap == false %>
-      <url>
-        <loc><%= xml_escape resource.absolute_url %></loc>
-        <lastmod><%= resource.sitemap_last_modified_at.localtime.xmlschema %></lastmod>
-      </url>
+    <% BridgetownSitemap::GroupedResources.new(collection.resources)
+        .each(locale: site.locale) do |default:, latest:, group:| %>
+      <% if default %>
+        <url>
+          <loc><%= xml_escape absolute_url(in_locale(default, default.data.locale)) %></loc>
+
+          <% group.each do |resource| %>
+            <% if site.locale == resource.data.locale %>
+              <xhtml:link rel="alternate" hreflang="x-default" href="<%= xml_escape resource.absolute_url %>" />
+            <% end %>
+              <xhtml:link rel="alternate" hreflang="<%= resource.data.locale %>" href="<%= xml_escape resource.absolute_url %>" />
+          <% end %>
+
+          <lastmod><%= latest.sitemap_last_modified_at.localtime.xmlschema %></lastmod>
+
+          <% if default.data.sitemap_priority %>
+            <priority><%= default.data.sitemap_priority %></priority>
+          <% end %>
+
+          <% if default.data.sitemap_change_frequency %>
+            <changefreq><%= default.data.sitemap_change_frequency %></changefreq>
+          <% end %>
+        </url>
+      <% end %>
     <% end %>
   <% end %>
 
-  <% site.generated_pages.each do |generated_page| %>
-    <% next if ["sitemap.erb", "robots.liquid"].include? generated_page.name %>
-    <% next if generated_page.data.sitemap == false %>
-    <url>
-      <loc><%= xml_escape absolute_url(generated_page.url) %></loc>
-      <lastmod><%= (generated_page.data.last_modified_at || site.time).localtime.xmlschema %></lastmod>
-    </url>
+  <% BridgetownSitemap::GroupedGeneratedPages.new(site.generated_pages)
+      .each(locale: site.locale) do |default:, latest:, group:| %>
+
+    <% if default %>
+      <url>
+        <loc><%= xml_escape absolute_url(default.url) %></loc>
+
+        <% group.each do |page| %>
+          <% if !page.data.locale || site.locale == page.data.locale %>
+            <xhtml:link rel="alternate" hreflang="x-default" href="<%= xml_escape absolute_url(page.url) %>" />
+          <% end %>
+            <xhtml:link rel="alternate" hreflang="<%= page.data.locale || site.locale %>" href="<%= xml_escape absolute_url(page.url) %>" />
+        <% end %>
+
+        <lastmod><%= (latest.data.last_modified_at || site.time).localtime.xmlschema %></lastmod>
+
+        <% if default.data.sitemap_priority %>
+          <priority><%= default.data.sitemap_priority %></priority>
+        <% end %>
+
+        <% if default.data.sitemap_change_frequency %>
+          <changefreq><%= default.data.sitemap_change_frequency %></changefreq>
+        <% end %>
+      </url>
+    <% end %>
   <% end %>
 
   <% page.data.static_files.each do |file| %>
@@ -31,6 +74,12 @@
     <url>
       <loc><%= xml_escape absolute_url(file.relative_path) %></loc>
       <lastmod><%= file.modified_time.localtime.xmlschema %></lastmod>
+      <% if file.data.sitemap_priority %>
+        <priority><%= file.data.sitemap_priority %></priority>
+      <% end %>
+      <% if file.data.sitemap_change_frequency %>
+        <changefreq><%= file.data.sitemap_change_frequency %></changefreq>
+      <% end %>
     </url>
   <% end %>
 </urlset>

data/script/cibuild

@@ -2,5 +2,4 @@
 
 set -e
 
-script/fmt
 script/test

data/test/fixtures/config/initializers.rb

@@ -8,5 +8,8 @@ Bridgetown.configure do |config|
     "values" => { "sitemap" => false }
   }
 
+  available_locales [ :en, :ru ]
+  default_locale :en
+
   init :"bridgetown-sitemap"
-end
+end

data/test/fixtures/plugins/builders/generated_pages.rb

@@ -5,7 +5,13 @@ class Builders::GeneratedPages < SiteBuilder
       generated_page.content = "<%= 'created from a plugin'.capitalize %>"
       generated_page.data.layout = "default"
 
+      generated_page_ru = Bridgetown::GeneratedPage.new(site, site.source, "/ru", "generated_page.erb")
+      generated_page_ru.content = "<%= '(RU) created from a plugin'.capitalize %>"
+      generated_page_ru.data.layout = "default"
+      generated_page_ru.data.locale = :ru
+
       site.generated_pages << generated_page
+      site.generated_pages << generated_page_ru
     end
   end
-end
+end

data/test/fixtures/src/_posts/2022-02-19-locale-default.md

@@ -0,0 +1,5 @@
+---
+date: 2022-02-19
+---
+
+The 18th of February!

data/test/fixtures/src/_posts/2022-02-19-locale-default.ru.md

@@ -0,0 +1,5 @@
+---
+date: 2022-02-19
+---
+
+18 Февраля!

data/test/fixtures/src/some-subfolder/test_priority_and_changefreq.html

@@ -0,0 +1,5 @@
+---
+sitemap_priority: 0.8
+sitemap_change_frequency: monthly
+---
+This is a page with custom sitemap priority and change frequency.

data/test/test_sitemap.rb

@@ -116,16 +116,33 @@ class TestSitemap < BridgetownSitemap::Test
     end
 
     it "includes the correct number of items for the sitemap" do
-      assert_equal 18, @sitemap.scan(%r!(?=<url>)!).count
+      assert_equal 20, @sitemap.scan(%r!(?=<url>)!).count
     end
 
     it "includes generated pages in the sitemap" do
       assert_match %r!<loc>https://example.com/generated_page/</loc>!, @sitemap
     end
 
+    it "includes i18n generated pages in the sitemap" do
+      assert_match %r!<xhtml:link rel="alternate" hreflang="x-default" href="https://example\.com/generated_page/" />!, @sitemap
+      assert_match %r!<xhtml:link rel="alternate" hreflang="en" href="https://example\.com/generated_page/" />!, @sitemap
+      assert_match %r!<xhtml:link rel="alternate" hreflang="ru" href="https://example\.com/ru/generated_page/" />!, @sitemap
+    end
+
     it "renders liquid in the robots.txt" do
       assert_match "Sitemap: https://example.com/sitemap.xml", @robots
     end
+
+    it "renders the priority and changefreq properties if needed" do
+      assert_match %r!<priority>0.8</priority>!, @sitemap
+      assert_match %r!<changefreq>monthly</changefreq>!, @sitemap
+    end
+
+    it "adds child links for i18n posts" do
+      assert_match %r!<xhtml:link rel="alternate" hreflang="x-default" href="https://example\.com/2022/02/19/locale-default/" />!, @sitemap
+      assert_match %r!<xhtml:link rel="alternate" hreflang="en" href="https://example\.com/2022/02/19/locale-default/" />!, @sitemap
+      assert_match %r!<xhtml:link rel="alternate" hreflang="ru" href="https://example\.com/ru/2022/02/19/locale-default/" />!, @sitemap
+    end
   end
 
   describe "rendering the site with a base URL" do
@@ -157,6 +174,12 @@ class TestSitemap < BridgetownSitemap::Test
     it "adds the baseurl in the robots.txt" do
       assert_match "Sitemap: https://example.com/baseurl/sitemap.xml", @robots
     end
+
+    it "adds child links for i18n posts with baseurl" do
+      assert_match %r!<xhtml:link rel="alternate" hreflang="x-default" href="https://example\.com/baseurl/2022/02/19/locale-default/" />!, @sitemap
+      assert_match %r!<xhtml:link rel="alternate" hreflang="en" href="https://example\.com/baseurl/2022/02/19/locale-default/" />!, @sitemap
+      assert_match %r!<xhtml:link rel="alternate" hreflang="ru" href="https://example\.com/baseurl/ru/2022/02/19/locale-default/" />!, @sitemap
+    end
   end
 
   describe "rendering the site with a url that needs URI encoding" do

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-sitemap
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Ayush Newatia
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -16,20 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,21 +57,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-bridgetown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description:
 email: ayush@hey.com
 executables: []
 extensions: []
@@ -89,12 +73,14 @@ files:
 - bridgetown-sitemap.gemspec
 - lib/bridgetown-sitemap.rb
 - lib/bridgetown-sitemap/builder.rb
+- lib/bridgetown-sitemap/git_inspector.rb
+- lib/bridgetown-sitemap/grouped_generated_pages.rb
+- lib/bridgetown-sitemap/grouped_resources.rb
 - lib/bridgetown-sitemap/version.rb
 - lib/bridgetown/resource/base.rb
 - lib/robots.liquid
 - lib/sitemap.erb
 - script/cibuild
-- script/fmt
 - script/release
 - script/test
 - test/fixtures/config/initializers.rb
@@ -112,6 +98,8 @@ files:
 - test/fixtures/src/_posts/2021-03-04-march-the-fourth.md
 - test/fixtures/src/_posts/2021-05-06-may-the-sixth.md
 - test/fixtures/src/_posts/2022-02-18-feb-the-eighteenth.md
+- test/fixtures/src/_posts/2022-02-19-locale-default.md
+- test/fixtures/src/_posts/2022-02-19-locale-default.ru.md
 - test/fixtures/src/about.html
 - test/fixtures/src/assets/sample_image.jpg
 - test/fixtures/src/assets/sample_pdf.pdf
@@ -123,6 +111,7 @@ files:
 - test/fixtures/src/some-subfolder/htm.htm
 - test/fixtures/src/some-subfolder/index.html
 - test/fixtures/src/some-subfolder/test_index.html
+- test/fixtures/src/some-subfolder/test_priority_and_changefreq.html
 - test/fixtures/src/some-subfolder/this-is-a-subfile.html
 - test/fixtures/src/some-subfolder/this-is-a-subpage.html
 - test/fixtures/src/some-subfolder/xhtml.xhtml
@@ -133,7 +122,6 @@ homepage: https://github.com/ayushn21/bridgetown-sitemap
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,15 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Bridgetown site.
 test_files:
@@ -168,6 +155,8 @@ test_files:
 - test/fixtures/src/_posts/2021-03-04-march-the-fourth.md
 - test/fixtures/src/_posts/2021-05-06-may-the-sixth.md
 - test/fixtures/src/_posts/2022-02-18-feb-the-eighteenth.md
+- test/fixtures/src/_posts/2022-02-19-locale-default.md
+- test/fixtures/src/_posts/2022-02-19-locale-default.ru.md
 - test/fixtures/src/about.html
 - test/fixtures/src/assets/sample_image.jpg
 - test/fixtures/src/assets/sample_pdf.pdf
@@ -179,6 +168,7 @@ test_files:
 - test/fixtures/src/some-subfolder/htm.htm
 - test/fixtures/src/some-subfolder/index.html
 - test/fixtures/src/some-subfolder/test_index.html
+- test/fixtures/src/some-subfolder/test_priority_and_changefreq.html
 - test/fixtures/src/some-subfolder/this-is-a-subfile.html
 - test/fixtures/src/some-subfolder/this-is-a-subpage.html
 - test/fixtures/src/some-subfolder/xhtml.xhtml

data/script/fmt

@@ -1,10 +0,0 @@
-#!/bin/bash
-set -e
-
-echo "Rubocop $(bundle exec rubocop --version)"
-bundle exec rubocop -D -E $@
-success=$?
-if ((success != 0)); then
-   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
-fi
-exit $success