jekyll-index-pages 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434e6a42ab53e8200e65e037b6984b6693eb05bc
-  data.tar.gz: c022b58acba4625785ca9a81d20e8fa67add484f
+  metadata.gz: 68ae1f6ad9f04cc3f99ec1d3ca767b7568c1c9b4
+  data.tar.gz: 56022368b8e991fe1442f9b55a2bdd70fbafca57
 SHA512:
-  metadata.gz: d44e8f13335e1274a05a8333a153e2e07a878e5cbb926f67c9782e2518280f451b3a50294929f27dd1bdfc38e9c2b5fba3ef7b7a800a17e892d5fe770be039de
-  data.tar.gz: d612fc1f00c25007a98a4116da3ffa9f4f50e20136097260dfbe7aeb3e7bc87e8e0c610067db0ee1b1abc33a808bfc7d4037f5c69840088d4ad2523e418eaf6d
+  metadata.gz: 059ea292f70bbac59ad7793289eebabab3aedf032df1364790b9f51a38ccbe43a0d71ffb4bb06502c6565110a4243d71c856a90af676e463fff3a1f6bc66e8db
+  data.tar.gz: 8338182a3c61dfa12805e9fe07864974aadc67f2dc0a8e103ee5b0e249b548165ce3729eb08d543d53429ab84f3d39a6d0c07c02fc04a64896e76311eeeb7132

data/README.md

@@ -175,8 +175,13 @@ 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.
+`{% category_url %}` accepts a valid category name as an argument:
+
+```liquid
+<a href="{% category_url "Category name" %}">Category name</a>
+```
+
+Likewise, `{% tag_url %}` receives a valid tag name.
 
 The following example demonstrates how to create a basic category navigation:
 

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

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

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

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

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

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

data/spec/category-url_spec.rb

@@ -24,20 +24,20 @@ describe JekyllIndexPages::CategoryURL 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("")
+      it "raises ArgumentError" do
+        expect { template.render!(payload, info) }.to raise_error(ArgumentError)
       end
     end
   end
 
   context "When a valid category name is provided" do
     let(:template) do
-      Liquid::Template.parse("{% category_url Ciencia ficción %}")
+      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/")
+        expect(template.render!(payload, info)).to eq("/ciencia-ficcion/")
       end
     end
 
@@ -54,7 +54,39 @@ describe JekyllIndexPages::CategoryURL do
 
       describe "CategoryURL.render" do
         it "returns a valid category page URL" do
-          expect(template.render(payload, info)).to eq("/custom/ciencia-ficcion/")
+          expect(template.render!(payload, info)).to eq("/custom/ciencia-ficcion/")
+        end
+      end
+    end
+  end
+
+  context "When a valid category name is provided as a variable" do
+    let(:template) do
+      Liquid::Template.parse <<-eos
+{% for category in site.categories %}{% if forloop.last %}{% category_url category[0] %}{% endif %}{% endfor %}
+eos
+    end
+
+    describe "CategoryURL.render" do
+      it "returns a valid category page URL" do
+        expect(template.render!(payload, info)).to start_with("/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 start_with("/custom/ciencia-ficcion/")
         end
       end
     end

data/spec/tag-url_spec.rb

@@ -24,20 +24,20 @@ describe JekyllIndexPages::TagURL 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("")
+      it "raises ArgumentError" do
+        expect { template.render!(payload, info) }.to raise_error(ArgumentError)
       end
     end
   end
 
   context "When a valid tag name is provided" do
     let(:template) do
-      Liquid::Template.parse("{% tag_url ciencia-ficción %}")
+      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/")
+        expect(template.render!(payload, info)).to eq("/ciencia-ficcion/")
       end
     end
 
@@ -54,7 +54,39 @@ describe JekyllIndexPages::TagURL do
 
       describe "TagURL.render" do
         it "returns a valid tag page URL" do
-          expect(template.render(payload, info)).to eq("/custom/ciencia-ficcion/")
+          expect(template.render!(payload, info)).to eq("/custom/ciencia-ficcion/")
+        end
+      end
+    end
+  end
+
+  context "When a valid tag name is provided as a variable" do
+    let(:template) do
+      Liquid::Template.parse <<-eos
+{% for tag in site.tags %}{% if forloop.last %}{% tag_url tag[0] %}{% endif %}{% endfor %}
+eos
+    end
+
+    describe "TagURL.render" do
+      it "returns a valid tag page URL" do
+        expect(template.render!(payload, info)).to start_with("/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 start_with("/custom/ciencia-ficcion/")
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-index-pages
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jose Miguel Venegas Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n