gollum 1.3.1 → 1.4.2

data/lib/gollum/page.rb

@@ -76,11 +76,20 @@ module Gollum
     end
 
     # Reusable filter to turn a filename (without path) into a canonical name.
-    # Strips extension, converts spaces to dashes.
+    # Strips extension, converts dashes to spaces.
     #
     # Returns the filtered String.
     def self.canonicalize_filename(filename)
-      filename.split('.')[0..-2].join('.').gsub('-', ' ')
+      strip_filename(filename).gsub('-', ' ')
+    end
+
+    # Reusable filter to strip extension and path from filename
+    #
+    # filename - The string path or filename to strip
+    #
+    # Returns the stripped String.
+    def self.strip_filename(filename)
+      ::File.basename(filename, ::File.extname(filename))
     end
 
     # Public: Initialize a page.
@@ -100,6 +109,13 @@ module Gollum
       @blob && @blob.name
     end
 
+    # Public: The on-disk filename of the page with extension stripped.
+    #
+    # Returns the String name.
+    def filename_stripped
+      self.class.strip_filename(filename)
+    end
+
     # Public: The canonical page name without extension, and dashes converted
     # to spaces.
     #
@@ -166,9 +182,11 @@ module Gollum
 
     # Public: The formatted contents of the page.
     #
+    # encoding - Encoding Constant or String.
+    #
     # Returns the String data.
-    def formatted_data(&block)
-      @blob && @wiki.markup_classes[format].new(self).render(historical?, &block)
+    def formatted_data(encoding = nil, &block)
+      @blob && markup_class.render(historical?, encoding, &block)
     end
 
     # Public: The format of the page.
@@ -180,6 +198,13 @@ module Gollum
       self.class.format_for(@blob.name)
     end
 
+    # Gets the Gollum::Markup instance that will render this page's content.
+    #
+    # Returns a Gollum::Markup instance.
+    def markup_class
+      @markup_class ||= @wiki.markup_classes[format].new(self)
+    end
+
     # Public: The current version of the page.
     #
     # Returns the Grit::Commit.
@@ -237,17 +262,22 @@ module Gollum
 
     # Convert a human page name into a canonical page name.
     #
-    # name - The String human page name.
+    # name           - The String human page name.
+    # char_white_sub - Substitution for whitespace
+    # char_other_sub - Substitution for other special chars
     #
     # Examples
     #
     #   Page.cname("Bilbo Baggins")
     #   # => 'Bilbo-Baggins'
     #
+    #   Page.cname("Bilbo Baggins",'_')
+    #   # => 'Bilbo_Baggins'
+    #
     # Returns the String canonical name.
-    def self.cname(name)
-      name.respond_to?(:gsub)      ?
-        name.gsub(%r{[ /<>]}, '-') :
+    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) :
         ''
     end
 
@@ -361,10 +391,11 @@ module Gollum
     # Returns a Boolean.
     def page_match(name, filename)
       if match = self.class.valid_filename?(filename)
-        Page.cname(name).downcase == Page.cname(match).downcase
-      else
-        false
+        @wiki.ws_subs.each do |sub|
+          return true if Page.cname(name).downcase == Page.cname(match, sub).downcase
+        end
       end
+      false
     end
 
     # Loads a sub page.  Sub page nanes (footers) are prefixed with
@@ -374,6 +405,7 @@ module Gollum
     #
     # Returns the Page or nil if none exists.
     def find_sub_page(name)
+      return nil unless self.version
       return nil if self.filename =~ /^_/
       name = "_#{name.to_s.capitalize}"
       return nil if page_match(name, self.filename)

data/lib/gollum/pagination.rb

@@ -19,7 +19,7 @@ module Gollum
         ([1, page.to_i].max - 1) * per_page
       end
 
-      # Fills in git-specific options for the log command using simple 
+      # Fills in git-specific options for the log command using simple
       # pagination options.
       #
       # options - Hash of options:
@@ -45,7 +45,7 @@ module Gollum
       self.class.page_to_skip(page)
     end
 
-    # Fills in git-specific options for the log command using simple 
+    # Fills in git-specific options for the log command using simple
     # pagination options.
     #
     # options - Hash of options:

data/lib/gollum/sanitization.rb

@@ -30,7 +30,7 @@ module Gollum
                 'compact', 'coords', 'datetime', 'dir',
                 'disabled', 'enctype', 'for', 'frame',
                 'headers', 'height', 'hreflang',
-                'hspace', 'ismap', 'label', 'lang',
+                'hspace', 'id', 'ismap', 'label', 'lang',
                 'longdesc', 'maxlength', 'media', 'method',
                 'multiple', 'name', 'nohref', 'noshade',
                 'nowrap', 'prompt', 'readonly', 'rel', 'rev',
@@ -43,28 +43,48 @@ module Gollum
 
     # Default whitelisted protocols for URLs.
     PROTOCOLS = {
-      'a'   => {'href' => ['http', 'https', 'mailto', :relative]},
+      'a'   => {'href' => ['http', 'https', 'mailto', 'ftp', 'irc', :relative]},
       'img' => {'src'  => ['http', 'https', :relative]}
     }.freeze
 
-    # Default transformers to force @id attributes with 'wiki-' prefix
+    ADD_ATTRIBUTES = lambda do |env, node|
+      if add = env[:config][:add_attributes][node.name]
+        add.each do |key, value|
+          node[key] = value
+        end
+      end
+    end
 
+    # Default elements whose contents will be removed in addition
+    # to the elements themselve
+    REMOVE_CONTENTS = [
+      '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? || !node['id'] 
+        node = env[:node]
+        return if env[:is_whitelisted] || !node.element?
         prefix = env[:config][:id_prefix]
-        node['id'] = node['id'].gsub(/\A(#{prefix})?/, prefix)
-
-        {:node_whitelist => [node]}
+        found_attrs = %w(id name).select do |key|
+          if value = node[key]
+            node[key] = value.gsub(/\A(#{prefix})?/, prefix)
+          end
+        end
+        if found_attrs.size > 0
+          ADD_ATTRIBUTES.call(env, node)
+          {}
+        end
       end,
       lambda do |env|
         node = env[:node]
-        return unless node['href']
+        return unless value = node['href']
         prefix = env[:config][:id_prefix]
-        node['href'] = node['href'].gsub(/\A\#(#{prefix})?/, '#'+prefix)
-
-        {:node_whitelist => [node]}
+        node['href'] = value.gsub(/\A\#(#{prefix})?/, '#'+prefix)
+        ADD_ATTRIBUTES.call(env, node)
+        {}
       end
     ].freeze
 
@@ -75,33 +95,39 @@ module Gollum
     # elements.  Default: ATTRIBUTES.
     attr_reader :attributes
 
-    # Gets a Hash describing which URI protocols are allowed in HTML 
+    # Gets a Hash describing which URI protocols are allowed in HTML
     # attributes.  Default: PROTOCOLS
     attr_reader :protocols
 
-    # Gets a Hash describing which URI protocols are allowed in HTML 
+    # Gets a Hash describing which URI protocols are allowed in HTML
     # attributes.  Default: TRANSFORMERS
     attr_reader :transformers
 
-    # Gets a String prefix which is added to ID attributes. Default: 'wiki-'
-    attr_reader :id_prefix
+    # Gets or sets a String prefix which is added to ID attributes.
+    # Default: 'wiki-'
+    attr_accessor :id_prefix
 
-    # Gets a Hash describing HTML attributes that Sanitize should add.  
+    # Gets a Hash describing HTML attributes that Sanitize should add.
     # Default: {}
     attr_reader :add_attributes
 
+    # Gets an Array of element names whose contents will be removed in addition
+    # to the elements themselves. Default: REMOVE_CONTENTS
+    attr_reader :remove_contents
+
     # Sets a boolean determining whether Sanitize allows HTML comments in the
     # output.  Default: false.
     attr_writer :allow_comments
 
     def initialize
-      @elements       = ELEMENTS
-      @attributes     = ATTRIBUTES
-      @protocols      = PROTOCOLS
-      @transformers   = TRANSFORMERS
-      @add_attributes = {}
-      @allow_comments = false
-      @id_prefix      = 'wiki-'
+      @elements         = ELEMENTS
+      @attributes       = ATTRIBUTES
+      @protocols        = PROTOCOLS
+      @transformers     = TRANSFORMERS
+      @add_attributes   = {}
+      @remove_contents  = REMOVE_CONTENTS
+      @allow_comments   = false
+      @id_prefix        = 'wiki-'
       yield self if block_given?
     end
 
@@ -126,13 +152,14 @@ module Gollum
     #
     # Returns a Hash.
     def to_hash
-      { :elements       => elements,
-        :attributes     => attributes,
-        :protocols      => protocols,
-        :add_attributes => add_attributes,
-        :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
 

data/lib/gollum/tex.rb

@@ -0,0 +1,89 @@
+require 'fileutils'
+require 'shellwords'
+require 'tmpdir'
+require 'posix/spawn'
+
+module Gollum
+  module Tex
+    class Error < StandardError; end
+
+    extend POSIX::Spawn
+
+    Template = <<-EOS
+\\documentclass[12pt]{article}
+\\usepackage{color}
+\\usepackage[dvips]{graphicx}
+\\pagestyle{empty}
+\\pagecolor{white}
+\\begin{document}
+{\\color{black}
+\\begin{eqnarray*}
+%s
+\\end{eqnarray*}}
+\\end{document}
+    EOS
+
+    class << self
+      attr_accessor :latex_path, :dvips_path, :convert_path
+    end
+
+    self.latex_path   = 'latex'
+    self.dvips_path   = 'dvips'
+    self.convert_path = 'convert'
+
+    def self.check_dependencies!
+      return if @dependencies_available
+
+      if `which latex` == ""
+        raise Error, "`latex` command not found"
+      end
+
+      if `which dvips` == ""
+        raise Error, "`dvips` command not found"
+      end
+
+      if `which convert` == ""
+        raise Error, "`convert` command not found"
+      end
+
+      if `which gs` == ""
+        raise Error, "`gs` command not found"
+      end
+
+      @dependencies_available = true
+    end
+
+    def self.render_formula(formula)
+      check_dependencies!
+
+      Dir.mktmpdir('tex') do |path|
+        tex_path = ::File.join(path, 'formula.tex')
+        dvi_path = ::File.join(path, 'formula.dvi')
+        eps_path = ::File.join(path, 'formula.eps')
+        png_path = ::File.join(path, 'formula.png')
+
+        ::File.open(tex_path, 'w') { |f| f.write(Template % formula) }
+
+        result = sh latex_path, '-interaction=batchmode', 'formula.tex', :chdir => path
+        raise Error, "`latex` command failed: #{result}" unless ::File.exist?(dvi_path)
+
+        result = sh dvips_path, '-o', eps_path, '-E', dvi_path
+        raise Error, "`dvips` command failed: #{result}" unless ::File.exist?(eps_path)
+        result = sh convert_path, '+adjoin',
+          '-antialias',
+          '-transparent', 'white',
+          '-density', '150x150',
+          eps_path, png_path
+        raise Error, "`convert` command failed: #{result}" unless ::File.exist?(png_path)
+
+        ::File.read(png_path)
+      end
+    end
+
+    private
+      def self.sh(*args)
+        pid = spawn *args
+        Process::waitpid(pid)
+      end
+  end
+end

data/lib/gollum/web_sequence_diagram.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+require 'uri'
+require 'open-uri'
+
+class Gollum::WebSequenceDiagram
+  WSD_URL = "http://www.websequencediagrams.com/index.php"
+
+  # Initialize a new WebSequenceDiagram object.
+  #
+  # code  - The String containing the sequence diagram markup.
+  # style - The String containing the rendering style.
+  #
+  # Returns a new Gollum::WebSequenceDiagram object
+  def initialize(code, style)
+    @code = code
+    @style = style
+    @tag = ""
+
+    render
+  end
+
+  # Render the sequence diagram on the remote server and store the url to
+  # the rendered image.
+  #
+  # Returns nil.
+  def render
+    response = Net::HTTP.post_form(URI.parse(WSD_URL), 'style' => @style, 'message' => @code)
+    if response.body =~ /img: "(.+)"/
+      url = "http://www.websequencediagrams.com/#{$1}"
+      @tag = "<img src=\"#{url}\" />"
+    else
+      puts response.body
+      @tag ="Sorry, unable to render sequence diagram at this time."
+    end
+  end
+
+  # Gets the HTML IMG tag for the sequence diagram.
+  #
+  # Returns a String containing the IMG tag.
+  def to_tag
+    @tag
+  end
+end

data/lib/gollum/wiki.rb

@@ -21,6 +21,9 @@ module Gollum
       # Sets the default email for commits.
       attr_accessor :default_committer_email
 
+      # Array of chars to substitute whitespace for when trying to locate file in git repo.
+      attr_accessor :default_ws_subs
+
       # Sets sanitization options. Set to false to deactivate
       # sanitization altogether.
       attr_writer :sanitization
@@ -54,32 +57,30 @@ module Gollum
       # Gets the markup class used by all instances of this Wiki.
       # Default: Gollum::Markup
       def markup_classes
-        @markup_classes ||
+        @markup_classes ||=
           if superclass.respond_to?(:markup_classes)
             superclass.markup_classes
           else
-            classes = Hash.new(::Gollum::Markup)
-
-            # Add custom markup classes for different languages
-            classes[:markdown] = ::Gollum::MarkupGFM
-            classes
+            Hash.new(::Gollum::Markup)
           end
       end
 
       # Gets the default markup class used by all instances of this Wiki.
       # Kept for backwards compatibility until Gollum v2.x
-      def markup_class
-        markup_classes[:default]
+      def markup_class(language=:default)
+        markup_classes[language]
       end
 
       # Sets the default markup class used by all instances of this Wiki.
       # Kept for backwards compatibility until Gollum v2.x
       def markup_class=(default)
-        new_classes     = Hash.new default
         @markup_classes = Hash.new(default).update(markup_classes)
         default
       end
 
+      alias_method :default_markup_class, :markup_class
+      alias_method :default_markup_class=, :markup_class=
+
       # Gets the default sanitization options for current pages used by
       # instances of this Wiki.
       def sanitization
@@ -105,6 +106,8 @@ module Gollum
     self.default_committer_name  = 'Anonymous'
     self.default_committer_email = 'anon@anon.com'
 
+    self.default_ws_subs = ['_','-']
+
     # The String base path to prefix to internal links. For example, when set
     # to "/wiki", the page "Hobbit" will be linked as "/wiki/Hobbit". Defaults
     # to "/".
@@ -122,6 +125,9 @@ module Gollum
     # Gets the String directory in which all page files reside.
     attr_reader :page_file_dir
 
+    # Gets the Array of chars to sub for ws in filenames.
+    attr_reader :ws_subs
+
     # Public: Initialize a new Gollum Repo.
     #
     # path    - The String path to the Git repository that holds the Gollum
@@ -136,6 +142,7 @@ module Gollum
     #           :sanitization  - An instance of Sanitization.
     #           :page_file_dir - String the directory in which all page files reside
     #           :ref - String the repository ref to retrieve pages from
+    #           :ws_subs       - Array of chars to sub for ws in filenames.
     #
     # Returns a fresh Gollum::Repo.
     def initialize(path, options = {})
@@ -153,6 +160,8 @@ module Gollum
       @repo          = @access.repo
       @ref           = options[:ref] || self.class.default_ref
       @sanitization  = options[:sanitization] || self.class.sanitization
+      @ws_subs       = options[:ws_subs] ||
+        self.class.default_ws_subs
       @history_sanitization = options[:history_sanitization] ||
         self.class.history_sanitization
     end
@@ -216,10 +225,10 @@ module Gollum
     #          :tree      - Optional String SHA of the tree to create the
     #                       index from.
     #          :committer - Optional Gollum::Committer instance.  If provided,
-    #                       assume that this operation is part of batch of 
+    #                       assume that this operation is part of batch of
     #                       updates and the commit happens later.
     #
-    # Returns the String SHA1 of the newly written version, or the 
+    # Returns the String SHA1 of the newly written version, or the
     # Gollum::Committer instance if this is part of a batch update.
     def write_page(name, format, data, commit = {})
       multi_commit = false
@@ -231,11 +240,13 @@ module Gollum
         Committer.new(self, commit)
       end
 
-      committer.add_to_index('', name, format, data)
+      filename = Gollum::Page.cname(name)
+
+      committer.add_to_index('', filename, format, data)
 
       committer.after_commit do |index, sha|
         @access.refresh
-        index.update_working_dir('', name, format)
+        index.update_working_dir('', filename, format)
       end
 
       multi_commit ? committer : committer.commit
@@ -258,16 +269,19 @@ module Gollum
     #          :tree      - Optional String SHA of the tree to create the
     #                       index from.
     #          :committer - Optional Gollum::Committer instance.  If provided,
-    #                       assume that this operation is part of batch of 
+    #                       assume that this operation is part of batch of
     #                       updates and the commit happens later.
     #
-    # Returns the String SHA1 of the newly written version, or the 
+    # Returns the String SHA1 of the newly written version, or the
     # Gollum::Committer instance if this is part of a batch update.
     def update_page(page, name, format, data, commit = {})
       name   ||= page.name
       format ||= page.format
       dir      = ::File.dirname(page.path)
       dir      = '' if dir == '.'
+      filename = (rename = page.name != name) ?
+        Gollum::Page.cname(name) : page.filename_stripped
+
       multi_commit = false
 
       committer = if obj = commit[:committer]
@@ -277,17 +291,17 @@ module Gollum
         Committer.new(self, commit)
       end
 
-      if page.name == name && page.format == format
+      if !rename && page.format == format
         committer.add(page.path, normalize(data))
       else
         committer.delete(page.path)
-        committer.add_to_index(dir, name, format, data, :allow_same_ext)
+        committer.add_to_index(dir, filename, format, data, :allow_same_ext)
       end
 
       committer.after_commit do |index, sha|
         @access.refresh
-        index.update_working_dir(dir, page.name, page.format)
-        index.update_working_dir(dir, name, format)
+        index.update_working_dir(dir, page.filename_stripped, page.format)
+        index.update_working_dir(dir, filename, format)
       end
 
       multi_commit ? committer : committer.commit
@@ -304,10 +318,10 @@ module Gollum
     #          :tree      - Optional String SHA of the tree to create the
     #                       index from.
     #          :committer - Optional Gollum::Committer instance.  If provided,
-    #                       assume that this operation is part of batch of 
+    #                       assume that this operation is part of batch of
     #                       updates and the commit happens later.
     #
-    # Returns the String SHA1 of the newly written version, or the 
+    # Returns the String SHA1 of the newly written version, or the
     # Gollum::Committer instance if this is part of a batch update.
     def delete_page(page, commit)
       multi_commit = false
@@ -326,7 +340,7 @@ module Gollum
         dir = '' if dir == '.'
 
         @access.refresh
-        index.update_working_dir(dir, page.name, page.format)
+        index.update_working_dir(dir, page.filename_stripped, page.format)
       end
 
       multi_commit ? committer : committer.commit
@@ -364,7 +378,7 @@ module Gollum
 
         files = []
         if page
-          files << [page.path, page.name, page.format]
+          files << [page.path, page.filename_stripped, page.format]
         else
           # Grit::Diff can't parse reverse diffs.... yet
           patch.each_line do |line|
@@ -524,13 +538,12 @@ module Gollum
 
     # Assemble a Page's filename from its name and format.
     #
-    # name   - The String name of the page (may be in human format).
+    # name   - The String name of the page (should be pre-canonicalized).
     # format - The Symbol format of the page.
     #
     # Returns the String filename.
     def page_file_name(name, format)
-      ext = @page_class.format_to_ext(format)
-      @page_class.cname(name) + '.' + ext
+      name + '.' + @page_class.format_to_ext(format)
     end
 
     # Fill an array with a list of pages.
@@ -615,7 +628,7 @@ module Gollum
     rescue Grit::GitRuby::Repository::NoSuchShaFound
       []
     end
-    
+
     def inspect
       %(#<#{self.class.name}:#{object_id} #{@repo.path}>)
     end