Release 2.3.10

Only alert on changes

README.md

@@ -532,9 +532,17 @@ Your Rack middleware can pass author details to Gollum in a Hash in the session
 ## WINDOWS FILENAME VALIDATION
 Note that filenames on windows must not contain any of the following characters `\ / : * ? " < > |`. See [this support article](http://support.microsoft.com/kb/177506) for details.
 
-## LIB.SO ERROR
+## CONFIG FILE
 
-`Could not open library 'lib.so'` may be solved by installing `python-devel` on Fedora or `python-dev` on Ubuntu. Gentoo requires a rubypython [patch](https://gist.github.com/2802480) to use python2.7.
+Gollum optionally takes a `--config file`. See [config.rb](https://github.com/github/gollum/blob/master/config.rb) for an example.
+
+## CUSTOM CSS
+
+The `--css` flag will inject `custom.css` from the root of your git repository into each page. Here's an example of floating the sidebar to the left.
+
+```css
+#wiki-rightbar { float: left !important; }
+```
 
 ## CONTRIBUTE
 

bin/gollum

@@ -45,6 +45,10 @@ opts = OptionParser.new do |opts|
     options['irb'] = true
   end
 
+  opts.on("--css", "Inject custom css. Uses custom.css from root repository") do
+    wiki_options[:css] = true
+  end
+
   opts.on("--page-file-dir [PATH]", "Specify the sub directory for all page files (default: repository root).") do |path|
     wiki_options[:page_file_dir] = path
   end

config.rb

@@ -0,0 +1,28 @@
+# Example gollum config
+# gollum ../wiki --config config.rb
+#
+# or run from source with
+#
+# bundle exec bin/gollum ../wiki/ --config config.rb
+
+# Remove const to avoid
+# warning: already initialized constant FORMAT_NAMES
+#
+# only remove if it's defined.
+# constant Gollum::Page::FORMAT_NAMES not defined (NameError)
+Gollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES
+# limit to one format
+Gollum::Page::FORMAT_NAMES = { :markdown  => "Markdown" }
+
+=begin
+Valid formats are:
+{ :markdown  => "Markdown",
+  :textile   => "Textile",
+  :rdoc      => "RDoc",
+  :org       => "Org-mode",
+  :creole    => "Creole",
+  :rest      => "reStructuredText",
+  :asciidoc  => "AsciiDoc",
+  :mediawiki => "MediaWiki",
+  :pod       => "Pod" }
+=end

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.7'
-  s.date              = '2012-11-06'
+  s.version           = '2.3.10'
+  s.date              = '2012-11-07'
   s.rubyforge_project = 'gollum'
 
   s.summary     = "A simple, Git-powered wiki."
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
     README.md
     Rakefile
     bin/gollum
+    config.rb
     docs/sanitization.md
     gollum.gemspec
     lib/gollum.rb

lib/gollum.rb

@@ -23,7 +23,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.7'
+  VERSION = '2.3.10'
 
   def self.assets_path
     ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))

lib/gollum/frontend/app.rb

@@ -238,6 +238,7 @@ module Precious
       @content = @page.formatted_data
       @toc_content = wiki.universal_toc ? @page.toc_data : nil
       @mathjax = wiki.mathjax
+      @css = wiki.css
       @editable = false
       mustache :page
     end
@@ -360,6 +361,7 @@ module Precious
         @content = page.formatted_data
         @toc_content = wiki.universal_toc ? @page.toc_data : nil
         @mathjax = wiki.mathjax
+        @css = wiki.css
         mustache :page
       elsif file = wiki.file(fullpath)
         content_type file.mime_type

lib/gollum/frontend/public/gollum/javascript/gollum.js

@@ -212,4 +212,20 @@ $(document).ready(function() {
       $('#gollum-revert-form').submit();
     });
   }
+
+  if( $('#wiki-wrapper.edit').length ){
+    $("#gollum-editor-submit").click( function() { window.onbeforeunload = null; } );
+    $("#gollum-editor-body").one('change', function(){
+      window.onbeforeunload = function(){ return "Leaving will discard all edits!" };
+    });
+    $.GollumEditor();
+  }
+
+  if( $('#wiki-wrapper.create').length ){
+    $("#gollum-editor-submit").click( function() { window.onbeforeunload = null; } );
+    $("#gollum-editor-body").one('change', function(){
+      window.onbeforeunload = function(){ return "Leaving will not create a new page!" };
+    )};
+    $.GollumEditor({ NewFile: true, MarkupType: '{{default_markup}}' });
+  }
 });

lib/gollum/frontend/templates/create.mustache

@@ -1,4 +1,4 @@
-<div id="wiki-wrapper">
+<div id="wiki-wrapper" class="create">
 <div id="head">
   <h1>Create New Page</h1>
 </div>
@@ -8,13 +8,5 @@
   </div>
 </div>
 </div>
-<script type="text/javascript">
-window.onbeforeunload = function(){ return "Leaving will not create a new page!" };
-$("#gollum-editor-submit").click( function() { window.onbeforeunload = null; } );
-
-jQuery(document).ready(function() {
-  $.GollumEditor({ NewFile: true, MarkupType: '{{default_markup}}' });
-});
-</script>
 
 {{something}}

lib/gollum/frontend/templates/edit.mustache

@@ -10,11 +10,3 @@
 </div>
   <div id="wiki-content">{{>editor}}</div>
 </div>
-<script type="text/javascript">
-window.onbeforeunload = function(){ return "Leaving will discard all edits!" };
-$("#gollum-editor-submit").click( function() { window.onbeforeunload = null; } );
-
-jQuery(document).ready(function() {
-  $.GollumEditor();
-});
-</script>

lib/gollum/frontend/templates/layout.mustache

@@ -6,6 +6,7 @@
   <link rel="stylesheet" type="text/css" href="{{base_url}}/css/editor.css" media="all">
   <link rel="stylesheet" type="text/css" href="{{base_url}}/css/dialog.css" media="all">
   <link rel="stylesheet" type="text/css" href="{{base_url}}/css/template.css" media="all">
+  {{#css}}<link rel="stylesheet" type="text/css" href="{{base_url}}/custom.css" media="all">{{/css}}
 
   <!--[if IE 7]>
   <link rel="stylesheet" type="text/css" href="{{base_url}}/css/ie7.css" media="all">

lib/gollum/frontend/views/page.rb

@@ -80,6 +80,10 @@ module Precious
         @mathjax
       end
 
+      def css # custom css
+        @css
+      end
+
       # Access to embedded metadata.
       #
       # Examples

lib/gollum/wiki.rb

@@ -137,6 +137,10 @@ module Gollum
     # Gets the boolean live preview value.
     attr_reader :live_preview
 
+    # Injects custom css from custom.css in root repo.
+    # Defaults to false
+    attr_reader :css
+
     # Public: Initialize a new Gollum Repo.
     #
     # path    - The String path to the Git repository that holds the Gollum
@@ -166,26 +170,32 @@ module Gollum
         options[:access] = path
         path             = path.path
       end
-      @path          = path
-      @repo_is_bare  = options[:repo_is_bare]
-      @page_file_dir = options[:page_file_dir]
-      @access        = options[:access]       || GitAccess.new(path, @page_file_dir, @repo_is_bare)
-      @base_path     = options[:base_path]    || "/"
-      @page_class    = options[:page_class]   || self.class.page_class
-      @file_class    = options[:file_class]   || self.class.file_class
-      @markup_classes = options[:markup_classes] || self.class.markup_classes
-      @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
-      @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
+
+      # Use .fetch instead of ||
+      #
+      # o = { :a => false }
+      # o[:a] || true # => true
+      # o.fetch :a, true # => false
+
+      @path                 = path
+      @repo_is_bare         = options.fetch :repo_is_bare, nil
+      @page_file_dir        = options.fetch :page_file_dir, nil
+      @access               = options.fetch :access, GitAccess.new(path, @page_file_dir, @repo_is_bare)
+      @base_path            = options.fetch :base_path, "/"
+      @page_class           = options.fetch :page_class, self.class.page_class
+      @file_class           = options.fetch :file_class, self.class.file_class
+      @markup_classes       = options.fetch :markup_classes, self.class.markup_classes
+      @repo                 = @access.repo
+      @ref                  = options.fetch :ref, self.class.default_ref
+      @sanitization         = options.fetch :sanitization, self.class.sanitization
+      @ws_subs              = options.fetch :ws_subs, self.class.default_ws_subs
+      @history_sanitization = options.fetch :history_sanitization, self.class.history_sanitization
+      @live_preview         = options.fetch :live_preview, true
+      @universal_toc        = options.fetch :universal_toc, false
+      @mathjax              = options.fetch :mathjax, false
+      @show_all             = options.fetch :show_all, false
+      @collapse_tree        = options.fetch :collapse_tree, false
+      @css                  = options.fetch :css, false
     end
 
     # Public: check whether the wiki's git repo exists on the filesystem.