jekyll-sitemap 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f288537895b8ef8244472fe563468be566d1553
-  data.tar.gz: 13d121259146c8ee408b5d1357000f1991b4cd55
+  metadata.gz: f132cc4e250a79b3f479249b8d069d1f390bfd8a
+  data.tar.gz: d6762c431548f94b50bae4b3856ad1c83b8088fd
 SHA512:
-  metadata.gz: 08b221f3b82a57229d71eeb1bbaaa73a8437de679a89170d794ba836d57766e2b5ff49b4219d61b7e3817923c702d01f607421ef098843e95de15714fd72ff66
-  data.tar.gz: 66012f77eb83fa20d36c34198a3b1b75fc34fd8ee13e1ab12ad4c2c84dbda160f8fceaf3e8af5b457578be742cfa4e26bc069df55194dcc2e0dad28fec87ab6d
+  metadata.gz: e6120fae9a6609421b111f579c5e476d3cdf08417ab6e804d12633ed4cba5ca8f13b84fbb612359107bb659472234c89d88979fa2d869dc51e4315267e5a199d
+  data.tar.gz: d68e7445917f84a6c0f16d26cb259d74fd2b8158a05754c8214d826df5e5b24eb7abc22817aa831ca7e591ba29867ebf58930b978de285f7a04da7b71277b292

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 1.9
+  Include:
+    - lib/*.rb
+
+  Exclude:
+    - script/**/*
+    - spec/**/*

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
 - 2.0
 - 2.1

data/History.markdown

@@ -1,3 +1,10 @@
+## 0.11.0 / 2016-07-08
+
+  * Add Rubocop (#100)
+  * Allow Travis to cache dependencies (#108)
+  * Properly Escape URLs (#107)
+  * Include PDF files in sitemap (#109)
+
 ## 0.10.0 / 2016-01-05
 
   * URI encode sitemap URLs (#85)
@@ -20,23 +27,16 @@
   * Call each page `page` in pages loop in `sitemap.xml` for clarity (#64)
   * Remove `changefreq` (#34)
   * Remove `priority` (#33)
-  * Don't strip 'index.html' when there is more to filename (#68)
+  * Don't strip 'index.html' when there is more to filename ## Minor Enhancements (#68)
 
 ## 0.7.0 / 2014-12-07
 
-## Minor Enhancements
-
   * Make `site.baseurl` support more robust (#59)
-  * Add `site.baseurl` to base site URL construction (#50)
-
-## Development Fixes
-
-  * Remove unnecessary spaces and escaping in README (#58)
+  * Add `site.baseurl` to base site URL construction ## Development Fixes (#50)
+  * Remove unnecessary spaces and escaping in README ## Bug Fixes (#58)
 
 ## 0.6.3 / 2014-11-11
 
-## Bug Fixes
-
   * Be backwards-compatible when `Site#in_source_dir` and `Site#in_dest_dir` don't exist (#57)
 
 ## 0.6.2 / 2014-11-08
@@ -84,10 +84,7 @@
 ### Bug Fixes
 
   * Force sitemap layout to be `nil` (#16)
-  * Correct seconds in timestamp for static files (#24)
-
-# Development Fixes
-
+  * Correct seconds in timestamp for static files # Development Fixes (#24)
   * Upgrade to Rspec 3.0 and use `be_truthy` (#24)
 
 ## 0.4.0 / 2014-05-06

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.10.0"
+  spec.version     = "0.11.0"
   spec.authors     = ["GitHub, Inc."]
   spec.email       = "support@github.com"
   spec.homepage    = "https://github.com/jekyll/jekyll-sitemap"
@@ -14,9 +14,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "addressable", "~>2.4.0"
+
   spec.add_development_dependency "jekyll", ">= 2.0"
   spec.add_development_dependency "jekyll-last-modified-at", "0.3.4"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rubocop"
 end

data/lib/jekyll-sitemap.rb

@@ -1,74 +1,3 @@
-require 'fileutils'
-
-module Jekyll
-  class PageWithoutAFile < Page
-    def read_yaml(*)
-      @data ||= {}
-    end
-  end
-
-  class JekyllSitemap < Jekyll::Generator
-    safe true
-    priority :lowest
-
-    # Main plugin action, called by Jekyll-core
-    def generate(site)
-      @site = site
-      @site.config["time"]         = Time.new
-      @site.config["html_files"]   = html_files.map(&:to_liquid)
-      unless sitemap_exists?
-        write
-        @site.keep_files ||= []
-        @site.keep_files << "sitemap.xml"
-      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| HTML_EXTENSIONS.include? file.extname }
-    end
-
-    # Path to sitemap.xml template file
-    def source_path
-      File.expand_path "sitemap.xml", 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
-    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
-      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({}, @site.site_payload)
-      site_map.output.gsub(/\s{2,}/, "\n")
-    end
-
-    # Checks if a sitemap already exists in the site source
-    def sitemap_exists?
-      if @site.respond_to?(:in_source_dir)
-        File.exists? @site.in_source_dir("sitemap.xml")
-      else
-        File.exists? Jekyll.sanitized_path(@site.source, "sitemap.xml")
-      end
-    end
-  end
-end
+require 'jekyll/sitemap_filters'
+require 'jekyll/page_without_a_file'
+require 'jekyll/jekyll-sitemap'

data/lib/jekyll/jekyll-sitemap.rb

@@ -0,0 +1,69 @@
+require 'fileutils'
+
+module Jekyll
+  class JekyllSitemap < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll-core
+    def generate(site)
+      @site = site
+      @site.config["time"] = Time.new
+      unless sitemap_exists?
+        write
+        @site.keep_files ||= []
+        @site.keep_files << "sitemap.xml"
+      end
+    end
+
+    INCLUDED_EXTENSIONS = %W(
+      .htm
+      .html
+      .xhtml
+      .pdf
+    ).freeze
+
+    # 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__)
+    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
+    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
+      site_map = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", "sitemap.xml")
+      site_map.content = File.read(source_path)
+      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(/\s{2,}/, "\n")
+    end
+
+    # Checks if a sitemap already exists in the site source
+    def sitemap_exists?
+      if @site.respond_to?(:in_source_dir)
+        File.exist? @site.in_source_dir("sitemap.xml")
+      else
+        File.exist? Jekyll.sanitized_path(@site.source, "sitemap.xml")
+      end
+    end
+  end
+end

data/lib/jekyll/page_without_a_file.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  class PageWithoutAFile < Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/lib/jekyll/sitemap_filters.rb

@@ -0,0 +1,10 @@
+require 'addressable/uri'
+
+module Jekyll
+  module SitemapFilters
+    def normalize_url(input)
+      Addressable::URI.parse(input).normalize.to_s
+    end
+  end
+end
+Liquid::Template.register_filter(Jekyll::SitemapFilters)

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 | uri_escape }}</loc>
+    <loc>{{ post.url | prepend: site_url | normalize_url }}</loc>
     {% if post.last_modified_at %}
     <lastmod>{{ post.last_modified_at | date_to_xmlschema }}</lastmod>
     {% else %}
@@ -13,7 +13,7 @@
   {% endunless %}{% endfor %}
   {% for page in site.html_pages %}{% unless page.sitemap == false %}
   <url>
-    <loc>{{ page.url | replace:'/index.html','/' | prepend: site_url | uri_escape }}</loc>
+    <loc>{{ page.url | replace:'/index.html','/' | prepend: site_url | normalize_url }}</loc>
     {% if page.last_modified_at %}
     <lastmod>{{ page.last_modified_at | date_to_xmlschema }}</lastmod>
     {% endif %}
@@ -22,7 +22,7 @@
   {% 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 | uri_escape }}</loc>
+    <loc>{{ doc.url | replace:'/index.html','/' | prepend: site_url | normalize_url }}</loc>
     {% if doc.last_modified_at %}
     <lastmod>{{ doc.last_modified_at | date_to_xmlschema }}</lastmod>
     {% endif %}
@@ -30,16 +30,16 @@
   {% endunless %}{% endfor %}
   {% for doc in collection.docs %}{% unless doc.sitemap == false %}
     <url>
-      <loc>{{ doc.url | replace:'/index.html','/' | prepend: site_url | uri_escape }}</loc>
+      <loc>{{ doc.url | replace:'/index.html','/' | prepend: site_url | normalize_url }}</loc>
       {% if doc.last_modified_at %}
       <lastmod>{{ doc.last_modified_at | date_to_xmlschema }}</lastmod>
       {% endif %}
     </url>
   {% endunless %}{% endfor %}
   {% endunless %}{% endfor %}
-  {% for file in site.html_files %}
+  {% for file in page.static_files %}
   <url>
-    <loc>{{ file.path | prepend: site_url | uri_escape }}</loc>
+    <loc>{{ file.path | prepend: site_url | normalize_url }}</loc>
     <lastmod>{{ file.modified_time | date_to_xmlschema }}</lastmod>
   </url>
   {% endfor %}

data/script/cibuild

@@ -3,3 +3,6 @@ set -e
 
 bundle exec rspec
 bundle exec rspec spec/test_jekyll-last-modified-at.rb
+if [ "$JEKYLL_VERSION" = "3.0" ]; then
+  bundle exec rubocop -S -D
+fi

data/spec/fixtures/_posts/2016-04-01-/351/224/231/350/257/257.html

@@ -0,0 +1,2 @@
+---
+---

data/spec/fixtures/_posts/2016-04-02-/351/224/231/350/257/257.html

@@ -0,0 +1,3 @@
+---
+permalink: "/2016/04/02/错误.html"
+---

data/spec/fixtures/_posts/2016-04-03-/351/224/231/350/257/257.html

@@ -0,0 +1,3 @@
+---
+permalink: "/2016/04/03/%E9%94%99%E8%AF%AF.html"
+---

data/spec/jekyll-sitemap_spec.rb

@@ -93,6 +93,10 @@ describe(Jekyll::JekyllSitemap) do
     expect(contents).to match /\/some-subfolder\/htm\.htm/
   end
 
+  it "does include assets or any static files with .pdf extension" do
+    expect(contents).to match %r!/static_files/test.pdf!
+  end
+
   it "does not include posts that have set 'sitemap: false'" do
     expect(contents).not_to match /\/exclude-this-post\.html<\/loc>/
   end
@@ -106,7 +110,7 @@ describe(Jekyll::JekyllSitemap) do
   end
 
   it "includes the correct number of items" do
-    expect(contents.scan(/(?=<url>)/).count).to eql 15
+    expect(contents.scan(/(?=<url>)/).count).to eql 19
   end
 
   context "with a baseurl" do
@@ -134,18 +138,21 @@ describe(Jekyll::JekyllSitemap) do
     end
   end
 
-  context "with site url that needs URI encoding" do
+  context "with urls that needs URI encoding" do
     let(:config) do
-      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, {"url" => "http://has ümlaut.org"}))
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, {"url" => "http://ümlaut.example.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>/
+      expect(contents).to match %r!<loc>http://xn--mlaut-jva.example.org/</loc>!
+      expect(contents).to match %r!<loc>http://xn--mlaut-jva.example.org/some-subfolder/this-is-a-subpage.html</loc>!
+      expect(contents).to match %r!<loc>http://xn--mlaut-jva.example.org/2014/03/04/march-the-fourth.html</loc>!
+      expect(contents).to match %r!<loc>http://xn--mlaut-jva.example.org/2016/04/01/%E9%94%99%E8%AF%AF.html</loc>!
+      expect(contents).to match %r!<loc>http://xn--mlaut-jva.example.org/2016/04/02/%E9%94%99%E8%AF%AF.html</loc>!
+      expect(contents).to match %r!<loc>http://xn--mlaut-jva.example.org/2016/04/03/%E9%94%99%E8%AF%AF.html</loc>!
     end
 
-    it "does not double-escape site url" do
+    it "does not double-escape urls" do
       expect(contents).to_not match /%25/
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sitemap
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: support@github.com
 executables: []
@@ -88,6 +116,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - History.markdown
@@ -96,6 +125,9 @@ files:
 - Rakefile
 - jekyll-sitemap.gemspec
 - lib/jekyll-sitemap.rb
+- lib/jekyll/jekyll-sitemap.rb
+- lib/jekyll/page_without_a_file.rb
+- lib/jekyll/sitemap_filters.rb
 - lib/sitemap.xml
 - script/bootstrap
 - script/cibuild
@@ -113,6 +145,9 @@ files:
 - spec/fixtures/_posts/2014-03-04-march-the-fourth.md
 - spec/fixtures/_posts/2014-05-11-exclude-this-post.md
 - spec/fixtures/_posts/2015-01-18-jekyll-last-modified-at.md
+- spec/fixtures/_posts/2016-04-01-错误.html
+- spec/fixtures/_posts/2016-04-02-错误.html
+- spec/fixtures/_posts/2016-04-03-错误.html
 - spec/fixtures/feeds/atom.xml
 - spec/fixtures/images/hubot.png
 - spec/fixtures/index.html
@@ -123,6 +158,7 @@ files:
 - 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/fixtures/static_files/test.pdf
 - spec/jekyll-sitemap_spec.rb
 - spec/spec_helper.rb
 - spec/test_jekyll-last-modified-at.rb
@@ -146,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Jekyll site.
@@ -163,6 +199,9 @@ test_files:
 - spec/fixtures/_posts/2014-03-04-march-the-fourth.md
 - spec/fixtures/_posts/2014-05-11-exclude-this-post.md
 - spec/fixtures/_posts/2015-01-18-jekyll-last-modified-at.md
+- spec/fixtures/_posts/2016-04-01-错误.html
+- spec/fixtures/_posts/2016-04-02-错误.html
+- spec/fixtures/_posts/2016-04-03-错误.html
 - spec/fixtures/feeds/atom.xml
 - spec/fixtures/images/hubot.png
 - spec/fixtures/index.html
@@ -173,6 +212,7 @@ test_files:
 - 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/fixtures/static_files/test.pdf
 - spec/jekyll-sitemap_spec.rb
 - spec/spec_helper.rb
 - spec/test_jekyll-last-modified-at.rb