wikitext 1.3.1 → 1.3.2

data/ext/parser.c

@@ -905,7 +905,7 @@ VALUE Wikitext_parser_initialize(int argc, VALUE *argv, VALUE self)
     VALUE mailto_class                  = rb_str_new2("mailto");
     VALUE internal_link_prefix          = rb_str_new2("/wiki/");
     VALUE img_prefix                    = rb_str_new2("/images/");
-    VALUE space_to_underscore           = Qfalse;
+    VALUE space_to_underscore           = Qtrue;
     VALUE treat_slash_as_special        = Qtrue;
     VALUE minimum_fulltext_token_length = INT2NUM(3);
 

data/lib/wikitext/parser.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# Copyright 2009 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 'wikitext'
+
+module Wikitext
+  class Parser
+    def self.shared_parser
+      @@shared_parser_instance ||= new
+    end
+  end # class Parser
+end # module Wikitext
+

data/lib/wikitext/string.rb

@@ -1,4 +1,4 @@
-# Copyright 2008 Wincent Colaiuta
+# Copyright 2008-2009 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
@@ -12,12 +12,11 @@
 # 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 'wikitext'
+require 'wikitext/parser'
 
 class String
   def to_wikitext
-    @@shared_wikitext_parser ||= Wikitext::Parser.new(:space_to_underscore => true)
-    @@shared_wikitext_parser.parse wikitext_preprocess
+    Wikitext::Parser.shared_parser.parse wikitext_preprocess
   end
   alias :w :to_wikitext
 
@@ -25,6 +24,7 @@ private
 
   # for now do this in pure Ruby
   # if speed later becomes a concern can whip up a Ragel C extension to do it
+  # TODO: make this customizable (accept a lambda that performs preprocessing)
   def wikitext_preprocess
     gsub /\b(bug|issue|request|ticket) #(\d+)/i, '[[issues/\2|\1 #\2]]'
   end

data/lib/wikitext/version.rb

@@ -13,5 +13,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module Wikitext
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
 end # module Wikitext

data/spec/integration_spec.rb

@@ -271,7 +271,7 @@ describe Wikitext::Parser, 'with large slab of input text' do
   # So add one long-running spec to hopefully catch any GC and memory-related bugs.
   it 'should work correctly during long runs (when Garbage Collection runs)' do
     input     = "a <strong>simple</strong> ''test'' of the [[wikitext parser]]"
-    expected  = %Q{<p>a <strong>simple</strong> <em>test</em> of the <a href="/wiki/wikitext%20parser">wikitext parser</a></p>\n}
+    expected  = %Q{<p>a <strong>simple</strong> <em>test</em> of the <a href="/wiki/wikitext_parser">wikitext parser</a></p>\n}
     100_000.times { @parser.parse(input).should == expected }
   end
 end

data/spec/internal_link_spec.rb

@@ -18,7 +18,7 @@ require 'wikitext'
 
 describe Wikitext::Parser, 'internal links (space to underscore off)' do
   before do
-    @parser = Wikitext::Parser.new
+    @parser = Wikitext::Parser.new :space_to_underscore => false
   end
 
   it 'should pass through unexpected link end tokens literally' do
@@ -447,7 +447,6 @@ end
 describe Wikitext::Parser, 'internal links (space to underscore on)' do
   before do
     @parser = Wikitext::Parser.new
-    @parser.space_to_underscore = true
   end
 
   it 'should pass through unexpected link end tokens literally' do

data/spec/nil_class_spec.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# Copyright 2009 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/nil_class'
+
+describe NilClass, 'wikitext extensions' do
+  it 'should provide a to_wikitext method on the nil singleton' do
+    nil.to_wikitext.should == ''
+  end
+
+  it 'should provide a w method on the nil singleton' do
+    nil.w.should == ''
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# Copyright 2009 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/parser'
+
+describe Wikitext::Parser do
+  it 'should provide access to the shared parser instance for customization' do
+    Wikitext::Parser.shared_parser.should be_instance_of(Wikitext::Parser)
+  end
+
+  it 'should persist customizations made to shared parser instance' do
+    # fisrt pass
+    parser                             = Wikitext::Parser.shared_parser
+    original_prefix                    = '/images/'
+    parser.img_prefix                  = original_prefix
+    parser.img_prefix.should           == original_prefix
+    parser.parse('{{foo.png}}').should == %Q{<p><img src="/images/foo.png" alt="foo.png" /></p>\n}
+
+    # second pass
+    parser                             = Wikitext::Parser.shared_parser
+    parser.img_prefix.should           == original_prefix
+    new_prefix                         = '/totally-different-prefix/'
+    parser.img_prefix                  = new_prefix
+    parser.img_prefix.should           == new_prefix
+    parser.parse('{{bar.png}}').should == %Q{<p><img src="/totally-different-prefix/bar.png" alt="bar.png" /></p>\n}
+  end
+end

data/spec/regressions_spec.rb

@@ -38,7 +38,7 @@ describe Wikitext::Parser, 'regressions' do
         <li>punto 1</li>
         <li>punto 2</li>
       </ul>
-      <p>Y <a href="/wiki/otro%20articulo">otro articulo</a>.</p>
+      <p>Y <a href="/wiki/otro_articulo">otro articulo</a>.</p>
     END
     @parser.parse(input).should == expected
   end
@@ -94,7 +94,7 @@ describe Wikitext::Parser, 'regressions' do
     END
     expected = dedent <<-END
       <ol>
-        <li>Turn off the <a href="/wiki/Movable%20Type">Movable Type</a> search function; use Google instead (it's better anyway) with a form something like this:</li>
+        <li>Turn off the <a href="/wiki/Movable_Type">Movable Type</a> search function; use Google instead (it's better anyway) with a form something like this:</li>
       </ol>
       <pre>&lt;form method=&quot;get&quot;...&gt;</pre>
     END

data/spec/string_spec.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# Copyright 2009 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/string'
+
+describe String, 'wikitext extensions' do
+  it 'should provide a to_wikitext method on all strings' do
+    "'''strong'''".to_wikitext.should == "<p><strong>strong</strong></p>\n"
+  end
+
+  it 'should provide a w method on all strings' do
+    "'''strong'''".w.should == "<p><strong>strong</strong></p>\n"
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# Copyright 2009 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/version'
+
+describe Wikitext, 'versioning' do
+  it 'should provide a version string' do
+    Wikitext::VERSION.should be_instance_of(String)
+  end
+end

data/spec/wikitext_spec.rb

@@ -45,8 +45,8 @@ describe Wikitext::Parser do
     @parser.img_prefix.should == '/images/'
   end
 
-  it 'should turn space-to-underscore off by default' do
-    @parser.space_to_underscore.should == false
+  it 'should turn space-to-underscore on by default' do
+    @parser.space_to_underscore.should == true
   end
 
   it 'should treat slash as special by default' do
@@ -81,7 +81,7 @@ describe Wikitext::Parser do
     end
 
     it 'should allow overriding of space-to-underscore' do
-      Wikitext::Parser.new(:space_to_underscore => true).space_to_underscore.should == true
+      Wikitext::Parser.new(:space_to_underscore => false).space_to_underscore.should == false
     end
 
     it 'should allow overriding of treat slash as special' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wikitext
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors: 
 - Wincent Colaiuta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-05 00:00:00 +01:00
+date: 2009-01-06 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -43,18 +43,22 @@ files:
 - spec/line_endings_spec.rb
 - spec/link_encoding_spec.rb
 - spec/link_sanitizing_spec.rb
+- spec/nil_class_spec.rb
 - spec/nowiki_spec.rb
 - spec/p_spec.rb
+- spec/parser_spec.rb
 - spec/pre_spec.rb
 - spec/rails_spec.rb
 - spec/regressions_spec.rb
 - spec/spec_helper.rb
+- spec/string_spec.rb
 - spec/strong_em_spec.rb
 - spec/strong_spec.rb
 - spec/tokenizing_spec.rb
 - spec/trash
 - spec/tt_spec.rb
 - spec/ul_spec.rb
+- spec/version_spec.rb
 - spec/wikitext_spec.rb
 - ext/extconf.rb
 - ext/ary.c
@@ -72,6 +76,7 @@ files:
 - ext/wikitext_ragel.h
 - ext/depend
 - lib/wikitext/nil_class.rb
+- lib/wikitext/parser.rb
 - lib/wikitext/rails.rb
 - lib/wikitext/string.rb
 - lib/wikitext/version.rb