jekyll-absolute-links 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56c531a208572d758809283df820b25555ce3901
+  data.tar.gz: c5ff0606703f9493027451de65aa6902bea0a144
+SHA512:
+  metadata.gz: 17bed3637a0d412a36159afcf00676a528164d1df29aa2d0e125c62d0c8115867796733447f54ad61637394eece136b59b9b3d58742848a187ee1c03b05713a4
+  data.tar.gz: ebda7c60e74c4e9424d7b37cd865637112197ac160e2af77db97850fe688024b4aa1ebed4da2bddfd134ecda62755be7c815905172e00084f92ce93b0bde4139

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/dest/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Session.vim
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--tty

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jose Miguel Venegas Mendoza
+
+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,59 @@
+# Jekyll Absolute Links
+
+Absolute link converter for Jekyll sites. Crawls the generated HTML and XML
+files in search of relative links and transform them to absolute links by
+prepending the site domain.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem "jekyll-absolute-links"
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install jekyll-absolute-links
+```
+
+Finally add this line to `gems` section in your `_config.yml` file:
+
+```yaml
+gems:
+  - jekyll-absolute-links
+```
+
+## Usage
+
+There's really nothing more to do. Links will be transformed automatically for
+production site only.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rukbotto/jekyll-absolute-links.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-absolute-links.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/jekyll-absolute-links/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name      = "jekyll-absolute-links"
+  spec.version   = JekyllAbsoluteLinks::VERSION
+  spec.authors   = ["Jose Miguel Venegas Mendoza"]
+  spec.email     = ["jvenegasmendoza@gmail.com"]
+  spec.homepage  = "https://github.com/rukbotto/jekyll-absolute-links"
+  spec.license   = "MIT"
+
+  spec.summary       = "Absolute link converter for Jekyll sites."
+  spec.description   = <<-DESCRIPTION
+    Absolute link converter for Jekyll sites. Crawls the generated HTML and XML
+    files in search of relative links and transform them to absolute links by
+    prepending the site domain.
+  DESCRIPTION
+
+  spec.files         = `git ls-files`.split("\n")
+  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("jekyll", "~> 3.3")
+
+  spec.add_development_dependency("bundler", "~> 1.14")
+  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("rspec", "~> 3.0")
+end

data/lib/jekyll-absolute-links.rb

@@ -0,0 +1,2 @@
+require "jekyll"
+require "jekyll-absolute-links/crawler"

data/lib/jekyll-absolute-links/crawler.rb

@@ -0,0 +1,24 @@
+module JekyllAbsoluteLinks
+  class Crawler
+    @regexp = %r{("|&quot;|>)(/[\w/.-]*)("|&quot;|<)}
+
+    Jekyll::Hooks.register :posts, :post_render do |post|
+      next if Jekyll::env == "development"
+      transform(post.output, @regexp, post.site.config["url"])
+    end
+
+    Jekyll::Hooks.register :pages, :post_render do |page|
+      next if Jekyll::env == "development"
+      transform(page.output, @regexp, page.site.config["url"])
+    end
+
+    class << self
+      private
+      def transform(output, regexp, site_url)
+        output.gsub!(regexp) do |match|
+          match.gsub($2, "#{site_url}#{$2}".sub(%r{(\w)/+}, "\\1/"))
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-absolute-links/version.rb

@@ -0,0 +1,3 @@
+module JekyllAbsoluteLinks
+  VERSION = "0.1.0"
+end

data/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll-absolute-links"
+
+# 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(__FILE__)

data/script/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/spec/crawler_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+
+describe(JekyllAbsoluteLinks::Crawler) do
+  let(:overrides) { Hash.new }
+  let(:site_config) do
+    Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
+      "source" => File.expand_path("../fixtures/absolute-links", __FILE__),
+      "destination" => File.expand_path("../dest", __FILE__)
+    }, overrides))
+  end
+  let(:site) { Jekyll::Site.new(site_config) }
+
+  before(:each) do
+    site.process
+  end
+
+  context("When development environment is active") do
+    describe("Crawler") do
+      it("performs no link transformation on posts") do
+        url = "\"/posts/curabitur-sed-condimentum-enim/\""
+        expect(site.posts[0].output).to include(url)
+      end
+
+      it("performs no link transformation on pages") do
+        url = "\"/posts/lorem-ipsum-dolor-sit-amet/\""
+        expect(site.pages[1].output).to include(url)
+      end
+
+      it("performs no link transformation on feeds") do
+        url = ">/posts/lorem-ipsum-dolor-sit-amet/<"
+        expect(site.pages[0].output).to include(url)
+      end
+
+      it("performs no encoded link transformation on feeds") do
+        url = "&quot;/posts/lorem-ipsum-dolor-sit-amet/&quot;"
+        expect(site.pages[0].output).to include(url)
+      end
+    end
+  end
+
+  context("When production environment is active") do
+    around(:each) do |example|
+      ENV["JEKYLL_ENV"] = "production"
+      example.run
+    end
+
+    describe("Crawler") do
+      it("transforms relative urls to absolute urls on posts") do
+        url = "\"http://example.com/posts/curabitur-sed-condimentum-enim/\""
+        expect(site.posts[0].output).to include(url)
+      end
+
+      it("transforms relative urls to absolute urls on pages") do
+        url = "\"http://example.com/posts/lorem-ipsum-dolor-sit-amet/\""
+        expect(site.pages[1].output).to include(url)
+      end
+
+      it("transforms relative urls to absolute urls on feeds") do
+        url = ">http://example.com/posts/lorem-ipsum-dolor-sit-amet/<"
+        expect(site.pages[0].output).to include(url)
+      end
+
+      it("transforms relative encoded urls to absolute urls on feeds") do
+        url = "&quot;http://example.com/posts/lorem-ipsum-dolor-sit-amet/&quot;"
+        expect(site.pages[0].output).to include(url)
+      end
+    end
+
+    context("And site domain has a trailing slash") do
+      let(:overrides) do
+        {
+          "url" => "http://example.com/"
+        }
+      end
+
+      describe("Crawler") do
+        it("Removes duplicate slashes from urls on posts") do
+          url = "\"http://example.com/posts/curabitur-sed-condimentum-enim/\""
+          expect(site.posts[0].output).to include(url)
+        end
+
+        it("Removes duplicate slashes from urls on pages") do
+          url = "\"http://example.com/posts/lorem-ipsum-dolor-sit-amet/\""
+          expect(site.pages[1].output).to include(url)
+        end
+
+        it("Removes duplicate slashes from urls on feeds") do
+          url = ">http://example.com/posts/lorem-ipsum-dolor-sit-amet/<"
+          expect(site.pages[0].output).to include(url)
+        end
+
+        it("Removes duplicate slashes from encoded urls on feeds") do
+          url = "&quot;http://example.com/posts/lorem-ipsum-dolor-sit-amet/&quot;"
+          expect(site.pages[0].output).to include(url)
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/absolute-links/_config.yml

@@ -0,0 +1,15 @@
+url: http://example.com
+
+defaults:
+  - scope:
+      path: ""
+      type: posts
+    values:
+      layout: default
+      permalink: /posts/:title/
+
+  - scope:
+      path: ""
+      type: pages
+    values:
+      layout: default

data/spec/fixtures/absolute-links/_layouts/default.html

@@ -0,0 +1,11 @@
+---
+---
+<html>
+  <head>
+    <title>{{ page.title }}</title>
+    <meta name="description" content="{{ page.excerpt | strip_html }}">
+  </head>
+  <body>
+    {{ content }}
+  </body>
+</html>

data/spec/fixtures/absolute-links/_posts/2001-01-01-lorem-ipsum-dolor-sit-amet.md

@@ -0,0 +1,11 @@
+---
+title: Lorem ipsum dolor sit amet
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis vitae imperdiet
+magna. Maecenas suscipit quis nisi vel cursus. In hac habitasse platea
+dictumst. Sed a mi eu magna semper porta. Donec mollis, leo sit amet elementum
+egestas, est nibh euismod mauris, quis molestie libero ex in erat. [Curabitur
+sed condimentum enim][link]
+
+[link]: /posts/curabitur-sed-condimentum-enim/

data/spec/fixtures/absolute-links/_posts/2001-01-02-curabitur-sed-condimentum-enim.md

@@ -0,0 +1,11 @@
+---
+title: Curabitur sed condimentum enim
+---
+
+Curabitur sed condimentum enim. Integer ut velit vitae ante facilisis
+consequat. Nullam egestas ipsum sit amet nibh ornare, non consequat massa
+dictum. Fusce porttitor iaculis velit elementum feugiat. Lorem ipsum dolor sit
+amet, consectetur adipiscing elit. Morbi nisi tortor, aliquet et eros id,
+cursus tincidunt sapien. [Lorem ipsum dolor sit amet][link]
+
+[link]: /posts/lorem-ipsum-dolor-sit-amet/

data/spec/fixtures/absolute-links/feed.xml

@@ -0,0 +1,31 @@
+---
+layout: null
+permalink: /feed.xml
+---
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title>{{ "Feed" | xml_escape }}</title>
+    <description>{{ "Feed" | xml_escape }}</description>
+    <link>/</link>
+    <atom:link href="{{ page.url }}" rel="self" type="application/rss+xml"/>
+    <pubDate>{{ site.time | date_to_rfc822 }}</pubDate>
+    <lastBuildDate>{{ site.time | date_to_rfc822 }}</lastBuildDate>
+    <generator>Jekyll v{{ jekyll.version }}</generator>
+    {% for post in site.posts limit:10 %}
+      <item>
+        <title>{{ post.title | xml_escape }}</title>
+        <description>{{ post.excerpt | xml_escape }}</description>
+        <pubDate>{{ post.date | date_to_rfc822 }}</pubDate>
+        <link>{{ post.url }}</link>
+        <guid isPermaLink="true">{{ post.url }}</guid>
+        {% for tag in post.tags %}
+          <category>{{ tag | xml_escape }}</category>
+        {% endfor %}
+        {% for cat in post.categories %}
+          <category>{{ cat | xml_escape }}</category>
+        {% endfor %}
+      </item>
+    {% endfor %}
+  </channel>
+</rss>

data/spec/fixtures/absolute-links/morbi-ultrices-nulla.md

@@ -0,0 +1,13 @@
+---
+title: Morbi ultrices nulla
+permalink: /morbi-ultrices-nulla/
+---
+
+Morbi ultrices nulla et dolor auctor elementum. In lacinia, leo et dignissim
+ornare, lectus odio lacinia nibh, nec vehicula nisi nulla a massa. Aliquam
+vulputate, risus ut dapibus tristique, sem nibh posuere elit, id venenatis odio
+dui non arcu. Duis ut justo consectetur, consequat odio vitae, vulputate urna.
+
+[Lorem ipsum dolor sit amet][link]
+
+[link]: /posts/lorem-ipsum-dolor-sit-amet/

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+require File.expand_path("../lib/jekyll-absolute-links", File.dirname(__FILE__))
+
+Jekyll.logger.log_level = :error
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-absolute-links
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Miguel Venegas Mendoza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      Absolute link converter for Jekyll sites. Crawls the generated HTML and XML
+      files in search of relative links and transform them to absolute links by
+      prepending the site domain.
+email:
+- jvenegasmendoza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- jekyll-absolute-links.gemspec
+- lib/jekyll-absolute-links.rb
+- lib/jekyll-absolute-links/crawler.rb
+- lib/jekyll-absolute-links/version.rb
+- script/console
+- script/setup
+- spec/crawler_spec.rb
+- spec/fixtures/absolute-links/_config.yml
+- spec/fixtures/absolute-links/_layouts/default.html
+- spec/fixtures/absolute-links/_posts/2001-01-01-lorem-ipsum-dolor-sit-amet.md
+- spec/fixtures/absolute-links/_posts/2001-01-02-curabitur-sed-condimentum-enim.md
+- spec/fixtures/absolute-links/feed.xml
+- spec/fixtures/absolute-links/morbi-ultrices-nulla.md
+- spec/spec_helper.rb
+homepage: https://github.com/rukbotto/jekyll-absolute-links
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Absolute link converter for Jekyll sites.
+test_files:
+- spec/crawler_spec.rb
+- spec/fixtures/absolute-links/_config.yml
+- spec/fixtures/absolute-links/_layouts/default.html
+- spec/fixtures/absolute-links/_posts/2001-01-01-lorem-ipsum-dolor-sit-amet.md
+- spec/fixtures/absolute-links/_posts/2001-01-02-curabitur-sed-condimentum-enim.md
+- spec/fixtures/absolute-links/feed.xml
+- spec/fixtures/absolute-links/morbi-ultrices-nulla.md
+- spec/spec_helper.rb