mm-jekyll-tags-list 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d91489237bb3492c97417fe88f24a9d8a7d0717f
-  data.tar.gz: 60105077e0bc8bb974cc90a0d891d5b4811a5d8b
+  metadata.gz: 385fcb96e785760a222f9fd8ffe6565352d0c0db
+  data.tar.gz: 8e43122f3f71cc53973f1a8e6d50c66b08abdbbf
 SHA512:
-  metadata.gz: a971036e623d6d077ba63fc976fdc4a5d03d8af4f24d5190a7e629f78a82f6a167ef778ef5d63dd1e53d1be8d38b312d58382a66d55a996755cc27681f0cc2c6
-  data.tar.gz: 628e05e25910da9aa7047b70a8affd17fbde53b1840390049451d7ed83dfdf3eae040cf982c7b2cfe39ef0af18f0544d9223af603af34d367ad0b714c51f8f78
+  metadata.gz: 9d7a7b0b89c5205a1371330961e1359e050d4d43c8e596ebde053674577949930308c4b11a9eb12954327360e32ef32e3657de75a3b6b7cf928c89420bf6775b
+  data.tar.gz: f906e3826f76a91ce47593eb7a5e742f2cb32c056866f1990298f40a07e00148edc7f6153df51018f346742b7607264ec69d9d91c10156f833d56a44697af2e2

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Changelog.md

@@ -0,0 +1,8 @@
+# Changelog
+
+### 0.0.1
+- Initial release
+
+### 0.0.2
+- Fixed naming issue with gem file
+- Fixed a reference to Prism in the test files (no idea...)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tim Oram
+
+MIT License
+
+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,50 @@
+# Jekyll Tags Plugin
+
+Provides a list of tags for use in tag lists or tag clouds. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem mm-jekyll-tags-list
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mm-jekyll-tags-list
+
+## Configuration
+
+You must define a value for *number_popularity_classes* in _config.yml for this plugin to work. *number_popularity_classes* is the number of classes to divide the tag across for the tag cloud.
+
+## Usage
+
+This plugin adds two data value, *tag_list* and *tag_data*. *tag_list* contains a list of all the tags that are used in the site. *tag_data* contains a hash with the following structure:
+
+    {'tagOne': {
+        'post_count': 10,
+        'popularity': 44,
+        'popularity_class': 2
+    },
+    'tagTwo': {
+        'post_count': 14,
+        'popularity': 67,
+        'popularity_class': 5
+    },
+    ...}
+
+*post_count* contains the number of posts that use the tag, *popularity* is the percentage from 0-100 of the tag, and *popularity_class* is a remapping of the percentage to a numerical range between 0 and *number_popularity_classes*.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/mitmaro/jekyll-tags-list-plugin/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mm-jekyll-tags-list.rb

@@ -0,0 +1,41 @@
+module Jekyll
+	class TagsList < Generator
+	
+		def generate(site)
+			site.data['tag_list'] = TagsList.generate_tags_structure(site).keys
+			site.data['tag_data'] = TagsList.generate_tags_structure(site)
+		end
+		
+		def self.generate_tags_structure(site)
+			tags = Hash.new
+			maximum = calculate_maximum_post_count(site)
+			for tag in site.tags.keys do
+				tags[tag] = Hash.new
+				post_count = number_of_posts_for_tag(site, tag)
+				popularity = calculate_popularity(maximum, post_count)
+				popularity_class = calculate_popularity_class(site, maximum, popularity)
+				tags[tag]['post_count'] = post_count.to_s
+				tags[tag]['popularity'] = popularity.to_s
+				tags[tag]['popularity_class'] = popularity_class.to_s
+			end
+			tags
+		end
+		
+		def self.calculate_popularity_class(site, maximum, popularity)
+			output = ((site.config['number_popularity_classes'] / 100.to_f) * popularity).round
+		end
+		
+		def self.calculate_maximum_post_count(site)
+			max = site.tags.map { |tag,posts| posts.count }.max
+		end
+	
+		def self.number_of_posts_for_tag(site, tag)
+			count = site.tags[tag].length
+		end
+		
+		def self.calculate_popularity(maximum, count)
+			percent = ((count.to_f / maximum) * 100).floor
+		end
+		
+	end
+end

data/mm_jekyll_tags_list_plugin.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "mm-jekyll-tags-list"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Tim Oram"]
+  spec.email         = ["mitmaro@gmail.com"]
+  spec.summary       = %q{Tags List plugin for Jekyll}
+  spec.description   = %q{Provides a list of tags for use in tag lists or tag clouds.}
+  spec.homepage      = "https://github.com/mitmaro/jekyll-tags-list-plugin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "jekyll", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rspec

data/spec/mm_jekyll_tags_list_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+RSpec.describe Jekyll::TagsList do
+	
+	before(:each) do
+		@site = double("tags" => {
+			'a' => [1,2,3,4,5],
+			'b' => [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15],
+			'c' => [1,2,3],
+			'd' => [1,2],
+			'e' => [1,2,3,4],
+			'f' => [1,2,3,4,5,6,7],
+			'g' => [1,2,3,4,5,6,7,8],
+			'g' => [1,2,3,4,5,6,7,8,9,10,11],
+			'h' => [1,2,3],
+			'i' => [1,2,3,4,5],
+		},
+		"config" => {
+			"number_popularity_classes" => 5
+		})
+	end
+
+	it "calculates the number of posts for tag" do
+		expect(described_class.number_of_posts_for_tag(@site, 'a')).to eql(5)
+		expect(described_class.number_of_posts_for_tag(@site, 'b')).to eql(15)
+		expect(described_class.number_of_posts_for_tag(@site, 'c')).to eql(3)
+	end
+	
+	it "calculates the maximum post count for a tag" do
+		expect(described_class.calculate_maximum_post_count(@site)).to eql(15)
+	end
+
+	it "calculates the popularity of a post for a tag" do
+		expect(described_class.calculate_popularity(15, 12)).to eql(80)
+		expect(described_class.calculate_popularity(15, 2)).to eql(13)
+		expect(described_class.calculate_popularity(15, 3)).to eql(20)
+		expect(described_class.calculate_popularity(15, 4)).to eql(26)
+		expect(described_class.calculate_popularity(15, 5)).to eql(33)
+		expect(described_class.calculate_popularity(15, 8)).to eql(53)
+	end
+	
+	it "calculates the popularity class of a post for a tag" do
+		expect(described_class.calculate_popularity_class(@site, 100, 0)).to eql(0)
+		expect(described_class.calculate_popularity_class(@site, 100, 9)).to eql(0)
+		expect(described_class.calculate_popularity_class(@site, 100, 10)).to eql(1)
+		expect(described_class.calculate_popularity_class(@site, 100, 20)).to eql(1)
+		expect(described_class.calculate_popularity_class(@site, 100, 21)).to eql(1)
+		expect(described_class.calculate_popularity_class(@site, 100, 29)).to eql(1)
+		expect(described_class.calculate_popularity_class(@site, 100, 30)).to eql(2)
+		expect(described_class.calculate_popularity_class(@site, 100, 39)).to eql(2)
+		expect(described_class.calculate_popularity_class(@site, 100, 40)).to eql(2)
+		expect(described_class.calculate_popularity_class(@site, 100, 49)).to eql(2)
+		expect(described_class.calculate_popularity_class(@site, 100, 50)).to eql(3)
+		expect(described_class.calculate_popularity_class(@site, 100, 59)).to eql(3)
+		expect(described_class.calculate_popularity_class(@site, 100, 60)).to eql(3)
+		expect(described_class.calculate_popularity_class(@site, 100, 69)).to eql(3)
+		expect(described_class.calculate_popularity_class(@site, 100, 70)).to eql(4)
+		expect(described_class.calculate_popularity_class(@site, 100, 79)).to eql(4)
+		expect(described_class.calculate_popularity_class(@site, 100, 80)).to eql(4)
+		expect(described_class.calculate_popularity_class(@site, 100, 89)).to eql(4)
+		expect(described_class.calculate_popularity_class(@site, 100, 90)).to eql(5)
+		expect(described_class.calculate_popularity_class(@site, 100, 99)).to eql(5)
+		expect(described_class.calculate_popularity_class(@site, 100, 100)).to eql(5)
+	end
+
+	it "generates a tags structure for site" do
+		result = described_class.generate_tags_structure(@site)
+		expect(result["a"]["post_count"]).to eql("5")
+		expect(result["a"]["popularity"]).to eql("33")
+		expect(result["a"]["popularity_class"]).to eql("2")
+	end	
+	
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'jekyll'
+p File.expand_path('../lib/mm-jekyll-tags-list', File.dirname(__FILE__))
+require File.expand_path('../lib/mm-jekyll-tags-list', File.dirname(__FILE__))
+
+Jekyll.logger.log_level = :error
+
+RSpec.configure do |config|
+	config.run_all_when_everything_filtered = true
+	config.filter_run :focus
+
+	def test_dir(*subdirs)
+		File.join(File.dirname(__FILE__), *subdirs)
+	end
+
+	def source_dir(*subdirs)
+		test_dir('fixtures', *subdirs)
+	end
+
+	def dest_dir(*subdirs)
+		test_dir('dest', *subdirs)
+	end
+	
+	def build_configs(overrides, base_hash = Jekyll::Configuration::DEFAULTS)
+		Jekyll::Utils.deep_merge_hashes(base_hash, overrides)
+	end
+
+	def site_configuration(overrides = {})
+		build_configs({
+		"source"      => source_dir,
+		"destination" => dest_dir
+		}, build_configs(overrides))
+	end
+	
+	def build_site(config = {})
+		site = Jekyll::Site.new(site_configuration(
+		))
+		site.process
+		site
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mm-jekyll-tags-list
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tim Oram
@@ -86,8 +86,20 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://github.com/mitmaro/jekyll-tags-list
+files:
+- ".gitignore"
+- Changelog.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mm-jekyll-tags-list.rb
+- mm_jekyll_tags_list_plugin.gemspec
+- script/bootstrap
+- script/cibuild
+- spec/mm_jekyll_tags_list_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mitmaro/jekyll-tags-list-plugin
 licenses:
 - MIT
 metadata: {}
@@ -111,4 +123,6 @@ rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Tags List plugin for Jekyll
-test_files: []
+test_files:
+- spec/mm_jekyll_tags_list_spec.rb
+- spec/spec_helper.rb