jekyll-index-pages 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a25da1b24a53ee735e7cae9a3eb1d9ed5f49228f
-  data.tar.gz: 47db13f7f5bfaadc4adab6c3271537a8e8c49af0
+  metadata.gz: 434e6a42ab53e8200e65e037b6984b6693eb05bc
+  data.tar.gz: c022b58acba4625785ca9a81d20e8fa67add484f
 SHA512:
-  metadata.gz: 57d5b0d80cd251773c2d791e5916ccb1cbe7585c473085b2869d68106dc3ed03665b2fb99b2457f0b8cfb8a48147e363d65f689861fd69717ea8d08c5fdf632a
-  data.tar.gz: c4c47471165ef78521ade61525b0724d260fd3c887e0070f43459c86697219dca8341e33139b8cf20dd556645e9ea81eb4afda77619c474b54b00cee2e5e0320
+  metadata.gz: d44e8f13335e1274a05a8333a153e2e07a878e5cbb926f67c9782e2518280f451b3a50294929f27dd1bdfc38e9c2b5fba3ef7b7a800a17e892d5fe770be039de
+  data.tar.gz: d612fc1f00c25007a98a4116da3ffa9f4f50e20136097260dfbe7aeb3e7bc87e8e0c610067db0ee1b1abc33a808bfc7d4037f5c69840088d4ad2523e418eaf6d

data/README.md

@@ -123,7 +123,7 @@ custom_name:
   ...
 ```
 
-Beacuse this plugin [transliterates](http://stackoverflow.com/a/20586777) the
+Because this plugin [transliterates](http://stackoverflow.com/a/20586777) the
 URL for generated pages, you need to define a language as follows:
 
 ```yaml
@@ -168,6 +168,26 @@ To include the pagination, you can do the following:
 {% endif %}
 ```
 
+### Linking category and tag pages
+
+Sometimes you will need to link category or tag pages, for example when
+building some kind of navigation. For this particular use case, you can use `{%
+category_url %}` and `{% tag_url %}` tags for getting the correct URL to a
+given category or tag page.
+
+`{% category_url %}` accepts a valid category name as an argument.  Likewise,
+`{% tag_url %}` receives a valid tag name.
+
+The following example demonstrates how to create a basic category navigation:
+
+```liquid
+<ul>
+  {% for category in site.categories %}
+    <li><a href="{% category_url category[0] %}">{{ category[0] }}</a></li>
+  {% endfor%}
+</ul>
+```
+
 ## Development
 
 After checking out the repo, run `script/setup` to install dependencies. Then,

data/lib/jekyll-index-pages/tags/category-url.rb

@@ -0,0 +1,35 @@
+module JekyllIndexPages
+  class CategoryURL < Liquid::Tag
+    def initialize(tag, text, tokens)
+      super
+      @text = text.strip
+    end
+
+    def render(context)
+      site = context.registers[:site]
+
+      config = site.config["index_pages"] || {}
+      _, item = config.detect do |key, value|
+        key == "categories"
+      end
+
+      permalink = item ? item["permalink"] : "/:label/"
+      category, _ = site.categories.detect do |key, value|
+        key == @text
+      end
+
+      if category
+        category_slug =
+          I18n.transliterate(
+            Jekyll::Utils.slugify(category),
+            :locale => I18n.locale
+          )
+        permalink.sub(":label", category_slug)
+      else
+        ""
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("category_url", JekyllIndexPages::CategoryURL)

data/lib/jekyll-index-pages/tags/tag-url.rb

@@ -0,0 +1,35 @@
+module JekyllIndexPages
+  class TagURL < Liquid::Tag
+    def initialize(tag, text, tokens)
+      super
+      @text = text.strip
+    end
+
+    def render(context)
+      site = context.registers[:site]
+
+      config = site.config["index_pages"] || {}
+      _, item = config.detect do |key, value|
+        key == "tags"
+      end
+
+      permalink = item ? item["permalink"] : "/:label/"
+      tag, _ = site.tags.detect do |key, value|
+        key == @text
+      end
+
+      if tag
+        tag_slug =
+          I18n.transliterate(
+            Jekyll::Utils.slugify(tag),
+            :locale => I18n.locale
+        )
+        permalink.sub(":label", tag_slug)
+      else
+        ""
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("tag_url", JekyllIndexPages::TagURL)

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

@@ -1,3 +1,3 @@
 module JekyllIndexPages
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/jekyll-index-pages.rb

@@ -4,8 +4,7 @@ require "jekyll-index-pages/archive"
 require "jekyll-index-pages/author"
 require "jekyll-index-pages/collection"
 require "jekyll-index-pages/generator"
-
-module JekyllIndexPages
-  autoload :Pagination, "jekyll-index-pages/pagination"
-  autoload :IndexPage, "jekyll-index-pages/index-page"
-end
+require "jekyll-index-pages/index-page"
+require "jekyll-index-pages/pagination"
+require "jekyll-index-pages/tags/category-url"
+require "jekyll-index-pages/tags/tag-url"

data/spec/category-url_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe JekyllIndexPages::CategoryURL 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) }
+  let(:payload) { site.site_payload }
+  let(:info) do
+    {
+      :registers => { :site => site, :page => payload["page"] }
+    }
+  end
+
+  before(:each) do
+    site.process
+  end
+
+  context "When no text is provided" do
+    let(:template) { Liquid::Template.parse("{% category_url %}") }
+
+    describe "CategoryURL.render" do
+      it "returns an empty string" do
+        expect(template.render(payload, info)).to eq("")
+      end
+    end
+  end
+
+  context "When a valid category name is provided" do
+    let(:template) do
+      Liquid::Template.parse("{% category_url Ciencia ficción %}")
+    end
+
+    describe "CategoryURL.render" do
+      it "returns a valid category page URL" do
+        expect(template.render(payload, info)).to eq("/ciencia-ficcion/")
+      end
+    end
+
+    context "and a custom category permalink is provided" do
+      let(:overrides) do
+        {
+          "index_pages" => {
+            "categories" => {
+              "permalink" => "/custom/:label/"
+            }
+          }
+        }
+      end
+
+      describe "CategoryURL.render" do
+        it "returns a valid category page URL" do
+          expect(template.render(payload, info)).to eq("/custom/ciencia-ficcion/")
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/index-page/_posts/1966-09-08-viaje-a-las-estrellas-la-serie-original.md

@@ -1,7 +1,7 @@
 ---
 title: "Viaje a las Estrellas: La Serie Original"
 category: Ciencia ficción
-tags: viaje-a-las-estrellas
+tags: [viaje-a-las-estrellas, ciencia-ficción]
 author: James T Kirk
 ---
 

data/spec/generator_spec.rb

@@ -197,8 +197,8 @@ describe(JekyllIndexPages::Generator) do
     end
 
     describe("Generator.generate") do
-      it("generates two tag index pages") do
-        expect(site.pages.length).to eq(2)
+      it("generates three tag index pages") do
+        expect(site.pages.length).to eq(3)
       end
 
       it("generates a tag index page at /star-trek/") do

data/spec/tag-url_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe JekyllIndexPages::TagURL 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) }
+  let(:payload) { site.site_payload }
+  let(:info) do
+    {
+      :registers => { :site => site, :page => payload["page"] }
+    }
+  end
+
+  before(:each) do
+    site.process
+  end
+
+  context "When no text is provided" do
+    let(:template) { Liquid::Template.parse("{% tag_url %}") }
+
+    describe "TagURL.render" do
+      it "returns an empty string" do
+        expect(template.render(payload, info)).to eq("")
+      end
+    end
+  end
+
+  context "When a valid tag name is provided" do
+    let(:template) do
+      Liquid::Template.parse("{% tag_url ciencia-ficción %}")
+    end
+
+    describe "TagURL.render" do
+      it "returns a valid tag page URL" do
+        expect(template.render(payload, info)).to eq("/ciencia-ficcion/")
+      end
+    end
+
+    context "and a custom tag permalink is provided" do
+      let(:overrides) do
+        {
+          "index_pages" => {
+            "tags" => {
+              "permalink" => "/custom/:label/"
+            }
+          }
+        }
+      end
+
+      describe "TagURL.render" do
+        it "returns a valid tag page URL" do
+          expect(template.render(payload, info)).to eq("/custom/ciencia-ficcion/")
+        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.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Jose Miguel Venegas Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -105,11 +105,14 @@ files:
 - lib/jekyll-index-pages/generator.rb
 - lib/jekyll-index-pages/index-page.rb
 - lib/jekyll-index-pages/pagination.rb
+- lib/jekyll-index-pages/tags/category-url.rb
+- lib/jekyll-index-pages/tags/tag-url.rb
 - lib/jekyll-index-pages/version.rb
 - script/console
 - script/setup
 - spec/archive_spec.rb
 - spec/author_spec.rb
+- spec/category-url_spec.rb
 - spec/collection_spec.rb
 - spec/fixtures/index-page/_config.yml
 - spec/fixtures/index-page/_layouts/archive.html
@@ -134,6 +137,7 @@ files:
 - spec/index-page_spec.rb
 - spec/pagination_spec.rb
 - spec/spec_helper.rb
+- spec/tag-url_spec.rb
 homepage: https://github.com/rukbotto/jekyll-index-pages
 licenses:
 - MIT
@@ -161,6 +165,7 @@ summary: Index page generator for Jekyll sites.
 test_files:
 - spec/archive_spec.rb
 - spec/author_spec.rb
+- spec/category-url_spec.rb
 - spec/collection_spec.rb
 - spec/fixtures/index-page/_config.yml
 - spec/fixtures/index-page/_layouts/archive.html
@@ -185,3 +190,4 @@ test_files:
 - spec/index-page_spec.rb
 - spec/pagination_spec.rb
 - spec/spec_helper.rb
+- spec/tag-url_spec.rb