jekyll-make-sitemap 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc834a187929e08532112c3848a7ebd82681cb91a8116c32d2408edccef635e8
-  data.tar.gz: c4c9a7013d3005a4963631d0f09f06f1fc2529fbbeb5a1fb43dc93c838719de7
+  metadata.gz: 463bbed9ec6b232b18f6570ee9050a516847d2c9ffae1c2c85cf92e63b341ba8
+  data.tar.gz: 0ef72dc954b89249c113b1f5cd3c7419d2fcd2b873bb5e04623343f609ffb6ca
 SHA512:
-  metadata.gz: a8b538b1d859f9eb1716ebe0d25ceeb74b25e62ce67ee3e82fbaf67f9a2054d35f8ff4137d8207abcc6dd669c3a6318697f68749f8d722cc02425c62e2a9308c
-  data.tar.gz: c67eca320106f61455adc6ef733dca69e4ab17bfdefa9ec7ff5c5273ce551475899add19a3aac356f9a85a0f08fdd21e61b588658298dd0dc9e8b7ebac4d30ac
+  metadata.gz: bf72ce53cb0ec9d5b7a1002e8cf0f59e41566bf8362fa69f1793991704e47532310fdc478bfdbc16b43c7fedb3212f4b4f5d8217bed4d3859f7426e041ccd45c
+  data.tar.gz: c7023a625232bfb50b2f96de78284e26748ba69abc33500f6fdf4dae75d4c264c74494942588d9143231b73158bd81a86a571909efc6b962f1b8461f0fa0265f

data/CHANGELOG.md

@@ -4,6 +4,22 @@ 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.0.0] - 2020-07-12
+## [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
+- Ability to run on non-production environments
+
+Fixed
+- Compatibility with `jekyll serve`
+
+## [1.0.0] - 2020-07-11
 
 Uploaded initial version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-make-sitemap (1.0.0)
+    jekyll-make-sitemap (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,9 @@
 # [jekyll-make-sitemap](https://rubygems.org/gems/jekyll-make-sitemap)
 [![Gem Version](https://badge.fury.io/rb/jekyll-make-sitemap.svg)](https://badge.fury.io/rb/jekyll-make-sitemap)
 
-Description
+A Jekyll hook plugin for generating a `sitemap.txt` file during the Jekyll build process. If you're interested in generating an XML sitemap I recommend checking out [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap).
+
+This plugin includes all pages and posts by default. See the [Configuration](#Configuration) section for more on configuring your sitemap. 
 
 ## Installation
 ``` 
@@ -23,11 +25,18 @@ In `_config.yml`
 ``` yaml
 jekyll-make-sitemap:
   pages: true       # Default: true
-  posts: true       # Default: true
-  collections: 
+  posts:            # Default: true
+   - category       # Categories of posts to include in sitemap; accepts true, false, or a list of categories
+  environments:     # Default: ['production']
+   - production 
+   - development
+  collections:      # Default: []
    - collection_1   # include items from collection_1 in sitemap
 ```
 
+### Exceptions
+To exclude a page or post, assign it the `sitemap-exclude` tag
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/jekyll-make-sitemap.gemspec

@@ -1,13 +1,13 @@
-require_relative 'lib/jekyll/make-sitemap/version'
+require_relative 'lib/jekyll/make/sitemap/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-make-sitemap"
-  spec.version       = Jekyll::MakeSitemap::VERSION
+  spec.version       = Jekyll::Make::Sitemap::VERSION
   spec.authors       = ["Sean Hofer"]
   spec.email         = ["me@seanhofer.com"]
 
-  spec.summary       = "A Jekyll hook for generating a sitemap.txt in production builds"
-  spec.description   = "A Jekyll hook for generating a sitemap.txt in production builds"
+  spec.summary       = "A Jekyll hook plugin for generating a sitemap.txt file during the Jekyll build process."
+  spec.description   = "A Jekyll hook plugin for generating a sitemap.txt file during the Jekyll build process."
   spec.homepage      = "https://github.com/hofers/jekyll-make-sitemap"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/})  or f.match(/^jekyll-make-sitemap-\d\.\d\.\d\.gem$/) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) or f.match(/^jekyll-make-sitemap-\d\.\d\.\d\.gem$/) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/jekyll/make/sitemap.rb

@@ -0,0 +1,57 @@
+require 'jekyll'
+
+module Jekyll 
+  module Make
+    class Sitemap
+      class Error < StandardError; end
+      class << self
+        def generate(site, payload, file)
+          default_config = { 'pages' => true, 'posts' => true, 'environments' => ['production'] }
+          config = site.config.has_key?("jekyll-make-sitemap") ? default_config.merge(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
+                  end
+                else
+                  process(file, post, baseurl) 
+                end
+              end
+            end
+            collections.each do |col|
+              site.collections[col].docs.each do |post| process(file, post, baseurl) end
+            end
+          end
+        end
+        def process(file, 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"
+          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
+
+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
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  File.delete("sitemap.txt")
+end

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

@@ -0,0 +1,7 @@
+module Jekyll
+  module Make
+    class Sitemap
+      VERSION = "1.2.1"
+    end
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-make-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Sean Hofer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies: []
-description: A Jekyll hook for generating a sitemap.txt in production builds
+description: A Jekyll hook plugin for generating a sitemap.txt file during the Jekyll
+  build process.
 email:
 - me@seanhofer.com
 executables: []
@@ -28,8 +29,8 @@ files:
 - bin/console
 - bin/setup
 - jekyll-make-sitemap.gemspec
-- lib/jekyll/make-sitemap.rb
-- lib/jekyll/make-sitemap/version.rb
+- lib/jekyll/make/sitemap.rb
+- lib/jekyll/make/sitemap/version.rb
 homepage: https://github.com/hofers/jekyll-make-sitemap
 licenses:
 - MIT
@@ -54,5 +55,6 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: A Jekyll hook for generating a sitemap.txt in production builds
+summary: A Jekyll hook plugin for generating a sitemap.txt file during the Jekyll
+  build process.
 test_files: []

data/lib/jekyll/make-sitemap.rb

@@ -1,42 +0,0 @@
-require "jekyll"
-
-module Jekyll 
-  class MakeSitemap
-    class << self
-      def generate(site, payload)
-        if payload.jekyll.environment == "production"
-          default_config = { 'pages' => true, 'posts' => true }
-          file = File.open("sitemap.txt", "w+")
-          config = site.config.has_key?("jekyll-make-sitemap") ? site.config["jekyll-make-sitemap"] : default_config
-          baseurl = site.config["url"]
-          collections = config.has_key?("collections") ? ["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| process(file, post, baseurl) end
-          end
-          collections.each do |col|
-            site.collections[col].docs.each do |post| process(file, post, baseurl) end
-          end
-
-          file.close()
-        end
-      end
-      def process(file, 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"
-        end
-      end
-    end
-  end
-end
-
-Jekyll::Hooks.register :site, :after_init do |site|
-  File.new("sitemap.txt", "w")
-end
-
-Jekyll::Hooks.register :site, :pre_render do |site, payload|
-  Jekyll::MakeSitemap.generate(site, payload)
-end

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

@@ -1,5 +0,0 @@
-module Jekyll
-  class MakeSitemap
-    VERSION = "1.0.0"
-  end
-end