olelo 0.9.2 → 0.9.3

data/README.creole

@@ -0,0 +1,127 @@
+= Ōlelo Wiki
+
+Ōlelo is a wiki that stores pages in a [[http://git-scm.org/|Git]] repository, supports many markup styles and has an extensible, hackable architecture!
+If you want to see a demo installation go to http://www.gitwiki.org/.
+
+== Features
+
+Ōlelo implements a plugin system. A lot of the features are implemented as plugins and can be activated or deactivated as you wish.
+
+Core features:
+* Edit, move or delete pages
+* Page attribute editor
+* Support for hierarchical wikis (directory structure)
+* File upload
+* History, commit and diff view
+
+Features, implemented by plugins:
+* Support for many markup languages (Creole, Markdown, Textile, ...)
+* RSS/Atom changelog for whole wiki or pages
+* Section editing for Creole and Markdown markup
+* Embedded LaTeX formulas (Rendered as image or using [[http://mathjax.org/|MathJax]]
+* Syntax highlighted embedded code blocks
+* Image resizing, SVG to PNG/JPEG conversion
+* Auto-generated table of contents
+* Wiki syntax can be extended with tags
+* Editor preview
+* View pages as S5 presentation
+* Privacy features: Access control lists, Private wiki which needs login, readonly wiki
+
+== Quick start
+
+The best way to install Ōlelo is via 'gem'.
+
+{{{
+$ gem install olelo
+}}}
+
+Go to a git repository via command line and start the Ōlelo webserver.
+
+{{{
+$ olelo
+}}}
+
+Point your web browser at http://localhost:8080/.
+
+== Installation from source
+
+Installation from source is especially useful if you want to do development or use the newest features.
+
+Clone the git repository:
+
+{{{
+git clone git://github.com/minad/olelo.git
+}}}
+
+Now change to the Ōlelo source directory and use Bundler to install the dependencies.
+
+{{{
+$ cd olelo
+$ bundle install
+}}}
+
+Start the Ōlelo webserver from the Ōlelo source directory.
+
+{{{
+$ bin/olelo
+}}}
+
+== Deployment
+
+For production purposes, I recommend that you deploy the wiki with [[http://unicorn.bogomips.org|Unicorn]]. You should use the rackup configuration from the Ōlelo source or gem directory.
+
+{{{
+$ unicorn path-to/config.ru
+}}}
+
+Unicorn is a very flexible ruby application server and Ōlelo runs very well on it. You can adapt the number of Unicorn workers depending on the load you expect. It is
+a good idea to observe the Unicorn workers as described in https://github.com/blog/519-unicorn-god and kill missbehaving workers if necessary.
+
+== Configuration
+
+For deployment you might want to tweak some settings. Ōlelo reads the files config/config.yml.default and config/config.yml in that order.
+So just copy the default configuration config/config.yml.default to config/config.yml and make your modifications. If you installed Ōlelo
+as gem this is not a good idea since you don't want to fiddle in the gem directory. For this purpose exists the environment variable OLELO_CONFIG which
+can point to the configuration file that you want to use.
+
+{{{
+export OLELO_CONFIG=/home/olelo/olelo_config.yml
+}}}
+
+You can also use the OLELO_CONFIG environment variable if you want to run multiple Ōlelo instances with different configurations.
+
+== Dependencies
+
+If you use Bundler or installed Ōlelo as gem you don't really have to care about the dependencies. The standard installation provides the core dependencies and a good selection of optional dependencies.
+
+Core dependencies:
+* [[http://www.git-scm.com|Git]]
+* [[http://slim-lang.com/|Slim template language]]
+* [[http://libgit2.github.com/|Rugged git library]]
+* [[http://rack.github.com/|Rack]]
+* [[https://github.com/minad/mimemagic/|MimeMagic]]
+
+Some dependencies are optional, for example depending on the markup you want to use.
+* [[https://github.com/minad/creole|Creole markup library]]
+* [[https://github.com/vmg/redcarpet|Redcarpet Markdown library]]
+* [[http://redcloth.org/|RedCloth Textile markup library]]
+* [[http://www.imagemagick.org/|ImageMagick for image resizing]]
+* [[http://nokogiri.org/|Nokogiri for auto-generated table of contents]]
+* [[http://pygments.org/|Pygments for syntax highlighting of code blocks]]
+
+== Authors
+
+Git-Wiki was originally developed by Simon Rozet. The development of Ōlelo to its current state was done by Daniel Mendler and contributors.
+The current code base doesn't have much in common with the original Git-Wiki proof-of-concept.
+
+Contributors:
+* Alex Eagle
+* Alex Wall
+* Hrvoje
+* Luca Greco
+* Pavel Suchmann
+* Raffael Schmid
+
+== License
+
+Ōlelo is released under the MIT license.

data/Rakefile

@@ -75,8 +75,8 @@ end
 
 desc 'Generate documentation'
 namespace :doc do
-  task :gen    do; system("yard doc -o doc/api -e lib/yard/addons.rb --backtrace 'lib/**/*.rb' 'plugins/**/*.rb'"); end
-  task :server do; system('yard server --reload -e lib/yard/addons.rb --backtrace'); end
+  task :gen    do; system("yard doc -o doc/api 'lib/**/*.rb' 'plugins/**/*.rb'"); end
+  task :server do; system('yard server --reload'); end
   task :check  do; system("yardcheck 'lib/**/*.rb' 'plugins/**/*.rb'"); end
 end
 

data/bin/olelo

@@ -1,5 +1,58 @@
 #!/usr/bin/env ruby
 
 require 'rack'
-Rack::Server.start(:Port => 8080,
-                   :config => ::File.expand_path(::File.join(__FILE__, '..', '..', 'config.ru')))
+require 'optparse'
+
+help = %{Usage: olelo [OPTIONS] [PATH]
+
+        PATH                         The path to the git repository to serve from (default .).
+
+Options:
+}
+
+options = {
+  :port => 8080,
+  :host => '0.0.0.0'
+}
+
+app_path = File.expand_path(File.join(__FILE__, '..', '..'))
+
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on('-p', '--port [PORT]', 'Bind port (default 8080).') do |port|
+    options[:port] = port.to_i
+  end
+
+  opts.on('-o', '--host [HOST]', 'Hostname or IP address to listen on (default 0.0.0.0).') do |host|
+    options[:host] = host
+  end
+
+  opts.on('-c', '--config [CONFIG]', 'Path to the Olelo configuration, sets the $OLELO_CONFIG environment variable.') do |config|
+    ENV['OLELO_CONFIG'] = File.expand_path(config)
+  end
+
+  opts.on('-v', '--version', 'Display current version.') do
+    require File.join(app_path, 'lib', 'olelo', 'version.rb')
+    puts "Olelo #{Olelo::VERSION}"
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+end
+opts.parse!(ARGV)
+
+if ARGV.size == 1
+  Dir.chdir(ARGV.first)
+elsif ARGV.size > 1
+  puts "Too many arguments: #{ARGV.join(' ')}"
+  puts opts
+  exit
+end
+
+Rack::Server.start(:Port => options[:port],
+                   :Host => options[:host],
+                   :config => File.join(app_path, 'config.ru'))

data/config.ru

@@ -7,7 +7,6 @@ $: << ::File.join(app_path, 'lib')
 Encoding.default_external = Encoding::UTF_8
 
 require 'fileutils'
-require 'rack/olelo_patches'
 require 'rack/relative_redirect'
 require 'rack/static_cache'
 require 'olelo'
@@ -43,14 +42,33 @@ else
   puts 'No default data storage location defined, please create your own configuration!'
 end
 
-Olelo::Config.instance.load(ENV['OLELO_CONFIG'] || ENV['WIKI_CONFIG'] || ::File.join(app_path, 'config', 'config.yml'))
+if config = ENV['OLELO_CONFIG'] || ENV['WIKI_CONFIG']
+  Olelo::Config.instance.load!(config)
+else
+  Olelo::Config.instance.load(::File.join(app_path, 'config', 'config.yml'))
+end
+
 Olelo::Config.instance.freeze
 
 FileUtils.mkpath ::File.dirname(Olelo::Config['log.file'])
 logger = ::Logger.new(Olelo::Config['log.file'], :monthly, 10240000)
 logger.level = ::Logger.const_get(Olelo::Config['log.level'])
 
-use_lint if !Olelo::Config['production']
+# Doesn't work currently, rack issue #241
+# if !Olelo::Config['production']
+#   # Rack::Lint injector
+#   module UseLint
+#     def use(middleware, *args, &block)
+#       super Rack::Lint if middleware != Rack::Lint
+#       super
+#     end
+#     def run(app)
+#       use Rack::Lint
+#       super
+#     end
+#   end
+#   class << self; include UseLint; end
+# end
 
 use Rack::Runtime
 use Rack::ShowExceptions if !Olelo::Config['production']
@@ -70,7 +88,6 @@ end
 
 use Rack::MethodOverride
 use Rack::CommonLogger, LoggerOutput.new(logger)
-
 use Olelo::Middleware::ForceEncoding
 use Olelo::Middleware::Flash, :set_accessors => %w(error warn info)
 use Rack::RelativeRedirect

data/config/aspects.rb

@@ -9,13 +9,15 @@
 #
 ################################################################################
 
-regexp :remove_comments, /<!--.*?-->/m,              ''
-regexp :tag_shortcuts,   /\\\((.*?)\\\)/m,           '<math display="inline">\1</math>',
-                         /\\\[(.*?)\\\]/m,           '<math display="block">\1</math>',
-                         /<<(.*?)(\|(.*?))?>>/,      '<include page="\1" \3/>'
-regexp :creole_nowiki,   /\{\{\{.*?\}\}\}/m,         '<notags>\0</notags>'
-regexp :textile_nowiki,  /<pre>.*?<\/pre>/m,         '<notags>\0</notags>'
-regexp :mediawiki_nowiki,  /<nowiki>.*?<\/nowiki>/m, '<notags>\0</notags>'
+regexp :remove_comments, /<!--.*?-->/m,                 ''
+regexp :tag_shortcuts,   /\\\((.*?)\\\)/m,              '<math display="inline">\1</math>',
+                         /\\\[(.*?)\\\]/m,              '<math display="block">\1</math>',
+                         /<<(.*?)(\|(.*?))?>>/,         '<include page="\1" \3/>',
+                         /^~~~\s*(\w+)\s*$(.*?)^~~~$/m, '<code lang="\1">\2</code>',
+                         /^```\s*(\w+)\s*$(.*?)^```$/m, '<code lang="\1">\2</code>'
+regexp :creole_nowiki,   /\{\{\{.*?\}\}\}/m,            '<notags>\0</notags>'
+regexp :textile_nowiki,  /<pre>.*?<\/pre>/m,            '<notags>\0</notags>'
+regexp :mediawiki_nowiki,  /<nowiki>.*?<\/nowiki>/m,    '<notags>\0</notags>'
 
 ################################################################################
 #

data/config/config.yml.default

@@ -113,6 +113,7 @@ disabled_plugins:
   - security/readonly_wiki
   - security/private_wiki
   - editor/recaptcha
+  - editor/ace
 
 ##################################################
 # Rack middleware configurations

data/lib/olelo.rb

@@ -8,6 +8,7 @@ require 'open3'
 require 'set'
 require 'yaml'
 require 'mimemagic'
+require 'socket'
 
 begin
   require 'yajl/json_gem'

data/lib/olelo/application.rb

@@ -15,11 +15,13 @@ module Olelo
                      :edit_buttons, :attributes_buttons, :upload_buttons
     has_hooks :auto_login, :render, :menu, :head, :script
 
-    class<< self
-      attr_accessor :reserved_paths
-      def reserved_path?(path)
-        path = '/' + path.cleanpath
-        reserved_paths.any? {|pattern| path =~ pattern }
+    def self.reserved_path?(path)
+      path = '/' + path.cleanpath
+      path.starts_with?('/static') ||
+      router.any? do |method, r|
+        r.any? do |name,pattern,keys,function|
+          name !~ /^\/\(?:path\)?$/ && pattern.match(path)
+        end
       end
     end
 
@@ -109,7 +111,7 @@ module Olelo
     post '/signup' do
       on_error :login
       raise 'Sign-up is disabled' if !Config['authentication.enable_signup']
-      User.current = User.create(params[:user], params[:password],
+      User.current = User.signup(params[:user], params[:password],
                                  params[:confirm], params[:email])
       redirect build_path('/')
     end
@@ -127,9 +129,13 @@ module Olelo
     post '/profile' do
       raise 'Anonymous users do not have a profile.' if !User.logged_in?
       on_error :profile
-      User.current.modify do |u|
-        u.change_password(params[:oldpassword], params[:password], params[:confirm]) if !params[:password].blank?
-        u.email = params[:email]
+      if User.supports?(:change_password) && !params[:password].blank?
+        User.current.change_password(params[:oldpassword], params[:password], params[:confirm])
+      end
+      if User.supports?(:update)
+        User.current.update do |u|
+          u.email = params[:email]
+        end
       end
       flash.info! :changes_saved.t
       render :profile
@@ -259,20 +265,25 @@ module Olelo
 
     def show_page
       @menu_versions = true
-      halt render(:show, :locals => {:content => page.try(:content)})
+      render(:show, :locals => {:content => page.try(:content)})
     end
 
-    get '/version/:version(/:path)|/(:path)', :tail => true do
+    get '/(:path)', :tail => true do
       begin
-        @page = Page.find!(params[:path], params[:version])
+        @page = Page.find!(params[:path])
         cache_control :version => page.version
         show_page
       rescue NotFound
-        redirect build_path(params[:path], :action => :new) if params[:version].blank?
-        raise
+        redirect build_path(params[:path], :action => :new)
       end
     end
 
+    get '/version/:version(/:path)' do
+      @page = Page.find!(params[:path], params[:version])
+      cache_control :version => page.version
+      show_page
+    end
+
     post '/(:path)', :tail => true do
       action, @close = params[:action].to_s.split('-', 2)
       if respond_to? "post_#{action}"

data/lib/olelo/config.rb

@@ -7,7 +7,7 @@ module Olelo
     def initialize(base = nil)
       @hash = {}
       @base = base.freeze
-   end
+    end
 
     def [](key)
       key = key.to_s

data/lib/olelo/extensions.rb

@@ -49,18 +49,6 @@ class Module
     end
     include(Module.new { define_method(name, &block) })
   end
-
-  if method(:const_defined?).arity == 1
-    # Ruby 1.8
-    def local_const_defined?(const)
-      const_defined?(const)
-    end
-  else
-    # Ruby 1.9
-    def local_const_defined?(const)
-      const_defined?(const, false)
-    end
-  end
 end
 
 class Hash

data/lib/olelo/helper.rb

@@ -246,10 +246,6 @@ module Olelo
       include_or_define_block(:title,  content, &block)
     end
 
-    def script
-      invoke_hook(:script).join.html_safe
-    end
-
     def head
       @@theme_link ||=
         begin

data/lib/olelo/initializer.rb

@@ -15,7 +15,7 @@ module Olelo
       init_locale
       init_templates
       init_plugins
-      init_routes
+      show_routes if Olelo.logger.debug?
       init_scripts
     end
 
@@ -41,7 +41,7 @@ module Olelo
     end
 
     def init_plugins
-      # Load locales for loaded plugins
+      # Load locales provided by plugins
       Plugin.after(:load) { Locale.load(File.join(File.dirname(file), 'locale.yml')) }
 
       # Configure plugin system
@@ -52,16 +52,13 @@ module Olelo
       Plugin.start
     end
 
-    def init_routes
-      Application.reserved_paths = Application.router.map do |method, router|
-        router.head.map {|name, pattern, keys, function| pattern }
-      end.flatten
+    def show_routes
       Application.router.each do |method, router|
         Olelo.logger.debug method
         router.each do |name, pattern, keys, function|
           Olelo.logger.debug "#{name} -> #{pattern.inspect}"
         end
-      end if Olelo.logger.debug?
+      end
     end
 
     def init_scripts