Release 2.3.3

Documentation and usability enhancement of recent fileview fix

README.md

@@ -363,25 +363,17 @@ appropriately.
 
 ## MATHEMATICAL EQUATIONS
 
+Start gollum with the `--mathjax` flag. Read more about [MathJax](http://docs.mathjax.org/en/latest/index.html) on the web. Gollum uses the `TeX-AMS-MML_HTMLorMML` config with the `autoload-all` extension.
 
-Page files may contain mathematic equations in TeX syntax that will be nicely
+Inline math:
-typeset into the expected output. A block-style equation is delimited by `\[`
-and `\]`. For example:
 
-    \[ P(E) = {n \choose k} p^k (1-p)^{ n-k} \]
+- $2^2$
+- `\\(2^2\\)`
 
-Inline equations are delimited by `\(` and `\)`. These equations will appear
+Display math:
-inline with regular text. For example:
 
-    The Pythagorean theorem is \( a^2 + b^2 = c^2 \).
+- $$2^2$$
-
+- [2^2]
-### INSTALLATION REQUIREMENTS
-
-In order to get the mathematical equations rendering to work, you need the following binaries:
-
-* LaTex, TeTex or MacTex/BasicTeX (pdflatex)
-* Netpbm (pnmcrop, pnmpad, pnmscale, ppmtopgm, pnmgamma, pnmtopng)
-* Ghostscript (gs)
 
 ## SEQUENCE DIAGRAMS
 

Rakefile

@@ -114,6 +114,7 @@ task :release => :build do
     exit!
   end
   sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git pull"
   sh "git tag v#{version}"
   sh "git push origin master"
   sh "git push origin v#{version}"

bin/gollum

@@ -68,6 +68,14 @@ opts = OptionParser.new do |opts|
   opts.on("--mathjax", "Enables mathjax.") do
     wiki_options[:mathjax] = true
   end
+
+  opts.on("--show-all", "Shows all files in file view. By default only valid pages are shown.") do
+    wiki_options[:show_all] = true
+  end
+
+  opts.on("--collapse-tree", "Collapse file view tree. By default, expanded tree is shown.") do
+    wiki_options[:collapse_tree] = true
+  end
 end
 
 # Read command line options into `options` hash

gollum.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.8.7"
 
   s.name              = 'gollum'
-  s.version           = '2.3.0'
+  s.version           = '2.3.3'
-  s.date              = '2012-10-21'
+  s.date              = '2012-10-23'
   s.rubyforge_project = 'gollum'
 
   s.summary     = "A simple, Git-powered wiki."

lib/gollum.rb

@@ -22,7 +22,7 @@ require File.expand_path('../gollum/web_sequence_diagram', __FILE__)
 require File.expand_path('../gollum/frontend/uri_encode_component', __FILE__)
 
 module Gollum
-  VERSION = '2.3.0'
+  VERSION = '2.3.3'
 
   def self.assets_path
     ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))

lib/gollum/file.rb

@@ -13,6 +13,22 @@ module Gollum
       @path = nil
     end
 
+    # Public: The url path required to reach this page within the repo.
+    #
+    # Returns the String url_path
+    def url_path
+      path = self.path
+      path = path.sub(/\/[^\/]+$/, '/') if path.include?('/')
+      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: The on-disk filename of the file.
     #
     # Returns the String name.

lib/gollum/file_view.rb

@@ -5,8 +5,13 @@ module Gollum
     - Then all the folders are sorted and processed
 =end
   class FileView
-    def initialize pages
+    # common use cases:
+    # set pages to wiki.pages and show_all to false
+    # set pages to wiki.pages + wiki.files and show_all to true
+    def initialize pages, options = {}
       @pages = pages
+      @show_all = options[:show_all] || false
+      @checked = options[:collapse_tree] ? '' : "checked"
     end
 
     def enclose_tree string
@@ -26,7 +31,7 @@ module Gollum
     def new_sub_folder path
       <<-HTML
       <li>
-        <label>#{path}</label> <input type="checkbox" checked />
+        <label>#{path}</label> <input type="checkbox" #{@checked} />
         <ol>
       HTML
     end
@@ -39,7 +44,16 @@ module Gollum
     end
 
     def url_for_page page
-      url = ::File.join(::File.dirname(page.path), page.filename_stripped)
+      url = ''
+      if @show_all
+        # Remove ext for valid pages.
+        filename = page.filename
+        filename = Page::valid_page_name?(filename) ? filename.chomp(::File.extname(filename)) : filename
+
+        url = ::File.join(::File.dirname(page.path), filename)
+      else
+        url = ::File.join(::File.dirname(page.path), page.filename_stripped)
+      end
       url = url[2..-1] if url[0,2] == './'
       url
     end
@@ -74,7 +88,7 @@ module Gollum
         url  = url_for_page page
         html += <<-HTML
         <li>
-          <label>#{::File.dirname(page.path)}</label> <input type="checkbox" checked />
+          <label>#{::File.dirname(page.path)}</label> <input type="checkbox" #{@checked} />
           <ol>
             <li class="file"><a href="#{url}">#{name}</a></li>
          </ol>

lib/gollum/frontend/app.rb

@@ -323,13 +323,19 @@ module Precious
       wiki_options = settings.wiki_options.merge({ :page_file_dir => @path })
       wiki         = Gollum::Wiki.new(settings.gollum_path, wiki_options)
       @results     = wiki.pages
+      @results     += wiki.files if settings.wiki_options[:show_all]
       @ref         = wiki.ref
       mustache :pages
     end
 
     get '/fileview' do
       wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      @results = Gollum::FileView.new(wiki.pages).render_files
+      show_all = settings.wiki_options[:show_all]
+      # if showing all files include wiki.files
+      # must pass wiki_options for both because
+      # --show-all and --collapse-tree can be set.
+      @results = show_all ? Gollum::FileView.new(wiki.pages + wiki.files, settings.wiki_options).render_files :
+                            Gollum::FileView.new(wiki.pages, settings.wiki_options).render_files
       @ref = wiki.ref
       mustache :file_view, { :layout => false }
     end

lib/gollum/frontend/templates/layout.mustache

@@ -20,7 +20,13 @@
   <script type="text/javascript" src="{{base_url}}/javascript/editor/gollum.editor.js"></script>
   {{#mathjax}}
   <script type="text/x-mathjax-config">
-  MathJax.Hub.Config({ TeX: { extensions: ["autoload-all.js"] }});
+  MathJax.Hub.Config({
+    tex2jax: {
+      inlineMath:  [ ['$','$'],   ['\\(','\\)']],
+      displayMath: [ ['$$','$$'], ['\[','\]'] ],
+      processEscapes: true
+    },
+    TeX: { extensions: ["autoload-all.js"] }});
   </script>
   <script>(function(d,j){
   j = d.createElement('script');

lib/gollum/markup.rb

@@ -543,7 +543,9 @@ module Gollum
       blocks.each do |lang, code|
         encoding ||= 'utf-8'
         begin
-          hl_code = Pygments.highlight(code, :lexer => lang, :options => {:encoding => encoding.to_s})
+          # must set startinline to true for php to be highlighted without <?
+          # http://pygments.org/docs/lexers/
+          hl_code = Pygments.highlight(code, :lexer => lang, :options => {:encoding => encoding.to_s, :startinline => true})
         rescue
           hl_code = code
         end

lib/gollum/wiki.rb

@@ -154,6 +154,9 @@ module Gollum
     #           :ref - String the repository ref to retrieve pages from
     #           :ws_subs       - Array of chars to sub for ws in filenames.
     #           :mathjax       - Set to false to disable mathjax.
+    #           :show_all      - Show all files in file view, not just valid pages.
+    #                            Default: false
+    #           :collapse_tree - Start with collapsed file view. Default: false
     #
     # Returns a fresh Gollum::Repo.
     def initialize(path, options = {})
@@ -180,6 +183,8 @@ module Gollum
       @live_preview  = options.fetch(:live_preview, true)
       @universal_toc = options.fetch(:universal_toc, false)
       @mathjax = options[:mathjax] || false
+      @show_all = options[:show_all] || false
+      @collapse_tree = options[:collapse_tree] || false
     end
 
     # Public: check whether the wiki's git repo exists on the filesystem.
@@ -588,6 +593,13 @@ module Gollum
     # Toggles mathjax.
     attr_reader :mathjax
 
+    # Toggles showing all files in files view. Default is false.
+    # When false, only valid pages in the git repo are displayed.
+    attr_reader :show_all
+
+    # Start with collapsed file view. Default: false
+    attr_reader :collapse_tree
+
     # Normalize the data.
     #
     # data - The String data to be normalized.

test/test_file_view.rb

@@ -12,6 +12,10 @@ class FakePage
     ::File.basename(@filepath, ::File.extname(@filepath))
   end
 
+  def filename
+    ::File.basename(@filepath)
+  end
+
   def path
     return @filepath
   end