jekyll-sitemap 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c82fc264e84cf81d8517c86db2f0d9653e8f1668
-  data.tar.gz: 91a7d2942b735f336b0228207216a07103ed21ff
+  metadata.gz: 08aeee9c78b3fe0667703cae93abcd7209f782df
+  data.tar.gz: 4d3ac34c308fb62c6f4ea9349a5e4515522cb574
 SHA512:
-  metadata.gz: c27f09fdc6c694bde3dfd3b14f50704146e6f202ad5b62f1a0b0aedafbc6c7f94a174fc24ee3321451287f28ecbe6af856cac26e1634a726440b3da3a810b93c
-  data.tar.gz: a7aea97eabdc31dff65f0c45a1a321bf382d8397dfed91383bee0ee112b4689a275acd6abafbde6136cc471adeaeb37f5aa13f279a6424491c8529dd5c76b6bf
+  metadata.gz: 7f7dd3c72ce37330affc7ddb67f9ea1309198e5841cb54e9f77e11c1f65ae5af1ce091cb95f30483b9244509491320e248f69fb10b709913583d23a630c525ba
+  data.tar.gz: f6d802042235cb1d8610967944c16262365eff95197b4ad9cb41b893441122cb6eecbcdf0e5f7cd4534c5f107d36446fea9aad98d0fb45d7b22c9b06992dc2a1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+spec/dest
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.1
+- 2.0.0
+- 1.9.3
+script: "script/cibuild"

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/History.markdown

@@ -0,0 +1,47 @@
+## HEAD
+
+## 0.5.0 / 2014-06-02
+
+### Minor Enhancements
+
+  * Allow users to exclude a page/post from the sitemap (#11)
+
+## 0.4.1 / 2014-05-10
+
+### Bug Fixes
+
+  * Force sitemap layout to be `nil` (#16)
+  * Correct seconds in timestamp for static files (#24)
+
+# Development Fixes
+
+  * Upgrade to Rspec 3.0 and use `be_truthy` (#24)
+
+## 0.4.0 / 2014-05-06
+
+### Major Enhancements
+
+  * Support Jekyll 2.0 (#12)
+
+## 0.3.0 / 2014-05-05
+
+### Minor Enhancements
+
+  * Generate sitemap using html_pages (#10)
+
+### Bug Fixes
+
+  * Remove stray sitemap.xsl from template (#8)
+
+### Development Fixes
+
+  * Added travis (#6)
+  * Better timezone support (#7)
+
+## 0.2.0 / 2014-03-24
+
+  * Loosen Jekyll requirement (#4)
+
+## 0.1.0 / 2014-03-15
+
+  * Birthday!

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 GitHub, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Jekyll Sitemap Generator Plugin
+
+*Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site*
+
+[![Build Status](https://travis-ci.org/jekyll/jekyll-sitemap.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-sitemap)
+
+## Usage
+
+1. Add `gem 'jekyll-sitemap'` to your site's Gemfile
+2. Add the following to your site's `_config.yml`:
+
+```yml
+gems:
+  - jekyll-sitemap
+```
+
+## Developing locally
+
+Use `script/bootstrap` to bootstrap your local development environment.
+
+Use `script/console` to load a local IRB console with the Gem.
+
+## Testing
+
+1. `script/bootstrap`
+2. `script/cibuild`
+
+## 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.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-sitemap.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name        = "jekyll-sitemap"
+  spec.summary     = "Automatically generate a sitemap.xml for your Jekyll site."
+  spec.version     = "0.5.0"
+  spec.authors     = ["GitHub, Inc."]
+  spec.email       = "support@github.com"
+  spec.homepage    = "https://github.com/jekyll/jekyll-sitemap"
+  spec.licenses    = ["MIT"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "jekyll", "~> 2.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

data/lib/sitemap.xml

@@ -1,25 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <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">
   {% capture site_url %}{% if site.url %}{{ site.url }}{% else %}{{ site.github.url }}{% endif %}{% endcapture %}
-  {% for post in site.posts %}
+  {% for post in site.posts %}{% unless post.sitemap == false %}
   <url>
     <loc>{{ site_url }}{{ post.url }}</loc>
     <lastmod>{{ post.date | date_to_xmlschema }}</lastmod>
     <priority>0.8</priority>
   </url>
-  {% endfor %}
-  {% for post in site.html_pages %}
+  {% endunless %}{% endfor %}
+  {% for post in site.html_pages %}{% unless post.sitemap == false %}
   <url>
     <loc>{{ site_url }}{{ post.url | replace:'index.html','' }}</loc>
     <lastmod>{{ site.time | date_to_xmlschema }}</lastmod>
     <changefreq>weekly</changefreq>
     <priority>{% if post.url == "/" or post.url == "/index.html" %}1.0{% else %}0.7{% endif %}</priority>
   </url>
-  {% endfor %}
+  {% endunless %}{% endfor %}
   {% for file in site.html_files %}
   <url>
     <loc>{{ site_url }}{{ file.path }}</loc>
-    <lastmod>{{ file.modified_time | date:"%Y-%m-%dT%H:%M:%sZ" }}</lastmod>
+    <lastmod>{{ file.modified_time | date:"%Y-%m-%dT%H:%M:%SZ" }}</lastmod>
     <priority>0.6</priority>
   </url>
   {% endfor %}

data/script/bootstrap

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

data/script/cibuild

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+bundle exec rspec

data/script/console

@@ -0,0 +1,34 @@
+#! /usr/bin/env ruby
+
+def relative_to_root(path)
+  File.expand_path(path, File.dirname(File.dirname(__FILE__)))
+end
+
+require 'jekyll'
+require relative_to_root('lib/jekyll-sitemap.rb')
+require 'pry-debugger'
+
+SOURCE_DIR = relative_to_root('spec/fixtures')
+DEST_DIR   = relative_to_root('spec/dest')
+
+def source_dir(*files)
+  File.join(SOURCE_DIR, *files)
+end
+
+def dest_dir(*files)
+  File.join(DEST_DIR, *files)
+end
+
+def config(overrides = {})
+  Jekyll.configuration({
+    "source"      => source_dir,
+    "destination" => dest_dir,
+    "url"         => "http://example.org"
+  }).merge(overrides)
+end
+
+def site(configuration = config)
+  Jekyll::Site.new(configuration)
+end
+
+binding.pry

data/script/release

@@ -0,0 +1,42 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Make sure the darn thing works
+
+bundle update
+
+# Build a new gem archive.
+
+rm -rf jekyll-sitemap-*.gem
+gem build -q jekyll-sitemap.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls jekyll-sitemap-*.gem | sed 's/^jekyll-sitemap-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push jekyll-sitemap-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/spec/fixtures/_posts/2013-12-12-dec-the-second.md

@@ -0,0 +1,4 @@
+---
+---
+
+December the twelfth, actually.

data/spec/fixtures/_posts/2014-03-02-march-the-second.md

@@ -0,0 +1,4 @@
+---
+---
+
+March the second!

data/spec/fixtures/_posts/2014-03-04-march-the-fourth.md

@@ -0,0 +1,4 @@
+---
+---
+
+March the fourth!

data/spec/fixtures/_posts/2014-05-11-exclude-this-post.md

@@ -0,0 +1,5 @@
+---
+sitemap: false
+---
+
+This post should not appear in the sitemap.

data/spec/fixtures/feeds/atom.xml

@@ -0,0 +1,6 @@
+---
+---
+
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+</feed>

data/spec/fixtures/index.html

@@ -0,0 +1,4 @@
+---
+---
+
+HERE IS MY SITE I AM SO EXCITED TO BE USING GITHUB PAGES

data/spec/fixtures/some-subfolder/exclude-this-page.html

@@ -0,0 +1,5 @@
+---
+sitemap: false
+---
+
+Exclude this page

data/spec/fixtures/some-subfolder/this-is-a-subpage.html

@@ -0,0 +1,4 @@
+---
+---
+
+This is a subpage!

data/spec/jekyll-sitemap_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe(Jekyll::JekyllSitemap) do
+  let(:config) do
+    Jekyll.configuration({
+      "source"      => source_dir,
+      "destination" => dest_dir,
+      "url"         => "http://example.org"
+    })
+  end
+  let(:site)     { Jekyll::Site.new(config) }
+  let(:contents) { File.read(dest_dir("sitemap.xml")) }
+  before(:each) do
+    site.process
+  end
+
+  it "creates a sitemap.xml file" do
+    expect(File.exist?(dest_dir("sitemap.xml"))).to be_truthy
+  end
+
+  it "sets the base URL for the site as priority 1.0" do
+    expect(contents).to match /<loc>http:\/\/example\.org\/<\/loc>\s+<lastmod>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(-|\+)\d{2}:\d{2}<\/lastmod>\s+<changefreq>weekly<\/changefreq>\s+<priority>1\.0<\/priority>/
+  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>/
+  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>/
+  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>/
+  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>/
+  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>/
+  end
+
+  it "does not include posts that have set 'sitemap: false'" do
+    expect(contents).not_to match /\/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>/
+  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}Z<\/lastmod>/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'jekyll'
+require File.expand_path('../lib/jekyll-sitemap', File.dirname(__FILE__))
+
+Jekyll.logger.log_level = :error
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
+  DEST_DIR   = File.expand_path("../dest",     __FILE__)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sitemap
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-10 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,7 +17,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -28,16 +28,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,15 +52,54 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: 
 email: support@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- History.markdown
+- LICENSE.md
+- README.md
+- Rakefile
+- jekyll-sitemap.gemspec
 - lib/jekyll-sitemap.rb
 - lib/sitemap.xml
-homepage: https://github.com/github/jekyll-sitemap
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- spec/fixtures/_posts/2013-12-12-dec-the-second.md
+- spec/fixtures/_posts/2014-03-02-march-the-second.md
+- spec/fixtures/_posts/2014-03-04-march-the-fourth.md
+- spec/fixtures/_posts/2014-05-11-exclude-this-post.md
+- spec/fixtures/feeds/atom.xml
+- spec/fixtures/images/hubot.png
+- spec/fixtures/index.html
+- spec/fixtures/some-subfolder/exclude-this-page.html
+- spec/fixtures/some-subfolder/this-is-a-subfile.html
+- spec/fixtures/some-subfolder/this-is-a-subpage.html
+- spec/jekyll-sitemap_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jekyll/jekyll-sitemap
 licenses:
 - MIT
 metadata: {}
@@ -84,4 +123,16 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Jekyll site.
-test_files: []
+test_files:
+- spec/fixtures/_posts/2013-12-12-dec-the-second.md
+- spec/fixtures/_posts/2014-03-02-march-the-second.md
+- spec/fixtures/_posts/2014-03-04-march-the-fourth.md
+- spec/fixtures/_posts/2014-05-11-exclude-this-post.md
+- spec/fixtures/feeds/atom.xml
+- spec/fixtures/images/hubot.png
+- spec/fixtures/index.html
+- spec/fixtures/some-subfolder/exclude-this-page.html
+- spec/fixtures/some-subfolder/this-is-a-subfile.html
+- spec/fixtures/some-subfolder/this-is-a-subpage.html
+- spec/jekyll-sitemap_spec.rb
+- spec/spec_helper.rb