jekyll-redirect-from 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8fa3fc03dd67c563c6018790133a100fcc0f04912859e8622efb6762116fc08
-  data.tar.gz: fce8c765fea3f6f17ae338fee50ce01331c91cc1f083f26d4294681b709972eb
+  metadata.gz: aaa57b2c808238484878ca1bf88007e53d33913ebaf9dd17d8f8adbfa306c49a
+  data.tar.gz: 82bf36aaf666d402f9d0c8058cfd92b77bfb15170de288cb82d0eddc2b512c90
 SHA512:
-  metadata.gz: 217696213cdf50a1f85dc636ced9efa29dd80567837989a00c87b7f68add82c84a74eb2319a547e3f04612b04eb8731685490d79a334ac85121fb78063d791fe
-  data.tar.gz: 01044dde063223161451b32fd6a4fa56cc17451eae306b88065f56a72e21b5f8f3b63f10fb0aba19bc7a6856e20b84d9fcad9ad920f7c7bc500e15ba70950c0a
+  metadata.gz: 2482574aba0bf20ebee0a17757a0bd1f967bfb70c0ddd0a8a4168d7da2105e7bf6763528ff15bdb1aca90ae7bfc068dc222ea4f1918e005f2805743d891f0cb1
+  data.tar.gz: 57dda6d4f263907a82f17baa9b9657cf33343c3f941f033c56563c8cf6f698445f4f691254422a59f948dc0b384b1a91d78e0b17106feb664a5393c95b23587a

data/.gitignore

@@ -17,3 +17,4 @@ spec/fixtures/.jekyll-cache
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle

data/.rubocop.yml

@@ -6,6 +6,6 @@ inherit_gem:
   rubocop-jekyll: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Exclude:
     - vendor/**/*

data/.travis.yml

@@ -12,7 +12,7 @@ matrix:
       rvm: 2.5.3
       env: GH_PAGES=true
     - rvm: *latest_ruby
-      env: JEKYLL_VERSION=">= 4.0.0.pre.alpha1"
+      env: JEKYLL_VERSION="~> 4.0"
 
 before_install:
 - gem update --system

data/History.markdown

@@ -1,3 +1,23 @@
+## 0.16.0 / 2020-01-26
+
+### Minor Enhancements
+
+  * Allows generation of `redirects.json` to be disabled (#207)
+  * Allow redirects from and for subclasses of page and document (#204)
+
+### Bug Fixes
+
+  * Use `Hash#key?` instead of `Hash#keys.any?` (#201)
+
+### Development Fixes
+
+  * Target Ruby 2.4
+  * Stop testing with backwards-compatible site config (#211)
+
+### Documentation
+
+  * Simplifies YAML for `redirect_to` (#185)
+
 ## 0.15.0 / 2019-03-23
 
 ### Development Fixes

data/README.md

@@ -113,13 +113,9 @@ Sometimes, you may want to redirect a site page to a totally different website.
 
 ```yaml
 title: My amazing post
-redirect_to:
-  - http://www.github.com
+redirect_to: http://www.github.com
 ```
 
-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
@@ -131,6 +127,19 @@ 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
 
+## Configuration
+
+You can configure this plugin in `_config.yml` by adding to the `redirect_from` key.
+
+### Disabling `redirects.json`
+
+By default, a file called `redirects.json`, which can be used for automated testing or to implement server-side redirects, will be included in the output. To exclude it from the output, set the `json` key to `false`:
+
+```yml
+redirect_from:
+  json: false
+```
+
 ## Contributing
 
 1. Fork it

data/jekyll-redirect-from.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
   spec.add_runtime_dependency "jekyll", ">= 3.3", "< 5.0"
 
@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   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-jekyll", "~> 0.4"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.10"
 end

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

@@ -10,19 +10,19 @@ module JekyllRedirectFrom
       @redirects = {}
 
       # Inject our layout, unless the user has already specified a redirect layout'
-      unless site.layouts.keys.any? { |name| name == "redirect" }
+      unless site.layouts.key?("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)
+        next unless redirectable_document?(doc)
 
         generate_redirect_from(doc)
         generate_redirect_to(doc)
       end
 
-      generate_redirects_json
+      generate_redirects_json if generate_redirects_json?
     end
 
     private
@@ -53,5 +53,13 @@ module JekyllRedirectFrom
       page.data["layout"] = nil
       site.pages << page
     end
+
+    def redirectable_document?(doc)
+      doc.is_a?(Jekyll::Document) || doc.is_a?(Jekyll::Page)
+    end
+
+    def generate_redirects_json?
+      site.config.dig("redirect_from", "json") != false
+    end
   end
 end

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

@@ -49,7 +49,7 @@ module JekyllRedirectFrom
         "permalink" => from,
         "redirect"  => {
           "from" => from,
-          "to"   => to =~ %r!^https?://! ? to : absolute_url(to),
+          "to"   => %r!^https?://!.match?(to) ? to : absolute_url(to),
         }
       )
     end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllRedirectFrom
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

data/spec/jekyll_redirect_from/generator_spec.rb

@@ -94,7 +94,7 @@ RSpec.describe JekyllRedirectFrom::Generator do
     let(:redirects) { JSON.parse(contents) }
     let(:domain) { "http://jekyllrb.com" }
 
-    it "creates the redirets file" do
+    it "creates the redirects file" do
       expect(path).to exist
     end
 
@@ -140,10 +140,32 @@ RSpec.describe JekyllRedirectFrom::Generator do
         FileUtils.rm_f source_path
       end
 
-      it "doesn't overwrite redirets.json" do
+      it "doesn't overwrite redirects.json" do
         expect(path).to exist
         expect(redirects).to eql("foo" => "bar")
       end
     end
+
+    context "when explicitly disabled" do
+      let(:site) { Jekyll::Site.new(config.merge("redirect_from" => { "json" => false })) }
+
+      it "does not create the redirects file" do
+        expect(path).to_not exist
+      end
+    end
+  end
+
+  context "redirectable_document?" do
+    let(:generator) { JekyllRedirectFrom::Generator.new }
+
+    it "accepts subclasses of Jekyll::Document" do
+      SubclassOfJekyllDocument = Class.new(Jekyll::Document) { define_method(:initialize) {} }
+      expect(generator.send(:redirectable_document?, SubclassOfJekyllDocument.new)).to be_truthy
+    end
+
+    it "accepts subclasses of Jekyll::Page" do
+      SubclassOfJekyllPage = Class.new(Jekyll::Page) { define_method(:initialize) {} }
+      expect(generator.send(:redirectable_document?, SubclassOfJekyllPage.new)).to be_truthy
+    end
   end
 end

data/spec/spec_helper.rb

@@ -42,7 +42,7 @@ RSpec.configure do |config|
         "authors"  => {},
       },
       "url"         => "http://jekyllrb.com",
-      "gems"        => [
+      "plugins"     => [
         "jekyll-redirect-from",
         "jekyll-sitemap",
       ],
@@ -50,7 +50,7 @@ RSpec.configure do |config|
         "scope"  => { "path" => "" },
         "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.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-23 00:00:00.000000000 Z
+date: 2020-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.10'
 description: 
 email:
 - parkrmoore@gmail.com
@@ -163,14 +163,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Seamlessly specify multiple redirection URLs for your pages and posts