Merge asset_path and page_asset_path together

Merged new page_asset_path to original asset_path as per samrayner's
comments. Also update readme and add a test site that checks that old
and new functionality works.

Author: oturpe

.gitignore

@@ -0,0 +1 @@
+test_site/_site

README.md

@@ -5,8 +5,11 @@ Jekyll Asset Path Tag
 
 A liquid tag to output a relative URL for assets based on the post or page, allowing you to organise your assets into subdirectories.
 
-Syntax: `{% asset_path [filename] %}`
-`{% page_asset_path [page_id] [filename] %}`
+Syntax:
+```
+{% asset_path filename [post_id] %}
+{% asset_path "filename with whitespace" [post_id] %}
+```
 
 ##Installation
 Copy asset_path_tag.rb into */_plugins* ([Jekyll][j]) or */plugins* ([Octopress][o])
@@ -26,7 +29,7 @@ in page my-first-page would output:
 ```
 
 ```
-{% page_asset_path /2012/05/25/another-post-title document.pdf %}
+{% asset_path document.pdf /2012/05/25/another-post-title %}
 ```
 would output:
 ```
@@ -57,14 +60,14 @@ then the tag will output:
 /assets/posts/another-post-title/image_two.png
 ```
 
-Tag `page-asset-path` is useful for showing asset from each page. Given the site contains pages:
+When used with `post_id` parameter, the tag is useful for showing asset from each page. Given the site contains pages:
 ```
 post-title
 another-post-title
 ```
 then
 ```
-{% for post in site.posts %}{% page_asset_path {{post.id}} cover.jpg %}{% endfor %} on index.html
+{% for post in site.posts %}{% asset_path cover.jpg {{post.id}} %}{% endfor %} on index.html
 ```
 will output:
 ```
@@ -74,3 +77,12 @@ will output:
 
 [j]: http://jekyllrb.com/
 [o]: http://octopress.org/
+
+##Testing
+The plugin can be tested by using the Jekyll test site in `test_site` directory. Generate the site with
+```
+bundle exec jekyll serve
+```
+then check the test results by browsing to [http://localhost:4000][test_site].
+
+[test_site]: http://localhost:4000

asset_path_tag.rb

@@ -1,20 +1,25 @@
 # Title: Asset path tag for Jekyll
-# Author: Sam Rayner http://samrayner.com
+# Authors:
+#     Sam Rayner http://samrayner.com
+#     Otto Urpelainen http://koti.kapsi.fi/oturpe/projects/
+#
 # Description: Output a relative URL for assets based on the post or page
 #
 # Syntax
-#    {% asset_path [filename] %}
-#    {% page_asset_path [page_id] [filename] %}
+#    {% asset_path filename [post_id] %}
+#    {% asset_path "filename with whitespace" [post_id] %}
 #
 # Examples:
 # {% asset_path kitten.png %} on post 2013-01-01-post-title
 # {% asset_path pirate.mov %} on page page-title
-# {% page_asset_path /2012/05/25/another-post-title document.pdf %}
+# {% asset_path document.pdf /2012/05/25/another-post-title %}
+# {% asset_path "document with long name.pdf" /2012/05/25/another-post-title %}
 #
 # Output:
 # /assets/posts/post-title/kitten.png
 # /assets/page-title/pirate.mov
 # /assets/posts/another-post-title/document.pdf
+# /assets/posts/another-post-title/document with long name.pdf
 #
 # Looping example using a variable for the pathname:
 #
@@ -35,7 +40,7 @@
 #   post-title
 #   another-post-title
 #
-# {% for post in site.posts %}{% page_asset_path {{post.id}} cover.jpg %}{% endfor %} on index.html
+# {% for post in site.posts %}{% asset_path cover.jpg {{post.id}} %}{% endfor %} on index.html
 #
 # Output:
 # /assets/posts/post-title/cover.jpg
@@ -75,21 +80,30 @@ def initialize(tag_name, markup, tokens)
 
     def render(context)
       if @markup.empty?
-        return "Error processing input, expected syntax: {% asset_path [filename] %}"
+        return "Error processing input, expected syntax: {% asset_path filename [post id] %}"
       end
 
       #render the markup
-      rawFilename = Liquid::Template.parse(@markup).render context
-
-      #strip leading and trailing quotes
-      filename = rawFilename.gsub(/^("|')|("|')$/, '')
+      parameters = Liquid::Template.parse(@markup).render context
+      parameters.strip!
+
+      if ['"', "'"].include? parameters[0] 
+        # Quoted filename, possibly followed by post id
+        last_quote_index = parameters.rindex(parameters[0])
+        filename = parameters[1 ... last_quote_index]
+        post_id = parameters[(last_quote_index + 1) .. -1].strip
+      else
+        # Unquoted filename, possibly followed by post id
+        filename, post_id = parameters.split(/\s+/)
+      end
 
       page = context.environments.first["page"]
 
-      #if a post
-      if page["id"]
+      post_id = page["id"] if post_id == nil or post_id.empty?
+      if post_id
+        #if a post
         posts = context.registers[:site].posts
-        path = Jekyll.get_post_path(page["id"], posts)
+        path = Jekyll.get_post_path(post_id, posts)
       else
         path = page["url"]
       end
@@ -101,38 +115,6 @@ def render(context)
       "#{context.registers[:site].config['baseurl']}/assets/#{path}/#{filename}".gsub(/\/{2,}/, '/')
     end
   end
-
-  class PageAssetPathTag < Liquid::Tag
-    @markup = nil
-
-    def initialize(tag_name, markup, tokens)
-      #strip leading and trailing spaces
-      @markup = markup.strip
-      super
-    end
-
-    def render(context)
-      if @markup.empty?
-        return "Error processing input, expected syntax: {% page_asset_path [page_id] [filename] %}"
-      end
-
-      # render the page markup
-      parsed = Liquid::Template.parse(@markup).render context
-      id, filename = parsed.split(' ', 2).each do |param|
-        unquoted = param.gsub(/^("|')|("|')$/, '')
-        unquoted.strip
-      end
-    
-      posts = context.registers[:site].posts
-      path = Jekyll.get_post_path(id, posts)
-      path = File.dirname(path) if path =~ /\.\w+$/
-
-      root = context.registers[:site].config['baseurl']
-      #fix double slashes
-      "#{root}/assets/#{path}/#{filename}".gsub(/\/{2,}/, '/')
-    end
-  end
 end
 
 Liquid::Template.register_tag('asset_path', Jekyll::AssetPathTag)
-Liquid::Template.register_tag('page_asset_path', Jekyll::PageAssetPathTag)

test_site/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'jekyll', '3.1.2'
+gem 'json'
+gem 'stringex'
+gem 'rmagick', '~>2.16.0'

test_site/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorator (0.1)
+    ffi (1.9.14)
+    jekyll (3.1.2)
+      colorator (~> 0.1)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.4.0)
+      sass (~> 3.4)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    json (1.8.3)
+    kramdown (1.11.1)
+    liquid (3.0.6)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    mercenary (0.3.6)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rmagick (2.16.0)
+    rouge (1.11.1)
+    safe_yaml (1.0.4)
+    sass (3.4.22)
+    stringex (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (= 3.1.2)
+  json
+  rmagick (~> 2.16.0)
+  stringex
+
+BUNDLED WITH
+   1.12.5

test_site/_config.yml

@@ -0,0 +1,24 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing these this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: jekyll-asset-path-plugin test site
+email: [email protected]
+description: > # this means to ignore newlines until "baseurl:"
+  Test site for jekyll-asset-path-plugin
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "http://example.com" # the base hostname & protocol for your site
+
+# Build settings
+markdown: kramdown

test_site/_plugins/asset_path_tag.rb

@@ -0,0 +1 @@
+../../asset_path_tag.rb

test_site/_posts/2000-01-02-Another_page.markdown

@@ -0,0 +1,5 @@
+---
+title:  "Another page"
+date:   2000-01-02 10:50:12 +0200
+---
+Another page to reference to.

test_site/_posts/2017-01-14-tests.markdown

@@ -0,0 +1,41 @@
+---
+title:  "jekyll-thumbnail-generator tests"
+date:   2017-01-14 10:50:12 +0200
+---
+Page tests.
+
+## This page
+
+### Unquoted: this-page.png
+![Failure]({% asset_path this-page.png %})
+
+### Double quotes: "this-page.png"
+![Failure]({% asset_path "this-page.png" %})
+
+### Single quotes: 'this-page.png'
+![Failure]({% asset_path 'this-page.png' %})
+
+### Quoted with spaces: "this page with space.png"
+![Failure]({% asset_path "this page with space.png" %})
+
+### Single quotes with spaces: 'this page with space.png'
+![Failure]({% asset_path 'this page with space.png' %})
+
+## Other page
+
+### Unquoted: another-page.png /2000/01/02/Another_page
+![Failure]({% asset_path another-page.png /2000/01/02/Another_page %})
+
+### Double quotes: "another-page.png" /2000/01/02/Another_page
+![Failure]({% asset_path "another-page.png" /2000/01/02/Another_page %})
+
+### Single quotes: 'another-page.png' /2000/01/02/Another_page
+![Failure]({% asset_path 'another-page.png' /2000/01/02/Another_page %})
+
+### Double quotes with space: "another page with space.png" /2000/01/02/Another_page
+![Failure]({% asset_path "another page with space.png" /2000/01/02/Another_page %})
+
+### Single quotes with space: 'another page with space.png' /2000/01/02/Another_page
+![Failure]({% asset_path 'another page with space.png' /2000/01/02/Another_page %})
+
+<!-- TODO: More cases needed? -->

test_site/assets/error.png

@@ -0,0 +1,15 @@
+---
+---
+
+<div class="home">
+
+  <h1>jekyll-asset-path-plugin tests</h1>
+  This is a test page for
+  <a href="https://github.com/samrayner/jekyll-asset-path-plugin">jekyll-asset-path-plugin</a>.
+  On each of the following pages, there is a set of test cases listed. A successful test shows a green
+  cicle. A failed test shows <i>Failure</i>.
+  <p>
+  <a href="nonpost_tests/index.html">Non-post tests</a>
+  <p>
+  <a href="2017/01/14/tests.html">Post tests</a>
+</div>

test_site/assets/nonpost_tests/nonpost with space.png

@@ -0,0 +1,22 @@
+---
+title:  "jekyll-thumbnail-generator non-post tests"
+permalink: /nonpost_tests/
+---
+Nonpost tests
+
+## This page
+
+### Unquoted: nonpost.png
+![Failure]({% asset_path nonpost.png %})
+
+### Double quotes: "nonpost.png"
+![Failure]({% asset_path "nonpost.png" %})
+
+### Single quotes: 'nonpost.png'
+![Failure]({% asset_path 'nonpost.png' %})
+
+### Quoted with spaces: "nonpost with space.png"
+![Failure]({% asset_path "nonpost with space.png" %})
+
+### Single quotes with spaces: 'nonpost with space.png'
+![Failure]({% asset_path 'nonpost with space.png' %})