jekyll-paginate-v2 1.9.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59ee73bfdddde665bfcac280629290ca03b809bc
-  data.tar.gz: a9534eca1fc37f499b33e8f4a4c6cefaf6b67adf
+  metadata.gz: 5b1be5a3a418704b6d5798054c310cb0d1db73c8
+  data.tar.gz: a0861fb2289e24c3ebc6d0047a9f4e55c7e8b866
 SHA512:
-  metadata.gz: 15f6a51f471f9950952f9ebbe45f4306dbd7c15ea70a95849d74f73c9b9905a44473d4284bd46aa30129ee13c71f630387326d97d7524f0ffeb8787f77d32ad1
-  data.tar.gz: 97299085a18024745768845f073e8d2a3d8df2ba41f6d07c3298dd15511d6dba6d7086cb603288b57fa424370b6de73ff52e42cc250dc80bd5f3e99d8820aada
+  metadata.gz: 6ac0fae0864bed484368ce0dd83645e177809c0a90c0fb8a1b55536cb15ecd693bbe9dcd058d90c7e797f1ba834ba0ba7fa2c8ef6464f6ccf73929e1a4c2254f
+  data.tar.gz: b7bf4594ed5718a301b49a118f4b040627f4705d601ef52cb0e79223c9b12436c900637a83048bdeb41bfaaca771618199eb2fe617b9f61c6f9f65baaac73d66

data/README-AUTOPAGES.md

@@ -100,5 +100,42 @@ An example of this can be found in [examples/03-tags/_layouts/autopage_collectio
 ### Title should not contain pagination macros
 There is no need to include the pagination title macros `:num`, `:max` or `:title` in the title configuration. The autopages will use the title configuration from the pagination configuration itself.
 
+### Categories and tags with spaces
+If you have category or tag names with spaces, make sure you use either
+1. the singular forms (`tag`, `category`), or
+2. the plural forms (`tags`, `categories`) using the YAML array syntax.
+
+See [Filtering categories](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#filtering-categories) for more information.
+
+### Special characters
+
+As of v1.9.4, special characters are supported in category, tag, and collection names by default:
+
+``` yml
+  category: sports car, b+w
+```
+
+If you need to support the previous behavior where special characters are replaced with hyphens in URLs, use the new `slugify` option:
+
+``` yml
+autopages:
+  categories:
+    enabled: true
+    slugify:
+      mode: nil
+      cased: true
+```
+
+The following modes are available:
+
+| Value| Description |
+| --- | --- |
+| `none` | No conversion (default) |
+| `raw` | Replace sequences of spaces with a hyphen |
+| `nil` | Replace non-alphabetic characters with a hyphen |
+| `pretty` | Keep some non-alphabetic characters (._~!$&'()+,;=@) |
+
+If `cased` is set to `true`, all uppercase letters are replaced with their lowercase counterparts.
+
 ## Common issues
-_None reported so far_
+_None reported so far_

data/README-GENERATOR.md

@@ -271,6 +271,36 @@ pagination:
   category: software, ruby
 ```
 
+You may use also use `categories` instead:
+
+``` yml
+pagination:
+  enabled: true
+  categories:
+    - software
+    - ruby
+```
+
+**Note:** Do *not* use `categories` as follows:
+
+``` yml
+  categories: programming language, ruby
+```
+
+i.e. with category names that have spaces in them. Jekyll will split the above using spaces as the delimiter, resulting in `programming`, `language,`, and `ruby` as categories. Instead, use
+
+``` yml
+  category: programming language, ruby
+```
+
+or
+
+``` yml
+  categories:
+    - programming language
+    - ruby
+```
+
 > To define categories you can either specify them in the front-matter or through the [directory structure](http://jekyllrb.com/docs/variables/#page-variables) of your jekyll site (Categories are derived from the directory structure above the \_posts directory). You can actually use both approaches to assign your pages to multiple categories.
 
 ### Filtering tags
@@ -291,6 +321,16 @@ pagination:
   tag: cool, life
 ```
 
+As with categories, you may also use the following syntax:
+
+``` yml
+pagination:
+  enabled: true
+  tags:
+    - cool
+    - life
+```
+
 > When specifying tags in your posts make sure that the values are not enclosed in single quotes (double quotes are fine). If they are you will get a cryptic error when generating your site that looks like _"Error: could not read file <FILE>: did not find expected key while parsing a block mapping at line 2 column 1"_
 
 ### Filtering locales

data/README.md

@@ -1,6 +1,6 @@
 # Jekyll::Paginate V2
 
-Pagination gem built specially for Jekyll 3 and newer that is fully backwards compatable and serves as an enhanced replacement for the previously built-in [jekyll-paginate gem](https://github.com/jekyll/jekyll-paginate). View it on [rubygems.org](https://rubygems.org/gems/jekyll-paginate-v2).
+Pagination gem built specially for Jekyll 3 and newer that is fully backwards compatible and serves as an enhanced replacement for the previously built-in [jekyll-paginate gem](https://github.com/jekyll/jekyll-paginate). View it on [rubygems.org](https://rubygems.org/gems/jekyll-paginate-v2).
 
 [![Gem](https://img.shields.io/gem/v/jekyll-paginate-v2.svg)](https://rubygems.org/gems/jekyll-paginate-v2)
 [![Join the chat at https://gitter.im/jekyll-paginate-v2/Lobby](https://badges.gitter.im/jekyll-paginate-v2/Lobby.svg)](https://gitter.im/jekyll-paginate-v2/Lobby)
@@ -10,7 +10,7 @@ Pagination gem built specially for Jekyll 3 and newer that is fully backwards co
 [![security](https://hakiri.io/github/sverrirs/jekyll-paginate-v2/master.svg)](https://hakiri.io/github/sverrirs/jekyll-paginate-v2/master)
 [![Gem](https://img.shields.io/gem/dt/jekyll-paginate-v2.svg)](https://rubygems.org/gems/jekyll-paginate-v2)
 
-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), you can also get in touch on the project's [Glitter chat room](https://gitter.im/jekyll-paginate-v2/Lobby).
+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), you can also get in touch on the project's [Gitter chat room](https://gitter.im/jekyll-paginate-v2/Lobby).
 
 > 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)).
 
@@ -39,6 +39,10 @@ Now you're ready to run `jekyll serve` and your paginated files should be genera
 
 Please see the [Examples](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples) for tips and tricks on how to configure the pagination logic.
 
+> :warning: Please note that this plugin is currently NOT supported by GitHub pages. Here is a [list of all plugins supported](https://pages.github.com/versions/). There is work underway to try to get it added it but until then please follow [this GitHub guide](https://help.github.com/articles/adding-jekyll-plugins-to-a-github-pages-site/) to enable it or use [Travis CI](https://ayastreb.me/deploy-jekyll-to-github-pages-with-travis-ci/). 
+
+> GitLab supposedly supports [any plugin](https://about.gitlab.com/comparison/gitlab-pages-vs-github-pages.html).
+
 
 ## Pagination Generator
 

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

@@ -11,6 +11,7 @@ module Jekyll
         # this function received the pagination config hash and manipulates it
         set_autopage_data_lambda = lambda do | in_config |
           in_config['category'] = category
+          in_config['collection'] = site.collections.keys
         end
 
         get_autopage_permalink_lambda = lambda do |permalink_pattern|

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

@@ -11,6 +11,7 @@ module Jekyll
         # this function received the pagination config hash and manipulates it
         set_autopage_data_lambda = lambda do | config |
           config['tag'] = tag
+          config['collection'] = site.collections.keys
         end
 
         get_autopage_permalink_lambda = lambda do |permalink_pattern|

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

@@ -32,7 +32,7 @@ module Jekyll
       def self.collect_all_docs(site_collections)
         coll = []
         site_collections.each do |coll_name, coll_data|
-          if !coll_data.nil? 
+          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
         end
@@ -49,25 +49,21 @@ module Jekyll
           next if post.data[index_key].nil?
           next if post.data[index_key].size <= 0
           next if post.data[index_key].to_s.strip.length == 0
-          
+
           # Only tags and categories come as premade arrays, locale does not, so convert any data
           # elements that are strings into arrays
           post_data = post.data[index_key]
           if post_data.is_a?(String)
             post_data = post_data.split(/;|,|\s/)
           end
-          
+
           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)
-            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")
-                # 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
+            key = key.to_s.strip
+            processed_key = key.downcase #Clean whitespace and junk
+            if !index.has_key?(processed_key)
+              # 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[processed_key] = [processed_key, key]
             end
           end
         end

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

@@ -5,6 +5,7 @@ module Jekyll
     DEFAULT = {
       'enabled'      => false,
       'collection'   => 'posts',
+      'offset'       => 0, # Supports skipping x number of posts from the beginning of the post list
       'per_page'     => 10,
       'permalink'    => '/page:num/', # Supports :num as customizable elements
       'title'        => ':title - page :num', # Supports :num as customizable elements

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

@@ -66,24 +66,47 @@ module Jekyll
         return nil if posts.nil?
         return nil if source_posts.nil? # If the source is empty then simply don't do anything
         return posts if config.nil?
-        return posts if !config.has_key?(config_key)
-        return posts if config[config_key].nil?
+
+        plural_key = Utils.plural(config_key)
+
+        return posts if !config.has_key?(config_key) && !config.has_key?(plural_key)
+        return posts if config[config_key].nil? && config[plural_key].nil?
         
         # Get the filter values from the config (this is the cat/tag/locale values that should be filtered on)
-        config_value = config[config_key]
         
-        # If we're dealing with a delimitered string instead of an array then let's be forgiving
-        if( config_value.is_a?(String))
-          config_value = config_value.split(/;|,/)
+        if config[config_key].is_a?(Hash) || config[plural_key].is_a?(Hash)
+          # { values: [..], matching: any|all }
+          config_hash = config[config_key].is_a?(Hash) ? config[config_key] : config[plural_key]
+          config_value = Utils.config_values(config_hash, 'value')
+          matching = config_hash['matching'] || 'all'
+        else
+          # Default array syntax
+          config_value = Utils.config_values(config, config_key)
+          matching = 'all'
         end
           
-        # 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
-        config_value.each do |key|
-          key = key.to_s.downcase.strip
-          posts = PaginationIndexer.intersect_arrays(posts, source_posts[key])
+        matching = matching.to_s.downcase.strip
+
+        # Filter on any/all specified categories, etc.
+
+        if matching == "all"
+          # 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
+          config_value.each do |key|
+            key = key.to_s.downcase.strip
+            posts = PaginationIndexer.intersect_arrays(posts, source_posts[key])
+          end
+
+        elsif matching == "any"
+          # "or" filter: Remove posts that don't have at least one required key
+          posts.delete_if { |post|
+            post_config = Utils.config_values(post.data, config_key)
+            (config_value & post_config).empty?
+          }
+
+        # else no filter
         end
-        
+
         # The fully filtered final post list
         return posts
       end #function read_config_value_and_filter_posts

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

@@ -158,6 +158,7 @@ module Jekyll
           
           puts f + " Active Filters"
           puts f + "  Collection: ".ljust(r) + config['collection'].to_s
+          puts f + "  Offset: ".ljust(r) + config['offset'].to_s
           puts f + "  Category: ".ljust(r) + (config['category'].nil? || config['category'] == "posts" ? "[Not set]" : config['category'].to_s)
           puts f + "  Tag: ".ljust(r) + (config['tag'].nil? ? "[Not set]" : config['tag'].to_s)
           puts f + "  Locale: ".ljust(r) + (config['locale'].nil? ? "[Not set]" : config['locale'].to_s)
@@ -243,6 +244,10 @@ module Jekyll
 
           using_posts.sort!{ |a,b| Utils.sort_values(Utils.sort_get_post_data(a.data, sort_field), Utils.sort_get_post_data(b.data, sort_field)) }
 
+          # Remove the first x entries
+          offset_post_count = [0, config['offset'].to_i].max
+          using_posts.pop(offset_post_count)
+
           if config['sort_reverse']
             using_posts.reverse!
           end

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

@@ -13,12 +13,24 @@ module Jekyll
         @site = page_to_copy.site
         @base = ''
         @url = ''
-        @name = index_pageandext.nil? ? 'index.html' : index_pageandext
+        if cur_page_nr == 1
+          @dir = File.dirname(page_to_copy.dir)
+          @name = page_to_copy.name
+        else
+          @name = index_pageandext.nil? ? 'index.html' : index_pageandext
+        end
 
         self.process(@name) # Creates the basename and ext member values
 
-        # Only need to copy the data part of the page as it already contains the layout information
-        self.data = Jekyll::Utils.deep_merge_hashes( page_to_copy.data, {} )
+        # Copy page data over site defaults
+        defaults = @site.frontmatter_defaults.all(page_to_copy.relative_path, type)
+        self.data = Jekyll::Utils.deep_merge_hashes(defaults, page_to_copy.data)
+
+        if defaults.has_key?('permalink')
+          self.data['permalink'] = Jekyll::URL.new(:template => defaults['permalink'], :placeholders => self.url_placeholders).to_s
+          @use_permalink_for_url = true
+        end
+
         if !page_to_copy.data['autopage']
           self.content = page_to_copy.content
         else
@@ -41,7 +53,7 @@ module Jekyll
       end
 
       def set_url(url_value)
-        @url = url_value
+        @url = @use_permalink_for_url ? self.data['permalink'] : url_value
       end
     end # class PaginationPage
 

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

@@ -135,6 +135,27 @@ module Jekyll
         return url
       end
 
+      # Constructs the plural for a key
+      def self.plural(config_key)
+        (config_key =~ /s$/) ? config_key :
+          (config_key.dup.sub!(/y$/, 'ies') || "#{config_key}s")
+      end
+
+      # Converts a string or array to a downcased, stripped array
+      def self.config_array(config, key, keepcase = nil)
+        [ config[key] ].flatten.compact.uniq.map { |c|
+          c.split(/[,;]\s*/).map { |v|
+            keepcase ? v.to_s.strip : v.to_s.downcase.strip
+          }
+        }.flatten.uniq
+      end
+
+      # Merges singular and plural config values into an array
+      def self.config_values(config, key, keepcase = nil)
+        singular = config_array(config, key, keepcase)
+        plural = config_array(config, plural(key), keepcase)
+        [ singular, plural ].flatten.uniq
+      end
     end
 
   end # module PaginateV2

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

@@ -1,8 +1,8 @@
 module Jekyll
   module PaginateV2
-    VERSION = "1.9.4"
+    VERSION = "2.0.0"
     # When modifying remember to issue a new tag command in git before committing, then push the new tag
-    #   git tag -a v1.9.4 -m "Gem v1.9.4"
+    #   git tag -a v2.0.0 -m "Gem v2.0.0"
     #   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.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll