bridgetown-sitemap 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46fc691359d55c28bae04bec5dc2712f995bfeda3b7f9a59d854e9594c61b5d
-  data.tar.gz: b5479047c0ccac7ec071a9aaf3428f9d615935548c8dd9d4d9b28f79769bf33a
+  metadata.gz: 4988c349a0919aefa587882e538bf0623a5c9a994f38aa937edcf6898f644e1d
+  data.tar.gz: d94f6c3d21bc8800f71c038d8615fb6902e61de07b64f8c61c99729a275da104
 SHA512:
-  metadata.gz: 73dd830ca3fc53df0a3850bb2a1fb6b230f2ebe62202281f019ae4d48b3bb414c5f9531a0bafda378b6cd22a94de62ae0f711be0206768ad3f8c2306c4dd2f34
-  data.tar.gz: b37f746153cf2c39ce6fe774194fc7e09ac5be31615c555c7f26e438bb32343b1783f517dfa07fdb94acebae756ea48690714411e9f44e61db6efbf117943c19
+  metadata.gz: 1752c19b00fb0de0b7f194da1ecbe20f279f6890a51f7ff5f826f4a0d5d3da9c1bbaca4331291d517552fa25ca54ae4a297421819a1fcca40e694ad172ce7e7c
+  data.tar.gz: de70253082a7be05ff85785b1c9ef806ed5c3e62b2fe4e32d616acb0c99dff1e83c50dd4c6b23fd216b50540511d09f2c8cedbdfad49c8d83e9590efa31136df

data/.rubocop.yml

@@ -4,22 +4,32 @@ inherit_gem:
   rubocop-bridgetown: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
-  Include:
-    - lib/**/*.rb
+  TargetRubyVersion: 2.7
 
   Exclude:
     - .gitignore
-    - .rspec
     - .rubocop.yml
+    - "*.gemspec"
 
     - Gemfile.lock
     - CHANGELOG.md
     - LICENSE.txt
     - README.md
+    - Rakefile
+    - bridgetown.automation.rb
 
     - script/**/*
+    - test/fixtures/**/*
     - vendor/**/*
 
 Layout/LineLength:
-  Max: 120
+  Max: 140
+
+Metrics/BlockLength:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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.
+
 # 2.0.0 / 25-01-2023
 
 * Restrict support to Bridgetown v1.2 and newer.

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/resource/base.rb

@@ -12,13 +12,20 @@ module Bridgetown
       def latest_git_commit_date
         return nil unless git_repo?
 
-        date = `git log -1 --pretty="format:%cI" "#{path}"`
+        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")
+      end
     end
   end
 end

data/lib/bridgetown-sitemap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownSitemap
-  VERSION = "2.0.0"
+  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/helper.rb

@@ -2,7 +2,7 @@
 
 require "minitest/autorun"
 require "minitest/reporters"
-require 'minitest/hooks/default'
+require "minitest/hooks/default"
 require "bridgetown"
 
 Bridgetown.begin!
@@ -37,6 +37,6 @@ class BridgetownSitemap::Test < Minitest::Test
   end
 
   def make_context(registers = {})
-    Liquid::Context.new({}, {}, { :site => site }.merge(registers))
+    Liquid::Context.new({}, {}, { site: site }.merge(registers))
   end
-end
+end

data/test/test_sitemap.rb

@@ -6,12 +6,12 @@ class TestSitemap < BridgetownSitemap::Test
   def prepare_site
     Bridgetown.reset_configuration!
     @config = Bridgetown.configuration(
-      "full_rebuild"    => true,
-      "root_dir"        => root_dir,
-      "source"          => source_dir,
-      "destination"     => dest_dir,
-      "url"             => "https://example.com",
-      "quiet"           => true
+      "full_rebuild" => true,
+      "root_dir"     => root_dir,
+      "source"       => source_dir,
+      "destination"  => dest_dir,
+      "url"          => "https://example.com",
+      "quiet"        => true
     )
 
     @config.run_initializers! context: :static
@@ -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
@@ -215,4 +220,3 @@ class TestSitemap < BridgetownSitemap::Test
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-sitemap
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Ayush Newatia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-25 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