jekyll-index-pages 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ee67fae3519b7680684e5c412bfc19d5bac6a44a122494310713035ac345455
-  data.tar.gz: 9efd20c3b37187e8ffbd1d5d7881e8fb1820af56eba8f1c30d1532a5e41ff691
+  metadata.gz: 15b1bb8d47b230b04e9f5494826715b53e9d45667c91b39181f4e0f95f38e621
+  data.tar.gz: 940618a6e09b35ddc2cf16a99cad645e1189678e615f084ffd8808757c67f9f8
 SHA512:
-  metadata.gz: 82455545f0573679cc8d8cff8549bc849dfca7d7476fc5cb31217dac4252ba35419897d550a5b1f2f107a8d85ae222331a92945290afc04dc80f5427a3551cfd
-  data.tar.gz: f7211b3e0e467a205cf5414185f8b1f7f7258b51e3c920f41625994114a8b88ba65c7d62ab0a88cd02150ad3e781ab61191ea742f01beddd1853f10005b5beb5
+  metadata.gz: 01705f933b4716cbc199e6d685fb2f4f31c9e6980d26f6ff3d6ce7e8054e16b4d01bc3fdba60edca999f7dbd51612116f67c097d9fb8b7f587de46f1f2a0e070
+  data.tar.gz: b24eb1a4defef28a49c2cd4577b031a682fbf66b92344020b3267fc0e9f4eea0483249bdbed362f517ec39870d46338e9545903fbd9e59f84b05a7f1d5f1c189

data/README.md

@@ -2,9 +2,7 @@
 
 [![Build Status](https://travis-ci.org/rukbotto/jekyll-index-pages.svg?branch=master)](https://travis-ci.org/rukbotto/jekyll-index-pages)
 
-Index page generator for Jekyll sites. Generates paginated index pages for blog
-posts, categories and tags. It can also generate a paginated yearly archive,
-author and collection pages.
+Index page generator for Jekyll sites. Generates paginated index pages for blog posts, categories and tags. It can also generate a paginated yearly archive, author and collection pages.
 
 ## Installation
 
@@ -37,8 +35,7 @@ gems:
 
 ### 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:
+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:
@@ -50,16 +47,11 @@ index_pages:
     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 documents. First page can be accessed at `/blog/`. Subsequent pages can be
-accessed at `/blog/<page-num>/`.
+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 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.
+> 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:
+If you want to generate index pages for categories, add the `categories` setting to `index_page` section:
 
 ```yaml
 index_pages:
@@ -110,14 +102,9 @@ 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.
+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:
+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:
@@ -126,21 +113,35 @@ custom_name:
   ...
 ```
 
-Because this plugin [transliterates](http://stackoverflow.com/a/20586777) the
-URL for generated pages, you need to define a language as follows:
+Because this plugin [transliterates](http://stackoverflow.com/a/20586777) the URL for generated pages, you need to define a language as follows:
 
 ```yaml
 lang: en-US
 ```
 
-Then get the specified locale file from
-https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale and add it to
-the `_locales/` directory inside your site codebase.
+Then get the specified locale file from <https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale> and add it to the `_locales/` directory inside your site codebase.
+
+### Including custom data into templates
+
+To include custom data in the template, you must define a variable in the configuration under the `data` section:
+
+```yaml
+index_pages:
+  posts:
+    layout: blog
+    data:
+      custom: This is a custom data item
+```
+
+In this case, you can print the contents of the `custom` variable in the `_layouts/blog.html` layout like this:
+
+```liquid
+{{ page.custom }}
+```
 
 ### Including documents and pagination into templates
 
-To include the paginated documents in your layouts, you can use the `pager`
-variable as demonstrated next:
+To include the paginated documents in your layouts, you can use the `pager` variable as demonstrated next:
 
 ```liquid
 {% assign pager = page.pager %}
@@ -152,8 +153,7 @@ variable as demonstrated next:
 {% endfor %}
 ```
 
-Each document in `pager.docs` is a Jekyll document, so you can access all its
-variables as normally do when developing a layout.
+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:
 
@@ -173,10 +173,7 @@ To include the pagination, you can do the following:
 
 ### Linking index pages
 
-Sometimes you will need to link index pages, for example when building some
-kind of category navigation. For this particular use case, you can use `{%
-category_url %}`, `{% tag_url %}`, `{% author_url %}` and `{% archive_url %}`
-tags for getting the correct URL to a given index page.
+Sometimes you will need to link index pages, for example when building some kind of category navigation. For this particular use case, you can use `{% category_url %}`, `{% tag_url %}`, `{% author_url %}` and `{% archive_url %}` tags for getting the correct URL to a given index page.
 
 ```liquid
 <a href="{% category_url "Category name" %}">Category name</a>
@@ -199,22 +196,14 @@ The following example demonstrates how to create a basic category navigation:
 
 ## Development
 
-After checking out the repo, run `script/setup` to install dependencies. Then,
-run `rake spec` to run the tests. You can also run `script/console` for an
-interactive prompt that will allow you to experiment.
+After checking out the repo, run `script/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `script/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/rukbotto/jekyll-index-pages.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/rukbotto/jekyll-index-pages.>
 
 ## License
 
-The gem is available as open source under the terms of the [MIT
-License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

@@ -22,6 +22,12 @@ module JekyllIndexPages
       self.process(@name)
       self.read_yaml(File.join(base, layout_dir), layout_name)
 
+      if config.key?("data") and config["data"].is_a?(Hash)
+        config["data"].each do |key, value|
+          self.data[key] = value
+        end
+      end
+
       self.data["title"] = title.sub(":label", label)
       self.data["excerpt"] = excerpt.sub(":label", label)
 

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

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

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

@@ -10,6 +10,8 @@
 
     <h1>{{ page.title }}</h1>
 
+    <p>{{ page.custom }}</p>
+
     {% for doc in pager.docs %}
       <h2>{{ doc.title }}</h2>
     {% endfor%}

data/spec/generator_spec.rb

@@ -197,6 +197,28 @@ describe JekyllIndexPages::Generator do
     end
   end
 
+  context "When custom data is provided in the configuration for posts index page" do
+    let(:overrides) do
+      {
+        "index_pages" => {
+          "posts" => {
+            "data" => {
+              "custom" => "This is a custom data item"
+            }
+          }
+        }
+      }
+    end
+
+    describe "Generator.generate" 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")
+      end
+    end
+  end
+
   context "When default configuration for category index pages is provided" do
     let(:overrides) do
       {

data/spec/index-page_spec.rb

@@ -47,6 +47,10 @@ describe JekyllIndexPages::IndexPage do
           expect(page.data["excerpt"]).to eq("posts")
         end
 
+        it "with no additional data" do
+          expect(page.data.length).to eq(3)
+        end
+
         it "listing the first two posts" do
           expect(page.data["pager"]["docs"].length).to eq(2)
         end
@@ -96,14 +100,56 @@ describe JekyllIndexPages::IndexPage do
     let(:config) do
       {
         "title" => "Star Trek Index",
-        "excerpt" => "Star Trek Index"
+        "excerpt" => "Star Trek Index",
+        "data" => {
+          "description" => "This is the Star Trek Index"
+        }
+      }
+    end
+
+    describe "IndexPage.initialize" do
+      it "creates the first index page with the specified title, excerpt and data items" do
+        expect(page.data["title"]).to eq("Star Trek Index")
+        expect(page.data["excerpt"]).to eq("Star Trek Index")
+        expect(page.data["description"]).to eq("This is the Star Trek Index")
+      end
+    end
+  end
+
+  context "When custom data is not provided as a Hash" do
+    let(:config) do
+      {
+        "title" => "Star Trek Index",
+        "excerpt" => "Star Trek Index",
+        "data" => ["This is custom data item"]
+      }
+    end
+
+    describe "IndexPage.initialize" do
+      it "will not add any custom data to index page" do
+        expect(page.data.length).to eq(3)
+      end
+    end
+  end
+
+  context "When custom data tries to override the page's original data" do
+    let(:config) do
+      {
+        "title" => "Star Trek Index",
+        "excerpt" => "Star Trek Index",
+        "data" => {
+          "title" => "This is another title",
+          "excerpt" => "This is another excerpt",
+          "pager" => nil
+        }
       }
     end
 
     describe "IndexPage.initialize" do
-      it "creates the first index page with custom title and excerpt" do
+      it "will preserve the original data" do
         expect(page.data["title"]).to eq("Star Trek Index")
         expect(page.data["excerpt"]).to eq("Star Trek Index")
+        expect(page.data["pager"]).to be_instance_of(Hash)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-index-pages
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Jose Miguel Venegas Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n