middleman-alias 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ecd02c745ef27ba02d7fcdfc20362fcc0ba2f5d
+  data.tar.gz: c703d3d75754481b339f8aeb47048d596eff3529
+SHA512:
+  metadata.gz: 24d174defd0c85ef813cf3d77008b1be2412cf4aab79142e6536fead7694f53ee4bf9f15649a49b4287176ea4cc1e56a7b0f20f9b859e3bc7d04247f8135f669
+  data.tar.gz: 5d7c9cc77e980586246cd5aac02811ba1b7734441b72c89895f9ce9bf285f230d34bd1d58ba0073b6efb02452b0757e3256749259439c1380372c85ef8865403

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeremy Green
+
+MIT License
+
+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,56 @@
+# Middleman::Alias
+
+Add alias/redirect information to your middleman pages and posts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'middleman-alias'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-alias
+
+## Usage
+
+First you need to activate the module in your `config.rb`.
+
+```
+activate :alias
+```
+
+Then you need to generate the template that will handle the aliases.
+You only need to do this one time.
+
+```
+middleman alias_template
+```
+
+Then you can add an `alias` to the frontmatter for a page or post and
+middleman-alias will generate a SEO friendly redirect page at that
+location.
+
+Say that you have a page at `/foo.html`, but that the page used to live
+at `/old-foo.html`.  In the frontmatter for `foo.html` you can alias it
+to the old address.
+
+```
+title : "A post about foo"
+alias : /old-foo.html
+```
+
+Now someone can visit your middleman site at `/old-foo.html` and they'll
+be redirected to `/foo.html`.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/middleman-alias/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/features/alias.feature

@@ -0,0 +1,5 @@
+Feature: Aliases
+  Scenario: Aliases should generate redirect pages
+    Given the Server is running at "alias-app"
+    When I go to "/foo.html"
+    Then I should see "You are being redirected"

data/features/generator_cli.feature

@@ -0,0 +1,7 @@
+Feature: Template generator CLI command
+ Scenario: Create a new alias template with the command line
+   Given a fixture app "empty-alias-app"
+   And I run `middleman alias_template`
+   Then the exit status should be 0
+   Then the following files should exist:
+     | source/alias.html.erb |

data/features/support/env.rb

@@ -0,0 +1,7 @@
+ENV["TEST"] = "true"
+ENV["AUTOLOAD_SPROCKETS"] = "false"
+
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-alias')

data/fixtures/alias-app/config.rb

@@ -0,0 +1,2 @@
+activate :alias
+#redirect "foo.html", :to => "bar.html"

data/fixtures/alias-app/source/alias.html.erb

@@ -0,0 +1,3 @@
+<meta http-equiv="refresh" content="0; url=<%= destination %>">
+<link rel="canonical" href="<%= destination %>" />
+<%= link_to "You are being redirected.", destination %>

data/fixtures/alias-app/source/bar.html.erb

@@ -0,0 +1,6 @@
+--- 
+title: "Bar"
+alias: foo.html
+---
+
+This is the bar page.

data/fixtures/alias-app/source/layout.html.erb

@@ -0,0 +1,8 @@
+<!doctype html>
+<html>
+  <head>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/fixtures/empty-alias-app/config.rb

@@ -0,0 +1 @@
+activate :alias

data/lib/middleman-alias/commands.rb

@@ -0,0 +1,33 @@
+require 'middleman-core/cli'
+
+module Middleman
+  module Cli
+    # This class provides an "article" command for the middleman CLI.
+    class AliasGenerator < Thor
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :alias_template
+
+      def self.source_root
+        ENV['MM_ROOT']
+      end
+
+      # Tell Thor to exit with a nonzero exit code on failure
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "alias_template", "Create a new template to handle alias redirects"
+      
+      def alias_template
+        source_root = ENV['MM_ROOT']
+        template_sub_path = "source/alias.html.erb"
+        template_filename = "#{source_root}/#{template_sub_path}"
+        FileUtils.cp "#{File.dirname(__FILE__)}/template/source/alias.html.erb", template_filename
+        puts "Alias template generated in #{template_sub_path}"
+      end
+    end
+  end
+end

data/lib/middleman-alias/extension.rb

@@ -0,0 +1,25 @@
+require 'middleman-core'
+
+module Middleman
+  class AliasExtension < Middleman::Extension
+    def initialize(app, options_hash={}, &block)
+      super
+    end
+
+    def manipulate_resource_list(resources)
+      resources.each do |resource|
+        if resource.data["alias"]
+          redirect = Sitemap::Resource.new(@app.sitemap, resource.data["alias"]).tap do |p|
+            p.proxy_to("alias.html")
+            p.add_metadata locals: {
+              destination: resource.destination_path
+            }
+          end
+          resources.push redirect
+        end
+      end
+      resources
+    end
+
+  end
+end

data/lib/middleman-alias/template/source/alias.html.erb

@@ -0,0 +1,4 @@
+<meta http-equiv="refresh" content="0; url=<%= destination %>">
+<link rel="canonical" href="<%= destination %>" />
+<%= link_to "You are being redirected.", destination %>
+

data/lib/middleman-alias/version.rb

@@ -0,0 +1,3 @@
+module MiddlemanAlias
+  VERSION = "0.0.1"
+end

data/lib/middleman-alias.rb

@@ -0,0 +1,14 @@
+require 'middleman-core'
+require "middleman-alias/version"
+require "middleman-alias/commands"
+
+::Middleman::Extensions.register(:alias) do
+  require 'middleman-alias/extension'
+  ::Middleman::AliasExtension
+end
+
+#module Middleman
+  #module Alias
+    ## Your code goes here...
+  #end
+#end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-alias"

data/middleman-alias.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-alias/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-alias"
+  spec.version       = MiddlemanAlias::VERSION
+  spec.authors       = ["Jeremy Green"]
+  spec.email         = ["jeremy@octolabs.com"]
+  spec.summary       = %q{Redirects for Middleman that are friendly to the Googles.}
+  spec.description   = %q{Redirects for Middleman that are friendly to the Googles.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "middleman-core", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "cucumber", "~> 1.3.10"
+  spec.add_development_dependency "aruba",    "~> 0.5.1"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: middleman-alias
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Green
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: Redirects for Middleman that are friendly to the Googles.
+email:
+- jeremy@octolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/alias.feature
+- features/generator_cli.feature
+- features/support/env.rb
+- fixtures/alias-app/config.rb
+- fixtures/alias-app/source/alias.html.erb
+- fixtures/alias-app/source/bar.html.erb
+- fixtures/alias-app/source/layout.html.erb
+- fixtures/empty-alias-app/config.rb
+- fixtures/empty-alias-app/source/.gitkeep
+- lib/middleman-alias.rb
+- lib/middleman-alias/commands.rb
+- lib/middleman-alias/extension.rb
+- lib/middleman-alias/template/source/alias.html.erb
+- lib/middleman-alias/version.rb
+- lib/middleman_extension.rb
+- middleman-alias.gemspec
+homepage: ''
+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.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Redirects for Middleman that are friendly to the Googles.
+test_files:
+- features/alias.feature
+- features/generator_cli.feature
+- features/support/env.rb