jekyll-redirect-from 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 75b76400cfc3098e9338f6c51cc5f0d333b9854c
-  data.tar.gz: 28c269f5b8c224cedf1a1a101af6fe371b3e1b73
+SHA256:
+  metadata.gz: 73140a57a234f6232115e33527adf1c1990047e283c7c7da89903e5f7e6c69f0
+  data.tar.gz: a8fefa172d07d08585d4b588f92387fc7619b4c44c175219a0586bf28f9d33a7
 SHA512:
-  metadata.gz: 9597899e7bf67614caa8ccd37fab0bbb5c1d49aa0a3e82b2ac33743c1fbc38a87df9bde4072d1a351b93ca9bbae52724af46d18d287f73b715c8f057225e3525
-  data.tar.gz: 014a1cbb51cbc1ff7e26d1f3d30eec8b8c806277a1e81bd1bd1e8f4db1886fa5be4903a0c4b1f873495f1b028ded807fe5aa7b1a5f2052fd6b21353c69ea72e1
+  metadata.gz: d78e9d907d33605e3975096ece1d8175a1fd4a68ee4cf637ea4b6f304e62e41aaeb720f2b3bfe208fcfcdcfaa7c2496fa2a6c3addb00afc5d4184c8767588fae
+  data.tar.gz: 13a2e320e9ab868e8949eec8fc3da74a328a0d276a1e2312a7ad0026430f861ebc4a7f9338031fb85a881ee5c145432a73539608f21de6075b77ed0c29494fcf

data/.rubocop.yml

@@ -2,6 +2,7 @@ inherit_gem:
   jekyll: .rubocop.yml
 
 AllCops:
+  TargetRubyVersion: 2.1
   Exclude:
     - vendor/**/*
 

data/.travis.yml

@@ -7,14 +7,11 @@ cache: bundler
 matrix:
   include:
     - # GitHub Pages
-      rvm: 2.1.1
+      rvm: 2.4.0
       env: GH_PAGES=true
-  allow_failures:
-    - env: GH_PAGES=true # Jekyll 2.4 will fail tests
-  fast_finish: true
 
 rvm:
-  - 2.3.0
+  - 2.4
+  - 2.3
   - 2.2
   - 2.1
-  - 2.0

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 gemspec
 
 if ENV["GH_PAGES"]

data/History.markdown

@@ -1,5 +1,29 @@
 ## HEAD
 
+  * Test against same version of Ruby that GitHub Pages uses (#132)
+
+### Development Fixes
+
+  * Rubocop (#141)
+  * Fix tests for jekyll 3.5.x (#160)
+  * Rubocop: autocorrect (#165)
+
+### Minor Enhancements
+
+  * HTML encode ellipsis (#142)
+  * Added no-index to template (#152)
+  * Define path with __dir__ (#161)
+
+### Major Enhancements
+
+  * Create redirects.json file (#147)
+
+### Documentation
+
+  * Update README.md (#167)
+
+## 0.12.1 / 2017-01-12
+
 ### Development Fixes
 
   * Stop testing Ruby 1.9 (#133)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Parker Moore
+Copyright (c) 2017 Parker Moore
 
 MIT License
 

data/README.md

@@ -34,10 +34,12 @@ Or install it yourself as:
 Once it's installed into your evironment, add it to your `_config.yml`:
 
 ```yaml
-gems:
+plugins:
   - jekyll-redirect-from
 ```
 
+💡 If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
+
 If you're using Jekyll in `safe` mode to mimic GitHub Pages, make sure to
 add jekyll-redirect-from to your whitelist:
 

data/Rakefile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/jekyll-redirect-from.gemspec

@@ -1,28 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll-redirect-from/version'
+require "jekyll-redirect-from/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-redirect-from"
   spec.version       = JekyllRedirectFrom::VERSION
   spec.authors       = ["Parker Moore"]
   spec.email         = ["parkrmoore@gmail.com"]
-  spec.description   = %q{Seamlessly specify multiple redirection URLs for your pages and posts}
-  spec.summary       = %q{Seamlessly specify multiple redirection URLs for your pages and posts}
+  spec.summary       = "Seamlessly specify multiple redirection URLs " \
+                       "for your pages and posts"
   spec.homepage      = "https://github.com/jekyll/jekyll-redirect-from"
   spec.license       = "MIT"
 
+  # rubocop:disable Style/SpecialGlobalVars
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  # rubocop:enable Style/SpecialGlobalVars
+
+  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_runtime_dependency "jekyll", "~> 3.3"
-
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "jekyll-sitemap", "~> 0.8.1"
-  spec.add_development_dependency "rubocop", "~> 0.43"
+  spec.add_development_dependency "jekyll-sitemap", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rubocop", "~> 0.51"
 end

data/lib/jekyll-redirect-from.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll"
 require "jekyll-redirect-from/version"
 require "jekyll-redirect-from/generator"
@@ -6,10 +8,11 @@ module JekyllRedirectFrom
   # Jekyll classes which should be redirectable
   CLASSES = [Jekyll::Page, Jekyll::Document].freeze
 
-  autoload :Context,      "jekyll-redirect-from/context"
-  autoload :RedirectPage, "jekyll-redirect-from/redirect_page"
-  autoload :Redirectable, "jekyll-redirect-from/redirectable"
-  autoload :Layout,       "jekyll-redirect-from/layout"
+  autoload :Context,          "jekyll-redirect-from/context"
+  autoload :RedirectPage,     "jekyll-redirect-from/redirect_page"
+  autoload :Redirectable,     "jekyll-redirect-from/redirectable"
+  autoload :Layout,           "jekyll-redirect-from/layout"
+  autoload :PageWithoutAFile, "jekyll-redirect-from/page_without_a_file"
 end
 
 JekyllRedirectFrom::CLASSES.each do |klass|

data/lib/jekyll-redirect-from/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllRedirectFrom
   # Stubbed LiquidContext to support relative_url and absolute_url helpers
   class Context

data/lib/jekyll-redirect-from/generator.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module JekyllRedirectFrom
   class Generator < Jekyll::Generator
     safe true
-    attr_reader :site
+    attr_reader :site, :redirects
 
     def generate(site)
       @site = site
+      @redirects = {}
 
       # Inject our layout, unless the user has already specified a redirect layout'
       unless site.layouts.keys.any? { |name| name == "redirect" }
@@ -17,6 +20,8 @@ module JekyllRedirectFrom
         generate_redirect_from(doc)
         generate_redirect_to(doc)
       end
+
+      generate_redirects_json
     end
 
     private
@@ -24,15 +29,26 @@ module JekyllRedirectFrom
     # For every `redirect_from` entry, generate a redirect page
     def generate_redirect_from(doc)
       doc.redirect_from.each do |path|
-        doc.site.pages << RedirectPage.redirect_from(doc, path)
+        page = RedirectPage.redirect_from(doc, path)
+        doc.site.pages << page
+        redirects[page.redirect_from] = page.redirect_to
       end
     end
 
     def generate_redirect_to(doc)
       return unless doc.redirect_to
-      redirect_page = RedirectPage.redirect_to(doc, doc.redirect_to)
-      doc.data.merge!(redirect_page.data)
-      doc.content = doc.output = redirect_page.output
+      page = RedirectPage.redirect_to(doc, doc.redirect_to)
+      doc.data.merge!(page.data)
+      doc.content = doc.output = page.output
+      redirects[page.redirect_from] = page.redirect_to
+    end
+
+    def generate_redirects_json
+      return if File.exist? site.in_source_dir("redirects.json")
+      page = PageWithoutAFile.new(site, "", "", "redirects.json")
+      page.content = redirects.to_json
+      page.data["layout"] = nil
+      site.pages << page
     end
   end
 end

data/lib/jekyll-redirect-from/layout.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module JekyllRedirectFrom
   # A stubbed layout for our default redirect template
   # We cannot use the standard Layout class because of site.in_source_dir
   class Layout < Jekyll::Layout
     def initialize(site)
       @site = site
-      @base = File.dirname(__FILE__)
+      @base = __dir__
       @name = "redirect.html"
       @path = File.expand_path(@name, @base)
       @relative_path = "_layouts/redirect.html"

data/lib/jekyll-redirect-from/page_without_a_file.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JekyllRedirectFrom
+  class PageWithoutAFile < Jekyll::Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/lib/jekyll-redirect-from/redirect.html

@@ -1,10 +1,11 @@
 <!DOCTYPE html>
 <html lang="en-US">
   <meta charset="utf-8">
-  <title>Redirecting…</title>
+  <title>Redirecting&hellip;</title>
   <link rel="canonical" href="{{ page.redirect.to }}">
   <meta http-equiv="refresh" content="0; url={{ page.redirect.to }}">
-  <h1>Redirecting…</h1>
+  <meta name="robots" content="noindex">
+  <h1>Redirecting&hellip;</h1>
   <a href="{{ page.redirect.to }}">Click here if you are not redirected.</a>
   <script>location="{{ page.redirect.to }}"</script>
 </html>

data/lib/jekyll-redirect-from/redirect_page.rb

@@ -1,4 +1,5 @@
-# Encoding: utf-8
+# frozen_string_literal: true
+
 module JekyllRedirectFrom
   # Specialty page which implements the redirect path logic
   class RedirectPage < Jekyll::Page
@@ -7,7 +8,7 @@ module JekyllRedirectFrom
 
     DEFAULT_DATA = {
       "sitemap" => false,
-      "layout"  => "redirect"
+      "layout"  => "redirect",
     }.freeze
 
     # Creates a new RedirectPage instance from a source path and redirect path
@@ -43,15 +44,24 @@ module JekyllRedirectFrom
     # to   - the relative path or absolute URL to the redirect target
     def set_paths(from, to)
       @context ||= context
+      from = ensure_leading_slash(from)
       data.merge!({
         "permalink" => from,
         "redirect"  => {
           "from" => from,
-          "to"   => to =~ %r!^https?://! ? to : absolute_url(to)
-        }
+          "to"   => to =~ %r!^https?://! ? to : absolute_url(to),
+        },
       })
     end
 
+    def redirect_from
+      data["redirect"]["from"] if data["redirect"]
+    end
+
+    def redirect_to
+      data["redirect"]["to"] if data["redirect"]
+    end
+
     private
 
     def context

data/lib/jekyll-redirect-from/redirectable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllRedirectFrom
   # Module which can be mixed in to documents (and pages) to provide
   # redirect_to and redirect_from helpers

data/lib/jekyll-redirect-from/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllRedirectFrom
-  VERSION = "0.12.1".freeze
+  VERSION = "0.13.0".freeze
 end

data/script/bootstrap

@@ -1,3 +1,4 @@
 #! /bin/bash
+set -e
 
-bundle install -j8
+bundle install -j8 || bundle install

data/script/cibuild

@@ -1,6 +1,6 @@
 #! /bin/bash
 set -e
 
-bundle exec rake spec
-bundle exec rubocop -S -D
-gem build jekyll-redirect-from.gemspec
+script/test
+script/fmt
+bundle exec rake build

data/script/fmt

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+echo "Rubocop $(bundle exec rubocop --version)"
+bundle exec rubocop -D -E $@
+success=$?
+if ((success != 0)); then
+   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
+fi
+exit $success

data/script/release

@@ -1,3 +1,4 @@
 #! /bin/bash
 
+script/cibuild
 bundle exec rake release

data/spec/integrations_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe "JekyllRedirectFrom integration tests" do
   before { site.process }
   let(:relative_path) { "" }

data/spec/jekyll_redirect_from/context_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe JekyllRedirectFrom::Context do
   subject { described_class.new(site) }
 

data/spec/jekyll_redirect_from/generator_spec.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe JekyllRedirectFrom::Generator do
   before(:each) do
     site.read
     site.generate
     site.render
+    site.write
   end
 
   context "layouts" do
@@ -84,4 +87,63 @@ RSpec.describe JekyllRedirectFrom::Generator do
       end
     end
   end
+
+  context "redirects.json" do
+    let(:path) { dest_dir("redirects.json") }
+    let(:contents) { File.read(path) }
+    let(:redirects) { JSON.parse(contents) }
+    let(:domain) { "http://jekyllrb.com" }
+
+    it "creates the redirets file" do
+      expect(path).to exist
+    end
+
+    it "contains redirects" do
+      expect(redirects.count).to eql(13)
+    end
+
+    it "contains single redirects tos" do
+      expect(redirects.keys).to include "/one_redirect_to_path.html"
+      expect(redirects["/one_redirect_to_path.html"]).to eql("#{domain}/foo")
+    end
+
+    it "contains multiple redirect tos" do
+      expect(redirects.keys).to include "/multiple_redirect_tos.html"
+      expect(redirects["/multiple_redirect_tos.html"]).to eql("https://www.jekyllrb.com")
+    end
+
+    it "contains single redirect froms" do
+      expect(redirects.keys).to include "/some/other/path"
+      expect(redirects["/some/other/path"]).to eql("#{domain}/one_redirect_from.html")
+    end
+
+    it "contains multiple redirect froms" do
+      expect(redirects.keys).to include "/help"
+      expect(redirects["/help"]).to eql("#{domain}/multiple_redirect_froms.html")
+
+      expect(redirects.keys).to include "/contact"
+      expect(redirects["/contact"]).to eql("#{domain}/multiple_redirect_froms.html")
+    end
+
+    context "with a user-supplied redirects.json" do
+      let(:source_path) { File.join fixtures_path, "redirects.json" }
+      before do
+        File.write source_path, { "foo" => "bar" }.to_json
+        site.reset
+        site.read
+        site.generate
+        site.render
+        site.write
+      end
+
+      after do
+        FileUtils.rm_f source_path
+      end
+
+      it "doesn't overwrite redirets.json" do
+        expect(path).to exist
+        expect(redirects).to eql({ "foo" => "bar" })
+      end
+    end
+  end
 end

data/spec/jekyll_redirect_from/layout_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe JekyllRedirectFrom::Layout do
   subject { described_class.new(@site) }
 
@@ -10,7 +12,7 @@ RSpec.describe JekyllRedirectFrom::Layout do
   end
 
   it "exposes the path" do
-    expected = File.expand_path "../../lib/jekyll-redirect-from/redirect.html", File.dirname(__FILE__)
+    expected = File.expand_path "../../lib/jekyll-redirect-from/redirect.html", __dir__
     expect(subject.path).to eql(expected)
   end
 

data/spec/jekyll_redirect_from/redirect_page_spec.rb

@@ -1,4 +1,4 @@
-# Encoding: utf-8
+# frozen_string_literal: true
 
 describe JekyllRedirectFrom::RedirectPage do
   let(:from) { "/foo" }

data/spec/jekyll_redirect_from/redirectable_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RedirectableTestHelper
   include JekyllRedirectFrom::Redirectable
   attr_reader :to_liquid

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll"
 require File.expand_path("lib/jekyll-redirect-from.rb")
 
@@ -20,7 +22,7 @@ RSpec.configure do |config|
   end
 
   def fixtures_path
-    Pathname.new(__FILE__).parent.join("fixtures")
+    Pathname.new(__dir__).join("fixtures")
   end
 
   def dest_path
@@ -37,18 +39,18 @@ RSpec.configure do |config|
       "destination" => fixtures_path.join("_site").to_s,
       "collections" => {
         "articles" => { "output" => true },
-        "authors"  => {}
+        "authors"  => {},
       },
       "url"         => "http://jekyllrb.com",
       "gems"        => [
         "jekyll-redirect-from",
-        "jekyll-sitemap"
+        "jekyll-sitemap",
       ],
       "defaults"    => [{
         "scope"  => { "path" => "" },
-        "values" => { "layout" => "layout" }
-      }]
-    })
+        "values" => { "layout" => "layout" },
+      },],
+    }).backwards_compatibilize
   end
 
   def site

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-redirect-from
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -39,62 +39,62 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: jekyll-sitemap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: jekyll-sitemap
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.43'
+        version: '0.51'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.43'
-description: Seamlessly specify multiple redirection URLs for your pages and posts
+        version: '0.51'
+description: 
 email:
 - parkrmoore@gmail.com
 executables: []
@@ -115,12 +115,14 @@ files:
 - lib/jekyll-redirect-from/context.rb
 - lib/jekyll-redirect-from/generator.rb
 - lib/jekyll-redirect-from/layout.rb
+- lib/jekyll-redirect-from/page_without_a_file.rb
 - lib/jekyll-redirect-from/redirect.html
 - lib/jekyll-redirect-from/redirect_page.rb
 - lib/jekyll-redirect-from/redirectable.rb
 - lib/jekyll-redirect-from/version.rb
 - script/bootstrap
 - script/cibuild
+- script/fmt
 - script/release
 - script/test
 - spec/fixtures/_articles/redirect-me-plz.md
@@ -162,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.1
 signing_key: 
 specification_version: 4
 summary: Seamlessly specify multiple redirection URLs for your pages and posts