bridgetown-sitemap 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac539efc37311d68fe991191d98d0f88c47318128e2bf529a177af6814066a14
-  data.tar.gz: 4fed4074d7a52b2fa807b35bf9e14d29649c09d0b6e8629dad7a7a56ce21423e
+  metadata.gz: 4988c349a0919aefa587882e538bf0623a5c9a994f38aa937edcf6898f644e1d
+  data.tar.gz: d94f6c3d21bc8800f71c038d8615fb6902e61de07b64f8c61c99729a275da104
 SHA512:
-  metadata.gz: 289155d9d0827a4c257c127227666f1d489b931521876d42b031000583a524b10d87e62e46991b6cc420d6958bbd94d1a1a9a49e125691cdd101c7e89056b52d
-  data.tar.gz: ab85ae03365fa0f65e4c1a12e32bff50c21e2254e5fa067594a58ee064021c15a03b495d8f21db009cd173670b420aad1d8cffe97e88130833dff766eccc4197
+  metadata.gz: 1752c19b00fb0de0b7f194da1ecbe20f279f6890a51f7ff5f826f4a0d5d3da9c1bbaca4331291d517552fa25ca54ae4a297421819a1fcca40e694ad172ce7e7c
+  data.tar.gz: de70253082a7be05ff85785b1c9ef806ed5c3e62b2fe4e32d616acb0c99dff1e83c50dd4c6b23fd216b50540511d09f2c8cedbdfad49c8d83e9590efa31136df

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # main
 
+# 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/lib/bridgetown-sitemap/version.rb

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

data/lib/sitemap.erb

@@ -13,6 +13,12 @@
       <url>
         <loc><%= xml_escape resource.absolute_url %></loc>
         <lastmod><%= resource.sitemap_last_modified_at.localtime.xmlschema %></lastmod>
+        <% if resource.data.sitemap_priority %>
+          <priority><%= resource.data.sitemap_priority %></priority>
+        <% end %>
+        <% if resource.data.sitemap_change_frequency %>
+          <changefreq><%= resource.data.sitemap_change_frequency %></changefreq>
+        <% end %>
       </url>
     <% end %>
   <% end %>
@@ -23,6 +29,12 @@
     <url>
       <loc><%= xml_escape absolute_url(generated_page.url) %></loc>
       <lastmod><%= (generated_page.data.last_modified_at || site.time).localtime.xmlschema %></lastmod>
+      <% if generated_page.data.sitemap_priority %>
+        <priority><%= generated_page.data.sitemap_priority %></priority>
+      <% end %>
+      <% if generated_page.data.sitemap_change_frequency %>
+        <changefreq><%= generated_page.data.sitemap_change_frequency %></changefreq>
+      <% end %>
     </url>
   <% end %>
 
@@ -31,6 +43,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/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,7 +116,7 @@ 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 19, @sitemap.scan(%r!(?=<url>)!).count
     end
 
     it "includes generated pages in the sitemap" do
@@ -126,6 +126,11 @@ class TestSitemap < BridgetownSitemap::Test
     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
   end
 
   describe "rendering the site with a base URL" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-sitemap
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Ayush Newatia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -123,6 +123,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
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Bridgetown site.
@@ -179,6 +180,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