wikicloth 0.7.1 → 0.8.0

data/lib/wikicloth/extensions/math.rb

@@ -0,0 +1,39 @@
+module WikiCloth
+  class MathExtension < Extension
+
+    # <math>latex markup</math>
+    #
+    element 'math', :skip_html => true, :run_globals => false do |buffer|
+
+      blahtex_path = @options[:blahtex_path] || '/usr/bin/blahtex'
+      blahtex_png_path = @options[:blahtex_png_path] || '/tmp'
+      blahtex_options = @options[:blahtex_options] || '--texvc-compatible-commands --mathml-version-1-fonts --disallow-plane-1 --spacing strict'
+
+      if File.exists?(blahtex_path) && @options[:math_formatter] != :google
+        begin
+          # pass tex markup to blahtex
+          response = `echo '#{buffer.element_content}' | #{blahtex_path} #{blahtex_options} --png --mathml --png-directory #{blahtex_png_path}`
+          xml_response = REXML::Document.new(response).root
+
+          if @options[:blahtex_html_prefix]
+            # render as embedded image
+            file_md5 = xml_response.elements["png/md5"].text
+            "<img src=\"#{File.join(@options[:blahtex_html_prefix],"#{file_md5}.png")}\" />"
+          else
+            # render as mathml
+            html = xml_response.elements["mathml/markup"].text
+            "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">#{xml_response.elements["mathml/markup"].children.to_s}</math>"
+          end
+        rescue => err
+          # blahtex error
+          "<span class=\"error\">#{I18n.t("unable to parse mathml", :error => err)}</span>"
+        end
+      else
+        # if blahtex does not exist fallback to google charts api
+        encoded_string = URI.escape(buffer.element_content, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        "<img src=\"https://chart.googleapis.com/chart?cht=tx&chl=#{encoded_string}\" />"
+      end
+    end
+
+  end
+end

data/lib/wikicloth/extensions/poem.rb

@@ -0,0 +1,15 @@
+module WikiCloth
+  class PoemExtension < Extension
+
+    # <poem>poem content (to preserve spacing)</poem>
+    #
+    element 'poem' do |buffer|
+      buffer.element_content.gsub!(/\A\n/,"") # remove new line at beginning of string
+      buffer.element_content.gsub!(/\n\z/,"") # remove new line at end of string
+      buffer.element_content.gsub!(/^\s+/) { |m| "&nbsp;" * m.length } # replace all spaces at beginning of line with &nbsp;
+      buffer.element_content.gsub!(/\n/,'<br />') # replace all new lines with <br />
+      "<div class=\"poem\">#{buffer.element_content}</div>"
+    end
+
+  end
+end

data/lib/wikicloth/extensions/references.rb

@@ -0,0 +1,48 @@
+module WikiCloth
+  class ReferencesExtension < Extension
+
+    # <ref>reference content</ref>
+    # <ref name="named">reference content</ref>
+    # <ref name="named" />
+    # <ref group="group_name">reference content</ref>
+    #
+    element 'ref' do |buffer|
+      # find our named reference reference if it exists
+      named_ref = buffer.get_attribute_by_name("name")
+      ref = @options[:link_handler].find_reference_by_name(named_ref) unless named_ref.nil?
+
+      # reference either not "named" or first time in document
+      if ref.nil?
+        @options[:link_handler].references << { :name => named_ref, :value => buffer.element_content, :count => 0, :group => buffer.get_attribute_by_name("group") }
+        ref = @options[:link_handler].references.last
+      end
+
+      ref_id = (named_ref.nil? ? "" : "#{named_ref}_") + "#{@options[:link_handler].reference_index(ref)}-#{ref[:count]}"
+      cite_anchor = "#cite_note-" + (named_ref.nil? ? "" : "#{named_ref}_") + @options[:link_handler].reference_index(ref).to_s
+      group_label = buffer.get_attribute_by_name("group") ? "#{buffer.get_attribute_by_name("group")} " : ""
+      ref_link = "<a href=\"#{cite_anchor}\">#{@options[:link_handler].reference_index(ref)}</a>"
+      ref[:count] += 1
+
+      "<sup class=\"reference\" id=\"cite_ref-#{ref_id}\">[#{group_label}#{ref_link}]</sup>"
+    end
+
+    # <references />
+    # <references group="group_name" />
+    #
+    element 'references' do |buffer|
+      ref_count = 0
+      group_match = buffer.get_attribute_by_name("group")
+      refs = @options[:link_handler].references.collect { |r|
+        next if r[:group] != group_match
+        ref_count += 1
+        ref_name = (r[:name].nil? ? "" : r[:name].to_slug + "_")
+        ret = "<li id=\"cite_note-#{ref_name}#{ref_count}\"><b>"
+        1.upto(r[:count]) { |x| ret += "<a href=\"#cite_ref-#{ref_name}#{ref_count}-#{x-1}\">" +
+                (r[:count] == 1 ? "^" : (x-1).to_s(26).tr('0-9a-p', 'a-z')) + "</a> " }
+        ret += "</b> #{r[:value]}</li>"
+      }.to_s
+      "<ol>#{refs}</ol>"
+    end
+
+  end
+end

data/lib/wikicloth/extensions/source.rb

@@ -0,0 +1,46 @@
+module WikiCloth
+  class LuaExtension < Extension
+
+    VALID_LANGUAGES = [ 'as','applescript','arm','asp','asm','awk','bat','bibtex','bbcode','bison','lua',
+      'bms','boo','c','c++','cc','cpp','cxx','h','hh','hpp','hxx','clojure','cbl','cob','cobol','cfc','cfm',
+      'coldfusion','csharp','cs','css','d','diff','patch','erlang','erl','hrl','go','hs','haskell','html',
+      'htm','xml','xhtml','httpd','js','javascript','matlab','m','perl','cgi','pl','plex','plx','pm','php',
+      'php3','php4','php5','php6','python','py','ruby','rb' ]
+
+    # <source lang="language">source code</source>
+    #
+    element 'source', :skip_html => true, :run_globals => false do |buffer|
+
+      highlight_path = @options[:highlight_path] || '/usr/bin/highlight'
+      highlight_options = @options[:highlight_options] || '--inline-css'
+
+      name = buffer.element_name
+      content = buffer.element_content
+      content = $1 if content =~ /^\s*\n(.*)$/m
+      error = nil
+
+      if File.exists?(highlight_path)
+        begin
+          raise I18n.t("lang attribute is required") unless buffer.element_attributes.has_key?('lang')
+          raise I18n.t("unknown lang", :lang => buffer.element_attributes['lang'].downcase) unless LuaExtension::VALID_LANGUAGES.include?(buffer.element_attributes['lang'].downcase)
+          IO.popen("#{highlight_path} #{highlight_options} -f --syntax #{buffer.element_attributes['lang'].downcase}", "r+") do |io|
+            io.puts content
+            io.close_write
+            content = io.read
+          end
+        rescue => err
+          error = "<span class=\"error\">#{err.message}</span>"
+        end
+      else
+        content = content.gsub('<','&lt;').gsub('>','&gt;')
+      end
+
+      if error.nil?
+        "<pre>#{content}</pre>"
+      else
+        error
+      end
+    end
+
+  end
+end

data/lib/wikicloth/i18n.rb

@@ -0,0 +1,108 @@
+require 'yaml'
+module I18n
+
+  class << self
+
+    def default_locale
+      :en
+    end
+
+    def locale
+      @@locale ||= default_locale
+    end
+
+    def locale=(val)
+      @@locale = val
+    end
+
+    def t(*args)
+      options  = args.last.is_a?(Hash) ? args.pop : {}
+      key      = args.shift
+
+      load_translations
+      use_locale = @@translations[locale].nil? || @@translations[locale].empty? ? default_locale : locale
+
+      if @@translations[use_locale].has_key?(key)
+        add_vars(@@translations[use_locale][key], options)
+      elsif use_locale != default_locale && @@translations[default_locale].has_key?(key)
+        add_vars(@@translations[default_locale][key], options)
+      else
+        "translation missing: #{locale}, #{key}"
+      end
+    end
+
+    def available_locales
+      load_translations
+      @@available_locales
+    end
+
+    def load_path
+      @@load_paths ||= []
+    end
+
+    def load_path=(val)
+      @@load_paths = val
+    end
+
+    def load_translations
+      return if initialized?
+
+      @@available_locales = []
+      @@translations = {}
+      load_path.each do |path|
+        Dir[path].each do |file| 
+          begin
+            data = YAML::load(File.read(file))
+            data.each do |key,value|
+              @@available_locales << key.to_sym unless @@available_locales.include?(key.to_sym)
+              @@translations[key.to_sym] ||= {}
+              import_values(key.to_sym,value)
+            end
+          rescue ArgumentError => err
+            puts "error in #{file}: #{err.message}"
+          end
+        end
+      end
+
+      initialized!
+    end
+
+    def initialized?
+      @@initialized ||= false
+    end
+
+    def initialized!
+      @@initialized = true
+    end
+
+    # Executes block with given I18n.locale set.
+    def with_locale(tmp_locale = nil)
+      if tmp_locale
+        current_locale = self.locale
+        self.locale    = tmp_locale
+      end
+      yield
+    ensure
+      self.locale = current_locale if tmp_locale
+    end
+
+    private
+    def import_values(key,values,prefix=[])
+      values.each do |k,value|
+        if value.is_a?(Hash)
+          import_values(key,value,prefix+[k])
+        else
+          @@translations[key.to_sym][(prefix+[k]).join(".")] = value
+        end
+      end
+    end
+
+    def add_vars(string, options)
+      options.each do |key,value|
+        string.gsub!(/(%\{#{key}\})/, value.to_s)
+      end
+      string
+    end
+  end
+
+end

data/lib/wikicloth/namespaces.rb

@@ -0,0 +1,62 @@
+module WikiCloth
+
+  class WikiNamespaces
+  class << self
+
+    NAMESPACE_TYPES = [:file,:category,:template,:special,:language,:help,:talk,:media]
+
+    def language_namespace_names
+      I18n.available_locales.collect { |l| l.to_s.gsub(/[_]+/,'-') }
+    end
+
+    def language_name(ns, locale=nil)
+      return nil unless language_namespace_names.include?(ns)
+      locale ||= I18n.locale
+      I18n.with_locale(locale) do
+        I18n.t("languages.#{ns}")
+      end
+    end
+
+    def localise_ns(name, locale=nil)
+      locale ||= I18n.locale
+      ns_type = namespace_type(name)
+      unless ns_type.nil? || ns_type == :language
+        I18n.with_locale(locale) do
+          I18n.t("namespaces.#{ns_type.to_s}").split(",").first
+        end
+      else
+        name
+      end
+    end
+
+    def namespace_type(name)
+      return :language if language_namespace_names.include?(name)
+      NAMESPACE_TYPES.each { |ns| return ns if send("#{ns}_namespace_names").include?(name.downcase) }
+      nil
+    end
+
+    def method_missing(method, *args)
+      if method.to_s =~ /^([a-z]+)_namespace_names$/
+        @@ns_cache ||= {}
+        @@ns_cache[$1] ||= get_namespace_names_for($1) 
+      elsif method.to_s =~ /^([a-z]+)_namespace\?$/
+        namespace_type(args.first) == $1.to_sym ? true : false
+      else
+        super(method, *args)
+      end
+    end
+
+    def get_namespace_names_for(name)
+      ret = []
+      I18n.available_locales.each do |locale|
+        I18n.with_locale(locale) do
+          I18n.t("namespaces.#{name}").split(",").each { |ns| ret << ns.downcase unless ret.include?(ns.downcase) }
+        end
+      end
+      ret
+    end
+
+  end
+  end
+
+end

data/lib/wikicloth/parser.rb

@@ -2,16 +2,16 @@ module WikiCloth
 
   class Parser < WikiLinkHandler
 
-    def initialize(opt={})
-      opt.each { |k,v|
+    def initialize(options={})
+      options.each { |k,v|
         if v.instance_of?(Proc)
           self.class.send :define_method, k.to_sym do |*args|
             self.instance_exec(args,&v)
           end
         end
       }
-      @params = opt[:params] || {}
-      @wikicloth = WikiCloth.new(:data => opt[:data], :link_handler => self, :params => @params)
+      @options = { :link_handler => self, :params => {} }.merge(options)
+      @wikicloth = WikiCloth.new(@options)
     end
 
     class << self
@@ -22,8 +22,8 @@ module WikiCloth
       end
 
       def toc(&block)
-        self.send :define_method, 'toc' do |sections|
-          self.instance_exec(sections, &block)
+        self.send :define_method, 'toc' do |sections, numbered|
+          self.instance_exec(sections, numbered, &block)
         end
       end
 
@@ -76,12 +76,26 @@ module WikiCloth
 	  self.instance_exec(page,&block)
 	end
       end
+
+      def cache(&block)
+        self.send :define_method, 'cache' do |item|
+          self.instance_exec(item,&block)
+        end
+      end
+    end
+
+    def method_missing(method, *args)
+      if @wikicloth.respond_to?(method)
+        @wikicloth.send(method, *args)
+      else
+        super(method, *args)
+      end
     end
 
     # Replace a section, along with any sub-section in the document
     def put_section(id,data)
       data = @wikicloth.sections.collect { |s| s.wikitext({ :replace => { id => data.last(1) == "\n" ? data : "#{data}\n" } }) }.join
-      @wikicloth = WikiCloth.new(:data => data, :link_handler => self, :params => @params)
+      @wikicloth = WikiCloth.new(:data => data, :link_handler => self, :params => @options[:params])
     end
 
     # Get the section, along with any sub-section of the document
@@ -89,14 +103,6 @@ module WikiCloth
       @wikicloth.sections.collect { |s| s.get_section(id) }.join
     end
 
-    def sections
-      @wikicloth.sections
-    end
-
-    def to_html(opts = {})
-      @wikicloth.to_html(opts)
-    end
-
     def to_wiki
       to_wikitext
     end

data/lib/wikicloth/section.rb

@@ -72,12 +72,8 @@ module WikiCloth
       if self.title.nil?
         ret = ""
       else
-        ret = "<h#{self.depth}>" + (options[:noedit] == true ? "" :
-          "<span class=\"editsection\">&#91;<a href=\"" + options[:link_handler].section_link(self.id) +
-          "\" title=\"Edit section: #{self.title}\">edit</a>&#93;</span> ") +
-          "<span id=\"#{self.id}\" class=\"mw-headline\"><a name=\"#{self.id}\">#{self.title}</a></span></h#{self.depth}>\n"
+        ret = "\n#{@title}\n"
       end
-      #ret += @template ? self.gsub(/\{\{\{\s*([A-Za-z0-9]+)\s*\}\}\}/,'\1') : self
       ret += self
       ret += "__TOC__" if @auto_toc
       ret += @children.collect { |c| c.render(options) } .join

data/lib/wikicloth/version.rb

@@ -1,3 +1,3 @@
 module WikiCloth
-  VERSION = "0.7.1" unless defined?(::WikiCloth::VERSION)
+  VERSION = "0.8.0" unless defined?(::WikiCloth::VERSION)
 end

data/lib/wikicloth/wiki_buffer.rb

@@ -63,7 +63,7 @@ class WikiBuffer
     @buffer_type
   end
 
-  def to_s
+  def to_html
     self.params.join("\n") + (@list_data.empty? ? "" : render_list_data()) + (@paragraph_open ? "</p>" : "")
   end
 
@@ -138,7 +138,7 @@ class WikiBuffer
       while @buffers.size > 1
         @buffers[-1].eof()
         tmp = @buffers.pop
-        @buffers[-1].data += tmp.to_s
+        @buffers[-1].data += tmp.send("to_#{@options[:output]}")
         unless tmp.data.blank?
           tmp.data.each_char { |x| self.add_char(x) }
         end
@@ -158,9 +158,9 @@ class WikiBuffer
         return self.new_char()
       when @buffers[-1].add_char(c) == false && self.class == WikiBuffer
         tmp = @buffers.pop
-        @buffers[-1].data += tmp.to_s
+        @buffers[-1].data += tmp.send("to_#{@options[:output]}")
         # any data left in the buffer we feed into the parent
-        unless tmp.data.blank?
+        unless tmp.data.nil?
           tmp.data.each_char { |x| self.add_char(x) }
         end
       end
@@ -178,11 +178,15 @@ class WikiBuffer
         self.data.gsub!(/_([^_]+)_/,"<u>\\1</u>")
       end
 
-      # Magic Words
-      self.data.gsub!(/__([A-Z]+)__/) { |r|
-        case $1
-        when "TOC"
+      # Behavior Switches
+      self.data.gsub!(/__([\w]+)__/) { |r|
+        case behavior_switch_key_name($1)
+        when "behavior_switches.toc"
           @options[:link_handler].toc(@options[:sections], @options[:toc_numbered])
+        when "behavior_switches.noeditsection"
+          @options[:noedit] = true
+        when "behavior_switches.editsection"
+          @options[:noedit] = false
         else
           ""
         end
@@ -191,14 +195,7 @@ class WikiBuffer
       # Horizontal Rule
       self.data.gsub!(/^([-]{4,})/) { |r| "<hr />" }
 
-      # Bold, Italic
-      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
-      }
+      render_bold_italic()
 
       # Lists
       tmp = ''
@@ -218,7 +215,7 @@ class WikiBuffer
       is_heading = false
       self.data.gsub!(/^([=]{1,6})\s*(.*?)\s*(\1)/) { |r|
         is_heading = true
-        (@paragraph_open ? "</p>" : "") + "<h#{$1.length}>#{$2}</h#{$1.length}>"
+        (@paragraph_open ? "</p>" : "") + gen_heading($1.length,$2)
       }
 
       # Paragraphs
@@ -238,11 +235,43 @@ class WikiBuffer
       self.params << self.data.auto_link
       self.data = ""
     else
-      self.data += current_char
+      self.data << current_char
     end
     return true
   end
 
+  def behavior_switch_key_name(name)
+    keys = [:toc,:notoc,:forcetoc,:noeditsection,:editsection]
+    locales = [@options[:locale],I18n.default_locale]
+    values = {}
+
+    locales.each do |locale|
+      I18n.with_locale(locale) do
+        keys.each do |key|
+          values[I18n.t("behavior_switches.#{key.to_s}")] = "behavior_switches.#{key.to_s}"
+        end
+      end
+    end
+
+    values[name]
+  end
+
+  def gen_heading(hnum,title)
+    id = get_id_for(title.gsub(/\s+/,'_'))
+    "<h#{hnum}>" + (@options[:noedit] == true ? "" :
+      "<span class=\"editsection\">&#91;<a href=\"" + @options[:link_handler].section_link(id) +
+      "\" title=\"#{I18n.t('edit section', :name => title)}\">#{I18n.t('edit')}</a>&#93;</span> ") +
+      "<span class=\"mw-headline\" id=\"#{id}\"><a name=\"#{id}\">#{title}</a></span></h#{hnum}>\n"
+  end
+
+  def get_id_for(val)
+    val.gsub!(/[^A-Za-z0-9_]+/,'')
+    @idmap ||= {}
+    @idmap[val] ||= 0
+    @idmap[val] += 1
+    @idmap[val] == 1 ? val : "#{val}-#{@idmap[val]}"
+  end
+
   def name_current_param()
     params[-1] = { :value => "", :name => params[-1] } unless params[-1].kind_of?(Hash) || params[-1].nil?
   end
@@ -291,35 +320,116 @@ class WikiBuffer
     @current_line ||= ""
   end
 
+  BOLD_ITALIC_MAP = {
+        0 => {
+          :bold        => [10, "<b>"],
+          :italic      => [20, "<i>"],
+          :bold_italic => [40, "<i><b>"],
+          :four        => [10, "'<b>"],
+          :finish      => [0, ""]
+        },
+        10 => {
+          :bold        => [0, "</b>"],
+          :italic      => [30, "<i>"],
+          :bold_italic => [20, "</b><i>"],
+          :four        => [0, "'</b>"],
+          :finish      => [0, "</b>"]
+        },
+        20 => {
+          :bold        => [40, "<b>"],
+          :italic      => [0, "</i>"],
+          :bold_italic => [10, "</i><b>"],
+          :four        => [40, "'<b>"],
+          :finish      => [0, "</i>"]
+        },
+        30 => {
+          :bold        => [20, "</i></b><i>"],
+          :italic      => [10, "</i>"],
+          :bold_italic => [0, "</i></b>"],
+          :four        => [20, "'</i></b><i>"],
+          :finish      => [0, "</i></b>"]
+        },
+        40 => {
+          :bold        => [20, "</b>"],
+          :italic      => [10, "</b></i><b>"],
+          :bold_italic => [0, "</b></i>"],
+          :four        => [20, "'</b>"],
+          :finish      => [0, "</b></i>"]
+          },
+      }
+
+  def render_bold_italic()
+
+    commands = []
+    self.data.scan(/([\']{2,5})/) do
+        commands << {
+          :len => $1.length,
+          :type => [nil, nil, :italic, :bold, :four, :bold_italic][$1.length],
+          :pos => $~.offset(0).first
+        }
+      end
+    commands << {:type => :finish}
+
+    state = 0
+    commands.each do |c|
+        trans = BOLD_ITALIC_MAP[state][c[:type]]
+        c[:output] = trans.last
+        state = trans.first
+      end
+
+    index = 0
+    self.data.gsub!(/([\']{2,5})/) do
+        output = commands[index][:output]
+        index += 1
+        output
+      end
+    self.data << commands.last[:output]
+  end
+
   def render_list_data()
+
     ret = ""
-    depth = 0
-    peices = ""
+    last = ""
 
-    @list_data.each do |l|
-      if l =~ /^([#\*:;]+)\s*(.*)$/
-        peices = $1
-        content = $2
-        if peices.length > depth
-          while peices.length > depth
-            ret += "<#{list_tag_for(peices[depth,1])}><#{list_inner_tag_for(peices[depth,1])}>"
-            depth += 1
+    process_line = Proc.new do |pieces, content|
+
+        common = 0
+        (0..last.length - 1).each do |i|
+          if last[i] == pieces[i]
+            common += 1
+          else
+            break
           end
-        elsif peices.length == depth
-          ret += "</#{list_inner_tag_for(peices[depth-1,1])}><#{list_inner_tag_for(peices[depth-1,1])}>"
-        else
-          while peices.length < depth
-            depth -= 1
-            ret += "</#{list_inner_tag_for(peices[depth-1,1])}></#{list_tag_for(peices[depth-1,1])}><#{list_inner_tag_for(peices[depth-1,1])}>"
+        end
+
+        close = last[common..-1].reverse
+        open = pieces[common..-1]
+
+        close.each_char do |e|
+          ret << "</#{list_inner_tag_for(e)}></#{list_tag_for(e)}>"
+        end
+        if open == '' && pieces != ''
+          if last != ''
+            ret << "</#{list_inner_tag_for(pieces[-1,1])}>"
           end
+          ret << "<#{list_inner_tag_for(pieces[-1,1])}>"
+        end
+        open.each_char do |e|
+          ret << "<#{list_tag_for(e)}><#{list_inner_tag_for(e)}>"
         end
-        ret += "#{content}"
+        
+        ret << content
+
+        last = pieces.clone
+      end
+
+    (@list_data + ['']).each do |l|
+      if l =~ /^([#\*:;]+)\s*(.*)$/
+        process_line.call($1, $2)
       end
     end
-    while depth > 0
-      depth -= 1
-      ret += "</#{list_inner_tag_for(peices[depth,1])}></#{list_tag_for(peices[depth,1])}>"
-    end
+    process_line.call('', '')
+
     @list_data = []
     ret + "\n"
   end
@@ -350,3 +460,5 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "wiki_buffer", "html
 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")
+# load all extensions
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), "extensions/*.rb")].each { |r| require r }