wikitext 2.0 → 2.1

data/ext/depend

@@ -1,18 +1,25 @@
-# depend
-# Additional material for Makefile
-# 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.
+# Copyright 2008-2010 Wincent Colaiuta. All rights reserved.
 #
-# 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.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
 #
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
 
 # don't warn about unused params because many Ruby methods accept "self" but don't use it
 CFLAGS += -std=gnu99 -Wall -Wextra -Wno-unused-parameter

data/ext/parser.c

@@ -51,6 +51,7 @@ typedef struct
     ary_t   *line;                  // stack for tracking scope as implied by current line
     ary_t   *line_buffer;           // stack for tracking raw tokens (not scope) on current line
     VALUE   external_link_class;    // CSS class applied to external links
+    VALUE   external_link_rel;      // rel attribute applied to external links
     VALUE   mailto_class;           // CSS class applied to email (mailto) links
     VALUE   img_prefix;             // path prepended when emitting img tags
     int     output_style;           // HTML_OUTPUT (default) or XML_OUTPUT
@@ -112,6 +113,7 @@ const char p_end[]                      = "</p>";
 const char space[]                      = " ";
 const char a_start[]                    = "<a href=\"";
 const char a_class[]                    = "\" class=\"";
+const char a_rel[]                      = "\" rel=\"";
 const char a_start_close[]              = "\">";
 const char a_end[]                      = "</a>";
 const char link_start[]                 = "[[";
@@ -153,6 +155,7 @@ parser_t *parser_new(void)
     parser->line                    = ary_new();
     parser->line_buffer             = ary_new();
     parser->external_link_class     = Qnil; // caller should set up
+    parser->external_link_rel       = Qnil; // caller should set up
     parser->mailto_class            = Qnil; // caller should set up
     parser->img_prefix              = Qnil; // caller should set up
     parser->output_style            = HTML_OUTPUT;
@@ -280,7 +283,7 @@ void wiki_downcase_bang(char *ptr, long len)
 // if check_autolink is true, checks parser->autolink to decide whether to emit a real hyperlink
 // or merely the literal link target
 // if link_text is Qnil, the link_target is re-used for the link text
-void wiki_append_hyperlink(parser_t *parser, VALUE link_prefix, str_t *link_target, str_t *link_text, VALUE link_class, bool check_autolink)
+void wiki_append_hyperlink(parser_t *parser, VALUE link_prefix, str_t *link_target, str_t *link_text, VALUE link_class, VALUE link_rel, bool check_autolink)
 {
     if (check_autolink && !parser->autolink)
         str_append_str(parser->output, link_target);
@@ -305,6 +308,11 @@ void wiki_append_hyperlink(parser_t *parser, VALUE link_prefix, str_t *link_targ
             str_append(parser->output, a_class, sizeof(a_class) - 1);           // " class="
             str_append_string(parser->output, link_class);
         }
+        if (link_rel != Qnil)
+        {
+            str_append(parser->output, a_rel, sizeof(a_rel) - 1);               // " rel="
+            str_append_string(parser->output, link_rel);
+        }
         str_append(parser->output, a_start_close, sizeof(a_start_close) - 1);   // ">
         if (!link_text || link_text->len == 0) // re-use link_target
             str_append_str(parser->output, link_target);
@@ -963,12 +971,13 @@ void wiki_rollback_failed_external_link(parser_t *parser)
     // store a couple of values before popping
     int scope_includes_space = IN(SPACE);
     VALUE link_class = IN(PATH) ? Qnil : parser->external_link_class;
+    VALUE link_rel   = IN(PATH) ? Qnil : parser->external_link_rel;
     wiki_pop_from_stack_up_to(parser, NULL, EXT_LINK_START, true);
 
     str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
     if (parser->link_target->len > 0)
     {
-        wiki_append_hyperlink(parser, Qnil, parser->link_target, NULL, link_class, true);
+        wiki_append_hyperlink(parser, Qnil, parser->link_target, NULL, link_class, link_rel, true);
         if (scope_includes_space)
         {
             str_append(parser->output, space, sizeof(space) - 1);
@@ -998,6 +1007,7 @@ VALUE Wikitext_parser_initialize(int argc, VALUE *argv, VALUE self)
     VALUE autolink                      = Qtrue;
     VALUE line_ending                   = rb_str_new2("\n");
     VALUE external_link_class           = rb_str_new2("external");
+    VALUE external_link_rel             = Qnil;
     VALUE mailto_class                  = rb_str_new2("mailto");
     VALUE internal_link_prefix          = rb_str_new2("/wiki/");
     VALUE img_prefix                    = rb_str_new2("/images/");
@@ -1014,6 +1024,7 @@ VALUE Wikitext_parser_initialize(int argc, VALUE *argv, VALUE self)
         autolink                        = OVERRIDE_IF_SET(autolink);
         line_ending                     = OVERRIDE_IF_SET(line_ending);
         external_link_class             = OVERRIDE_IF_SET(external_link_class);
+        external_link_rel               = OVERRIDE_IF_SET(external_link_rel);
         mailto_class                    = OVERRIDE_IF_SET(mailto_class);
         internal_link_prefix            = OVERRIDE_IF_SET(internal_link_prefix);
         img_prefix                      = OVERRIDE_IF_SET(img_prefix);
@@ -1027,6 +1038,7 @@ VALUE Wikitext_parser_initialize(int argc, VALUE *argv, VALUE self)
     rb_iv_set(self, "@autolink",                        autolink);
     rb_iv_set(self, "@line_ending",                     line_ending);
     rb_iv_set(self, "@external_link_class",             external_link_class);
+    rb_iv_set(self, "@external_link_rel",               external_link_rel);
     rb_iv_set(self, "@mailto_class",                    mailto_class);
     rb_iv_set(self, "@internal_link_prefix",            internal_link_prefix);
     rb_iv_set(self, "@img_prefix",                      img_prefix);
@@ -1070,6 +1082,8 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
     line_ending         = StringValue(line_ending);
     VALUE link_class    = rb_iv_get(self, "@external_link_class");
     link_class          = NIL_P(link_class) ? Qnil : StringValue(link_class);
+    VALUE link_rel      = rb_iv_get(self, "@external_link_rel");
+    link_rel            = NIL_P(link_rel) ? Qnil : StringValue(link_rel);
     VALUE mailto_class  = rb_iv_get(self, "@mailto_class");
     mailto_class        = NIL_P(mailto_class) ? Qnil : StringValue(mailto_class);
     VALUE prefix        = rb_iv_get(self, "@internal_link_prefix");
@@ -1102,6 +1116,14 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
         if (rb_funcall(options, has_key, 1, id) == Qtrue)
             base_heading_level = NUM2INT(rb_hash_aref(options, id));
 
+        // :external_link_rel => 'nofollow'
+        id = ID2SYM(rb_intern("external_link_rel"));
+        if (rb_funcall(options, has_key, 1, id) == Qtrue)
+        {
+            link_rel = rb_hash_aref(options, id);
+            link_rel = NIL_P(link_rel) ? Qnil : StringValue(link_rel);
+        }
+
         // :output_style => :html/:xml
         id = ID2SYM(rb_intern("output_style"));
         if (rb_funcall(options, has_key, 1, id) == Qtrue)
@@ -1128,6 +1150,7 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
     parser_t *parser                = parser_new();
     GC_WRAP_PARSER(parser, parser_gc);
     parser->external_link_class     = link_class;
+    parser->external_link_rel       = link_rel;
     parser->mailto_class            = mailto_class;
     parser->img_prefix              = rb_iv_get(self, "@img_prefix");
     parser->autolink                = rb_iv_get(self, "@autolink") == Qtrue ? true : false;
@@ -1947,7 +1970,7 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
                     wiki_start_para_if_necessary(parser);
                     token_str->ptr = token->start;
                     token_str->len = TOKEN_LEN(token);
-                    wiki_append_hyperlink(parser, rb_str_new2("mailto:"), token_str, NULL, mailto_class, true);
+                    wiki_append_hyperlink(parser, rb_str_new2("mailto:"), token_str, NULL, mailto_class, Qnil, true);
                 }
                 break;
 
@@ -1962,7 +1985,7 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
                     wiki_rollback_failed_internal_link(parser);
                     token_str->ptr = token->start;
                     token_str->len = TOKEN_LEN(token);
-                    wiki_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, true);
+                    wiki_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, parser->external_link_rel, true);
                 }
                 else if (IN(EXT_LINK_START))
                 {
@@ -1987,7 +2010,7 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
                             wiki_pop_excess_elements(parser);
                             wiki_start_para_if_necessary(parser);
                             str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
-                            wiki_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, true);
+                            wiki_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, parser->external_link_rel, true);
                         }
                     }
                     else
@@ -1999,7 +2022,7 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
                     wiki_start_para_if_necessary(parser);
                     token_str->ptr = token->start;
                     token_str->len = TOKEN_LEN(token);
-                    wiki_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, true);
+                    wiki_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, parser->external_link_rel, true);
                 }
                 break;
 
@@ -2202,7 +2225,7 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
                     wiki_encode_link_target(parser);
                     wiki_pop_from_stack_up_to(parser, output, LINK_START, true);
                     parser->capture = NULL;
-                    wiki_append_hyperlink(parser, prefix, parser->link_target, parser->link_text, j, false);
+                    wiki_append_hyperlink(parser, prefix, parser->link_target, parser->link_text, j, Qnil, false);
                     str_clear(parser->link_target);
                     str_clear(parser->link_text);
                 }
@@ -2270,9 +2293,10 @@ VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
                     {
                         // success!
                         j = IN(PATH) ? Qnil : parser->external_link_class;
+                        k = IN(PATH) ? Qnil : parser->external_link_rel;
                         wiki_pop_from_stack_up_to(parser, output, EXT_LINK_START, true);
                         parser->capture = NULL;
-                        wiki_append_hyperlink(parser, Qnil, parser->link_target, parser->link_text, j, false);
+                        wiki_append_hyperlink(parser, Qnil, parser->link_target, parser->link_text, j, k, false);
                     }
                     str_clear(parser->link_target);
                     str_clear(parser->link_text);

data/ext/wikitext.c

@@ -78,6 +78,7 @@ void Init_wikitext()
     rb_define_attr(cWikitextParser, "internal_link_prefix", Qtrue, Qtrue);
     rb_define_attr(cWikitextParser, "img_prefix", Qtrue, Qtrue);
     rb_define_attr(cWikitextParser, "external_link_class", Qtrue, Qtrue);
+    rb_define_attr(cWikitextParser, "external_link_rel", Qtrue, Qtrue);
     rb_define_attr(cWikitextParser, "mailto_class", Qtrue, Qtrue);
     rb_define_attr(cWikitextParser, "autolink", Qtrue, Qtrue);
     rb_define_attr(cWikitextParser, "space_to_underscore", Qtrue, Qtrue);

data/lib/wikitext/version.rb

@@ -22,5 +22,5 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 module Wikitext
-  VERSION = '2.0'
+  VERSION = '2.1'
 end # module Wikitext

data/spec/external_link_spec.rb

@@ -204,6 +204,47 @@ describe Wikitext::Parser, 'external links' do
     @parser.parse('> ]').should == "<blockquote>\n  <p>]</p>\n</blockquote>\n"                    # in BLOCKQUOTE scope
   end
 
+  describe '#external_link_rel attribute' do
+    it 'defaults to nil (external links do not have a rel attribute)' do
+      @parser.parse('http://google.com/').should == \
+        %Q{<p><a href="http://google.com/" class="external">http://google.com/</a></p>\n}
+    end
+
+    context 'set at parse time' do
+      it 'uses the rel attribute in external links' do
+        @parser.parse('http://google.com/', :external_link_rel => 'nofollow').should == \
+          %Q{<p><a href="http://google.com/" class="external" rel="nofollow">http://google.com/</a></p>\n}
+      end
+    end
+
+    context 'set at initialization time' do
+      let (:parser) { Wikitext::Parser.new :external_link_rel => 'nofollow' }
+
+      it 'uses the rel attribute in external links' do
+        parser.parse('http://google.com/').should == \
+          %Q{<p><a href="http://google.com/" class="external" rel="nofollow">http://google.com/</a></p>\n}
+      end
+
+      it 'is overrideable' do
+        parser.parse('http://google.com/', :external_link_rel => nil).should == \
+          %Q{<p><a href="http://google.com/" class="external">http://google.com/</a></p>\n}
+      end
+    end
+
+    context 'set via an accessor' do
+      let (:parser) do
+        parser = Wikitext::Parser.new
+        parser.external_link_rel = 'nofollow'
+        parser
+      end
+
+      it 'uses the rel attribute in external links' do
+        parser.parse('http://google.com/').should == \
+          %Q{<p><a href="http://google.com/" class="external" rel="nofollow">http://google.com/</a></p>\n}
+      end
+    end
+  end
+
   describe 'questionable links' do
     it 'should handle links which contain an embedded [ character' do
       # note that [ is allowed in the link text, although the result may be unexpected to the user

data/spec/spec_helper.rb

@@ -23,7 +23,7 @@
 
 require 'pathname'
 require 'rubygems'
-require 'spec'
+require 'rspec'
 
 # allow indenting of multiline spec data for better readability
 # but must dedent it before actually doing the comparison

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: wikitext
 version: !ruby/object:Gem::Version 
+  hash: 1
   prerelease: false
   segments: 
   - 2
-  - 0
-  version: "2.0"
+  - 1
+  version: "2.1"
 platform: ruby
 authors: 
 - Wincent Colaiuta
@@ -13,45 +14,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-13 00:00:00 +02:00
+date: 2010-10-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
+        - 2
         - 0
-        version: "0"
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: thor
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: wopen3
+  name: yard
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 0
-        version: "0"
+        - 5
+        - 8
+        version: 0.5.8
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: wopen3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: "    Wikitext is a fast wikitext-to-HTML translator written in C.\n"
 email: win@wincent.com
 executables: 
@@ -122,7 +147,7 @@ files:
 - spec/version_spec.rb
 - spec/vim_formatter.rb
 - spec/wikitext_spec.rb
-has_rdoc: true
+has_rdoc: false
 homepage: https://wincent.com/products/wikitext
 licenses: []
 
@@ -133,23 +158,27 @@ require_paths:
 - ext
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: wikitext
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Wikitext-to-HTML translator