jekyll-post-tags 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82dd827934df79ac51aef7b21aac284c6b25e53f
+  data.tar.gz: ed13ea925f73f25e96bb1c27f2010bbe4ea4a2ce
+SHA512:
+  metadata.gz: dd010d97fbe32465b007517ac794b7a6e6ffe1eb208c1a80c0663c58ac7cf21ab5b5917fe8c778c67ae1961ccac1160bc19cb78f56e75c814f673e2e732e7407
+  data.tar.gz: b2b62853fa92a1c29663ff639976c17d9c36aca219a39d4ce0d5b0867acb0d6790620822b0de0a9f42017b2b9d7c9c184960d1d91da3cc4f2fc0502520179906

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+gem "pry"
+
+if ENV["JEKYLL_VERSION"]
+  # So we can test across all our supported.
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015-2017 Jordon Bedwell
+
+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 @@
+<p align=center>
+  <a href=https://goo.gl/BhrgjW>
+    <img src=https://envygeeks.io/badges/paypal-large_1.png alt=Donate>
+  </a>
+  <br>
+  <a href=https://travis-ci.org/envygeeks/jekyll-post-tags>
+    <img src="https://travis-ci.org/envygeeks/jekyll-post-tags.svg?branch=master">
+  </a>
+</div>
+
+# Jekyll Post Tags
+
+Jekyll post tags turns your Jekyll tags into drops without disrupting the way that Jekyll flows... or the way that you work with Jekyll's own tagging system.  It also acts as a generator for tag pages, with custom templates (no defaults,) and custom pathing.  It is different than other tagging platforms in that it works within what Jekyll already does and might not require you to change your code that much (if at all in some cases.)
+
+## Usage
+#### From Within Your Templates
+##### All Tags
+```html
+<ul class="tags">
+  {% for tag in site.tags %}
+  <li class="weight-{{ tag[0].weight | round }}">
+    <a title="Site Tag: {{ tag[0] }}" href="{{ tag[0].url | pretty }}">
+      {{ tag[0] }}
+    </a>
+  </li>
+  {% endfor %}
+</ul>
+```
+
+##### Post Tags
+```html
+<ul class="tags">
+  {% for tag in post.tags %}
+  <li class="weight-{{ tag.weight | round }}">
+    <a title="Site Tag: {{ tag }}" href="{{ tag.url | pretty }}">
+      {{ tag }}
+    </a>
+  </li>
+  {% endfor %}
+</ul>
+```

data/Rakefile

@@ -0,0 +1,7 @@
+# Frozen-String-Literal: true
+# Copyright 2015 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :default => [:spec]

data/lib/jekyll-post-tags.rb

@@ -0,0 +1,5 @@
+# Frozen-String-Literal: true
+# Copyright 2015 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+require_relative "jekyll/post/tags"

data/lib/jekyll/post/tags.rb

@@ -0,0 +1,17 @@
+# Frozen-String-Literal: true
+# Copyright 2015 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+require "jekyll"
+
+module Jekyll
+  module Post
+    module Tags
+      require_relative "tags/drop"
+      require_relative "tags/generator"
+      require_relative "tags/version"
+      require_relative "tags/page"
+      require_relative "tags/hook"
+    end
+  end
+end

data/lib/jekyll/post/tags/drop.rb

@@ -0,0 +1,58 @@
+# Frozen-String-Literal: true
+# Copyright 2016 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+require_relative "helpers"
+require "liquid/drop/str"
+
+module Jekyll
+  module Post
+    module Tags
+
+      # --
+      # @see https://github.com/envygeeks/liquid-string-drop
+      # Provides a string drop that we can wrap directly
+      #   back into Jekyll without disrupting the ways users
+      #   work, and without disrupting the way Jekyll currently
+      #   works with it's own stuff.
+      # --
+      class Drop < Liquid::Drop::Str
+        attr_reader :weight, :site
+        extend Forwardable::Extended
+        rb_delegate :name, to: :@tag, alias_of: :to_s
+        include Helpers
+
+        # --
+        def initialize(tag, site:, weight: 1)
+          super(tag)
+
+          @site = site
+          @weight = weight
+          @tag = tag
+        end
+
+        # --
+        def url
+          File.join(*tag_path)
+        end
+
+        # --
+        # @return [[]] the tags.
+        # Loop through tags, set them up and then, pass
+        #   them back out.
+        # --
+        def self.to_tags(site:)
+          div = 4.0 / site.tags.values.max_by(&:size).size
+          site.tags.each_with_object([]) do |(k, v), o|
+            weight = format("%.2f", div * v.size)
+
+            o << new(k, {
+              weight: weight.to_f,
+              site: site,
+            })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/post/tags/generator.rb

@@ -0,0 +1,48 @@
+# Frozen-String-Literal: true
+# Copyright 2016 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+require "jekyll/generator"
+
+module Jekyll
+  module Post
+    module Tags
+
+      # --
+      # @see https://github.com/jekyll/jekyll
+      # Generates the sites tags, using Jekyll's
+      #   generators this is controlled by them and we don't
+      #   really need to do that much after that.
+      #
+      # @example
+      #   ```yaml
+      #   # _config.yml
+      #   tag_layout: custom_layout
+      #   ```
+      # --
+      class Generator < Jekyll::Generator
+        def generate(site)
+          # @note this belongs in your `_config.yml`
+          key = (site.config["tag_layout"] || "default").chomp(".html")
+
+          if site.layouts.has_key?(key)
+            return site.tags.keys.each do |v|
+              tag = Doc.new(v, site: site)
+              tag.render(site.layouts, site.site_payload)
+              tag.write(site.dest)
+              site.pages << tag
+            end
+
+          # This error should be configurable or removed entirely
+          # because at the end of the day if there is no default.html
+          # or a specific tag layout, the user knows this...
+
+          else
+            Jekyll.logger.error "", "Could not find '#{key}.html' " \
+              "Skipping tags."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/post/tags/helpers.rb

@@ -0,0 +1,43 @@
+# Frozen-String-Literal: true
+# Copyright 2016 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+module Jekyll
+  module Post
+    module Tags
+      module Helpers
+
+        # --
+        # Provides the layout path.
+        # --
+        private
+        def tag_layout
+          return @tag_layout ||= begin
+            File.join("_layouts", (site.config["tag_layout"] \
+              ||= "default.html").gsub(/^_layouts\//, ""))
+          end
+        end
+
+        # --
+        # Provide the write path to the tag.
+        # @return [Array<Base,Path>]
+        # --
+        private
+        def tag_path
+          return @tag_path ||= begin
+            path = @site.config["tag_path"] || "/tag/:tag.html"
+            path = path.sub(":tag", @tag).split("/")
+            unless path.last =~ /\.html$/
+              path << "/index.html"
+            end
+
+            [
+              path[0...-1].join("/"),
+              path.last
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/post/tags/hook.rb

@@ -0,0 +1,17 @@
+# Frozen-String-Literal: true
+# Copyright 2016 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+Jekyll::Hooks.register :site, :pre_render, priority: 99 do |s, p|
+  tags = Jekyll::Post::Tags::Drop.to_tags(site: s)
+
+  s.posts.docs.each do |d|
+    d.data["tags"] = d.data["tags"].map do |t|
+      o = tags.find do |v|
+        v == t
+      end
+
+      o
+    end
+  end
+end

data/lib/jekyll/post/tags/page.rb

@@ -0,0 +1,69 @@
+# Frozen-String-Literal: true
+# Copyright 2015 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+require_relative "helpers"
+
+module Jekyll
+  module Post
+    module Tags
+
+      # --
+      # Provides the base page for all tags that get built,
+      #   this is mostly modeled after Jekyll's own pages, posts
+      #   documents and otherwise.
+      # --
+      class Doc < Jekyll::Page
+        attr_accessor :site, :base, :tag, :dir, :name
+        include Helpers
+
+        # --
+        # Initialize a new instance.
+        # @return [Page]
+        # --
+        def initialize(tag, site:)
+          @site = site
+          @tag = tag
+          @base = site.source
+          @dir, @name = tag_path
+          process_tag_template
+          setup_defaults
+        end
+
+        # --
+        # Since this class is dynamic, and it's path being
+        #   dynamic too, we provide a "realpath" method so that
+        #   anything using Git, or otherwise can determine
+        #   what the actual path is.
+        # @return [String]
+        # --
+        def realpath
+          @site.tags[@tag].sort_by { |v| v.data["date"] \
+            }.first.relative_path
+        end
+
+        # --
+        # Pull out the base data from within the layout.
+        # Most of the time this will simply just be empty.
+        # @return [Hash]
+        # --
+        private
+        def process_tag_template
+          read_yaml(@base, tag_layout)
+          process(@name)
+        end
+
+        # --
+        # Set the defaults.
+        # --
+        private
+        def setup_defaults
+          @data["type"] = "tag"
+          @data["description"] ||= "Post Tag: #{@tag}"
+          @data["title"] ||= "Post Tag: #{@tag}"
+          @data["tag"] = @tag
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/post/tags/version.rb

@@ -0,0 +1,11 @@
+# Frozen-String-Literal: true
+# Copyright 2015 - 2017 Jordon Bedwell - MIT License
+# Encoding: UTF-8
+
+module Jekyll
+  module Post
+    module Tags
+      VERSION = "1.0.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-post-tags
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordon Bedwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: luna-rspec-formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: liquid-string-drop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Reusable Post Tags for Jekyll
+email:
+- jordon@envygeeks.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/jekyll-post-tags.rb
+- lib/jekyll/post/tags.rb
+- lib/jekyll/post/tags/drop.rb
+- lib/jekyll/post/tags/generator.rb
+- lib/jekyll/post/tags/helpers.rb
+- lib/jekyll/post/tags/hook.rb
+- lib/jekyll/post/tags/page.rb
+- lib/jekyll/post/tags/version.rb
+homepage: http://github.com/envygeeks/jekyll-post-tags
+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.11
+signing_key: 
+specification_version: 4
+summary: Post Tags for Jekyll
+test_files: []