jekyll_custom_permalink 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23d765af94dfb8fde47e0bf948f8051fc14841a2c8324a8b16d3f18461835ca4
+  data.tar.gz: 84102fea573672f031173789b61429041d04e2682fa9c04f7a98af1164a1831d
+SHA512:
+  metadata.gz: 4bec2416a3af0162ccc7f11a678a86eee737f47edc92e93e872e5cf3eea7a23b716bdd266f5bac2f271f7949e4a9ea60242fb916f0ff4fec49e69380a0909281
+  data.tar.gz: e90221aa72389233877636c849ec6c102bb295221fc9351139869cac70972a2393819bc1338846442c5a403de432d1804b92a5a09c72cbc04afe0419a98ef09e

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Niklas Eicker.
+
+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,52 @@
+# Jekyll custom permalink
+
+[![Gem Version](https://badge.fury.io/rb/jekyll_custom_permalink.svg)](https://badge.fury.io/rb/jekyll_custom_permalink)
+
+This Jekyll plugin allows you to use custom Front Matter in the `permalink` setting of collections.
+
+## Installation
+
+Add the plugin to your site's Gemfile:
+```ruby
+group :jekyll_plugins do
+  # your other jekyll plugins...
+  gem 'jekyll_custom_permalink', '~> 0.0'
+end
+```
+
+Then run
+```bash
+$ bundle install
+```
+
+## Usage
+
+Lets assume that you have some options for your collection "projects" defined in `_config`:
+```yml
+collections:
+  projects:
+    output: true
+    permalink: projects/:title/
+```
+
+You would like to use custom Front Matter in the paths of your projects. For example, it would be great to be able to include the Front Matter variable `type` in the links to your projects, which is defined in every file belonging to the "projects" collection.
+```yml
+---
+layout: page
+type: python
+title: MyAwesomeProject
+---
+Some content
+```
+
+You can use the `type` variable in your permalink by first adding it to an array of custom permalink placeholders for the collection, and then adding the placeholder to the permalink setting prefixed with a `:` like every other Jekyll placeholder.
+```yml
+collections:
+  projects:
+    output: true
+    custom_permalink_placeholders: ["type"]
+    permalink: projects/:type/:title/
+```
+These settings lead to the "project" page, shown above, to be live at `/projects/python/MyAwesomeProject`.
+
+If the variable is not defined, it is ignored for the permalink. Meaning `projects/:type/:title/` will be like `projects/:title/` for a document without `type` set in its Front Matter. This is the same behaviour as for the default Jekyll placeholders.

data/lib/jekyll_custom_permalink.rb

@@ -0,0 +1,8 @@
+module JekyllCustomPermalink
+  autoload :VERSION, 'jekyll_custom_permalink/version.rb'
+
+  class CustomPermalinkError < StandardError; end
+  class CustomPermalinkSetupError < CustomPermalinkError; end
+end
+
+require 'jekyll_custom_permalink/custom_permalink.rb'

data/lib/jekyll_custom_permalink/custom_permalink.rb

@@ -0,0 +1,29 @@
+module JekyllCustomPermalink
+  class CustomPermalink < Jekyll::Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      # nothing to do, wait for hook
+    end
+
+    Jekyll::Hooks.register :documents, :pre_render do |doc|
+      begin
+        # check if jekyll can resolve the url template
+        doc.url
+      rescue NoMethodError => error
+        begin
+          if !doc.collection.metadata.fetch("custom_permalink_placeholders").is_a?(Array)
+            raise CustomPermalinkSetupError, "The custom placeholders need to be an array! Check the settings of your '#{doc.collection.label}' collection."
+          end
+          def doc.url_template
+            @custom_url_template ||= collection.metadata.fetch("custom_permalink_placeholders").inject(collection.url_template){|o,m| o.sub ":" + m, data[m].to_s}
+          end
+        rescue KeyError
+          # "custom_permalink_placeholders"
+          raise CustomPermalinkSetupError, "No custom placeholders defined for the '#{doc.collection.label}' collection. Define an array of placeholders under the key 'custom_permalink_placeholders'. \nCaused by: " + error.to_s
+        end
+      end
+    end
+  end
+end

data/lib/jekyll_custom_permalink/version.rb

@@ -0,0 +1,3 @@
+module JekyllCustomPermalink
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_custom_permalink
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Niklas Eicker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Jekyll plugin allowing usage of custom Front Matter in the `permalink`
+  setting of collections.
+email:
+- hello@nikl.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/jekyll_custom_permalink.rb
+- lib/jekyll_custom_permalink/custom_permalink.rb
+- lib/jekyll_custom_permalink/version.rb
+homepage: https://github.com/NiklasEi/jekyll_custom_permalink
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/NiklasEi/jekyll_custom_permalink/issues
+  documentation_uri: https://github.com/NiklasEi/jekyll_custom_permalink
+  homepage_uri: https://github.com/NiklasEi/jekyll_custom_permalink
+  source_code_uri: https://github.com/NiklasEi/jekyll_custom_permalink
+  changelog_uri: https://github.com/NiklasEi/jekyll_custom_permalink/blob/master/changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin allowing usage of custom Front Matter in the `permalink` setting
+  of collections.
+test_files: []