html-pipeline-wiki-link 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.0.2
+
+* Added support for supplying a base URL.
+* Added support for replacing and collapsing spaces in wiki links.
+* Added support for replacing spaces with a configurable string.
+
 ## 0.0.1 - *Initial Version*
 
 * Built support for basic wiki links and wiki links with descriptions.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    html-pipeline-wiki-link (0.0.1)
+    html-pipeline-wiki-link (0.0.2)
       html-pipeline (>= 0.0.8)
 
 GEM

data/README.md

@@ -1,6 +1,4 @@
-[![Build Status](https://travis-ci.org/lifted-studios/html-pipeline-cite.png?branch=master)](https://travis-ci.org/lifted-studios/html-pipeline-cite)
-
-# HTML::Pipeline WikiLink Gem
+# HTML::Pipeline WikiLink Gem [![Build Status](https://travis-ci.org/lifted-studios/html-pipeline-wiki-link.png?branch=master)](https://travis-ci.org/lifted-studios/html-pipeline-wiki-link)
 
 An HTML::Pipeline filter for handling WikiMedia-style wiki links.
 
@@ -26,7 +24,7 @@ $ gem install html-pipeline-wiki-link
 
 ## Usage
 
-This library is designed as an extension of the [HTML::Pipeline]() system for creating pipelines of text conversions.  It can work on its own or in conjunction with other filters descended from `HTML::Pipeline::Filter`.
+This library is designed as an extension of the [HTML::Pipeline](https://github.com/jch/html-pipeline) system for creating pipelines of text conversions.  It can work on its own or in conjunction with other filters descended from `HTML::Pipeline::Filter`.
 
 To use this filter on its own:
 
@@ -50,17 +48,21 @@ This is some **Markdown** with a [[Link]] in it!
 CODE
 ```
 
+<!--
 ## Troubleshooting
+-->
 
 ## Development
 
-To see what has changed in recent versions of Lifted Wiki, see the [CHANGELOG](https://github.com/lifted-studios/html-pipeline-wiki-link/blob/master/CHANGELOG.md).
+To see what has changed in recent versions of Lifted Wiki, see the [CHANGELOG](CHANGELOG.md).
 
 ## Core Team Members
 
 * [Lee Dohm](https://github.com/lee-dohm/)
 
+<!--
 ## Resources
+-->
 
 <!-- ### Other questions
 
@@ -69,6 +71,6 @@ Feel free to chat with the Lifted Wiki core team (and many other users) on IRC i
 
 ## Copyright
 
-Copyright © 2013 Lee Dohm, Lifted Studios. See [LICENSE](https://github.com/lifted-studios/html-pipeline-wiki-link/blob/master/LICENSE.md) for details.
+Copyright © 2013 Lee Dohm, Lifted Studios. See [LICENSE](LICENSE.md) for details.
 
 Project is a member of the [OSS Manifesto](http://ossmanifesto.com/).

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.1'
+      VERSION = '0.0.2'
     end
   end
 end

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

@@ -8,12 +8,54 @@ module HTML
   class Pipeline
     # An `HTML::Pipeline` filter class that detects wiki-style links and converts them to HTML links.
     class WikiLinkFilter < Filter
+      # Initializes a new instance of the `WikiLinkFilter` class.
+      #
+      # @param doc     Document to filter.
+      # @param context Parameters for the filter.
+      # @param result  Results extracted from the filter.
+      def initialize(doc, context = nil, result = nil)
+        super(doc, context, result)
+
+        @base_url = '/'
+        @space_replacement = '_'
+        
+        if context
+          @base_url = context[:base_url] if context[:base_url]
+          @space_replacement = context[:space_replacement] if context[:space_replacement]
+        end
+      end
+
       # Performs the translation and returns the updated text.
       # 
       # @return [String] Updated text with translated wiki links.
       def call
-        text = html.gsub(/\[\[(.*)\|(.*)\]\]/, '<a href="/\1">\2</a>')
-        text.gsub(/\[\[(.*)\]\]/, '<a href="/\1">\1</a>')
+        html.gsub(/\[\[([^|]*)(\|(.*))?\]\]/) do
+          link = $1
+          desc = $3 ? $3 : $1
+
+          link = convert_whitespace(link)
+          desc = collapse_whitespace(desc)
+
+          "<a href=\"#{@base_url}#{link}\">#{desc}</a>"
+        end
+      end
+
+      private
+
+      # Collapses multiple whitespace characters into a single space.
+      # 
+      # @param text Text within which to collapse whitespace.
+      # @return Text with collapsed whitespace.
+      def collapse_whitespace(text)
+        text.gsub(/\s+/, ' ')
+      end
+
+      # Converts spaces to underscores in the given text.
+      # 
+      # @param text Text within which to replace spaces.
+      # @return Text with spaces replaced with underscores.
+      def convert_whitespace(text)
+        text.gsub(/\s+/, @space_replacement)
       end
     end
   end

data/spec/wiki_link_filter_spec.rb

@@ -14,9 +14,10 @@ describe HTML::Pipeline::WikiLinkFilter do
   # Creates a new `WikiLinkFilter` object.
   # 
   # @param text Text for the filter to parse.
+  # @param context Context object to pass to the constructor. 
   # @return [HTML::Pipeline::WikiLinkFilter] Newly created filter object.
-  def new_filter(text)
-    HTML::Pipeline::WikiLinkFilter.new(text)
+  def new_filter(text, context = {})
+    HTML::Pipeline::WikiLinkFilter.new(text, context)
   end
 
   it 'can be instantiated' do
@@ -40,4 +41,44 @@ describe HTML::Pipeline::WikiLinkFilter do
 
     text.must_equal '<a href="/Link">Description</a>'
   end
+
+  it 'converts a wiki link with spaces to use underscores in the href' do
+    filter = new_filter('[[A Link With Spaces]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/A_Link_With_Spaces">A Link With Spaces</a>'
+  end
+
+  it 'converts a wiki link with spaces in the link to use underscores in the href' do
+    filter = new_filter('[[A Link With Spaces|A Description With Spaces]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/A_Link_With_Spaces">A Description With Spaces</a>'    
+  end
+
+  it 'converts a link with multiple spaces into one underscore and coalesces them in the description' do
+    filter = new_filter('[[Many       Spaces]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Many_Spaces">Many Spaces</a>'    
+  end
+
+  it 'coalesces spaces in both link and description' do
+    filter = new_filter('[[Many     Spaces|Many     Spaces]]')
+
+    text = filter.call
+
+    text.must_equal '<a href="/Many_Spaces">Many Spaces</a>'
+  end
+
+  it 'replaces spaces with other characters when given a :space_replacement parameter' do
+    filter = new_filter('[[A Link With Spaces]]', :space_replacement => '*')
+
+    text = filter.call
+
+    text.must_equal '<a href="/A*Link*With*Spaces">A Link With Spaces</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.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline