octopress-categories 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58ba8d339175910c1d20d4f6cc57b07257d21573
+  data.tar.gz: 297c7afc1748627d049869774bf881d8cab32873
+SHA512:
+  metadata.gz: d6b19ed84eaf9f2cfb3d79bae2f53b3d30e48d0f8edac153c2b83ea6712e09e60deb4b437ed6648c420885a505fe3403fc1bd963463e550c8a9d2d9193206ae9
+  data.tar.gz: c907a7296609b8b9285d94be86110401a8ea08bd68905fa1bd063954bbc5e3854f456c27a36f8fd3b27ef25460f950ec660c67843c44c89f97faae5d07a3af46

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+### 0.0.1 (2015-XX-XX)
+
+- Support for category indexes
+- Multilingual support

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brandon Mathis, Patrice Brend'amour
+
+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,118 @@
+# Categories
+
+TODO: Write a gem description
+
+[![Build Status](http://img.shields.io/travis/octopress/categories.svg)](https://travis-ci.org/octopress/categories)
+[![Gem Version](http://img.shields.io/gem/v/octopress-categories.svg)](https://rubygems.org/gems/octopress-multilingual)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://octopress.mit-license.org)
+
+## Installation
+
+If you're using bundler add this gem to your site's Gemfile in the `:jekyll_plugins` group:
+
+    group :jekyll_plugins do
+      gem 'octopress-categories'
+    end
+
+Then install the gem with Bundler
+
+    $ bundle
+
+To install manually without bundler:
+
+    $ gem install octopress-categories
+
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      - octopress-categories
+
+
+## Usage
+
+For multilingual category pages, install [octopress-multilingual](https://github.com/octopress/multilingual).
+
+## Customize categories
+
+To list detailed information about this plugin, run `$ octopress ink list categories`. This will output something like this:
+
+```
+Plugin: Octopress Categories - v0.0.1
+Slug: categories
+Category pages for Octopress and Jekyll pages.
+================================================================================
+ includes:
+  - category_feed.xml
+  - category_index.html
+
+ config:
+   category_dir: "categories"
+   prefixes: 
+     title: "Category: "
+     meta_description: "Category: "
+   feed: 
+     enabled: false
+     count: 5
+   permalinks:
+
+ category-pages:
+  - announcements                   /categories/announcements/
+
+```
+
+If you have posts written in English and German, and are using [octopress-multilingual](https://github.com/octopress/multilingual),
+your permalinks will automatically be name-spaced by language, like this:
+
+```
+category-pages:
+  - announcements-de                   /de/categories/announcements/
+  - announcements-en                   /en/categories/announcements/
+```
+
+Octopress Ink can copy all of the plugin's assets to `_plugins/categories/*` where you can override them with your own modifications. This is
+only necessary if you want to modify this plugin's behavior.
+
+```
+octopress ink copy categories
+```
+
+This will copy the plugin's configuration and includes from the gem, to your local site. If, for example, you want to change the HTML for a category's index, you can simply edit the `_plugins/includes/category_index.html` file.
+
+If you want to revert to the defaults, simply delete any file you don't care to override from the `_plugins/categories/` directory.
+
+## Linking to the category pages
+
+This plugin includes a handy filter `category_links` that allows you to automatically link to a post's category pages.
+Here's how you use it:
+
+```
+{% capture num_categories %}{% if post %}{{ post.categories | size }}{% else %}{{ page.categories | size }}{% endif %}{% endcapture %}
+{% unless num_categories == '0' %}
+<span class="categories">
+  {% if post %}
+    {{ post.categories | category_links }}
+  {% else %}
+    {{ page.categories | category_links }}
+  {% endif %}
+</span>
+{% endunless %}
+
+```
+
+## Configuration
+
+To configure this plugin, first create a configuration file at `_plugins/categories/config.yml`. If you like, you can have Octopress Ink add it for you.
+
+```
+$ octopress ink copy categories --config-file
+```
+
+This will create a configuration file populated with the defaults for this plugin. Deleting this file will restore the default configuration.
+
+## Contributing
+
+1. Fork it ( https://github.com/drallgood/octopress-categories/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,7 @@
+category_dir: categories
+prefixes:
+  title: "Category: "
+  meta_description: "Category: "
+feed:
+  enabled: false
+  count: 5

data/assets/includes/category_feed.xml

@@ -0,0 +1,7 @@
+{% assign feed_type = 'category' %}{% include feeds:head.xml %}
+{% for post in site.categories[page.category] limit: plugins.categories.feed_count %}
+  <entry>
+    {% include feeds:entry.xml %}
+  </entry>
+{% endfor %}
+</feed>

data/assets/includes/category_index.html

@@ -0,0 +1,22 @@
+---
+layout: page
+---
+
+<div class="category">
+{% for post in site.categories[page.category] %}
+	{% capture this_year %}{{ post.date | date: "%Y" }}{% endcapture %}
+	{% unless year == this_year %}
+	  {% assign year = this_year %}
+	  <h2>{{ year }}</h2>
+	{% endunless %}
+	<article>
+	  <h3><a href="{{ root_url }}{{ post.url }}">{% if site.titlecase %}{{ post.title | titlecase }}{% else %}{{ post.title }}{% endif %}</a></h3>
+	  <time datetime="{{ post.date | datetime | date_to_xmlschema }}" pubdate>{{ post.date | date: "<span class='month'>%b</span> <span class='day'>%d</span> <span class='year'>%Y</span>"}}</time>
+		{% if categoryNumber != '0' %}
+		<footer>
+		  <span class="categories">Posted in {{ post.categories | category_links }}</span>
+		</footer>
+		{% endif %}
+	</article>
+{% endfor %}
+</div>

data/lib/octopress-categories.rb

@@ -0,0 +1,95 @@
+require 'octopress-ink'
+require 'octopress-categories/version'
+require 'octopress-categories/page_asset'
+require 'octopress-categories/filters'
+
+module Octopress
+  module Categories
+    class Plugin < Ink::Plugin
+
+      attr_reader :category_pages
+
+      def initialize(options)
+        super
+        @category_pages = []
+      end
+
+      def register
+        super
+        unless @assets_path.nil?
+          if Octopress::Ink.enabled?
+            add_category_pages
+          end
+        end
+      end
+
+      def assets
+        superAssets = super
+        superAssets.merge!({
+                             "category-pages" => @category_pages
+        })
+      end
+
+      def add_category_pages
+
+        # Find the correct template
+        template = @includes.detect { |l|
+          l.file == "category_index.html"
+        }
+
+        created_pages = []
+        if defined? Octopress::Multilingual
+          # We need to create pages for each language
+          Octopress.site.languages.each do |lang|
+            category_pages_lang = createCategoryPages(template, config(lang))
+            category_pages_lang.each { |p|
+              p.data.merge!({"lang"=>lang})
+            }
+            created_pages.concat(category_pages_lang)
+          end
+        else
+          created_pages = createCategoryPages(template, config)
+        end
+
+        @category_pages.concat(created_pages)
+      end
+
+      def createCategoryPages(template, config)
+        categoryPages = []
+        Octopress.site.categories.keys.each do |category|
+          categoryPages << CategoryPageAsset.new(self, template, category)
+        end
+        categoryPages
+      end
+
+      def add_asset_files(options)
+        options << "category-pages"
+        super
+      end
+
+      def category_dir(category)
+        category_base_dir = config['category_dir'].gsub(/^\/*(.*)\/*$/, '\1')
+        # Make sure the category directory begins with a slash.
+        category_base_dir = "/#{category_base_dir}" unless category_base_dir =~ /^\//
+        File.join(category_base_dir, slugifyCategory(category))
+      end
+
+      def slugifyCategory(category)
+        category.gsub(/_|\P{Word}/, '-').gsub(/-{2,}/, '-').tr( '^A-Za-z0-9\-_', '-' ).downcase
+      end
+    end
+  end
+end
+
+#Octopress::Ink.add_plugin({
+Octopress::Ink::Plugins.register_plugin(Octopress::Categories::Plugin,{
+                                          name:          "Octopress Categories",
+                                          slug:          "categories",
+                                          gem:           "octopress-categories",
+                                          path:          File.expand_path(File.join(File.dirname(__FILE__), "..")),
+                                          type:          "plugin",
+                                          version:       Octopress::Categories::VERSION,
+                                          description:   "Category pages for Octopress and Jekyll pages.",                                # What does your theme/plugin do?
+                                          source_url:    "https://github.com/drallgood/octopress-categories",
+                                          website:       "https://github.com/drallgood/octopress-categories"                                 # Optional project website
+})

data/lib/octopress-categories/filters.rb

@@ -0,0 +1,37 @@
+module Octopress
+  module Categories
+    module Filters
+      # Outputs a list of categories as comma-separated <a> links. This is used
+      # to output the category list for each post on a category page.
+      #
+      #  +categories+ is the list of categories to format.
+      #
+      # Returns string
+      def category_links(categories)
+        plugin = Ink::Plugins.plugin("categories")
+        root = @context.registers[:site].baseurl
+        language = @context.registers[:page]['lang']
+
+
+        categories = categories.sort!.map do |category|
+          category_dir = plugin.category_dir(category)
+          
+          if language
+            category_dir = "/#{language}#{category_dir}"
+          end
+          "<a class='category' href='#{root}#{category_dir}/'>#{category.capitalize}</a>"
+        end
+
+        case categories.length
+        when 0
+          ""
+        when 1
+          categories[0].to_s
+        else
+          categories.join(', ')
+        end
+      end
+    end
+  end
+end
+Liquid::Template.register_filter(Octopress::Categories::Filters)

data/lib/octopress-categories/page_asset.rb

@@ -0,0 +1,65 @@
+module Octopress
+  module Categories
+    class CategoryPageAsset < Ink::Assets::PageAsset
+
+      attr_accessor :category 
+
+      def initialize(plugin, template, category)
+        super(plugin, template.base, template.file)
+        self.category = category
+      end
+
+      def clone(plugin, template, category)
+        p = CategoryPageAsset.new(plugin, template, category)
+        p
+      end
+
+      def copy(target_dir)
+        # Don't copy anything
+      end
+
+      def info
+        message = super
+        name = permalink_name << page.ext
+        message.sub!(/#{name}\s*/, permalink_name.ljust(35))
+        message.sub!(/#{filename}\s*/, filename.ljust(35))
+        message.sub!(/\.\/#{filename}*/, "#{@plugin.slug}/includes/#{filename}")
+        message
+      end
+
+      def permalink_name
+        name = plugin.slugifyCategory(category)
+        if lang
+          name = "#{name}-#{lang}"
+        end
+        name
+      end
+
+      def permalink
+        link = "/#{plugin.category_dir(category)}/"
+        if lang
+          link = "/#{lang}#{link}"
+        end
+        link
+      end
+
+      def category=(category)
+        title_prefix = plugin.config['prefixes']['title'] || 'Category: '
+        meta_description_prefix = plugin.config['prefixes']['meta_description'] || 'Category: '
+        @data.merge!({
+                       "category"=>category,
+                       "title"=>"#{title_prefix}#{category.capitalize}",
+                       "description"=>"#{meta_description_prefix}#{category.capitalize}"
+        })
+        @category = category
+        @category_dir = plugin.category_dir(category)
+      end
+
+      private
+
+      def lang
+        data['lang']
+      end
+    end
+  end
+end

data/lib/octopress-categories/version.rb

@@ -0,0 +1,5 @@
+module Octopress
+  module Categories
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: octopress-categories
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrice Brend'amour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octopress-ink
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc
+- !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: octopress
+  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: 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-multilingual
+  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-debugger
+  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: 
+email:
+- patrice@brendamour.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- assets/config.yml
+- assets/includes/category_feed.xml
+- assets/includes/category_index.html
+- lib/octopress-categories.rb
+- lib/octopress-categories/filters.rb
+- lib/octopress-categories/page_asset.rb
+- lib/octopress-categories/version.rb
+homepage: ''
+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: Category pages for Octopress and Jekyll pages.
+test_files: []