jekyll-redirect-from 0.11.0 → 0.12.0

data/spec/jekyll_redirect_from/context_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe JekyllRedirectFrom::Context do
+  subject { described_class.new(site) }
+
+  it "stores the site" do
+    expect(subject.site).to be_a(Jekyll::Site)
+  end
+
+  it "returns the register" do
+    expect(subject.registers).to have_key(:site)
+    expect(subject.registers[:site]).to be_a(Jekyll::Site)
+  end
+end

data/spec/jekyll_redirect_from/generator_spec.rb

@@ -0,0 +1,87 @@
+RSpec.describe JekyllRedirectFrom::Generator do
+  before(:each) do
+    site.read
+    site.generate
+    site.render
+  end
+
+  context "layouts" do
+    context "a site with a redirect layout" do
+      before { site.layouts["redirect"] = "foo" }
+
+      it "doesn't inject the layout" do
+        expect(site.layouts["redirect"]).to eql("foo")
+      end
+    end
+
+    context "a site without a redirect layout" do
+      it "injects the layout" do
+        expect(site.layouts["redirect"]).to be_a(JekyllRedirectFrom::Layout)
+      end
+    end
+  end
+
+  context "redirect froms" do
+    context "pages" do
+      context "a page with a single redirect" do
+        let(:page) { site.pages.find { |p| p.url == "/some/other/path" } }
+
+        it "creates the redirect" do
+          expect(page).to_not be_nil
+          expect(page.output).to match("http://jekyllrb.com/one_redirect_from.html")
+        end
+      end
+
+      context "a page with multiple redirects" do
+        let(:redirects) do
+          ["/help", "/contact", "/let-there/be/light-he-said", "/geepers/mccreepin"]
+        end
+
+        it "creates all the redirects" do
+          redirects.each do |url|
+            page = site.pages.find { |p| p.url == url }
+            expect(page).to_not be_nil
+            expect(page.output).to match("http://jekyllrb.com/multiple_redirect_froms.html")
+          end
+        end
+      end
+    end
+
+    context "documents" do
+      let(:page) { site.pages.find { |p| p.url == "/articles/23128432159832/mary-had-a-little-lamb" } }
+
+      it "redirects" do
+        expect(page).to_not be_nil
+        expect(page.output).to match("http://jekyllrb.com/articles/redirect-me-plz.html")
+      end
+    end
+  end
+
+  context "redirect tos" do
+    context "pages" do
+      context "a single redirect to" do
+        let(:page) { site.pages.find { |p| p.url == "/one_redirect_to_url.html" } }
+
+        it "redirects" do
+          expect(page.output).to match("https://www.github.com")
+        end
+      end
+
+      context "multiple redirect tos" do
+        let(:page) { site.pages.find { |p| p.url == "/multiple_redirect_tos.html" } }
+
+        it "redirects to the first entry" do
+          expect(page.output).to match("https://www.jekyllrb.com")
+        end
+      end
+    end
+
+    context "documents" do
+      let(:doc) { site.documents.find { |p| p.url == "/articles/redirect-somewhere-else-plz.html" } }
+
+      it "redirects" do
+        expect(doc.output).to match("http://www.zombo.com")
+      end
+    end
+  end
+end

data/spec/jekyll_redirect_from/layout_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe JekyllRedirectFrom::Layout do
+  subject { described_class.new(@site) }
+
+  it "exposes the site" do
+    expect(subject.site).to eql(@site)
+  end
+
+  it "exposes the name" do
+    expect(subject.name).to eql("redirect.html")
+  end
+
+  it "exposes the path" do
+    expected = File.expand_path "../../lib/jekyll-redirect-from/redirect.html", File.dirname(__FILE__)
+    expect(subject.path).to eql(expected)
+  end
+
+  it "exposes the relative path" do
+    expect(subject.relative_path).to eql("_layouts/redirect.html")
+  end
+
+  it "exposes the ext" do
+    expect(subject.ext).to eql("html")
+  end
+
+  it "exposes data" do
+    expect(subject.data).to eql({})
+  end
+
+  it "exposes content" do
+    expect(subject.content).to match("Redirecting...")
+  end
+end

data/spec/jekyll_redirect_from/redirect_page_spec.rb

@@ -1,76 +1,207 @@
 # Encoding: utf-8
 
-require "spec_helper"
-
 describe JekyllRedirectFrom::RedirectPage do
-  let(:permalink)     { "/posts/12435151125/larry-had-a-little-lamb" }
-  let(:redirect_page) { new_redirect_page(permalink) }
-  let(:item_url)      { File.join(@site.config["url"], "2014", "01", "03", "moving-to-jekyll.md") }
-  let(:page_content)  { redirect_page.generate_redirect_content(item_url) }
+  let(:from) { "/foo" }
+  let(:to) { "/bar" }
+  let(:site_url) { site.config["url"] }
+  subject { described_class.from_paths(site, from, to) }
+  before { site.read }
+
+  context "being a page" do
+    before { subject.read_yaml(nil, nil, nil) }
+
+    it "returns no content" do
+      expect(subject.content).to eql("")
+    end
+
+    it "sets default data" do
+      expect(subject.to_liquid["layout"]).to eql("redirect")
+      expect(subject.to_liquid["sitemap"]).to be_falsey
+    end
+  end
+
+  context "creating a page from paths" do
+    it "sets the permalink" do
+      expect(subject.to_liquid["permalink"]).to eql(from)
+    end
+
+    it "sets redirect metadata" do
+      expect(subject.to_liquid).to have_key("redirect")
+      expect(subject.to_liquid["redirect"]["from"]).to eql(from)
+      expect(subject.to_liquid["redirect"]["to"]).to eql("#{site_url}#{to}")
+    end
+
+    context "with a document" do
+      let(:doc) { site.documents.first }
+
+      context "redirect from" do
+        let(:page) { described_class.redirect_from(doc, from) }
 
-  context "#generate_redirect_content" do
-    it "sets the #content to the generated refresh page" do
-      expect(page_content).to eq("<!DOCTYPE html>\n<html lang=\"en-US\">\n<meta charset=\"utf-8\">\n<title>Redirecting…</title>\n<link rel=\"canonical\" href=\"#{item_url}\">\n<meta http-equiv=\"refresh\" content=\"0; url=#{item_url}\">\n<h1>Redirecting…</h1>\n<a href=\"#{item_url}\">Click here if you are not redirected.</a>\n<script>location=\"#{item_url}\"</script>\n</html>\n")
+        it "creates with redirect_from" do
+          expect(page.to_liquid["permalink"]).to eql(from)
+          expect(page.to_liquid).to have_key("redirect")
+          expect(page.to_liquid["redirect"]["from"]).to eql(from)
+          expected = "http://jekyllrb.com/2014/01/03/redirect-me-plz.html"
+          expect(page.to_liquid["redirect"]["to"]).to eql(expected)
+        end
+      end
+
+      context "redirect to" do
+        let(:page) { described_class.redirect_to(doc, to) }
+
+        context "redirecting to a path" do
+          let(:to) { "/bar" }
+
+          it "redirects" do
+            expect(page.to_liquid["permalink"]).to eql("/2014/01/03/redirect-me-plz.html")
+            expect(page.to_liquid).to have_key("redirect")
+            expect(page.to_liquid["redirect"]["to"]).to eql("#{site_url}#{to}")
+            expect(page.to_liquid["redirect"]["from"]).to eql("/2014/01/03/redirect-me-plz.html")
+          end
+
+          context "with no leading slash" do
+            let(:to) { "bar" }
+
+            it "redirects" do
+              expect(page.to_liquid).to have_key("redirect")
+              expect(page.to_liquid["redirect"]["to"]).to eql("#{site_url}/#{to}")
+            end
+          end
+
+          context "with a trailing slash" do
+            let(:to) { "/bar/" }
+
+            it "redirects" do
+              expect(page.to_liquid).to have_key("redirect")
+              expect(page.to_liquid["redirect"]["to"]).to eql("#{site_url}#{to}")
+            end
+          end
+        end
+
+        context "redirecting to a URL" do
+          let(:to) { "https://foo.invalid" }
+
+          it "redirects" do
+            expect(page.to_liquid["permalink"]).to eql("/2014/01/03/redirect-me-plz.html")
+            expect(page.to_liquid).to have_key("redirect")
+            expect(page.to_liquid["redirect"]["to"]).to eql("https://foo.invalid")
+            expect(page.to_liquid["redirect"]["from"]).to eql("/2014/01/03/redirect-me-plz.html")
+          end
+        end
+      end
+    end
+  end
+
+  context "setting the paths" do
+    let(:from) { "/foo2" }
+    let(:to) { "/bar2" }
+
+    before { subject.set_paths(from, to) }
+
+    it "sets the paths" do
+      expect(subject.to_liquid["permalink"]).to eql(from)
+      expect(subject.to_liquid).to have_key("redirect")
+      expect(subject.to_liquid["redirect"]["from"]).to eql(from)
+      expect(subject.to_liquid["redirect"]["to"]).to eql("#{site_url}#{to}")
+    end
+  end
+
+  context "generating" do
+    before { site.generate }
+    let(:output) { Jekyll::Renderer.new(site, subject, site.site_payload).run }
+
+    it "renders the template" do
+      expect(output).to_not be_nil
+      expect(output.to_s).to_not be_empty
     end
 
     it "contains the meta refresh tag" do
-      expect(page_content).to include("<meta http-equiv=\"refresh\" content=\"0; url=#{item_url}\">")
+      expect(output).to match("<meta http-equiv=\"refresh\" content=\"0; url=#{site_url}#{to}\">")
     end
 
-    it "contains JavaScript redirect" do
-      expect(page_content).to include("location=\"http://jekyllrb.com/2014/01/03/moving-to-jekyll.md\"")
+    it "contains the javascript redirect" do
+      expect(output).to match("<script>location=\"#{site_url}#{to}\"</script>")
     end
 
     it "contains canonical link in header" do
-      expect(page_content).to include("<link rel=\"canonical\" href=\"http://jekyllrb.com/2014/01/03/moving-to-jekyll.md\">")
+      expect(output).to match("<link rel=\"canonical\" href=\"#{site_url}#{to}\">")
     end
 
-    it "contains a clickable link to redirect" do
-      expect(page_content).to include("<a href=\"http://jekyllrb.com/2014/01/03/moving-to-jekyll.md\">Click here if you are not redirected.</a>")
+    it "contains the clickable link" do
+      expect(output).to match("<a href=\"#{site_url}#{to}\">Click here if you are not redirected.</a>")
     end
   end
 
-  context "when determining the write destination" do
-    context "of a redirect page meant to be a dir" do
-      let(:permalink_dir) { "/posts/1914798137981389/larry-had-a-little-lamb/" }
-      let(:redirect_page) { new_redirect_page(permalink_dir) }
+  context "redirect from destination" do
+    context "when redirect from has no extension" do
+      let(:from) { "/foo" }
 
-      it "knows to add the index.html if it's a folder" do
-        expected = dest_dir("posts", "1914798137981389", "larry-had-a-little-lamb", "index.html").to_s
-        dest = redirect_page.destination("/")
-        dest = "#{@site.dest}#{dest}" unless dest.start_with? @site.dest
-        expect(dest).to eql(expected)
+      it "adds .html" do
+        expected = File.expand_path "foo.html", site.dest
+        expect(subject.destination("/")).to eql(expected)
       end
     end
 
-    context "of a redirect page meant to be a file" do
-      it "knows not to add the index.html if it's not a folder" do
-        expected = dest_dir("posts", "12435151125", "larry-had-a-little-lamb#{forced_output_ext}").to_s
-        dest = redirect_page.destination("/")
-        dest = "#{@site.dest}#{dest}" unless dest.start_with? @site.dest
-        expect(dest).to eql(expected)
+    context "when redirect from is a directory" do
+      let(:from) { "/foo/" }
+
+      it "knows to add the index.html" do
+        expected = File.expand_path "foo/index.html", site.dest
+        expect(subject.destination("/")).to eql(expected)
       end
     end
-  end
 
-  context "when writing to disk" do
-    let(:redirect_page_full_path) { redirect_page.destination(@site.dest) }
+    context "when redirect from is an HTML file" do
+      let(:from) { "/foo.html" }
 
-    before(:each) do
-      redirect_page.generate_redirect_content(item_url)
-      redirect_page.write(@site.dest)
+      it "adds .html" do
+        expected = File.expand_path "foo.html", site.dest
+        expect(subject.destination("/")).to eql(expected)
+      end
     end
 
-    it "fetches the path properly" do
-      expect(redirect_page_full_path).to match /\/spec\/fixtures\/\_site\/posts\/12435151125\/larry-had-a-little-lamb#{forced_output_ext}$/
+    context "when redirect from is another extension" do
+      let(:from) { "/foo.htm" }
+
+      it "doesn't add .html" do
+        expected = File.expand_path "foo.htm", site.dest
+        expect(subject.destination("/")).to eql(expected)
+      end
     end
 
-    it "is written to the proper location" do
-      expect(File.exist?(redirect_page_full_path)).to be_truthy
+    context "when redirect from has no leading slash" do
+      let(:from) { "foo" }
+
+      it "adds the slash" do
+        expected = File.expand_path "foo.html", site.dest
+        expect(subject.destination("/")).to eql(expected)
+      end
+    end
+  end
+
+  context "output extension" do
+    context "with an extension" do
+      let(:from) { "foo.htm" }
+
+      it "honors the extension" do
+        expect(subject.output_ext).to eql(".htm")
+      end
     end
 
-    it "writes the context we expect" do
-      expect(File.read(redirect_page_full_path)).to eql(page_content)
+    context "with a trailing slash" do
+      let(:from) { "foo/" }
+
+      it "uses HTML" do
+        expect(subject.output_ext).to eql(".html")
+      end
+    end
+
+    context "with no slash" do
+      let(:from) { "foo" }
+
+      it "uses HTML" do
+        expect(subject.output_ext).to eql(".html")
+      end
     end
   end
 end

data/spec/jekyll_redirect_from/redirectable_spec.rb

@@ -0,0 +1,61 @@
+class RedirectableTestHelper
+  include JekyllRedirectFrom::Redirectable
+  attr_reader :to_liquid
+
+  def initialize(data)
+    @to_liquid = data
+  end
+end
+
+RSpec.describe JekyllRedirectFrom::Redirectable do
+  let(:data) { "" }
+  subject { RedirectableTestHelper.new(data) }
+
+  context "with strings" do
+    let(:data) { { "redirect_from" => "/foo", "redirect_to" => "/bar" } }
+
+    it "returns redirect_from" do
+      expect(subject.redirect_from).to eql(["/foo"])
+    end
+
+    it "returns redirect_to" do
+      expect(subject.redirect_to).to eql("/bar")
+    end
+  end
+
+  context "with arrays" do
+    let(:data) { { "redirect_from" => ["/foo"], "redirect_to" => ["/bar"] } }
+
+    it "returns redirect_from" do
+      expect(subject.redirect_from).to eql(["/foo"])
+    end
+
+    it "returns redirect_to" do
+      expect(subject.redirect_to).to eql("/bar")
+    end
+  end
+
+  context "with fields missing" do
+    let(:data) { {} }
+
+    it "returns an empty array for redirect_from" do
+      expect(subject.redirect_from).to eql([])
+    end
+
+    it "returns nil for redirect_to" do
+      expect(subject.redirect_to).to be_nil
+    end
+  end
+
+  context "with nils" do
+    let(:data) { { "redirect_from" => nil, "redirect_to" => nil } }
+
+    it "returns an empty array for redirect_from" do
+      expect(subject.redirect_from).to eql([])
+    end
+
+    it "returns nil for redirect_to" do
+      expect(subject.redirect_to).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ require File.expand_path("lib/jekyll-redirect-from.rb")
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-  config.order = 'random'
 
   config.expect_with :rspec do |c|
     c.syntax = :expect
@@ -12,77 +11,47 @@ RSpec.configure do |config|
 
   config.before(:each) do
     Jekyll.logger.log_level = :error
-
-    @fixtures_path = Pathname.new(__FILE__).parent.join("fixtures")
-    @dest        = @fixtures_path.join("_site")
-    @posts_src   = @fixtures_path.join("_posts")
-    @layouts_src = @fixtures_path.join("_layouts")
-    @plugins_src = @fixtures_path.join("_plugins")
-
-    @site = Jekyll::Site.new(Jekyll.configuration({
-      "source"      => @fixtures_path.to_s,
-      "destination" => @dest.to_s,
-      "plugins"     => @plugins_src.to_s,
-      "collections" => {
-        "articles" => {"output" => true},
-        "authors"  => {}
-      },
-      "defaults"    => [{
-        "scope" => { "path" => "" },
-        "values" => { "layout" => "layout" }
-      }]
-    }))
-
-    @dest.rmtree if @dest.exist?
-    @site.process
+    dest_path.rmtree if dest_path.exist?
+    site.reset
   end
 
   config.after(:each) do
-    @dest.rmtree if @dest.exist?
-  end
-
-  def dest_dir(*paths)
-    @dest.join(*paths)
-  end
-
-  def unpublished_doc
-    @site.collections["authors"].docs.first
+    dest_path.rmtree if dest_path.exist?
   end
 
-  def setup_doc(doc_filename)
-    @site.collections["articles"].docs.find { |d| d.relative_path.match(doc_filename) }
+  def fixtures_path
+    Pathname.new(__FILE__).parent.join("fixtures")
   end
 
-  def setup_post(file)
-    Jekyll::Post.new(@site, @fixtures_path.to_s, '', file)
+  def dest_path
+    Pathname.new(site.dest)
   end
 
-  def setup_page(file)
-    Jekyll::Page.new(@site, @fixtures_path.to_s, File.dirname(file), File.basename(file))
-  end
-
-  def new_redirect_page(permalink)
-    page = JekyllRedirectFrom::RedirectPage.new(@site, @site.source, "", "index.html")
-    page.data['permalink'] = permalink
-    page.data['sitemap'] = false
-    page
-  end
-
-  def destination_sitemap
-    @dest.join("sitemap.xml").read
-  end
-
-  def forced_output_ext
-    JekyllRedirectFrom.jekyll_3? ? ".html" : ""
+  def dest_dir(*paths)
+    dest_path.join(*paths)
   end
-end
 
-class TestStringContainer
-  def initialize(strValue)
-    @val = strValue
+  def config
+    Jekyll.configuration({
+      "source"      => fixtures_path.to_s,
+      "destination" => fixtures_path.join("_site").to_s,
+      "collections" => {
+        "articles" => { "output" => true },
+        "authors"  => {}
+      },
+      "url"         => "http://jekyllrb.com",
+      "gems"        => [
+        "jekyll-redirect-from",
+        "jekyll-sitemap"
+      ],
+      "defaults"    => [{
+        "scope"  => { "path" => "" },
+        "values" => { "layout" => "layout" }
+      }]
+    })
   end
 
-  def to_s
-    @val
+  def site
+    @site ||= Jekyll::Site.new(config)
   end
 end