wikicloth 0.2.0 → 0.5.0

data/Rakefile

@@ -2,6 +2,7 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
+require 'init'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -25,7 +26,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name = "wikicloth"
-  s.version = %q{0.2.0}
+  s.version = WikiCloth::VERSION
   s.author = "David Ricciardi"
   s.email = "nricciar@gmail.com"
   s.homepage = "http://github.com/nricciar/wikicloth"
@@ -41,6 +42,7 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README","MIT-LICENSE"]
   s.description = %q{mediawiki parser}
   s.add_dependency 'builder'
+  s.add_dependency 'expression_parser'
 end
 Rake::GemPackageTask.new(spec) do |pkg|
     pkg.need_tar = true

data/lib/wikicloth/calc.citrus

@@ -0,0 +1,133 @@
+# A grammar for mathematical formulas that apply basic mathematical operations
+# to all numbers, respecting operator precedence and grouping of expressions
+# while ignoring whitespace.
+#
+# An identical grammar that is written using pure Ruby can be found in calc.rb.
+grammar Calc
+
+  ## Hierarchy
+
+  rule term
+    additive | factor
+  end
+
+  rule additive
+    (factor additive_operator term) {
+      def value
+        additive_operator.apply(factor.value, term.value)
+      end
+    }
+  end
+
+  rule factor
+    multiplicative | prefix
+  end
+
+  rule multiplicative
+    (prefix multiplicative_operator factor) {
+      def value
+        multiplicative_operator.apply(prefix.value, factor.value)
+      end
+    }
+  end
+
+  rule prefix
+    prefixed | exponent
+  end
+
+  rule prefixed
+    (unary_operator prefix) {
+      def value
+        unary_operator.apply(prefix.value)
+      end
+    }
+  end
+
+  rule exponent
+    exponential | primary
+  end
+
+  rule exponential
+    (primary exponential_operator exponent) {
+      def value
+        exponential_operator.apply(primary.value, exponent.value)
+      end
+    }
+  end
+
+  rule primary
+    group | number
+  end
+
+  rule group
+    (lparen term rparen) {
+      def value
+        term.value
+      end
+    }
+  end
+
+  ## Syntax
+
+  rule number
+    float | integer
+  end
+
+  rule float
+    (digits '.' digits space) {
+      def value
+        text.strip.to_f
+      end
+    }
+  end
+
+  rule integer
+    (digits space) {
+      def value
+        text.strip.to_i
+      end
+    }
+  end
+
+  rule digits
+    [0-9]+ ('_' [0-9]+)*
+  end
+
+  rule additive_operator
+    (('+' | '-') space) {
+      def apply(n1, n2)
+        n1.send(text.strip, n2)
+      end
+    }
+  end
+
+  rule multiplicative_operator
+    (('*' | '/' | '%') space) {
+      def apply(n1, n2)
+        n1.send(text.strip, n2)
+      end
+    }
+  end
+
+  rule exponential_operator
+    ('**' space) {
+      def apply(n1, n2)
+        n1 ** n2
+      end
+    }
+  end
+
+  rule unary_operator
+    (('~' | '+' | '-') space) {
+      def apply(n)
+        op = text.strip
+        # Unary + and - require an @.
+        n.send(op == '~' ? op : '%s@' % op)
+      end
+    }
+  end
+
+  rule lparen '(' space end
+  rule rparen ')' space end
+  rule space [ \t\n\r]* end
+end

data/lib/wikicloth/core_ext.rb

@@ -19,6 +19,14 @@ class Object
   end
 end
 
+module Math
+  def self.eval(expression)
+    allowed_characters = Regexp.escape('+-*/.() ')
+    safe_expression = expression.match(/[\d#{allowed_characters}]*/).to_s
+    Kernel.eval(safe_expression)
+  end
+end
+
 module ExtendedString
 
   def blank?
@@ -37,6 +45,10 @@ module ExtendedString
     to_s
   end
 
+  def last(n)
+    self[-n,n]
+  end
+
   def dump()
     ret = to_s
     delete!(to_s)

data/lib/wikicloth/math.rb

@@ -0,0 +1,155 @@
+# The following code taken from http://lukaszwrobel.pl/blog/math-parser-part-3-implementation
+module WikiCloth
+
+class Token
+  Plus     = 0
+  Minus    = 1
+  Multiply = 2
+  Divide   = 3
+  
+  Number   = 4
+  
+  LParen   = 5
+  RParen   = 6
+  
+  End      = 7
+  
+  attr_accessor :kind
+  attr_accessor :value
+  
+  def initialize
+    @kind = nil
+    @value = nil
+  end
+
+  def unknown?
+    @kind.nil?
+  end
+end
+
+class Lexer
+  def initialize(input)
+    @input = input
+    @return_previous_token = false
+  end
+  
+  def get_next_token
+    if @return_previous_token
+      @return_previous_token = false
+      return @previous_token
+    end
+    
+    token = Token.new
+    
+    @input.lstrip!
+
+    case @input
+      when /\A\+/ then
+        token.kind = Token::Plus
+      when /\A-/ then
+        token.kind = Token::Minus
+      when /\A\*/ then
+        token.kind = Token::Multiply
+      when /\A\// then
+        token.kind = Token::Divide
+      when /\A\d+(\.\d+)?/
+        token.kind = Token::Number
+        token.value = $&.to_f
+      when /\A\(/
+        token.kind = Token::LParen
+      when /\A\)/
+        token.kind = Token::RParen
+      when ''
+        token.kind = Token::End
+    end
+    
+    raise 'Unknown token' if token.unknown?
+    @input = $'
+
+    @previous_token = token
+    token
+  end
+  
+  def revert
+    @return_previous_token = true
+  end
+end
+
+class MathParser
+  def parse(input)
+    @lexer = Lexer.new(input)
+    
+    expression_value = expression
+
+    token = @lexer.get_next_token
+    if token.kind == Token::End
+      expression_value
+    else
+      raise 'End expected'
+    end
+  end
+  
+  protected
+  def expression
+    component1 = factor
+
+    additive_operators = [Token::Plus, Token::Minus]
+
+    token = @lexer.get_next_token
+    while additive_operators.include?(token.kind)
+      component2 = factor
+      
+      if token.kind == Token::Plus
+        component1 += component2
+      else
+        component1 -= component2
+      end
+
+      token = @lexer.get_next_token
+    end
+    @lexer.revert
+
+    component1
+  end
+  
+  def factor
+    factor1 = number
+    
+    multiplicative_operators = [Token::Multiply, Token::Divide]
+    
+    token = @lexer.get_next_token
+    while multiplicative_operators.include?(token.kind)
+      factor2 = number
+      
+      if token.kind == Token::Multiply
+        factor1 *= factor2
+      else
+        factor1 /= factor2
+      end
+      
+      token = @lexer.get_next_token
+    end
+    @lexer.revert
+
+    factor1
+  end
+    
+  def number
+    token = @lexer.get_next_token
+    
+    if token.kind == Token::LParen
+      value = expression
+      
+      expected_rparen = @lexer.get_next_token
+      raise 'Unbalanced parenthesis' unless expected_rparen.kind == Token::RParen
+    elsif token.kind == Token::Number
+      value = token.value
+    else
+      raise 'Not a number'
+    end
+    
+    value
+  end
+end
+
+end

data/lib/wikicloth/parser.rb

@@ -46,6 +46,12 @@ module WikiCloth
 	end
       end
 
+      def template(&block)
+        self.send :define_method, 'template' do |template|
+          self.instance_exec(template,&block)
+        end
+      end
+
       def link_for_resource(&block)
 	self.send :define_method, 'link_for_resource' do |prefix,resource,options|
 	  options ||= []
@@ -59,12 +65,6 @@ module WikiCloth
         end
       end
 
-      def template(&block)
-        self.send :define_method, 'template' do |template|
-          self.instance_exec(template,&block)
-        end
-      end
-
       def link_for(&block)
 	self.send :define_method, 'link_for' do |page,text|
 	  self.instance_exec(page,text,&block)
@@ -80,7 +80,7 @@ module WikiCloth
 
     # Replace a section, along with any sub-section in the document
     def put_section(id,data)
-      data = @wikicloth.sections.first.wikitext({ :replace => { id => data } })
+      data = @wikicloth.sections.first.wikitext({ :replace => { id => data.last(1) == "\n" ? data : "#{data}\n" } })
       @wikicloth = WikiCloth.new(:data => data, :link_handler => self, :params => @params)
     end
 

data/lib/wikicloth/section.rb

@@ -20,6 +20,10 @@ module WikiCloth
       @auto_toc = val
     end
 
+    def template=(val)
+      @template = val
+    end
+
     def title=(val)
       if val =~ /^([=]{1,6})\s*(.*?)\s*(\1)/
         @depth = $1.length
@@ -71,7 +75,7 @@ module WikiCloth
           "\" title=\"Edit section: #{self.title}\">edit</a>&#93;</span>") +
           " <span id=\"#{self.id}\" class=\"mw-headline\">#{self.title}</span></h#{self.depth}>"
       end
-      ret += self
+      ret += @template ? self.gsub(/\{\{\{\s*([A-Za-z0-9]+)\s*\}\}\}/,'\1') : self
       ret += "__TOC__" if @auto_toc
       ret += @children.collect { |c| c.render(options) } .join
       ret

data/lib/wikicloth/wiki_buffer/template.rb

@@ -0,0 +1,32 @@
+module WikiCloth
+
+class WikiBuffer::Template < WikiBuffer
+
+  def initialize(data="",options={})
+    super(data,options)
+    @in_quotes = false
+  end
+
+  def to_s
+    "WICKED COOL"
+  end
+
+  protected
+  def new_char()
+    case
+    # End of a template, variable, or function
+    when current_char == '}' && previous_char == '}'
+      puts "TEMP: #{self.data} ----"
+      self.data = ""
+      return false
+
+    else
+      self.data += current_char
+    end
+
+    return true
+  end
+
+end
+
+end

data/lib/wikicloth/wiki_buffer/var.rb

@@ -1,3 +1,5 @@
+require 'expression_parser'
+
 module WikiCloth
 
 class WikiBuffer::Var < WikiBuffer
@@ -18,17 +20,83 @@ class WikiBuffer::Var < WikiBuffer
 
   def to_s
     if self.is_function?
-#      ret = "#{buffer_type}"
-#      ret += " function #{function_name}"
-#      ret += "(#{params.inspect})"
-#      ret += " [#{data}]"
-      ret = @options[:link_handler].function(function_name, params.collect { |p| p.strip })
+      ret = default_functions(function_name,params.collect { |p| p.strip })
+      ret ||= @options[:link_handler].function(function_name, params.collect { |p| p.strip })
+      ret.to_s
     else
       ret = @options[:link_handler].include_resource("#{params[0]}".strip,params[1..-1])
+      # template params
+      ret = ret.to_s.gsub(/\{\{\{\s*([A-Za-z0-9]+)+(|\|+([^}]+))\s*\}\}\}/) { |match| get_param($1.strip,$3.to_s.strip) }
+      # put template at beginning of buffer
+      self.data = ret
+      ""
+    end
+  end
+
+  def get_param(name,default=nil)
+    ret = nil
+    # numbered params
+    if name =~ /^[0-9]+$/
+      ret = self.params[name.to_i].instance_of?(Hash) ? self.params[name.to_i][:value] : self.params[name.to_i]
+    end
+    # named params
+    self.params.each do |param|
+      ret = param[:value] if param[:name] == name
+    end
+    ret.nil? ? default : ret
+  end
+
+  def default_functions(name,params)
+    case name
+    when "#if"
+      params.first.blank? ? params[2] : params[1]
+    when "#switch"
+      params.length.times do |i|
+        temp = params[i].split("=")
+        return temp[1].strip if temp[0].strip == params[0] && i != 0
+      end
+      return ""
+    when "#expr"
+      begin
+        ExpressionParser::Parser.new.parse(params.first)
+      rescue RuntimeError
+        'Expression error: ' + $!
+      end
+    when "#ifeq"
+      if params[0] =~ /^[0-9A-Fa-f]+$/ && params[1] =~ /^[0-9A-Fa-f]+$/
+        params[0].to_i == params[1].to_i ? params[2] : params[3]
+      else
+        params[0] == params[1] ? params[2] : params[3]
+      end
+    when "#len"
+      params.first.length
+    when "#sub"
+      params.first[params[1].to_i,params[2].to_i]
+    when "#pad"
+      case params[3]
+      when "right"
+        params[0].ljust(params[1].to_i,params[2])
+      when "center"
+        params[0].center(params[1].to_i,params[2])
+      else
+        params[0].rjust(params[1].to_i,params[2])
+      end
+    when "#iferror"
+      params.first =~ /error/ ? params[1] : params[2]
+    when "#capture"
+      @options[:params][params.first] = params[1]
+      ""
+    when "lc"
+      params.first.downcase
+    when "uc"
+      params.first.upcase
+    when "ucfirst"
+      params.first.capitalize
+    when "lcfirst"
+      params.first[0,1].downcase + params.first[1,-1]
+    when "plural"
+      params.first.to_i > 1 ? params[1] : params[2]
     end
-#    ret ||= "<!-- TEMPLATE[#{params[0]}] NOT FOUND -->"
-    ret ||= ""
-    ret
   end
 
   def is_function?
@@ -54,7 +122,7 @@ class WikiBuffer::Var < WikiBuffer
 
     # Dealing with variable names within functions
     # and variables
-    when current_char == '=' && @in_quotes == false
+    when current_char == '=' && @in_quotes == false && !is_function?
       self.current_param = self.data
       self.data = ""
       self.name_current_param()

data/lib/wikicloth/wiki_link_handler.rb

@@ -18,10 +18,7 @@ class WikiLinkHandler
   end
 
   def function(name, params)
-    case name
-    when "#if"
-      params.first.blank? ? params[2] : params[1]
-    end
+    nil
   end
 
   def toc_children(children)
@@ -44,10 +41,6 @@ class WikiLinkHandler
     "#{ret}</ul></td></tr></table>"
   end
 
-  def template(template, args)
-    nil
-  end
-
   def external_links
     @external_links ||= []
   end
@@ -94,7 +87,30 @@ class WikiLinkHandler
   end
 
   def include_resource(resource, options=[])
-    return self.params[resource] unless self.params[resource].nil?
+    if self.params.has_key?(resource)
+      self.params[resource]
+    else
+      # FIXME: hack to keep template loops from raising havoc
+      @include_count ||= 0
+      @include_count += 1
+      raise "Page reached maximum number of includes [1000] (possible template loop?)" if @include_count > 100
+
+      ret = template(resource)
+      unless ret.nil?
+        @included_templates ||= {}
+        @included_templates[resource] ||= 0
+        @included_templates[resource] += 1
+      end
+      ret
+    end
+  end
+
+  def included_templates
+    @included_templates ||= {}
+  end
+
+  def template(template)
+    nil
   end
 
   def link_for_resource(prefix, resource, options=[])

data/lib/wikicloth.rb

@@ -8,6 +8,8 @@ String.send(:include, ExtendedString)
 
 module WikiCloth
 
+  VERSION = "0.5.0"
+
   class WikiCloth
 
     def initialize(opt={})
@@ -19,6 +21,8 @@ module WikiCloth
       depth = 1
       count = 0
       root = [self.sections]
+
+      # parse wiki document into sections
       data.each_line do |line|
         if line =~ /^([=]{1,6})\s*(.*?)\s*(\1)/
           root << root.last[-1].children if $1.length > depth
@@ -30,7 +34,15 @@ module WikiCloth
           root.last[-1] << line
         end
       end
+
+      # if we find template variables assume document is
+      # a template
+      self.sections.first.template = true if data =~ /\{\{\{\s*([A-Za-z0-9]+)\s*\}\}\}/
+
+      # If there are more than four sections enable automatic
+      # table of contents
       self.sections.first.auto_toc = true unless count < 4 || data =~ /__(NO|)TOC__/
+
       self.params = p
     end
 
@@ -40,11 +52,11 @@ module WikiCloth
 
     def render(opt={})
       noedit = false
+      self.params.merge!({ 'WIKI_VERSION' => ::WikiCloth::VERSION })
       self.options = { :output => :html, :link_handler => self.link_handler, :params => self.params, :sections => self.sections }.merge(opt)
       self.options[:link_handler].params = options[:params]
       data = self.sections.first.render(self.options)
       data.gsub!(/<!--(.|\s)*?-->/,"")
-      data.gsub!(/\{\{(.*?)(\|(.*?))?\}\}/){ |match| expand_templates($1,$3,["."]) }
       buffer = WikiBuffer.new("",options)
       data.each_char { |c| buffer.add_char(c) }
       buffer.to_s
@@ -63,24 +75,6 @@ module WikiCloth
     end
 
     protected
-    def expand_templates(template, args, stack)
-      template.strip!
-      article = link_handler.template(template, args)
-
-      if article.nil?
-        data = "{{#{template}}}"
-      else
-        unless stack.include?(template)
-          data = article
-        else
-          data = "WARNING: TEMPLATE LOOP"
-        end
-        data = data.gsub(/\{\{(.*?)(?:\|(.*?))?\}\}?/){ |match| expand_templates($1, $2, stack + [template])}
-      end
-
-      data
-    end
-
     def sections=(val)
       @sections = val
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wikicloth
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 5
   - 0
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - David Ricciardi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-15 00:00:00 +00:00
+date: 2010-09-20 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: expression_parser
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: mediawiki parser
 email: nricciar@gmail.com
 executables: []
@@ -43,10 +57,13 @@ extra_rdoc_files:
 - MIT-LICENSE
 files: 
 - lib/wikicloth.rb
+- lib/wikicloth/calc.citrus
+- lib/wikicloth/math.rb
 - lib/wikicloth/core_ext.rb
 - lib/wikicloth/wiki_buffer/html_element.rb
 - lib/wikicloth/wiki_buffer/var.rb
 - lib/wikicloth/wiki_buffer/table.rb
+- lib/wikicloth/wiki_buffer/template.rb
 - lib/wikicloth/wiki_buffer/link.rb
 - lib/wikicloth/parser.rb
 - lib/wikicloth/section.rb