Add basic sitemaps

The following article served as the basis for this first implementation
of sitemaps:

https://www.johnnunemaker.com/rails-easy-sitemaps/

Author: rossta

app/controllers/sitemaps_controller.rb

@@ -0,0 +1,24 @@
+class SitemapsController < ApplicationController
+  def index
+    respond_to do |format|
+      format.xml
+    end
+  end
+
+  def pages
+    @last_modified_at = Time.now.middle_of_day.utc
+    @pages = Page.all.published.order(published_at: :desc)
+
+    @slash_pages = %w[
+      about
+      articles
+      contact
+      meta
+      settings
+    ]
+
+    respond_to do |format|
+      format.xml
+    end
+  end
+end

app/views/sitemaps/index.xml.builder

@@ -0,0 +1,8 @@
+# index.xml.builder
+xml.instruct!
+xml.sitemapindex xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9" do
+  xml.sitemap do
+    xml.loc sitemap_pages_url(format: :xml)
+    xml.lastmod Time.utc(2020, 12, 21, 11).strftime("%Y-%m-%dT%H:%M:%S+00:00")
+  end
+end

app/views/sitemaps/pages.xml.builder

@@ -0,0 +1,21 @@
+xml.instruct!
+xml.urlset xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9" do
+  xml.url do
+    xml.loc root_url
+    xml.lastmod @last_modified_at.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+  end
+
+  @pages.each do |page|
+    xml.url do
+      xml.loc Addressable::URI.join(root_url, page.request_path)
+      xml.lastmod @last_modified_at.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+    end
+  end
+
+  @slash_pages.each do |path|
+    xml.url do
+      xml.loc Addressable::URI.join(root_url, path)
+      xml.lastmod @last_modified_at.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+    end
+  end
+end

config/routes.rb

@@ -125,12 +125,15 @@
 #                 admin_mission_control_jobs                 /admin/jobs                                                                                       MissionControl::Jobs::Engine
 #                           admin_litestream                 /admin/litestream                                                                                 Litestream::Engine
 #                                rails_admin                 /admin/data                                                                                       RailsAdmin::Engine
+#                                   sitemaps GET             /sitemap.xml(.:format)                                                                            sitemaps#index
+#                              sitemap_pages GET             /sitemap-pages.xml(.:format)                                                                      sitemaps#pages
 #                                            GET             /404(.:format)                                                                                    errors#not_found
 #                                            GET             /500(.:format)                                                                                    errors#internal_server
 #                                            GET             /422(.:format)                                                                                    errors#unprocessable
 #                          pwa_serviceworker GET             /serviceworker(.:format)                                                                          rails/pwa#serviceworker {:format=>"js"}
 #                               pwa_manifest GET             /manifest(.:format)                                                                               rails/pwa#manifest {:format=>"json"}
 #                         rails_health_check GET             /up(.:format)                                                                                     rails/health#show
+#                            deploy_hatchbox GET             /deploy/hatchbox(.:format)                                                                        redirect(301, meta/deployment/hatchbox)
 #           turbo_recede_historical_location GET             /recede_historical_location(.:format)                                                             turbo/native/navigation#recede
 #           turbo_resume_historical_location GET             /resume_historical_location(.:format)                                                             turbo/native/navigation#resume
 #          turbo_refresh_historical_location GET             /refresh_historical_location(.:format)                                                            turbo/native/navigation#refresh
@@ -323,6 +326,9 @@
 
   mount RailsAdmin::Engine => "/admin/data", :as => "rails_admin", :constraints => Routes::AdminAccessConstraint.new
 
+  get "/sitemap" => "sitemaps#index", :as => :sitemaps, :constraints => {format: "xml"}
+  get "/sitemap-pages" => "sitemaps#pages", :as => :sitemap_pages, :constraints => {format: "xml"}
+
   get "/404", to: "errors#not_found"
   get "/500", to: "errors#internal_server"
   get "/422", to: "errors#unprocessable"

spec/requests/sitemaps_spec.rb

@@ -0,0 +1,31 @@
+require "rails_helper"
+
+RSpec.describe "Sitemaps", type: :request do
+  describe "GET /sitemaps" do
+    it "renders list of sitemaps" do
+      get sitemaps_path(format: :xml)
+
+      expect(response).to have_http_status(200)
+      expect(document).to have_xpath("//sitemapindex/sitemap/loc", text: "http://example.com/sitemap-pages.xml")
+    end
+  end
+
+  describe "GET /sitemap-pages.xml" do
+    it "renders sitemap" do
+      pages = Page.upsert_collection_from_sitepress!(limit: 3)
+      get sitemap_pages_path(format: :xml)
+
+      expect(response).to have_http_status(200)
+      expect(document).to have_xpath("//urlset/url/loc", text: "http://example.com/")
+      expect(document).to have_xpath("//urlset/url/loc", text: "http://example.com/about")
+      expect(document).to have_xpath("//urlset/url/loc", text: "http://example.com/articles")
+      expect(document).to have_xpath("//urlset/url/loc", text: "http://example.com/contact")
+      expect(document).to have_xpath("//urlset/url/loc", text: "http://example.com/meta")
+      expect(document).to have_xpath("//urlset/url/loc", text: "http://example.com/settings")
+
+      pages.each do |page|
+        expect(document).to have_xpath("//urlset/url/loc", text: "http://example.com#{page.request_path}")
+      end
+    end
+  end
+end