bridgetown-sitemap 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0baaab38ea6feb29653fec867f81a3cff27f8423497ebd91b5b43b786f4f3cc
+  data.tar.gz: 1ee7250c217916417007949bc5238fffa139a7ecbe3e46b87e3dd289a61e813a
+SHA512:
+  metadata.gz: be2ff77fd2e15d1741fa8a57938059d0c475a44a226353b9be2fd12d8469a9c073b103794957390c95a5d157a64332d1196bdfb33e3f7a80407fef228d9ff9ac
+  data.tar.gz: 2fcab96c2edaae32d3355328e8afec2d84878af173ec9d02c452b37aa75c3e4566a116b3cf5dc77aa2b9e989c1053e09dc8c9772a8fc4d0b2b2b5c1e6124465b

data/.gitignore

@@ -0,0 +1,41 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+# macOS
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "minitest"
+  gem "minitest-profile"
+  gem "minitest-reporters"
+  gem "shoulda"
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Bridgetown Sitemap Generator Plugin
+
+**_Bridgetown plugin to silently generate a sitemaps.org compliant sitemap for your Bridgetown site_**
+
+## Usage
+
+1. Install the plugin with the following command:
+
+```shell
+bundle add bridgetown-sitemap -g bridgetown_plugins
+```
+
+2. Add the following to your site's `bridgetown.config.yml`:
+
+```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`:
+
+```yml
+content_engine: "resource"
+```
+
+
+## `<lastmod>` tag
+The `<lastmod>` tag in the `sitemap.xml` will reflect by priority:
+
+1. A personalised date if you add the variable `last_modified_at:` with a date in the Front Matter. (*Dates need to be formatted as* `%Y-%m-%d %H:%M:%S %z`)
+2. The modified date of the file as reported by the filesystem.
+
+
+## Exclusions
+
+If you would like to exclude specific pages from the sitemap set the
+sitemap flag to `false` in the front matter for the page.
+
+```yml
+sitemap: false
+```
+
+To exclude multiple files, add a glob config to your `bridgetown.config.yml` file.
+
+```yml
+defaults:
+  -
+    scope:
+      path: "assets/**/*.pdf"
+    values:
+      sitemap: false
+```
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and run tests together.
+
+## Contributing
+
+1. Fork it (https://github.com/ayushn21/bridgetown-sitemap/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task spec: :test
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+  test.warning = false
+end

data/bridgetown-sitemap.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-sitemap/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "bridgetown-sitemap"
+  spec.summary     = "Automatically generate a sitemap.xml for your Bridgetown site."
+  spec.version     = BridgetownSitemap::VERSION
+  spec.authors     = ["Ayush Newatia"]
+  spec.email       = "ayush@hey.com"
+  spec.homepage    = "https://github.com/ayushn21/bridgetown-sitemap"
+  spec.licenses    = ["MIT"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.20", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/lib/bridgetown-sitemap.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown/resource/base"
+require "bridgetown-sitemap/builder"
+
+BridgetownSitemap::Builder.register

data/lib/bridgetown-sitemap/builder.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+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")
+        @site.generated_pages << robots unless file_exists?("robots.txt")
+      end
+    end
+
+    private
+
+    INCLUDED_EXTENSIONS = %w(
+      .htm
+      .html
+      .xhtml
+      .pdf
+    ).freeze
+
+    # Array of all non-bridgetown site files with an HTML extension
+    def static_files
+      @site.static_files.select { |file| INCLUDED_EXTENSIONS.include? file.extname }
+    end
+
+    def source_path(file)
+      File.expand_path "../#{file}", __dir__
+    end
+
+    def destination_path(file)
+      @site.in_dest_dir(file)
+    end
+
+    def sitemap
+      site_map = Bridgetown::GeneratedPage.new(@site, @site.source, "/", "sitemap.erb", from_plugin: true)
+      site_map.content = File.read(source_path(site_map.name))
+      site_map.data.permalink = "/sitemap.xml"
+      site_map.data.layout = "none"
+      site_map.data.static_files = static_files
+      site_map.data.xsl = file_exists?("sitemap.xsl")
+      site_map
+    end
+
+    def robots
+      robots = Bridgetown::GeneratedPage.new(@site, @site.source, "/", "robots.liquid", from_plugin: true)
+      robots.content = File.read(source_path(robots.name))
+      robots.data.layout = "none"
+      robots.data.permalink = "/robots.txt"
+      robots
+    end
+
+    # Checks if a file already exists in the site source
+    def file_exists?(file_path)
+      pages_and_files.any? { |p| p.relative_path == "/#{file_path}" }
+    end
+
+    def pages_and_files
+      @pages_and_files ||= @site.collections.pages.resources + @site.static_files
+    end
+  end
+end

data/lib/bridgetown-sitemap/version.rb

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

data/lib/bridgetown/resource/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Resource
+    class Base
+      def sitemap_last_modified_at
+        data.last_modified_at || File.mtime(path) || date
+      end
+    end
+  end
+end

data/lib/robots.liquid

@@ -0,0 +1 @@
+Sitemap: {{ "sitemap.xml" | absolute_url }}

data/lib/sitemap.erb

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<% if page.data.xsl.present? %>
+  <?xml-stylesheet type="text/xsl" href="/sitemap.xsl"?>
+<% end %>
+
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <% output_collection_names = site.config.collections.select { |_name, data| data.output }.keys %>
+
+  <% collections.slice(*output_collection_names).each do |_name, collection| %>
+    <% collection.resources.each do |resource| %>
+      <% next if resource.id == "/404" || resource.data.sitemap == false %>
+      <url>
+        <loc><%= xml_escape resource.absolute_url %></loc>
+        <lastmod><%= resource.sitemap_last_modified_at.localtime.xmlschema %></lastmod>
+      </url>
+    <% end %>
+  <% 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>
+  <% end %>
+
+  <% page.data.static_files.each do |file| %>
+    <% next if file.data.sitemap == false %>
+    <url>
+      <loc><%= xml_escape absolute_url(file.relative_path) %></loc>
+      <lastmod><%= file.modified_time.localtime.xmlschema %></lastmod>
+    </url>
+  <% end %>
+</urlset>

data/script/cibuild

@@ -0,0 +1,6 @@
+#! /bin/bash
+
+set -e
+
+script/fmt
+script/test

data/script/fmt

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+echo "Rubocop $(bundle exec rubocop --version)"
+bundle exec rubocop -D -E $@
+success=$?
+if ((success != 0)); then
+   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
+fi
+exit $success

data/script/release

@@ -0,0 +1,7 @@
+#!/bin/sh
+# Tag and push a release to Rubygems
+
+set -e
+
+script/cibuild
+bundle exec rake release

data/script/test

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -e
+
+# Usage:
+#   script/test <test_file>
+#   script/test
+
+if [ -d test/dest ]
+  then rm -r test/dest
+fi
+
+testopts="--profile"
+
+if [[ $# -lt 1 ]]
+then
+  set -x
+  time ruby -S bundle exec \
+    rake TESTOPTS=$testopts test
+else
+  set -x
+  time ruby -S bundle exec ruby -I test \
+    "$@" $testops
+fi

data/test/fixtures/bridgetown.config.yml

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

data/test/fixtures/plugins/builders/generated_pages_builder.rb

@@ -0,0 +1,11 @@
+class GeneratedPagesBuilder < SiteBuilder
+  def build
+    generator do
+      generated_page = Bridgetown::GeneratedPage.new(site, site.source, "/", "generated_page.erb")
+      generated_page.content = "<%= 'created from a plugin'.capitalize %>"
+      generated_page.data.layout = "default"
+
+      site.generated_pages << generated_page
+    end
+  end
+end

data/test/fixtures/plugins/site_builder.rb

@@ -0,0 +1,3 @@
+class SiteBuilder < Bridgetown::Builder
+  # write builders which subclass SiteBuilder in plugins/builder
+end

data/test/fixtures/src/_layouts/default.html

@@ -0,0 +1,10 @@
+---
+---
+<html>
+  <head>
+  </head>
+  <body>
+    THIS IS MY LAYOUT
+    {{ content }}
+  </body>
+</html>

data/test/fixtures/src/_other_things/test2.html

@@ -0,0 +1,4 @@
+---
+---
+
+This file shouldn't show up in the sitemap.

data/test/fixtures/src/_posts/2019-04-01-/351/224/231/350/257/257.html

@@ -0,0 +1,2 @@
+---
+---

data/test/fixtures/src/_posts/2019-07-14-last-modified-at.md

@@ -0,0 +1,4 @@
+---
+---
+
+Please don't modify this file. It's modified time is important.

data/test/fixtures/src/_posts/2020-04-02-/351/224/231/350/257/257.html

@@ -0,0 +1,3 @@
+---
+permalink: "/2020/04/02/错误.html"
+---

data/test/fixtures/src/_posts/2020-04-03-/351/224/231/350/257/257.html

@@ -0,0 +1,3 @@
+---
+permalink: "/2020/04/03/%E9%94%99%E8%AF%AF.html"
+---

data/test/fixtures/src/_posts/2020-05-11-exclude-this-post.md

@@ -0,0 +1,5 @@
+---
+sitemap: false
+---
+
+This post should not appear in the sitemap.

data/test/fixtures/src/_posts/2021-03-02-march-the-second.md

@@ -0,0 +1,5 @@
+---
+last_modified_at: 2021-03-02 00:00:00 +0000
+---
+
+March the second!

data/test/fixtures/src/_posts/2021-03-04-march-the-fourth.md

@@ -0,0 +1,5 @@
+---
+last_modified_at: 2021-03-04 00:00:00 +0000
+---
+
+March the fourth!

data/test/fixtures/src/_posts/2021-05-06-may-the-sixth.md

@@ -0,0 +1,5 @@
+---
+last_modified_at: 2021-05-06 00:00:00 +0000
+---
+
+6th of May!

data/test/fixtures/src/about.html

@@ -0,0 +1,6 @@
+---
+layout: default
+sitemap: false
+---
+
+<h1>About</h1>

data/test/fixtures/src/feeds/atom.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+</feed>

data/test/fixtures/src/index.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+<h1>Index</h1>

data/test/fixtures/src/some-subfolder/exclude-this-page.html

@@ -0,0 +1,5 @@
+---
+sitemap: false
+---
+
+Exclude this page

data/test/fixtures/src/some-subfolder/htm.htm

@@ -0,0 +1 @@
+This file has an .htm extension, and should be included in the sitemap

data/test/fixtures/src/some-subfolder/index.html

@@ -0,0 +1 @@
+static subfolder index.html file that should be indexed as permalink

data/test/fixtures/src/some-subfolder/test_index.html

@@ -0,0 +1,4 @@
+---
+---
+
+The permalink of this page does not end with a '/', but with a filename

data/test/fixtures/src/some-subfolder/this-is-a-subpage.html

@@ -0,0 +1,4 @@
+---
+---
+
+This is a subpage!

data/test/fixtures/src/some-subfolder/xhtml.xhtml

@@ -0,0 +1 @@
+This file has an .xhtml extension, and should be included in the sitemap

data/test/fixtures/src/this-has-non-standard-chars.md

@@ -0,0 +1,5 @@
+---
+permalink: this url has an ümlaut
+---
+
+# URL contains characters that need to be URI encoded

data/test/helper.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "minitest/reporters"
+require "minitest/profile"
+require "shoulda"
+require_relative "../lib/bridgetown-sitemap"
+
+# Report with color.
+Minitest::Reporters.use! [
+  Minitest::Reporters::DefaultReporter.new(
+    color: true
+  ),
+]
+
+class BridgetownSitemap::Test < Minitest::Test
+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
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  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
+    ))
+  end
+end

data/test/test_sitemap.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require "helper"
+
+class TestSitemap < BridgetownSitemap::Test
+
+  context "rendering the site with defaults" do
+    setup { build_site }
+
+    should "create the sitemap" do
+      assert File.exist?(dest_dir("sitemap.xml"))
+    end
+
+    should "create robots.txt" do
+      assert File.exist?(dest_dir("robots.txt"))
+    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
+
+      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
+        assert_match %r!<lastmod>2020-12-24T03:51:50\+00:00</lastmod>!, @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
+
+      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
+
+      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
+      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
+
+      should "not include any files named 404.html" do
+        refute_match %r!404.html!, @sitemap
+      end
+
+      should "not include any static files that have set 'sitemap: false'" do
+        refute_match %r!/excluded_files/excluded\.pdf!, @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
+
+      should "not include posts that have set 'sitemap: false'" do
+        refute_match %r!exclude-this-post!, @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
+
+      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
+
+      should "include the correct number of items" do
+        assert_equal 17, @sitemap.scan(%r!(?=<url>)!).count
+      end
+
+      should "include generated pages" do
+        assert_match %r!<loc>https://example.com/generated_page/</loc>!, @sitemap
+      end
+    end
+
+    context "the robots.txt" do
+      setup { @robots = File.read(dest_dir("robots.txt")) }
+
+      should "have no layout" do
+        refute_match %r!\ATHIS IS MY LAYOUT!, @robots
+      end
+
+      should "renders liquid" do
+        assert_match "Sitemap: https://example.com/sitemap.xml", @robots
+      end
+    end
+  end
+
+  context "rendering the site with a baseurl" do
+    setup do
+      config.baseurl = "/baseurl"
+      build_site
+    end
+
+    context "the sitemap" do
+      setup { @sitemap = File.read(dest_dir("sitemap.xml")) }
+
+      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
+
+      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
+
+      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
+    end
+
+    context "the robots.txt" do
+      setup { @robots = File.read(dest_dir("robots.txt")) }
+
+      should "add contain the baseurl" do
+        assert_match "Sitemap: https://example.com/baseurl/sitemap.xml", @robots
+      end
+    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
+
+    context "the sitemap" do
+      setup { @sitemap = File.read(dest_dir("sitemap.xml")) }
+
+      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
+    end
+  end
+
+  context "rendering the site with a user defined robots.txt" do
+    setup do
+      File.write(source_dir("robots.txt"), "ROBOT")
+      build_site
+      @robots = File.read(dest_dir("robots.txt"))
+    end
+
+    teardown do
+      File.delete(source_dir("robots.txt"))
+    end
+
+    should "not overwrite the robots.txt" do
+      assert_match %r!ROBOT!, @robots
+      refute_match %r!Sitemap!, @robots
+    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

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-sitemap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ayush Newatia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: ayush@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bridgetown-sitemap.gemspec
+- lib/bridgetown-sitemap.rb
+- lib/bridgetown-sitemap/builder.rb
+- lib/bridgetown-sitemap/version.rb
+- lib/bridgetown/resource/base.rb
+- lib/robots.liquid
+- lib/sitemap.erb
+- script/cibuild
+- script/fmt
+- script/release
+- script/test
+- test/fixtures/bridgetown.config.yml
+- test/fixtures/plugins/builders/generated_pages_builder.rb
+- test/fixtures/plugins/site_builder.rb
+- test/fixtures/src/_data/.keep
+- test/fixtures/src/_layouts/default.html
+- test/fixtures/src/_other_things/test2.html
+- test/fixtures/src/_posts/2019-04-01-错误.html
+- test/fixtures/src/_posts/2019-07-14-last-modified-at.md
+- test/fixtures/src/_posts/2020-04-02-错误.html
+- test/fixtures/src/_posts/2020-04-03-错误.html
+- test/fixtures/src/_posts/2020-05-11-exclude-this-post.md
+- test/fixtures/src/_posts/2021-03-02-march-the-second.md
+- test/fixtures/src/_posts/2021-03-04-march-the-fourth.md
+- test/fixtures/src/_posts/2021-05-06-may-the-sixth.md
+- test/fixtures/src/about.html
+- test/fixtures/src/assets/sample_image.jpg
+- test/fixtures/src/assets/sample_pdf.pdf
+- test/fixtures/src/excluded_files/excluded_pdf.pdf
+- test/fixtures/src/excluded_files/html_file.html
+- test/fixtures/src/feeds/atom.xml
+- test/fixtures/src/index.html
+- test/fixtures/src/some-subfolder/exclude-this-page.html
+- 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/this-is-a-subfile.html
+- test/fixtures/src/some-subfolder/this-is-a-subpage.html
+- test/fixtures/src/some-subfolder/xhtml.xhtml
+- test/fixtures/src/this-has-non-standard-chars.md
+- test/helper.rb
+- test/test_sitemap.rb
+homepage: https://github.com/ayushn21/bridgetown-sitemap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Automatically generate a sitemap.xml for your Bridgetown site.
+test_files:
+- test/fixtures/bridgetown.config.yml
+- test/fixtures/plugins/builders/generated_pages_builder.rb
+- test/fixtures/plugins/site_builder.rb
+- test/fixtures/src/_data/.keep
+- test/fixtures/src/_layouts/default.html
+- test/fixtures/src/_other_things/test2.html
+- test/fixtures/src/_posts/2019-04-01-错误.html
+- test/fixtures/src/_posts/2019-07-14-last-modified-at.md
+- test/fixtures/src/_posts/2020-04-02-错误.html
+- test/fixtures/src/_posts/2020-04-03-错误.html
+- test/fixtures/src/_posts/2020-05-11-exclude-this-post.md
+- test/fixtures/src/_posts/2021-03-02-march-the-second.md
+- test/fixtures/src/_posts/2021-03-04-march-the-fourth.md
+- test/fixtures/src/_posts/2021-05-06-may-the-sixth.md
+- test/fixtures/src/about.html
+- test/fixtures/src/assets/sample_image.jpg
+- test/fixtures/src/assets/sample_pdf.pdf
+- test/fixtures/src/excluded_files/excluded_pdf.pdf
+- test/fixtures/src/excluded_files/html_file.html
+- test/fixtures/src/feeds/atom.xml
+- test/fixtures/src/index.html
+- test/fixtures/src/some-subfolder/exclude-this-page.html
+- 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/this-is-a-subfile.html
+- test/fixtures/src/some-subfolder/this-is-a-subpage.html
+- test/fixtures/src/some-subfolder/xhtml.xhtml
+- test/fixtures/src/this-has-non-standard-chars.md
+- test/helper.rb
+- test/test_sitemap.rb