jekyll-paginate-v2 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b1be5a3a418704b6d5798054c310cb0d1db73c8
-  data.tar.gz: a0861fb2289e24c3ebc6d0047a9f4e55c7e8b866
+SHA256:
+  metadata.gz: 87dc86f06aedb8e2c1e0b3d398a3580bb00d31569577ebb4ab6bfdefb45ad572
+  data.tar.gz: fd0c6a583189811309acd885c468eb2ed19555e8223743e285a7eecbd575c1a6
 SHA512:
-  metadata.gz: 6ac0fae0864bed484368ce0dd83645e177809c0a90c0fb8a1b55536cb15ecd693bbe9dcd058d90c7e797f1ba834ba0ba7fa2c8ef6464f6ccf73929e1a4c2254f
-  data.tar.gz: b7bf4594ed5718a301b49a118f4b040627f4705d601ef52cb0e79223c9b12436c900637a83048bdeb41bfaaca771618199eb2fe617b9f61c6f9f65baaac73d66
+  metadata.gz: 8bf26590ccba733825ab51cc305fdfb914d235983984d734ffdb9c5a95a97acb63c78ca6930c252431e81f8bffe25bb27fd10f87edb2c0915ef0a7e49d82c2ac
+  data.tar.gz: c51a21cb26af1df50f5fd26693828b09321bc556b986be7abdc10e26b333aa3251bf100fc6d059dfc8fc4025b8b511a87df7f9f62878d858de4910a80b2ea9cd

data/README-AUTOPAGES.md

@@ -100,42 +100,5 @@ 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

@@ -21,6 +21,7 @@ The **Generator** forms the core of the pagination logic. It is responsible for
   + [Filtering locales](#filtering-locales)
 * [How to paginate on combination of filters](#paginate-on-combination-of-filters)
 * [Overriding site configuration](#configuration-overrides)
+* [Offsetting posts (how to skip newest posts)](#offsetting-posts)
 * [Advanced Sorting](#advanced-sorting)
 * [Creating Pagination Trails](#creating-pagination-trails)
 * [How to detect auto-generated pages](#detecting-generated-pagination-pages)
@@ -271,36 +272,6 @@ 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
@@ -321,16 +292,6 @@ 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
@@ -394,6 +355,20 @@ pagination:
   sort_reverse: false
 ```
 
+## Offsetting posts
+The paging logic can be instructed to exclude the first _N_ number of newest posts from the pagination.
+This can be useful in situations where your site treats the first N posts differently from the rest (e.g. a featured post that is always present).
+
+The number of pages to skip is configured using the `offset` setting like so
+
+``` yml
+pagination: 
+  enabled: true
+  offset: 3
+```
+
+This example skips the 3 newest posts from the pagination logic.
+
 ## Advanced Sorting
 Sorting can be done by any field that is available in the post front-matter. You can even sort by nested fields.
 

data/README.md

@@ -2,10 +2,10 @@
 
 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).
 
+[![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/)
 [![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)
 [![Build Status](https://travis-ci.org/sverrirs/jekyll-paginate-v2.svg?branch=master)](https://travis-ci.org/sverrirs/jekyll-paginate-v2) 
-[![Dependency Status](https://gemnasium.com/badges/github.com/sverrirs/jekyll-paginate-v2.svg)](https://gemnasium.com/github.com/sverrirs/jekyll-paginate-v2)
 [![Code Climate](https://codeclimate.com/github/sverrirs/jekyll-paginate-v2/badges/gpa.svg)](https://codeclimate.com/github/sverrirs/jekyll-paginate-v2)
 [![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)

data/jekyll-paginate-v2.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sverrirs/jekyll-paginate-v2"
   spec.license       = "MIT"
 
-  spec.summary       = %q{Pagination Generator for Jekyll 3}
+  spec.summary       = %q{Pagination Generator for Jekyll 3 and newer}
   spec.description   = %q{An enhanced zero-configuration in-place replacement for the now decomissioned built-in jekyll-paginate gem. This pagination gem offers full backwards compatability as well as a slew of new frequently requested features with minimal additional site and page configuration. Optional features include auto-generation of paginated collection, tag and category pages.}
   
   spec.files          = Dir['CODE_OF_CONDUCT.md', 'README*.md', 'LICENSE', 'Rakefile', '*.gemspec', 'Gemfile', 'lib/**/*', 'spec/**/*']
@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
 
   # Gem requires Jekyll to work
   # ~> is the pessimistic operator and is equivalent to '>= 3.0', '< 4.0'
-  spec.add_runtime_dependency "jekyll", "~> 3.0"
+  spec.add_runtime_dependency "jekyll", ">= 3.0", "< 5.0"
 
   # Development requires more
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.4"
   spec.add_development_dependency "minitest", '~> 5.4'
-end
+end

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

@@ -11,7 +11,6 @@ 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,7 +11,6 @@ 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,21 +49,25 @@ 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.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]
+            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
             end
           end
         end

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

@@ -66,47 +66,24 @@ 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?
-
-        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?
+        return posts if !config.has_key?(config_key)
+        return posts if config[config_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 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'
+        # 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(/;|,/)
         end
           
-        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
+        # 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
-
+        
         # The fully filtered final post list
         return posts
       end #function read_config_value_and_filter_posts

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

@@ -13,24 +13,12 @@ module Jekyll
         @site = page_to_copy.site
         @base = ''
         @url = ''
-        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
+        @name = index_pageandext.nil? ? 'index.html' : index_pageandext
 
         self.process(@name) # Creates the basename and ext member values
 
-        # 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
-
+        # 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, {} )
         if !page_to_copy.data['autopage']
           self.content = page_to_copy.content
         else
@@ -53,7 +41,7 @@ module Jekyll
       end
 
       def set_url(url_value)
-        @url = @use_permalink_for_url ? self.data['permalink'] : url_value
+        @url = url_value
       end
     end # class PaginationPage
 

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

@@ -135,27 +135,6 @@ 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,10 +1,12 @@
 module Jekyll
   module PaginateV2
-    VERSION = "2.0.0"
+    VERSION = "3.0.0"
     # When modifying remember to issue a new tag command in git before committing, then push the new tag
-    #   git tag -a v2.0.0 -m "Gem v2.0.0"
+    #   git tag -a v3.0.0 -m "Gem v3.0.0"
     #   git push origin --tags
     # Yanking a published Gem
     #   gem yank jekyll-paginate-v2 -v VERSION
+    # Building gem
+    #   gem build jekyll-paginate-v2.gemspec
   end # module PaginateV2
 end # module Jekyll

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -127,10 +133,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
-summary: Pagination Generator for Jekyll 3
+summary: Pagination Generator for Jekyll 3 and newer
 test_files:
 - spec/generator/defaults_spec.rb
 - spec/generator/paginationPage_spec.rb