jekyll-sitemap 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d72f608d750c33e415a1310cc27cb168eb85f8c44bba7d5cc8b57cd30e1bcf7
-  data.tar.gz: 1b6e319eefec2756983e9d583b086e42992d79f27afc96d42974ca5ea299cf0f
+  metadata.gz: 337a5086866fdc4e32826bc5f0fe55479f8a21b35a27e680b53caa5280fb579c
+  data.tar.gz: 5eb0b8f16a9c5d9e05d8e80886e2ae84f67ede7103ec717457e30904e9f13e5a
 SHA512:
-  metadata.gz: 689ff7481d8d20f46ea345acf86aa76ce486b23ace38f9f063e726dd1b5b1a9e4228ba7e2c23d34c4988505ed8c23f5ee93b9f9363a990c8beadaa966be9fd05
-  data.tar.gz: 968839d0875ec17ee5d0cfd5b22cd43d95229a204321211aace6849bb0d6b5df2839024ecd256018facc778cf1ac3ebdad8d25e75909c40edfc86a4036cfd5ba
+  metadata.gz: 0f81c53e4acc536e757f308c976bcbfa3e233148b99a1c23d289effb0900269cff8dc8be68435541b0794e0fdd61cb0dd161ce95e6142c1678dc903141fab1c3
+  data.tar.gz: 7f6e69c5b0a3fedf6105d898e0ccd6a904f3a829a7095e09a46f5aaf50179954ad96139af0194f27b446e67762cfb028275baf768fd4f8525f5cf719cab12850

data/.gitignore

@@ -2,3 +2,4 @@
 Gemfile.lock
 spec/dest
 .bundle
+spec/fixtures/.jekyll-cache

data/.rubocop.yml

@@ -1,11 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-jekyll
+
 inherit_gem:
-  jekyll: .rubocop.yml
+  rubocop-jekyll: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
-  Include:
-    - lib/*.rb
-
-  Exclude:
-    - script/**/*
-    - spec/**/*
+  TargetRubyVersion: 2.4

data/.rubocop_todo.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-12-06 11:55:46 +0100 using RuboCop version 0.61.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/Debugger:
+  Exclude:
+    - 'script/console'
+
+# Offense count: 3
+# Configuration parameters: CountComments, Max, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/jekyll-sitemap_spec.rb'
+    - 'spec/test_jekyll-last-modified-at.rb'
+
+# Offense count: 17
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 154

data/.travis.yml

@@ -1,28 +1,25 @@
-sudo: false
 language: ruby
 cache: bundler
 rvm:
-- 2.2
-- 2.3
 - 2.4
-- 2.5
+- 2.6
 matrix:
   include:
   # GitHub Pages
-  - rvm: 2.4.0
+  - rvm: 2.5.3
     env:
-    - JEKYLL_VERSION=3.6.2
+    - JEKYLL_VERSION=3.7.4
     - GITHUB_PAGES=1 # Only set on one build in matrix
 env:
   matrix:
-  - JEKYLL_VERSION=3.6
+  - JEKYLL_VERSION=3.8
 branches:
   only:
   - master
   - /^v\d+\.\d+\.\d+/
 git:
   depth: 1000
-before_install: 
+before_install:
 - gem update --system
 install:
 - travis_retry script/bootstrap

data/Gemfile

@@ -3,6 +3,4 @@
 source "https://rubygems.org"
 gemspec
 
-if ENV["JEKYLL_VERSION"]
-  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
-end
+gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}" if ENV["JEKYLL_VERSION"]

data/History.markdown

@@ -1,3 +1,21 @@
+## HEAD
+
+  * Release: v1.3.0 (#243)
+
+## 1.3.0 / 2019-03-21
+
+  * Allow Jekyll v4 (still alpha)
+
+### Documentation
+
+  * Add PDF file exclusion documentation (#213)
+  * Correct capitalization of GitHub (#207)
+
+### Development Fixes
+
+  * Use Ruby 2.3 and Rubocop 0.55 (#214)
+  * chore(deps): rubocop-jekyll-0.3 (#227)
+
 ## 1.2.0 / 2018-01-25
 
 ### Minor Enhancements

data/README.md

@@ -29,17 +29,17 @@ Because the sitemap is added to `site.pages`, you may have to modify any
 templates that iterate through all pages (for example, to build a menu of
 all of the site's content).
 
-## Note on Use with Github Pages Gem
-The Github Pages gem ignores all plugins included in the Gemfile. If you only include `jekyll-sitemap` in the Gemfile without also including it in the `_config.yml` *the plugin will not work*. This can be confusing because the official Jekyll docs state that plugins can be included in either the Gemfile or `_config.yml`.
+## Note on Use with GitHub Pages Gem
+The GitHub Pages gem ignores all plugins included in the Gemfile. If you only include `jekyll-sitemap` in the Gemfile without also including it in the `_config.yml` *the plugin will not work*. This can be confusing because the official Jekyll docs state that plugins can be included in either the Gemfile or `_config.yml`.
 
-When building a site that uses the Github Pages gem, follow the instructions above and ensure that `jekyll-sitemap` is listed in the `plugins` array in `_config.yml`.
+When building a site that uses the GitHub Pages gem, follow the instructions above and ensure that `jekyll-sitemap` is listed in the `plugins` array in `_config.yml`.
 
 :warning: If you are using Jekyll < 3.5.0 use the `gems` key instead of `plugins`.
 
 ## `<lastmod>` tag
 The `<lastmod>` tag in the `sitemap.xml` will reflect by priority:
 
-1.   The modified date of the file as reported by the filesystem if you have `jekyll-last-modified-at` plugin installed (not compatible with Github Pages auto building)
+1.   The modified date of the file as reported by the filesystem if you have `jekyll-last-modified-at` plugin installed (not compatible with GitHub Pages auto building)
 2.   A personalised date if you add the variable `last_modified_at:` with a date in the Front Matter
 3.   The creation date of your post (corresponding to the `post.date` variable)
 
@@ -52,6 +52,19 @@ sitemap flag to `false` in the front matter for the page/post.
 sitemap: false
 ```
 
+To exclude files from your sitemap. It can be achieved with configuration using [Jekyll v3.7.2 and jekyll-sitemap v1.2.0](https://github.com/jekyll/jekyll/commit/776433109b96cb644938ffbf9caf4923bdde4d7f).
+
+Add a glob config to your `_config.yml` file. 
+
+```yml
+defaults:
+  -
+    scope:
+      path:            "assets/**/*.pdf"
+    values:
+      sitemap:         false
+```
+
 ## Override default development settings
 
 [Follow these instructions on Jekyll's documentation](https://jekyllrb.com/docs/usage/#override-default-development-settings).

data/jekyll-sitemap.gemspec

@@ -18,11 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll", "~> 3.3"
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "jekyll-last-modified-at", "0.3.4"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "0.51"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.4"
 end

data/lib/jekyll-sitemap/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Sitemap
-    VERSION = "1.2.0".freeze
+    VERSION = "1.3.0"
   end
 end

data/lib/jekyll/jekyll-sitemap.rb

@@ -27,7 +27,7 @@ module Jekyll
     #   1. A '>' followed by a newline or
     #   2. A '}' which closes a Liquid tag
     # We will strip all of this whitespace to minify the template
-    MINIFY_REGEX = %r!(?<=>\n|})\s+!
+    MINIFY_REGEX = %r!(?<=>\n|})\s+!.freeze
 
     # Array of all non-jekyll site files with an HTML extension
     def static_files

data/lib/jekyll/page_without_a_file.rb

@@ -2,8 +2,10 @@
 
 module Jekyll
   class PageWithoutAFile < Page
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def read_yaml(*)
       @data ||= {}
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
   end
 end

data/script/console

@@ -1,4 +1,5 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
 
 def relative_to_root(path)
   File.expand_path(path, File.dirname(__dir__))
@@ -20,11 +21,11 @@ def dest_dir(*files)
 end
 
 def config(overrides = {})
-  Jekyll.configuration({
+  Jekyll.configuration(
     "source"      => source_dir,
     "destination" => dest_dir,
-    "url"         => "http://example.org",
-  }).merge(overrides)
+    "url"         => "http://example.org"
+  ).merge(overrides)
 end
 
 def site(configuration = config)

data/spec/jekyll-sitemap_spec.rb

@@ -37,64 +37,64 @@ describe(Jekyll::JekyllSitemap) do
   end
 
   it "puts all the pages in the sitemap.xml file" do
-    expect(contents).to match /<loc>http:\/\/example\.org\/<\/loc>/
-    expect(contents).to match /<loc>http:\/\/example\.org\/some-subfolder\/this-is-a-subpage\.html<\/loc>/
+    expect(contents).to match %r!<loc>http://example\.org/</loc>!
+    expect(contents).to match %r!<loc>http://example\.org/some-subfolder/this-is-a-subpage\.html</loc>!
   end
 
   it "only strips 'index.html' from end of permalink" do
-    expect(contents).to match /<loc>http:\/\/example\.org\/some-subfolder\/test_index\.html<\/loc>/
+    expect(contents).to match %r!<loc>http://example\.org/some-subfolder/test_index\.html</loc>!
   end
 
   it "puts all the posts in the sitemap.xml file" do
-    expect(contents).to match /<loc>http:\/\/example\.org\/2014\/03\/04\/march-the-fourth\.html<\/loc>/
-    expect(contents).to match /<loc>http:\/\/example\.org\/2014\/03\/02\/march-the-second\.html<\/loc>/
-    expect(contents).to match /<loc>http:\/\/example\.org\/2013\/12\/12\/dec-the-second\.html<\/loc>/
+    expect(contents).to match %r!<loc>http://example\.org/2014/03/04/march-the-fourth\.html</loc>!
+    expect(contents).to match %r!<loc>http://example\.org/2014/03/02/march-the-second\.html</loc>!
+    expect(contents).to match %r!<loc>http://example\.org/2013/12/12/dec-the-second\.html</loc>!
   end
 
   describe "collections" do
     it "puts all the `output:true` into sitemap.xml" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/my_collection\/test\.html<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/my_collection/test\.html</loc>!
     end
 
     it "doesn't put all the `output:false` into sitemap.xml" do
-      expect(contents).to_not match /<loc>http:\/\/example\.org\/other_things\/test2\.html<\/loc>/
+      expect(contents).to_not match %r!<loc>http://example\.org/other_things/test2\.html</loc>!
     end
 
     it "remove 'index.html' for directory custom permalinks" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/permalink\/<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/permalink/</loc>!
     end
 
     it "doesn't remove filename for non-directory custom permalinks" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/permalink\/unique_name\.html<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/permalink/unique_name\.html</loc>!
     end
 
     it "performs URI encoding of site paths" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/this%20url%20has%20an%20%C3%BCmlaut<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/this%20url%20has%20an%20%C3%BCmlaut</loc>!
     end
   end
 
   it "generates the correct date for each of the posts" do
-    expect(contents).to match /<lastmod>2014-03-04T00:00:00(-|\+)\d+:\d+<\/lastmod>/
-    expect(contents).to match /<lastmod>2014-03-02T00:00:00(-|\+)\d+:\d+<\/lastmod>/
-    expect(contents).to match /<lastmod>2013-12-12T00:00:00(-|\+)\d+:\d+<\/lastmod>/
+    expect(contents).to match %r!<lastmod>2014-03-04T00:00:00(-|\+)\d+:\d+</lastmod>!
+    expect(contents).to match %r!<lastmod>2014-03-02T00:00:00(-|\+)\d+:\d+</lastmod>!
+    expect(contents).to match %r!<lastmod>2013-12-12T00:00:00(-|\+)\d+:\d+</lastmod>!
   end
 
   it "puts all the static HTML files in the sitemap.xml file" do
-    expect(contents).to match /<loc>http:\/\/example\.org\/some-subfolder\/this-is-a-subfile\.html<\/loc>/
+    expect(contents).to match %r!<loc>http://example\.org/some-subfolder/this-is-a-subfile\.html</loc>!
   end
 
   it "does not include assets or any static files that aren't .html" do
-    expect(contents).not_to match /<loc>http:\/\/example\.org\/images\/hubot\.png<\/loc>/
-    expect(contents).not_to match /<loc>http:\/\/example\.org\/feeds\/atom\.xml<\/loc>/
+    expect(contents).not_to match %r!<loc>http://example\.org/images/hubot\.png</loc>!
+    expect(contents).not_to match %r!<loc>http://example\.org/feeds/atom\.xml</loc>!
   end
 
   it "converts static index.html files to permalink version" do
-    expect(contents).to match /<loc>http:\/\/example\.org\/some-subfolder\/<\/loc>/
+    expect(contents).to match %r!<loc>http://example\.org/some-subfolder/</loc>!
   end
 
   it "does include assets or any static files with .xhtml and .htm extensions" do
-    expect(contents).to match /\/some-subfolder\/xhtml\.xhtml/
-    expect(contents).to match /\/some-subfolder\/htm\.htm/
+    expect(contents).to match %r!/some-subfolder/xhtml\.xhtml!
+    expect(contents).to match %r!/some-subfolder/htm\.htm!
   end
 
   it "does include assets or any static files with .pdf extension" do
@@ -116,19 +116,19 @@ describe(Jekyll::JekyllSitemap) do
   end
 
   it "does not include posts that have set 'sitemap: false'" do
-    expect(contents).not_to match /\/exclude-this-post\.html<\/loc>/
+    expect(contents).not_to match %r!/exclude-this-post\.html</loc>!
   end
 
   it "does not include pages that have set 'sitemap: false'" do
-    expect(contents).not_to match /\/exclude-this-page\.html<\/loc>/
+    expect(contents).not_to match %r!/exclude-this-page\.html</loc>!
   end
 
   it "does not include the 404 page" do
-    expect(contents).not_to match /\/404\.html<\/loc>/
+    expect(contents).not_to match %r!/404\.html</loc>!
   end
 
   it "correctly formats timestamps of static files" do
-    expect(contents).to match /\/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>/
+    expect(contents).to 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>!
   end
 
   it "includes the correct number of items" do
@@ -142,26 +142,26 @@ describe(Jekyll::JekyllSitemap) do
 
   context "with a baseurl" do
     let(:config) do
-      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, { "baseurl" => "/bass" }))
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, "baseurl" => "/bass"))
     end
 
     it "correctly adds the baseurl to the static files" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/bass\/some-subfolder\/this-is-a-subfile\.html<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/bass/some-subfolder/this-is-a-subfile\.html</loc>!
     end
 
     it "correctly adds the baseurl to the collections" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/bass\/my_collection\/test\.html<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/bass/my_collection/test\.html</loc>!
     end
 
     it "correctly adds the baseurl to the pages" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/bass\/<\/loc>/
-      expect(contents).to match /<loc>http:\/\/example\.org\/bass\/some-subfolder\/this-is-a-subpage\.html<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/bass/</loc>!
+      expect(contents).to match %r!<loc>http://example\.org/bass/some-subfolder/this-is-a-subpage\.html</loc>!
     end
 
     it "correctly adds the baseurl to the posts" do
-      expect(contents).to match /<loc>http:\/\/example\.org\/bass\/2014\/03\/04\/march-the-fourth\.html<\/loc>/
-      expect(contents).to match /<loc>http:\/\/example\.org\/bass\/2014\/03\/02\/march-the-second\.html<\/loc>/
-      expect(contents).to match /<loc>http:\/\/example\.org\/bass\/2013\/12\/12\/dec-the-second\.html<\/loc>/
+      expect(contents).to match %r!<loc>http://example\.org/bass/2014/03/04/march-the-fourth\.html</loc>!
+      expect(contents).to match %r!<loc>http://example\.org/bass/2014/03/02/march-the-second\.html</loc>!
+      expect(contents).to match %r!<loc>http://example\.org/bass/2013/12/12/dec-the-second\.html</loc>!
     end
 
     it "adds baseurl to robots.txt" do
@@ -172,7 +172,7 @@ describe(Jekyll::JekyllSitemap) do
 
   context "with urls that needs URI encoding" do
     let(:config) do
-      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, { "url" => "http://ümlaut.example.org" }))
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, "url" => "http://ümlaut.example.org"))
     end
 
     it "performs URI encoding of site url" do

data/spec/test_jekyll-last-modified-at.rb

@@ -26,11 +26,11 @@ describe(Jekyll::JekyllSitemap) do
 
   context "with jekyll-last-modified-at" do
     it "correctly adds the modified time to the posts" do
-      expect(contents).to match  /<loc>http:\/\/example.org\/2015\/01\/18\/jekyll-last-modified-at.html<\/loc>\s+<lastmod>2015-01-19T07:03:38\+00:00<\/lastmod>/
+      expect(contents).to match  %r!<loc>http://example.org/2015/01/18/jekyll-last-modified-at.html</loc>\s+<lastmod>2015-01-19T07:03:38\+00:00</lastmod>!
     end
 
     it "correctly adds the modified time to the pages" do
-      expect(contents).to match  /<loc>http:\/\/example.org\/jekyll-last-modified-at\/page.html<\/loc>\s+<lastmod>2015-01-19T07:03:38\+00:00<\/lastmod>/
+      expect(contents).to match  %r!<loc>http://example.org/jekyll-last-modified-at/page.html</loc>\s+<lastmod>2015-01-19T07:03:38\+00:00</lastmod>!
     end
   end
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll-last-modified-at
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.4'
 description: 
 email: support@github.com
 executables: []
@@ -103,6 +109,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - History.markdown
@@ -168,15 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Jekyll site.