wikitext 0.3 → 0.4

data/spec/img_spec.rb

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby
+# Copyright 2008 Wincent Colaiuta
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require 'wikitext'
+
+describe Wikitext::Parser, 'embedding img tags' do
+  before do
+    @parser = Wikitext::Parser.new
+  end
+
+  it 'should convert valid markup into inline image tags' do
+    @parser.parse('{{foo.png}}').should == %Q{<p><img src="/images/foo.png" alt="foo.png" /></p>\n}
+  end
+
+  it 'should appear embedded in an inline flow' do
+    @parser.parse('before {{foo.png}} after').should == %Q{<p>before <img src="/images/foo.png" alt="foo.png" /> after</p>\n}
+  end
+
+  it 'should allow images in subdirectories' do
+    @parser.parse('{{foo/bar.png}}').should == %Q{<p><img src="/images/foo/bar.png" alt="foo/bar.png" /></p>\n}
+  end
+
+  it 'should work in BLOCKQUOTE blocks' do
+    expected = dedent <<-END
+      <blockquote>
+        <p><img src="/images/foo.png" alt="foo.png" /></p>
+      </blockquote>
+    END
+    @parser.parse('> {{foo.png}}').should == expected
+  end
+
+  it 'should work in unordered lists' do
+    input = dedent <<-END
+      * {{foo.png}}
+      * {{bar.png}}
+      * {{baz.png}}
+    END
+    expected = dedent <<-END
+      <ul>
+        <li><img src="/images/foo.png" alt="foo.png" /></li>
+        <li><img src="/images/bar.png" alt="bar.png" /></li>
+        <li><img src="/images/baz.png" alt="baz.png" /></li>
+      </ul>
+    END
+    @parser.parse(input).should == expected
+  end
+
+  it 'should work in ordered lists' do
+    input = dedent <<-END
+      # {{foo.png}}
+      # {{bar.png}}
+      # {{baz.png}}
+    END
+    expected = dedent <<-END
+      <ol>
+        <li><img src="/images/foo.png" alt="foo.png" /></li>
+        <li><img src="/images/bar.png" alt="bar.png" /></li>
+        <li><img src="/images/baz.png" alt="baz.png" /></li>
+      </ol>
+    END
+    @parser.parse(input).should == expected
+  end
+
+  it 'should work in <h1> headings' do
+    @parser.parse('= {{foo.png}} =').should == %Q{<h1><img src="/images/foo.png" alt="foo.png" /></h1>\n}
+  end
+
+  it 'should work in <h2> headings' do
+    @parser.parse('== {{foo.png}} ==').should == %Q{<h2><img src="/images/foo.png" alt="foo.png" /></h2>\n}
+  end
+
+  it 'should work in <h3> headings' do
+    @parser.parse('=== {{foo.png}} ===').should == %Q{<h3><img src="/images/foo.png" alt="foo.png" /></h3>\n}
+  end
+
+  it 'should work in <h4> headings' do
+    @parser.parse('==== {{foo.png}} ====').should == %Q{<h4><img src="/images/foo.png" alt="foo.png" /></h4>\n}
+  end
+
+  it 'should work in <h5> headings' do
+    @parser.parse('===== {{foo.png}} =====').should == %Q{<h5><img src="/images/foo.png" alt="foo.png" /></h5>\n}
+  end
+
+  it 'should work in <h6> headings' do
+    @parser.parse('====== {{foo.png}} ======').should == %Q{<h6><img src="/images/foo.png" alt="foo.png" /></h6>\n}
+  end
+
+  it 'should pass single curly braces through unaltered' do
+    @parser.parse('{foo.png}').should == %Q{<p>{foo.png}</p>\n}
+  end
+
+  it 'should have no effect inside PRE blocks' do
+    @parser.parse(' {{foo.png}}').should == %Q{<pre>{{foo.png}}</pre>\n}
+  end
+
+  it 'should have no effect inside PRE_START blocks' do
+    @parser.parse('<pre>{{foo.png}}</pre>').should == %Q{<pre>{{foo.png}}</pre>\n}
+  end
+
+  it 'should have no effect inside NO_WIKI spans' do
+    @parser.parse('<nowiki>{{foo.png}}</nowiki>').should == %Q{<p>{{foo.png}}</p>\n}
+  end
+
+  it 'should be passed through in internal link targets' do
+    @parser.parse('[[{{foo.png}}]]').should == %Q{<p><a href="/wiki/%7b%7bfoo.png%7d%7d">{{foo.png}}</a></p>\n}
+  end
+
+  it 'should be passed through in internal link text' do
+    @parser.parse('[[article|{{foo.png}}]]').should == %Q{<p><a href="/wiki/article">{{foo.png}}</a></p>\n}
+  end
+
+  it 'should not be allowed as an external link target' do
+    expected = %Q{<p>[<img src="/images/foo.png" alt="foo.png" /> the link]</p>\n}
+    @parser.parse('[{{foo.png}} the link]').should == expected
+  end
+
+  it 'should be passed through in external link text' do
+    expected = %Q{<p><a href="http://example.com/" class="external">{{foo.png}}</a></p>\n}
+    @parser.parse('[http://example.com/ {{foo.png}}]').should == expected
+  end
+
+  it 'should not allow embedded quotes' do
+    @parser.parse('{{"fun".png}}').should == %Q{<p>{{&quot;fun&quot;.png}}</p>\n}
+  end
+
+  it 'should not allow embedded spaces' do
+    @parser.parse('{{foo bar.png}}').should == %Q{<p>{{foo bar.png}}</p>\n}
+  end
+
+  it 'should not allow characters beyond printable ASCII' do
+    @parser.parse('{{500€.png}}').should == %Q{<p>{{500&#x20ac;.png}}</p>\n}
+  end
+
+  it 'should allow overrides of the image prefix at initialization time' do
+    parser = Wikitext::Parser.new(:img_prefix => '/gfx/')
+    parser.parse('{{foo.png}}').should == %Q{<p><img src="/gfx/foo.png" alt="foo.png" /></p>\n}
+  end
+
+  it 'should suppress the image prefix if passed an empty string at initialization time' do
+    parser = Wikitext::Parser.new(:img_prefix => '')
+    parser.parse('{{foo.png}}').should == %Q{<p><img src="foo.png" alt="foo.png" /></p>\n}
+  end
+
+  it 'should suppress image prefix if passed nil at initialization time' do
+    parser = Wikitext::Parser.new(:img_prefix => nil)
+    parser.parse('{{foo.png}}').should == %Q{<p><img src="foo.png" alt="foo.png" /></p>\n}
+  end
+
+  it 'should allow overrides of the image prefix after initialization' do
+    @parser.img_prefix = '/gfx/'
+    @parser.parse('{{foo.png}}').should == %Q{<p><img src="/gfx/foo.png" alt="foo.png" /></p>\n}
+  end
+
+  it 'should suppress image if prefix set to an empty string after initialization' do
+    @parser.img_prefix = ''
+    @parser.parse('{{foo.png}}').should == %Q{<p><img src="foo.png" alt="foo.png" /></p>\n}
+  end
+
+  it 'should suppress image if prefix set to nil after initialization' do
+    @parser.img_prefix = nil
+    @parser.parse('{{foo.png}}').should == %Q{<p><img src="foo.png" alt="foo.png" /></p>\n}
+  end
+end

data/spec/integration_spec.rb

@@ -90,6 +90,8 @@ describe Wikitext::Parser, 'with large slab of input text' do
        
       a normal paragraph again
       
+      {{an_image.png}}
+      
       > This is another blockquote which demonstrates that we
       > can nest other structures inside of it. For example, here
       > we have a code sample:
@@ -194,6 +196,7 @@ describe Wikitext::Parser, 'with large slab of input text' do
       which would '''otherwise''' have <tt>special</tt> meaning
       although explicit entities &copy; are passed through unchanged</pre>
       <p>a normal paragraph again</p>
+      <p><img src="/images/an_image.png" alt="an_image.png" /></p>
       <blockquote>
         <p>This is another blockquote which demonstrates that we can nest other structures inside of it. For example, here we have a code sample:</p>
         <pre>line 1

data/spec/tokenizing_spec.rb

@@ -101,9 +101,10 @@ describe Wikitext::Parser, 'tokenizing' do
 
   it 'should be able to tokenize strings containing "}"' do
     # was a bug: we were throwing an exception "failed before finding a token" because our PRINTABLE rule omitted this code point
+    # later on the "}" became the RIGHT_CURLY token, so the spec has been modified accordingly
     lambda { @tokens = @parser.tokenize('}') }.should_not raise_error
     @tokens.length.should == 2
-    @tokens[0].token_type.should    == :printable
+    @tokens[0].token_type.should    == :right_curly # was PRINTABLE
     @tokens[0].string_value.should  == '}'
     @tokens[0].line_start.should    == 1
     @tokens[0].column_start.should  == 1

data/spec/wikitext_spec.rb

@@ -41,6 +41,10 @@ describe Wikitext::Parser do
     @parser.internal_link_prefix.should == '/wiki/'
   end
 
+  it 'should use "/images/" as default img prefix' do
+    @parser.img_prefix.should == '/images/'
+  end
+
   it 'should turn space-to-underscore off by default' do
     @parser.space_to_underscore.should == false
   end
@@ -70,6 +74,12 @@ describe Wikitext::Parser do
       Wikitext::Parser.new(:internal_link_prefix => '/baz/').internal_link_prefix.should == '/baz/'
     end
 
+    it 'should allow overriding of the img prefix' do
+      Wikitext::Parser.new(:img_prefix => '/bar/').img_prefix.should == '/bar/'
+      Wikitext::Parser.new(:img_prefix => '').img_prefix.should == ''
+      Wikitext::Parser.new(:img_prefix => nil).img_prefix.should == nil
+    end
+
     it 'should allow overriding of space-to-underscore' do
       Wikitext::Parser.new(:space_to_underscore => true).space_to_underscore.should == true
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wikitext
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: "0.4"
 platform: ruby
 authors: 
 - Wincent Colaiuta
@@ -34,6 +34,7 @@ files:
 - spec/h4_spec.rb
 - spec/h5_spec.rb
 - spec/h6_spec.rb
+- spec/img_spec.rb
 - spec/indentation_spec.rb
 - spec/integration_spec.rb
 - spec/internal_link_spec.rb