jekyll-index-pages 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 644663b8c4ce0860a650f8293f1795d30694ef57
-  data.tar.gz: 39a86341f8fdbceff9fa5deaea830615c911f34e
+  metadata.gz: a1d9113d77e75aa8da870300ced987ad10325450
+  data.tar.gz: e0b2d158119e53b2a3cf79f19732b6c402e14367
 SHA512:
-  metadata.gz: 71b7d568df6cb8aac4637e79cf14dc12015f022393e232d7e7e5760abd7f7423bcbca6b508d20c52cb062c5827130b4788759f617cf695aad05e252d3c5d9f7e
-  data.tar.gz: 04778169628e282f12696b1523cc0cd2ad6bda00b18b73e5aee3d2e9b11e469bd858ee8655e95b43414b53d5e061f62ac5aafc134682244530bf5e7786b57638
+  metadata.gz: 0609577fc6a27874ea0ef5dd621ee43fcd581e0f76914033552925f95cf111d517eb8e7b7affe1d7605876c05c6ced2009b06bcd4f46b7a823ae2f351181c90a
+  data.tar.gz: 5adcccf910a80b6a078fab6a1e0df00c90da3a5da9dde634cdddb3f6969d038622b7409b6fc437934644016b67340672d8e6bca4c395615f34a3da59df65acb0

data/README.md

@@ -168,20 +168,21 @@ To include the pagination, you can do the following:
 {% endif %}
 ```
 
-### Linking category and tag pages
+### Linking index 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:
+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>
+<a href="{% tag_url "Tag name" %}">Tag name</a>
+<a href="{% author_url "Author Name" %}">Author Name</a>
+<a href="{% archive_url "2001" %}">2001</a>
 ```
 
-Likewise, `{% tag_url %}` receives a valid tag name.
+You can pass the argument directly as a string or as a variable.
 
 The following example demonstrates how to create a basic category navigation:
 

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

@@ -3,9 +3,6 @@ module JekyllIndexPages
     priority :high
 
     def generate(site)
-      config = site.config["index_pages"] || {}
-      return if !config.key?("archive")
-
       archive = Hash.new { |hash, key| hash[key] = [] }
       site.posts.docs.each { |doc| archive[doc.date.strftime("%Y")] << doc }
       site.data["archive"] = archive

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

@@ -3,10 +3,7 @@ module JekyllIndexPages
     priority :high
 
     def generate(site)
-      config = site.config["index_pages"] || {}
-      return if !config.key?("authors")
-
-      authors = Hash.new { |hash, key| authors[key] = [] }
+      authors = Hash.new { |hash, key| hash[key] = [] }
       site.posts.docs.each { |doc| authors[doc.data["author"]] << doc }
       site.data["authors"] = authors
     end

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

@@ -0,0 +1,14 @@
+module JekyllIndexPages
+  class ArchiveURL < URLTag
+    def has_kind?(site, kind)
+      site.data["archive"].key?(kind)
+    end
+
+    def filter_config(config)
+      _, item = config.detect { |key, value| key == "archive" }
+      item
+    end
+  end
+end
+
+Liquid::Template.register_tag("archive_url", JekyllIndexPages::ArchiveURL)

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

@@ -0,0 +1,14 @@
+module JekyllIndexPages
+  class AuthorURL < URLTag
+    def has_kind?(site, kind)
+      site.data["authors"].key?(kind)
+    end
+
+    def filter_config(config)
+      _, item = config.detect { |key, value| key == "authors" }
+      item
+    end
+  end
+end
+
+Liquid::Template.register_tag("author_url", JekyllIndexPages::AuthorURL)

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

@@ -1,50 +1,12 @@
 module JekyllIndexPages
-  class CategoryURL < Liquid::Tag
-    STRING_SYNTAX = %r{^\"[[:alnum:] ]+\"$}u
-    VARIABLE_SYNTAX = %r{^\(?[[:alnum:]\-\.\[\]]+\)?$}u
-
-    def initialize(tag, markup, tokens)
-      super
-      @markup = markup.strip
+  class CategoryURL < URLTag
+    def has_kind?(site, kind)
+      site.categories.has_key?(kind)
     end
 
-    def render(context)
-      input = ""
-      if @markup.match(STRING_SYNTAX)
-        input = @markup.gsub("\"", "")
-      elsif @markup.match(VARIABLE_SYNTAX)
-        input = Liquid::Variable.new(@markup).render(context)
-      else
-        raise ArgumentError, <<-eos
-Invalid syntax for category_url tag:
-
-  #{@markup}
-
-Valid syntax:
-
-  {% category_url "Category name" %}
-
-  or
-
-  {% category_url name_in_variable %}
-
-eos
-      end
-
-      site = context.registers[:site]
-
-      category, _ = site.categories.detect { |key, value| key == input }
-      return "" if !category
-      category_slug =
-        I18n.transliterate(
-          Jekyll::Utils.slugify(category),
-          :locale => I18n.locale
-        )
-
-      config = site.config["index_pages"] || {}
+    def filter_config(config)
       _, item = config.detect { |key, value| key == "categories" }
-      permalink = item ? item["permalink"] : "/:label/"
-      permalink.sub(":label", category_slug)
+      item
     end
   end
 end

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

@@ -1,50 +1,12 @@
 module JekyllIndexPages
-  class TagURL < Liquid::Tag
-    STRING_SYNTAX = %r{^\"[[:alnum:]\-]+\"$}u
-    VARIABLE_SYNTAX = %r{^\(?[[:alnum:]\-\.\[\]]+\)?$}u
-
-    def initialize(tag, markup, tokens)
-      super
-      @markup = markup.strip
+  class TagURL < URLTag
+    def has_kind?(site, kind)
+      site.tags.has_key?(kind)
     end
 
-    def render(context)
-      input = ""
-      if @markup.match(STRING_SYNTAX)
-        input = @markup.gsub("\"", "")
-      elsif @markup.match(VARIABLE_SYNTAX)
-        input = Liquid::Variable.new(@markup).render(context)
-      else
-        raise ArgumentError, <<-eos
-Invalid syntax for tag_url tag:
-
-  #{@markup}
-
-Valid syntax:
-
-  {% tag_url "Tag name" %}
-
-  or
-
-  {% tag_url name_in_variable %}
-
-eos
-      end
-
-      site = context.registers[:site]
-
-      tag, _ = site.tags.detect { |key, value| key == input }
-      return "" if !tag
-      tag_slug =
-        I18n.transliterate(
-          Jekyll::Utils.slugify(tag),
-          :locale => I18n.locale
-      )
-
-      config = site.config["index_pages"] || {}
+    def filter_config(config)
       _, item = config.detect { |key, value| key == "tags" }
-      permalink = item ? item["permalink"] : "/:label/"
-      permalink.sub(":label", tag_slug)
+      item
     end
   end
 end

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

@@ -0,0 +1,61 @@
+module JekyllIndexPages
+  class URLTag < Liquid::Tag
+    STRING_SYNTAX = %r{^\"[[:alnum:]\- ]+\"$}u
+    VARIABLE_SYNTAX = %r{^\(?[[:alnum:]\-\.\[\]]+\)?$}u
+
+    def initialize(tag_name, markup, tokens)
+      super
+      @markup = markup.strip
+      @tag_name = tag_name
+    end
+
+    def parse_params(context)
+      input = ""
+      if @markup.match(STRING_SYNTAX)
+        input = @markup.gsub("\"", "")
+      elsif @markup.match(VARIABLE_SYNTAX)
+        input = Liquid::Variable.new(@markup).render(context)
+      else
+        raise ArgumentError, <<-eos
+Invalid syntax for #{@tag_name} tag:
+
+  #{@markup}
+
+Valid syntax:
+
+  {% #{@tag_name} "Name" %}
+
+  or
+
+  {% #{@tag_name} variable %}
+
+eos
+      end
+    end
+
+    def has_kind?(site, kind)
+      false
+    end
+
+    def filter_config(config)
+      nil
+    end
+
+    def render(context)
+      site = context.registers[:site]
+      master_config = site.config["index_pages"] || {}
+
+      kind = parse_params(context)
+      return "" if !has_kind?(site, kind)
+      slug =
+        I18n.transliterate(
+          Jekyll::Utils.slugify(kind),
+          :locale => I18n.locale
+        )
+
+      config = filter_config(master_config)
+      permalink = config ? config["permalink"] : "/:label/"
+      permalink.sub(":label", slug)
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module JekyllIndexPages
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/jekyll-index-pages.rb

@@ -6,5 +6,8 @@ require "jekyll-index-pages/collection"
 require "jekyll-index-pages/generator"
 require "jekyll-index-pages/index-page"
 require "jekyll-index-pages/pagination"
+require "jekyll-index-pages/tags"
+require "jekyll-index-pages/tags/archive-url"
+require "jekyll-index-pages/tags/author-url"
 require "jekyll-index-pages/tags/category-url"
 require "jekyll-index-pages/tags/tag-url"

data/spec/archive-url_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+
+describe JekyllIndexPages::ArchiveURL 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("{% archive_url %}") }
+
+    describe "ArchiveURL.render" do
+      it "raises ArgumentError" do
+        expect { template.render!(payload, info) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  context "When a valid year is provided" do
+    let(:template) do
+      Liquid::Template.parse("{% archive_url \"1966\" %}")
+    end
+
+    describe "ArchiveURL.render" do
+      it "returns a valid archive page URL" do
+        expect(template.render!(payload, info)).to eq("/1966/")
+      end
+    end
+
+    context "and a custom archive permalink is provided" do
+      let(:overrides) do
+        {
+          "index_pages" => {
+            "archive" => {
+              "permalink" => "/custom/:label/"
+            }
+          }
+        }
+      end
+
+      describe "ArchiveURL.render" do
+        it "returns a valid archive page URL" do
+          expect(template.render!(payload, info)).to eq("/custom/1966/")
+        end
+      end
+    end
+  end
+
+  context "When a valid year is provided as a variable" do
+    let(:template) do
+      Liquid::Template.parse <<-eos
+{% assign year = "1966" %}
+{% archive_url year %}
+eos
+    end
+
+    describe "ArchiveURL.render" do
+      it "returns a valid archive page URL" do
+        expect(template.render!(payload, info)).to eq("\n/1966/\n")
+      end
+    end
+
+    context "and a custom author permalink is provided" do
+      let(:overrides) do
+        {
+          "index_pages" => {
+            "archive" => {
+              "permalink" => "/custom/:label/"
+            }
+          }
+        }
+      end
+
+      describe "ArchiveURL.render" do
+        it "returns a valid archive page URL" do
+          expect(template.render!(payload, info)).to eq("\n/custom/1966/\n")
+        end
+      end
+    end
+  end
+end

data/spec/archive_spec.rb

@@ -14,35 +14,17 @@ describe(JekyllIndexPages::Archive) do
     site.process
   end
 
-  context("When no configuration is provided") do
-    describe("Archive.generate") do
-      it("skips archive generation") do
-        expect(site.data["archive"]).to be_nil
-      end
+  describe("Archive.generate") do
+    it("generates a five year post archive") do
+      expect(site.data["archive"].length).to eq(5)
     end
-  end
-
-  context("When default configuration for archive index pages is provided") do
-    let(:overrides) do
-      {
-        "index_pages" => {
-          "archive" => {}
-        }
-      }
-    end
-
-    describe("Archive.generate") do
-      it("generates a five year post archive") do
-        expect(site.data["archive"].length).to eq(5)
-      end
 
-      it("generates a post listing page per year") do
-        expect(site.data["archive"]["1966"].length).to be > 0
-        expect(site.data["archive"]["1987"].length).to be > 0
-        expect(site.data["archive"]["1993"].length).to be > 0
-        expect(site.data["archive"]["1995"].length).to be > 0
-        expect(site.data["archive"]["2001"].length).to be > 0
-      end
+    it("generates a post listing page per year") do
+      expect(site.data["archive"]["1966"].length).to be > 0
+      expect(site.data["archive"]["1987"].length).to be > 0
+      expect(site.data["archive"]["1993"].length).to be > 0
+      expect(site.data["archive"]["1995"].length).to be > 0
+      expect(site.data["archive"]["2001"].length).to be > 0
     end
   end
 end

data/spec/author-url_spec.rb

@@ -0,0 +1,120 @@
+require "spec_helper"
+
+describe JekyllIndexPages::AuthorURL 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("{% author_url %}") }
+
+    describe "AuthorURL.render" do
+      it "raises ArgumentError" do
+        expect { template.render!(payload, info) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  context "When a valid author name is provided" do
+    let(:template) do
+      Liquid::Template.parse("{% author_url \"James T Kirk\" %}")
+    end
+
+    describe "AuthorURL.render" do
+      it "returns a valid author page URL" do
+        expect(template.render!(payload, info)).to eq("/james-t-kirk/")
+      end
+    end
+
+    context "and a custom author permalink is provided" do
+      let(:overrides) do
+        {
+          "index_pages" => {
+            "authors" => {
+              "permalink" => "/custom/:label/"
+            }
+          }
+        }
+      end
+
+      describe "AuthorURL.render" do
+        it "returns a valid author page URL" do
+          expect(template.render!(payload, info)).to eq("/custom/james-t-kirk/")
+        end
+      end
+    end
+  end
+
+  context "When valid author names are provided as a variable" do
+    let(:template) do
+      Liquid::Template.parse <<-eos
+{% for author in site.data.authors %}
+{% author_url author[0] %}
+{% endfor %}
+eos
+    end
+
+    describe "AuthorURL.render" do
+      it "returns valid author page URLs" do
+        expect(template.render!(payload, info)).to eq <<-eos
+
+/james-t-kirk/
+
+/jean-luc-picard/
+
+/benjamin-sisko/
+
+/kathryn-janeway/
+
+/jonathan-archer/
+
+eos
+      end
+    end
+
+    context "and a custom author permalink is provided" do
+      let(:overrides) do
+        {
+          "index_pages" => {
+            "authors" => {
+              "permalink" => "/custom/:label/"
+            }
+          }
+        }
+      end
+
+      describe "AuthorURL.render" do
+        it "returns valid author page URLs" do
+          expect(template.render!(payload, info)).to eq <<-eos
+
+/custom/james-t-kirk/
+
+/custom/jean-luc-picard/
+
+/custom/benjamin-sisko/
+
+/custom/kathryn-janeway/
+
+/custom/jonathan-archer/
+
+eos
+        end
+      end
+    end
+  end
+end

data/spec/author_spec.rb

@@ -14,35 +14,17 @@ describe(JekyllIndexPages::Author) do
     site.process
   end
 
-  context("When no configuration is provided") do
-    describe("Author.generate") do
-      it("skips author index page generation") do
-        expect(site.data["author"]).to be_nil
-      end
+  describe("Author.generate") do
+    it("generates five author index pages") do
+      expect(site.data["authors"].length).to eq(5)
     end
-  end
-
-  context("When default configuration is provided") do
-    let(:overrides) do
-      {
-        "index_pages" => {
-          "authors" => {}
-        }
-      }
-    end
-
-    describe("Author.generate") do
-      it("generates five author index pages") do
-        expect(site.data["authors"].length).to eq(5)
-      end
 
-      it("generates a post listing page per author") do
-        expect(site.data["authors"]["James T Kirk"].length).to be > 0
-        expect(site.data["authors"]["Jean-Luc Picard"].length).to be > 0
-        expect(site.data["authors"]["Benjamin Sisko"].length).to be > 0
-        expect(site.data["authors"]["Kathryn Janeway"].length).to be > 0
-        expect(site.data["authors"]["Jonathan Archer"].length).to be > 0
-      end
+    it("generates a post listing page per author") do
+      expect(site.data["authors"]["James T Kirk"].length).to be > 0
+      expect(site.data["authors"]["Jean-Luc Picard"].length).to be > 0
+      expect(site.data["authors"]["Benjamin Sisko"].length).to be > 0
+      expect(site.data["authors"]["Kathryn Janeway"].length).to be > 0
+      expect(site.data["authors"]["Jonathan Archer"].length).to be > 0
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-index-pages
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Jose Miguel Venegas Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -105,12 +105,17 @@ 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.rb
+- lib/jekyll-index-pages/tags/archive-url.rb
+- lib/jekyll-index-pages/tags/author-url.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-url_spec.rb
 - spec/archive_spec.rb
+- spec/author-url_spec.rb
 - spec/author_spec.rb
 - spec/category-url_spec.rb
 - spec/collection_spec.rb
@@ -163,7 +168,9 @@ signing_key:
 specification_version: 4
 summary: Index page generator for Jekyll sites.
 test_files:
+- spec/archive-url_spec.rb
 - spec/archive_spec.rb
+- spec/author-url_spec.rb
 - spec/author_spec.rb
 - spec/category-url_spec.rb
 - spec/collection_spec.rb