gollum-lib 5.0.a.1 → 5.0.a.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e2a9bc73881bcc33b66757b63f6c185ddc2576e
-  data.tar.gz: 4c3e252678d02c073238a84055cae92104bf6665
+  metadata.gz: fe17d31af04eac933565ca3a8064c14e6958b1fe
+  data.tar.gz: c66f0147ff6edd7e1b83259fff3f090bce156c96
 SHA512:
-  metadata.gz: 84db71e0ad0f5fa9ce423a3de399476feb573b3f9f89977af3c2af69c5ae65b20749f66dceeb84ce3ee124cf7d9255dab2c1194da16473ae9969913fc4cf14c5
-  data.tar.gz: 88c21171f76cfa9255ac1c7c17245520fbd2748c69a966349eb790e859cc88f8d9ed18785bf44679713ba8a0a3b364ea3d58caad70b3bbce1879347ea898344a
+  metadata.gz: 8007eb7edd7b8e74aaedd7ebc5ab9968a34f58007d9bcdc6577789018b64bcc92c421c35892a5fa3348fc1e9132391b65ab4732b773cd25eb02ff13c0dd780da
+  data.tar.gz: 6dc4517307645b99009596814ee06bca440085d1da04cec3d99c34bbde7eddad6c1ff1d0b25ec3599ec6d226d1cb0615d3ba9575ce8766028bae5e96dcd25442

data/gemspec.rb

@@ -8,7 +8,7 @@ def specification(version, default_adapter, platform = nil)
     s.name              = 'gollum-lib'
     s.version           = version
     s.platform          = platform if platform
-    s.date              = '2017-04-08'
+    s.date              = '2017-04-12'
     s.rubyforge_project = 'gollum-lib'
     s.license           = 'MIT'
 

data/lib/gollum-lib/committer.rb

@@ -78,14 +78,12 @@ module Gollum
     # name   - The String Gollum::Page filename_stripped.
     # format - The Symbol Gollum::Page format.
     # data   - The String wiki data to store in the tree map.
-    # allow_same_ext - A Boolean determining if the tree map allows the same
-    #                  filename with the same extension.
     #
     # Raises Gollum::DuplicatePageError if a matching filename already exists.
     # This way, pages are not inadvertently overwritten.
     #
     # Returns nothing (modifies the Index in place).
-    def add_to_index(dir, name, format, data, allow_same_ext = false)
+    def add_to_index(dir, name, format, data)
       path = @wiki.page_file_name(name, format)
 
       dir  = '/' if dir.strip.empty?
@@ -108,7 +106,7 @@ module Gollum
 
           new_file_ext = ::File.extname(path).sub(/^\./, '')
 
-          if downpath == existing_file && !(allow_same_ext && new_file_ext == existing_file_ext)
+          if downpath == existing_file && (new_file_ext == existing_file_ext)
             raise DuplicatePageError.new(dir, blob.name, path)
           end
         end

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

@@ -3,7 +3,7 @@ module Gollum
     class GlobalTOC < Gollum::Macro
       def render(title = "Global Table of Contents")
         if @wiki.pages.size > 0
-          result = '<ul>' + @wiki.pages.map { |p| "<li><a href=\"/#{p.url_path}\">#{p.url_path_display}</a></li>" }.join + '</ul>'
+          result = '<ul>' + @wiki.pages.map { |p| "<li><a href=\"/#{p.url_path}\">#{p.url_path}</a></li>" }.join + '</ul>'
         end
         "<div class=\"toc\"><div class=\"toc-title\">#{title}</div>#{result}</div>"
       end

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

@@ -6,7 +6,7 @@ module Gollum
         if @wiki.pages.size > 0
           list_items = @wiki.pages.map do |page|
             if page.url_path.start_with?(toc_root_path)
-              path_display = full_path ? page.url_path_display  : page.url_path_display.sub(toc_root_path,"").sub(/^\//,'')
+              path_display = full_path ? page.url_path_display  : page.url_path.sub(toc_root_path,"").sub(/^\//,'')
               "<li><a href=\"/#{page.url_path}\">#{path_display}</a></li>"
             end
           end

data/lib/gollum-lib/markup.rb

@@ -19,6 +19,7 @@ module Gollum
     include Helpers
 
     @formats = {}
+    @extensions = []
 
     class << self
 
@@ -31,20 +32,33 @@ module Gollum
         end
       end
 
+      def extensions
+        @extensions
+      end
+
       # Register a file format
       #
       # ext     - The file extension
       # name    - The name of the markup type
       # options - Hash of options:
-      #           regexp - Regexp to match against.
-      #                    Defaults to exact match of ext.
+      #           extensions - Array of valid file extensions, for instance ['md']
+      #           enabled - Whether the markup is enabled
       #
       # If given a block, that block will be registered with GitHub::Markup to
       # render any matching pages
       def register(ext, name, options = {}, &block)
+        if options[:regexp] then
+          STDERR.puts <<-EOS
+          Warning: attempted to register a markup (name: #{name.to_s}) by passing the deprecated :regexp option.
+          Please pass an Array of valid file extensions (:extensions => ['ext1', 'ext2']) instead.
+          EOS
+        end
+        new_extension = options.fetch(:extensions, [ext.to_s])
         @formats[ext] = { :name => name,
-          :regexp => options.fetch(:regexp, Regexp.new(ext.to_s)),
-          :reverse_links => options.fetch(:reverse_links, false) }
+          :extensions => new_extension,
+          :reverse_links => options.fetch(:reverse_links, false),
+          :enabled => options.fetch(:enabled, true) }
+        @extensions.concat(new_extension)
       end
     end
 

data/lib/gollum-lib/markups.rb

@@ -1,20 +1,61 @@
 # ~*~ encoding: utf-8 ~*~
+
+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
+
+    # Check if an executable exists. This implementation comes from
+    # stackoverflow question 2108727.
+    def executable_exists?(name)
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      paths = ENV["PATH"].split(::File::PATH_SEPARATOR)
+      paths.each do |path|
+        exts.each do |ext|
+          exe = Pathname(path) + "#{name}#{ext}"
+          return true if exe.executable?
+        end
+      end
+      return false
+    end
+  end
+end
+
+include Gollum::MarkupRegisterUtils
+
 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
     }
 
-    register(:markdown,  "Markdown", :regexp => /md|mkdn?|mdown|markdown/)
-    register(:textile,   "Textile")
-    register(:rdoc,      "RDoc")
-    register(:org,       "Org-mode")
-    register(:creole,    "Creole", :reverse_links => true)
-    register(:rest,      "reStructuredText", :regexp => /re?st(\.txt)?/)
-    register(:asciidoc,  "AsciiDoc")
-    register(:mediawiki, "MediaWiki", :regexp => /(media)?wiki/, :reverse_links => true)
-    register(:pod,       "Pod")
-    register(:txt,       "Plain Text")
+    # markdown, rdoc, and plain text are always supported.
+    register(:markdown, "Markdown", :extensions => ['md','mkd','mkdn','mdown','markdown'])
+    register(:rdoc, "RDoc")
+    register(:txt, "Plain Text")
+    # the following formats are available only when certain gem is installed
+    # or certain program exists.
+    register(:textile, "Textile",
+             :enabled => MarkupRegisterUtils::gem_exists?("RedCloth"))
+    register(:org, "Org-mode",
+             :enabled => MarkupRegisterUtils::gem_exists?("org-ruby"))
+    register(:creole, "Creole",
+             :enabled => MarkupRegisterUtils::gem_exists?("creole"),
+             :reverse_links => true)
+    register(:rest, "reStructuredText",
+             :enabled => MarkupRegisterUtils::executable_exists?("python2"),
+             :extensions => ['rest', 'rst', 'rst.txt', 'rest.txt'])
+    register(:asciidoc, "AsciiDoc",
+             :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"))
   end
-end
+end

data/lib/gollum-lib/page.rb

@@ -17,25 +17,13 @@ module Gollum
     # Returns a Page
     attr_accessor :parent_page
 
-    # Find the Symbol format for the file extension
-    #
-    # ext - String file extension, like ".md"
-    #
-    # Returns the Symbol format associated with ext
-    def self.parse_extension(ext)
-      Gollum::Markup.formats.each_pair do |name, format|
-        return name if ext =~ format[:regexp]
-      end
-      nil
-    end
-
     # Checks if a filename has a valid, registered extension
     #
     # filename - String filename, like "Home.md".
     #
     # Returns true or false.
     def self.valid_extension?(filename)
-      !!self.parse_extension(::File.extname(filename))
+      Gollum::Markup.extensions.include?(::File.extname(filename.to_s).sub(/^\./,''))
     end
 
     # Checks if a filename has a valid extension understood by GitHub::Markup.
@@ -55,15 +43,11 @@ module Gollum
     #
     # Returns the Symbol format of the page; one of the registered format types
     def self.format_for(filename)
-      self.parse_extension(::File.extname(filename))
-    end
-
-    # Reusable filter to turn a filename (without path) into a canonical name.
-    # Strips extension, convert to string if possible.
-    #
-    # Returns the filtered String.
-    def self.canonicalize_filename(filename)
-      self.strip_filename(filename.to_s)
+      ext = ::File.extname(filename.to_s).sub(/^\./,'')
+      Gollum::Markup.formats.each_pair do |name, format|
+        return name if format[:extensions].include?(ext)
+      end
+      nil
     end
 
     # Reusable filter to strip extension and path from filename
@@ -72,7 +56,7 @@ module Gollum
     #
     # Returns the stripped String.
     def self.strip_filename(filename)
-      ::File.basename(filename, ::File.extname(filename))
+      ::File.basename(filename.to_s, ::File.extname(filename.to_s))
     end
 
     # Public: Initialize a page.
@@ -88,6 +72,13 @@ module Gollum
       @parent_page    = nil
     end
 
+    # Public: The SHA hash identifying this page
+    #
+    # Returns the String SHA.
+    def sha
+      @blob && @blob.id
+    end
+
     # Public: The on-disk filename of the page including extension.
     #
     # Returns the String name.
@@ -106,7 +97,7 @@ module Gollum
     #
     # Returns the String name.
     def name
-      self.class.canonicalize_filename(filename)
+      self.class.strip_filename(filename)
     end
 
     # Public: The title will be constructed from the
@@ -140,17 +131,10 @@ module Gollum
                ''
              end
 
-      path << self.name
+      path << self.filename
       path
     end
 
-    # Public: The display form of the url path required to reach this page within the repo.
-    #
-    # Returns the String url_path
-    def url_path_display
-      url_path
-    end
-
     # Public: Defines title for page.rb
     #
     # Returns the String title
@@ -158,6 +142,13 @@ module Gollum
       metadata_title || url_path
     end
 
+    # Public: The url_path, but CGI escaped.
+    #
+    # Returns the String url_path
+    def escaped_url_path
+      CGI.escape(self.url_path).gsub('%2F', '/')
+    end
+
     # Public: Metadata title
     #
     # Set with <!-- --- title: New Title --> in page content
@@ -179,13 +170,6 @@ module Gollum
       @wiki.display_metadata
     end
 
-    # Public: The url_path, but CGI escaped.
-    #
-    # Returns the String url_path
-    def escaped_url_path
-      CGI.escape(self.url_path).gsub('%2F', '/')
-    end
-
     # Public: The raw contents of the page.
     #
     # Returns the String data.
@@ -390,7 +374,7 @@ module Gollum
 
       map.each do |entry|
         next if entry.name.to_s.empty? || !self.class.valid_extension?(entry.name)
-        entry_name =  ::File.extname(name).empty? ? Page.canonicalize_filename(entry.name) : entry.name
+        entry_name =  ::File.extname(name).empty? ? ::Gollum::Page.strip_filename(entry.name) : entry.name
         path = checked_dir ? ::File.join(entry.dir, entry_name) : entry_name
         next unless query.downcase == path.downcase
         return entry.page(@wiki, @version)

data/lib/gollum-lib/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   module Lib
-    VERSION = '5.0.a.1'
+    VERSION = '5.0.a.2'
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-lib
 version: !ruby/object:Gem::Version
-  version: 5.0.a.1
+  version: 5.0.a.2
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-08 00:00:00.000000000 Z
+date: 2017-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gollum-grit_adapter