jekyll-paginate-v2 1.7.0 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 520aefbd27b59fcb86fcaca7871c693295bafb16
-  data.tar.gz: 3e45a7ccc457134a43ee81520dc0f32971c9989d
+  metadata.gz: 9ce2b9e1db9613c363b49bd85abcde999a711f92
+  data.tar.gz: 4e1437c8cf70f5bc127db725e3b3ddb8b3993aac
 SHA512:
-  metadata.gz: 31e6855bc99cd94c7160da6e5926046f7cb32b783bd177c9b5ef1d3d38b989063746df296a3909159e3fbc43d9285202d424d165ef639c0187c002828b8ff332
-  data.tar.gz: 734e0a050c950f4535c49eb115009f65c509ecd20ce8c1c95b99b27fa535bef19f8a990457edd8a9e1207184004f617d84e416385bf1602c73af28470af51532
+  metadata.gz: bf461c4d569da1753e223721f06092d6f54c1fefe59910531bcaab16daa39af8494278527d984cb5c34e4ec4e1bf3da1a0f8869cdac364a75a0063e52da7afd1
+  data.tar.gz: 88df86ce35916323d5caf29f23bcb15e8a10f5607f91bc46a2f2de94823cc6a3957bfd1449bd55f3ab0da9e7774bfc80a6d30c9669a1d0312b6916e0fa9466cb

data/README-AUTOPAGES.md

@@ -62,6 +62,23 @@ Example of a simple autopage layout can be seen in Example 3 [examples/03-tags/_
 
 The layout does not need anything special beyond the normal pagination logic (e.g. `for post in paginator.posts` and then the next/prev arrows). You can either name the layouts by the default names (see site configuration section above) or give them a custom name and add them to the `layouts:` configuration for the relevant type of autopage.
 
+### Obtaining the original Tag or Category name
+Internally the autopage system will trim and downcase the indexing key (tag, category or collection name). To retrieve the original name of the index key you can use the `autopages.display_name` liquid variable.
+
+``` html
+<h1 class="page-heading">All pages tagged with <b>{% if page.autopages %}{{page.autopages.display_name}}{% endif %}</b></h1>
+```
+
+This variable returns the untouched key value. As an example if your site uses the tag `Science-Fiction` then
+
+```
+page.tag = "science-fiction"
+page.autopages.display_name = "Science-Fiction"
+```
+
+See [#6](https://github.com/sverrirs/jekyll-paginate-v2/issues/6) for more information.
+
+
 ## Advanced configuration
 You can customize the look an feel of the permalink structure and the title for the auto-pages. You can also add front-matter `pagination` configuration to the layout pages you're using to specify things like sorting, filtering and all the other configuration options that are available in the normal pagination generator.
 

data/README-GENERATOR.md

@@ -82,8 +82,6 @@ pagination:
 
  # Optional,omit or set both before and after to zero to disable. 
  # Controls how the pagination trail for the paginated pages look like. 
- # this feature enables the user to display a <prev, 1, 2, 3, 4, 5, next> pagination trail on their page
- # By default this feature produces two pages before and two pages after the current page (total of 5 pages)
   trail: 
     before: 2
     after: 2
@@ -368,7 +366,7 @@ pagination:
 ## Creating Pagination Trails
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/sverrirs/jekyll-paginate-v2/master/res/pagination-trails.png" width="59" />
+  <img src="https://raw.githubusercontent.com/sverrirs/jekyll-paginate-v2/master/res/pagination-trails.png" />
 </p>
 
 Creating a trail structure for your pagination as shown above can be achieved by enabling the `trail` configuration and including a little extra code in your liquid templates.
@@ -385,26 +383,27 @@ Your layout file would then have to include code similar to the following to gen
 ``` HTML
 {% if paginator.page_trail %}
   {% for trail in paginator.page_trail %}
-    <li>
+    <li {% if page.url == trail.path %}class="selected"{% endif %}>
         <a href="{{ trail.path | prepend: site.baseurl }}" title="{{trail.title}}">{{ trail.num }}</a>
     </li>
   {% endfor %}
 {% endif %}
 ```
+_See [example 3](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples/03-tags) for a demo of a pagination trail_
 
-The `trail` value exposes three properties:
+The `trail` object exposes three properties:
 * `num`: The number of the page
 * `path`: The path to the page
 * `title`: The title of the page
 
 The algorithm will always attempt to keep the same trail length for all pages (`trail length = before + after + 1`). 
-Example when on page 4 the trail for the configuration above would look like this
+As an example if we have only 7 pagination pages in total and the user is currently on page 6 then the trail would look like this
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/sverrirs/jekyll-paginate-v2/master/res/pagination-trails-p4.png" />
+  <img src="https://raw.githubusercontent.com/sverrirs/jekyll-paginate-v2/master/res/pagination-trails-p6.png" />
 </p>
 
-Different number of before and after trail links can be specified. Below is an example of how this yml config would look like when on the same page 4
+Different number of before and after trail links can be specified. Below is an example of how the yml config below would look like when on the same page 4
 
 ``` yml
 pagination:

data/README.md

@@ -11,7 +11,7 @@ Pagination gem built specially for Jekyll 3 and newer that is fully backwards co
 
 Reach me at the [project issues](https://github.com/sverrirs/jekyll-paginate-v2/issues) section or via email at [jekyll@sverrirs.com](mailto:jekyll@sverrirs.com).
 
-> The code was based on the original design of [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) and features were sourced discussions such as [#27](https://github.com/jekyll/jekyll-paginate/issues/27) (thanks [Günter Kits](https://github.com/gynter)).
+> The code was based on the original design of [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) and features were sourced from discussions such as [#27](https://github.com/jekyll/jekyll-paginate/issues/27) (thanks [Günter Kits](https://github.com/gynter)).
 
 * [Installation](#installation)
 * [Example Sites](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples)

data/lib/jekyll-paginate-v2/autopages/autoPages.rb

@@ -25,23 +25,23 @@ module Jekyll
 
       ###############################################
       # Generate the Tag pages if enabled
-      createtagpage_lambda = lambda do | autopage_tag_config, pagination_config, layout_name, tag |
-        site.pages << TagAutoPage.new(site, site.dest, autopage_tag_config, pagination_config, layout_name, tag)
+      createtagpage_lambda = lambda do | autopage_tag_config, pagination_config, layout_name, tag, tag_original_name |
+        site.pages << TagAutoPage.new(site, site.dest, autopage_tag_config, pagination_config, layout_name, tag, tag_original_name)
       end
       autopage_create(autopage_config, pagination_config, posts_to_use, 'tags', 'tags', createtagpage_lambda) # Call the actual function
       
 
       ###############################################
       # Generate the category pages if enabled
-      createcatpage_lambda = lambda do | autopage_cat_config, pagination_config, layout_name, category |
-        site.pages << CategoryAutoPage.new(site, site.dest, autopage_cat_config, pagination_config, layout_name, category)
+      createcatpage_lambda = lambda do | autopage_cat_config, pagination_config, layout_name, category, category_original_name |
+        site.pages << CategoryAutoPage.new(site, site.dest, autopage_cat_config, pagination_config, layout_name, category, category_original_name)
       end
       autopage_create(autopage_config, pagination_config,posts_to_use, 'categories', 'categories', createcatpage_lambda) # Call the actual function
       
       ###############################################
       # Generate the Collection pages if enabled
-      createcolpage_lambda = lambda do | autopage_col_config, pagination_config, layout_name, coll_name |
-        site.pages << CollectionAutoPage.new(site, site.dest, autopage_col_config, pagination_config, layout_name, coll_name)
+      createcolpage_lambda = lambda do | autopage_col_config, pagination_config, layout_name, coll_name, coll_original_name |
+        site.pages << CollectionAutoPage.new(site, site.dest, autopage_col_config, pagination_config, layout_name, coll_name, coll_original_name)
       end
       autopage_create(autopage_config, pagination_config,posts_to_use, 'collections', '__coll', createcolpage_lambda) # Call the actual function
     
@@ -58,13 +58,13 @@ module Jekyll
           Jekyll.logger.info "AutoPages:","Generating #{configkey_name} pages"
 
           # Roll through all documents in the posts collection and extract the tags
-          index_keys = Utils.index_posts_by(posts_to_use, indexkey_name).keys # Cannot use just the posts here, must use all things.. posts, collections...
+          index_keys = Utils.ap_index_posts_by(posts_to_use, indexkey_name) # Cannot use just the posts here, must use all things.. posts, collections...
 
-          index_keys.each do |index_key|
+          index_keys.each do |index_key, value|
             # Iterate over each layout specified in the config
             ap_sub_config ['layouts'].each do | layout_name |
               # Use site.dest here as these pages are never created in the actual source but only inside the _site folder
-              createpage_lambda.call(ap_sub_config, pagination_config, layout_name, index_key)
+              createpage_lambda.call(ap_sub_config, pagination_config, layout_name, index_key, value[-1]) # the last item in the value array will be the display name
             end
           end
         else

data/lib/jekyll-paginate-v2/autopages/pages/baseAutoPage.rb

@@ -2,7 +2,7 @@ module Jekyll
   module PaginateV2::AutoPages
 
     class BaseAutoPage < Jekyll::Page
-      def initialize(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda)
+      def initialize(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda, display_name)
         @site = site
         @base = base
         @name = 'index.html'
@@ -46,7 +46,7 @@ module Jekyll
 
         # Add the auto page flag in there to be able to detect the page (necessary when figuring out where to load it from)
         # TODO: Need to re-think this variable!!!
-        self.data['autopage'] = {"layout_path" => File.join( layout_dir, layout_name ) }
+        self.data['autopage'] = {"layout_path" => File.join( layout_dir, layout_name ), 'display_name' => display_name.to_s }
 
         data.default_proc = proc do |_, key|
           site.frontmatter_defaults.find(File.join(layout_dir, layout_name), type, key)

data/lib/jekyll-paginate-v2/autopages/pages/categoryAutoPage.rb

@@ -2,7 +2,7 @@ module Jekyll
   module PaginateV2::AutoPages
 
     class CategoryAutoPage < BaseAutoPage
-      def initialize(site, base, autopage_config, pagination_config, layout_name, category)
+      def initialize(site, base, autopage_config, pagination_config, layout_name, category, category_name)
 
         # Construc the lambda function to set the config values
         # this function received the pagination config hash and manipulates it
@@ -19,7 +19,7 @@ module Jekyll
         end
                 
         # Call the super constuctor with our custom lambda
-        super(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda)
+        super(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda, category_name)
         
       end #function initialize
 

data/lib/jekyll-paginate-v2/autopages/pages/collectionAutoPage.rb

@@ -2,7 +2,7 @@ module Jekyll
   module PaginateV2::AutoPages
 
     class CollectionAutoPage < BaseAutoPage
-      def initialize(site, base, autopage_config, pagination_config, layout_name, collection)
+      def initialize(site, base, autopage_config, pagination_config, layout_name, collection, collection_name)
 
         # Construc the lambda function to set the config values
         # this function received the pagination config hash and manipulates it
@@ -19,7 +19,7 @@ module Jekyll
         end
                 
         # Call the super constuctor with our custom lambda
-        super(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda)
+        super(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda, collection_name)
         
       end #function initialize
 

data/lib/jekyll-paginate-v2/autopages/pages/tagAutoPage.rb

@@ -2,7 +2,7 @@ module Jekyll
   module PaginateV2::AutoPages
 
     class TagAutoPage < BaseAutoPage
-      def initialize(site, base, autopage_config, pagination_config, layout_name, tag)
+      def initialize(site, base, autopage_config, pagination_config, layout_name, tag, tag_name)
 
         # Construc the lambda function to set the config values, 
         # this function received the pagination config hash and manipulates it
@@ -19,7 +19,7 @@ module Jekyll
         end
                 
         # Call the super constuctor with our custom lambda
-        super(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda)
+        super(site, base, autopage_config, pagination_config, layout_name, set_autopage_data_lambda, get_autopage_permalink_lambda, get_autopage_title_lambda, tag_name)
         
       end #function initialize
 

data/lib/jekyll-paginate-v2/autopages/utils.rb

@@ -33,7 +33,7 @@ module Jekyll
         return coll
       end
 
-      def self.index_posts_by(all_posts, index_key)
+      def self.ap_index_posts_by(all_posts, index_key)
         return nil if all_posts.nil?
         return all_posts if index_key.nil?
         index = {}
@@ -52,16 +52,16 @@ module Jekyll
           end
           
           for key in post_data
-            key = key.downcase.strip
+            key = key.strip
             # If the key is a delimetered list of values 
             # (meaning the user didn't use an array but a string with commas)
-            for k_split in key.split(/;|,/)
-              k_split = k_split.downcase.strip #Clean whitespace and junk
+            for raw_k_split in key.split(/;|,/)
+              k_split = raw_k_split.to_s.downcase.strip #Clean whitespace and junk
               if !index.has_key?(k_split)
-                index[k_split.to_s] = []
+                # Need to store the original key value here so that I can present it to the users as a page variable they can use (unmodified, e.g. tags not being 'sci-fi' but "Sci-Fi")
+                # Also, only interested in storing all the keys not the pages in this case
+                index[k_split.to_s] = [k_split.to_s, raw_k_split.to_s]
               end
-              # TODO: Need to store the original key value here so that I can present it to the users as a page variable they can use (unmodified, e.g. tags not being 'sci-fi' but "Sci-Fi")
-              index[k_split.to_s] << post
             end
           end
         end

data/lib/jekyll-paginate-v2/generator/paginationPage.rb

@@ -22,6 +22,12 @@ module Jekyll
         self.data = Jekyll::Utils.deep_merge_hashes( page_to_copy.data, {} )
         if !page_to_copy.data['autopage']
           self.content = page_to_copy.content
+        else
+          # If the page is an auto page then migrate the necessary autopage info across into the
+          # new pagination page (so that users can get the correct keys etc)
+          if( page_to_copy.data['autopage'].has_key?('display_name') )
+            self.data['autopages'] = Jekyll::Utils.deep_merge_hashes( page_to_copy.data['autopage'], {} )
+          end
         end
 
         # Perform some validation that is also performed in Jekyll::Page

data/lib/jekyll-paginate-v2/version.rb

@@ -1,8 +1,8 @@
 module Jekyll
   module PaginateV2
-    VERSION = "1.7.0"
+    VERSION = "1.7.2"
     # When modifying remember to issue a new tag command in git before committing, then push the new tag
-    # git tag -a v1.7.0 -m "Gem v1.7.0"
+    # git tag -a v1.7.2 -m "Gem v1.7.2"
     # git push origin --tags
   end # module PaginateV2
 end # module Jekyll

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.2
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-29 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll