jekyll-sitemap 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d48df23af4df6ba9fecfb131005e085b655b4482f7325fe69894c323d06fd15
-  data.tar.gz: 870ba6091d3a84ae9ef7739e6bf37ba8a5de6b18168bc6f561b238de069b0223
+  metadata.gz: fcd7dced46edc1fe61d6b0ccfd9574a07c4ea10fcf171b57cda3dfc72b078de4
+  data.tar.gz: 27a727b6359318f89161b868810cee74637685d8af0f25c2d4211856ea3391b7
 SHA512:
-  metadata.gz: ef3cffc55662703294defc8b91ce0ecd41339c261fa9dcc966a22b7ccb9925f8a378e6aaa0577ad9460f4107537474b9fbf129284858be0063a10bc7f9ed9f92
-  data.tar.gz: 552379f5a42c4bb325552133d9cb72954158c798b56f4a3c008eaad4c57d85062f22c0e02a7741da9769e379b48a8727bbac3c61028d1960dacdad8248ddade6
+  metadata.gz: 368433ab557a4d3b20dee8fd99c2f59e25777ae8ad58510e2542486154caad8717af3584ba55da7b841b84414abaadb7b97998026a8e22bee4c42208ad6a0e73
+  data.tar.gz: 7f25e64a6d1f32e51e92e9a17c4c44f333dfdb79432bebd31b25d74281a9c95d42cb2691192759e040c81b62ba5b867b2fce320599fb851b1c30acdb1e25110f

data/.gitignore

@@ -1,5 +1,6 @@
+.bundle
 *.gem
 Gemfile.lock
 spec/dest
-.bundle
 spec/fixtures/.jekyll-cache
+vendor/bundle

data/.rubocop.yml

@@ -3,3 +3,7 @@ inherit_from: .rubocop_todo.yml
 require: rubocop-jekyll
 inherit_gem:
   rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*

data/.travis.yml

@@ -3,16 +3,15 @@ cache: bundler
 rvm:
 - &latest_ruby 2.6
 - 2.4
-- 2.3
 matrix:
   include:
   # GitHub Pages
   - rvm: 2.5.3
     env:
-    - JEKYLL_VERSION="~> 3.7.4"
+    - JEKYLL_VERSION="~> 3.8.5"
     - GITHUB_PAGES=1 # Only set on one build in matrix
   - rvm: *latest_ruby
-    env: JEKYLL_VERSION=">= 4.0.0.pre.alpha1"
+    env: JEKYLL_VERSION=">= 4.0.0"
 env:
   matrix:
   - JEKYLL_VERSION="~> 3.8"

data/History.markdown

@@ -1,3 +1,13 @@
+## 1.4.0 / 2019-11-21
+
+### Minor Enhancements
+
+  * Avoid overwriting an existing robots.txt (#246)
+
+### Bug Fixes
+
+  * Simulate `last_modified_at` injection by plugin (#256)
+
 ## 1.3.1 / 2019-03-25
 
 ### Bug Fixes

data/jekyll-sitemap.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "jekyll-last-modified-at", "~> 1.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop-jekyll", "~> 0.4"

data/lib/jekyll-sitemap/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Sitemap
-    VERSION = "1.3.1"
+    VERSION = "1.4.0"
   end
 end

data/lib/jekyll/jekyll-sitemap.rb

@@ -62,11 +62,11 @@ module Jekyll
 
     # 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(file_path)
-      else
-        File.exist? Jekyll.sanitized_path(@site.source, file_path)
-      end
+      pages_and_files.any? { |p| p.url == "/#{file_path}" }
+    end
+
+    def pages_and_files
+      @pages_and_files ||= @site.pages + @site.static_files
     end
   end
 end

data/spec/jekyll-sitemap_spec.rb

@@ -195,7 +195,7 @@ describe(Jekyll::JekyllSitemap) do
         expect(contents).not_to match(%r!\ATHIS IS MY LAYOUT!)
       end
 
-      it "creates a sitemap.xml file" do
+      it "creates a robots.txt file" do
         expect(File.exist?(dest_dir("robots.txt"))).to be_truthy
       end
 
@@ -204,4 +204,53 @@ describe(Jekyll::JekyllSitemap) do
       end
     end
   end
+
+  context "with user-defined robots.txt" do
+    let(:fixture) { "/" }
+    let(:fixture_source) { robot_fixtures(fixture) }
+    let(:fixture_dest) { robot_fixtures(fixture, "_site") }
+    let(:robot_contents) { File.read(robot_fixtures(fixture, "_site", "robots.txt")).strip }
+    let(:overrides) do
+      {
+        "source"      => fixture_source,
+        "destination" => fixture_dest,
+        "url"         => "http://example.org",
+      }
+    end
+
+    before(:each) { setup_fixture(fixture) }
+    after(:each) { cleanup_fixture(fixture) }
+
+    context "as a static-file at source-root" do
+      let(:fixture) { "static-at-source-root" }
+
+      it "doesn't override the robots file" do
+        expect(robot_contents).to eql("Allow: /")
+      end
+    end
+
+    context "as a static-file in a subdir" do
+      let(:fixture) { "static-in-subdir" }
+
+      it "generates a valid robot.txt" do
+        expect(robot_contents).to eql("Sitemap: http://example.org/sitemap.xml")
+      end
+    end
+
+    context "as a page at root" do
+      let(:fixture) { "page-at-root" }
+
+      it "doesn't override the robots file" do
+        expect(robot_contents).to eql("Allow: http://example.org")
+      end
+    end
+
+    context "as a page with permalink in a subdir" do
+      let(:fixture) { "permalinked-page-in-subdir" }
+
+      it "doesn't override the robots file" do
+        expect(robot_contents).to eql("Allow: http://example.org")
+      end
+    end
+  end
 end

data/spec/robot-fixtures/page-at-root/robots.txt

@@ -0,0 +1,4 @@
+---
+---
+
+Allow: {{ site.url }}

data/spec/robot-fixtures/permalinked-page-in-subdir/assets/robots.txt

@@ -0,0 +1,5 @@
+---
+permalink: '/robots.txt'
+---
+
+Allow: {{ site.url }}

data/spec/robot-fixtures/static-at-source-root/robots.txt

@@ -0,0 +1 @@
+Allow: /

data/spec/robot-fixtures/static-in-subdir/assets/robots.txt

@@ -0,0 +1 @@
+Allow: /

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "jekyll"
+require "fileutils"
 require File.expand_path("../lib/jekyll-sitemap", __dir__)
 
 Jekyll.logger.log_level = :error
@@ -12,6 +13,8 @@ RSpec.configure do |config|
 
   SOURCE_DIR = File.expand_path("fixtures", __dir__)
   DEST_DIR   = File.expand_path("dest", __dir__)
+  ROBOT_FIXTURES = File.expand_path("robot-fixtures", __dir__)
+  ROBOT_FIXTURE_ITEMS = %w(_posts _layouts _config.yml index.html).freeze
 
   def source_dir(*files)
     File.join(SOURCE_DIR, *files)
@@ -20,4 +23,18 @@ RSpec.configure do |config|
   def dest_dir(*files)
     File.join(DEST_DIR, *files)
   end
+
+  def robot_fixtures(*subdirs)
+    File.join(ROBOT_FIXTURES, *subdirs)
+  end
+
+  def setup_fixture(directory)
+    ROBOT_FIXTURE_ITEMS.each { |item| FileUtils.cp_r(source_dir(item), robot_fixtures(directory)) }
+  end
+
+  def cleanup_fixture(directory, dest_dirname = "_site")
+    (ROBOT_FIXTURE_ITEMS + [dest_dirname]).each do |item|
+      FileUtils.remove_entry(robot_fixtures(directory, item))
+    end
+  end
 end

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "spec_helper"
-require "jekyll-last-modified-at"
 
 describe(Jekyll::JekyllSitemap) do
   let(:overrides) do
@@ -21,16 +20,31 @@ describe(Jekyll::JekyllSitemap) do
   let(:site)     { Jekyll::Site.new(config) }
   let(:contents) { File.read(dest_dir("sitemap.xml")) }
   before(:each) do
+    # simulate `last_modified_at` injection by `jekyll-last-modified-at` plugin
+    Jekyll::Hooks.register([:pages, :documents], :post_init) do |page|
+      page.data["last_modified_at"] = Time.parse("2015-01-18T00:00:00+00:00")
+    end
+
     site.process
   end
 
   context "with jekyll-last-modified-at" do
     it "correctly adds the modified time to the posts" do
-      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>!
+      expect(contents).to match(
+        %r!
+          <loc>http://example.org/2015/01/18/jekyll-last-modified-at.html</loc>\s+
+          <lastmod>2015-01-18T00:00:00\+00:00</lastmod>
+        !x
+      )
     end
 
     it "correctly adds the modified time to the pages" do
-      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>!
+      expect(contents).to match(
+        %r!
+          <loc>http://example.org/jekyll-last-modified-at/page.html</loc>\s+
+          <lastmod>2015-01-18T00:00:00\+00:00</lastmod>
+        !x
+      )
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,20 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jekyll-last-modified-at
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +147,10 @@ files:
 - spec/fixtures/static_files/html_file.html
 - spec/fixtures/static_files/test.pdf
 - spec/jekyll-sitemap_spec.rb
+- spec/robot-fixtures/page-at-root/robots.txt
+- spec/robot-fixtures/permalinked-page-in-subdir/assets/robots.txt
+- spec/robot-fixtures/static-at-source-root/robots.txt
+- spec/robot-fixtures/static-in-subdir/assets/robots.txt
 - spec/spec_helper.rb
 - spec/test_jekyll-last-modified-at.rb
 homepage: https://github.com/jekyll/jekyll-sitemap
@@ -182,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Automatically generate a sitemap.xml for your Jekyll site.
@@ -219,5 +209,9 @@ test_files:
 - spec/fixtures/static_files/html_file.html
 - spec/fixtures/static_files/test.pdf
 - spec/jekyll-sitemap_spec.rb
+- spec/robot-fixtures/page-at-root/robots.txt
+- spec/robot-fixtures/permalinked-page-in-subdir/assets/robots.txt
+- spec/robot-fixtures/static-at-source-root/robots.txt
+- spec/robot-fixtures/static-in-subdir/assets/robots.txt
 - spec/spec_helper.rb
 - spec/test_jekyll-last-modified-at.rb