wikicloth 0.1.3

data/lib/wiki_buffer/var.rb

@@ -0,0 +1,77 @@
+module WikiCloth
+
+class WikiBuffer::Var < WikiBuffer
+
+  def initialize(data="",options={})
+    super(data,options)
+    self.buffer_type = "var"
+    @in_quotes = false
+  end
+
+  def skip_html?
+    true
+  end
+
+  def function_name
+    @fname
+  end
+
+  def to_s
+    if self.is_function?
+      ret = "#{buffer_type}"
+      ret += " function #{function_name}"
+      ret += "(#{params.inspect})"
+      ret += " [#{data}]"
+    else
+      ret = @options[:link_handler].include_resource("#{params[0]}".strip,params[1..-1])
+    end
+    ret ||= "<!-- TEMPLATE[#{params[0]}] NOT FOUND -->"
+    ret
+  end
+
+  def is_function?
+    self.function_name.nil? || self.function_name.blank? ? false : true
+  end
+
+  protected
+  def function_name=(val)
+    @fname = val
+  end
+
+  def new_char()
+    case
+    when current_char == '|' && @in_quotes == false
+      self.current_param = self.data
+      self.data = ""
+      self.params << ""
+
+    # Start of either a function or a namespace change
+    when current_char == ':' && @in_quotes == false && self.params.size <= 1
+      self.function_name = self.data
+      self.data = ""
+      puts "[found var function (#{function_name})"
+
+    # Dealing with variable names within functions
+    # and variables
+    when current_char == '=' && @in_quotes == false
+      self.current_param = self.data
+      self.data = ""
+      self.name_current_param()
+
+    # End of a template, variable, or function
+    when current_char == '}' && previous_char == '}'
+      self.data.chop!
+      self.current_param = self.data
+      self.data = ""
+      return false
+
+    else
+      self.data += current_char
+    end
+
+    return true
+  end
+
+end
+
+end

data/lib/wiki_buffer.rb

@@ -0,0 +1,279 @@
+module WikiCloth
+class WikiBuffer
+
+  def initialize(data="",options={})
+    @options = options
+    self.data = data
+    self.buffer_type = nil
+    @section_count = 0
+    @buffers ||= [ ]
+    @buffers << self
+    @list_data = []
+  end
+
+  def run_globals?
+    true
+  end
+
+  def skip_html?
+    false
+  end
+
+  def data
+    @data ||= ""
+  end
+
+  def params
+    @params ||= [ "" ]
+  end
+
+  def buffer_type
+    @buffer_type
+  end
+
+  def to_s
+    "<p>" + self.params.join("\n") + "</p>"
+  end
+
+  def check_globals()
+    return false if self.class != WikiBuffer
+
+    if previous_char == "\n"
+      if @indent == @buffers[-1].object_id && current_char != " " && current_char != "\n"
+        # close pre tag
+        cc_temp = current_char
+        "</pre>\n".each_char { |c| self.add_char(c) }
+        # get the parser back on the right track
+        "\n#{cc_temp}".each_char { |c| @buffers[-1].add_char(c) }
+        @indent = nil
+        return true
+      end
+      if current_char == " " && @indent.nil? && @buffers[-1].class != WikiBuffer::HTMLElement
+        "\n<pre> ".each_char { |c| @buffers[-1].add_char(c) }
+        @indent = @buffers[-1].object_id
+        return true
+      end
+    end
+
+    if @buffers[-1].run_globals?
+      # new html tag
+      if @check_new_tag == true && current_char =~ /([a-z])/ && !@buffers[-1].skip_html?
+        @buffers[-1].data.chop!
+        parent = @buffers[-1].element_name if @buffers[-1].class == WikiBuffer::HTMLElement
+        @buffers << WikiBuffer::HTMLElement.new("",@options,parent)
+      end
+      @check_new_tag = current_char == '<' ? true : false
+
+      # global
+      case
+      # start variable
+      when previous_char == '{' && current_char == '{'
+        @buffers[-1].data.chop!
+        @buffers << WikiBuffer::Var.new("",@options)
+        return true
+
+      # start link
+      when current_char == '[' && previous_char != '['
+        @buffers << WikiBuffer::Link.new("",@options)
+        return true
+
+      # start table
+      when previous_char == '{' && current_char == "|"
+        @buffers[-1].data.chop!
+        @buffers << WikiBuffer::Table.new("",@options)
+        return true
+
+      end
+    end
+
+    return false
+  end
+
+  def add_char(c)
+    self.previous_char = self.current_char
+    self.current_char = c
+
+    if self.check_globals() == false
+      case
+      when @buffers.size == 1
+        return self.new_char()
+      when @buffers[-1].add_char(c) == false && self.class == WikiBuffer
+        tmp = @buffers.pop
+        @buffers[-1].data += tmp.to_s
+        # any data left in the buffer we feed into the parent
+        unless tmp.data.blank?
+          tmp.data.each_char { |c| self.add_char(c) }
+        end
+      end
+    end
+  end
+
+  protected
+  # only executed in the default state
+  def new_char()
+    case
+    when current_char == "\n"
+      if @options[:extended_markup] == true
+        self.data.gsub!(/---([^-]+)---/,"<strike>\\1</strike>")
+        self.data.gsub!(/_([^_]+)_/,"<u>\\1</u>")
+      end
+      self.data.gsub!(/__([a-zA-Z0-9]+)__/) { |r|
+        case $1
+        when "NOEDITSECTION"
+          @noeditsection = true
+        end
+        ""
+      }
+      self.data.gsub!(/^([-]{4,})/) { |r| "<hr />" }
+      self.data.gsub!(/^([=]{1,6})\s*(.*?)\s*(\1)/) { |r|
+        @section_count += 1
+        "<h#{$1.length}>" + (@noeditsection == true ? "" : 
+        "<span class=\"editsection\">[<a href=\"" + @options[:link_handler].section_link(@section_count) + 
+	"\" title=\"Edit section: #{$2}\">edit</a>]</span>") +
+        " <span class=\"mw-headline\">#{$2}</span></h#{$1.length}>"
+      }
+      self.data.gsub!(/([\']{2,5})(.*?)(\1)/) { |r|
+        tmp = "<i>#{$2}</i>" if $1.length == 2
+        tmp = "<b>#{$2}</b>" if $1.length == 3
+        tmp = "<b>'#{$2}'</b>" if $1.length == 4
+        tmp = "<b><i>#{$2}</i></b>" if $1.length == 5
+        tmp
+      }
+      lines = self.data.split("\n")
+      self.data = ""
+      for line in lines
+        if !@list_data.empty? && (line.blank? || line =~ /^([^#\*:;]+)/)
+          tmp = ""
+          @list_data.reverse!
+          @list_data.each { |x| tmp += "</" + list_inner_tag_for(x) + "></#{list_tag_for(x)}>" }
+          line = "#{tmp} #{line}"
+          @list_data = []
+        end
+        line.gsub!(/^([#\*:;]+)(.*)$/) { |r|
+          cdata = []
+          tmp = ""
+          $1.each_char { |c| cdata << c }
+          if @list_data.empty?
+            tmp += "<#{list_tag_for(cdata[0])}>"
+            cdata[1..-1].each { |x| tmp += "<" + list_inner_tag_for(cdata[0]) + "><#{list_tag_for(x)}>" } if cdata.size > 1
+          else
+            case
+            when cdata.size > @list_data.size
+              i = cdata.size-@list_data.size
+              cdata[-i,i].each { |x| tmp += "<#{list_tag_for(x)}>" }
+            when cdata.size < @list_data.size
+              i = @list_data.size-cdata.size
+              nlist = @list_data[-i,i].reverse
+              nlist.each { |x| tmp += "</" + list_inner_tag_for(x) + "></#{list_tag_for(x)}>" }
+              tmp += "</#{list_inner_tag_for(cdata.last)}>"
+            else
+              if cdata != @list_data
+                # FIXME: this will only work if the change depth is one level
+                unless (@list_data.last == ';' || @list_data.last == ':') && (cdata.last == ';' || cdata.last == ':')
+                  tmp += "</#{list_tag_for(@list_data.pop)}>"
+                  tmp += "<#{list_tag_for(cdata.last)}>"
+                end
+              else
+                tmp += "</" + list_inner_tag_for(@list_data.last) + ">"
+              end
+            end
+          end
+          # FIXME: still probably does not detect the : properly
+          peices = cdata.last == ";" ? $2.smart_split(":") : [ $2 ]
+          if peices.size > 1
+            tmp += "<#{list_inner_tag_for(cdata.last)}>#{peices[0]}</#{list_inner_tag_for(cdata.last)}>"
+            tmp += "<dd>#{peices[1..-1].join(":")}</dd>"
+            cdata[-1] = ":"
+          else
+            tmp += "<#{list_inner_tag_for(cdata.last)}>#{peices[0]}"
+          end
+          @list_data = cdata
+          tmp
+        }
+        self.data += line + "\n"
+      end
+
+      self.data = "</p><p>" if self.data.blank?
+
+      self.params << self.data.auto_link
+      self.data = ""
+    else
+      self.data += current_char
+    end
+    return true
+  end
+
+  def name_current_param()
+    params[-1] = { :value => "", :name => params[-1] } unless params[-1].kind_of?(Hash) || params[-1].nil?
+  end
+
+  def current_param=(val)
+    unless self.params[-1].nil? || self.params[-1].kind_of?(String)
+      self.params[-1][:value] = val
+    else
+      self.params[-1] = val
+    end
+  end
+
+  def params=(val)
+    @params = val
+  end
+
+  def buffer_type=(val)
+    @buffer_type = val
+  end
+
+  def data=(val)
+    @data = val
+  end
+
+  def current_char=(val)
+    @current_char = val
+  end
+
+  def current_char
+    @current_char ||= ""
+  end
+
+  def previous_char=(val)
+    @previous_char = val
+  end
+
+  def previous_char
+    @previous_char
+  end
+
+  def current_line=(val)
+    @current_line = val
+  end
+
+  def current_line
+    @current_line ||= ""
+  end
+
+  def list_tag_for(tag)
+    case tag
+    when "#" then "ol"
+    when "*" then "ul"
+    when ";" then "dl"
+    when ":" then "dl"
+    end
+  end
+
+  def list_inner_tag_for(tag)
+    case tag
+    when "#" then "li"
+    when "*" then "li"
+    when ";" then "dt"
+    when ":" then "dd"
+    end
+  end
+
+end
+
+end
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_buffer", "html_element")
+require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_buffer", "table")
+require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_buffer", "var")
+require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_buffer", "link")

data/lib/wiki_cloth.rb

@@ -0,0 +1,61 @@
+require 'jcode'
+
+module WikiCloth
+
+class WikiCloth
+
+  def initialize(opt={})
+    self.load(opt[:data],opt[:params]) unless opt[:data].nil? || opt[:data].blank?
+    self.options[:link_handler] = opt[:link_handler] unless opt[:link_handler].nil?
+  end
+
+  def load(data,p={})
+    data.gsub!(/<!--(.|\s)*?-->/,"")
+    self.params = p
+    self.html = data
+  end
+
+  def render(opt={})
+    self.options = { :output => :html, :link_handler => self.link_handler, :params => self.params }.merge(opt)
+    self.options[:link_handler].params = options[:params]
+    buffer = WikiBuffer.new("",options)
+    self.html.each_char { |c| buffer.add_char(c) }
+    buffer.to_s
+  end
+
+  def to_html(opt={})
+    self.render(opt)
+  end
+
+  def link_handler
+    self.options[:link_handler] ||= WikiLinkHandler.new
+  end
+
+  def html
+    @page_data + (@page_data[-1,1] == "\n" ? "" : "\n")
+  end
+
+  def params
+    @page_params ||= {}
+  end
+
+  protected
+  def options=(val)
+    @options = val
+  end
+
+  def options
+    @options ||= {}
+  end
+
+  def html=(val)
+    @page_data = val
+  end
+
+  def params=(val)
+    @page_params = val
+  end
+
+end
+
+end

data/lib/wiki_link_handler.rb

@@ -0,0 +1,138 @@
+require 'rubygems'
+require 'builder'
+
+module WikiCloth
+
+class WikiLinkHandler
+
+  def references
+    @references ||= []
+  end
+
+  def section_link(section)
+    ""
+  end
+
+  def params
+    @params ||= {}
+  end
+
+  def external_links
+    @external_links ||= []
+  end
+
+  def find_reference_by_name(n)
+    references.each { |r| return r if !r[:name].nil? && r[:name].strip == n }
+    return nil
+  end
+
+  def reference_index(h)
+    references.each_index { |r| return r+1 if references[r] == h }
+    return nil
+  end
+
+  def references=(val)
+    @references = val
+  end
+
+  def params=(val)
+    @params = val
+  end
+
+  def external_link(url,text)
+    self.external_links << url
+    elem.a({ :href => url }) { |x| x << (text.blank? ? url : text) }
+  end
+
+  def external_links=(val)
+    @external_links = val
+  end
+
+  def url_for(page)
+    "javascript:void(0)"
+  end
+
+  def link_attributes_for(page)
+     { :href => url_for(page) }
+  end
+
+  def link_for(page, text)
+    ltitle = !text.nil? && text.blank? ? self.pipe_trick(page) : text
+    ltitle = page if text.nil?
+    elem.a(link_attributes_for(page)) { |x| x << ltitle.strip }
+  end
+
+  def include_resource(resource, options=[])
+    return self.params[resource] unless self.params[resource].nil?
+  end
+
+  def link_for_resource(prefix, resource, options=[])
+    ret = ""
+    prefix.downcase!
+    case
+    when ["image","file","media"].include?(prefix)
+      ret += wiki_image(resource,options)
+    else
+      title = options[0] ? options[0] : "#{prefix}:#{resource}"
+      ret += link_for("#{prefix}:#{resource}",title)
+    end
+    ret
+  end
+
+  protected
+  def pipe_trick(page)
+    t = page.split(":")
+    t = t[1..-1] if t.size > 1
+    return t.join("").split(/[,(]/)[0]
+  end
+
+  # this code needs some work... lots of work
+  def wiki_image(resource,options)
+      pre_img = ''
+      post_img = ''
+      css = []
+      loc = "right"
+      type = nil
+      w = 180
+      h = nil
+      title = nil
+      ffloat = false
+
+      options.each do |x|
+        case
+        when ["thumb","thumbnail","frame","border"].include?(x.strip)
+          type = x.strip
+        when ["left","right","center","none"].include?(x.strip)
+          ffloat = true
+          loc = x.strip
+        when x.strip =~ /^([0-9]+)\s*px$/
+          w = $1
+          css << "width:#{w}px"
+        when x.strip =~ /^([0-9]+)\s*x\s*([0-9]+)\s*px$/
+          w = $1
+          css << "width:#{w}px"
+          h = $2
+          css << "height:#{h}px"
+        else
+          title = x.strip
+        end
+      end
+      css << "float:#{loc}" if ffloat == true
+      css << "border:1px solid #000" if type == "border"
+
+      sane_title = title.nil? ? "" : title.gsub(/<\/?[^>]*>/, "")
+      if type == "thumb" || type == "thumbnail" || type == "frame"
+        pre_img = '<div class="thumb t' + loc + '"><div class="thumbinner" style="width: ' + w.to_s +
+            'px;"><a href="" class="image" title="' + sane_title + '">'
+        post_img = '</a><div class="thumbcaption">' + title + '</div></div></div>'
+      end
+      "#{pre_img}<img src=\"#{resource}\" alt=\"#{sane_title}\" title=\"#{sane_title}\" style=\"#{css.join(";")}\" />#{post_img}"
+  end
+
+  def elem
+    Builder::XmlMarkup.new
+  end
+
+end
+
+end

data/lib/wikicloth.rb

@@ -0,0 +1,5 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "core_ext")
+require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_cloth")
+require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_buffer")
+require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_link_handler")
+String.send(:include, ExtendedString)

data/run_tests.rb

@@ -0,0 +1,48 @@
+require 'init'
+include WikiCloth
+
+class CustomLinkHandler < WikiLinkHandler
+  def include_resource(resource,options=[])
+    case resource
+    when "date"
+      Time.now.to_s
+    else
+      # default behavior
+      super(resource,options)
+    end
+  end
+  def url_for(page)
+    "javascript:alert('You clicked on: #{page}');"
+  end
+  def link_attributes_for(page)
+     { :href => url_for(page) }
+  end
+end
+@wiki = WikiCloth::WikiCloth.new({ 
+  :data => "<nowiki>{{test}}</nowiki> ''Hello {{test}}!''\n",
+  :params => { "test" => "World" } })
+puts @wiki.to_html
+@wiki = WikiCloth::WikiCloth.new({ 
+  :params => { "PAGENAME" => "Testing123" }, 
+  :link_handler => CustomLinkHandler.new, 
+  :data => "\n[[Hello World]] From {{ PAGENAME }} on {{ date }}\n" 
+})
+puts @wiki.to_html
+
+Dir.glob("sample_documents/*.wiki").each do |x|
+
+  start_time = Time.now
+  out_name = "#{x}.html"
+  data = File.open(x) { |x| x.read }
+
+  tmp = WikiCloth::WikiCloth.new()
+  tmp.load(data, { "PAGENAME" => "HelloWorld" })
+  out = tmp.render({ :output => :html })
+  out = "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\" dir=\"ltr\"><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" /><link rel=\"stylesheet\" href=\"default.css\" type=\"text/css\" /></head><body>#{out}</body></html>"
+
+  File.open(out_name, "w") { |x| x.write(out) }
+  end_time = Time.now
+  puts "#{out_name}: Completed (#{end_time - start_time} sec) | External Links: #{tmp.link_handler.external_links.size} -- References: #{tmp.link_handler.references.size}"
+
+end
+