nanoc-redirector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9af124d8b7a32fd875577a066429214faf9d78c7
+  data.tar.gz: 6a4442383d789bacce4ff049cbcce9c9c095cce7
+SHA512:
+  metadata.gz: 203cf8a015375f9449a9b7f50eb77fb2257b9bf2b1445a8c64787732960d6a0b778f275c2104ae4e9c8cf7f0f3d5485654cdb1a1741602df456346e1432edebb
+  data.tar.gz: 8156759b947c00ff710ecbe0b8df6786cb93ea44add4ddd3b1ed9e49cad315a53e4e4c2be51700c70bff77702f70eaa628568e7049c7582e6c9424e3e3cc5a9f

data/.gitignore

@@ -0,0 +1,30 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin
+
+Gemfile.lock
+out/
+sample.rb
+run_sample.rb
+src/
+docs/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.DS_Store
+
+test/fixtures/output
+test/fixtures/tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.2
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+sudo: false
+cache: bundler
+
+git:
+  depth: 10

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nanoc-redirector.gemspec
+gemspec

data/README.md

@@ -0,0 +1,88 @@
+# Nanoc-Redirector
+
+This plugin implements client-side redirects _from_ and _to_ other generated pages. It's pretty close in functionality to Jekyll's [redirect-from](https://github.com/jekyll/jekyll-redirect-from) plugin.
+
+Redirects are performed by serving an HTML file with an HTTP-REFRESH meta
+tag which points to your destination. No `.htaccess` file, nginx conf, xml
+file, or anything else will be generated. It simply creates HTML files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nanoc-redirector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nanoc-redirector
+
+## Usage
+
+The object of this gem is to allow an author to specify multiple URLs for a
+page, such that the alternative URLs redirect to the new URL.
+
+To use it, simply add a string or array to the YAML front-matter of your page:
+
+### Redirect From
+
+``` yaml
+title: My amazing post
+redirect_from:
+  - /post/123456789/
+  - /post/123456789/my-amazing-post/
+```
+
+For example, this frontmatter will generate two pages in the following destinations:
+
+```
+/post/123456789/
+/post/123456789/my-amazing-post/
+```
+
+Each will point to wherever `My amazing post` is routed to.
+
+You can also specify just one url like this:
+
+```text
+title: My other awesome post
+redirect_from: /post/123456798/
+```
+
+You can implement this functionality by calling `NanocRedirector::RedirectFrom.process` anywhere in your Rules file. You must pass in the item to redirect to, as well as its destination. For example:
+
+``` ruby
+postprocess do
+  REPS.each do |rep|
+    @items.each do |item|
+      NanocRedirector::RedirectFrom.process(item, item.path(rep: rep))
+    end
+  end
+end
+```
+
+### Redirect To filter
+
+Sometimes, you may want to redirect a site page to a totally different website. This plugin also supports that with the `redirect_to` key:
+
+``` yaml
+title: My amazing post
+redirect_to:
+  - http://www.github.com
+```
+
+If you have multiple `redirect_to`s set, only the first one will be respected.
+
+You can implement this functionality by adding a filter to your compile step:
+
+``` ruby
+compile '/**/*.md' do
+  filter :redirect_to, { :redirect_to => @item[:redirect_to] }
+  layout '/default.*'
+end
+```

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: [:test]

data/lib/nanoc-redirector.rb

@@ -0,0 +1,45 @@
+require 'redirect-to-filter'
+require 'version'
+
+module NanocRedirector
+  module RedirectFrom
+    def self.process(item, dest)
+      return if item[:redirect_from].nil?
+      return if dest.nil?
+      redirect_hash = {}
+
+      key = item.identifier.without_ext
+      value = item[:redirect_from].is_a?(String) ? [item[:redirect_from]] : item[:redirect_from]
+
+      redirect_hash[key] = value
+
+      redirect_hash.values.each do |redirects|
+        redirects.each do |redirect|
+          content = NanocRedirector.redirect_template(dest)
+          dir = "output/#{redirect}"
+          unless File.directory?(dir)
+            FileUtils.mkdir_p(dir)
+            File.write("#{dir}/index.html", content)
+          end
+        end
+      end
+    end
+  end
+
+  def self.redirect_template(item_url)
+    <<-EOF
+<!DOCTYPE html>
+<html>
+<head>
+<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>
+</body>
+</html>
+EOF
+  end
+end

data/lib/redirect-to-filter.rb

@@ -0,0 +1,9 @@
+class RedirectToFilter < Nanoc::Filter
+  identifier :redirect_to
+  type :text
+
+  def run(content, params = {})
+    return content unless params[:redirect_to]
+    NanocRedirector.redirect_template(params[:redirect_to])
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module NanocRedirector
+  VERSION = '0.1.0'
+end

data/nanoc-redirector.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nanoc-redirector'
+  spec.version       = NanocRedirector::VERSION
+  spec.authors       = %w(Garen Torikian)
+  spec.email         = %w(gjtorikian@gmail.com)
+
+  spec.summary       = %w(Allows you to generate redirects to and from an item.)
+  spec.homepage      = 'https://www.github.com/gjtorikian/nanoc-redirector'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'nanoc', '4.1.0rc1'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'awesome_print'
+end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+bundle install "$@"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-redirector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen
+- Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.0rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.0rc1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/nanoc-redirector.rb
+- lib/redirect-to-filter.rb
+- lib/version.rb
+- nanoc-redirector.gemspec
+- script/bootstrap
+homepage: https://www.github.com/gjtorikian/nanoc-redirector
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: '["Allows", "you", "to", "generate", "redirects", "to", "and", "from", "an",
+  "item."]'
+test_files: []