gollum-lib 5.0.a.3 → 5.0.a.4

data/lib/gollum-lib/macro/video.rb

@@ -0,0 +1,9 @@
+module Gollum
+  class Macro
+    class Video < Gollum::Macro
+      def render (fname)
+        "<video width=\"100%\" height=\"100%\" src=\"#{fname}\" controls=\"\"> HTML5 video is not supported on this Browser.</video>"
+      end
+    end
+  end
+end

data/lib/gollum-lib/markup.rb

@@ -57,6 +57,7 @@ module Gollum
         @formats[ext] = { :name => name,
           :extensions => new_extension,
           :reverse_links => options.fetch(:reverse_links, false),
+          :skip_filters => options.fetch(:skip_filters, nil),
           :enabled => options.fetch(:enabled, true) }
         @extensions.concat(new_extension)
       end
@@ -82,44 +83,33 @@ module Gollum
     #
     # Returns a new Gollum::Markup object, ready for rendering.
     def initialize(page)
-      if page
-        @wiki        = page.wiki
-        @name        = page.filename
-        @data        = page.text_data
-        @version     = page.version.id if page.version
-        @format      = page.format
-        @sub_page    = page.sub_page
-        @parent_page = page.parent_page
-        @page        = page
-        @dir         = ::File.dirname(page.path)
-      end
+      @wiki        = page.wiki
+      @name        = page.filename
+      @data        = page.text_data
+      @version     = page.version.id if page.version
+      @format      = page.format
+      @sub_page    = page.sub_page
+      @parent_page = page.parent_page
+      @page        = page
+      @dir         = ::File.dirname(page.path)
       @metadata    = nil
       @to_xml_opts = { :save_with => Nokogiri::XML::Node::SaveOptions::DEFAULT_XHTML ^ 1, :indent => 0, :encoding => 'UTF-8' }
     end
 
+    # Whether or not this markup's format uses reversed-order links ([description | url] rather than [url | description]). Defaults to false.
     def reverse_links?
       self.class.formats[@format][:reverse_links]
     end
 
-    # Render data using default chain in the target format.
-    #
-    # data - the data to render
-    # format - format to use as a symbol
-    # name - name using the extension of the format
-    #
-    # Returns the processed data
-    def render_default(data, format=:markdown, name='render_default.md')
-      # set instance vars so we're able to render data without a wiki or page.
-      @format = format
-      @name   = name
-
-      chain = [:YAML, :PlainText, :Emoji, :TOC, :RemoteCode, :Code, :Sanitize, :WSD, :Tags, :Render]
-
-      filter_chain = chain.map do |r|
-        Gollum::Filter.const_get(r).new(self)
+    # Whether or not a particular filter should be skipped for this format.
+    def skip_filter?(filter)
+      if self.class.formats[@format][:skip_filters].respond_to?(:include?)
+        self.class.formats[@format][:skip_filters].include?(filter)
+      elsif self.class.formats[@format][:skip_filters].respond_to?(:call)
+        self.class.formats[@format][:skip_filters].call(filter)
+      else
+        false
       end
-
-      process_chain data, filter_chain
     end
 
     # Process the filter chain
@@ -139,11 +129,6 @@ module Gollum
         data = filter.process(data)
       end
 
-      # Finally, a little bit of cleanup, just because
-      data.gsub!(/<p><\/p>/) do
-        ''
-      end
-
       data
     end
 
@@ -156,16 +141,16 @@ module Gollum
     #
     # Returns the formatted String content.
     def render(no_follow = false, encoding = nil, include_levels = 10)
-      @sanitize = no_follow ?
-          @wiki.history_sanitizer :
-          @wiki.sanitizer
+      @sanitize = no_follow ? @wiki.history_sanitizer : @wiki.sanitizer
 
       @encoding       = encoding
       @include_levels = include_levels
 
-      data         = @data.dup
-      filter_chain = @wiki.filter_chain.map do |r|
-        Gollum::Filter.const_get(r).new(self)
+      data     = @data.dup
+
+      filter_chain = @wiki.filter_chain.reject {|filter| skip_filter?(filter)}
+      filter_chain.map! do |filter_sym|
+        Gollum::Filter.const_get(filter_sym).new(self)
       end
 
       # Since the last 'extract' action in our chain *should* be the markup
@@ -212,5 +197,4 @@ module Gollum
     end
   end
 
-  MarkupGFM = Markup
 end

data/lib/gollum-lib/markups.rb

@@ -1,15 +1,23 @@
 # ~*~ encoding: utf-8 ~*~
 
-require "pathname"
+require 'pathname'
 
 module Gollum
   module MarkupRegisterUtils
+
     # Check if a gem exists. This implementation requires Gem::Specificaton to
     # be filled.
     def gem_exists?(name)
       Gem::Specification.find {|spec| spec.name == name} != nil
     end
 
+    def all_gems_available?(names)
+      names.each do |name|
+        return false unless gem_exists?(name)
+      end
+      true
+    end
+
     # Check if an executable exists. This implementation comes from
     # stackoverflow question 2108727.
     def executable_exists?(name)
@@ -23,21 +31,42 @@ module Gollum
       end
       return false
     end
+
+    # Whether the current markdown renderer is pandoc
+    def using_pandoc?
+      GitHub::Markup::Markdown.implementation_name == 'pandoc-ruby'
+    end
   end
 end
 
 include Gollum::MarkupRegisterUtils
 
+module GitHub
+  module Markup
+    class Markdown < Implementation
+      class << self
+        def implementation_name
+          @implementation_name ||= MARKDOWN_GEMS.keys.detect {|gem_name| self.new.send(:try_require, gem_name) }
+        end
+      end
+    end
+  end
+end
+
 module Gollum
   class Markup
     GitHub::Markup::Markdown::MARKDOWN_GEMS['kramdown'] = proc { |content|
         Kramdown::Document.new(content, :auto_ids => false, :smart_quotes => ["'", "'", '"', '"'].map{|char| char.codepoints.first}).to_html
     }
+    GitHub::Markup::Markdown::MARKDOWN_GEMS['pandoc-ruby'] = proc { |content|
+        PandocRuby.convert(content, :s, :from => :markdown, :to => :html, :filter => 'pandoc-citeproc')
+    } if gem_exists?('pandoc-ruby')
 
     # markdown, rdoc, and plain text are always supported.
     register(:markdown, "Markdown", :extensions => ['md','mkd','mkdn','mdown','markdown'])
     register(:rdoc, "RDoc")
-    register(:txt, "Plain Text")
+    register(:txt, "Plain Text",
+             :skip_filters => Proc.new {|filter| ![:PlainText,:YAML].include?(filter) })
     # the following formats are available only when certain gem is installed
     # or certain program exists.
     register(:textile, "Textile",
@@ -49,13 +78,17 @@ module Gollum
              :reverse_links => true)
     register(:rest, "reStructuredText",
              :enabled => MarkupRegisterUtils::executable_exists?("python2"),
-             :extensions => ['rest', 'rst', 'rst.txt', 'rest.txt'])
+             :extensions => ['rest', 'rst'])
     register(:asciidoc, "AsciiDoc",
+             :skip_filters => [:Tags],
              :enabled => MarkupRegisterUtils::gem_exists?("asciidoctor"))
     register(:mediawiki, "MediaWiki",
              :enabled => MarkupRegisterUtils::gem_exists?("wikicloth"),
              :extensions => ['mediawiki','wiki'], :reverse_links => true)
     register(:pod, "Pod",
              :enabled => MarkupRegisterUtils::executable_exists?("perl"))
+    register(:bib, "BibTeX", :extensions => ['bib'],
+             :enabled => MarkupRegisterUtils::all_gems_available?(["bibtex-ruby", "citeproc-ruby", "csl"]),
+             :skip_filters => Proc.new {|filter| true unless [:YAML,:BibTeX,:Sanitize].include?(filter)})
   end
 end

data/lib/gollum-lib/sanitization.rb

@@ -5,22 +5,223 @@ module Gollum
   # This class does not yet support all options of Sanitize library.
   # See http://github.com/rgrove/sanitize/.
   class Sanitization
-    # Default whitelisted elements.
-    ELEMENTS   = [
-        'a', 'abbr', 'acronym', 'address', 'area', 'b', 'big',
-        'blockquote', 'br', 'button', 'caption', 'center', 'cite',
-        'code', 'col', 'colgroup', 'dd', 'del', 'dfn', 'dir',
-        'div', 'dl', 'dt', 'em', 'fieldset', 'font', 'form', 'h1',
-        'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'input',
-        'ins', 'kbd', 'label', 'legend', 'li', 'map', 'mark', 'menu',
-        'ol', 'optgroup', 'option', 'p', 'pre', 'q', 's', 'samp',
-        'select', 'small', 'span', 'strike', 'strong', 'sub',
-        'sup', 'table', 'tbody', 'td', 'textarea', 'tfoot', 'th',
-        'thead', 'tr', 'tt', 'u', 'ul', 'var'
+
+    # Default whitelisted elements required for MathML. See https://developer.mozilla.org/en-US/docs/Web/MathML/Element
+    # For some help on generating MATHML_ELEMENTS and MATHML_ATTRS, see https://gist.github.com/dometto/52d9cb8b45d68bfc7665e5e6683b75a0
+    MATHML_ELEMENTS = [
+      'math', 'maction', 'maligngroup', 'malignmark', 'menclose',
+      'merror', 'mfenced', 'mfrac', 'mglyph', 'mi', 'mlabeledtr',
+      'mlongdiv', 'mmultiscripts', 'mn', 'mo', 'mover', 'mpadded',
+      'mphantom', 'mroot', 'mrow', 'ms', 'mscarries', 'mscarry',
+      'msgroup', 'msline', 'mspace', 'msqrt', 'msrow', 'mstack',
+      'mstyle', 'msub', 'msup', 'msubsup', 'mtable', 'mtd',
+      'mtext', 'mtr', 'munder', 'munderover', 'semantics'
     ].freeze
 
+
+    # Default whitelisted attributes required for MathML. See https://developer.mozilla.org/en-US/docs/Web/MathML/Attribute 
+    MATHML_ATTRS = {
+     'math'=>
+        ['altimg',
+         'altimg-width',
+         'altimg-height',
+         'altimg-valign',
+         'alttext',
+         'dir',
+         'display',
+         'xmlns',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'maction'=>
+        ['actiontype', 'selection', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'maligngroup'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'malignmark'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'menclose'=>['notation', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'merror'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'mfenced'=>
+        ['close', 'open', 'separators', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'mfrac'=>
+        ['bevelled',
+         'denomalign',
+         'linethickness',
+         'numalign',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mglyph'=>['height', 'width', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'mi'=>
+        ['dir',
+         'mathbackground',
+         'mathcolor',
+         'mathsize',
+         'mathvariant',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mlabeledtr'=>['columnalign', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'mlongdiv'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'mmultiscripts'=>
+        ['subscriptshift',
+         'supscriptshift',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mn'=>
+        ['mathbackground',
+         'mathcolor',
+         'mathsize',
+         'mathvariant',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mo'=>
+        ['accent',
+         'dir',
+         'fence',
+         'href',
+         'id',
+         'largeop',
+         'lspace',
+         'mathbackground',
+         'mathcolor',
+         'mathsize',
+         'mathvariant',
+         'maxsize',
+         'minsize',
+         'movablelimits',
+         'rspace',
+         'separator',
+         'stretchy',
+         'symmetric',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mover'=>['accent', 'align', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'mpadded'=>
+        ['depth',
+         'height',
+         'lspace',
+         'voffset',
+         'width',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mphantom'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'mroot'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'mrow'=>['dir', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'ms'=>
+        ['dir',
+         'lquote',
+         'mathbackground',
+         'mathcolor',
+         'mathsize',
+         'mathvariant',
+         'rquote',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mscarries'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'mscarry'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'msgroup'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'msline'=>['length', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'mspace'=>['height', 'width', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'msqrt'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'msrow'=>['href', 'id', 'mathbackground', 'mathcolor'],
+     'mstack'=>['align', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'mstyle'=>
+        ['displaystyle',
+         'scriptlevel',
+         'scriptminsize',
+         'scriptsizemultiplier',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'msub'=>['subscriptshift', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'msup'=>['supscriptshift', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'msubsup'=>
+        ['subscriptshift',
+         'supscriptshift',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mtable'=>
+        ['align',
+         'columnalign',
+         'columnlines',
+         'columnspacing',
+         'displaystyle',
+         'frame',
+         'framespacing',
+         'rowalign',
+         'rowlines',
+         'rowspacing',
+         'width',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mtd'=>
+        ['columnalign',
+         'columnspan',
+         'rowalign',
+         'rowspan',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mtext'=>
+        ['dir',
+         'mathbackground',
+         'mathcolor',
+         'mathsize',
+         'mathvariant',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'mtr'=>
+        ['columnalign', 'rowalign', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'munder'=>
+        ['accentunder', 'align', 'href', 'id', 'mathbackground', 'mathcolor'],
+     'munderover'=>
+        ['accent',
+         'accentunder',
+         'align',
+         'href',
+         'id',
+         'mathbackground',
+         'mathcolor'],
+     'semantics'=>['href', 'id', 'mathbackground', 'mathcolor']
+    }.freeze
+
+    # Default whitelisted elements.
+    ELEMENTS   = ([
+      'a', 'abbr', 'acronym', 'address', 'area', 'b', 'big',
+      'blockquote', 'br', 'button', 'caption', 'center', 'cite',
+      'code', 'col', 'colgroup', 'dd', 'del', 'dfn', 'dir', 'div',
+      'dl', 'dt', 'em', 'fieldset', 'font', 'form', 'h1', 'h2', 'h3',
+      'h4', 'h5', 'h6', 'hr', 'i', 'img', 'input', 'ins', 'kbd', 'label',
+      'legend', 'li', 'map', 'mark', 'math', 'menu', 'mfrac', 'mi', 'mn',
+      'mo', 'mrow', 'msqrt', 'msubsup', 'msup', 'mtext', 'ol', 'optgroup',
+      'option', 'p', 'pre', 'q', 's', 'samp', 'select', 'small', 'span',
+      'strike', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'textarea',
+      'tfoot', 'th', 'thead', 'tr', 'tt', 'u', 'ul', 'var'
+    ] + MATHML_ELEMENTS).freeze
+
+
     # Default whitelisted attributes.
-    ATTRIBUTES = {
+    ATTRIBUTES = ({
         'a'   => ['href'],
         'img' => ['src'],
         :all  => ['abbr', 'accept', 'accept-charset',
@@ -40,7 +241,7 @@ module Gollum
                   'start', 'summary', 'tabindex', 'target',
                   'title', 'type', 'usemap', 'valign', 'value',
                   'vspace', 'width']
-    }.freeze
+    }.merge(MATHML_ATTRS)).freeze
 
     # Default whitelisted protocols for URLs.
     PROTOCOLS  = {