gollum-lib 1.0.9 → 2.0.0

data/lib/gollum-lib/markups.rb

@@ -10,5 +10,6 @@ module Gollum
     register(:asciidoc,  "AsciiDoc")
     register(:mediawiki, "MediaWiki", :regexp => /(media)?wiki/)
     register(:pod,       "Pod")
+    register(:txt,       "Plain Text")
   end
 end

data/lib/gollum-lib/wiki.rb

@@ -150,6 +150,12 @@ module Gollum
 
     # Gets side on which the sidebar should be shown
     attr_reader :bar_side
+    
+    # An array of symbols which refer to classes under Gollum::Filter,
+    # each of which is an element in the "filtering chain".  See
+    # the documentation for Gollum::Filter for more on how this chain
+    # works, and what filter classes need to implement.
+    attr_reader :filter_chain
 
     # Public: Initialize a new Gollum Repo.
     #
@@ -183,6 +189,10 @@ module Gollum
     #                             - :left
     #                             - :right
     #           :allow_uploads - Set to true to allow file uploads.
+    #           :per_page_uploads - Whether uploads should be stored in a central
+    #                            'uploads' directory, or in a directory named for
+    #                            the page they were uploaded to.
+    #           :filter_chain  - Override the default filter chain with your own.
     #
     # Returns a fresh Gollum::Repo.
     def initialize(path, options = {})
@@ -223,6 +233,9 @@ module Gollum
       @user_icons           = ['gravatar', 'identicon'].include?( options[:user_icons] ) ?
                               options[:user_icons] : 'none'
       @allow_uploads        = options.fetch :allow_uploads, false
+      @per_page_uploads     = options.fetch :per_page_uploads, false
+      @filter_chain         = options.fetch :filter_chain,
+                              [:Metadata, :PlainText, :TOC, :RemoteCode, :Code, :Sanitize, :WSD, :Tags, :Render]
     end
 
     # Public: check whether the wiki's git repo exists on the filesystem.
@@ -642,6 +655,74 @@ module Gollum
         @history_sanitizer ||= options.to_sanitize
       end
     end
+    
+    # Public: Add an additional link to the filter chain.
+    #
+    # name - A symbol which represents the name of a class under the
+    #        Gollum::Render namespace to insert into the chain.
+    #
+    # loc  - A "location specifier" -- that is, where to put the new
+    #        filter in the chain.  This can be one of `:first`, `:last`,
+    #        `:before => :SomeElement`, or `:after => :SomeElement`, where
+    #        `:SomeElement` (if specified) is a symbol already in the
+    #        filter chain.  A `:before` or `:after` which references a
+    #        filter that doesn't exist will cause `ArgumentError` to be
+    #        raised.
+    #
+    # Returns nothing.
+    def add_filter(name, loc)
+      unless name.is_a? Symbol
+        raise ArgumentError,
+              "Invalid filter name #{name.inspect} (must be a symbol)"
+      end
+      
+      case loc
+        when :first
+          @filter_chain.unshift(name)
+        when :last
+          @filter_chain.push(name)
+        when Hash
+          if loc.length != 1
+            raise ArgumentError,
+                  "Invalid location specifier"
+          end
+          if ([:before, :after] && loc.keys).empty?
+            raise ArgumentError,
+                  "Invalid location specifier"
+          end
+          
+          next_to = loc.values.first
+          relative = loc.keys.first
+          
+          i = @filter_chain.index(next_to)
+          if i.nil?
+            raise ArgumentError,
+                  "Unknown filter #{next_to.inspect}"
+          end
+
+          i += 1 if relative == :after
+          @filter_chain.insert(i, name)
+        else
+          raise ArgumentError,
+                "Invalid location specifier"
+      end
+    end
+    
+    # Remove the named filter from the filter chain.
+    #
+    # Returns nothing.  Raises `ArgumentError` if the named filter doesn't
+    # exist in the chain.
+    def remove_filter(name)
+      unless name.is_a? Symbol
+        raise ArgumentError,
+              "Invalid filter name #{name.inspect} (must be a symbol)"
+      end
+      
+      unless @filter_chain.delete(name)
+        raise ArgumentError,
+              "#{name.inspect} not found in filter chain"
+      end
+    end
 
     #########################################################################
     #
@@ -687,6 +768,10 @@ module Gollum
     # Toggles file upload functionality.
     attr_reader :allow_uploads
 
+    # Toggles whether uploaded files go into 'uploads', or a directory
+    # named after the page they were uploaded to.
+    attr_reader :per_page_uploads
+
     # Normalize the data.
     #
     # data - The String data to be normalized.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-lib
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 2.0.0
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-02 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab-grit
@@ -46,19 +46,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: pygments.rb
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
@@ -345,6 +345,16 @@ files:
 - lib/gollum-lib/committer.rb
 - lib/gollum-lib/file.rb
 - lib/gollum-lib/file_view.rb
+- lib/gollum-lib/filter.rb
+- lib/gollum-lib/filter/code.rb
+- lib/gollum-lib/filter/metadata.rb
+- lib/gollum-lib/filter/plain_text.rb
+- lib/gollum-lib/filter/remote_code.rb
+- lib/gollum-lib/filter/render.rb
+- lib/gollum-lib/filter/sanitize.rb
+- lib/gollum-lib/filter/tags.rb
+- lib/gollum-lib/filter/toc.rb
+- lib/gollum-lib/filter/wsd.rb
 - lib/gollum-lib/git_access.rb
 - lib/gollum-lib/gitcode.rb
 - lib/gollum-lib/grit_ext.rb
@@ -354,9 +364,7 @@ files:
 - lib/gollum-lib/markups.rb
 - lib/gollum-lib/page.rb
 - lib/gollum-lib/pagination.rb
-- lib/gollum-lib/remote_code.rb
 - lib/gollum-lib/sanitization.rb
-- lib/gollum-lib/web_sequence_diagram.rb
 - lib/gollum-lib/wiki.rb
 - licenses/licenses.txt
 homepage: http://github.com/gollum/gollum-lib
@@ -380,7 +388,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: gollum-lib
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 2
 summary: A simple, Git-powered wiki.

data/lib/gollum-lib/remote_code.rb

@@ -1,39 +0,0 @@
-# ~*~ encoding: utf-8 ~*~
-require 'net/http'
-require 'net/https' # ruby 1.8.7 fix, remove at upgrade
-require 'uri'
-require 'open-uri'
-
-module Gollum
-  class RemoteCode
-    def initialize path
-      raise(ArgumentError, 'path is nil or empty') if path.nil? or path.empty?
-      @uri = URI(path)
-    end
-
-    def contents
-      @contents ||= req @uri
-    end
-
-    private
-
-      def req uri, cut = 1
-        return "Too many redirects or retries" if cut >= 10
-        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',
-          'User-Agent'    => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:15.0) Gecko/20100101 Firefox/15.0'
-        }
-        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']
-        uri2 = loc.relative? ? (uri + loc) : loc # overloads (+)
-        req uri2, (cut + 1)
-      end
-  end
-end

data/lib/gollum-lib/web_sequence_diagram.rb

@@ -1,44 +0,0 @@
-# ~*~ encoding: utf-8 ~*~
-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