jekyll-sitemap 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97d257da0dc97c587c0e9c08b979835bb933f12f
-  data.tar.gz: 0a9f1d08dd96afd69e372f2230e812e81f34c1a9
+  metadata.gz: 4f288537895b8ef8244472fe563468be566d1553
+  data.tar.gz: 13d121259146c8ee408b5d1357000f1991b4cd55
 SHA512:
-  metadata.gz: 6d3a4d6e03e2536ef04b33794def33fee2eb870f7025855f2f2f74a3561788a97396d37a612a9d53622d7bb02a4d9f97c1fac2b4d908e74c64b83fba5df3f477
-  data.tar.gz: 529d0c282a5d0f5f1edb9c0f66ef356735b2e3e926b9e01266683944c2ca23358a92b93f734b60acd03d55eb4af5982598424e3228e41053dcd6a2909e4d03fc
+  metadata.gz: 08b221f3b82a57229d71eeb1bbaaa73a8437de679a89170d794ba836d57766e2b5ff49b4219d61b7e3817923c702d01f607421ef098843e95de15714fd72ff66
+  data.tar.gz: 66012f77eb83fa20d36c34198a3b1b75fc34fd8ee13e1ab12ad4c2c84dbda160f8fceaf3e8af5b457578be742cfa4e26bc069df55194dcc2e0dad28fec87ab6d

data/.travis.yml

@@ -1,23 +1,34 @@
-language: ruby
-before_script: bundle update
-script: "script/cibuild"
 sudo: false
-cache: bundler
-
+language: ruby
+rvm:
+- 2.0
+- 2.1
+- 2.2
 matrix:
   include:
     - # GitHub Pages
       rvm: 2.1.1
-      env: GH_PAGES=true
-    - # Ruby 1.9
-      rvm: 1.9
-      env: JEKYLL_VERSION=2.0
-
-rvm:
-  - 2.2
-  - 2.1
-  - 2.0
+      env: JEKYLL_VERSION=2.4.0
+    - rvm: 1.9.3
+      env: JEKYLL_VERSION=2.5
 env:
-  - ""
-  - JEKYLL_VERSION=3.0.0.beta8
-  - JEKYLL_VERSION=2.0
+  matrix:
+    - JEKYLL_VERSION=2.5
+    - JEKYLL_VERSION=3.0
+branches:
+  only:
+    - master
+install:
+- travis_retry script/bootstrap
+script: script/cibuild
+notifications:
+  irc:
+    on_success: change
+    on_failure: change
+    channels:
+    - irc.freenode.org#jekyll
+    template:
+    - '%{repository}#%{build_number} %{message} %{build_url}'
+  email:
+    on_success: never
+    on_failure: change

data/Gemfile

@@ -1,8 +1,6 @@
 source "https://rubygems.org"
 gemspec
 
-if ENV["GH_PAGES"]
-  gem "github-pages"
-elsif ENV["JEKYLL_VERSION"]
+if ENV["JEKYLL_VERSION"]
   gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
 end

data/History.markdown

@@ -1,3 +1,11 @@
+## 0.10.0 / 2016-01-05
+
+  * URI encode sitemap URLs (#85)
+  * Do not include 'posts' collection twice (#92)
+  * Fix GitHub Pages tests to test just the Jekyll version (#87)
+  * Allow HTML files to end with `.xhtml` or `.htm` (#93)
+  * Simplify whitespace regex for stripping whitespace (#96)
+
 ## 0.9.0 / 2015-09-21
 
   * Test against Jekyll 2, 3, and the GitHub Pages version. (#83)

data/jekyll-sitemap.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |spec|
   spec.name        = "jekyll-sitemap"
   spec.summary     = "Automatically generate a sitemap.xml for your Jekyll site."
-  spec.version     = "0.9.0"
+  spec.version     = "0.10.0"
   spec.authors     = ["GitHub, Inc."]
   spec.email       = "support@github.com"
   spec.homepage    = "https://github.com/jekyll/jekyll-sitemap"

data/lib/jekyll-sitemap.rb

@@ -23,9 +23,15 @@ module Jekyll
       end
     end
 
+    HTML_EXTENSIONS = %W(
+      .html
+      .xhtml
+      .htm
+    )
+
     # Array of all non-jekyll site files with an HTML extension
     def html_files
-      @site.static_files.select { |file| File.extname(file.relative_path) == ".html" }
+      @site.static_files.select { |file| HTML_EXTENSIONS.include? file.extname }
     end
 
     # Path to sitemap.xml template file
@@ -52,8 +58,8 @@ module Jekyll
       site_map = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", "sitemap.xml")
       site_map.content = File.read(source_path)
       site_map.data["layout"] = nil
-      site_map.render(Hash.new, @site.site_payload)
-      site_map.output.gsub(/\s*\n+/, "\n")
+      site_map.render({}, @site.site_payload)
+      site_map.output.gsub(/\s{2,}/, "\n")
     end
 
     # Checks if a sitemap already exists in the site source

data/lib/sitemap.xml

@@ -3,7 +3,7 @@
   {% capture site_url %}{% if site.url %}{{ site.url | append: site.baseurl }}{% else %}{{ site.github.url }}{% endif %}{% endcapture %}
   {% for post in site.posts %}{% unless post.sitemap == false %}
   <url>
-    <loc>{{ post.url | prepend: site_url }}</loc>
+    <loc>{{ post.url | prepend: site_url | uri_escape }}</loc>
     {% if post.last_modified_at %}
     <lastmod>{{ post.last_modified_at | date_to_xmlschema }}</lastmod>
     {% else %}
@@ -13,16 +13,16 @@
   {% endunless %}{% endfor %}
   {% for page in site.html_pages %}{% unless page.sitemap == false %}
   <url>
-    <loc>{{ page.url | replace:'/index.html','/' | prepend: site_url }}</loc>
+    <loc>{{ page.url | replace:'/index.html','/' | prepend: site_url | uri_escape }}</loc>
     {% if page.last_modified_at %}
     <lastmod>{{ page.last_modified_at | date_to_xmlschema }}</lastmod>
     {% endif %}
   </url>
   {% endunless %}{% endfor %}
-  {% for collection in site.collections %}{% unless collection.last.output == false or collection.output == false %}
+  {% for collection in site.collections %}{% unless collection.last.output == false or collection.output == false or collection.label == 'posts' %}
   {% for doc in collection.last.docs %}{% unless doc.sitemap == false %}
   <url>
-    <loc>{{ doc.url | replace:'/index.html','/' | prepend: site_url }}</loc>
+    <loc>{{ doc.url | replace:'/index.html','/' | prepend: site_url | uri_escape }}</loc>
     {% if doc.last_modified_at %}
     <lastmod>{{ doc.last_modified_at | date_to_xmlschema }}</lastmod>
     {% endif %}
@@ -30,7 +30,7 @@
   {% endunless %}{% endfor %}
   {% for doc in collection.docs %}{% unless doc.sitemap == false %}
     <url>
-      <loc>{{ doc.url | replace:'/index.html','/' | prepend: site_url }}</loc>
+      <loc>{{ doc.url | replace:'/index.html','/' | prepend: site_url | uri_escape }}</loc>
       {% if doc.last_modified_at %}
       <lastmod>{{ doc.last_modified_at | date_to_xmlschema }}</lastmod>
       {% endif %}
@@ -39,7 +39,7 @@
   {% endunless %}{% endfor %}
   {% for file in site.html_files %}
   <url>
-    <loc>{{ file.path | prepend: site_url }}</loc>
+    <loc>{{ file.path | prepend: site_url | uri_escape }}</loc>
     <lastmod>{{ file.modified_time | date_to_xmlschema }}</lastmod>
   </url>
   {% endfor %}

data/script/bootstrap

@@ -1,3 +1,3 @@
-#! /bin/bash
+#!/bin/sh
 
 bundle install

data/script/cibuild

@@ -1,4 +1,4 @@
-#! /bin/bash
+#!/bin/sh
 set -e
 
 bundle exec rspec

data/spec/fixtures/_my_collection/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/spec/fixtures/some-subfolder/htm.htm

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

data/spec/fixtures/some-subfolder/xhtml.xhtml

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

data/spec/jekyll-sitemap_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'spec_helper'
 
 describe(Jekyll::JekyllSitemap) do
@@ -65,6 +67,10 @@ describe(Jekyll::JekyllSitemap) do
     it "doesn't remove filename for non-directory custom permalinks" do
       expect(contents).to match /<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>/
+    end
   end
 
   it "generates the correct date for each of the posts" do
@@ -82,6 +88,11 @@ describe(Jekyll::JekyllSitemap) do
     expect(contents).not_to match /<loc>http:\/\/example\.org\/feeds\/atom\.xml<\/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/
+  end
+
   it "does not include posts that have set 'sitemap: false'" do
     expect(contents).not_to match /\/exclude-this-post\.html<\/loc>/
   end
@@ -94,6 +105,10 @@ describe(Jekyll::JekyllSitemap) 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>/
   end
 
+  it "includes the correct number of items" do
+    expect(contents.scan(/(?=<url>)/).count).to eql 15
+  end
+
   context "with a baseurl" do
     let(:config) do
       Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, {"baseurl" => "/bass"}))
@@ -118,4 +133,20 @@ describe(Jekyll::JekyllSitemap) do
       expect(contents).to match /<loc>http:\/\/example\.org\/bass\/2013\/12\/12\/dec-the-second\.html<\/loc>/
     end
   end
+
+  context "with site url that needs URI encoding" do
+    let(:config) do
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, {"url" => "http://has ümlaut.org"}))
+    end
+
+    it "performs URI encoding of site url" do
+      expect(contents).to match /<loc>http:\/\/has%20%C3%BCmlaut\.org\/<\/loc>/
+      expect(contents).to match /<loc>http:\/\/has%20%C3%BCmlaut\.org\/some-subfolder\/this-is-a-subpage\.html<\/loc>/
+      expect(contents).to match /<loc>http:\/\/has%20%C3%BCmlaut\.org\/2014\/03\/04\/march-the-fourth\.html<\/loc>/
+    end
+
+    it "does not double-escape site url" do
+      expect(contents).to_not match /%25/
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sitemap
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -106,6 +106,7 @@ files:
 - spec/fixtures/_my_collection/custom_permalink.md
 - spec/fixtures/_my_collection/custom_permalink_2.md
 - spec/fixtures/_my_collection/test.html
+- spec/fixtures/_my_collection/this-has-non-standard-chars.md
 - spec/fixtures/_other_things/test2.html
 - spec/fixtures/_posts/2013-12-12-dec-the-second.md
 - spec/fixtures/_posts/2014-03-02-march-the-second.md
@@ -117,9 +118,11 @@ files:
 - spec/fixtures/index.html
 - spec/fixtures/jekyll-last-modified-at/page.html
 - spec/fixtures/some-subfolder/exclude-this-page.html
+- spec/fixtures/some-subfolder/htm.htm
 - spec/fixtures/some-subfolder/test_index.html
 - spec/fixtures/some-subfolder/this-is-a-subfile.html
 - spec/fixtures/some-subfolder/this-is-a-subpage.html
+- spec/fixtures/some-subfolder/xhtml.xhtml
 - spec/jekyll-sitemap_spec.rb
 - spec/spec_helper.rb
 - spec/test_jekyll-last-modified-at.rb
@@ -143,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Jekyll site.
@@ -153,6 +156,7 @@ test_files:
 - spec/fixtures/_my_collection/custom_permalink.md
 - spec/fixtures/_my_collection/custom_permalink_2.md
 - spec/fixtures/_my_collection/test.html
+- spec/fixtures/_my_collection/this-has-non-standard-chars.md
 - spec/fixtures/_other_things/test2.html
 - spec/fixtures/_posts/2013-12-12-dec-the-second.md
 - spec/fixtures/_posts/2014-03-02-march-the-second.md
@@ -164,9 +168,11 @@ test_files:
 - spec/fixtures/index.html
 - spec/fixtures/jekyll-last-modified-at/page.html
 - spec/fixtures/some-subfolder/exclude-this-page.html
+- spec/fixtures/some-subfolder/htm.htm
 - spec/fixtures/some-subfolder/test_index.html
 - spec/fixtures/some-subfolder/this-is-a-subfile.html
 - spec/fixtures/some-subfolder/this-is-a-subpage.html
+- spec/fixtures/some-subfolder/xhtml.xhtml
 - spec/jekyll-sitemap_spec.rb
 - spec/spec_helper.rb
 - spec/test_jekyll-last-modified-at.rb