gollum-lib 2.0.0 → 3.0.0

data/lib/gollum-lib/gitcode.rb

@@ -10,10 +10,10 @@ module Gollum
       raise(ArgumentError, 'path is nil or empty') if path.nil? or path.empty?
 
       @uri = URI::HTTP.build({
-        :path   => self.unchomp(path),
-        :host   => 'raw.github.com',
-        :scheme => 'https',
-        :port   => 443 })
+                                 :path   => self.unchomp(path),
+                                 :host   => 'raw.github.com',
+                                 :scheme => 'https',
+                                 :port   => 443 })
     end
 
     def contents
@@ -27,20 +27,20 @@ module Gollum
 
     def req uri, cut = 1
       return "Too many redirects or retries" if cut >= 10
-      http = Net::HTTP.new uri.host, uri.port
+      http         = Net::HTTP.new uri.host, uri.port
       http.use_ssl = true
-      resp = http.get uri.path, {
-        'Accept'        => 'text/plain',
-        'Cache-Control' => 'no-cache',
-        'Connection'    => 'keep-alive',
-        'Host'          => uri.host,
-        'User-Agent'    => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:15.0) Gecko/20100101 Firefox/15.0'
+      resp         = http.get uri.path, {
+          'Accept'        => 'text/plain',
+          'Cache-Control' => 'no-cache',
+          'Connection'    => 'keep-alive',
+          'Host'          => uri.host,
+          'User-Agent'    => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:15.0) Gecko/20100101 Firefox/15.0'
       }
-      code = resp.code.to_i
+      code         = resp.code.to_i
       return resp.body if code == 200
       return "Not Found" if code == 404
       return "Unhandled Response Code #{code}" unless code == 304 or not resp.header['location'].nil?
-      loc = URI.parse resp.header['location']
+      loc  = URI.parse resp.header['location']
       uri2 = loc.relative?() ? (uri + loc) : loc # overloads (+)
       return req uri2, (cut + 1)
     end

data/lib/gollum-lib/grit_ext.rb

@@ -7,7 +7,7 @@ module Grit
     end
 
     def symlink_target(base_path = nil)
-      target = self.data
+      target   = self.data
       new_path = File.expand_path(File.join('..', target), base_path)
 
       if File.file? new_path

data/lib/gollum-lib/helpers.rb

@@ -4,8 +4,8 @@ module Gollum
 
     def trim_leading_slash url
       return url if url.nil?
-      url.gsub!('%2F','/')
-      return '/' + url.gsub(/^\/+/,'') if url[0,1] == '/'
+      url.gsub!('%2F', '/')
+      return '/' + url.gsub(/^\/+/, '') if url[0, 1] == '/'
       url
     end
 

data/lib/gollum-lib/markup.rb

@@ -6,15 +6,22 @@ require 'base64'
 
 require File.expand_path '../helpers', __FILE__
 
+# Use pygments if it's installed
+begin
+  require 'pygments'
+  Pygments.start
+rescue Exception
+end
+
 module Gollum
 
   class Markup
     include Helpers
 
     @formats = {}
-    
+
     class << self
-      
+
       # Only use the formats that are specified in config.rb
       def formats
         if defined? Gollum::Page::FORMAT_NAMES
@@ -23,7 +30,7 @@ module Gollum
           @formats
         end
       end
-      
+
       # Register a file extension and associated markup type
       #
       # ext     - The file extension
@@ -35,22 +42,21 @@ module Gollum
       # If given a block, that block will be registered with GitHub::Markup to
       # render any matching pages
       def register(ext, name, options = {}, &block)
-        regexp = options[:regexp] || Regexp.new(ext.to_s)
+        regexp        = options[:regexp] || Regexp.new(ext.to_s)
         @formats[ext] = { :name => name, :regexp => regexp }
-        GitHub::Markup.add_markup(regexp, &block) if block_given?
       end
     end
 
     attr_accessor :toc
     attr_accessor :metadata
-    attr_reader   :encoding
-    attr_reader   :sanitize
-    attr_reader   :format
-    attr_reader   :wiki
-    attr_reader   :name
-    attr_reader   :include_levels
-    attr_reader   :to_xml_opts
-    attr_reader   :dir
+    attr_reader :encoding
+    attr_reader :sanitize
+    attr_reader :format
+    attr_reader :wiki
+    attr_reader :name
+    attr_reader :include_levels
+    attr_reader :to_xml_opts
+    attr_reader :dir
 
     # Initialize a new Markup object.
     #
@@ -58,18 +64,66 @@ module Gollum
     #
     # Returns a new Gollum::Markup object, ready for rendering.
     def initialize(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
-      @dir     = ::File.dirname(page.path)
-      @metadata = nil
+      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
+        @dir         = ::File.dirname(page.path)
+      end
+      @metadata    = nil
       @to_xml_opts = { :save_with => Nokogiri::XML::Node::SaveOptions::DEFAULT_XHTML ^ 1, :indent => 0, :encoding => 'UTF-8' }
     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 = [:Metadata, :PlainText, :TOC, :RemoteCode, :Code, :Sanitize, :WSD, :Tags, :Render]
+
+      filter_chain = chain.map do |r|
+        Gollum::Filter.const_get(r).new(self)
+      end
+
+      process_chain data, filter_chain
+    end
+
+    # Process the filter chain
+    #
+    # data - the data to send through the chain
+    # filter_chain - the chain to process
+    #
+    # Returns the formatted data
+    def process_chain data, filter_chain
+      # First we extract the data through the chain...
+      filter_chain.each do |filter|
+        data = filter.extract(data)
+      end
+
+      # Then we process the data through the chain *backwards*
+      filter_chain.reverse.each do |filter|
+        data = filter.process(data)
+      end
+
+      # Finally, a little bit of cleanup, just because
+      data.gsub!(/<p><\/p>/) do
+        ''
+      end
+
+      data
+    end
+
     # Render the content with Gollum wiki syntax on top of the file's own
     # markup language.
     #
@@ -80,13 +134,13 @@ 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
+          @wiki.history_sanitizer :
+          @wiki.sanitizer
 
-      @encoding = encoding
+      @encoding       = encoding
       @include_levels = include_levels
 
-      data = @data.dup
+      data         = @data.dup
       filter_chain = @wiki.filter_chain.map do |r|
         Gollum::Filter.const_get(r).new(self)
       end
@@ -98,22 +152,7 @@ module Gollum
         yield Nokogiri::HTML::DocumentFragment.parse(data)
       end
 
-      # First we extract the data through the chain...
-      filter_chain.each do |filter|
-        data = filter.extract(data)
-      end
-      
-      # Then we process the data through the chain *backwards*
-      filter_chain.reverse.each do |filter|
-        data = filter.process(data)
-      end
-
-      # Finally, a little bit of cleanup, just because
-      data.gsub!(/<p><\/p>/) do
-        ''
-      end
-
-      data
+      process_chain data, filter_chain
     end
 
     # Find the given file in the repo.

data/lib/gollum-lib/markups.rb

@@ -12,4 +12,4 @@ module Gollum
     register(:pod,       "Pod")
     register(:txt,       "Plain Text")
   end
-end
+end

data/lib/gollum-lib/page.rb

@@ -84,9 +84,9 @@ module Gollum
     #
     # Returns a newly initialized Gollum::Page.
     def initialize(wiki)
-      @wiki = wiki
-      @blob = @header = @footer = @sidebar = nil
-      @doc = nil
+      @wiki        = wiki
+      @blob        = @header = @footer = @sidebar = nil
+      @doc         = nil
       @parent_page = nil
     end
 
@@ -139,10 +139,10 @@ module Gollum
     # Returns the String url_path
     def url_path
       path = if self.path.include?('/')
-        self.path.sub(/\/[^\/]+$/, '/')
-      else
-        ''
-      end
+               self.path.sub(/\/[^\/]+$/, '/')
+             else
+               ''
+             end
 
       path << Page.cname(self.name, '-', '-')
       path
@@ -180,7 +180,7 @@ module Gollum
     #
     # Returns the String url_path
     def escaped_url_path
-      CGI.escape(self.url_path).gsub('%2F','/')
+      CGI.escape(self.url_path).gsub('%2F', '/')
     end
 
     # Public: The raw contents of the page.
@@ -284,9 +284,9 @@ module Gollum
     # Public: The first 7 characters of the current version.
     #
     # Returns the first 7 characters of the current version.
-   def version_short
-     version.to_s[0,7]
-   end
+    def version_short
+      version.to_s[0, 7]
+    end
 
     # Public: The header Page.
     #
@@ -341,8 +341,8 @@ module Gollum
     # Returns the String canonical name.
     def self.cname(name, char_white_sub = '-', char_other_sub = '-')
       name.respond_to?(:gsub) ?
-        name.gsub(%r{\s},char_white_sub).gsub(%r{[<>+]}, char_other_sub) :
-        ''
+          name.gsub(%r{\s}, char_white_sub).gsub(%r{[<>+]}, char_other_sub) :
+          ''
     end
 
     # Convert a format Symbol into an extension String.
@@ -380,7 +380,7 @@ module Gollum
       map = @wiki.tree_map_for(version.to_s)
       if page = find_page_in_tree(map, name, dir, exact)
         page.version    = version.is_a?(Grit::Commit) ?
-          version : @wiki.commit_for(version)
+            version : @wiki.commit_for(version)
         page.historical = page.version.to_s == version.to_s
         page
       end
@@ -400,7 +400,7 @@ module Gollum
 
       checked_dir = BlobEntry.normalize_dir(checked_dir)
       checked_dir = '' if exact && checked_dir.nil?
-      name = ::File.join(checked_dir, name) if checked_dir
+      name        = ::File.join(checked_dir, name) if checked_dir
 
       map.each do |entry|
         next if entry.name.to_s.empty?

data/lib/gollum-lib/pagination.rb

@@ -30,7 +30,7 @@ module Gollum
       #
       # Returns Hash with :max_count and :skip keys.
       def log_pagination_options(options = {})
-        skip = page_to_skip(options.delete(:page))
+        skip                = page_to_skip(options.delete(:page))
         options[:max_count] = [options.delete(:per_page).to_i, per_page].max
         options[:skip]      = skip if skip > 0
         options

data/lib/gollum-lib/sanitization.rb

@@ -6,50 +6,50 @@ module Gollum
   # 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', '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'
+    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', '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'
     ].freeze
 
     # Default whitelisted attributes.
     ATTRIBUTES = {
-      'a'   => ['href'],
-      'img' => ['src'],
-      :all  => ['abbr', 'accept', 'accept-charset',
-                'accesskey', 'action', 'align', 'alt', 'axis',
-                'border', 'cellpadding', 'cellspacing', 'char',
-                'charoff', 'class', 'charset', 'checked', 'cite',
-                'clear', 'cols', 'colspan', 'color',
-                'compact', 'coords', 'datetime', 'dir',
-                'disabled', 'enctype', 'for', 'frame',
-                'headers', 'height', 'hreflang',
-                'hspace', 'id', 'ismap', 'label', 'lang',
-                'longdesc', 'maxlength', 'media', 'method',
-                'multiple', 'name', 'nohref', 'noshade',
-                'nowrap', 'prompt', 'readonly', 'rel', 'rev',
-                'rows', 'rowspan', 'rules', 'scope',
-                'selected', 'shape', 'size', 'span',
-                'start', 'summary', 'tabindex', 'target',
-                'title', 'type', 'usemap', 'valign', 'value',
-                'vspace', 'width']
+        'a'   => ['href'],
+        'img' => ['src'],
+        :all  => ['abbr', 'accept', 'accept-charset',
+                  'accesskey', 'action', 'align', 'alt', 'axis',
+                  'border', 'cellpadding', 'cellspacing', 'char',
+                  'charoff', 'class', 'charset', 'checked', 'cite',
+                  'clear', 'cols', 'colspan', 'color',
+                  'compact', 'coords', 'datetime', 'dir',
+                  'disabled', 'enctype', 'for', 'frame',
+                  'headers', 'height', 'hreflang',
+                  'hspace', 'id', 'ismap', 'label', 'lang',
+                  'longdesc', 'maxlength', 'media', 'method',
+                  'multiple', 'name', 'nohref', 'noshade',
+                  'nowrap', 'prompt', 'readonly', 'rel', 'rev',
+                  'rows', 'rowspan', 'rules', 'scope',
+                  'selected', 'shape', 'size', 'span',
+                  'start', 'summary', 'tabindex', 'target',
+                  'title', 'type', 'usemap', 'valign', 'value',
+                  'vspace', 'width']
     }.freeze
 
     # Default whitelisted protocols for URLs.
-    PROTOCOLS = {
-      'a'   => {'href' => ['http', 'https', 'mailto', 'ftp', 'irc', 'apt', :relative]},
-      'img' => {'src'  => ['http', 'https', :relative]},
-      'form' => {'action' => ['http', 'https', :relative]}
+    PROTOCOLS  = {
+        'a'    => { 'href' => ['http', 'https', 'mailto', 'ftp', 'irc', 'apt', :relative] },
+        'img'  => { 'src' => ['http', 'https', :relative] },
+        'form' => { 'action' => ['http', 'https', :relative] }
     }.freeze
 
-    ADD_ATTRIBUTES = lambda do |env, node|
+    ADD_ATTRIBUTES  = lambda do |env, node|
       if add = env[:config][:add_attributes][node.name]
         add.each do |key, value|
           node[key] = value
@@ -60,34 +60,34 @@ module Gollum
     # Default elements whose contents will be removed in addition
     # to the elements themselve
     REMOVE_CONTENTS = [
-      'script',
-      'style'
-      ].freeze
+        'script',
+        'style'
+    ].freeze
 
     # Default transformers to force @id attributes with 'wiki-' prefix
-    TRANSFORMERS = [
-      lambda do |env|
-        node = env[:node]
-        return if env[:is_whitelisted] || !node.element?
-        prefix = env[:config][:id_prefix]
-        found_attrs = %w(id name).select do |key|
-          if value = node[key]
-            node[key] = value.gsub(/\A(#{prefix})?/, prefix)
+    TRANSFORMERS    = [
+        lambda do |env|
+          node = env[:node]
+          return if env[:is_whitelisted] || !node.element?
+          prefix      = env[:config][:id_prefix]
+          found_attrs = %w(id name).select do |key|
+            if value = node[key]
+              node[key] = value.gsub(/\A(#{prefix})?/, prefix)
+            end
           end
-        end
-        if found_attrs.size > 0
+          if found_attrs.size > 0
+            ADD_ATTRIBUTES.call(env, node)
+            {}
+          end
+        end,
+        lambda do |env|
+          node = env[:node]
+          return unless value = node['href']
+          prefix       = env[:config][:id_prefix]
+          node['href'] = value.gsub(/\A\#(#{prefix})?/, '#'+prefix)
           ADD_ATTRIBUTES.call(env, node)
           {}
         end
-      end,
-      lambda do |env|
-        node = env[:node]
-        return unless value = node['href']
-        prefix = env[:config][:id_prefix]
-        node['href'] = value.gsub(/\A\#(#{prefix})?/, '#'+prefix)
-        ADD_ATTRIBUTES.call(env, node)
-        {}
-      end
     ].freeze
 
     # Gets an Array of whitelisted HTML elements.  Default: ELEMENTS.
@@ -122,14 +122,14 @@ module Gollum
     attr_writer :allow_comments
 
     def initialize
-      @elements         = ELEMENTS.dup
-      @attributes       = ATTRIBUTES.dup
-      @protocols        = PROTOCOLS.dup
-      @transformers     = TRANSFORMERS.dup
-      @add_attributes   = {}
-      @remove_contents  = REMOVE_CONTENTS.dup
-      @allow_comments   = false
-      @id_prefix        = ''
+      @elements        = ELEMENTS.dup
+      @attributes      = ATTRIBUTES.dup
+      @protocols       = PROTOCOLS.dup
+      @transformers    = TRANSFORMERS.dup
+      @add_attributes  = {}
+      @remove_contents = REMOVE_CONTENTS.dup
+      @allow_comments  = false
+      @id_prefix       = ''
       yield self if block_given?
     end
 
@@ -146,7 +146,7 @@ module Gollum
     # Returns a Sanitization instance.
     def history_sanitization
       self.class.new do |sanitize|
-        sanitize.add_attributes['a'] = {'rel' => 'nofollow'}
+        sanitize.add_attributes['a'] = { 'rel' => 'nofollow' }
       end
     end
 
@@ -154,14 +154,14 @@ module Gollum
     #
     # Returns a Hash.
     def to_hash
-      { :elements         => elements,
-        :attributes       => attributes,
-        :protocols        => protocols,
-        :add_attributes   => add_attributes,
-        :remove_contents  => remove_contents,
-        :allow_comments   => allow_comments?,
-        :transformers     => transformers,
-        :id_prefix        => id_prefix
+      { :elements        => elements,
+        :attributes      => attributes,
+        :protocols       => protocols,
+        :add_attributes  => add_attributes,
+        :remove_contents => remove_contents,
+        :allow_comments  => allow_comments?,
+        :transformers    => transformers,
+        :id_prefix       => id_prefix
       }
     end