jekyll-redirect-from 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 112381245761df69cddfd8b8c7d67755d6037cd8
-  data.tar.gz: fcd9362806dba6253fa56680db4142b1b401f996
+  metadata.gz: 00b63d3652670cb824eac206484575da47507dd7
+  data.tar.gz: 4b21faeb8f35a76532c4473bf9df0fe79453b97a
 SHA512:
-  metadata.gz: 40503272424d63e5baf7df133bada0382c3cd4478c16d41671b4201a311e74537a0690259d86b30b22bd22a613c7ceda4d4fdce9dd0f38825b2b2e6d07924f38
-  data.tar.gz: 65ed493e7b3a3e34c6c86da859f3626460ae8e4f477de5e984d27b135458e9f5c6a9df9f8a8363fb8ccc276725ad1286a6b2c1a806e3605ccf8b0fb09a2ee1c2
+  metadata.gz: 37a01d9e02364740b8f76373e8a3f987df5ab2c46625cd8372fd221a88194fae4be7812d4069a93784116ba735811b916e9d9b7f6301fa1f08b5adf494c1e92a
+  data.tar.gz: af8280d5ab1735fdfc02dc1c3480b1ea514ef10c50e332bd97110537218b6a6ade3851ba47569135f82d43b80d33c05d3115d2f6853f1118e2be94dc40f98ca5

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.0
-  - 2.0.0
+  - 2.1
+  - 2.0
   - 1.9.3
 script: "script/cibuild"

data/History.markdown

@@ -1,13 +1,20 @@
 ## HEAD
 
-### Major Enhancements
+## 0.5.0 / 2014-08-10
 
 ### Minor Enhancements
 
+  * Support `redirect_to` property (#32)
+  * Automatically prefix redirects with the `baseurl` or GitHub URL. (#26)
+
 ### Bug Fixes
 
+  * Remove unnecessary `Array#flatten` (#34)
+
 ### Development Fixes
 
+  * Use `be_truthy` instead of `be_true`. (#33)
+
 ## 0.4.0 / 2014-05-06
 
 ### Major Enhancements

data/README.md

@@ -83,6 +83,12 @@ title: My other awesome post
 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`.
+
 ## Contributing
 
 1. Fork it

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

@@ -11,10 +11,18 @@ module JekyllRedirectFrom
     def generate_alt_urls(site, list)
       list.each do |item|
         if has_alt_urls?(item)
-          alt_urls(item).flatten.each do |alt_url|
+          alt_urls(item).each do |alt_url|
             redirect_page = RedirectPage.new(site, site.source, "", "")
             redirect_page.data['permalink'] = alt_url
-            redirect_page.generate_redirect_content(item.url)
+            redirect_page.generate_redirect_content(redirect_url(site, item))
+            site.pages << redirect_page
+          end
+        end
+        if has_redirect_to_url?(item)
+          redirect_to_url(item).flatten.each do |alt_url|
+            redirect_page = RedirectPage.new(site, site.source, File.dirname(item.url), File.basename(item.url))
+            redirect_page.data['permalink'] = item.url
+            redirect_page.generate_redirect_content(alt_url)
             site.pages << redirect_page
           end
         end
@@ -30,5 +38,31 @@ module JekyllRedirectFrom
     def alt_urls(page_or_post)
       Array[page_or_post.data['redirect_from']].flatten
     end
+
+    def has_redirect_to_url?(page_or_post)
+      page_or_post.data.has_key?('redirect_to') &&
+        !alt_urls(page_or_post).nil? &&
+        !alt_urls(page_or_post).empty?
+    end
+
+    def redirect_to_url(page_or_post)
+      [Array[page_or_post.data['redirect_to']].flatten.first]
+    end
+
+    def redirect_url(site, item)
+      File.join redirect_prefix(site), item.url
+    end
+
+    def redirect_prefix(site)
+      config_github_url(site) || config_baseurl(site) || ""
+    end
+
+    def config_github_url(site)
+      site.config.fetch('github', Hash.new).fetch('url', nil)
+    end
+
+    def config_baseurl(site)
+      site.config.fetch('baseurl', nil)
+    end
   end
 end

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

@@ -1,3 +1,3 @@
 module JekyllRedirectFrom
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/fixtures/multiple_redirect_tos.md

@@ -0,0 +1,9 @@
+---
+title: I have lots of redirect to urls
+redirect_to:
+- https://www.jekyllrb.com
+- https://www.github.com
+- https://www.twitter.com
+---
+
+Lots of redirect to urls.

data/spec/fixtures/one_redirect_to.md

@@ -0,0 +1,6 @@
+---
+title: I am going somewhere else.
+redirect_to: https://www.github.com
+---
+
+Redirecting elsewhere.

data/spec/jekyll_redirect_from/redirect_page_spec.rb

@@ -58,7 +58,7 @@ describe JekyllRedirectFrom::RedirectPage do
     end
 
     it "is written to the proper location" do
-      expect(File.exist?(redirect_page_full_path)).to be_true
+      expect(File.exist?(redirect_page_full_path)).to be_truthy
     end
 
     it "writes the context we expect" do

data/spec/jekyll_redirect_from/redirector_spec.rb

@@ -1,13 +1,15 @@
 require "spec_helper"
 
 describe JekyllRedirectFrom::Redirector do
-  let(:redirector)       { described_class.new }
-  let(:post_to_redirect) { setup_post("2014-01-03-redirect-me-plz.md") }
-  let(:page_with_one)    { setup_page("one_redirect_url.md") }
-  let(:page_with_many)   { setup_page("multiple_redirect_urls.md") }
+  let(:redirector)                  { described_class.new }
+  let(:post_to_redirect)            { setup_post("2014-01-03-redirect-me-plz.md") }
+  let(:page_with_one)               { setup_page("one_redirect_url.md") }
+  let(:page_with_many)              { setup_page("multiple_redirect_urls.md") }
+  let(:page_with_one_redirect_to)   { setup_page("one_redirect_to.md") }
+  let(:page_with_many_redirect_to)  { setup_page("multiple_redirect_tos.md") }
 
   it "knows if a page or post is requesting a redirect page" do
-    expect(redirector.has_alt_urls?(post_to_redirect)).to be_true
+    expect(redirector.has_alt_urls?(post_to_redirect)).to be_truthy
   end
 
   it "handles one redirect path" do
@@ -18,24 +20,64 @@ describe JekyllRedirectFrom::Redirector do
     expect(redirector.alt_urls(page_with_many)).to eql(["help", "contact", "let-there/be/light-he-said", "/geepers/mccreepin"])
   end
 
+  it "handles a single redirect_to url" do
+    expect(redirector.redirect_to_url(page_with_one_redirect_to)).to eql(["https://www.github.com"])
+  end
+
+  it "handles a many redirect_to urls" do
+    expect(redirector.redirect_to_url(page_with_many_redirect_to)).to eql(["https://www.jekyllrb.com"])
+  end
+
   context "refresh page generation" do
-    before(:all) do
+    before(:each) do
       described_class.new.generate(@site)
     end
 
     it "generates the refresh page for the post properly" do
-      expect(destination_file_exists?("posts/23128432159832/mary-had-a-little-lamb")).to be_true
+      expect(destination_file_exists?("posts/23128432159832/mary-had-a-little-lamb")).to be_truthy
     end
 
     it "generates the refresh pages for the page with multiple redirect_from urls" do
-      expect(destination_file_exists?("help")).to be_true
-      expect(destination_file_exists?("contact")).to be_true
-      expect(destination_file_exists?("let-there/be/light-he-said")).to be_true
-      expect(destination_file_exists?("/geepers/mccreepin")).to be_true
+      expect(destination_file_exists?("help")).to be_truthy
+      expect(destination_file_exists?("contact")).to be_truthy
+      expect(destination_file_exists?("let-there/be/light-he-said")).to be_truthy
+      expect(destination_file_exists?("/geepers/mccreepin")).to be_truthy
     end
 
     it "generates the refresh page for the page with one redirect_from url" do
-      expect(destination_file_exists?("mencius/was/my/father")).to be_true
+      expect(destination_file_exists?("mencius/was/my/father")).to be_truthy
+    end
+
+    it "generates the refresh page for the page with one redirect_to url" do
+      expect(destination_file_exists?("one_redirect_to.html")).to be_truthy
+      expect(destination_file_contents("one_redirect_to.html")).to include(%|<meta http-equiv=refresh content="0; url=https://www.github.com">|)
+    end
+
+    it "generates the refresh page for the page with multiple redirect_to urls" do
+      expect(destination_file_exists?("multiple_redirect_tos.html")).to be_truthy
+      expect(destination_file_contents("multiple_redirect_tos.html")).to include(%|<meta http-equiv=refresh content="0; url=https://www.jekyllrb.com">|)
+    end
+  end
+
+  context "prefix" do
+    it "uses site.github.url as the redirect prefix" do
+      @site.config['github'] = { "url" => "http://example.github.io/test" }
+      expect(redirector.redirect_url(@site, page_with_one)).to start_with("http://example.github.io/test")
+    end
+
+    it "uses site.baseurl as the redirect prefix when site.github.url is not set" do
+      @site.config['baseurl'] = "/fancy/prefix"
+      expect(redirector.redirect_url(@site, page_with_one)).to start_with("/fancy/prefix")
+    end
+
+    it "prefers site.github.url over site.baseurl" do
+      @site.config['github'] = { "url" => "http://example.github.io/test" }
+      @site.config['baseurl'] = "/fancy/baseurl"
+      expect(redirector.redirect_url(@site, page_with_one)).to start_with("http://example.github.io/test")
+    end
+    
+    it "no-ops when site.github.url and site.baseurl are not set" do
+      expect(redirector.redirect_url(@site, page_with_one)).to eql("/one_redirect_url.html")
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ require "jekyll"
 require File.expand_path("lib/jekyll-redirect-from.rb")
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'
@@ -11,7 +10,7 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
-  config.before(:all) do
+  config.before(:each) do
     Jekyll.logger.log_level = :error
 
     @fixtures_path = Pathname.new(__FILE__).parent.join("fixtures")
@@ -30,7 +29,7 @@ RSpec.configure do |config|
     @site.process
   end
 
-  config.after(:all) do
+  config.after(:each) do
     @dest.rmtree if @dest.exist?
   end
 
@@ -46,6 +45,10 @@ RSpec.configure do |config|
     File.exists?(File.join(@dest.to_s, file))
   end
 
+  def destination_file_contents(file)
+    File.read(File.join(@dest.to_s, file))
+  end
+
   def new_redirect_page(permalink)
     page = JekyllRedirectFrom::RedirectPage.new(@site, @site.source, "", "")
     page.data['permalink'] = permalink

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-redirect-from
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -91,7 +91,9 @@ files:
 - script/release
 - spec/fixtures/_config.yml
 - spec/fixtures/_posts/2014-01-03-redirect-me-plz.md
+- spec/fixtures/multiple_redirect_tos.md
 - spec/fixtures/multiple_redirect_urls.md
+- spec/fixtures/one_redirect_to.md
 - spec/fixtures/one_redirect_url.md
 - spec/jekyll_redirect_from/redirect_page_spec.rb
 - spec/jekyll_redirect_from/redirector_spec.rb
@@ -123,7 +125,9 @@ summary: Seamlessly specify multiple redirection URLs for your pages and posts
 test_files:
 - spec/fixtures/_config.yml
 - spec/fixtures/_posts/2014-01-03-redirect-me-plz.md
+- spec/fixtures/multiple_redirect_tos.md
 - spec/fixtures/multiple_redirect_urls.md
+- spec/fixtures/one_redirect_to.md
 - spec/fixtures/one_redirect_url.md
 - spec/jekyll_redirect_from/redirect_page_spec.rb
 - spec/jekyll_redirect_from/redirector_spec.rb