jekyll-post-tags 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82dd827934df79ac51aef7b21aac284c6b25e53f
-  data.tar.gz: ed13ea925f73f25e96bb1c27f2010bbe4ea4a2ce
+SHA256:
+  metadata.gz: dc296d8f4add80c0002a7443deca2a61db53f41d96f5d61013d4b98add6f4004
+  data.tar.gz: a1505efce2180779d9255a7c92022247dca0cf7a7ba703f96c235b723a2669b6
 SHA512:
-  metadata.gz: dd010d97fbe32465b007517ac794b7a6e6ffe1eb208c1a80c0663c58ac7cf21ab5b5917fe8c778c67ae1961ccac1160bc19cb78f56e75c814f673e2e732e7407
-  data.tar.gz: b2b62853fa92a1c29663ff639976c17d9c36aca219a39d4ce0d5b0867acb0d6790620822b0de0a9f42017b2b9d7c9c184960d1d91da3cc4f2fc0502520179906
+  metadata.gz: 3f9eb8f498adb3bb552f2490d05e16b45dc093b51906b2b9cb44a9709d3608676859f5125a811dd49a188645140e6ab64d888ad59d13202bc1e3b53e2c156286
+  data.tar.gz: eb45cfea6698a658f062ed0219241d31fd2e52943656c7a06a82a1d33825bd8d217e2784eb8a32a2f2a0f6da9122fa210b30655b6a50b37bc83e1129e3b082de

data/Gemfile

@@ -1,10 +1,11 @@
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# Encoding: utf-8
+
 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"]}"
+  gem "jekyll", "~> #{ENV['JEKYLL_VERSION']}"
 end

data/README.md

@@ -1,12 +1,9 @@
-<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>
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/envygeeks/jekyll-post-tags.svg?style=for-the-badge)](https://codeclimate.com/github/envygeeks/jekyll-post-tags/maintainability)
+[![Code Climate](https://img.shields.io/codeclimate/c/envygeeks/jekyll-post-tags.svg?style=for-the-badge)](https://codeclimate.com/github/envygeeks/jekyll-post-tags/coverage)
+[![Travis CI](https://img.shields.io/travis/envygeeks/jekyll-post-tags/master.svg?style=for-the-badge)](https://travis-ci.org/envygeeks/jekyll-post-tags)
+[![Donate](https://img.shields.io/badge/-DONATE-yellow.svg?style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=LKGZAWXLZ8ZPG)
+![Gem Version](https://img.shields.io/gem/v/jekyll-post-tags.svg?style=for-the-badge)
+![Gem DL](https://img.shields.io/gem/dt/jekyll-post-tags.svg?style=for-the-badge)
 
 # Jekyll Post Tags
 

data/Rakefile

@@ -1,7 +1,42 @@
-# Frozen-String-Literal: true
-# Copyright 2015 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2017 - 2018 - MIT License
+# Source: https://github.com/envygeeks/devfiles
+# Author: Jordon Bedwell
+# Encoding: utf-8
 
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec)
-task :default => [:spec]
+# --
+# 🔖
+# RSpec, MiniTest, Whatever.
+# --
+task default: [:spec]
+task :spec do
+  exec "script/test"
+end
+# --
+# 🔖
+# RSpec, MiniTest, Whatever.
+# --
+task :test do
+  exec "script/test"
+end
+# --
+# 🔖
+# @see .rubocop.yml
+# Rubocop.
+# --
+task :rubocop do
+  exec "script/lint"
+end
+# --
+# 🔖
+# @see .rubocop.yml
+# Rubocop.
+# --
+task :lint do
+  exec "script/lint"
+end
+
+# --
+Dir.glob("script/rake.d/*.rake").each do |v|
+  load v
+end

data/lib/jekyll-post-tags.rb

@@ -1,5 +1,6 @@
-# Frozen-String-Literal: true
-# Copyright 2015 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# Encoding: utf-8
 
 require_relative "jekyll/post/tags"

data/lib/jekyll/post/tags.rb

@@ -1,17 +1,11 @@
-# Frozen-String-Literal: true
-# Copyright 2015 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# 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
+require_relative "tags/drop"
+require_relative "tags/generator"
+require_relative "tags/version"
+require_relative "tags/page"
+require_relative "tags/hook"

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

@@ -1,6 +1,7 @@
-# Frozen-String-Literal: true
-# Copyright 2016 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# Encoding: utf-8
 
 require_relative "helpers"
 require "liquid/drop/str"
@@ -8,20 +9,15 @@ 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
 
+        # --
+        # New instance.
+        # @return [nil]
         # --
         def initialize(tag, site:, weight: 1)
           super(tag)
@@ -31,15 +27,19 @@ module Jekyll
           @tag = tag
         end
 
+        # --
+        # The url of the tag.
+        # @return [String]
         # --
         def url
           File.join(*tag_path)
         end
 
         # --
+        # Loop through, and return tags.
+        # @param site [Jekyll::Site] the site.
+        # @note These should return drops?
         # @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

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

@@ -1,47 +1,53 @@
-# Frozen-String-Literal: true
-# Copyright 2016 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# 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...
+        # --
+        # Generate the tags.
+        # @param site [Jekyll::Site]
+        # @return [nil]
+        # --
+        def generate(site)
+          site.config["tags"] ||= {}
+          key = site.config["tags"]["layout"] || "tag"
+          site.layouts.key?(key) || key = "default" # Main?
+          return error(key) unless site.layouts.key?(key)
+          site.config["tags"]["layout"] = key
+          generate_tags_with(site)
+        end
 
-          else
-            Jekyll.logger.error "", "Could not find '#{key}.html' " \
-              "Skipping tags."
+        # --
+        # Generate the tags.
+        # @param site [Jekyll::Site] the site
+        # @see #generate
+        # @return [nil]
+        # --
+        def generate_tags_with(site)
+          site.tags.each_key do |v|
+            site.pages << (Page.new(v, site: site).tap do |o|
+              o.render(site.layouts, site.site_payload); o.write(site.dest)
+            end)
           end
         end
+
+        # --
+        # Throw an error.
+        # @param layout [String]
+        # @see #generate
+        # @return [nil]
+        # --
+        def error(layout)
+          Jekyll.logger.error "", "Could not find '#{layout}.html' " \
+            "Skipping tag generation."
+        end
       end
     end
   end

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

@@ -1,6 +1,7 @@
-# Frozen-String-Literal: true
-# Copyright 2016 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# Encoding: utf-8
 
 module Jekyll
   module Post
@@ -12,10 +13,7 @@ module Jekyll
         # --
         private
         def tag_layout
-          return @tag_layout ||= begin
-            File.join("_layouts", (site.config["tag_layout"] \
-              ||= "default.html").gsub(/^_layouts\//, ""))
-          end
+          @tag_layout ||= File.join("_layouts", site.config["tags"]["layout"])
         end
 
         # --
@@ -24,16 +22,16 @@ module Jekyll
         # --
         private
         def tag_path
-          return @tag_path ||= begin
-            path = @site.config["tag_path"] || "/tag/:tag.html"
+          @tag_path ||= begin
+            path = @site.config["tags"]["path"] || "/tag/:tag.html"
             path = path.sub(":tag", @tag).split("/")
-            unless path.last =~ /\.html$/
+            unless path.last =~ %r!\.html$!
               path << "/index.html"
             end
 
             [
               path[0...-1].join("/"),
-              path.last
+              path.last,
             ]
           end
         end

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

@@ -1,10 +1,24 @@
-# Frozen-String-Literal: true
-# Copyright 2016 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# Encoding: utf-8
 
-Jekyll::Hooks.register :site, :pre_render, priority: 99 do |s, p|
-  tags = Jekyll::Post::Tags::Drop.to_tags(site: s)
+# --
+# Register a hook to create the configuration
+# @return [nil]
+# --
+Jekyll::Hooks.register :site, :after_init do |s|
+  s.config["tags"] ||= {
+    "layout" => nil, "path" => nil
+  }
+end
 
+# --
+# Register a hook to generate the tags.
+# @return [nil]
+# --
+Jekyll::Hooks.register :site, :pre_render, priority: 99 do |s, _|
+  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|

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

@@ -1,6 +1,7 @@
-# Frozen-String-Literal: true
-# Copyright 2015 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# Encoding: utf-8
 
 require_relative "helpers"
 
@@ -13,7 +14,7 @@ module Jekyll
       #   this is mostly modeled after Jekyll's own pages, posts
       #   documents and otherwise.
       # --
-      class Doc < Jekyll::Page
+      class Page < Jekyll::Page
         attr_accessor :site, :base, :tag, :dir, :name
         include Helpers
 
@@ -38,8 +39,9 @@ module Jekyll
         # @return [String]
         # --
         def realpath
-          @site.tags[@tag].sort_by { |v| v.data["date"] \
-            }.first.relative_path
+          @site.tags[@tag].sort_by do |v|
+            v.data["date"]
+          end.first.relative_path
         end
 
         # --

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

@@ -1,11 +1,12 @@
-# Frozen-String-Literal: true
-# Copyright 2015 - 2017 Jordon Bedwell - MIT License
-# Encoding: UTF-8
+# Frozen-string-literal: true
+# Copyright: 2016 - 2018 - MIT License
+# Author: Jordon Bedwell
+# Encoding: utf-8
 
 module Jekyll
   module Post
     module Tags
-      VERSION = "1.0.0"
+      VERSION = "1.1.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-post-tags
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordon Bedwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-12 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: luna-rspec-formatters
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Reusable Post Tags for Jekyll
 email:
 - jordon@envygeeks.io
@@ -97,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -105,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Post Tags for Jekyll