jekyll-make-sitemap 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16db4afb3d3c11c391bb3b66415273fc85911357a5a9fd9032f740533925c3b2
-  data.tar.gz: 448cffe8ddb49bf4945a08192214eacb11bde3892670d8a4a0cc1d61658b2ee3
+  metadata.gz: bd4a41d21f409fc188d785d843aea6e5914bbe33e36746e0559dfdf53694054f
+  data.tar.gz: 2577576bcb190c6bafdf42d5b627d5a706acc1ac0c953cafe1c1eae82b1d28b3
 SHA512:
-  metadata.gz: f4458b5ea17b2942cc5381c94789a97167457c17b577b7d00e67e7ec4b9a40f1aea0f3247e7c742bf514a4a9cacdf61e4ac3673df52d54a43254b58604a0c818
-  data.tar.gz: 024267fbca6c40efc38cf0da7fc691cc0650f432e662d8dff0657fb8baf13b22730f4230d0d3a4c47499de5a551db965bf0d876758344dbcf3845d1986b2b615
+  metadata.gz: 8e40c0ec789663d2c5f02b5d0591b788c0bd90d10bcedf43126c5716d7e74501c08d99764f1f247d5e11ced80864792730e38d4d702548eb7ba13f345b8356fd
+  data.tar.gz: debe344540615d72d81f168cde9baa31ce634970f493d69b3b6be7e8ce8b5a340657875396bcb5109476729f0984f5fdf3815fb6522faff149da92c44a7c3a74

data/CHANGELOG.md

@@ -4,11 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
  
-## [1.2.0] - 2020-07-19
+## [1.3.0] - 2026-08-21
+
+Fixed
+- Endless rebuild loop under `jekyll serve`. The sitemap was written to, and then
+  deleted from, the source directory on every build. The watcher saw that churn as
+  a source change and rebuilt, which churned the file again. The sitemap is now
+  built in memory as a generated page and written only to the destination, so the
+  source directory is never touched.
+
+Changed
+- When the current environment is not listed in `environments`, no `sitemap.txt` is
+  written at all. Previously an empty `sitemap.txt` was emitted into the destination.
+
+## [1.2.1] - 2020-07-19
 
 Added
 - Ability to include posts by category in configuration
 
+Fixed
+- Bug where default env config is lost if there are config settings but none for envs
+
 ## [1.1.1] - 2020-07-12
 
 Added

data/Gemfile.lock

@@ -6,8 +6,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     colorator (1.1.0)
     concurrent-ruby (1.1.6)
     em-websocket (0.5.1)
@@ -38,7 +38,7 @@ GEM
       sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.0)
+    kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -49,12 +49,12 @@ GEM
     mercenary (0.3.6)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.5)
+    public_suffix (4.0.7)
     rake (12.3.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rouge (3.20.0)
     safe_yaml (1.0.5)
     sassc (2.4.0)

data/lib/jekyll/make/sitemap/version.rb

@@ -1,7 +1,7 @@
 module Jekyll
   module Make
     class Sitemap
-      VERSION = "1.2.0"
+      VERSION = "1.3.0"
     end
   end
 end

data/lib/jekyll/make/sitemap.rb

@@ -4,54 +4,68 @@ module Jekyll
   module Make
     class Sitemap
       class Error < StandardError; end
+
+      FILENAME = "sitemap.txt".freeze
+
       class << self
-        def generate(site, payload, file)
+        def config_for(site)
           default_config = { 'pages' => true, 'posts' => true, 'environments' => ['production'] }
-          config = site.config.has_key?("jekyll-make-sitemap") ? site.config["jekyll-make-sitemap"] : default_config
-          if config['environments'].include?(payload.jekyll.environment)
-            baseurl = site.config["url"]
-            collections = config.has_key?("collections") ? config["collections"] : []
-            unless config.has_key?("pages") && config["pages"] == false
-              payload.site.pages.each do |page| process(file, page, baseurl) end
-            end
-            unless config.has_key?("posts") && config["posts"] == false
-              payload.site.posts.each do |post|
-                if !config["posts"].eql?(true)
-                  config["posts"].each do |cat|
-                    if post.data.has_key?("categories") && post.data["categories"].include?(cat)
-                      process(file, post, baseurl)
-                    end
+          site.config.has_key?("jekyll-make-sitemap") ? default_config.merge(site.config["jekyll-make-sitemap"]) : default_config
+        end
+
+        def generate(site, config)
+          lines = []
+          baseurl = site.config["url"]
+          collections = config.has_key?("collections") ? config["collections"] : []
+          unless config.has_key?("pages") && config["pages"] == false
+            site.pages.each do |page| process(lines, page, baseurl) end
+          end
+          unless config.has_key?("posts") && config["posts"] == false
+            # Match the ordering of `site.posts` as exposed to Liquid, which
+            # `Jekyll::Drops::SiteDrop` sorts newest-first.
+            site.posts.docs.sort { |a, b| b <=> a }.each do |post|
+              if !config["posts"].eql?(true)
+                config["posts"].each do |cat|
+                  if post.data.has_key?("categories") && post.data["categories"].include?(cat)
+                    process(lines, post, baseurl)
                   end
-                else
-                  process(file, post, baseurl) 
                 end
+              else
+                process(lines, post, baseurl) 
               end
             end
-            collections.each do |col|
-              site.collections[col].docs.each do |post| process(file, post, baseurl) end
-            end
           end
+          collections.each do |col|
+            site.collections[col].docs.each do |post| process(lines, post, baseurl) end
+          end
+          lines
         end
-        def process(file, doc, baseurl)
+
+        def process(lines, doc, baseurl)
           if !((doc.data.has_key?("tags") && doc.data["tags"].include?("sitemap-exclude")) || !doc.path.end_with?(".md"))
-            file.write "#{baseurl}#{doc.url}\n"
+            lines << "#{baseurl}#{doc.url}\n"
           end
         end
       end
     end
-  end
-end
 
-Jekyll::Hooks.register :site, :after_reset do |site|
-  File.new("sitemap.txt", "w") if !File.exist?("sitemap.txt")
-end
+    # Builds the sitemap as an in-memory page so that it is written by Jekyll's
+    # normal output pipeline. Nothing is ever written to the source directory,
+    # which would otherwise churn the watcher during `jekyll serve` and trigger
+    # an endless rebuild loop.
+    class SitemapGenerator < Jekyll::Generator
+      safe true
+      priority :lowest
 
-Jekyll::Hooks.register :site, :post_render do |site, payload|
-  file = File.open("sitemap.txt", "w+")
-  Jekyll::Make::Sitemap.generate(site, payload, file)
-  file.close
-end
+      def generate(site)
+        config = Sitemap.config_for(site)
+        return unless config["environments"].include?(Jekyll.env)
 
-Jekyll::Hooks.register :site, :post_write do |site|
-  File.delete("sitemap.txt")
-end
+        page = Jekyll::PageWithoutAFile.new(site, site.source, "", Sitemap::FILENAME)
+        page.content = Sitemap.generate(site, config).join
+        page.data["layout"] = nil
+        site.pages << page
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-make-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sean Hofer
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A Jekyll hook plugin for generating a sitemap.txt file during the Jekyll
   build process.
@@ -37,7 +36,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/hofers/jekyll-make-sitemap
   source_code_uri: https://github.com/hofers/jekyll-make-sitemap
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Jekyll hook plugin for generating a sitemap.txt file during the Jekyll
   build process.