jekyll-migrate-permalink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9aa3e159978a144363692cb37c043400820b1aaf
+  data.tar.gz: 551ad25d8bd6fdda11bcbdff51e1f3d0e2d09ba0
+SHA512:
+  metadata.gz: 5a2463d4a9768ab3c57464084a1e0ee024d66cdc0979c3d06de567b199c70fd872cdd689f13194a6cc74d7e01676215669b123bfe1090115fba75fb390b78583
+  data.tar.gz: f769390180c7f7b2318fd11001c6f401ea292953d7f94cf6acbf2f5ba6592905a8cac1cf671a60d0347e1446b3a1d1667fc48de41489d91ab1eb47d65d034e2c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Max Chadwick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# jekyll-migrate-permalink
+
+### What Is This?
+
+`jekyll-migrate-permalink` is a plugin that aims to make your life easier if you're considering changing your [permalink](https://jekyllrb.com/docs/permalinks/). I got the idea for this plugin as I was considering a switch from `/blog/:title` to `/title`.
+
+A change to your permalink means that any backlinks to your site will break. You have a few options...
+
+- Redirect all old URLs to the new permalinks.
+- Continue serving old content at your old URL and only use the new permalink style for new content
+
+`jekyll-migrate-permalink` can help you with either approach.
+
+### Redirect all old URLs to the new permalink
+
+The [`jekyll-redirect-from`](https://github.com/jekyll/jekyll-redirect-from) plugin is [available on GitHub pages](https://pages.github.com/versions/) can be used to for creating redirects. However, to do this you need to update your front matter with a `redirect_from` specifying the old URL. `jekyll-migrate-permalink` makes this process painless.
+
+1. Before changing your permalink style in `_config.yml` run `jekyll migrate-permalink`. The front matter will be updated on all your posts with a `redirect_from` referencing your post's current URL.
+2. Update your permalink in `_config.yml`
+3. Build your site!
+
+### Continue serving old content at old URLs
+
+`jekyll-migrate-plugin` can also help with this approach. Again, it's painless
+
+1. Before changing your permalink style in `_config.yml` run `jekyll migrate-permalink --strategy retain`. The front matter will be updated on all your posts with a `permalink` referencing your current post's URL.
+2. Update your permalink in `_config.yml`
+3. Build your site!
+
+### Caveats
+
+Note that the plugin loads the front matter as YAML in order to safely manipulate, and then converts it back to a string. This process may result in some slight formatting changes to your front matter.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/migrate/permalink"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-migrate-permalink.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/migrate/permalink/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-migrate-permalink"
+  spec.version       = Jekyll::Migrate::Permalink::VERSION
+  spec.authors       = ["Max Chadwick"]
+  spec.email         = ["mpchadwick@gmail.com"]
+
+  spec.summary       = %q{A custom Jekyll command to help deal with side effects of changing your permalink}
+  spec.homepage      = "https://github.com/mpchadwick/jekyll-migrate-permalink"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/jekyll/commands/migrate_permalink.rb

@@ -0,0 +1,54 @@
+module Jekyll
+  module Commands
+    class MigratePermalinks < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:"migrate-permalink") do |c|
+            c.description "Migrate your permalinks"
+            c.option "strategy", "-s", "--strategy STRATEGY", "Strategy"
+
+            add_build_options(c)
+
+            c.action do |args, opts|
+              opts["serving"] = false
+              Jekyll::Commands::MigratePermalinks.process(args, opts)
+            end
+          end
+        end
+
+        def process(args, opts)
+          Jekyll.logger.adjust_verbosity(opts)
+          options = configuration_from_options(opts)
+          site = Jekyll::Site.new(options)
+
+          site.reset
+          site.read
+
+          site.posts.docs.each do |post|
+            content = File.read(post.path, Utils.merged_file_read_opts(site, options))
+            if content =~ Document::YAML_FRONT_MATTER_REGEXP
+              content = $POSTMATCH
+              frontmatter = SafeYAML.load(Regexp.last_match(1))
+            end
+
+            if opts["strategy"] == "retain"
+              frontmatter["permalink"] = post.url
+            else
+              if frontmatter["redirect_from"].is_a? Array
+                frontmatter["redirect_from"].push(post.url)
+              else
+                frontmatter["redirect_from"] = [post.url]
+              end
+            end
+
+            output = "#{frontmatter.to_yaml}---\n\n#{content}"
+            File.write(post.path, output, :mode => "w")
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/jekyll/migrate/permalink/version.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module Migrate
+    module Permalink
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/jekyll/migrate/permalink.rb

@@ -0,0 +1,11 @@
+require "jekyll/migrate/permalink/version"
+
+module Jekyll
+  module Migrate
+    module Permalink
+      # Your code goes here...
+    end
+  end
+end
+
+require "jekyll/commands/migrate_permalink"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-migrate-permalink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Chadwick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- mpchadwick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-migrate-permalink.gemspec
+- lib/jekyll/commands/migrate_permalink.rb
+- lib/jekyll/migrate/permalink.rb
+- lib/jekyll/migrate/permalink/version.rb
+homepage: https://github.com/mpchadwick/jekyll-migrate-permalink
+licenses:
+- MIT
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: A custom Jekyll command to help deal with side effects of changing your permalink
+test_files: []