jekyll-redirect-from 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d791a13d885f60395b4ae51369248e46e4b049b
-  data.tar.gz: d4bb94fb82a1dca865b49d404ec035ce037b3e65
+  metadata.gz: 7e24a249a812fdc138185c2969c99551fe3381e4
+  data.tar.gz: cae3b55835fb5559a4ba03fd2c9a1daf1e7c3042
 SHA512:
-  metadata.gz: d918ab960428cd3d81738dddf6c8b66a68560ea686db49d29c775d0c722ea5ea3cd5d4722e1ffa67f7ad6eaf6ab802a91332a9a30a5bd3c16a316d2afd82cc39
-  data.tar.gz: a9c2dd79f38008c59b9fca3314bea0a4d3c1b1a51bb218e60e4837bcf75f33ba7fcc3be67dd55a6aa4e2011c9f6c9eaf6074503e4318764485a75cded95e19c0
+  metadata.gz: 495dde833d74a819dd8b46f5e0b003813bfac7458cf31697ba048cce13c715236f0792fc8e7d53c20d1dd47b48c026f64b407e24649bcf0c2d0dc02e184c1d54
+  data.tar.gz: 4dc27cedf73031652945823ee9aa75bce46a2a9df78f9aa49ad37cc05d4e7ce18c7273bf333a9121bd1f9c19bb8ec42dcd186df26aa76deb2ad08ee1b58e5549

data/.rspec

@@ -1,2 +1,4 @@
 --color
 --format progress
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -9,18 +9,11 @@ matrix:
     - # GitHub Pages
       rvm: 2.1.1
       env: GH_PAGES=true
-    - # Ruby 1.9
-      rvm: 1.9
-      env: JEKYLL_VERSION=2.0
   allow_failures:
     - env: GH_PAGES=true # Jekyll 2.4 will fail tests
   fast_finish: true
 
 rvm:
+  - 2.3.0
   - 2.2
   - 2.1
-  - 2.0
-env:
-  - ""
-  - JEKYLL_VERSION=3.0
-  - JEKYLL_VERSION=2.0

data/Gemfile

@@ -3,6 +3,4 @@ gemspec
 
 if ENV["GH_PAGES"]
   gem "github-pages"
-elsif ENV["JEKYLL_VERSION"]
-  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
 end

data/History.markdown

@@ -1,3 +1,23 @@
+## HEAD
+
+### Major Enhancements
+
+  * Support for custom redirect templates
+  * Use Jekyll's `absolute_url` filter to generate canonical URLs (now respecting `baseurl`)
+  * Rely more heavily on Jekyll's native Page, permalink, and extension handling logic
+  
+### Minor Enhancementse
+
+  * redirect_to Pages should not have a layout. (#115)
+  * Require Jekyll >= 3.3
+  
+### Development Enhancements
+
+  * Push redirect logic to the redirect page model (#131)
+  * Add Rubocop and enforce Jekyll coding standards
+  * Tests no longer build and write the entire site between each example
+  * Removed all the `is_*`? and `has_*`? helpers from the generator
+  
 ## 0.11.0 / 2016-07-06
 
   * Redirect page should not have any layout (#106)

data/README.md

@@ -100,10 +100,10 @@ redirect_from: /post/123456798/
 ```
 
 ### Prefix
-If `site.baseurl` is set, its value is used as a prefix for the redirect url automatically.
-This is useful for scenarios where a site isn't available from the domain root, so the redirects point to the correct path.
 
-**_Note_**: If you are hosting your Jekyll site on [GitHub Pages](https://pages.github.com/), the prefix is set to the pages domain name i.e. `http://example.github.io/project` or a custom `CNAME`.
+If `site.url` is set, its value, together with `site.baseurl`, is used as a prefix for the redirect url automatically. This is useful for scenarios where a site isn't available from the domain root, so the redirects point to the correct path. If `site.url` is not set, only `site.baseurl` is used, if set.
+
+**_Note_**: If you are hosting your Jekyll site on [GitHub Pages](https://pages.github.com/), and `site.url` is not set, the prefix is set to the pages domain name i.e. http://example.github.io/project or a custom CNAME.
 
 ### Redirect To
 
@@ -120,6 +120,15 @@ If you have multiple `redirect_to`s set, only the first one will be respected.
 
 **Note**: Using `redirect_to` or `redirect_from` with collections will only work with files which are output to HTML, such as `.md`, `.textile`, `.html` etc.
 
+## Customizing the redirect template
+
+If you want to customize the redirect template, you can. Simply create a layout in your site's `_layouts` directory called `redirect.html`.
+
+Your layout will get the following variables:
+
+* `page.redirect.from` - the relative path to the redirect page
+* `page.redirect.to` - the absolute URL (where available) to the target page
+
 ## Contributing
 
 1. Fork it

data/jekyll-redirect-from.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "jekyll", ">= 2.0"
+  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"
 end

data/lib/jekyll-redirect-from.rb

@@ -1,11 +1,17 @@
 require "jekyll"
+require "jekyll-redirect-from/version"
+require "jekyll-redirect-from/generator"
 
 module JekyllRedirectFrom
-  def self.jekyll_3?
-    @jekyll_3 ||= (Jekyll::VERSION >= '3.0.0')
-  end
+  # 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"
 end
 
-require "jekyll-redirect-from/version"
-require "jekyll-redirect-from/redirect_page"
-require "jekyll-redirect-from/redirector"
+JekyllRedirectFrom::CLASSES.each do |klass|
+  klass.include JekyllRedirectFrom::Redirectable
+end

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

@@ -0,0 +1,14 @@
+module JekyllRedirectFrom
+  # Stubbed LiquidContext to support relative_url and absolute_url helpers
+  class Context
+    attr_reader :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    def registers
+      { :site => site }
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module JekyllRedirectFrom
+  class Generator < Jekyll::Generator
+    safe true
+    attr_reader :site
+
+    def generate(site)
+      @site = site
+
+      # Inject our layout, unless the user has already specified a redirect layout'
+      unless site.layouts.keys.any? { |name| name == "redirect" }
+        site.layouts["redirect"] = JekyllRedirectFrom::Layout.new(site)
+      end
+
+      # Must duplicate pages to modify while in loop
+      (site.docs_to_write + site.pages.dup).each do |doc|
+        next unless JekyllRedirectFrom::CLASSES.include?(doc.class)
+        generate_redirect_from(doc)
+        generate_redirect_to(doc)
+      end
+    end
+
+    private
+
+    # 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)
+      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
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+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__)
+      @name = "redirect.html"
+      @path = File.expand_path(@name, @base)
+      @relative_path = "_layouts/redirect.html"
+
+      self.data = {}
+      self.ext = "html"
+      self.content = File.read(@path)
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <meta charset="utf-8">
+  <title>Redirecting…</title>
+  <link rel="canonical" href="{{ page.redirect.to }}">
+  <meta http-equiv="refresh" content="0; url={{ page.redirect.to }}">
+  <h1>Redirecting…</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,42 +1,61 @@
 # Encoding: utf-8
-
 module JekyllRedirectFrom
+  # Specialty page which implements the redirect path logic
   class RedirectPage < Jekyll::Page
-    # Initialize a new RedirectPage.
+    # Use Jekyll's native absolute_url filter
+    include Jekyll::Filters::URLFilters
+
+    DEFAULT_DATA = {
+      "sitemap" => false,
+      "layout"  => "redirect"
+    }.freeze
+
+    # Creates a new RedirectPage instance from a source path and redirect path
     #
-    # site - The Site object.
-    # base - The String path to the source.
-    # dir  - The String path between the source and the file.
-    # name - The String filename of the file.
-    def initialize(site, base, dir, name)
-      @site = site
-      @base = base
-      @dir  = dir
-      @name = name
-
-      self.process(name)
-      self.data = { "layout" => nil }
-
-      data.default_proc = proc do |_, key|
-        site.frontmatter_defaults.find(File.join(dir, name), type, key)
-      end
-
-      Jekyll::Hooks.trigger :pages, :post_init, self if JekyllRedirectFrom.jekyll_3?
+    # site - The Site object
+    # from - the (URL) path, relative to the site root to redirect from
+    # to   - the relative path or URL which the page should redirect to
+    def self.from_paths(site, from, to)
+      page = RedirectPage.new(site, site.source, "", "redirect.html")
+      page.set_paths(from, to)
+      page
+    end
+
+    # Creates a new RedirectPage instance from the path to the given doc
+    def self.redirect_from(doc, path)
+      RedirectPage.from_paths(doc.site, path, doc.url)
+    end
+
+    # Creates a new RedirectPage instance from the doc to the given path
+    def self.redirect_to(doc, path)
+      RedirectPage.from_paths(doc.site, doc.url, path)
     end
 
-    def generate_redirect_content(item_url)
-      self.output = self.content = <<-EOF
-<!DOCTYPE html>
-<html lang="en-US">
-<meta charset="utf-8">
-<title>Redirecting…</title>
-<link rel="canonical" href="#{item_url}">
-<meta http-equiv="refresh" content="0; url=#{item_url}">
-<h1>Redirecting…</h1>
-<a href="#{item_url}">Click here if you are not redirected.</a>
-<script>location="#{item_url}"</script>
-</html>
-EOF
+    # Overwrite the default read_yaml method since the file doesn't exist
+    def read_yaml(_base, _name, _opts = {})
+      self.content = ""
+      self.data ||= DEFAULT_DATA.dup
+    end
+
+    # Helper function to set the appropriate path metadata
+    #
+    # from - the relative path to the redirect page
+    # to   - the relative path or absolute URL to the redirect target
+    def set_paths(from, to)
+      @context ||= context
+      data.merge!({
+        "permalink" => from,
+        "redirect"  => {
+          "from" => from,
+          "to"   => to =~ %r!^https?://! ? to : absolute_url(to)
+        }
+      })
+    end
+
+    private
+
+    def context
+      JekyllRedirectFrom::Context.new(site)
     end
   end
 end

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

@@ -0,0 +1,25 @@
+module JekyllRedirectFrom
+  # Module which can be mixed in to documents (and pages) to provide
+  # redirect_to and redirect_from helpers
+  module Redirectable
+    # Returns a string representing the relative path or URL
+    # to which the document should be redirected
+    def redirect_to
+      if to_liquid["redirect_to"].is_a?(Array)
+        to_liquid["redirect_to"].compact.first
+      else
+        to_liquid["redirect_to"]
+      end
+    end
+
+    # Returns an array representing the relative paths to other
+    # documents which should be redirected to this document
+    def redirect_from
+      if to_liquid["redirect_from"].is_a?(Array)
+        to_liquid["redirect_from"].compact
+      else
+        [to_liquid["redirect_from"]].compact
+      end
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module JekyllRedirectFrom
-  VERSION = "0.11.0"
+  VERSION = "0.12.0".freeze
 end

data/script/cibuild

@@ -2,3 +2,5 @@
 set -e
 
 bundle exec rake spec
+bundle exec rubocop -S -D
+gem build jekyll-redirect-from.gemspec

data/spec/fixtures/one_redirect_from.md

@@ -0,0 +1,6 @@
+---
+title: I only have one redirect path
+redirect_from: some/other/path
+---
+
+One redirect url

data/spec/fixtures/one_redirect_to_path.md

@@ -0,0 +1,6 @@
+---
+title: I am going somewhere external
+redirect_to: /foo
+---
+
+Redirecting elsewhere.

data/spec/fixtures/{one_redirect_to.md → one_redirect_to_url.md}

@@ -1,5 +1,5 @@
 ---
-title: I am going somewhere else.
+title: I am going somewhere external
 redirect_to: https://www.github.com
 ---
 

data/spec/integrations_spec.rb

@@ -1,13 +1,86 @@
-require 'spec_helper'
+RSpec.describe "JekyllRedirectFrom integration tests" do
+  before { site.process }
+  let(:relative_path) { "" }
+  let(:path) { dest_dir(relative_path) }
+  let(:contents) { File.read(path) }
 
-describe("Integration Tests") do
-  it "writes the redirect pages for collection items which are outputted" do
-    expect(dest_dir("articles", "redirect-me-plz.html")).to exist
-    expect(dest_dir("articles", "23128432159832", "mary-had-a-little-lamb#{forced_output_ext}")).to exist
+  context "pages" do
+    context "single redirect from" do
+      let(:relative_path) { "some/other/path.html" }
+
+      it "exists in the built site" do
+        expect(path).to exist
+        expect(contents).to match("http://jekyllrb.com/one_redirect_from.html")
+      end
+    end
+
+    context "multiple redirect froms" do
+      %w(help contact let-there/be/light-he-said geepers/mccreepin).each do |redirect|
+        context "the #{redirect} redirect" do
+          let(:relative_path) { "#{redirect}.html" }
+
+          it "exists in the built site" do
+            expect(path).to exist
+            expect(contents).to match("http://jekyllrb.com/multiple_redirect_froms.html")
+          end
+        end
+      end
+    end
+
+    context "a redirect to URL" do
+      let(:relative_path) { "one_redirect_to_url.html" }
+
+      it "exists in the built site" do
+        expect(path).to exist
+        expect(contents).to match("https://www.github.com")
+      end
+    end
+
+    context "a redirect to path" do
+      let(:relative_path) { "one_redirect_to_path.html" }
+
+      it "exists in the built site" do
+        expect(path).to exist
+        expect(contents).to match("http://jekyllrb.com/foo")
+      end
+    end
   end
 
-  it "doesn't write redirect pages for collection items which are not outputted" do
-    expect(dest_dir("authors")).not_to exist
-    expect(dest_dir("kansaichris")).not_to exist
+  context "documents" do
+    context "a single redirect from" do
+      let(:relative_path) { "articles/23128432159832/mary-had-a-little-lamb.html" }
+
+      it "exists in the built site" do
+        expect(path).to exist
+        expect(contents).to match("http://jekyllrb.com/articles/redirect-me-plz.html")
+      end
+    end
+
+    context "redirect to" do
+      let(:relative_path) { "articles/redirect-somewhere-else-plz.html" }
+
+      it "exists in the built site" do
+        expect(path).to exist
+        expect(contents).to match("http://www.zombo.com")
+      end
+    end
+
+    context "with a permalink" do
+      let(:relative_path) { "tags/our projects/index.html" }
+
+      it "exists in the built site" do
+        expect(path).to exist
+        expect(contents).to match("http://jekyllrb.com/tags/our-projects/")
+      end
+    end
+  end
+
+  context "sitemap" do
+    let(:relative_path) { "sitemap.xml" }
+
+    it "doesn't contain redirects" do
+      expect(contents).to_not be_nil
+      expect(contents).to_not match("redirect_to")
+    end
   end
 end