jekyll-tagging-related_posts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2d867dcf20c6da79bf081959fa90e988c489f9f
+  data.tar.gz: 0edfcd46f1fb75596cf88235ecf906de89e8c328
+SHA512:
+  metadata.gz: fe7a19d6f053b1c5087e4809abc8dd91f345e230115609c8fe29959bfbfbf8b10afb2621c4c9037417f611b291197853d53db1a8e9bf3402ee7ce7d4f036ae6b
+  data.tar.gz: e1a741b1722d3a908f52475e05e7faa13efd9277550e741466fb750cdfd79e7d4ef92c605ca11bfcbb85a2ee286077b16e952eb8d3770e37eccb22f17180347e

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-tagging-related_posts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 toshi
+
+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,63 @@
+
+# jekyll-tagging-related_posts
+
+Jekyll `related_posts` function based on tags (works for only Jekyll3). It replaces original Jekyll's `related_posts` function to use tags to calculate relationships.
+
+ The calculation algorithm is based on [LawrenceWoodman/related\_posts-jekyll\_plugin](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin).
+
+## Requirements
+* [Jekyll 3.x](https://github.com/jekyll/jekyll)
+* [pattex/jekyll-tagging](https://github.com/pattex/jekyll-tagging)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-tagging-related_posts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-tagging-related_posts
+
+## Usage
+
+Edit `_config.yml` to use the plug-in:
+
+```yml
+gems:
+  - jekyll/tagging
+  - jekyll-tagging-related_posts
+```
+
+Then, add related_posts in your post layout.
+
+```liquid
+{% if site.related_posts.size >= 1 %}
+<div>
+  <h3>Related Posts</h3>
+  <ul>
+  {% for related_post in site.related_posts limit: 5 %}
+    <li><a href="{{ related_post.url }}">{{ related_post.title }}</a></li>
+  {% endfor %}
+  </ul>
+</div>
+{% endif %}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/toshimaru/jekyll-tagging-related_posts. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll-tagging-related_posts"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-tagging-related_posts.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/tagging/related_posts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-tagging-related_posts"
+  spec.version       = Jekyll::Tagging::RelatedPosts::VERSION
+  spec.authors       = ["toshimaru"]
+  spec.email         = ["me@toshimaru.net"]
+
+  spec.summary       = %q{Replaces Jekyll's related_posts function to use tags to calculate relationships}
+  spec.description   = %q{Replaces Jekyll's related_posts function to use tags to calculate relationships}
+  spec.homepage      = "https://github.com/toshimaru/jekyll-tagging-related_posts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", "~> 3.0"
+  spec.add_runtime_dependency "jekyll-tagging", "~> 1.0.0"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "minitest"
+end

data/lib/jekyll-tagging-related_posts.rb

@@ -0,0 +1,10 @@
+require "jekyll/document"
+
+require "jekyll/tagging/related_posts/version"
+require "jekyll/tagging/related_posts"
+
+module Jekyll
+  class Document
+    include ::Jekyll::Tagging::RelatedPosts
+  end
+end

data/lib/jekyll/tagging/related_posts.rb

@@ -0,0 +1,62 @@
+require "jekyll/tagging/related_posts/version"
+
+module Jekyll
+  module Tagging
+    module RelatedPosts
+      # Used to remove #related_posts so that it can be overridden
+      def self.included(klass)
+        klass.class_eval do
+          remove_method :related_posts
+        end
+      end
+
+      # Calculate related posts.
+      # Returns [<Post>]
+      def related_posts
+        return [] unless docs.count > 1
+        highest_freq = tag_freq.values.max
+        related_scores = Hash.new(0)
+
+        docs.each do |doc|
+          doc.data["tags"].each do |tag|
+            if self.data["tags"].include?(tag) && doc != self
+              cat_freq = tag_freq[tag]
+              related_scores[doc] += (1 + highest_freq - cat_freq)
+            end
+          end
+        end
+
+        sort_related_posts(related_scores)
+      end
+
+      private
+
+      # Calculate the frequency of each tag.
+      # Returns {tag => freq, tag => freq, ...}
+      def tag_freq
+        @tag_freq ||= docs.inject(Hash.new(0)) do |tag_freq, doc|
+          doc.data["tags"].each {|tag| tag_freq[tag] += 1 }
+          tag_freq
+        end
+      end
+
+      # Sort the related posts in order of their score and date
+      # and return just the posts
+      def sort_related_posts(related_scores)
+        related_scores.sort do |a, b|
+          if a[1] < b[1]
+            1
+          elsif a[1] > b[1]
+            -1
+          else
+            b[0].date <=> a[0].date
+          end
+        end.collect {|post, freq| post}
+      end
+
+      def docs
+        @docs ||= site.posts.docs
+      end
+    end
+  end
+end

data/lib/jekyll/tagging/related_posts/version.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module Tagging
+    module RelatedPosts
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-tagging-related_posts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- toshimaru
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-25 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: jekyll-tagging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: byebug
+  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
+  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: Replaces Jekyll's related_posts function to use tags to calculate relationships
+email:
+- me@toshimaru.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-tagging-related_posts.gemspec
+- lib/jekyll-tagging-related_posts.rb
+- lib/jekyll/tagging/related_posts.rb
+- lib/jekyll/tagging/related_posts/version.rb
+homepage: https://github.com/toshimaru/jekyll-tagging-related_posts
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Replaces Jekyll's related_posts function to use tags to calculate relationships
+test_files: []