jekyll-category_generator 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9190022eb9493e3e9ac4157263a6d81bdfb5bca
-  data.tar.gz: c08736efa6b9b376d598b62f94139853f4670158
+  metadata.gz: d554cee62eeab79fd1fc2bde081c1c6747742bd0
+  data.tar.gz: 0b7b924d91668bd8b08be0a5e4c3c60c65730145
 SHA512:
-  metadata.gz: 6b8fc47cc6626c3ebbd57b1150827d07ec14bc912e6828e4237e40e872cd6014202aa51891c19c47bf01187c8be0db9c4c4e5b74dbd4bb95a7a2159f997a9d3b
-  data.tar.gz: e09a05d3d8176a8f11caa609c7ace9783fcf1607fe22b8e13dcabf6dedab8bfc1b086a4238afd8d09bfcc0decd4dfcf8870336e800980b3538fa65e6e51d52e0
+  metadata.gz: b11a75f5ef74522d0ae167b79d372eb561aab20e78e2bb4c26fad57c8084fdae02bb9e2a6fdbd1224992b63ef500b20ff014b8934d25e2ed6a58def88356fac7
+  data.tar.gz: 404e7820c7237683f31f7b2a14e83e3b1816fdcba0cee6c2963011057fa13d7088aaa412962000a5163bdb01521fb47674f10366cfc23811075d9c0abea58323

data/lib/jekyll-category_generator.rb

@@ -13,7 +13,7 @@ require 'jekyll/category_generator/category_filters.rb'
 module Jekyll
   # The category generator module
   module CategoryGenerator
-    DIRECTORIES_FOLDER = 'categories'.freeze
+    CATEGORIES_FOLDER = 'categories'.freeze
     # Jekyll hook - the generate method is called by jekyll, and generates all of the category pages.
     class CGenerator < Generator
       safe true

data/lib/jekyll/category_generator/categories.rb

@@ -14,6 +14,7 @@ module Jekyll
     # +context+ is the Liquid:Tag context
     #
     def initialize(category_names, context)
+      @context = context
       category_names = [category_names] unless category_names.is_a? Array
       initialize_category_list(category_names, context)
     end
@@ -29,25 +30,29 @@ module Jekyll
     end
 
     ##
-    # Outputs a list of categories as comma-separated <a> links. This is used
+    # Outputs a list of categories as separated <a> links. This is used
     # to output the category list for each post on a category page.
     #
     # Returns string
     #
     def links
-      comma_separate(@category_list.sort!.map(&:link))
+      separate(@category_list.sort!.map(&:link))
     end
 
     private
 
     ##
-    # Join a list as comma-separated
-    def comma_separate(list_of_links)
-      if list_of_links.length == 1
-        list_of_links[0].to_s
-      else
-        "#{list_of_links[0...-1].join(', ')}, #{list_of_links[-1]}"
-      end
+    # Join the list of category
+    def separate(list_of_links)
+      list_of_links.join(category_link_separator).to_s
+    end
+
+    ##
+    # Get the defined category link separator
+    def category_link_separator
+      @context.registers[:site].config['jekyll-category_generator']['link_separator']
+    rescue
+      ' '
     end
   end
 end

data/lib/jekyll/category_generator/category.rb

@@ -38,8 +38,16 @@ module Jekyll
     #
     def link
       return '' until @name
-      dir = @context.registers[:site].config['category_dir'] || CategoryGenerator::DIRECTORIES_FOLDER
-      "<a class='category' href='/#{dir}/#{URI.encode(@name)}/'>#{@name}</a>"
+      "<a class='category' href='/#{categories_folder}/#{URI.encode(@name)}/'>#{@name}</a>"
+    end
+
+    ##
+    # Returns the categories folder
+    #
+    def categories_folder
+      @context.registers[:site].config['jekyll-category_generator']['category_dir']
+    rescue
+      CategoryGenerator::CATEGORIES_FOLDER
     end
   end
 end

data/lib/jekyll/category_generator/category_index.rb

@@ -20,22 +20,14 @@ module Jekyll
       data['category'] = category
       # Set the title for this page.
       data['title'] = "#{title_prefix}#{category}"
-      # Set the meta-description for this page.
-      data['description'] = "#{description_prefix}#{category}"
     end
 
-    private
-
     ##
     # Return the category title prefix
     def title_prefix
-      site.config['jekyll-category_generator.title_prefix'] || 'Category: '
-    end
-
-    ##
-    # Return the category description prefix
-    def description_prefix
-      site.config['jekyll-category_generator.description_prefix'] || 'Category: '
+      site.config['jekyll-category_generator']['title_prefix']
+    rescue
+      'Category: '
     end
   end
 end

data/lib/jekyll/category_generator/site_override.rb

@@ -33,7 +33,9 @@ module Jekyll
     # Returns the categories folder
     #
     def categories_folder
-      config['category_dir'] || CategoryGenerator::DIRECTORIES_FOLDER
+      config['jekyll-category_generator']['category_dir']
+    rescue
+      CategoryGenerator::CATEGORIES_FOLDER
     end
 
     # Raise an error on unexisting layout

data/lib/jekyll/category_generator/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module CategoryGenerator
-    VERSION = '0.0.3'.freeze
+    VERSION = '0.0.4'.freeze
   end
 end

data/readme.md

@@ -23,7 +23,7 @@ plugins:
   - jekyll-category_generator
 ```
 
-# Configuration
+## Create your layout
 First of all, you need to create a *layout* named `category_index.html`; It will be used to create the index of all posts of a category.
 
 The file should at least have the following code.
@@ -37,18 +37,23 @@ The file should at least have the following code.
 ```
 
 # Using the plugin
-The plugin contains usefull filters and configuration variables helping you to create a nice *layout*.
+The plugin contains usefull filters and [configuration](#configuration) variables helping you to create a nice *layout*.
 
 ## Filters
 ### category_links
-This filter allows you to create a list of links of all the given categories. 
-
-Usefull to add to the end of a page for example.
+Usefull to add to the bottom of a **page**, this filter allows you to create a list of links of all the given categories generated by default in the `categories` folder (see [category_dir](#category_dir) for configuration). 
 
+For example,
 ```html
 {{ page.categories | category_links }}
 ```
 
+will render by default the following (see [link_separator](#link_separator) for configuration). 
+```html
+<a class="category" href="/categories/ionic/">ionic</a>
+<a class="category" href="/categories/ruby%20on%20rails/">ruby on rails</a>
+```
+
 ### category_link 
 This filter allows you to create the link of a given category. 
 
@@ -63,25 +68,31 @@ Usefull for a menu listing all categories for example.
 ```
 
 ### date_to_html_string
-This filter allows you to output a HtML formatted date (`2017-03-12` by default).
+This filter allows you to output a HtML formatted date (`%Y-%m-%d` by default, see [date format](#date-format) for configuration).
 
-This code 
+For example,
 ```html 
 {{ post.date | date_to_html_string }}
 ```
 
-The format can be specified in the `_config.yml` file.
+will render by default something like
+```
+2017-07-01
+```
 
-## Variables in `_config.yml`
+## Configuration 
+All variables must be set under the `jekyll-category_generator` key in the `_config.yml` file!
 
-### Basics configuration keys
-The title of the category can be prefixed by the `title_prefix` value, by default, it is set with **Category:**
+### title_prefix
+The **title** of the category can be **prefixed** by the `title_prefix` value, by default, it is set with **Category:**. So when using `{{ page.title }}` in your `category_index` layout, it will be prefixed.
 
-The category directory is by default the `categories/` folder, but you can change it by adding the `category_dir` key.
+### category_dir
+The category **directory** is by default the `categories/` folder, but you can change it by adding the `category_dir` key.
 
-The `description_prefix` configuration key can be used to prefix each post description.
+### link_separator
+When joinning category links, the generator will use white space by default, but you can specify the separator using the `link_separator` key.
 
-### Date format configuration
+### date format
 The `date_to_html_string` filter allows you to stringify the date for your own language by adding the following.
 
 The *format* variable uses the Ruby [Time#strftime](http://ruby-doc.org/core-2.2.1/Time.html#method-i-strftime) method.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-category_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alain ANDRE