jekyll-paginate-v2 1.9.2 → 1.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f15ac980bc5f0d9247bc5c939e01b60817ac572d
-  data.tar.gz: 2aba630fd12a6b32d4ab3df5efadb0b005590c8d
+  metadata.gz: 59ee73bfdddde665bfcac280629290ca03b809bc
+  data.tar.gz: a9534eca1fc37f499b33e8f4a4c6cefaf6b67adf
 SHA512:
-  metadata.gz: 0eacf17144bd636451263625cc0c1ad9850d112070a69c0e6bcd3e37acc84095722bbfe469f04560ed17c619618ee4ed61667eb26b03110df0ca85066a0ce915
-  data.tar.gz: 73a3e97b8db75f491f2b30294109c84c3839f52917e8e5f03010a6709053e9cf08151a889874a8210b8a7a1c8d0eb794d9dbbde558e8dacf1643609e3e85b63f
+  metadata.gz: 15f6a51f471f9950952f9ebbe45f4306dbd7c15ea70a95849d74f73c9b9905a44473d4284bd46aa30129ee13c71f630387326d97d7524f0ffeb8787f77d32ad1
+  data.tar.gz: 97299085a18024745768845f073e8d2a3d8df2ba41f6d07c3298dd15511d6dba6d7086cb603288b57fa424370b6de73ff52e42cc250dc80bd5f3e99d8820aada

data/README-GENERATOR.md

@@ -508,6 +508,7 @@ Paginating content meets both of these requirements, but developers are limited
 First, create a new jekyll page and set its layout to `null` to avoid any extra html to show up.
 
 Next, use the `extension` and `indexpage` option to customize the output of the page and its paginated content as JSON files.
+> Note that the `indexpage` field also supports the same macros as the permalink field
 
 Here's an example page:
 ```
@@ -515,10 +516,10 @@ Here's an example page:
 layout: null
 permalink: /api
 pagination:
-  permalink: 'feed-:num'
+  permalink: ''
   enabled: true
-  extension: json
-  indexpage: 'feed-1'
+  extension: .json
+  indexpage: 'feed-:num'
 ---
 
 {
@@ -649,4 +650,4 @@ pagination:
   permalink: '/cars/:num/'
 ```
 
-Make absolutely sure that your pagination permalink paths do not clash with any other paths in your final site. For simplicity it is recommended that you keep all custom pagination (non root index.html) in a single or multiple separate sub folders under your site root.
+Make absolutely sure that your pagination permalink paths do not clash with any other paths in your final site. For simplicity it is recommended that you keep all custom pagination (non root index.html) in a single or multiple separate sub folders under your site root.

data/README.md

@@ -25,10 +25,6 @@ Reach me at the [project issues](https://github.com/sverrirs/jekyll-paginate-v2/
 
 :heart:
 
-<a target='_blank' rel='nofollow' href='https://app.codesponsor.io/link/zzB7QVjdsbLjtaFcQie3TDxC/sverrirs/jekyll-paginate-v2'>
-  <img alt='Sponsor' width='888' height='68' src='https://app.codesponsor.io/embed/zzB7QVjdsbLjtaFcQie3TDxC/sverrirs/jekyll-paginate-v2.svg' />
-</a>
-
 ## Installation
 
 ```

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

@@ -2,9 +2,9 @@ module Jekyll
   module PaginateV2::AutoPages
 
     #
-    # When the site has been read then go a head an generate the necessary extra pages
+    # This function is called right after the main generator is triggered by Jekyll
     # This code is adapted from Stephen Crosby's code https://github.com/stevecrozz
-    Jekyll::Hooks.register :site, :post_read do |site|
+    def self.create_autopages(site)
 
       # Get the configuration for the auto pages
       autopage_config = Jekyll::Utils.deep_merge_hashes(DEFAULT, site.config['autopages'] || {})
@@ -13,7 +13,7 @@ module Jekyll
       # If disabled then don't do anything
       if !autopage_config['enabled'] || autopage_config['enabled'].nil?
         Jekyll.logger.info "AutoPages:","Disabled/Not configured in site.config."
-        next ## Break the loop, could be an issue if the hook is called again though??
+        return
       end
 
       # TODO: Should I detect here and disable if we're running the legacy paginate code???!
@@ -45,7 +45,7 @@ module Jekyll
       end
       autopage_create(autopage_config, pagination_config,posts_to_use, 'collections', '__coll', createcolpage_lambda) # Call the actual function
     
-    end # Jekyll::Hooks
+    end # create_autopages
 
 
     # STATIC: this function actually performs the steps to generate the autopages. It uses a lambda function to delegate the creation of the individual
@@ -74,4 +74,4 @@ module Jekyll
     end
 
   end # module PaginateV2
-end # module Jekyll
+end # module Jekyll

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

@@ -8,20 +8,31 @@ module Jekyll
         'layouts'       => ['autopage_tags.html'],
         'title'         => 'Posts tagged with :tag',
         'permalink'     => '/tag/:tag',
-        'enabled'       => true
-
+        'enabled'       => true,
+        'slugify'       => {
+                              'mode' => 'none', # [raw default pretty ascii latin], none gives back the same string
+                              'cased'=> false # If cased is true, all uppercase letters in the result string are replaced with their lowercase counterparts.
+                            }
       },
       'categories'  => {
         'layouts'       => ['autopage_category.html'],
         'title'         => 'Posts in category :cat',
         'permalink'     => '/category/:cat',
-        'enabled'       => true
+        'enabled'       => true,
+        'slugify'       => {
+                              'mode' => 'none', # [raw default pretty ascii latin], none gives back the same string
+                              'cased'=> false # If cased is true, all uppercase letters in the result string are replaced with their lowercase counterparts.
+                            }
       },
       'collections' => {
         'layouts'       => ['autopage_collection.html'],
         'title'         => 'Posts in collection :coll',
         'permalink'     => '/collection/:coll',
-        'enabled'       => true
+        'enabled'       => true,
+        'slugify'       => {
+                              'mode' => 'none', # [raw default pretty ascii latin], none gives back the same string
+                              'cased'=> false # If cased is true, all uppercase letters in the result string are replaced with their lowercase counterparts.
+                            }
       } 
     }
 

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

@@ -4,6 +4,9 @@ module Jekyll
     class CategoryAutoPage < BaseAutoPage
       def initialize(site, base, autopage_config, pagination_config, layout_name, category, category_name)
 
+        # Do we have a slugify configuration available
+        slugify_config = autopage_config.is_a?(Hash) && autopage_config.has_key?('slugify') ? autopage_config['slugify'] : nil
+
         # Construc the lambda function to set the config values
         # this function received the pagination config hash and manipulates it
         set_autopage_data_lambda = lambda do | in_config |
@@ -11,11 +14,11 @@ module Jekyll
         end
 
         get_autopage_permalink_lambda = lambda do |permalink_pattern|
-          return Utils.format_cat_macro(permalink_pattern, category)
+          return Utils.format_cat_macro(permalink_pattern, category, slugify_config)
         end
 
         get_autopage_title_lambda = lambda do |title_pattern|
-          return Utils.format_cat_macro(title_pattern, category)
+          return Utils.format_cat_macro(title_pattern, category, slugify_config)
         end
                 
         # Call the super constuctor with our custom lambda
@@ -25,4 +28,4 @@ module Jekyll
 
     end #class CategoryAutoPage
   end # module PaginateV2
-end # module Jekyll
+end # module Jekyll

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

@@ -4,6 +4,9 @@ module Jekyll
     class CollectionAutoPage < BaseAutoPage
       def initialize(site, base, autopage_config, pagination_config, layout_name, collection, collection_name)
 
+        # Do we have a slugify configuration available
+        slugify_config = autopage_config.is_a?(Hash) && autopage_config.has_key?('slugify') ? autopage_config['slugify'] : nil
+
         # Construc the lambda function to set the config values
         # this function received the pagination config hash and manipulates it
         set_autopage_data_lambda = lambda do | in_config |
@@ -11,11 +14,11 @@ module Jekyll
         end
 
         get_autopage_permalink_lambda = lambda do |permalink_pattern|
-          return Utils.format_coll_macro(permalink_pattern, collection)
+          return Utils.format_coll_macro(permalink_pattern, collection, slugify_config)
         end
 
         get_autopage_title_lambda = lambda do |title_pattern|
-          return Utils.format_coll_macro(title_pattern, collection)
+          return Utils.format_coll_macro(title_pattern, collection, slugify_config)
         end
                 
         # Call the super constuctor with our custom lambda
@@ -25,4 +28,4 @@ module Jekyll
 
     end #class CollectionAutoPage
   end # module PaginateV2
-end # module Jekyll
+end # module Jekyll

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

@@ -4,6 +4,9 @@ module Jekyll
     class TagAutoPage < BaseAutoPage
       def initialize(site, base, autopage_config, pagination_config, layout_name, tag, tag_name)
 
+        # Do we have a slugify configuration available
+        slugify_config = autopage_config.is_a?(Hash) && autopage_config.has_key?('slugify') ? autopage_config['slugify'] : nil
+
         # Construc the lambda function to set the config values, 
         # this function received the pagination config hash and manipulates it
         set_autopage_data_lambda = lambda do | config |
@@ -11,11 +14,11 @@ module Jekyll
         end
 
         get_autopage_permalink_lambda = lambda do |permalink_pattern|
-          return Utils.format_tag_macro(permalink_pattern, tag)
+          return Utils.format_tag_macro(permalink_pattern, tag, slugify_config)
         end
 
         get_autopage_title_lambda = lambda do |title_pattern|
-          return Utils.format_tag_macro(title_pattern, tag)
+          return Utils.format_tag_macro(title_pattern, tag, slugify_config)
         end
                 
         # Call the super constuctor with our custom lambda
@@ -25,4 +28,4 @@ module Jekyll
 
     end #class TagAutoPage
   end # module PaginateV2
-end # module Jekyll
+end # module Jekyll

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

@@ -5,27 +5,33 @@ module Jekyll
 
       # Static: returns a fully formatted string with the tag macro (:tag) replaced
       #
-      def self.format_tag_macro(toFormat, tag)
-        return toFormat.sub(':tag', Jekyll::Utils.slugify(tag.to_s))
+      def self.format_tag_macro(toFormat, tag, slugify_config=nil)
+        slugify_mode = slugify_config.has_key?('mode') ? slugify_config['mode'] : nil
+        slugify_cased = slugify_config.has_key?('cased') ? slugify_config['cased'] : false
+        return toFormat.sub(':tag', Jekyll::Utils.slugify(tag.to_s, mode:slugify_mode, cased:slugify_cased))
       end #function format_tag_macro
 
       # Static: returns a fully formatted string with the category macro (:cat) replaced
       #
-      def self.format_cat_macro(toFormat, category)
-        return toFormat.sub(':cat', Jekyll::Utils.slugify(category.to_s))
+      def self.format_cat_macro(toFormat, category, slugify_config=nil)
+        slugify_mode = slugify_config.has_key?('mode') ? slugify_config['mode'] : nil
+        slugify_cased = slugify_config.has_key?('cased') ? slugify_config['cased'] : false
+        return toFormat.sub(':cat', Jekyll::Utils.slugify(category.to_s, mode:slugify_mode, cased:slugify_cased))
       end #function format_cat_macro
 
       # Static: returns a fully formatted string with the collection macro (:coll) replaced
       #
-      def self.format_coll_macro(toFormat, collection)
-        return toFormat.sub(':coll', Jekyll::Utils.slugify(collection.to_s))
+      def self.format_coll_macro(toFormat, collection, slugify_config=nil)
+        slugify_mode = slugify_config.has_key?('mode') ? slugify_config['mode'] : nil
+        slugify_cased = slugify_config.has_key?('cased') ? slugify_config['cased'] : false
+        return toFormat.sub(':coll', Jekyll::Utils.slugify(collection.to_s, mode:slugify_mode, cased:slugify_cased))
       end #function format_coll_macro
 
       # Static: returns all documents from all collections defined in the hash of collections passed in
       # excludes all pagination pages though
       def self.collect_all_docs(site_collections)
         coll = []
-        for coll_name, coll_data in site_collections
+        site_collections.each do |coll_name, coll_data|
           if !coll_data.nil? 
             coll += coll_data.docs.select { |doc| !doc.data.has_key?('pagination') }.each{ |doc| doc.data['__coll'] = coll_name } # Exclude all pagination pages and then for every page store it's collection name
           end
@@ -37,7 +43,7 @@ module Jekyll
         return nil if all_posts.nil?
         return all_posts if index_key.nil?
         index = {}
-        for post in all_posts
+        all_posts.each do |post|
           next if post.data.nil?
           next if !post.data.has_key?(index_key)
           next if post.data[index_key].nil?
@@ -51,11 +57,11 @@ module Jekyll
             post_data = post_data.split(/;|,|\s/)
           end
           
-          for key in post_data
+          post_data.each do |key|
             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 raw_k_split in key.split(/;|,/)
+            key.split(/;|,/).each do |raw_k_split|
               k_split = raw_k_split.to_s.downcase.strip #Clean whitespace and junk
               if !index.has_key?(k_split)
                 # 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")
@@ -71,4 +77,4 @@ module Jekyll
     end # class Utils
 
   end # module PaginateV2
-end # module Jekyll
+end # module Jekyll

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

@@ -20,6 +20,9 @@ module Jekyll
       # Returns nothing.
       def generate(site)
       #begin
+        # Generate the AutoPages first
+        PaginateV2::AutoPages.create_autopages(site)
+
         # Retrieve and merge the pagination configuration from the site yml file
         default_config = Jekyll::Utils.deep_merge_hashes(DEFAULT, site.config['pagination'] || {})
 
@@ -74,7 +77,7 @@ module Jekyll
           if collection_name == "all"
             # the 'all' collection_name is a special case and includes all collections in the site (except posts!!)
             # this is useful when you want to list items across multiple collections
-            for coll_name, coll_data in site.collections
+            site.collections.each do |coll_name, coll_data|
               if( !coll_data.nil? && coll_name != 'posts')
                 coll += coll_data.docs.select { |doc| !doc.data.has_key?('pagination') } # Exclude all pagination pages
               end
@@ -139,4 +142,4 @@ module Jekyll
     end # class PaginationGenerator
 
   end # module PaginateV2
-end # module Jekyll
+end # module Jekyll

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

@@ -12,7 +12,7 @@ module Jekyll
         return nil if all_posts.nil?
         return all_posts if index_key.nil?
         index = {}
-        for post in all_posts
+        all_posts.each do |post|
           next if post.data.nil?
           next if !post.data.has_key?(index_key)
           next if post.data[index_key].nil?
@@ -26,11 +26,11 @@ module Jekyll
             post_data = post_data.split(/;|,|\s/)
           end
           
-          for key in post_data
+          post_data.each do |key|
             key = key.to_s.downcase.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(/;|,/)
+            key.split(/;|,/).each do |k_split|
               k_split = k_split.to_s.downcase.strip #Clean whitespace and junk
               if !index.has_key?(k_split)
                 index[k_split.to_s] = []
@@ -79,7 +79,7 @@ module Jekyll
           
         # Now for all filter values for the config key, let's remove all items from the posts that
         # aren't common for all collections that the user wants to filter on
-        for key in config_value
+        config_value.each do |key|
           key = key.to_s.downcase.strip
           posts = PaginationIndexer.intersect_arrays(posts, source_posts[key])
         end

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

@@ -31,7 +31,7 @@ module Jekyll
         end
 
         # Now for each template page generate the paginator for it
-        for template in templates
+        templates.each do |template|
           # All pages that should be paginated need to include the pagination config element
           if template.data['pagination'].is_a?(Hash)
             template_config = Jekyll::Utils.deep_merge_hashes(default_config, template.data['pagination'] || {})
@@ -113,7 +113,7 @@ module Jekyll
 
         docs = []
         # Now for each of the collections get the docs
-        for coll_name in collection_names
+        collection_names.each do |coll_name|
           # Request all the documents for the collection in question, and join it with the total collection 
           docs += @collection_by_name_lambda.call(coll_name.downcase.strip)
         end
@@ -229,14 +229,14 @@ module Jekyll
           if @debug
             puts "Pagination: ".rjust(20) + "Rolling through the date fields for all documents"
           end
-          for p in using_posts
-            if p.respond_to?('date')
-              tmp_date = p.date
+          using_posts.each do |u_post|
+            if u_post.respond_to?('date')
+              tmp_date = u_post.date
               if( !tmp_date || tmp_date.nil? )
                 if @debug
-                  puts "Pagination: ".rjust(20) + "Explicitly assigning date for doc: #{p.data['title']} | #{p.path}"
+                  puts "Pagination: ".rjust(20) + "Explicitly assigning date for doc: #{u_post.data['title']} | #{u_post.path}"
                 end
-                p.date = File.mtime(p.path)
+                u_post.date = File.mtime(u_post.path)
               end
             end
           end

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

@@ -80,16 +80,16 @@ module Jekyll
       # Handles Strings separately as we want a case-insenstive sorting
       #
       def self.sort_values(a, b)
-        if a.is_a?(String)
-          return a.downcase <=> b.downcase
-        end
-        
         if a.nil? && !b.nil?
           return -1
         elsif !a.nil? && b.nil?
           return 1
         end
 
+        if a.is_a?(String)
+          return a.downcase <=> b.downcase
+        end
+
         if a.respond_to?('to_datetime') && b.respond_to?('to_datetime')
           return a.to_datetime <=> b.to_datetime
         end
@@ -107,7 +107,7 @@ module Jekyll
         sort_split = sort_field.split(":")
         sort_value = post_data
 
-        for r_key in sort_split
+        sort_split.each do |r_key|
           key = r_key.downcase.strip # Remove any erronious whitespace and convert to lower case
           if !sort_value.has_key?(key)
             return nil

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

@@ -1,8 +1,8 @@
 module Jekyll
   module PaginateV2
-    VERSION = "1.9.2"
+    VERSION = "1.9.4"
     # When modifying remember to issue a new tag command in git before committing, then push the new tag
-    #   git tag -a v1.9.2 -m "Gem v1.9.2"
+    #   git tag -a v1.9.4 -m "Gem v1.9.4"
     #   git push origin --tags
     # Yanking a published Gem
     #   gem yank jekyll-paginate-v2 -v VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.9.4
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll