bridgetown-sitemap 1.2.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7fdbaa3c96e9fc71d97de9a13f7828a2d3aa6cc45c1a396b8157cc3281b3231
-  data.tar.gz: ee8c8d4adc46245e9ed35ab05b4450c319c0fc0c0a9d475a0114c5ef02557296
+  metadata.gz: ac539efc37311d68fe991191d98d0f88c47318128e2bf529a177af6814066a14
+  data.tar.gz: 4fed4074d7a52b2fa807b35bf9e14d29649c09d0b6e8629dad7a7a56ce21423e
 SHA512:
-  metadata.gz: f3667fc1df4b0e1d8f6e7ddfd404272c56ae996cc7d638a5d2390e9a233849e2a342aae11f7724691b81f3843e9afda18c32c04e5d9ee80c276b1d2529fe2e79
-  data.tar.gz: f4bf13d4337464aa9455b645971e277d4952c5c4554b8dbf7b9aced457b504842299c79af5ec70d063205192d378ce5f16f3e0ba9f804953f657b1b95eb9c59a
+  metadata.gz: 289155d9d0827a4c257c127227666f1d489b931521876d42b031000583a524b10d87e62e46991b6cc420d6958bbd94d1a1a9a49e125691cdd101c7e89056b52d
+  data.tar.gz: ab85ae03365fa0f65e4c1a12e32bff50c21e2254e5fa067594a58ee064021c15a03b495d8f21db009cd173670b420aad1d8cffe97e88130833dff766eccc4197

data/.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         ruby_version: [2.7.7, 3.0.5, 3.1.3, 3.2.0]
-        bridgetown_version: [1.0.0, 1.1.0]
+        bridgetown_version: [1.2.0]
     continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
     # Has to be top level to cache properly
     env:

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,14 @@
 # main
 
+# 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.
+* Initialize plugin using the new Ruby DSL in Bridgetown v1.2.
+
 # 1.2.0 / 23-01-2023
 
 * Require Bridgetown 1.0 or newer.

data/Gemfile

@@ -9,5 +9,5 @@ group :test do
   gem "minitest"
   gem "minitest-profile"
   gem "minitest-reporters"
-  gem "shoulda"
+  gem "minitest-hooks"
 end

data/README.md

@@ -10,26 +10,19 @@ Bridgetown plugin to silently generate a sitemaps.org compliant sitemap for your
 1. Install the plugin with the following command:
 
 ```shell
-bundle add bridgetown-sitemap -g bridgetown_plugins
+bundle add bridgetown-sitemap
 ```
 
-2. Add the following to your site's `bridgetown.config.yml`:
+2. Add the following to your site's `config/initializers.rb`:
 
-```yml
-url: "https://example.com" # the base hostname & protocol for your site
-```
-
-<br>
-
-**This plugin only supports Bridgetown sites that use the [resource content engine](https://www.bridgetownrb.com/docs/resources).**
-
-This can be configured by adding the following line to your site's `bridgetown.config.yml`:
+```ruby
+Bridgetown.configure do |config|
+  config.url = "https://example.com" # the base hostname & protocol for your site
 
-```yml
-content_engine: "resource"
+  init :"bridgetown-sitemap"
+end
 ```
 
-
 ## `<lastmod>` tag
 The `<lastmod>` tag in the `sitemap.xml` will reflect by priority:
 
@@ -46,15 +39,17 @@ sitemap flag to `false` in the front matter for the page.
 sitemap: false
 ```
 
-To exclude multiple files, add a glob config to your `bridgetown.config.yml` file.
+To exclude multiple files, add a glob config to your `config/initializers.rb` file.
 
-```yml
-defaults:
-  -
-    scope:
-      path: "assets/**/*.pdf"
-    values:
-      sitemap: false
+```ruby
+Bridgetown.configure do |config|
+  # ...
+
+  config.defaults << {
+    "scope" => { "path" => "assets/**/*.pdf" },
+    "values" => { "sitemap" => false }
+  }
+end
 ```
 
 ## Testing
@@ -75,4 +70,4 @@ defaults:
 
 Bridgetown Sitemap is released under the [MIT License](https://opensource.org/licenses/MIT).
 
-Copyright © 2021 [Ayush Newatia](https://twitter.com/ayushn21)
+Copyright © 2023 [Ayush Newatia](https://twitter.com/ayushn21)

data/bridgetown-sitemap.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.7.0"
 
-  spec.add_dependency "bridgetown", ">= 1.0", "< 2.0"
+  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

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/builder.rb

@@ -3,17 +3,9 @@
 require "fileutils"
 
 module BridgetownSitemap
-  class UnsupportedContentEngine < StandardError; end
-
   class Builder < Bridgetown::Builder
     def build
       hook :site, :pre_render, priority: :low do |site|
-        unless site.uses_resource?
-          Bridgetown.logger.error "\n\nbridgetown-sitemap only supports the resource content engine"
-          Bridgetown.logger.info "Add `content_engine: 'resource'` to your bridgetown.config.yml\n\n"
-          raise UnsupportedContentEngine
-        end
-
         @site = site
 
         @site.generated_pages << sitemap unless file_exists?("sitemap.xml")

data/lib/bridgetown-sitemap/version.rb

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

data/lib/bridgetown-sitemap.rb

@@ -4,4 +4,6 @@ require "bridgetown"
 require "bridgetown/resource/base"
 require "bridgetown-sitemap/builder"
 
-BridgetownSitemap::Builder.register
+Bridgetown.initializer :"bridgetown-sitemap" do |config|
+  config.builder BridgetownSitemap::Builder
+end

data/lib/sitemap.erb

@@ -18,12 +18,12 @@
   <% 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>
+    <% 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>
   <% end %>
 
   <% page.data.static_files.each do |file| %>

data/test/fixtures/config/initializers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Bridgetown.configure do |config|
+  timezone "UTC"
+
+  config.defaults << {
+    "scope" => { "path" => "excluded_files/**/*" },
+    "values" => { "sitemap" => false }
+  }
+
+  init :"bridgetown-sitemap"
+end

data/test/helper.rb

@@ -2,9 +2,12 @@
 
 require "minitest/autorun"
 require "minitest/reporters"
-require "minitest/profile"
-require "shoulda"
-require_relative "../lib/bridgetown-sitemap"
+require "minitest/hooks/default"
+require "bridgetown"
+
+Bridgetown.begin!
+
+require File.expand_path("../lib/bridgetown-sitemap", __dir__)
 
 # Report with color.
 Minitest::Reporters.use! [
@@ -14,15 +17,13 @@ Minitest::Reporters.use! [
 ]
 
 class BridgetownSitemap::Test < Minitest::Test
+  extend Minitest::Spec::DSL
+  include Minitest::Hooks
+
   ROOT_DIR = File.expand_path("fixtures", __dir__)
   SOURCE_DIR = File.join(ROOT_DIR, "src")
   DEST_DIR   = File.expand_path("dest", __dir__)
 
-  def build_site
-    @site = Bridgetown::Site.new(config)
-    process_site
-  end
-
   def root_dir(*files)
     File.join(ROOT_DIR, *files)
   end
@@ -36,44 +37,6 @@ class BridgetownSitemap::Test < Minitest::Test
   end
 
   def make_context(registers = {})
-    Liquid::Context.new({}, {}, { :site => site }.merge(registers))
-  end
-
-  def config_overrides
-    {}
-  end
-
-  def metadata_overrides
-    {}
-  end
-
-  private
-
-  def process_site
-    @metadata = {
-      "name" => "My Awesome Site",
-      "author" => {
-        "name" => "Ada Lovejoy",
-      }
-    }
-
-    metadata = @metadata.merge(metadata_overrides).to_yaml.sub("---\n", "")
-    File.write(source_dir("_data/site_metadata.yml"), metadata)
-    @site.process
-    FileUtils.rm(source_dir("_data/site_metadata.yml"))
-  end
-
-  def config
-    @config ||= Bridgetown.configuration(Bridgetown::Utils.deep_merge_hashes({
-      "full_rebuild"    => true,
-      "root_dir"        => root_dir,
-      "source"          => source_dir,
-      "destination"     => dest_dir,
-      "content_engine"  => "resource",
-      "url"             => "https://example.com",
-      "quiet"           => true
-      },
-      config_overrides
-    ))
+    Liquid::Context.new({}, {}, { site: site }.merge(registers))
   end
-end
+end

data/test/test_sitemap.rb

@@ -3,216 +3,215 @@
 require "helper"
 
 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
+    )
+
+    @config.run_initializers! context: :static
+    @site = Bridgetown::Site.new(@config)
+  end
+
+  def process_site
+    @site.process
+  end
 
-  context "rendering the site with defaults" do
-    setup { build_site }
+  describe "rendering the site with defaults" do
+    before(:all) do
+      prepare_site
+      process_site
 
-    should "create the sitemap" do
+      @sitemap = File.read(dest_dir("sitemap.xml"))
+      @robots = File.read(dest_dir("robots.txt"))
+    end
+
+    it "creates the sitemap without a layout" do
       assert File.exist?(dest_dir("sitemap.xml"))
+      refute_match %r!THIS IS MY LAYOUT!, @sitemap
     end
 
-    should "create robots.txt" do
+    it "creates robots.txt without a layout" do
       assert File.exist?(dest_dir("robots.txt"))
+      refute_match %r!\ATHIS IS MY LAYOUT!, @robots
     end
 
-    context "the sitemap" do
-      setup { @sitemap = File.read(dest_dir("sitemap.xml")) }
-
-      should "have no layout" do
-        refute_match %r!THIS IS MY LAYOUT!, @sitemap
-      end
-
-      should "put all the pages in the sitemap" do
-        assert_match %r!<loc>https://example\.com/</loc>!, @sitemap
-        assert_match %r!<loc>https://example\.com/some-subfolder/this-is-a-subpage/</loc>!, @sitemap
-      end
-
-      should "not put files with output: false into the sitemap" do
-        refute_match %r!/other_things/test2\.html</loc>!, @sitemap
-      end
-
-      should "performs URI encoding of site paths" do
-        assert_match %r!<loc>https://example\.com/this%20url%20has%20an%20%C3%BCmlaut</loc>!, @sitemap
-      end
-
-      should "put all the posts in the sitemap" do
-        assert_match %r!<loc>https://example.com/2021/05/06/may-the-sixth/</loc>!, @sitemap
-        assert_match %r!<loc>https://example.com/2021/03/04/march-the-fourth/</loc>!, @sitemap
-        assert_match %r!<loc>https://example.com/2021/03/02/march-the-second/</loc>!, @sitemap
-        assert_match %r!<loc>https://example.com/2019/07/14/last-modified-at/</loc>!, @sitemap
-      end
+    it "puts all the pages in the sitemap" do
+      assert_match %r!<loc>https://example\.com/</loc>!, @sitemap
+      assert_match %r!<loc>https://example\.com/some-subfolder/this-is-a-subpage/</loc>!, @sitemap
+    end
 
-      should "generate the correct date for each of the posts" do
-        assert_match %r!<lastmod>2021-05-06T00:00:00(-|\+)\d+:\d+</lastmod>!, @sitemap
-        assert_match %r!<lastmod>2021-03-04T00:00:00(-|\+)\d+:\d+</lastmod>!, @sitemap
-        assert_match %r!<lastmod>2021-03-02T00:00:00(-|\+)\d+:\d+</lastmod>!, @sitemap
+    it "does not put files with output: false into the sitemap" do
+      refute_match %r!/other_things/test2\.html</loc>!, @sitemap
+    end
 
-        # This doesn't work on CI because it runs a git command which isn't allowed I guess
-        unless ENV["GITHUB_ACTIONS"]
-          assert_match %r!<lastmod>2019-07-14T18:22:00\+00:00</lastmod>!, @sitemap
-        end
-      end
+    it "performs URI encoding of site paths" do
+      assert_match %r!<loc>https://example\.com/this%20url%20has%20an%20%C3%BCmlaut</loc>!, @sitemap
+    end
 
-      should "puts all the static HTML files in the sitemap.xml file" do
-        assert_match %r!<loc>https://example\.com/some-subfolder/this-is-a-subfile\.html</loc>!, @sitemap
-      end
+    it "puts all the posts in the sitemap" do
+      assert_match %r!<loc>https://example.com/2021/05/06/may-the-sixth/</loc>!, @sitemap
+      assert_match %r!<loc>https://example.com/2021/03/04/march-the-fourth/</loc>!, @sitemap
+      assert_match %r!<loc>https://example.com/2021/03/02/march-the-second/</loc>!, @sitemap
+      assert_match %r!<loc>https://example.com/2019/07/14/last-modified-at/</loc>!, @sitemap
+    end
 
-      should "does not include assets or any static files that aren't .html" do
-        refute_match %r!/assets/sample_image\.jpg</loc>!, @sitemap
-        refute_match %r!/feeds/atom\.xml</loc>!, @sitemap
-      end
+    it "generates the correct date for each of the posts" do
+      assert_match %r!<lastmod>2021-05-06T00:00:00(-|\+)\d+:\d+</lastmod>!, @sitemap
+      assert_match %r!<lastmod>2021-03-04T00:00:00(-|\+)\d+:\d+</lastmod>!, @sitemap
+      assert_match %r!<lastmod>2021-03-02T00:00:00(-|\+)\d+:\d+</lastmod>!, @sitemap
 
-      should "include assets or any static files with .xhtml and .htm extensions" do
-        assert_match %r!<loc>https://example\.com/some-subfolder/xhtml\.xhtml</loc>!, @sitemap
-        assert_match %r!<loc>https://example\.com/some-subfolder/htm\.htm</loc>!, @sitemap
+      # This doesn't work on CI because it runs a git command which isn't allowed I guess
+      unless ENV["GITHUB_ACTIONS"]
+        assert_match %r!<lastmod>2019-07-14T18:22:00\+00:00</lastmod>!, @sitemap
       end
+    end
 
-      should "include assets or any static files with .pdf extension" do
-        assert_match %r!<loc>https://example\.com/assets/sample_pdf\.pdf</loc>!, @sitemap
-      end
+    it "puts all the static HTML files in the sitemap.xml file" do
+      assert_match %r!<loc>https://example\.com/some-subfolder/this-is-a-subfile\.html</loc>!, @sitemap
+    end
 
-      should "not include any files named 404.html" do
-        refute_match %r!404.html!, @sitemap
-      end
+    it "does not include assets or any static files that aren't .html" do
+      refute_match %r!/assets/sample_image\.jpg</loc>!, @sitemap
+      refute_match %r!/feeds/atom\.xml</loc>!, @sitemap
+    end
 
-      should "not include any static files that have set 'sitemap: false'" do
-        refute_match %r!/excluded_files/excluded\.pdf!, @sitemap
-      end
+    it "includes assets or any static files with .xhtml and .htm extensions" do
+      assert_match %r!<loc>https://example\.com/some-subfolder/xhtml\.xhtml</loc>!, @sitemap
+      assert_match %r!<loc>https://example\.com/some-subfolder/htm\.htm</loc>!, @sitemap
+    end
 
-      should "not include any static html files that have set 'sitemap: false'" do
-        refute_match %r!/excluded_files/html_file\.html!, @sitemap
-      end
+    it "includes assets or any static files with .pdf extension" do
+      assert_match %r!<loc>https://example\.com/assets/sample_pdf\.pdf</loc>!, @sitemap
+    end
 
-      should "not include posts that have set 'sitemap: false'" do
-        refute_match %r!exclude-this-post!, @sitemap
-      end
+    it "does not include any files named 404.html" do
+      refute_match %r!404.html!, @sitemap
+    end
 
-      should "not include pages that have set 'sitemap: false'" do
-        refute_match %r!exclude-this-page!, @sitemap
-        refute_match %r!about!, @sitemap
-      end
+    it "does not include any static files that have set 'sitemap: false'" do
+      refute_match %r!/excluded_files/excluded\.pdf!, @sitemap
+    end
 
-      should "correctly format timestamps of static files" do
-        assert_match %r!/this-is-a-subfile\.html</loc>\s+<lastmod>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(-|\+)\d{2}:\d{2}</lastmod>!, @sitemap
-      end
+    it "does not include any static html files that have set 'sitemap: false'" do
+      refute_match %r!/excluded_files/html_file\.html!, @sitemap
+    end
 
-      should "include the correct number of items" do
-        assert_equal 18, @sitemap.scan(%r!(?=<url>)!).count
-      end
+    it "does not include posts that have set 'sitemap: false'" do
+      refute_match %r!exclude-this-post!, @sitemap
+    end
 
-      should "include generated pages" do
-        assert_match %r!<loc>https://example.com/generated_page/</loc>!, @sitemap
-      end
+    it "does not include pages that have set 'sitemap: false'" do
+      refute_match %r!exclude-this-page!, @sitemap
+      refute_match %r!about!, @sitemap
     end
 
-    context "the robots.txt" do
-      setup { @robots = File.read(dest_dir("robots.txt")) }
+    it "correctly formats timestamps of static files" do
+      assert_match %r!/this-is-a-subfile\.html</loc>\s+<lastmod>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(-|\+)\d{2}:\d{2}</lastmod>!, @sitemap
+    end
 
-      should "have no layout" do
-        refute_match %r!\ATHIS IS MY LAYOUT!, @robots
-      end
+    it "includes the correct number of items for the sitemap" do
+      assert_equal 18, @sitemap.scan(%r!(?=<url>)!).count
+    end
 
-      should "renders liquid" do
-        assert_match "Sitemap: https://example.com/sitemap.xml", @robots
-      end
+    it "includes generated pages in the sitemap" do
+      assert_match %r!<loc>https://example.com/generated_page/</loc>!, @sitemap
     end
-  end
 
-  context "rendering the site with a baseurl" do
-    setup do
-      config.base_path = "/baseurl"
-      build_site
+    it "renders liquid in the robots.txt" do
+      assert_match "Sitemap: https://example.com/sitemap.xml", @robots
     end
+  end
 
-    context "the sitemap" do
-      setup { @sitemap = File.read(dest_dir("sitemap.xml")) }
+  describe "rendering the site with a base URL" do
+    before(:all) do
+      prepare_site
+      @config.base_path = "/baseurl"
+      process_site
 
-      should "add the baseurl to the static files" do
-        assert_match %r!<loc>https://example\.com/baseurl/some-subfolder/this-is-a-subfile\.html</loc>!, @sitemap
-      end
+      @sitemap = File.read(dest_dir("sitemap.xml"))
+      @robots = File.read(dest_dir("robots.txt"))
+    end
 
-      should "add the baseurl to the pages" do
-        assert_match %r!<loc>https://example\.com/baseurl/</loc>!, @sitemap
-        assert_match %r!<loc>https://example\.com/baseurl/some-subfolder/this-is-a-subpage/</loc>!, @sitemap
-      end
+    it "adds the baseurl to the static files in the sitemap" do
+      assert_match %r!<loc>https://example\.com/baseurl/some-subfolder/this-is-a-subfile\.html</loc>!, @sitemap
+    end
 
-      should "add the baseurl to the posts" do
-        assert_match %r!<loc>https://example.com/baseurl/2021/05/06/may-the-sixth/</loc>!, @sitemap
-        assert_match %r!<loc>https://example.com/baseurl/2021/03/04/march-the-fourth/</loc>!, @sitemap
-        assert_match %r!<loc>https://example.com/baseurl/2021/03/02/march-the-second/</loc>!, @sitemap
-        assert_match %r!<loc>https://example.com/baseurl/2019/07/14/last-modified-at/</loc>!, @sitemap
-      end
+    it "adds the baseurl to the pages in the sitemap" do
+      assert_match %r!<loc>https://example\.com/baseurl/</loc>!, @sitemap
+      assert_match %r!<loc>https://example\.com/baseurl/some-subfolder/this-is-a-subpage/</loc>!, @sitemap
     end
 
-    context "the robots.txt" do
-      setup { @robots = File.read(dest_dir("robots.txt")) }
+    it "adds the baseurl to the posts in the sitemap" do
+      assert_match %r!<loc>https://example.com/baseurl/2021/05/06/may-the-sixth/</loc>!, @sitemap
+      assert_match %r!<loc>https://example.com/baseurl/2021/03/04/march-the-fourth/</loc>!, @sitemap
+      assert_match %r!<loc>https://example.com/baseurl/2021/03/02/march-the-second/</loc>!, @sitemap
+      assert_match %r!<loc>https://example.com/baseurl/2019/07/14/last-modified-at/</loc>!, @sitemap
+    end
 
-      should "add contain the baseurl" do
-        assert_match "Sitemap: https://example.com/baseurl/sitemap.xml", @robots
-      end
+    it "adds the baseurl in the robots.txt" do
+      assert_match "Sitemap: https://example.com/baseurl/sitemap.xml", @robots
     end
   end
 
-  context "rendering the site with a url that needs URI encoding" do
-    setup do
-      config.url = "http://ümlaut.example.org"
-      build_site
-    end
+  describe "rendering the site with a url that needs URI encoding" do
+    before(:all) do
+      prepare_site
+      @config.url = "http://ümlaut.example.org"
+      process_site
 
-    context "the sitemap" do
-      setup { @sitemap = File.read(dest_dir("sitemap.xml")) }
+      @sitemap = File.read(dest_dir("sitemap.xml"))
+    end
 
-      should "performs URI encoding of site url" do
-        assert_match %r!<loc>http://xn--mlaut-jva.example.org/</loc>!, @sitemap
-        assert_match %r!<loc>http://xn--mlaut-jva.example.org/some-subfolder/this-is-a-subpage/</loc>!, @sitemap
-        assert_match %r!<loc>http://xn--mlaut-jva.example.org/2021/03/04/march-the-fourth/</loc>!, @sitemap
-        assert_match %r!<loc>http://xn--mlaut-jva.example.org/2020/04/03/%E9%94%99%E8%AF%AF</loc>!, @sitemap
-        assert_match %r!<loc>http://xn--mlaut-jva.example.org/2020/04/02/%E9%94%99%E8%AF%AF</loc>!, @sitemap
-        assert_match %r!<loc>http://xn--mlaut-jva.example.org/2019/04/01/%E9%94%99%E8%AF%AF/</loc>!, @sitemap
-      end
+    it "performs URI encoding of site url" do
+      assert_match %r!<loc>http://xn--mlaut-jva.example.org/</loc>!, @sitemap
+      assert_match %r!<loc>http://xn--mlaut-jva.example.org/some-subfolder/this-is-a-subpage/</loc>!, @sitemap
+      assert_match %r!<loc>http://xn--mlaut-jva.example.org/2021/03/04/march-the-fourth/</loc>!, @sitemap
+      assert_match %r!<loc>http://xn--mlaut-jva.example.org/2020/04/03/%E9%94%99%E8%AF%AF</loc>!, @sitemap
+      assert_match %r!<loc>http://xn--mlaut-jva.example.org/2020/04/02/%E9%94%99%E8%AF%AF</loc>!, @sitemap
+      assert_match %r!<loc>http://xn--mlaut-jva.example.org/2019/04/01/%E9%94%99%E8%AF%AF/</loc>!, @sitemap
     end
   end
 
-  context "rendering the site with a user defined robots.txt" do
-    setup do
+  describe "rendering the site with a user defined robots.txt" do
+    before(:all) do
+      prepare_site
       File.write(source_dir("robots.txt"), "ROBOT")
-      build_site
+      process_site
+
       @robots = File.read(dest_dir("robots.txt"))
     end
 
-    teardown do
+    after(:all) do
       File.delete(source_dir("robots.txt"))
     end
 
-    should "not overwrite the robots.txt" do
+    it "does not overwrite the robots.txt" do
       assert_match %r!ROBOT!, @robots
       refute_match %r!Sitemap!, @robots
     end
   end
 
-  context "rendering the site with an uncommitted file" do
-    setup do
+  describe "rendering the site with an uncommitted file" do
+    before(:all) do
+      prepare_site
       File.write(source_dir("new.html"), "---\n---")
-      build_site
+      process_site
+
       @sitemap = File.read(dest_dir("sitemap.xml"))
     end
 
-    teardown do
+    after(:all) do
       File.delete(source_dir("new.html"))
     end
 
-    should "include the uncommitted file in the sitemap" do
+    it "includes the uncommitted file in the sitemap" do
       assert_match %r!<loc>https://example.com/new/</loc>!, @sitemap
     end
   end
-
-  context "rendering the site without the resource content engine" do
-    setup { config.delete "content_engine" }
-
-    should "throw an error" do
-      capture_io do
-        assert_raises(BridgetownSitemap::UnsupportedContentEngine) { build_site }
-      end
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Ayush Newatia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -97,7 +97,7 @@ files:
 - script/fmt
 - script/release
 - script/test
-- test/fixtures/bridgetown.config.yml
+- test/fixtures/config/initializers.rb
 - test/fixtures/plugins/builders/generated_pages.rb
 - test/fixtures/plugins/site_builder.rb
 - test/fixtures/src/_data/.keep
@@ -153,7 +153,7 @@ signing_key:
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Bridgetown site.
 test_files:
-- test/fixtures/bridgetown.config.yml
+- test/fixtures/config/initializers.rb
 - test/fixtures/plugins/builders/generated_pages.rb
 - test/fixtures/plugins/site_builder.rb
 - test/fixtures/src/_data/.keep

data/test/fixtures/bridgetown.config.yml

@@ -1,8 +0,0 @@
-timezone: UTC
-
-defaults:
-  -
-    scope:
-      path: "excluded_files/**/*"
-    values:
-      sitemap: false