jekyll-tagories 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bbf2194099e21e2dc77a311012e932955d2830ea05cf94afc1ee9d45d489938
+  data.tar.gz: 140efd114dc36efff9be4eb1b89a9a4ff9b8f05ae00e3849a4a9e7e702d315ae
+SHA512:
+  metadata.gz: 88ce830573812a8516d8e8bab5780138a17bcce71cb93f8b5153db86d8ca893a46d159a185f606f3a2002a0189dc94ca461f1668941e4d71c9fd239ea7aeaf9a
+  data.tar.gz: 6f11f4722c820093ce6e860033503ccf64226d7f63531dc96013d377f7e0b675daca0a5b70c1ba3f7724958ed36e233d023882739c7e743e820abd82663f3ae8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2020 Ashwin Maroli
+
+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,41 @@
+# Jekyll Tagories
+
+A Jekyll plugin that enhances `site.tags` and `site.categories` to include documents from user-defined collections and easily
+*select* documents based on a given tag or category.
+
+## Installation
+
+Add `jekyll-tagories` to your `Gemfile` and then run `bundle install` on your terminal. However, if your site doesn't have
+a Gemfile, you may install it directly by running `gem install jekyll-tagories`.
+
+## Usage
+
+To enable this plugin, add it to your configuration file before building your site:
+
+```yaml
+plugins:
+  - jekyll-tagories
+```
+
+Once enabled, `{{ site.tags }}` and `{{ site.categories }}` will include documents from your collections if they have been
+tagged or categorized via their front matter.
+
+*Note: The support for categories are limited to just the document's front matter and will not consider a document's
+superdirectories as categories like your posts.*
+
+### Liquid filters
+
+The plugin also exposes two Liquid filters to ease handling of the grouped pages and documents:
+
+  * **`tagged`** — retrieve documents that are tagged.
+    * **input:** an array of objects that have a `data` attribute.
+    * **optional parameter:** a single tag name
+    * **examples:**
+      * `{{ site.recipes | tagged }}`
+      * `{{ site.recipes | tagged: 'cake' }}`
+  * **`categorized`** — retrieve documents that are categorized.
+    * **input:** an array of objects that have a `data` attribute.
+    * **optional parameter:** a single category name
+    * **examples:**
+      * `{{ site.recipes | categorized }}`
+      * `{{ site.recipes | categorized: 'cakes' }}`

data/lib/jekyll-tagories.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "jekyll/tagories/site_xtension"
+require_relative "jekyll/tagories/filters"

data/lib/jekyll/tagories/filters.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Tagories
+    module LiquidFilters
+      def tagged(input, tag = nil)
+        return input unless input.is_a?(Array)
+
+        input.select do |item|
+          next false unless item.respond_to?(:data)
+          next false if item.data["tags"].empty?
+          next true if tag.nil?
+
+          item.data["tags"].include?(tag)
+        end
+      end
+
+      def categorized(input, category = nil)
+        return input unless input.is_a?(Array)
+
+        input.select do |item|
+          next false unless item.respond_to?(:data)
+          next false if item.data["categories"].empty?
+          next true if category.nil?
+
+          item.data["categories"].include?(category)
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Tagories::LiquidFilters)

data/lib/jekyll/tagories/site_xtension.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Tagories
+    module SiteXtension
+      def tags
+        register_tags_and_categories unless @tags
+        @tags
+      end
+
+      def categories
+        register_tags_and_categories unless @categories
+        @categories
+      end
+
+      private
+
+      def register_tags_and_categories
+        @tags = {}
+        @categories = {}
+
+        documents.each do |doc|
+          next unless doc.is_a?(Jekyll::Document)
+
+          segregate_doc_by_attr_list(doc, doc.data["tags"], @tags)
+          segregate_doc_by_attr_list(doc, doc.data["categories"], @categories)
+        end
+      end
+
+      def segregate_doc_by_attr_list(doc, list, stash)
+        Array(list).each_with_object(stash) do |item, hash|
+          hash[item] ||= []
+          hash[item] << doc
+        end
+      end
+    end
+
+    Jekyll::Site.prepend(SiteXtension)
+    private_constant :SiteXtension
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-tagories
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Maroli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-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.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: A Jekyll plugin that allows iterating through tagged or categorized documents
+  in user-defined collections
+email:
+- ashmaroli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-tagories.rb
+- lib/jekyll/tagories/filters.rb
+- lib/jekyll/tagories/site_xtension.rb
+homepage: https://github.com/ashmaroli/jekyll-tagories
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to allow iterating through tagged or categorized documents
+test_files: []