jekyll-index-pages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ce65b6deaeb39e301bca0272d1bd62e17221afe
+  data.tar.gz: e2d7e5c552696eae82bbb78a46403018be516513
+SHA512:
+  metadata.gz: 0e1d7966321495e3c404f4736123c32b38413f4b96f228777c7b0281a536463eba5bdaf16753cc8470bed6403e19c189436c57736e89ce9c4ee23210c77ef1f9
+  data.tar.gz: 39cf9d4784a6cd473a2267cdbd88696b0f03a7ec5400d08acc27a0a373899bd7b3bd0059ff0394e6b324149febb12b38d17b9deda9744174fe092d48dc776d9e

data/.gitignore

@@ -0,0 +1,4 @@
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+spec/dest

data/.rspec

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

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jose Miguel Venegas Mendoza
+
+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,134 @@
+# Jekyll Index Pages
+
+Index page generator for Jekyll sites. Generates paginated index pages for blog
+posts, categories and tags.
+
+## Installation
+
+To perform a manual install, execute this command on your terminal:
+
+```sh
+$ gem install jekyll-index-pages
+```
+
+Or, if you happen to use Bundler, add this line to your Gemfile:
+
+```ruby
+gem "jekyll-index-pages"
+```
+
+Then add the gem to the `gems` setting in your `_config.yml` file:
+
+```yaml
+gems:
+  - jekyll-index-pages
+```
+
+## Usage
+
+### Configuring the plugin
+
+If you want to generate index pages for your blog posts, you can add the
+following settings to your `_config.yml` file:
+
+```yaml
+index_pages:
+  posts:
+    title: Post Listing Page Title
+    excerpt: Post listing page excerpt
+    per_page: 20
+    permalink: /blog/
+    layout: blog
+```
+
+This will tell the plugin to generate index pages with given title and excerpt,
+using the layout named `_layouts/blog.html`. Each index page will contain up to
+20 posts. First page can be accessed at `/blog/`. Subsequent pages can be
+accessed at `/blog/<page-num>/`.
+
+Default values for each setting are:
+
+```yaml
+index_pages:
+  posts:
+    title: posts
+    excerpt: posts
+    per_page: 10
+    permalink: /posts/
+    layout: posts
+```
+
+If you want to generate index pages for categories, add the `categories`
+setting to `index_page` section:
+
+```yaml
+# Displaying default values
+index_pages:
+  categories:
+    title: categories
+    excerpt: categories
+    per_page: 10
+    permalink: /categories/
+    layout: categories
+```
+
+Given the default values above, categories index pages can be accessed at
+`/categories/<category-name-slug>/`.
+
+The same reasoning applies if you want to generate index pages for tags:
+
+```yaml
+# Displaying default values
+index_pages:
+  tags:
+    title: tags
+    excerpt: tags
+    per_page: 10
+    permalink: /tags/
+    layout: tags
+```
+
+Given the default values above, tags index pages can be accessed at
+`/tags/<tag-name-slug>/`.
+
+### Including documents and pagination into templates
+
+To include the paginated documents in your layouts, you can use the `pager`
+variable as demonstrated next:
+
+```liquid
+{% assign pager = page.pager %}
+
+{% for doc in pager.docs %}
+  <h2>{{ doc.title }}</h2>
+  {{ doc.excerpt }}
+  <a href="{{ doc.url }}">Read more...</a>
+{% endfor %}
+```
+
+Each document in `pager.docs` is a Jekyll document, so you can access all its
+variables as normally do when developing a layout.
+
+To include the pagination, you can do the following:
+
+```liquid
+{% assign pager = page.pager %}
+
+{% if pager.total_pages > 1 %}
+  {% if pager.prev_page > 0 %}
+  <a href="{{ pager.prev_page_url }}">Prev. page</a>
+  {% endif %}
+  <span>Page {{ pager.current_page }} of {{ pager.total_pages }}</span>
+  {% if next_page > 0 %}
+  <a href="{{ pager.next_page_url }}">Next page</a>
+  {% endif %}
+{% endif %}
+```
+
+## Contributing
+
+1. Fork it (https://github.com/rukbotto/jekyll-index-pages/fork)
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request

data/jekyll-index-pages.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/jekyll-index-pages/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name     = "jekyll-index-pages"
+  spec.version  = JekyllIndexPages::VERSION
+  spec.date     = "2017-02-21"
+  spec.authors  = ["Jose Miguel Venegas Mendoza"]
+  spec.email    = ["jvenegasmendoza@gmail.com"]
+  spec.homepage = "https://github.com/rukbotto/jekyll-index-pages"
+  spec.license  = "MIT"
+
+  spec.summary      = "Index page generator for Jekyll sites."
+  spec.description  = <<-DESCRIPTION
+    Generates paginated index pages for blog posts, categories, tags, authors
+    and collections. It also let you generate a paginated blog post archive.
+  DESCRIPTION
+
+  spec.files          = `git ls-files`.split("\n")
+  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_dependency("jekyll", "~> 3.3")
+
+  spec.add_development_dependency("bundler", "~> 1.14")
+  spec.add_development_dependency("rspec", "~> 3.5")
+end

data/lib/jekyll-index-pages/generator.rb

@@ -0,0 +1,55 @@
+module JekyllIndexPages
+  class Generator < Jekyll::Generator
+    safe true
+
+    def generate(site)
+      config = site.config["index_pages"] || {}
+      config.each do |kind, item|
+        permalink = item["permalink"] || "/:label/"
+        per_page = item['per_page'] || 10
+        layout = item["layout"] || "#{kind}"
+
+        next if !site.layouts.key? layout
+
+        doc_group =
+          case kind
+          when "posts"
+            { "posts" => site.posts.docs.reverse }
+          when "categories"
+            site.categories
+          when "tags"
+            site.tags
+          else
+            {}
+          end
+
+        doc_group.each do |label, docs|
+          pagination = Pagination.new(docs, per_page)
+
+          (0...pagination.total).each do |current|
+            pagination.paginate(current)
+
+            pager = pagination.pager
+
+            dir =
+              File.join(
+                permalink.sub(":label", Jekyll::Utils.slugify(label)),
+                (pager.current_page > 1) ? pager.current_page.to_s : ""
+              )
+
+            site.pages <<
+              IndexPage.new(
+                site,
+                site.source,
+                dir,
+                item,
+                label,
+                layout,
+                pager
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-index-pages/index-page.rb

@@ -0,0 +1,38 @@
+module JekyllIndexPages
+  class IndexPage < Jekyll::Page
+    def initialize(site, base, dir, config, label, layout, pager)
+      @site = site
+      @base = base
+      @dir = dir
+      @name = "index.html"
+
+      title = config["title"] || ":label"
+      excerpt = config["excerpt"] || ":label"
+
+      self.process(@name)
+      self.read_yaml(File.join(base, "_layouts"), "#{layout}.html")
+
+      self.data["title"] = title.sub(":label", label)
+      self.data["excerpt"] = excerpt.sub(":label", label)
+
+      self.data["pager"] = Hash.new
+      self.data["pager"]["docs"] = pager.docs.sort { |x, y| y.date <=> x.date }
+      self.data["pager"]["total_pages"] = pager.total_pages
+      self.data["pager"]["current_page"] = pager.current_page
+      self.data["pager"]["prev_page"] = pager.prev_page
+      self.data["pager"]["next_page"] = pager.next_page
+      self.data["pager"]["prev_page_url"] =
+        if (pager.prev_page > 0)
+          File.join(dir.sub(%r{/\d+}, ""), pager.prev_page.to_s << "/")
+        else
+          ""
+        end
+      self.data["pager"]["next_page_url"] =
+        if (pager.next_page > 0)
+          File.join(dir.sub(%r{/\d+}, ""), pager.next_page.to_s << "/")
+        else
+          ""
+        end
+    end
+  end
+end

data/lib/jekyll-index-pages/pagination.rb

@@ -0,0 +1,30 @@
+module JekyllIndexPages
+  class Pagination
+    Pager = Struct.new(
+      :docs,
+      :total_pages,
+      :current_page,
+      :prev_page,
+      :next_page
+    )
+
+    attr_reader :total, :pager
+
+    def initialize(docs, per_page)
+      @docs = docs
+      @per_page = per_page
+      @total = per_page > 0 ? (docs.length.to_f / per_page).ceil : 0
+      @pager = Pager.new([], @total, 0, 0, 0)
+    end
+
+    def paginate(current)
+      first = @per_page * current
+      last = first + @per_page
+
+      @pager.docs = @docs[first...last]
+      @pager.current_page = current + 1
+      @pager.prev_page = current
+      @pager.next_page = (current < total - 1) ? current + 2 : 0
+    end
+  end
+end

data/lib/jekyll-index-pages/version.rb

@@ -0,0 +1,3 @@
+module JekyllIndexPages
+  VERSION = "0.1.0"
+end

data/lib/jekyll-index-pages.rb

@@ -0,0 +1,7 @@
+require "jekyll"
+require "jekyll-index-pages/generator"
+
+module JekyllIndexPages
+  autoload :Pagination, "jekyll-index-pages/pagination"
+  autoload :IndexPage, "jekyll-index-pages/index-page"
+end

data/spec/fixtures/index-page/_config.yml

@@ -0,0 +1,6 @@
+defaults:
+  - scope:
+      path: ""
+      type: posts
+    values:
+      layout: default

data/spec/fixtures/index-page/_layouts/categories.html

@@ -0,0 +1,27 @@
+---
+---
+<html>
+  <head>
+    <title>{{ page.title }}</title>
+    <meta name="description" content="{{ page.excerpt | strip_html }}">
+  </head>
+  <body>
+    {% assign pager = page.pager %}
+
+    <h1>{{ page.title }}</h1>
+
+    {% for doc in pager.docs %}
+    <h2>{{ doc.title }}</h2>
+    {% endfor%}
+
+    {% if pager.total_pages > 1 %}
+      {% if pager.prev_page > 0 %}
+        <a href="{{ pager.prev_page_url }}">Prev. page</a>
+      {% endif %}
+        <span>Page {{ pager.current_page }} of {{ pager.total_pages }}</span>
+      {% if pager.next_page > 0 %}
+        <a href="{{ pager.next_page_url }}">Next page</a>
+      {% endif %}
+    {% endif %}
+  </body>
+</html>

data/spec/fixtures/index-page/_layouts/custom-layout.html

@@ -0,0 +1,11 @@
+---
+---
+<html>
+  <head>
+    <title>{{ page.title }}</title>
+    <meta name="description" content="{{ page.excerpt | strip_html }}">
+  </head>
+  <body>
+    <h1>Custom Layout</h1>
+  </body>
+</html>

data/spec/fixtures/index-page/_layouts/default.html

@@ -0,0 +1,11 @@
+---
+---
+<html>
+  <head>
+    <title>{{ page.title }}</title>
+    <meta name="description" content="{{ page.excerpt | strip_html }}">
+  </head>
+  <body>
+    {{ content }}
+  </body>
+</html>

data/spec/fixtures/index-page/_layouts/posts.html

@@ -0,0 +1,27 @@
+---
+---
+<html>
+  <head>
+    <title>{{ page.title }}</title>
+    <meta name="description" content="{{ page.excerpt | strip_html }}">
+  </head>
+  <body>
+    {% assign pager = page.pager %}
+
+    <h1>{{ page.title }}</h1>
+
+    {% for doc in pager.docs %}
+      <h2>{{ doc.title }}</h2>
+    {% endfor%}
+
+    {% if pager.total_pages > 1 %}
+      {% if pager.prev_page > 0 %}
+        <a href="{{ pager.prev_page_url }}">Prev. page</a>
+      {% endif %}
+        <span>Page {{ pager.current_page }} of {{ pager.total_pages }}</span>
+      {% if pager.next_page > 0 %}
+        <a href="{{ pager.next_page_url }}">Next page</a>
+      {% endif %}
+    {% endif %}
+  </body>
+</html>

data/spec/fixtures/index-page/_layouts/tags.html

@@ -0,0 +1,27 @@
+---
+---
+<html>
+  <head>
+    <title>{{ page.title }}</title>
+    <meta name="description" content="{{ page.excerpt | strip_html }}">
+  </head>
+  <body>
+    {% assign pager = page.pager %}
+
+    <h1>{{ page.title }}</h1>
+
+    {% for doc in pager.docs %}
+      <h2>{{ doc.title }}</h2>
+    {% endfor%}
+
+    {% if pager.total_pages > 1 %}
+      {% if pager.prev_page > 0 %}
+        <a href="{{ pager.prev_page_url }}">Prev. page</a>
+      {% endif %}
+      <span>Page {{ pager.current_page }} of {{ pager.total_pages }}</span>
+      {% if pager.next_page > 0 %}
+        <a href="{{ pager.next_page_url }}">Next page</a>
+      {% endif %}
+    {% endif %}
+  </body>
+</html>

data/spec/fixtures/index-page/_posts/1966-09-08-star-trek-the-original-series.md

@@ -0,0 +1,7 @@
+---
+title: "Star Trek: The Original Series"
+category: Science fiction
+tags: star-trek
+---
+
+# Star Trek: The Original Series

data/spec/fixtures/index-page/_posts/1987-09-28-star-trek-the-next-generation.md

@@ -0,0 +1,7 @@
+---
+title: "Star Trek: The Next Generation"
+category: Science fiction
+tags: star-trek
+---
+
+# Star Trek: The Next Generation

data/spec/fixtures/index-page/_posts/1993-01-03-star-trek-deep-space-nine.md

@@ -0,0 +1,7 @@
+---
+title: "Star Trek: Deep Space Nine"
+category: Science fiction
+tags: star-trek
+---
+
+# Star Trek: Deep Space Nine

data/spec/fixtures/index-page/_posts/1995-01-16-star-trek-voyager.md

@@ -0,0 +1,7 @@
+---
+title: "Star Trek: Voyager"
+category: Science fiction
+tags: star-trek
+---
+
+# Star Trek: Voyager

data/spec/fixtures/index-page/_posts/2001-09-26-star-trek-enterprise.md

@@ -0,0 +1,7 @@
+---
+title: "Star Trek: Enterprise"
+category: Science fiction
+tags: star-trek
+---
+
+# Star Trek: Enterprise

data/spec/generator_spec.rb

@@ -0,0 +1,205 @@
+require "spec_helper"
+
+describe(JekyllIndexPages::Generator) do
+  let(:overrides) { Hash.new }
+  let(:site_config) do
+    Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
+      "source" => File.expand_path("../fixtures/index-page", __FILE__),
+      "destination" => File.expand_path("../dest", __FILE__)
+    }, overrides))
+  end
+  let(:site) { Jekyll::Site.new(site_config) }
+
+  before(:each) do
+    site.process
+  end
+
+  context("When no configuration is provided") do
+    describe("Generator.generate") do
+      it("skips index page generation") do
+        expect(site.pages.length).to eq(0)
+      end
+    end
+  end
+
+  context("When default configuration for post index pages is provided") do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "posts" => {}
+        }
+      }
+    end
+
+    describe("Generator.generate") do
+      it("generates a single post index page") do
+        expect(site.pages.length).to eq(1)
+      end
+
+      it("generates post index page with default title and excerpt") do
+        expect(site.pages[0].data["title"]).to eq("posts")
+        expect(site.pages[0].data["excerpt"]).to eq("posts")
+      end
+
+      it("generates a post index page at /posts/") do
+        expect(site.pages[0].url).to eq("/posts/")
+      end
+
+      it("generates a post index page with five documents") do
+        expect(site.pages[0].data["pager"]["docs"].length).to eq(5)
+      end
+
+      it("generates a post index page with recent documents first") do
+        recent_doc = site.pages[0].data["pager"]["docs"][0]
+        older_doc = site.pages[0].data["pager"]["docs"][1]
+        expect(recent_doc.date).to be > older_doc.date
+      end
+
+      it("generates a post index page with a pager") do
+        expect(site.pages[0].data["pager"]).to be_instance_of(Hash)
+      end
+    end
+  end
+
+  context("When custom title and excerpt for posts index page is provided") do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "posts" => {
+            "title" => "Custom Title",
+            "excerpt" => "Custom excerpt"
+          }
+        }
+      }
+    end
+
+    describe("Generator.generate") do
+      it("generates post index page with custom values") do
+        expect(site.pages[0].data["title"]).to eq("Custom Title")
+        expect(site.pages[0].data["excerpt"]).to eq("Custom excerpt")
+      end
+    end
+  end
+
+  context("When custom 'per page' setting for posts index page is provided") do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "posts" => {
+            "per_page" => 2
+          }
+        }
+      }
+    end
+
+    describe("Generator.generate") do
+      context("generates the first post index page") do
+        let(:page) { site.pages[0] }
+
+        it("with two documents") do
+          expect(page.data["pager"]["docs"].length).to eq(2)
+        end
+
+        it("and next page url only") do
+          expect(page.data["pager"]["prev_page_url"]).to eq("")
+          expect(page.data["pager"]["next_page_url"]).to eq("/posts/2/")
+        end
+      end
+
+      context("generates the second post index page") do
+        let(:page) { site.pages[1] }
+
+        it("with previous and next page urls") do
+          expect(page.data["pager"]["prev_page_url"]).to eq("/posts/1/")
+          expect(page.data["pager"]["next_page_url"]).to eq("/posts/3/")
+        end
+      end
+
+      context("generates the third post index page") do
+        let(:page) { site.pages[2] }
+
+        it("with previous page url only") do
+          expect(page.data["pager"]["prev_page_url"]).to eq("/posts/2/")
+          expect(page.data["pager"]["next_page_url"]).to eq("")
+        end
+      end
+    end
+  end
+
+  context("When custom 'permalink' setting for posts index page is provided") do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "posts" => {
+            "permalink" => "/custom-permalink/"
+          }
+        }
+      }
+    end
+
+    describe("Generator.generate") do
+      it("generates a post index page at /custom-permalink/") do
+        expect(site.pages[0].url).to eq("/custom-permalink/")
+      end
+    end
+  end
+
+  context("When custom 'layout' setting for posts index page is provided") do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "posts" => {
+            "layout" => "custom-layout"
+          }
+        }
+      }
+    end
+
+    describe("Generator.generate") do
+      it("generates a post index page using the custom layout") do
+        expect(site.pages.length).to eq(1)
+        expect(site.pages[0].content).to include("Custom Layout")
+      end
+    end
+  end
+
+  context("When default settings for category index pages is provided") do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "categories" => {}
+        }
+      }
+    end
+
+    describe("Generator.generate") do
+      it("generates a single category index page") do
+        expect(site.pages.length).to eq(1)
+      end
+
+      it("generates a category index page at /science-fiction/") do
+        expect(site.pages[0].url).to eq("/science-fiction/")
+      end
+    end
+  end
+
+  context("When default settings for tag index pages is provided") do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "tags" => {}
+        }
+      }
+    end
+
+    describe("Generator.generate") do
+      it("generates a single tag index page") do
+        expect(site.pages.length).to eq(1)
+      end
+
+      it("generates a tag index page at /star-trek/") do
+        expect(site.pages[0].url).to eq("/star-trek/")
+      end
+    end
+  end
+end

data/spec/index-page_spec.rb

@@ -0,0 +1,110 @@
+require "spec_helper"
+
+describe(JekyllIndexPages::IndexPage) do
+  let(:site_config) do
+    Jekyll.configuration({
+      "source" => File.expand_path("../fixtures/index-page", __FILE__),
+      "destination" => File.expand_path("../dest", __FILE__)
+    })
+  end
+  let(:site) { Jekyll::Site.new(site_config) }
+  let(:base) { site.source }
+  let(:dir) { "/posts/" }
+  let(:label) { "posts" }
+  let(:layout) { "default" }
+  let(:pagination) do
+    JekyllIndexPages::Pagination.new(site.posts.docs.reverse, 2)
+  end
+  let(:pager) { pagination.pager }
+  let(:page) do
+    JekyllIndexPages::IndexPage.new(
+      site,
+      base,
+      dir,
+      config,
+      label,
+      layout,
+      pager
+    )
+  end
+
+  before(:each) do
+    site.process
+  end
+
+  context("When no configuration is provided") do
+    let(:config) { {} }
+
+    describe("IndexPage.initialize") do
+      context("creates the first index page") do
+        let(:pager) do
+          pagination.paginate(0)
+          pagination.pager
+        end
+
+        it("with default title and excerpt") do
+          expect(page.data["title"]).to eq("posts")
+          expect(page.data["excerpt"]).to eq("posts")
+        end
+
+        it("listing the first two posts") do
+          expect(page.data["pager"]["docs"].length).to eq(2)
+        end
+
+        it("containing pagination data") do
+          expect(page.data["pager"]["total_pages"]).to eq(3)
+          expect(page.data["pager"]["current_page"]).to eq(1)
+          expect(page.data["pager"]["prev_page"]).to eq(0)
+          expect(page.data["pager"]["next_page"]).to eq(2)
+        end
+
+        it("and url for next page only") do
+          expect(page.data["pager"]["prev_page_url"]).to eq("")
+          expect(page.data["pager"]["next_page_url"]).to eq("/posts/2/")
+        end
+      end
+
+      context("creates the second index page") do
+        let(:dir) { "/posts/2" }
+        let(:pager) do
+          pagination.paginate(1)
+          pagination.pager
+        end
+
+        it("containing urls for previous and next pages") do
+          expect(page.data["pager"]["prev_page_url"]).to eq("/posts/1/")
+          expect(page.data["pager"]["next_page_url"]).to eq("/posts/3/")
+        end
+      end
+
+      context("creates the third index page") do
+        let(:dir) { "/posts/3" }
+        let(:pager) do
+          pagination.paginate(2)
+          pagination.pager
+        end
+
+        it("containing url for prev page only") do
+          expect(page.data["pager"]["prev_page_url"]).to eq("/posts/2/")
+          expect(page.data["pager"]["next_page_url"]).to eq("")
+        end
+      end
+    end
+  end
+
+  context("When configuration is provided") do
+    let(:config) do
+      {
+        "title" => "Star Trek Index",
+        "excerpt" => "Star Trek Index"
+      }
+    end
+
+    describe("IndexPage.initialize") do
+      it("creates the first index page with custom title and excerpt") do
+        expect(page.data["title"]).to eq("Star Trek Index")
+        expect(page.data["excerpt"]).to eq("Star Trek Index")
+      end
+    end
+  end
+end

data/spec/pagination_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe(JekyllIndexPages::Pagination) do
+  context "When no documents and no results per page are provided" do
+    let(:pagination) { JekyllIndexPages::Pagination.new([], 0) }
+    let(:pager) { pagination.pager }
+
+    describe "Pagination.initialize" do
+      it "creates an empty pagination object" do
+        expect(pagination.total).to eq(0)
+      end
+    end
+  end
+
+  context "When two documents and one result per page are provided" do
+    let(:pagination) { JekyllIndexPages::Pagination.new([true, true], 1) }
+    let(:pager) { pagination.pager }
+
+    before(:each) do
+      pagination.paginate(0)
+    end
+
+    describe "Pagination.initialize" do
+      it "creates a pagination object with two documents" do
+        expect(pagination.total).to eq(2)
+      end
+    end
+
+    describe "Pagination.paginate" do
+      it "creates a pager object with two pages, one document each" do
+        expect(pager.docs.length).to eq(1)
+        expect(pager.total_pages).to eq(2)
+        expect(pager.current_page).to eq(1)
+        expect(pager.prev_page).to eq(0)
+        expect(pager.next_page).to eq(2)
+      end
+    end
+  end
+
+  context "When two documents and two result per page are provided" do
+    let(:pagination) { JekyllIndexPages::Pagination.new([true, true], 2) }
+    let(:pager) { pagination.pager }
+
+    before(:each) do
+      pagination.paginate(0)
+    end
+
+    describe "Pagination.paginate" do
+      it "creates a pager object with a single two document page" do
+        expect(pager.docs.length).to eq(2)
+        expect(pager.total_pages).to eq(1)
+        expect(pager.current_page).to eq(1)
+        expect(pager.prev_page).to eq(0)
+        expect(pager.next_page).to eq(0)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "jekyll"
+require File.expand_path("../lib/jekyll-index-pages", File.dirname(__FILE__))
+
+Jekyll.logger.log_level = :error

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-index-pages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Miguel Venegas Mendoza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: |2
+      Generates paginated index pages for blog posts, categories, tags, authors
+      and collections. It also let you generate a paginated blog post archive.
+email:
+- jvenegasmendoza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.md
+- README.md
+- jekyll-index-pages.gemspec
+- lib/jekyll-index-pages.rb
+- lib/jekyll-index-pages/generator.rb
+- lib/jekyll-index-pages/index-page.rb
+- lib/jekyll-index-pages/pagination.rb
+- lib/jekyll-index-pages/version.rb
+- spec/fixtures/index-page/_config.yml
+- spec/fixtures/index-page/_layouts/categories.html
+- spec/fixtures/index-page/_layouts/custom-layout.html
+- spec/fixtures/index-page/_layouts/default.html
+- spec/fixtures/index-page/_layouts/posts.html
+- spec/fixtures/index-page/_layouts/tags.html
+- spec/fixtures/index-page/_posts/1966-09-08-star-trek-the-original-series.md
+- spec/fixtures/index-page/_posts/1987-09-28-star-trek-the-next-generation.md
+- spec/fixtures/index-page/_posts/1993-01-03-star-trek-deep-space-nine.md
+- spec/fixtures/index-page/_posts/1995-01-16-star-trek-voyager.md
+- spec/fixtures/index-page/_posts/2001-09-26-star-trek-enterprise.md
+- spec/generator_spec.rb
+- spec/index-page_spec.rb
+- spec/pagination_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rukbotto/jekyll-index-pages
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Index page generator for Jekyll sites.
+test_files:
+- spec/fixtures/index-page/_config.yml
+- spec/fixtures/index-page/_layouts/categories.html
+- spec/fixtures/index-page/_layouts/custom-layout.html
+- spec/fixtures/index-page/_layouts/default.html
+- spec/fixtures/index-page/_layouts/posts.html
+- spec/fixtures/index-page/_layouts/tags.html
+- spec/fixtures/index-page/_posts/1966-09-08-star-trek-the-original-series.md
+- spec/fixtures/index-page/_posts/1987-09-28-star-trek-the-next-generation.md
+- spec/fixtures/index-page/_posts/1993-01-03-star-trek-deep-space-nine.md
+- spec/fixtures/index-page/_posts/1995-01-16-star-trek-voyager.md
+- spec/fixtures/index-page/_posts/2001-09-26-star-trek-enterprise.md
+- spec/generator_spec.rb
+- spec/index-page_spec.rb
+- spec/pagination_spec.rb
+- spec/spec_helper.rb