gollum_rails 1.4.0.rc1 → 1.4.0.rc2

data/README.md

@@ -1,74 +1,74 @@
-Gollum for Rails
-================
-[![Build Status](https://travis-ci.org/nirnanaaa/gollum_rails.png?branch=master)](https://travis-ci.org/nirnanaaa/gollum_rails)
-[![Dependency Status](https://gemnasium.com/nirnanaaa/gollum_rails.png)](https://gemnasium.com/nirnanaaa/gollum_rails)
-[![Gem Version](https://badge.fury.io/rb/gollum_rails.png)](http://badge.fury.io/rb/gollum_rails)
-[![Coverage Status](https://coveralls.io/repos/nirnanaaa/gollum_rails/badge.png?branch=master)](https://coveralls.io/r/nirnanaaa/gollum_rails)
-
-
-gollum_rails combines the git-powered wiki software gollum with the extremely popular webframework rails.
-It improves the lightweight "gollum" experience which is quite awesome.
-
-with gollum_rails you can:
-
-* Define your own views
-* Use your Rails layouts
-* Embed gollum it without mounting any rack application
-* Use own preprocession e.g. background workers for data procession
-* Use user authentication e.g. Devise or Authlogic
-
-## SYSTEM REQUIREMENTS
-- Python 2.5+ (2.7.3 recommended)
-- Ruby 1.9.3+ (2.0.0 recommended)
-- Unix like operating system (OS X, Ubuntu, Debian, and more)
-- Will not work on Windows (see [gollum](https://github.com/github/gollum/blob/master/README.md#system-requirements))
-
-## [Installation](https://github.com/nirnanaaa/gollum_rails/wiki/Installation)
-
-## [Usage](https://github.com/nirnanaaa/gollum_rails/wiki/Usage)
-
-
-## DEVELOPER
-
-Very cool. Just fork this repository and send me pull requests.
-
-### QUICK START
-
-Clone the repository:
-
-    $ git clone git://github.com/nirnanaaa/gollum_rails.git
-
-Run the [Bundler](http://gembundler.com/):
-
-    $ bundle install
-
-
-### TESTING
-
-First use the Quick Start to install all dependencies.
-All tests are stored under the `spec/` directory.
-
-To run tests just use the `rspec` command:
-
-    $ bundle exec rspec
-
-## LICENSE
-
-[![AGPLv3](http://www.gnu.org/graphics/agplv3-155x51.png)](http://www.gnu.org/licenses/agpl-3.0.en.html)
-
-gollum_rails is licensed under the AGPL license.
-
-Copyright (C) 2013  Florian Kasper
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+Gollum for Rails
+================
+[![Build Status](https://travis-ci.org/nirnanaaa/gollum_rails.png?branch=master)](https://travis-ci.org/nirnanaaa/gollum_rails)
+[![Dependency Status](https://gemnasium.com/nirnanaaa/gollum_rails.png)](https://gemnasium.com/nirnanaaa/gollum_rails)
+[![Gem Version](https://badge.fury.io/rb/gollum_rails.png)](http://badge.fury.io/rb/gollum_rails)
+[![Coverage Status](https://coveralls.io/repos/nirnanaaa/gollum_rails/badge.png?branch=master)](https://coveralls.io/r/nirnanaaa/gollum_rails)
+
+
+gollum_rails combines the git-powered wiki software gollum with the extremely popular webframework rails.
+It improves the lightweight "gollum" experience which is quite awesome.
+
+with gollum_rails you can:
+
+* Define your own views
+* Use your Rails layouts
+* Embed gollum it without mounting any rack application
+* Use own preprocession e.g. background workers for data procession
+* Use user authentication e.g. Devise or Authlogic
+
+## SYSTEM REQUIREMENTS
+- Python 2.5+ (2.7.3 recommended)
+- Ruby 1.9.3+ (2.0.0 recommended)
+- Unix like operating system (OS X, Ubuntu, Debian, and more)
+- Will not work on Windows (see [gollum](https://github.com/github/gollum/blob/master/README.md#system-requirements))
+
+## [Installation](https://github.com/nirnanaaa/gollum_rails/wiki/Installation)
+
+## [Usage](https://github.com/nirnanaaa/gollum_rails/wiki/Usage)
+
+
+## DEVELOPER
+
+Very cool. Just fork this repository and send me pull requests.
+
+### QUICK START
+
+Clone the repository:
+
+    $ git clone git://github.com/nirnanaaa/gollum_rails.git
+
+Run the [Bundler](http://gembundler.com/):
+
+    $ bundle install
+
+
+### TESTING
+
+First use the Quick Start to install all dependencies.
+All tests are stored under the `spec/` directory.
+
+To run tests just use the `rspec` command:
+
+    $ bundle exec rspec
+
+## LICENSE
+
+[![AGPLv3](http://www.gnu.org/graphics/agplv3-155x51.png)](http://www.gnu.org/licenses/agpl-3.0.en.html)
+
+gollum_rails is licensed under the AGPL license.
+
+Copyright (C) 2013  Florian Kasper
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -1,170 +1,170 @@
-require 'rubygems'
-require 'rake'
-require 'date'
-require 'rspec/core/rake_task'
-
-
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-# assumes x.y.z all digit version
-def next_version
-  # x.y.z
-  v = version.split '.'
-  # bump z
-  v[-1] = v[-1].to_i + 1
-  v.join '.'
-end
-
-def bump_version
-  old_file = File.read("lib/#{name}.rb")
-  old_version_line = old_file[/^\s*VERSION\s*=\s*.*/]
-  new_version = next_version
-  # replace first match of old vesion with new version
-  old_file.sub!(old_version_line, "  VERSION = '#{new_version}'")
-
-  File.write("lib/#{name}.rb", old_file)
-
-  new_version
-end
-
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
-
-task :default => :spec_run
-
-desc "Run RSpec"
-RSpec::Core::RakeTask.new do |t|
-    t.verbose = false
-end
-
-desc "Run specs"
-task :spec_run do
-  begin
-    sh "rake spec"
-  rescue RuntimeError => e
-    puts e.message
-    exit(1)
-  end
-end
-
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-#############################################################################
-#
-# Custom tasks (add your own tasks here)
-#
-#############################################################################
-
-desc "Update version number and gemspec"
-task :bump do
-  puts "Updated version to #{bump_version}"
-  # Execute does not invoke dependencies.
-  # Manually invoke gemspec then validate.
-  Rake::Task[:gemspec].execute
-  Rake::Task[:validate].execute
-end
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc 'Create a release build'
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    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}"
-  sh "gem push pkg/#{name}-#{version}.gem"
-end
-
-desc 'Build gem'
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-desc 'Update gemspec'
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(doc|pkg|script|config|Home\.md|\.gitattributes)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
-
-desc 'Validate lib files and version file'
-task :validate do
-  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/generators"]
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
-end
-
+require 'rubygems'
+require 'rake'
+require 'date'
+require 'rspec/core/rake_task'
+
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+# assumes x.y.z all digit version
+def next_version
+  # x.y.z
+  v = version.split '.'
+  # bump z
+  v[-1] = v[-1].to_i + 1
+  v.join '.'
+end
+
+def bump_version
+  old_file = File.read("lib/#{name}.rb")
+  old_version_line = old_file[/^\s*VERSION\s*=\s*.*/]
+  new_version = next_version
+  # replace first match of old vesion with new version
+  old_file.sub!(old_version_line, "  VERSION = '#{new_version}'")
+
+  File.write("lib/#{name}.rb", old_file)
+
+  new_version
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :spec_run
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |t|
+    t.verbose = false
+end
+
+desc "Run specs"
+task :spec_run do
+  begin
+    sh "rake spec"
+  rescue RuntimeError => e
+    puts e.message
+    exit(1)
+  end
+end
+
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+desc "Update version number and gemspec"
+task :bump do
+  puts "Updated version to #{bump_version}"
+  # Execute does not invoke dependencies.
+  # Manually invoke gemspec then validate.
+  Rake::Task[:gemspec].execute
+  Rake::Task[:validate].execute
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc 'Create a release build'
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    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}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc 'Build gem'
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc 'Update gemspec'
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(doc|pkg|script|config|Home\.md|\.gitattributes)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc 'Validate lib files and version file'
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/generators"]
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end
+