jekyll-index-pages 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cceaff67e3e3d1c462af99dcd4261144ce31b83
-  data.tar.gz: 46f33530bb464f594198f6a9de3bedbcb7933f2d
+  metadata.gz: f1229998c1d43a580d8b502d6e80d309b753e9cf
+  data.tar.gz: e8da9dee48aa8484a28e91b9c6aad773117715d6
 SHA512:
-  metadata.gz: dcccc1ea66b50900352d9aa3d487d5a81577e6772df562a3179279a9f9bdfb8373690fca4938b9681934f284e764ce30c7c8a92c1d963be201617b36b0561bc1
-  data.tar.gz: 4fa00badff6b61b42300664637495651ec2f01c8a8a0d53fa116ca49ec3de3731d74b81f31a1d4b103e8b1bd5bd2440ec76c76d24bbb7e189744cd4939881514
+  metadata.gz: 3fa256f6a0eff606f548a28b24a42bcdeaa583721d130dfb85ec31e80b67328b8c581a717e30255d6dab80ca5df7126de23324bb29164a77f0861b53fbf812c3
+  data.tar.gz: 43fb7b088bcca51ece6699fdeb9f310693e8ac33232abaab808a8a9dbbca817d184fed1458c3bf8f429069ca1385e157a18e16f9c9d5e9c9b1110575cf7d7cab

data/README.md

@@ -52,9 +52,12 @@ index_pages:
 
 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
+20 documents. First page can be accessed at `/blog/`. Subsequent pages can be
 accessed at `/blog/<page-num>/`.
 
+> Documents are sorted automatically using document's `date` setting, the
+> first being the most recent.
+
 If you want to generate index pages for categories, add the `categories`
 setting to `index_page` section:
 

data/jekyll-index-pages.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths  = ["lib"]
 
   spec.add_dependency("i18n", "~> 0.8")
-  spec.add_dependency("jekyll", "~> 3.3")
+  spec.add_dependency("jekyll", "~> 3.4.0")
 
   spec.add_development_dependency("bundler", "~> 1.14")
   spec.add_development_dependency("rake", "~> 10.0")

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

@@ -15,7 +15,7 @@ module JekyllIndexPages
         doc_group =
           case kind
           when "posts"
-            { "posts" => site.posts.docs.reverse }
+            { "posts" => site.posts.docs }
           when "categories"
             site.categories
           when "tags"
@@ -29,7 +29,8 @@ module JekyllIndexPages
           end
 
         doc_group.each do |label, docs|
-          pagination = Pagination.new(docs, per_page)
+          sorted_docs = docs.sort { |x, y| y.date <=> x.date }
+          pagination = Pagination.new(sorted_docs, per_page)
 
           (0...pagination.total).each do |current|
             pagination.paginate(current)

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

@@ -26,7 +26,7 @@ module JekyllIndexPages
       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"]["docs"] = pager.docs
       self.data["pager"]["total_pages"] = pager.total_pages
       self.data["pager"]["current_page"] = pager.current_page
       self.data["pager"]["prev_page"] = pager.prev_page

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

@@ -1,3 +1,3 @@
 module JekyllIndexPages
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/spec/fixtures/index-page/_starships/deep-space-nine.md

@@ -1,4 +1,5 @@
 ---
 title: Deep Space Nine
 layout: starships
+date: 2351-01-01
 ---

data/spec/fixtures/index-page/_starships/enterprise-d.md

@@ -1,4 +1,5 @@
 ---
 title: Enterprise D
 layout: starships
+date: 2363-01-01
 ---

data/spec/fixtures/index-page/_starships/enterprise.md

@@ -1,4 +1,5 @@
 ---
 title: Enterprise
 layout: starships
+date: 2245-01-01
 ---

data/spec/fixtures/index-page/_starships/voyager.md

@@ -1,4 +1,5 @@
 ---
 title: Voyager
 layout: starships
+date: 2371-01-01
 ---

data/spec/generator_spec.rb

@@ -45,18 +45,32 @@ describe JekyllIndexPages::Generator do
         expect(site.pages[0].url).to eq("/posts/")
       end
 
+      it "generates a post index page with a pager" do
+        expect(site.pages[0].data["pager"]).to be_instance_of(Hash)
+      end
+
       it "generates a post index page with six documents" do
         expect(site.pages[0].data["pager"]["docs"].length).to eq(6)
       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
+        first = site.pages[0].data["pager"]["docs"][0]
+        expect(first.date).to eq(Time.new(2001, 9, 26))
 
-      it "generates a post index page with a pager" do
-        expect(site.pages[0].data["pager"]).to be_instance_of(Hash)
+        second = site.pages[0].data["pager"]["docs"][1]
+        expect(second.date).to eq(Time.new(1995, 1, 16))
+
+        third = site.pages[0].data["pager"]["docs"][2]
+        expect(third.date).to eq(Time.new(1993, 1, 03))
+
+        fourth = site.pages[0].data["pager"]["docs"][3]
+        expect(fourth.date).to eq(Time.new(1987, 9, 28))
+
+        fifth = site.pages[0].data["pager"]["docs"][4]
+        expect(fifth.date).to eq(Time.new(1966, 9, 8))
+
+        sixth = site.pages[0].data["pager"]["docs"][5]
+        expect(sixth.date).to eq(Time.new(1966, 9, 8))
       end
     end
   end
@@ -100,6 +114,14 @@ describe JekyllIndexPages::Generator do
           expect(page.data["pager"]["docs"].length).to eq(2)
         end
 
+        it "sorted by date, recent first" do
+          first = page.data["pager"]["docs"][0]
+          expect(first.date).to eq(Time.new(2001, 9, 26))
+
+          second = page.data["pager"]["docs"][1]
+          expect(second.date).to eq(Time.new(1995, 1, 16))
+        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/")
@@ -109,6 +131,18 @@ describe JekyllIndexPages::Generator do
       context "generates the second post index page" do
         let(:page) { site.pages[1] }
 
+        it "with two documents" do
+          expect(page.data["pager"]["docs"].length).to eq(2)
+        end
+
+        it "sorted by date, recent first" do
+          first = page.data["pager"]["docs"][0]
+          expect(first.date).to eq(Time.new(1993, 1, 03))
+
+          second = page.data["pager"]["docs"][1]
+          expect(second.date).to eq(Time.new(1987, 9, 28))
+        end
+
         it "with previous and next page urls" do
           expect(page.data["pager"]["prev_page_url"]).to eq("/posts/")
           expect(page.data["pager"]["next_page_url"]).to eq("/posts/3/")
@@ -268,6 +302,83 @@ describe JekyllIndexPages::Generator do
       it "generates the first collection index page at /starships/" do
         expect(site.pages[0].url).to eq("/starships/")
       end
+
+      it "generates a post index page with four documents" do
+        expect(site.pages[0].data["pager"]["docs"].length).to eq(4)
+      end
+
+      it "generates a post index page with recent documents first" do
+        first = site.pages[0].data["pager"]["docs"][0]
+        expect(first.date).to eq(Time.new(2371, 1, 1))
+
+        second = site.pages[0].data["pager"]["docs"][1]
+        expect(second.date).to eq(Time.new(2363, 1, 1))
+
+        third = site.pages[0].data["pager"]["docs"][2]
+        expect(third.date).to eq(Time.new(2351, 1, 1))
+
+        fourth = site.pages[0].data["pager"]["docs"][3]
+        expect(fourth.date).to eq(Time.new(2245, 1, 1))
+      end
+    end
+  end
+
+  context "When custom 'per page' setting for posts index page is provided" do
+    let(:overrides) do
+      {
+        "collections" => ["starships"],
+        "index_pages" => {
+          "custom" => {
+            "per_page" => 2,
+            "layout" => "custom-layout",
+            "collection" => "starships"
+          }
+        }
+      }
+    end
+
+    describe "Generator.generate" do
+      context "generates the first collection index page" do
+        let(:page) { site.pages[0] }
+
+        it "with two documents" do
+          expect(page.data["pager"]["docs"].length).to eq(2)
+        end
+
+        it "sorted by date, recent first" do
+          first = page.data["pager"]["docs"][0]
+          expect(first.date).to eq(Time.new(2371, 1, 1))
+
+          second = page.data["pager"]["docs"][1]
+          expect(second.date).to eq(Time.new(2363, 1, 1))
+        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("/starships/2/")
+        end
+      end
+
+      context "generates the second collection index page" do
+        let(:page) { site.pages[1] }
+
+        it "with two documents" do
+          expect(page.data["pager"]["docs"].length).to eq(2)
+        end
+
+        it "sorted by date, recent first" do
+          first = page.data["pager"]["docs"][0]
+          expect(first.date).to eq(Time.new(2351, 1, 1))
+
+          second = page.data["pager"]["docs"][1]
+          expect(second.date).to eq(Time.new(2245, 1, 1))
+        end
+
+        it "and previous page url only" do
+          expect(page.data["pager"]["prev_page_url"]).to eq("/starships/")
+          expect(page.data["pager"]["next_page_url"]).to eq("")
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-index-pages
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Jose Miguel Venegas Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-22 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Index page generator for Jekyll sites.