html-pipeline-wiki-link 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.0.4
+
+* Add handling for special characters and leading or trailing whitespace.
+* Add tests for base URL settings.
+* Fix bug with multiple links in succession.
+
 ## 0.0.3
 
 * Fixed erroneous gem description.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    html-pipeline-wiki-link (0.0.3)
+    html-pipeline-wiki-link (0.0.4)
       html-pipeline (>= 0.0.8)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     activesupport (3.2.12)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    escape_utils (0.3.1)
+    escape_utils (0.3.2)
     gemoji (1.4.0)
     github-markdown (0.5.3)
     html-pipeline (0.0.8)

data/README.md

@@ -35,7 +35,7 @@ filter = HTML::Pipeline::WikiLinkFilter.new('Some text with a [[Link]] in it.')
 filter.call
 ```
 
-Filters can be combined into a pipeline which causes each filter to hand its output to the next filter's input.  For example, you could support wiki links in markdown by creating a pipeline like this:
+Filters can be combined into a pipeline which causes each filter to hand its output to the next filter's input.  For example, you could support wiki links in Markdown by creating a pipeline like this:
 
 ```ruby
 pipeline = HTML::Pipeline.new [
@@ -48,13 +48,18 @@ This is some **Markdown** with a [[Link]] in it!
 CODE
 ```
 
+The wiki link filter supports the standard link types:
+
+* `[[Link]]`
+* `[[Link|Description]]`
+
 <!--
 ## Troubleshooting
 -->
 
 ## Development
 
-To see what has changed in recent versions of Lifted Wiki, see the [CHANGELOG](CHANGELOG.md).
+To see what has changed in recent versions of the wiki link gem, see the [CHANGELOG](CHANGELOG.md).
 
 ## Core Team Members
 
@@ -66,11 +71,11 @@ To see what has changed in recent versions of Lifted Wiki, see the [CHANGELOG](C
 
 <!-- ### Other questions
 
-Feel free to chat with the Lifted Wiki core team (and many other users) on IRC in the  [#project](irc://irc.freenode.net/project) channel on Freenode, or via email on the [Project mailing list]().
+Feel free to chat with the wiki link gem core team (and many other users) on IRC in the  [#project](irc://irc.freenode.net/project) channel on Freenode, or via email on the [Project mailing list]().
  -->
 
 ## Copyright
 
 Copyright © 2013 Lee Dohm, Lifted Studios. See [LICENSE](LICENSE.md) for details.
 
-Project is a member of the [OSS Manifesto](http://ossmanifesto.com/).
+Project is a member of the [OSS Manifesto](http://ossmanifesto.org/).

data/Rakefile

@@ -38,10 +38,12 @@ Rake::TestTask.new('spec') do |spec|
   # spec.warning = true
 end
 
-YARD::Rake::YardocTask.new
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--markup', 'markdown', '--files', 'CHANGELOG.md,CONTRIBUTING.md,LICENSE.md']
+end
 
 desc 'Build gem'
-task :build do
+task :build => :default do
   sh "mkdir -p pkg"
   sh "gem build #{gemspec_file}"
   sh "mv #{gem_file} pkg"

data/html-pipeline-wiki-link.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('minitest', '~> 3.0')
   s.add_development_dependency('rake', '~> 10.0')
-  s.add_development_dependency('redcarpet')
-  s.add_development_dependency('yard', '~> 0.8')
+  s.add_development_dependency('redcarpet')           # For Markdown formatting of YARD documentation
+  s.add_development_dependency('yard', '~> 0.8')      # For documentation
 
   s.files = `git ls-files`.
     split("\n").

data/lib/html/pipeline/wiki_link/version.rb

@@ -6,7 +6,7 @@ module HTML
   class Pipeline
     module WikiLink
       # Version number for the Lifted Wiki gem.
-      VERSION = '0.0.3'
+      VERSION = '0.0.4'
     end
   end
 end

data/lib/html/pipeline/wiki_link/wiki_link_filter.rb

@@ -3,6 +3,7 @@
 # 
 
 require 'html/pipeline'
+require 'open-uri'
 
 module HTML
   class Pipeline
@@ -23,39 +24,40 @@ module HTML
           @base_url = context[:base_url] if context[:base_url]
           @space_replacement = context[:space_replacement] if context[:space_replacement]
         end
+
+        unless @base_url.empty? || @base_url =~ /\/$/
+          @base_url += '/'
+        end
       end
 
       # Performs the translation and returns the updated text.
       # 
       # @return [String] Updated text with translated wiki links.
       def call
-        html.gsub(/\[\[([^|]*)(\|(.*))?\]\]/) do
+        html.gsub(/\[\[([^\]|]*)(\|([^\]]*))?\]\]/) do
           link = $1
           desc = $3 ? $3 : $1
 
-          link = convert_whitespace(link)
-          desc = collapse_whitespace(desc)
-
-          "<a href=\"#{@base_url}#{link}\">#{desc}</a>"
+          "<a href=\"#{to_link link}\">#{to_description desc}</a>"
         end
       end
 
       private
 
-      # Collapses multiple whitespace characters into a single space.
+      # Converts the given text into an appropriate link description.
       # 
-      # @param text Text within which to collapse whitespace.
-      # @return Text with collapsed whitespace.
-      def collapse_whitespace(text)
-        text.gsub(/\s+/, ' ')
+      # @param text Proposed description text.
+      # @return Updated text for use as a link description.
+      def to_description(text)
+        text.strip.gsub(/\s+/, ' ')
       end
 
-      # Converts spaces to underscores in the given text.
+      # Converts the given text into an appropriate link.
       # 
-      # @param text Text within which to replace spaces.
-      # @return Text with spaces replaced with underscores.
-      def convert_whitespace(text)
-        text.gsub(/\s+/, @space_replacement)
+      # @param text Proposed link text.
+      # @return Updated text to use as a link.
+      def to_link(text)
+        URI::encode(@base_url + text.strip.gsub(/\s+/, @space_replacement))
       end
     end
   end

data/spec/wiki_link_filter_spec.rb

@@ -81,4 +81,76 @@ describe HTML::Pipeline::WikiLinkFilter do
 
     text.must_equal '<a href="/A*Link*With*Spaces">A Link With Spaces</a>'
   end
-end
+
+  it 'must urlencode special characters in the link but not in the description' do
+    filter = new_filter('[[{}\]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/%7B%7D%5C">{}\</a>'
+  end
+
+  it 'must strip whitespace from the ends of a link' do
+    filter = new_filter('[[   Link   ]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Link">Link</a>'
+  end
+
+  it 'must strip whitespace from the ends of a description' do
+    filter = new_filter('[[Link|   Description   ]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Link">Description</a>'
+  end
+
+  it 'prepends the link with another string when given a :base_url parameter' do
+    filter = new_filter('[[Link]]', :base_url => '/foo/bar/')
+
+    text = filter.call
+
+    text.must_equal '<a href="/foo/bar/Link">Link</a>'
+  end
+
+  it 'properly joins the base_url with the link' do
+    filter = new_filter('[[Link]]', :base_url => 'foo/bar')
+
+    text = filter.call
+
+    text.must_equal '<a href="foo/bar/Link">Link</a>'
+  end
+
+  it 'replaces with underscores when nil is given as a space replacement' do
+    filter = new_filter('[[A Link With Spaces]]', :space_replacement => nil)
+
+    text = filter.call
+
+    text.must_equal '<a href="/A_Link_With_Spaces">A Link With Spaces</a>'
+  end
+
+  it 'uses a single forward slash when nil is given as a base URL' do
+    filter = new_filter('[[Link]]', :base_url => nil)
+
+    text = filter.call
+
+    text.must_equal '<a href="/Link">Link</a>'
+  end
+
+  it 'converts two links on the same line into two links, not one big one with brackets inside' do
+    filter = new_filter('[[Link One]] and [[Link Two]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Link_One">Link One</a> and <a href="/Link_Two">Link Two</a>'
+  end
+
+  it 'converts two links with descriptions into two links' do
+    filter = new_filter('[[Link|Link One]] and [[Link|Link Two]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Link">Link One</a> and <a href="/Link">Link Two</a>'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline-wiki-link
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 2
 summary: An HTML::Pipeline filter for WikiMedia-style wiki links.