wikitext 0.4 → 0.5

data/ext/ary.c

@@ -0,0 +1,21 @@
+// 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/>.
+
+#include "ary.h"
+
+void ary_free(ary_t *ary)
+{
+    free(ary->entries);
+    free(ary);
+}

data/ext/ary.h

@@ -26,6 +26,10 @@ typedef struct
 
 #define NO_ITEM(item) (item == INT_MAX)
 
+// Mark the ary struct designated by ptr as a participant in Ruby's mark-and-sweep garbage collection scheme.
+// A variable named name is placed on the C stack to prevent the structure from being prematurely collected.
+#define GC_WRAP_ARY(ptr, name) volatile VALUE name = Data_Wrap_Struct(rb_cObject, 0, ary_free, ptr)
+
 inline ary_t *ary_new(void)
 {
     ary_t *ary      = ALLOC_N(ary_t, 1);
@@ -35,11 +39,8 @@ inline ary_t *ary_new(void)
     return ary;
 }
 
-inline void ary_free(ary_t *ary)
-{
-    free(ary->entries);
-    free(ary);
-}
+// this method not inlined so its address can be passed to the Data_Wrap_Struct function.
+void ary_free(ary_t *ary);
 
 inline int ary_entry(ary_t *ary, int idx)
 {

data/ext/depend

@@ -16,7 +16,9 @@
 
 CFLAGS += -std=gnu99
 
-parser.o : ary.h parser.c parser.h token.h str.h wikitext.h wikitext_ragel.h
+ary.o : ary.c ary.h
+parser.o : ary.c ary.h parser.c parser.h token.h str.c str.h wikitext.h wikitext_ragel.h
+str.o : str.c str.h
 token.o : token.c token.h wikitext.h
 wikitext.o : parser.h token.h wikitext.c wikitext.h wikitext_ragel.h
 wikitext_ragel.o : token.h wikitext.h wikitext_ragel.h wikitext_ragel.c

data/ext/parser.c

@@ -207,9 +207,7 @@ inline void _Wikitext_indent(parser_t *parser)
     if (space_count > 0)
     {
         char *old_end, *new_end;
-        if (!parser->tabulation)
-            parser->tabulation = str_new_size(space_count);
-        else if (parser->tabulation->len < space_count)
+        if (parser->tabulation->len < space_count)
             str_grow(parser->tabulation, space_count); // reallocates if necessary
         old_end = parser->tabulation->ptr + parser->tabulation->len;
         new_end = parser->tabulation->ptr + space_count;
@@ -930,17 +928,22 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
     parser->external_link_class     = link_class;
     parser->img_prefix              = rb_iv_get(self, "@img_prefix");
     parser->scope                   = ary_new();
+    GC_WRAP_ARY(parser->scope, scope_gc);
     parser->line                    = ary_new();
+    GC_WRAP_ARY(parser->line, line_gc);
     parser->line_buffer             = ary_new();
+    GC_WRAP_ARY(parser->line_buffer, line_buffer_gc);
     parser->pending_crlf            = Qfalse;
     parser->autolink                = rb_iv_get(self, "@autolink");
     parser->treat_slash_as_special  = rb_iv_get(self, "@treat_slash_as_special");
     parser->space_to_underscore     = rb_iv_get(self, "@space_to_underscore");
     parser->special_link            = Qfalse;
     parser->line_ending             = str_new_from_string(line_ending);
+    GC_WRAP_STR(parser->line_ending, line_ending_gc);
     parser->base_indent             = base_indent;
     parser->current_indent          = 0;
-    parser->tabulation              = NULL;
+    parser->tabulation              = str_new();
+    GC_WRAP_STR(parser->tabulation, tabulation_gc);
 
     token_t _token;
     _token.type = NO_TOKEN;
@@ -2266,12 +2269,5 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
         token = NULL;
     } while (1);
 return_output:
-    // BUG: these will leak if we exit this function by raising an exception; need to investigate using Data_Wrap_Struct
-    ary_free(parser->scope);
-    ary_free(parser->line);
-    ary_free(parser->line_buffer);
-    str_free(parser->line_ending);
-    if (parser->tabulation)
-        str_free(parser->tabulation);
     return parser->output;
 }

data/ext/str.c

@@ -0,0 +1,22 @@
+// 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/>.
+
+#include "str.h"
+
+void str_free(str_t *str)
+{
+    if (str->ptr)
+        free(str->ptr);
+    free(str);
+}

data/ext/str.h

@@ -21,6 +21,10 @@ typedef struct
     long capacity;
 } str_t;
 
+// Mark the str struct designated by ptr as a participant in Ruby's mark-and-sweep garbage collection scheme.
+// A variable named name is placed on the C stack to prevent the structure from being prematurely collected.
+#define GC_WRAP_STR(ptr, name) volatile VALUE name = Data_Wrap_Struct(rb_cObject, 0, str_free, ptr)
+
 // create a new, empty string struct
 inline str_t *str_new(void)
 {
@@ -127,9 +131,5 @@ inline void str_clear(str_t *str)
     str->len = 0;
 }
 
-inline void str_free(str_t *str)
-{
-    if (str->ptr)
-        free(str->ptr);
-    free(str);
-}
+// this method not inlined so its address can be passed to the Data_Wrap_Struct function.
+void str_free(str_t *str);

data/lib/wikitext/rails.rb

@@ -0,0 +1,14 @@
+require 'wikitext/string'
+
+module Wikitext
+  class TemplateHandler
+    def initialize view
+    end
+
+    def render text, locals = {}
+      text.w
+    end
+  end
+end
+
+ActionView::Base.register_template_handler :wikitext, Wikitext::TemplateHandler

data/lib/wikitext/string.rb

@@ -0,0 +1,21 @@
+require 'wikitext'
+
+class String
+
+  def to_wikitext
+    @@shared_wikitext_parser ||= Wikitext::Parser.new(:space_to_underscore => true)
+    @@shared_wikitext_parser.parse wikitext_preprocess
+  end
+
+  # Convenience shortcut
+  alias :w :to_wikitext
+
+private
+
+  # for now do this in pure Ruby
+  # if speed later becomes a concern can whip up a Ragel C extension to do it
+  def wikitext_preprocess
+    gsub /\b(bug|issue|request) #(\d+)/i, '[[issues/\2|\1 #\2]]'
+  end
+
+end

data/spec/integration_spec.rb

@@ -265,4 +265,13 @@ describe Wikitext::Parser, 'with large slab of input text' do
 
     @parser.parse(input).should == expected
   end
+
+  # Without something like this it is possible to complete the entire spec suite without
+  # triggering garbage collection at all, or at least enough to expose memory-related bugs.
+  # 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}
+    100_000.times { @parser.parse(input).should == expected }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wikitext
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: "0.5"
 platform: ruby
 authors: 
 - Wincent Colaiuta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-19 00:00:00 +01:00
+date: 2008-02-23 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -53,7 +53,9 @@ files:
 - spec/ul_spec.rb
 - spec/wikitext_spec.rb
 - ext/extconf.rb
+- ext/ary.c
 - ext/parser.c
+- ext/str.c
 - ext/token.c
 - ext/wikitext.c
 - ext/wikitext_ragel.c
@@ -64,6 +66,8 @@ files:
 - ext/wikitext.h
 - ext/wikitext_ragel.h
 - ext/depend
+- lib/wikitext/rails.rb
+- lib/wikitext/string.rb
 has_rdoc: true
 homepage: http://wikitext.rubyforge.org/
 post_install_message: 
@@ -71,6 +75,7 @@ rdoc_options: []
 
 require_paths: 
 - ext
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="