jekyll-paginate-data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87dfb180279b84e603e0f6bdef8c3e50eb801311286e5093cfb322f1283d66b6
+  data.tar.gz: c8fd3b62f5f16b55f3b4fa2a7bf2eda78bace0ef380d4aa75c970af031c4226a
+SHA512:
+  metadata.gz: 269b0b9d213588a58179b4c669813695ea41060d33f1da42c23858fa67b69018e6df2eba20d1968e668b044584b95b998e4c191093ae00f0f0b7016ca6444683
+  data.tar.gz: c4546dfbe61689d9fd2614196b12ee1ccf84b6ae3a2e67503e87456be7fb95f228d84de15cb74b4e68d3dbf366fcb8819232774181fb4f2c4333a034dedc1216

data/.github/workflows/ci.yml

@@ -0,0 +1,104 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  j4:
+    if: "!contains(github.event.commits[0].message, '[ci skip]')"
+    name: "Jekyll ${{ matrix.jekyll_version }} (Ruby ${{ matrix.ruby_version }})"
+    runs-on: 'ubuntu-latest'
+    env:
+      JEKYLL_VERSION: ${{ matrix.jekyll_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+        - 2.5
+        - 2.7
+        - 3.0
+        jekyll_version:
+        - "~> 3.0"
+        - "~> 4.0"
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 5
+      - name: "Set up Ruby ${{ matrix.ruby_version }}"
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Execute tests
+        run:  bundle exec rspec
+  j3:
+    if: "!contains(github.event.commits[0].message, '[ci skip]')"
+    name: "Jekyll ${{ matrix.jekyll_version }} (Ruby ${{ matrix.ruby_version }})"
+    runs-on: 'ubuntu-latest'
+    env:
+      JEKYLL_VERSION: ${{ matrix.jekyll_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+        - 2.5
+        jekyll_version:
+        - "~> 3.9"
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 5
+      - name: "Set up Ruby ${{ matrix.ruby_version }}"
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Execute tests
+        run:  'bundle exec rspec && true'
+
+  style_check:
+    if: "!contains(github.event.commits[0].message, '[ci skip]')"
+    name: "Code Style Check (Ruby ${{ matrix.ruby_version }})"
+    runs-on: 'ubuntu-latest'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+        - 2.5
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 5
+      - name: "Set up Ruby ${{ matrix.ruby_version }}"
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Check Style Offenses
+        run:  bundle exec rubocop -S -D
+
+  gem_build:
+    if: "!contains(github.event.commits[0].message, '[ci skip]')"
+    name: "Test Gem build (Ruby ${{ matrix.ruby_version }})"
+    runs-on: 'ubuntu-latest'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+        - 2.5
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 5
+      - name: "Set up Ruby ${{ matrix.ruby_version }}"
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Test Gem build
+        run:  bundle exec gem build jekyll-paginate.gemspec

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/dest
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,36 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+- 2.2
+- 2.1
+- 2.0
+- 1.9.3
+before_script: bundle update
+script: script/cibuild
+notifications:
+  irc:
+    on_success: change
+    on_failure: change
+    channels:
+    - irc.freenode.org#jekyll
+    template:
+    - '%{repository}#%{build_number} (%{branch}) %{message} %{build_url}'
+  email:
+    on_success: never
+    on_failure: never
+
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      env: JEKYLL_VERSION=3.0.0
+    - env: JEKYLL_VERSION=2.4
+      rvm: 2.1
+    - rvm: 2.2
+      env: JEKYLL_VERSION=2.4
+
+env:
+  matrix:
+    - ""
+    - JEKYLL_VERSION=2.4
+    - JEKYLL_VERSION=3.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-paginate-data.gemspec
+gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", ENV["JEKYLL_VERSION"]
+end

data/History.markdown

@@ -0,0 +1,20 @@
+## HEAD
+
+### Minor Enhancements
+
+  * Throw an error if the pagination path doesn't contain `:num`. (#19)
+
+### Development Fixes
+
+  * Upgrade to the new Travis build environment and use their built-in caching (#20)
+  * Add GitHub Actions CI (#46)
+
+## 1.1.0 / 2014-10-14
+
+### Minor Enhancements
+
+  * Filter out posts that have `hidden: true` in front matter (#13)
+
+### Development Fixes
+
+  * Fix tests for rspec 3. (#9)

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2025 Bastian Greshake Tzovaras
+Copyright (c) 2014 Parker Moore
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Jekyll::DataPaginate
+
+This is a modified version of `jekyll-paginate`, the default pagination generator gem for Jekyll. 
+
+`Jekyll::DataPaginate` allows you to paginate over a collection of data files, by setting a few parameters in your `_config.yml` for Jekyll.
+
+**Currently, this gem only works for paginating a data collection that is based on a collection of files that are within a subfolder of `_data`**
+
+For example, if your `example` data file folder looks like this:
+
+```
+❯ ls _data/example/*
+_data/example/1.yaml  _data/example/2.yaml  _data/example/3.yaml
+```
+
+this gem will give you three "posts" to paginate.
+ 
+The gem is setup to work side-by-side with the regular pagination feature for posts/pages.
+
+You can see a [small example of this gem in action at my website](https://tzovar.as/links), with the corresponding code residing at [Codeberg too](https://codeberg.org/gedankenstuecke/pages-source).
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-paginate-data'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-paginate-data
+
+## Usage
+
+You will have to activate this gem in your Jekyll `_config.yml`: 
+
+```
+plugins:
+  - jekyll-paginate-data
+```
+
+You will have to configure the following three parameters in your `_config.yml` too:
+
+- `data_paginate`, the number of items per page
+- `data_paginate_key`, which is the sub-folder of `_data` over which you want to paginate
+- `data_paginate_path`, the format & path the pagination should take
+
+An example configuration could be:
+
+```
+data_paginate: 25
+data_paginate_key: "links"
+data_paginate_path: "links/:num"
+``` 
+
+### Template requirement
+You will need to have an `index.html` file that corresponds to your `data_paginate_path`, e.g. if you use `links/:num` as your path, then you will need to have a `links/index.html` template file in your Jekyll. 
+
+**Note: Your `index.html` can not define a `permalink`!**
+
+In the template you can access the paginator via `{{ paginator }}`, just as the regular paginator, with the following options:
+
+```
+ # {"paginator" => { "page" => <Number>,
+ #                   "per_page" => <Number>,
+ #                   "posts" => [<Post>],
+ #                   "total_posts" => <Number>,
+ #                   "total_pages" => <Number>,
+ #                   "previous_page" => <Number>,
+ # 					 "next_page_path => <Path>,
+ # 					 "previous_page_path => <Path>,
+ #                   "next_page" => <Number> }}
+```
+
+## Contributing
+
+If you have any improvement suggestions or would like to contribute code, please do! 

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jekyll-paginate.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-paginate-data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-paginate-data"
+  spec.version       = Jekyll::DataPaginate::VERSION
+  spec.authors       = ["Bastian Greshake Tzovaras"]
+  spec.email         = ["bgreshake@proton.me"]
+  spec.summary       = %q{Pagination for data files of Jekyll}
+  spec.homepage      = "https://codeberg.org/gedankenstuecke/jekyll-paginate-data"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "jekyll", ">= 2.0", "< 5.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-jekyll"
+end

data/lib/jekyll-paginate-data/pager.rb

@@ -0,0 +1,140 @@
+module Jekyll
+  module DataPaginate
+    class DataPager
+      attr_reader :page, :per_page, :posts, :total_posts, :total_pages,
+        :previous_page, :previous_page_path, :next_page, :next_page_path
+
+      # Calculate the number of pages.
+      #
+      # all_posts - The Array of all Posts.
+      # per_page  - The Integer of entries per page.
+      #
+      # Returns the Integer number of pages.
+      def self.calculate_pages(all_posts, per_page)
+        (all_posts.size.to_f / per_page.to_i).ceil
+      end
+
+      # Determine if pagination is enabled the site.
+      #
+      # site - the Jekyll::Site object
+      #
+      # Returns true if pagination is enabled, false otherwise.
+      def self.pagination_enabled?(site)
+       !site.config['data_paginate'].nil? &&
+           site.data[site.config['data_paginate_key']].size > 0
+      end
+
+      # Static: Determine if a page is a possible candidate to be a template page.
+      #         Page's name must be `index.html` and exist in any of the directories
+      #         between the site source and `paginate_path`.
+      #
+      # config - the site configuration hash
+      # page   - the Jekyll::Page about which we're inquiring
+      #
+      # Returns true if the
+      def self.pagination_candidate?(config, page)
+        page_dir = File.dirname(File.expand_path(remove_leading_slash(page.path), config['source']))
+        paginate_path = remove_leading_slash(config['data_paginate_path'])
+        paginate_path = File.expand_path(paginate_path, config['source'])
+        page.name == 'index.html' &&
+          in_hierarchy(config['source'], page_dir, File.dirname(paginate_path))
+      end
+
+      # Determine if the subdirectories of the two paths are the same relative to source
+      #
+      # source        - the site source
+      # page_dir      - the directory of the Jekyll::Page
+      # paginate_path - the absolute paginate path (from root of FS)
+      #
+      # Returns whether the subdirectories are the same relative to source
+      def self.in_hierarchy(source, page_dir, paginate_path)
+        return false if paginate_path == File.dirname(paginate_path)
+        return false if paginate_path == Pathname.new(source).parent
+        page_dir == paginate_path ||
+          in_hierarchy(source, page_dir, File.dirname(paginate_path))
+      end
+
+      # Static: Return the pagination path of the page
+      #
+      # site     - the Jekyll::Site object
+      # num_page - the pagination page number
+      #
+      # Returns the pagination path as a string
+      def self.paginate_path(site, num_page)
+        return nil if num_page.nil?
+        return DataPagination.first_page_url(site) if num_page <= 1
+        format = site.config['data_paginate_path']
+        if format.include?(":num")
+          format = format.sub(':num', num_page.to_s)
+        else
+          raise ArgumentError.new("Invalid pagination path: '#{format}'. It must include ':num'.")
+        end
+        ensure_leading_slash(format)
+      end
+
+      # Static: Return a String version of the input which has a leading slash.
+      #         If the input already has a forward slash in position zero, it will be
+      #         returned unchanged.
+      #
+      # path - a String path
+      #
+      # Returns the path with a leading slash
+      def self.ensure_leading_slash(path)
+        path[0..0] == "/" ? path : "/#{path}"
+      end
+
+      # Static: Return a String version of the input without a leading slash.
+      #
+      # path - a String path
+      #
+      # Returns the input without the leading slash
+      def self.remove_leading_slash(path)
+        ensure_leading_slash(path)[1..-1]
+      end
+
+      # Initialize a new DataPager.
+      #
+      # site     - the Jekyll::Site object
+      # page      - The Integer page number.
+      # all_posts - The Array of all the site's Posts.
+      # num_pages - The Integer number of pages or nil if you'd like the number
+      #             of pages calculated.
+      def initialize(site, page, all_posts, num_pages = nil)
+        @page = page
+        @per_page = site.config['data_paginate'].to_i
+        @total_pages = num_pages || DataPager.calculate_pages(all_posts, @per_page)
+
+        if @page > @total_pages
+          raise RuntimeError, "page number can't be greater than total pages: #{@page} > #{@total_pages}"
+        end
+
+        init = (@page - 1) * @per_page
+        offset = (init + @per_page - 1) >= all_posts.size ? all_posts.size : (init + @per_page - 1)
+
+        @total_posts = all_posts.size
+        @posts = all_posts[init..offset]
+        @previous_page = @page != 1 ? @page - 1 : nil
+        @previous_page_path = DataPager.paginate_path(site, @previous_page)
+        @next_page = @page != @total_pages ? @page + 1 : nil
+        @next_page_path = DataPager.paginate_path(site, @next_page)
+      end
+
+      # Convert this DataPager's data to a Hash suitable for use by Liquid.
+      #
+      # Returns the Hash representation of this DataPager.
+      def to_liquid
+        {
+          'page' => page,
+          'per_page' => per_page,
+          'posts' => posts,
+          'total_posts' => total_posts,
+          'total_pages' => total_pages,
+          'previous_page' => previous_page,
+          'previous_page_path' => previous_page_path,
+          'next_page' => next_page,
+          'next_page_path' => next_page_path
+        }
+      end
+    end
+  end
+end

data/lib/jekyll-paginate-data/pagination.rb

@@ -0,0 +1,90 @@
+module Jekyll
+  module DataPaginate
+    class DataPagination < Generator
+      # This generator is safe from arbitrary code execution.
+      safe true
+
+      # This generator should be passive with regard to its execution
+      priority :lowest
+
+      # Generate paginated pages if necessary.
+      #
+      # site - The Site.
+      #
+      # Returns nothing.
+      def generate(site)
+        if DataPager.pagination_enabled?(site)
+          Jekyll.logger.warn "DataPagination:", "activated data pagination"
+          if template = self.class.template_page(site)
+            paginate(site, template)
+          else
+            Jekyll.logger.warn "DataPagination:", "DataPagination is enabled, but I couldn't find " +
+            "an index.html page to use as the pagination template. Skipping pagination."
+          end
+        end
+      end
+
+      # Paginates the blog's posts. Renders the index.html file into paginated
+      # directories, e.g.: page2/index.html, page3/index.html, etc and adds more
+      # site-wide data.
+      #
+      # site - The Site.
+      # page - The index.html Page that requires pagination.
+      #
+      # {"paginator" => { "page" => <Number>,
+      #                   "per_page" => <Number>,
+      #                   "posts" => [<Post>],
+      #                   "total_posts" => <Number>,
+      #                   "total_pages" => <Number>,
+      #                   "previous_page" => <Number>,
+      #                   "next_page" => <Number> }}
+      def paginate(site, page)
+        all_posts_t = site.site_payload['site']['data'][site.config['data_paginate_key']]
+        all_posts = all_posts_t.map { |p| p[1] }.reverse
+        pages = DataPager.calculate_pages(all_posts, site.config['data_paginate'].to_i)
+        (1..pages).each do |num_page|
+          pager = DataPager.new(site, num_page, all_posts, pages)
+          # the original jekyll-paginate rocks num_page > 1 but that leads to
+          # the first page having no data at all. I don't understand the jekyll
+          # internals enough to know why, but just going with "do this for all pages"
+          # seems to fix it :shrug:
+          if num_page > 0
+            newpage = Page.new(site, site.source, page.dir, page.name)
+            newpage.pager = pager
+            newpage.dir = DataPager.paginate_path(site, num_page)
+            site.pages << newpage
+          else
+            page.pager = pager
+          end
+        end
+      end
+
+      # Static: Fetch the URL of the template page. Used to determine the
+      #         path to the first pager in the series.
+      #
+      # site - the Jekyll::Site object
+      #
+      # Returns the url of the template page
+      def self.first_page_url(site)
+        if page = DataPagination.template_page(site)
+          page.url
+        else
+          nil
+        end
+      end
+
+      # Public: Find the Jekyll::Page which will act as the pager template
+      #
+      # site - the Jekyll::Site object
+      #
+      # Returns the Jekyll::Page which will act as the pager template
+      def self.template_page(site)
+        site.pages.select do |page|
+          DataPager.pagination_candidate?(site.config, page)
+        end.sort do |one, two|
+          two.path.size <=> one.path.size
+        end.first
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Jekyll
+  module DataPaginate
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll-paginate-data.rb

@@ -0,0 +1,8 @@
+require "jekyll-paginate-data/version"
+require "jekyll-paginate-data/pager"
+require "jekyll-paginate-data/pagination"
+
+module Jekyll
+  module DataPaginate
+  end
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rspec

data/spec/pager_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+RSpec.describe(Jekyll::DataPaginate::DataPager) do
+
+  it "calculate number of pages" do
+    expect(described_class.calculate_pages([], '2')).to eql(0)
+    expect(described_class.calculate_pages([1], '2')).to eql(1)
+    expect(described_class.calculate_pages([1,2], '2')).to eql(1)
+    expect(described_class.calculate_pages([1,2,3], '2')).to eql(2)
+    expect(described_class.calculate_pages([1,2,3,4], '2')).to eql(2)
+    expect(described_class.calculate_pages([1,2,3,4,5], '2')).to eql(3)
+  end
+
+  context "with paginate_path set to a subdirectory with no index.html" do
+    let(:site) { build_site({'data_paginate_path' => '/blog/page-:num'}) }
+
+    it "determines the correct pagination path for each page" do
+      if Jekyll::VERSION < '3.0.0'
+        expect(described_class.paginate_path(site, 1)).to eql("/index.html")
+      else
+        expect(described_class.paginate_path(site, 1)).to eql("/")
+      end
+
+      expect(described_class.paginate_path(site, 2)).to eql("/blog/page-2")
+    end
+  end
+
+  context "with paginate_path set to a subdirectory with no index.html with num pages being in subdirectories" do
+    let(:site) { build_site({'data_paginate_path' => '/blog/page/:num'}) }
+
+    it "determines the correct pagination path for each page" do
+      if Jekyll::VERSION < '3.0.0'
+        expect(described_class.paginate_path(site, 1)).to eql("/index.html")
+      else
+        expect(described_class.paginate_path(site, 1)).to eql("/")
+      end
+
+      expect(described_class.paginate_path(site, 2)).to eql("/blog/page/2")
+    end
+  end
+
+  context "with paginate_path set to a subdirectory wherein an index.html exists" do
+    let(:site) { build_site({'data_paginate_path' => '/contacts/page:num'}) }
+
+    it "determines the correct pagination path for each page" do
+      if Jekyll::VERSION < '3.0.0'
+        expect(described_class.paginate_path(site, 1)).to eql("/contacts/index.html")
+      else
+        expect(described_class.paginate_path(site, 1)).to eql("/contacts/")
+      end
+
+      expect(described_class.paginate_path(site, 2)).to eql("/contacts/page2")
+    end
+  end
+
+  context "with paginate_path set to a subdir wherein an index.html exists with pages in subdirs" do
+    let(:site) { build_site({'data_paginate_path' => '/contacts/page/:num'}) }
+
+    it "determines the correct pagination path for each page" do
+      if Jekyll::VERSION < '3.0.0'
+        expect(described_class.paginate_path(site, 1)).to eql("/contacts/index.html")
+      else
+        expect(described_class.paginate_path(site, 1)).to eql("/contacts/")
+      end
+
+      expect(described_class.paginate_path(site, 2)).to eql("/contacts/page/2")
+    end
+  end
+
+  context "with an paginate_path devoid of :num" do
+    let(:site) { build_site({'data_paginate_path' => '/blog/page'}) }
+
+    it "determines the correct pagination path for each page" do
+      expect(-> { described_class.paginate_path(site, 1) }).to raise_error
+    end
+  end
+
+  context "pagination disabled" do
+    let(:site) { build_site('data_paginate' => nil) }
+
+    it "report that pagination is disabled" do
+      expect(described_class.pagination_enabled?(site)).to be_falsey
+    end
+  end
+
+  context "pagination enabled for 2" do
+    let(:site)  { build_site('data_paginate' => 2, 'data_paginate_path' => '/blog/page-:num') }
+    if Jekyll::VERSION < '3.0.0'
+      let(:posts) { site.posts }
+    else
+      let(:posts) { site.posts.docs }
+    end
+
+    it "report that pagination is enabled" do
+      expect(described_class.pagination_enabled?(site)).to be_truthy
+    end
+  
+    context "with 4 posts" do
+      if Jekyll::VERSION < '3.0.0'
+        let(:posts) { site.posts[1..4] }
+      else
+        let(:posts) { site.posts.docs[1..4] }
+      end
+  
+      it "create first pager" do
+        pager = described_class.new(site, 1, posts)
+        expect(pager.posts.size).to eql(2)
+        expect(pager.total_pages).to eql(2)
+        expect(pager.previous_page).to be_nil
+        expect(pager.next_page).to eql(2)
+      end
+  
+      it "create second pager" do
+        pager = described_class.new(site, 2, posts)
+        expect(pager.posts.size).to eql(2)
+        expect(pager.total_pages).to eql(2)
+        expect(pager.previous_page).to eql(1)
+        expect(pager.next_page).to be_nil
+      end
+  
+      it "not create third pager" do
+        expect { described_class.new(site, 3, posts) }.to raise_error
+      end
+    end
+
+    context "with 5 posts" do
+      if Jekyll::VERSION < '3.0.0'
+        let(:posts) { site.posts[1..5] }
+      else
+        let(:posts) { site.posts.docs[1..5] }
+      end
+  
+      it "create first pager" do
+        pager = described_class.new(site, 1, posts)
+        expect(pager.posts.size).to eql(2)
+        expect(pager.total_pages).to eql(3)
+        expect(pager.previous_page).to be_nil
+        expect(pager.next_page).to eql(2)
+      end
+  
+      it "create second pager" do
+        pager = described_class.new(site, 2, posts)
+        expect(pager.posts.size).to eql(2)
+        expect(pager.total_pages).to eql(3)
+        expect(pager.previous_page).to eql(1)
+        expect(pager.next_page).to eql(3)
+      end
+  
+      it "create third pager" do
+        pager = described_class.new(site, 3, posts)
+        expect(pager.posts.size).to eql(1)
+        expect(pager.total_pages).to eql(3)
+        expect(pager.previous_page).to eql(2)
+        expect(pager.next_page).to be_nil
+      end
+  
+      it "not create fourth pager" do
+        expect { described_class.new(site, 4, posts) }.to raise_error(RuntimeError)
+      end
+
+    end
+  end
+
+end

data/spec/source/_data/example/1.yaml

@@ -0,0 +1,2 @@
+username: jekyll
+name: Jekyll

data/spec/source/_data/example/2.yaml

@@ -0,0 +1,2 @@
+username: hyde
+name: Hyde

data/spec/source/_data/example/3.yaml

@@ -0,0 +1,2 @@
+username: stevenson
+name: Robert Louis Stevenson

data/spec/source/contacts/index.html

@@ -0,0 +1,2 @@
+---
+---

data/spec/source/index.html

@@ -0,0 +1,2 @@
+---
+---

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+require 'jekyll'
+require File.expand_path("../lib/jekyll-paginate-data", File.dirname(__FILE__))
+
+module TestMethods
+  def test_dir(*subdirs)
+    File.join(File.dirname(__FILE__), *subdirs)
+  end
+
+  def dest_dir(*subdirs)
+    test_dir('dest', *subdirs)
+  end
+
+  def source_dir(*subdirs)
+    test_dir('source', *subdirs)
+  end
+
+  def build_configs(overrides, base_hash = Jekyll::Configuration::DEFAULTS)
+    Jekyll::Utils.deep_merge_hashes(base_hash, overrides)
+  end
+
+  def site_configuration(overrides = {})
+    build_configs({
+      "source"      => source_dir,
+      "destination" => dest_dir
+    }, build_configs(overrides))
+  end
+
+  def build_site(config = {})
+    site = Jekyll::Site.new(site_configuration(
+      {
+        "data_paginate" => 1,
+        "data_paginate_key" => "example",
+       # "data_paginate_path" => "contacts/:num"
+      }.merge(config)
+    ))
+    site.process
+    site
+  end
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  include TestMethods
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-paginate-data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bastian Greshake Tzovaras
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- bgreshake@proton.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- History.markdown
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-paginate.gemspec
+- lib/jekyll-paginate-data.rb
+- lib/jekyll-paginate-data/pager.rb
+- lib/jekyll-paginate-data/pagination.rb
+- lib/jekyll-paginate-data/version.rb
+- script/bootstrap
+- script/cibuild
+- spec/pager_spec.rb
+- spec/pagination_spec.rb
+- spec/source/_data/example/1.yaml
+- spec/source/_data/example/2.yaml
+- spec/source/_data/example/3.yaml
+- spec/source/_posts/2014-05-20-blah.html
+- spec/source/_posts/2014-05-21-bleh.html
+- spec/source/_posts/2014-05-22-humor.html
+- spec/source/_posts/2014-05-23-hey-there.html
+- spec/source/_posts/2014-05-24-whateva.html
+- spec/source/_posts/2014-05-25-oh-yes.html
+- spec/source/contacts/index.html
+- spec/source/index.html
+- spec/spec_helper.rb
+homepage: https://codeberg.org/gedankenstuecke/jekyll-paginate-data
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Pagination for data files of Jekyll
+test_files:
+- spec/pager_spec.rb
+- spec/pagination_spec.rb
+- spec/source/_data/example/1.yaml
+- spec/source/_data/example/2.yaml
+- spec/source/_data/example/3.yaml
+- spec/source/_posts/2014-05-20-blah.html
+- spec/source/_posts/2014-05-21-bleh.html
+- spec/source/_posts/2014-05-22-humor.html
+- spec/source/_posts/2014-05-23-hey-there.html
+- spec/source/_posts/2014-05-24-whateva.html
+- spec/source/_posts/2014-05-25-oh-yes.html
+- spec/source/contacts/index.html
+- spec/source/index.html
+- spec/spec_helper.rb