jekyll-index-pages 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b1bb8d47b230b04e9f5494826715b53e9d45667c91b39181f4e0f95f38e621
-  data.tar.gz: 940618a6e09b35ddc2cf16a99cad645e1189678e615f084ffd8808757c67f9f8
+  metadata.gz: cb7c18d211338644857081590675369c4a95f25bf868ec1d3d9a826c45e2fa86
+  data.tar.gz: 7fc7d7a8189af324659467dd05217fcfd830091b3abd43532ef006a46884c8a4
 SHA512:
-  metadata.gz: 01705f933b4716cbc199e6d685fb2f4f31c9e6980d26f6ff3d6ce7e8054e16b4d01bc3fdba60edca999f7dbd51612116f67c097d9fb8b7f587de46f1f2a0e070
-  data.tar.gz: b24eb1a4defef28a49c2cd4577b031a682fbf66b92344020b3267fc0e9f4eea0483249bdbed362f517ec39870d46338e9545903fbd9e59f84b05a7f1d5f1c189
+  metadata.gz: 36145d8c4629ce4a8e92cdbc003a3bc13af9e90dd60a3502a82d5596eac60800779a4eb67907a3aca4bc7ff7692917df4dc7a78c19a0a34c71311925ffb4785c
+  data.tar.gz: 95074d86fbbebec59d495a4415e39e37500a68295fc79c3144798ca269b6f9e35bc2dfc5a1fb99532a80d4efb815199f69e9b6416b42f281640f925e8fe97055

data/README.md

@@ -99,19 +99,11 @@ title: :label
 excerpt: :label
 per_page: 10
 permalink: /:label/
-layout: posts|categories|tags|authors|archive
 ```
 
 For categories and tags, `:label` variable refers to the category or tag name.  For posts, `:label` will always be equal to `posts`. For the archive, `:label` refers to any given year. For authors, `:label` is the author name. `:label` value is slugified when composing the permalink.
 
-Default value for layout depends on the type of index page. For collection index pages, the default layout is the same as the custon name used to define the collection config:
-
-```yaml
-custom_name:
-  layout: custom_name
-  collection: collection_name
-  ...
-```
+> Note there is no default value for layout. You must always specify this setting otherwise pages will be generated blank, with no markup.
 
 Because this plugin [transliterates](http://stackoverflow.com/a/20586777) the URL for generated pages, you need to define a language as follows:
 

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

@@ -48,15 +48,8 @@ module JekyllIndexPages
                 (pager.current_page > 1) ? pager.current_page.to_s : ""
               )
 
-            base =
-              if site.in_theme_dir()
-                site.in_theme_dir()
-              else
-                site.in_source_dir()
-              end
-
             site.pages <<
-              IndexPage.new(site, base, dir, item, label, layout, pager)
+              IndexPage.new(site, site.source, dir, item, label, pager)
           end
         end
       end

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

@@ -1,26 +1,18 @@
 module JekyllIndexPages
   class IndexPage < Jekyll::Page
-    def initialize(site, base, dir, config, label, layout, pager)
+    def initialize(site, base, dir, config, label, pager)
       @site = site
       @base = base
       @dir = dir
-      @name = "index.html"
-
-      layout_dir = "_layouts"
-      layout_name = "#{layout}.html"
-
-      @path =
-        if site.in_theme_dir(base) == base
-          site.in_theme_dir(base, layout_dir, layout_name)
-        else
-          site.in_source_dir(base, layout_dir, layout_name)
-        end
+      @name = "index.md"
 
       title = config["title"] || ":label"
       excerpt = config["excerpt"] || ":label"
 
       self.process(@name)
-      self.read_yaml(File.join(base, layout_dir), layout_name)
+
+      self.content = ""
+      self.data = {}
 
       if config.key?("data") and config["data"].is_a?(Hash)
         config["data"].each do |key, value|
@@ -29,6 +21,7 @@ module JekyllIndexPages
       end
 
       self.data["title"] = title.sub(":label", label)
+      self.data["layout"] = config["layout"]
       self.data["excerpt"] = excerpt.sub(":label", label)
 
       self.data["pager"] = Hash.new
@@ -51,6 +44,8 @@ module JekyllIndexPages
         else
           ""
         end
+
+      Jekyll::Hooks.trigger :pages, :post_init, self
     end
   end
 end

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

@@ -1,3 +1,3 @@
 module JekyllIndexPages
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

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

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

data/spec/fixtures/index-page/_layouts/liquid-layout.liquid

@@ -0,0 +1,12 @@
+---
+---
+<html>
+  <head>
+    <title>{{ page.title }}</title>
+    <meta name="description" content="{{ page.excerpt | strip_html }}">
+  </head>
+  <body>
+    <p>This is a liquid layout</p>
+    {{ content }}
+  </body>
+</html>

data/spec/generator_spec.rb

@@ -178,7 +178,7 @@ describe JekyllIndexPages::Generator do
     end
   end
 
-  context "When custom 'layout' setting for posts index page is provided" do
+  context "When a custom layout is provided in posts index page configuration" do
     let(:overrides) do
       {
         "index_pages" => {
@@ -192,7 +192,26 @@ describe JekyllIndexPages::Generator do
     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")
+        expect(site.pages[0].output).to include("Custom Layout")
+      end
+    end
+  end
+
+  context "When a liquid file is provided as a layout in posts index page configuration" do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "posts" => {
+            "layout" => "liquid-layout"
+          }
+        }
+      }
+    end
+
+    describe "Generator.generate" do
+      it "generates a post index page using the liquid layout" do
+        expect(site.pages.length).to eq(1)
+        expect(site.pages[0].output).to include("This is a liquid layout")
       end
     end
   end
@@ -202,6 +221,7 @@ describe JekyllIndexPages::Generator do
       {
         "index_pages" => {
           "posts" => {
+            "layout" => "data-layout",
             "data" => {
               "custom" => "This is a custom data item"
             }
@@ -214,7 +234,7 @@ describe JekyllIndexPages::Generator do
       it "generates an index page containing the custom data items" do
         expect(site.pages.length).to eq(1)
         expect(site.pages[0].data["custom"]).to eq("This is a custom data item")
-        expect(site.pages[0].content).to include("This is a custom data item")
+        expect(site.pages[0].output).to include("This is a custom data item")
       end
     end
   end

data/spec/index-page_spec.rb

@@ -11,7 +11,6 @@ describe JekyllIndexPages::IndexPage do
   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
@@ -23,7 +22,6 @@ describe JekyllIndexPages::IndexPage do
       dir,
       config,
       label,
-      layout,
       pager
     )
   end
@@ -48,7 +46,11 @@ describe JekyllIndexPages::IndexPage do
         end
 
         it "with no additional data" do
-          expect(page.data.length).to eq(3)
+          expect(page.data.length).to eq(4)
+          expect(page.data.keys).to include("title")
+          expect(page.data.keys).to include("layout")
+          expect(page.data.keys).to include("excerpt")
+          expect(page.data.keys).to include("pager")
         end
 
         it "listing the first two posts" do
@@ -127,7 +129,11 @@ describe JekyllIndexPages::IndexPage do
 
     describe "IndexPage.initialize" do
       it "will not add any custom data to index page" do
-        expect(page.data.length).to eq(3)
+        expect(page.data.length).to eq(4)
+        expect(page.data.keys).to include("title")
+        expect(page.data.keys).to include("layout")
+        expect(page.data.keys).to include("excerpt")
+        expect(page.data.keys).to include("pager")
       end
     end
   end
@@ -136,9 +142,11 @@ describe JekyllIndexPages::IndexPage do
     let(:config) do
       {
         "title" => "Star Trek Index",
+        "layout" => "default",
         "excerpt" => "Star Trek Index",
         "data" => {
           "title" => "This is another title",
+          "layout" => nil,
           "excerpt" => "This is another excerpt",
           "pager" => nil
         }
@@ -148,6 +156,7 @@ describe JekyllIndexPages::IndexPage do
     describe "IndexPage.initialize" do
       it "will preserve the original data" do
         expect(page.data["title"]).to eq("Star Trek Index")
+        expect(page.data["layout"]).to eq("default")
         expect(page.data["excerpt"]).to eq("Star Trek Index")
         expect(page.data["pager"]).to be_instance_of(Hash)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-index-pages
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jose Miguel Venegas Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2018-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -126,7 +126,9 @@ files:
 - spec/fixtures/index-page/_layouts/authors.html
 - spec/fixtures/index-page/_layouts/categories.html
 - spec/fixtures/index-page/_layouts/custom-layout.html
+- spec/fixtures/index-page/_layouts/data-layout.html
 - spec/fixtures/index-page/_layouts/default.html
+- spec/fixtures/index-page/_layouts/liquid-layout.liquid
 - spec/fixtures/index-page/_layouts/posts.html
 - spec/fixtures/index-page/_layouts/tags.html
 - spec/fixtures/index-page/_locales/en-US.yml
@@ -183,7 +185,9 @@ test_files:
 - spec/fixtures/index-page/_layouts/authors.html
 - spec/fixtures/index-page/_layouts/categories.html
 - spec/fixtures/index-page/_layouts/custom-layout.html
+- spec/fixtures/index-page/_layouts/data-layout.html
 - spec/fixtures/index-page/_layouts/default.html
+- spec/fixtures/index-page/_layouts/liquid-layout.liquid
 - spec/fixtures/index-page/_layouts/posts.html
 - spec/fixtures/index-page/_layouts/tags.html
 - spec/fixtures/index-page/_locales/en-US.yml