Merge pull request #131 from jekyll/bb-refactor

Merge pull request 131

Author: jekyllbot

.rspec

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

.rubocop.yml

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

.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

Gemfile

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

README.md

@@ -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

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

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

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

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

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