Removed unnecessary method aliases. Added tests.

vendor/plugins/wiki_engine/lib/wiki_engine.rb

@@ -11,9 +11,8 @@ class << self
     # Returns an array of system available WIKI engines
     # eg. ['retro', 'rdoc', 'textile', 'markdown']
     def supported_engine_names
-      supported_engines.map { |(k, v)| v ? k : nil }.compact
+      supported_engines.map {|k, v| v ? k : nil }.compact
     end
-    alias_method :available_engine_names, :supported_engine_names
 
     # Returns the HTML formatted markup
     def markup(text, engine = nil)
@@ -24,7 +23,7 @@ def markup(text, engine = nil)
     # This method can be called in environment.rb to override the default engine
     def default_engine=(engine)
       engine = engine.to_s
-      if !self.supported_engines.include?(engine)
+      if !supported_engines.include?(engine)
         raise "The selected WIKI engine '#{engine}' is invalid! Supported engines: #{supported_engines.keys.inspect}"
       elsif supported_engines[engine]
         @@default_engine = supported_engines[engine]
@@ -33,16 +32,14 @@ def default_engine=(engine)
       else
         raise "The selected WIKI default engine '#{engine}' is missing! " + 
               "Please install required GEM or library or switch to another engine. " + 
-              "Available engines: #{available_engine_names.inspect}" 
+              "Supported engines: #{supported_engine_names.inspect}" 
       end
     end
-    alias_method :default_markup=, :default_engine=
 
     # Returns the default engine
     def default_engine
       @@default_engine ? @@default_engine : supported_engines['retro']
     end
-    alias_method :default_markup, :default_engine
 
     # Initializes the WikiEngine. Looks for available libraries. A default engine can be specified.
     def init(default = :retro)

vendor/plugins/wiki_engine/test/helper.rb

@@ -0,0 +1,6 @@
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../init'
+require 'wiki_engine/retro'

vendor/plugins/wiki_engine/test/wiki_engine/retro_test.rb

@@ -0,0 +1,333 @@
+# encoding:utf-8
+require File.dirname(__FILE__) + '/../helper' 
+
+class WikiEngineRetroTest < Test::Unit::TestCase
+
+
+  def test_basic
+    text = %Q(h2. Lorem ipsum
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut pulvinar mauris sed lorem.
+Phasellus non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra. 
+
+Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
+Nunc sem lectus, consectetuer a, volutpat eu, pretium ac, nisl. Sed vitae augue.
+Sed sit amet velit. Integer lobortis magna. Cras odio.)
+
+    html = "<h2>Lorem ipsum</h2>
+<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut pulvinar mauris sed lorem.
+Phasellus non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra.</p>
+<p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
+Nunc sem lectus, consectetuer a, volutpat eu, pretium ac, nisl. Sed vitae augue.
+Sed sit amet velit. Integer lobortis magna. Cras odio.</p>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)      
+  end
+
+  def test_advanced
+    text = %Q(h2. Lorem ipsum
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut pulvinar mauris sed lorem.
+
+* One
+* Two 
+
+Cum +sociis+ natoque *penatibus* et magnis _dis_ parturient montes.)
+
+    html = "<h2>Lorem ipsum</h2>
+<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut pulvinar mauris sed lorem.</p>
+<ul>
+\t<li>One</li>
+\t<li>Two</li>
+</ul>
+<p>Cum <ins>sociis</ins> natoque <strong>penatibus</strong> et magnis <em>dis</em> parturient montes.</p>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)      
+  end
+
+
+
+  def test_html_code_removal
+    text = %Q(Lorem ipsum dolor
+  <script> 
+    this.location.href = "http://www.myspampage.com"
+  </script> 
+sit amet, <span style="color:red;">consectetuer</span> adipiscing elit. <br/>
+Ut pulvinar <frame>mauris</frame> sed <iframe>lorem</iframe>.)
+
+    html = %Q(<p>Lorem ipsum dolor</p>
+this.location.href = &#8220;http://www.myspampage.com&#8221;
+
+<p>sit amet, consectetuer adipiscing elit. <br/>
+Ut pulvinar mauris sed lorem.</p>)
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)  
+  end
+
+
+
+  def test_code_parts
+    text = %Q(Lorem ipsum dolor sit amet. 
+{{{
+consectetuer adipiscing elit. Ut pulvinar mauris sed lorem.
+}}}
+Phasellus non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra. 
+
+Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
+{{{Nunc sem lectus, consectetuer a, volutpat eu, pretium ac, nisl. Sed vitae augue.}}}
+Sed sit amet velit. Integer lobortis magna. Cras odio.)
+
+    html = "<p>Lorem ipsum dolor sit amet.</p>
+<pre><code>consectetuer adipiscing elit. Ut pulvinar mauris sed lorem.</code></pre>
+<p>Phasellus non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra.</p>
+<p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.</p>
+<pre><code>Nunc sem lectus, consectetuer a, volutpat eu, pretium ac, nisl. Sed vitae augue.</code></pre>
+<p>Sed sit amet velit. Integer lobortis magna. Cras odio.</p>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+  def test_spacing_in_code_parts
+    text = %Q(Some introduction:
+
+{{{
+ruby script/server -e production
+}}}
+)
+    html = "<p>Some introduction:</p>
+<pre><code>ruby script/server -e production</code></pre>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+  def test_correct_whitespaces_in_code_parts
+    text = %Q(Some introduction {{{  
+ Baud Rate: 9600
+Parity Bit: even
+    }}}
+)
+    html = "<p>Some introduction</p>
+<pre><code> Baud Rate: 9600\nParity Bit: even</code></pre>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+  def test_inline_code_parts
+    text = %Q(Some introduction and then {{{    
+inline:
+  code
+}}}
+)
+    html = "<p>Some introduction and then</p>
+<pre><code>inline:
+  code</code></pre>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+  def test_code_parts_only
+    text = %Q({{{
+inline:
+  code
+}}})
+    html = "<pre><code>inline:
+  code
+</code></pre>"
+
+    markup = WikiEngine.markup(text, 'retro')
+    assert_equal(html, markup)    
+  end
+
+
+  def test_code_escaping
+    text = %Q(Intro:
+{{{
+<html>
+
+<head>
+  <script>
+    // Evil Code
+  </script>
+</head>
+
+<body></body>
+
+</html>
+}}}
+)
+
+    html = "<p>Intro:</p>
+<pre><code>&lt;html&gt;
+
+&lt;head&gt;
+  &lt;script&gt;
+    // Evil Code
+  &lt;/script&gt;
+&lt;/head&gt;
+
+&lt;body&gt;&lt;/body&gt;
+
+&lt;/html&gt;</code></pre>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+
+  def test_backslashes_in_code
+    text = %Q(Intro.
+
+{{{
+The \\'foo bar\\'.
+}}}
+
+Break!
+
+{{{
+The \'foo bar\'.
+}}}
+
+The @\'@ characters seem to be the problem.    
+)
+    html = "<p>Intro.</p>
+<pre><code>The \\'foo bar\\'.</code></pre>
+<p>Break!</p>
+<pre><code>The 'foo bar'.</code></pre>
+<p>The <code>'</code> characters seem to be the problem.</p>"
+
+    markup = WikiEngine.markup(text, 'retro')
+    assert_equal(html, markup)    
+  end
+
+
+  def test_br_handling
+    text='Lorem ipsum[[BR]]dolor sit amet.'
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal('<p>Lorem ipsum<br />dolor sit amet.</p>', markup)
+  end
+
+
+
+  def test_object_itself_remains_unchanged
+    text = 'Lorem ipsum<br/>dolor � sit amet.'
+    original = text.dup
+    WikiEngine.markup(text, 'retro')
+    assert_equal(original, text)
+  end
+
+  def test_media_wiki_headers
+    text = 'h2. Lorem ipsum
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut pulvinar mauris sed lorem. 
+Phasellus non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra.
+
+=== Cum sociis natoque ===
+Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. 
+Nunc sem lectus, consectetuer a, volutpat eu, pretium ac, nisl. Sed vitae augue. 
+Sed sit amet velit. Integer lobortis magna. Cras odio.'
+
+    html = "<h2>Lorem ipsum</h2>
+<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut pulvinar mauris sed lorem. 
+Phasellus non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra.</p>
+<h3>Cum sociis natoque</h3>
+<p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. 
+Nunc sem lectus, consectetuer a, volutpat eu, pretium ac, nisl. Sed vitae augue. 
+Sed sit amet velit. Integer lobortis magna. Cras odio.</p>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)      
+  end
+
+  def test_wiki_links
+    text = 'Lorem ipsum dolor sit amet. 
+
+Phasellus non [[dolor]]. Vestibulum sodales fringilla eros. Pellentesque viverra. 
+'
+    html = "<p>Lorem ipsum dolor sit amet.</p>
+<p>Phasellus non [[dolor]]. Vestibulum sodales fringilla eros. Pellentesque viverra.</p>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+
+  def test_wiki_links_at_beginning
+    text = 'Lorem ipsum dolor sit amet. 
+
+[[Phasellus]] non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra. 
+'
+    html = "<p>Lorem ipsum dolor sit amet.</p>
+<p>[[Phasellus]] non dolor. Vestibulum sodales fringilla eros. Pellentesque viverra.</p>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+
+  def test_wiki_refs
+    text = 'I am crazy about "Retrospectiva":retrospectiva
+    
+[retrospectiva]http://retrospectiva.org       
+'
+    html = "<p>I am crazy about <a href=\"http://retrospectiva.org\">Retrospectiva</a></p>\n"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+
+  def test_security
+    text = "
+p>. Right aligned line\n
+p<(((. Left aligned and indented line\n
+p<(). IF A < B THEN B > A\n
+<font size=\"100\">Test</font>\n
+<font size=100>Test</font>\n
+<font size='100'>Test</font>\n
+<font>Test</font>\n
+p<<iframe src=http://ha.ckers.org/scriptlet.html(. A nasty hack?\n
+<iframe src=http://ha.ckers.org/scriptlet.html <\n
+"
+
+    html = "<p style=\"text-align:right;\">Right aligned line</p>
+<p style=\"padding-left:3em;text-align:left;\">Left aligned and indented line</p>
+<p style=\"padding-left:1em;padding-right:1em;text-align:left;\">IF A &lt; B THEN B &gt; A</p>
+<p>Test</p>
+<p>Test</p>
+<p>Test</p>
+<p>Test</p>
+<p>p&lt;&lt;iframe src=http://ha.ckers.org/scriptlet.html(. A nasty hack?</p>
+<p>&lt;iframe src=http://ha.ckers.org/scriptlet.html &lt;</p>"
+
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+  def test_correct_html_escaping
+    text = "p>. Right \"aligned\" line\n"
+    html = "<p style=\"text-align:right;\">Right &#8220;aligned&#8221; line</p>"
+    markup = WikiEngine.markup(text, 'retro')    
+    assert_equal(html, markup)
+  end
+
+
+  def test_extracting_text_parts
+    original = "<p>Extract me</p><pre>Ignore me</pre><p class=\"ignore-me\">Extract me too</p>"
+    source   = original.dup
+
+    result   = WikiEngine.with_text_parts_only(source) do |match|
+      match.gsub(/me/, 'ME')
+    end
+
+    assert_equal("<p>Extract ME</p><pre>Ignore me</pre><p class=\"ignore-me\">Extract ME too</p>", result)
+    assert_equal(original, source)
+  end
+
+end