jekyll-relations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 145d22caafbdb3232391e3a0f525b0c0fc5d6941
+  data.tar.gz: 8a25ae3bb43a139f38ac5b44583abcb844df497e
+SHA512:
+  metadata.gz: 812ce2bab6934d7f64b727b0e912e677ef652978b2b9d62e24d16610ba01453bd8c858abdf7d44bbd9b4cad46bdd73fc447f7634fbf779e95375773c30e63f65
+  data.tar.gz: 1f44c490975bc15f5ff119c3b941e079a043b604852215e70c84e8ef8b50ed0d87ddfce158f23c54f740a61b15aaf2ff669ab65acb53f6e1717e78e9108734a9

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    jekyll-relations (0.1.0)
+      jekyll (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    builder (3.2.3)
+    colorator (1.1.0)
+    ffi (1.9.18)
+    forwardable-extended (2.6.0)
+    jekyll (3.6.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 3)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.0)
+      sass (~> 3.4)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    kramdown (1.16.1)
+    liquid (4.0.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    mercenary (0.3.6)
+    minitest (5.10.3)
+    minitest-reporters (1.1.19)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pathutil (0.16.0)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (2.2.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    sass (3.5.3)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  jekyll-relations!
+  minitest
+  minitest-reporters
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+task t: :test

data/jekyll-relations.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/relations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-relations'
+  spec.version       = Jekyll::Relations::VERSION
+  spec.authors       = ['Adam Hollett']
+  spec.email         = ['mail@adamhollett.com']
+
+  spec.summary       = 'Jekyll plugin to make pages aware of their relatives.'
+  spec.homepage      = 'https://github.com/adamhollett/jekyll-relations'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jekyll',               '~> 3.0'
+  spec.add_development_dependency 'bundler',  '~> 1.16'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+end

data/lib/jekyll-relations.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'jekyll/relations/page'
+require 'jekyll/relations/version'

data/lib/jekyll/relations/page.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Relations
+    module Page
+      # The next highest page in the folder structure.
+      #
+      # Returns the Page object for the parent page.
+      def parent
+        @parent ||= begin
+          return nil unless html?
+          depth = url.count('/')
+          site.pages
+            .select(&:html?)
+            .find { |p| url.start_with?(p.url) && p.url.count('/') == depth - 1 }
+        end
+      end
+
+      # A list of ancestors from the site index to the current page.
+      #
+      # Returns an Array of Page objects or an empty Array.
+      def ancestors
+        @ancestors ||= begin
+          return [] unless parent
+          ancestors = []
+          i = self
+          while i.parent
+            ancestors << i.parent
+            i = i.parent
+          end
+          ancestors.reverse
+        end
+      end
+      alias_method :parents, :ancestors
+
+      # A list of the pages directly below this one in the folder structure.
+      #
+      # Returns an Array of Page objects or an empty Array.
+      def children
+        return [] unless html? && index?
+        @children ||= begin
+          depth = url.count('/')
+          site.pages
+            .select(&:html?)
+            .select { |p| p.url.start_with?(url) && p.url.count('/') == depth + 1 }
+        end
+      end
+
+      # Convert the new Page data to a Hash suitable for use by Liquid.
+      #
+      # Returns the Hash representation of this Page.
+      def to_liquid(attrs = Jekyll::Page::ATTRIBUTES_FOR_LIQUID)
+        super(attrs + %w(parent ancestors parents children))
+      end
+    end
+  end
+end
+
+Jekyll::Page.prepend Jekyll::Relations::Page

data/lib/jekyll/relations/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Relations
+    VERSION = '0.1.0'
+  end
+end

data/license.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Adam Hollett
+
+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,115 @@
+# Jekyll Relations plugin
+
+A Jekyll plugin to create relations between pages according to your file structure.
+
+> ⚠️  
+> **Note**:  
+> This plugin is beta-quality and relies on the `permalink: pretty` configuration setting to work. Future versions will be compatible with other permalink settings.
+
+## Installation
+
+1.  Add this line to the `jekyll_plugins` group of your site's Gemfile:
+
+    ``` ruby
+    gem 'jekyll-relations', git: 'https://github.com/adamhollett/jekyll-relations'
+    ```
+
+2.  Add `jekyll-relations` under the `plugins` key in your site's `_config.yml`:
+
+    ``` yml
+    plugins:
+      - jekyll-relations
+    ```
+
+    If you're using Jekyll < 3.5.0, use the `gems` key instead of `plugins`.
+
+3.  Run `bundle` to ensure your dependencies are up to date.
+
+## Usage
+
+After installing this plugin, your Jekyll pages will respond to a few new methods: `parent`, `ancestors`, and `children`.
+
+### parent
+
+Returns a `Jekyll::Page`. You can access a page's parent in Liquid with `{{ page.parent }}`.
+
+A page's **parent** is the next highest page in the folder structure.
+
+- If a page's filename is `index`, then its parent is the page with the filename `index` in the folder above:
+
+  ```
+  about.md
+  contact.md
+  index.md     <-- {{ page.parent }}
+  fruit/
+    apple.md
+    index.md   <-- {{ page }}
+    orange.md
+  ```
+
+- If a page's filename is not `index`, then its parent is the page with the filename `index` in the same folder.
+
+  ```
+  about.md
+  contact.md
+  index.md     
+  fruit/
+    apple.md   <-- {{ page }}
+    index.md   <-- {{ page.parent }}
+    orange.md
+  ```
+
+### ancestors
+
+Returns an array of `Jekyll::Page` objects. You can access a page's ancestors in Liquid with `{{ page.ancestors }}` or `{{ page.parents }}`.
+
+A page's **ancestors** are its parent, its parent's parent, and so on until the site index. They are returned in order from highest to lowest.
+
+It can be useful to think of a page's ancestors as the "breadcrumbs" for the page.
+
+```
+about.md
+contact.md
+index.md     
+fruit/
+  apple.md  <-- {{ page }}
+  index.md
+  orange.md
+```
+
+In the tree above, the page is `fruit/apple.md` and its ancestors are:
+
+```
+[
+  'index.md',
+  'fruit/index.md'
+]
+```
+
+Because `fruit/apple.md`'s parent is `fruit/index.md` and that page's parent is `index.md`.
+
+### children
+
+Returns an array of `Jekyll::Page` objects. You can access a page's children in Liquid with `{{ page.children }}`.
+
+A page's **children** are the pages directly below it in the folder structure. Only pages with the filename `index` have children.
+
+The children of a page called `index` are the other page files in the same folder, as well as `index` files in its subfolders:
+
+```
+about.md         {{ page.children[0] }}
+contact.md       {{ page.children[1] }}
+index.md     <-- {{ page }}
+fruit/
+  apple.md
+  index.md       {{ page.children[2] }}
+  orange.md
+```
+
+## Testing
+
+Run `rake test` to run tests for this plugin.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adamhollett/jekyll-relations.

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-relations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Hollett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  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-reporters
+  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:
+- mail@adamhollett.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- jekyll-relations.gemspec
+- lib/jekyll-relations.rb
+- lib/jekyll/relations/page.rb
+- lib/jekyll/relations/version.rb
+- license.txt
+- readme.md
+homepage: https://github.com/adamhollett/jekyll-relations
+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.14
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to make pages aware of their relatives.
+test_files: []