octopress-category-list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f5cee15f638374082b90708253efcdf2638b4ca
+  data.tar.gz: b48b15aae28d13da52186194b3804fdfa5f69421
+SHA512:
+  metadata.gz: 91aa4d35835718281801c268e376a074dd51b4530e25b4f7ffdacddde057e31d50050406c1637d8ee9e898a8a0ec0701d5788804186c30276a81e85956edb8cb
+  data.tar.gz: 5161e26fa7267a71a6b9269ef4d68a95ed9a14c659fce8dcc3941aa1b8a803f965e68b2e3101e96a3ac754c05a56d070849c07b30ea5c52f8993872f0e6110d2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0 - 2015-05-18
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Wang Jian
+
+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,52 @@
+# OctopressCategoryList
+
+A Octopress Ink plugin to generate a category list page for your site.
+
+[![Build Status](https://travis-ci.org/wantee/octopress-category-list.svg)](https://travis-ci.org/wantee/octopress-category-list)
+[![Gem Version](https://badge.fury.io/rb/octopress-category-list.svg)](http://badge.fury.io/rb/octopress-category-list)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/wantee/octopress-category-list/blob/master/LICENSE.txt)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'octopress-category-list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-category-list
+
+## Usage
+
+Make sure generating category indexes in your site. Set this in your theme config:
+
+```yaml
+category_indexes:  true
+```
+
+Then add navigation to categories or other place to link to `/categories/`:
+
+```yaml
+main_nav:
+  - { url: '/categories/', title: 'Categories' }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/wantee/octopress-category-list/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/assets/config.yml

@@ -0,0 +1,2 @@
+categories_dir:           "categories"
+category_list_title:      "Categories"

data/assets/includes/category_list_category.html

@@ -0,0 +1,14 @@
+<article class="archive {{ category }}" role="article">
+  {% capture category_permalink %}/categories/{{ category }}/{% endcapture %}
+  <header class="archive-entry-header">
+    <h2 class="archive-entry-title"><a href='{{ category_permalink }}'>{{ category | titlecase }}</a></h2>
+    <div class="archive-entry-date"> posts: {% category_size category %}</div>
+  </header>
+
+
+  <footer class='archive-entry-footer' role='contentinfo'>
+  <p>
+    <a href='{{ category_permalink }}'>Permalink</a>
+  </p>
+  </footer>
+</article>

data/assets/templates/category_list.html

@@ -0,0 +1,15 @@
+---
+layout: theme:default
+---
+<div class="post-archive limit-width">
+  <div class="category-index">
+    {% capture categories %}{% for category in site.categories %}|{{ category | first | strip }}{% endfor %}{% endcapture %}
+
+    {% assign sorted_categories = categories | remove_first:'|' | split:'|' | sort %}
+
+    {% for category in sorted_categories %}
+      {% include octopress-category-list:category_list_category.html %}
+    {% endfor %}
+    </div>
+  </div>
+</div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "octopress_category_list"
+
+# 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/lib/octopress-category-list.rb

@@ -0,0 +1,21 @@
+require 'octopress-category-list/version'
+require 'octopress-ink'
+
+module OctopressCategoryList
+    autoload :Plugin,          'octopress-category-list/plugin'
+    autoload :Tags,            'octopress-category-list/tags'
+end
+
+Liquid::Template.register_tag('category_size', OctopressCategoryList::Tags)
+
+Octopress::Ink.register_plugin(OctopressCategoryList::Plugin, { 
+  name:          "Octopress Category List",
+  slug:          "octopress-category-list",
+  gem:           "octopress-category-list",
+  path:          File.expand_path(File.join(File.dirname(__FILE__), "..")),
+  type:          "plugin",
+  version:       OctopressCategoryList::VERSION,
+  description:   "Generating a category list page",
+  source_url:    "https://github.com/wantee/octopress-category-list", 
+  websit:        "https://github.com/wantee/octopress-category-list"
+})

data/lib/octopress-category-list/config.rb

@@ -0,0 +1,13 @@
+module OctopressCategoryList
+
+  class Config
+
+    def self.default_config
+<<-CONFIG
+categories_dir:           "categories"
+category_list_title:      "Categories"
+CONFIG
+    end
+
+  end
+end

data/lib/octopress-category-list/plugin.rb

@@ -0,0 +1,40 @@
+module OctopressCategoryList
+  autoload :Config,           'octopress-category-list/config'
+
+  class Plugin < Octopress::Ink::Plugin
+
+    def register
+      super
+      if Octopress::Ink.enabled?
+        self.generate(Octopress.site, config)
+      end
+    end
+
+    def generate(site, config)
+      @conf = inject_configs
+
+      @template = find_template('category_list.html')
+
+      return unless @template
+
+      permalink = "/" + @conf['categories_dir'] + "/index.html"
+      if page = @template.new_page({
+          'lang'      => nil,
+          'title'     => @conf['category_list_title'],
+          'permalink' => permalink,
+          'plugin'    => self
+        })
+
+        Octopress::Ink::Bootstrap.add_page(page, nil)
+        Octopress.site.pages << page
+      end
+
+    end
+
+    def inject_configs
+      @conf = self.config
+      @conf = Jekyll::Utils.deep_merge_hashes(YAML.load(Config.default_config), @conf)
+    end
+
+  end
+end

data/lib/octopress-category-list/tags.rb

@@ -0,0 +1,31 @@
+module OctopressCategoryList
+
+  class Tags < Liquid::Tag
+    def initialize(tag_name, input, tokens)
+      super
+      @input = input.strip
+    end
+
+    def render(context)
+      site = context.registers[:site]
+
+      category_name = @input
+      if ! site.categories.has_key?(category_name)
+        # if it is a variable
+        if context[@input]
+           category_name = context[@input].strip
+        end
+
+        if ! site.categories.has_key?(category_name)
+          raise ArgumentError.new <<-eos
+Could not find category "#{@input}"  or "#{category_name}" in tag 'category_size'.
+make sure the category exists and the name is correct.
+eos
+        end
+      end
+
+      site.categories[category_name].size
+    end
+  end
+end
+

data/lib/octopress-category-list/version.rb

@@ -0,0 +1,3 @@
+module OctopressCategoryList
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: octopress-category-list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wang Jian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: clash
+  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: octopress-genesis-theme
+  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: octopress-ink
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Generating a category list page.
+email:
+- wantee.wang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- assets/config.yml
+- assets/includes/category_list_category.html
+- assets/templates/category_list.html
+- bin/console
+- bin/setup
+- lib/octopress-category-list.rb
+- lib/octopress-category-list/config.rb
+- lib/octopress-category-list/plugin.rb
+- lib/octopress-category-list/tags.rb
+- lib/octopress-category-list/version.rb
+homepage: https://github.com/wantee/octopress-category-list.git
+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: Generating a category list page.
+test_files: []