jekyll-sitemap 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c389f3b3fb31f59c71861d1db7fb3ead58b6cd55
-  data.tar.gz: 71d6f86a78f5b2f403ac9119953af38eb05bc8bf
+  metadata.gz: 545a5dae100fc813cfc730407cc0d3bf3656d008
+  data.tar.gz: 5840efbad8ffbe12ec88479e5b9ba9517055618b
 SHA512:
-  metadata.gz: 3cedbd8b869f0905b9b6cf6b8a8fe2961b4b2e7191d44cd68539c7d4742a38d75f689cc19007d8cdc548c6c19bc9b9579bdbcfc049756541f7948dee6b046fc2
-  data.tar.gz: 3d9c5ce959997df32df9ccaadd28a3be44dca64cd4c0f3f06b99589f83c0265572e6ed3af161b8ab0b0413eeaebece48f5c7311bae8e9220b25b6d849aacbfca
+  metadata.gz: 6ea2addd12b55152f253503281d60b7453969b7133cc680dffdd471aa80cde89c1782f3cb704707bddb9bd71830249d39616a7ffa4c0c574435ec0d68d456431
+  data.tar.gz: ed2f2f20b26e9445347b3c729b60096930862a33034e6314a30c0323d66a0f716eb94d164c0f518cee54a1c76e451d008815252eeafa11311bd3978000ca6735

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   jekyll: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 1.9
+  TargetRubyVersion: 2.0
   Include:
     - lib/*.rb
 

data/.travis.yml

@@ -7,15 +7,16 @@ rvm:
 - 2.2
 matrix:
   include:
-    - # GitHub Pages
-      rvm: 2.3.1
-      env: JEKYLL_VERSION=3.3.0
+  - rvm: 2.3.1
+    env: JEKYLL_VERSION=3.3.0
 env:
   matrix:
-    - JEKYLL_VERSION=3.3
+  - JEKYLL_VERSION=3.3
 branches:
   only:
-    - master
+  - master
+git:
+  depth: 1000
 install:
 - travis_retry script/bootstrap
 script: script/cibuild
@@ -26,7 +27,15 @@ notifications:
     channels:
     - irc.freenode.org#jekyll
     template:
-    - '%{repository}#%{build_number} %{message} %{build_url}'
+    - "%{repository}#%{build_number} %{message} %{build_url}"
   email:
     on_success: never
     on_failure: change
+deploy:
+  provider: rubygems
+  api_key:
+    secure: O8fGRnM6OJCqC2BlVE1BqYfq5aR19ulpiHhQwRiHbtSCh8H4rYt7FLsuOwSTtRQjhWYRRSpdRt2ilfQ6PY6Jx1UkxZq5zo9QAPQ9tKxiFTm7gBpZAiAgb06eyaMBSzyQ8qe2qccaFI6CiZhsiaGMsdKsWuYpuoPmdLPd7aDyYJs=
+  gem: jekyll-sitemap
+  on:
+    tags: true
+    repo: jekyll/jekyll-sitemap

data/History.markdown

@@ -1,3 +1,22 @@
+## 0.13.0 / 2017-01-05
+
+### Minor Enhancements
+
+  * Add sitemap.xsl if exists (#143)
+  * Add robots.txt when none exists (#146)
+  * Refactor and add sitemap to `site.pages` (#137)
+  * DRY in sitemap.xml (#136)
+
+### Documentation
+
+  * Fix #134: Rename "Issues" to "Known Issues" (#135)
+  * Fix #104: Add explanation in README for <lastmod> tag (#139)
+  * Update copyright attribution (#149)
+
+### Development Fixes
+
+  * Travis should do a deep clone (#147)
+
 ## 0.12.0 / 2016-10-06
 
 ### Minor Enhancements

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 GitHub, inc.
+Copyright (c) 2014-2017, GitHub, inc. and the jekyll-sitemap contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -22,6 +22,17 @@ those other gems if you *want* the sitemap to include the generated
 content, or *before* those other gems if you *don't want* the sitemap to
 include the generated content from the gems. (Programming is *hard*.)
 
+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).
+
+## `<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)
+2.   A personnalised date if you add the variable `last_modified_at:` with a date in the Front Matter
+3.   The creation date of your post (correspondig to the `post.date` variable)
+
 ## Exclusions
 
 If you would like to exclude specific pages/posts from the sitemap set the
@@ -42,14 +53,14 @@ Use `script/console` to load a local IRB console with the Gem.
 1. `script/bootstrap`
 2. `script/cibuild`
 
+## Known Issues
+
+1. If the `sitemap.xml` doesn't generate in the `_site` folder, ensure `_config.yml` doesn't have `safe: true`. That prevents all plugins from working.
+2. If the `sitemap.xml` doesn't generate in the `_site` folder, ensure that you don't have a sitemap generator plugin in your `_plugin` folder.
+
 ## Contributing
 
 1. Fork the project
 2. Create a descriptively named feature branch
 3. Add your feature
 4. Submit a pull request
-
-## Issues
-
-1. If the `sitemap.xml` doesn't generate in the `_site` folder, ensure `_config.yml` doesn't have `safe: true`. That prevents all plugins from working.
-2. If the `sitemap.xml` doesn't generate in the `_site` folder, ensure that you don't have a sitemap generator plugin in your `_plugin` folder.

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.12.0"
+  spec.version     = "0.13.0"
   spec.authors     = ["GitHub, Inc."]
   spec.email       = "support@github.com"
   spec.homepage    = "https://github.com/jekyll/jekyll-sitemap"

data/lib/jekyll/jekyll-sitemap.rb

@@ -8,13 +8,12 @@ module Jekyll
     # Main plugin action, called by Jekyll-core
     def generate(site)
       @site = site
-      unless sitemap_exists?
-        write
-        @site.keep_files ||= []
-        @site.keep_files << "sitemap.xml"
-      end
+      @site.pages << sitemap unless file_exists?("sitemap.xml")
+      @site.pages << robots unless file_exists?("robots.txt")
     end
 
+    private
+
     INCLUDED_EXTENSIONS = %W(
       .htm
       .html
@@ -22,46 +21,49 @@ module Jekyll
       .pdf
     ).freeze
 
+    # Matches all whitespace that follows
+    #   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+!
+
     # Array of all non-jekyll site files with an HTML extension
     def static_files
       @site.static_files.select { |file| INCLUDED_EXTENSIONS.include? file.extname }
     end
 
     # Path to sitemap.xml template file
-    def source_path
-      File.expand_path "../sitemap.xml", File.dirname(__FILE__)
+    def source_path(file = "sitemap.xml")
+      File.expand_path "../#{file}", File.dirname(__FILE__)
     end
 
     # Destination for sitemap.xml file within the site source directory
-    def destination_path
-      if @site.respond_to?(:in_dest_dir)
-        @site.in_dest_dir("sitemap.xml")
-      else
-        Jekyll.sanitized_path(@site.dest, "sitemap.xml")
-      end
+    def destination_path(file = "sitemap.xml")
+      @site.in_dest_dir(file)
     end
 
-    # copy sitemap template from source to destination
-    def write
-      FileUtils.mkdir_p File.dirname(destination_path)
-      File.open(destination_path, "w") { |f| f.write(sitemap_content) }
-    end
-
-    def sitemap_content
+    def sitemap
       site_map = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", "sitemap.xml")
-      site_map.content = File.read(source_path)
+      site_map.content = File.read(source_path).gsub(MINIFY_REGEX, "")
       site_map.data["layout"] = nil
       site_map.data["static_files"] = static_files.map(&:to_liquid)
-      site_map.render({}, @site.site_payload)
-      site_map.output.gsub(%r!\s{2,}!, "\n")
+      site_map.data["xsl"] = file_exists?("sitemap.xsl")
+      site_map
+    end
+
+    def robots
+      robots = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", "robots.txt")
+      robots.content = File.read(source_path("robots.txt"))
+      robots.data["layout"] = nil
+      robots
     end
 
-    # Checks if a sitemap already exists in the site source
-    def sitemap_exists?
+    # Checks if a file already exists in the site source
+    def file_exists?(file_path)
       if @site.respond_to?(:in_source_dir)
-        File.exist? @site.in_source_dir("sitemap.xml")
+        File.exist? @site.in_source_dir(file_path)
       else
-        File.exist? Jekyll.sanitized_path(@site.source, "sitemap.xml")
+        File.exist? Jekyll.sanitized_path(@site.source, file_path)
       end
     end
   end

data/lib/robots.txt

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

data/lib/sitemap.xml

@@ -1,41 +1,35 @@
 <?xml version="1.0" encoding="UTF-8"?>
+{% if page.xsl %}
+  <?xml-stylesheet type="text/xsl" href="{{ "/sitemap.xsl" | absolute_url }}"?>
+{% endif %}
 <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">
-  {% for post in site.posts %}{% unless post.sitemap == false %}
-  <url>
-    <loc>{{ post.url | absolute_url }}</loc>
-    <lastmod>{{ post.last_modified_at | default: post.date | date_to_xmlschema }}</lastmod>
-  </url>
-  {% endunless %}{% endfor %}
-  {% for page in site.html_pages %}{% unless page.sitemap == false %}
-  <url>
-    <loc>{{ page.url | replace:'/index.html','/' | absolute_url }}</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 or collection.label == 'posts' %}
-  {% for doc in collection.last.docs %}{% unless doc.sitemap == false %}
-  <url>
-    <loc>{{ doc.url | replace:'/index.html','/' | absolute_url }}</loc>
-    {% if doc.last_modified_at %}
-    <lastmod>{{ doc.last_modified_at | date_to_xmlschema }}</lastmod>
-    {% endif %}
-  </url>
-  {% endunless %}{% endfor %}
-  {% for doc in collection.docs %}{% unless doc.sitemap == false %}
+  {% assign collections = site.collections | where_exp:'collection','collection.output != false' %}
+  {% for collection in collections %}
+    {% assign docs = collection.docs | where_exp:'doc','doc.sitemap != false' %}
+    {% for doc in docs %}
+      <url>
+        <loc>{{ doc.url | replace:'/index.html','/' | absolute_url }}</loc>
+        {% if doc.last_modified_at or doc.date %}
+          <lastmod>{{ doc.last_modified_at | default: doc.date | date_to_xmlschema }}</lastmod>
+        {% endif %}
+      </url>
+    {% endfor %}
+  {% endfor %}
+
+  {% assign pages = site.html_pages | where_exp:'doc','doc.sitemap != false' %}
+  {% for page in pages %}
     <url>
-      <loc>{{ doc.url | replace:'/index.html','/' | absolute_url }}</loc>
-      {% if doc.last_modified_at %}
-      <lastmod>{{ doc.last_modified_at | date_to_xmlschema }}</lastmod>
+      <loc>{{ page.url | replace:'/index.html','/' | absolute_url }}</loc>
+      {% if page.last_modified_at %}
+        <lastmod>{{ page.last_modified_at | date_to_xmlschema }}</lastmod>
       {% endif %}
     </url>
-  {% endunless %}{% endfor %}
-  {% endunless %}{% endfor %}
+  {% endfor %}
+
   {% for file in page.static_files %}
-  <url>
-    <loc>{{ file.path | absolute_url }}</loc>
-    <lastmod>{{ file.modified_time | date_to_xmlschema }}</lastmod>
-  </url>
+    <url>
+      <loc>{{ file.path | absolute_url }}</loc>
+      <lastmod>{{ file.modified_time | date_to_xmlschema }}</lastmod>
+    </url>
   {% endfor %}
 </urlset>

data/spec/jekyll-sitemap_spec.rb

@@ -136,6 +136,11 @@ describe(Jekyll::JekyllSitemap) do
       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>/
     end
+
+    it "adds baseurl to robots.txt" do
+      content = File.read(dest_dir("robots.txt"))
+      expect(content).to match("Sitemap: http://example.org/bass/sitemap.xml")
+    end
   end
 
   context "with urls that needs URI encoding" do
@@ -155,5 +160,21 @@ describe(Jekyll::JekyllSitemap) do
     it "does not double-escape urls" do
       expect(contents).to_not match /%25/
     end
+
+    context "readme" do
+      let(:contents) { File.read(dest_dir("robots.txt")) }
+
+      it "has no layout" do
+        expect(contents).not_to match(/\ATHIS IS MY LAYOUT/)
+      end
+
+      it "creates a sitemap.xml file" do
+        expect(File.exist?(dest_dir("robots.txt"))).to be_truthy
+      end
+
+      it "renders liquid" do
+        expect(contents).to match("Sitemap: http://xn--mlaut-jva.example.org/sitemap.xml")
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sitemap
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -113,6 +113,7 @@ files:
 - lib/jekyll-sitemap.rb
 - lib/jekyll/jekyll-sitemap.rb
 - lib/jekyll/page_without_a_file.rb
+- lib/robots.txt
 - lib/sitemap.xml
 - script/bootstrap
 - script/cibuild
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Jekyll site.