Add and implement sitemap_generator gem (#52)

* Implement sitemap generation using the 'sitemap_generator' gem

This commit adds sitemap generation for our Sitepress-enabled app. It iterates through all PageModel instances, adding their paths to the sitemap with appropriate change frequencies and priorities. The sitemap helps improve SEO by providing search engines with structured access to our site's pages.

Gemfile

@@ -80,6 +80,9 @@ gem "erb_lint", "~> 0.5.0"
 # Search Engine Optimization (SEO) for Ruby on Rails applications.
 gem "meta-tags"
 
+# A sitemap generator gem for Rails
+gem "sitemap_generator", "~> 6.3"
+
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
   gem "debug", platforms: %i[mri windows]

Gemfile.lock

@@ -268,6 +268,8 @@ GEM
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
       websocket (~> 1.0)
+    sitemap_generator (6.3.0)
+      builder (~> 3.0)
     sitepress-core (3.2.2)
       mime-types (>= 2.99)
     sitepress-rails (3.2.2)
@@ -356,6 +358,7 @@ DEPENDENCIES
   redis (>= 4.0.1)
   rouge (~> 4.1)
   selenium-webdriver
+  sitemap_generator (~> 6.3)
   sitepress-rails
   sprockets-rails
   standard (~> 1.31)

config/sitemap.rb

@@ -0,0 +1,36 @@
+# Set the host name for URL creation
+SitemapGenerator::Sitemap.default_host = "https://hotwire.io"
+
+SitemapGenerator::Sitemap.create do
+  # Put links creation logic here.
+  #
+  # The root path '/' and sitemap index file are added automatically for you.
+  # Links are added to the Sitemap in the order they are specified.
+  #
+  # Usage: add(path, options={})
+  #        (default options are used if you don't specify)
+  #
+  # Defaults: :priority => 0.5, :changefreq => 'weekly',
+  #           :lastmod => Time.now, :host => default_host
+  #
+  # Examples:
+  #
+  # Add '/articles'
+  #
+  #   add articles_path, :priority => 0.7, :changefreq => 'daily'
+  #
+  # Add all articles:
+  #
+  #   Article.find_each do |article|
+  #     add article_path(article), :lastmod => article.updated_at
+  #   end
+
+  add "/", changefreq: "weekly"
+
+  PageModel.all.each do |page|
+    nest_level = page.request_path.split("/").count.to_f
+    priority = nest_level.zero? ? 0.9 : (1 / nest_level)
+
+    add page_path(resource_path: page.request_path), changefreq: "weekly", priority: priority
+  end
+end

public/robots.txt

@@ -1 +1,2 @@
 # See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
+Sitemap: https://hotwire.io/sitemap.xml.gz