olelo 0.9.0

data/.gitignore

@@ -0,0 +1,10 @@
+*.log
+*.swp
+*.rbc
+.wiki
+.yardoc
+config.yml
+doc/api
+coverage
+attic
+test/.test

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "deps/diascope"]
+	path = deps/diascope
+	url = git://github.com/minad/diascope.git

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+

data/README.markdown

@@ -0,0 +1,104 @@
+README
+======
+
+Ōlelo is a wiki that stores pages in a [Git][] repository.
+See the demo installation at <http://www.gitwiki.org/>.
+
+Features
+--------
+
+A lot of the features are implemented as plugins.
+
+- Edit, move or delete pages
+- Support for hierarchical wikis (directory structure)
+- Upload files
+- History (also as RSS/Atom changelog)
+- Access control lists
+- Support for multiple text engines (Creole, Markdown, Textile, ...)
+- Section editing for creole markup
+- Embedded LaTeX/Graphviz graphics
+- Syntax highlighting (embedded code blocks)
+- Image resizing, SVG to bitmap conversion
+- Auto-generated table of contents
+- Templates via include-tag
+- XML tag soup can be used to extend Wiki syntax
+- View pages as S5 presentation
+
+Installation
+------------
+
+The best way to install olelo is via `gem`:
+
+    $ gem install olelo
+
+If you run olelo from source you can use Bundler to install the dependencies.
+
+    $ bundle install
+
+Running
+-------
+
+If you installed via gem, go to a git repository via command line and execute:
+
+    $ olelo
+
+If you installed from source you can run the rackup configuration from the olelo application directory:
+
+    $ unicorn
+
+Point your web browser at <http://localhost:8080>.
+
+For production purposes, I recommend that you deploy the wiki with Unicorn.
+I tested other webservers like thin, rainbows, webrick and mongrel.
+
+Configuration
+-------------
+
+You might want to deploy the wiki on a server and want to tweak some settings.
+Just copy the default configuration config/config.yml.default to config/config.yml.
+You can specify a different configuration file via the environment variable WIKI_CONFIG.
+
+    export WIKI_CONFIG=/home/user/wiki_config.yml
+
+Dependencies
+------------
+
+- [Nokogiri][]
+- [Slim][]
+- [Rugged][]
+- [Rack][]
+- [MimeMagic][]
+
+### Optional Dependencies
+
+- [Pygments][] for syntax highlighting
+- [ImageMagick][] for image scaling and svg rendering
+- [RubyPants][] to fix punctuation
+
+### Dependencies for page rendering
+
+At least one of these renderers should be installed:
+
+- [creole][] for creole wikitext rendering
+  (`creole` Gem from [gemcutter][])
+- [RedCarpet][] for Markdown rendering
+- [RedCloth][] for Textile rendering
+- [org-ruby][] for org-mode rendering
+
+[creole]:http://github.com/minad/creole
+[mimemagic]:http://github.com/minad/mimemagic
+[Gem]:http://rubygems.org
+[Git]:http://www.git-scm.org
+[rack]:http://rack.rubyforge.org/
+[org-ruby]:http://orgmode.org/worg/org-tutorials/org-ruby.php
+[GraphViz]:http://www.graphviz.org
+[SLIM]:http://github.com/stonean/slim
+[nokogiri]:http://nokogiri.org/
+[LaTeX]:www.latex-project.org
+[pygments]:http://pygments.org/
+[RedCarpet]:http://github.com/tanoku/redcarpet
+[RedCloth]:http://redcloth.org/
+[ImageMagick]:http://www.imagemagick.org/
+[gitrb]:http://github.com/minad/gitrb/
+[gemcutter]:http://gemcutter.org/
+[RubyPants]:http://chneukirchen.org/blog/static/projects/rubypants.html

data/Rakefile

@@ -0,0 +1,92 @@
+task :default => %w(test:spec)
+
+def shrink_js(t)
+  #sh "cat #{t.prerequisites.sort.join(' ')} > #{t.name}"
+  sh 'java -jar tools/google-compiler*.jar --dev_mode EVERY_PASS --compilation_level SIMPLE_OPTIMIZATIONS ' +
+     t.prerequisites.sort.map {|x| "--js #{x}" }.join(' ')  + " > #{t.name}"
+end
+
+def sass(file)
+  `sass -C -I #{File.dirname(file)} -I static/themes -t compressed #{file}`
+end
+
+def spew(file, content)
+  File.open(file, 'w') {|f| f.write(content) }
+end
+
+file 'plugins/utils/pygments.scss' do
+  sh "pygmentize -S default -f html -a .highlight > plugins/utils/pygments.scss"
+end
+
+file('static/themes/atlantis/style.css' => Dir.glob('static/themes/atlantis/*.scss') + Dir.glob('static/themes/lib/*.scss')) do |t|
+  puts "Creating #{t.name}..."
+  content = "@media screen{#{sass(t.name.gsub('style.css', 'screen.scss'))}}@media print{#{sass(t.name.gsub('style.css', 'print.scss'))}}"
+  spew(t.name, content)
+end
+
+rule '.css' => ['.scss'] do |t|
+  puts "Creating #{t.name}..."
+  spew(t.name, sass(t.source))
+end
+
+file('static/script.js' => Dir.glob('static/script/*.js')) { |t| shrink_js(t) }
+file('plugins/treeview/script.js' => Dir.glob('plugins/treeview/script/*.js')) {|t| shrink_js(t) }
+file('plugins/misc/fancybox/script.js' => Dir.glob('plugins/misc/fancybox/script/*.js')) {|t| shrink_js(t) }
+file('plugins/editor/markup/script.js' => Dir.glob('plugins/editor/markup/script/*.js')) {|t| shrink_js(t) }
+
+namespace :gen do
+  desc('Shrink JS files')
+  task :js => %w(static/script.js plugins/treeview/script.js plugins/misc/fancybox/script.js plugins/editor/markup/script.js)
+
+  desc('Compile CSS files')
+  task :css => %w(static/themes/atlantis/style.css
+                  plugins/treeview/treeview.css
+                  plugins/utils/pygments.css
+                  plugins/gallery/gallery.css
+                  plugins/misc/fancybox/jquery.fancybox.css
+                  plugins/blog/blog.css)
+end
+
+namespace :test do
+  desc 'Run tests with bacon'
+  task :spec => FileList['test/*_test.rb'] do |t|
+    sh "bacon -q -Ilib:test #{t.prerequisites.join(' ')}"
+  end
+
+  desc 'Generate test coverage report'
+  task :rcov => FileList['test/*_test.rb'] do |t|
+    sh "rcov -Ilib:test #{t.prerequisites.join(' ')}"
+  end
+end
+
+desc 'Cleanup'
+task :clean do |t|
+  FileUtils.rm_rf 'doc/api'
+  FileUtils.rm_rf 'coverage'
+  FileUtils.rm_rf '.wiki/cache'
+  FileUtils.rm_rf '.wiki/blahtex'
+  FileUtils.rm_rf '.wiki/log'
+end
+
+desc 'Remove wiki folder'
+task 'clean:all' => :clean do |t|
+  FileUtils.rm_rf '.wiki'
+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 :check  do; system("yardcheck 'lib/**/*.rb' 'plugins/**/*.rb'"); end
+end
+
+namespace :notes do
+  task :todo      do; system('ack T''ODO');      end
+  task :fixme     do; system('ack F''IXME');     end
+  task :hack      do; system('ack H''ACK');      end
+  task :warning   do; system('ack W''ARNING');   end
+  task :important do; system('ack I''MPORTANT'); end
+end
+
+desc 'Show annotations'
+task :notes => %w(notes:todo notes:fixme notes:hack notes:warning notes:important)

data/bin/olelo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rack'
+Rack::Server.start(:Port => 8080,
+                   :config => ::File.expand_path(::File.join(__FILE__, '..', '..', 'config.ru')))

data/config.ru

@@ -0,0 +1,86 @@
+#!/usr/bin/env rackup
+
+app_path = ::File.expand_path(::File.dirname(__FILE__))
+$: << ::File.join(app_path, 'lib')
+
+# We want to read all text data as UTF-8
+Encoding.default_external = Encoding::UTF_8
+
+require 'fileutils'
+require 'rack/olelo_patches'
+require 'rack/relative_redirect'
+require 'rack/static_cache'
+require 'olelo'
+require 'olelo/middleware/degrade_mime_type'
+require 'olelo/middleware/flash'
+require 'olelo/middleware/force_encoding'
+require 'securerandom'
+
+Olelo::Config.instance['app_path'] = app_path
+Olelo::Config.instance['config_path'] = ::File.join(app_path, 'config')
+Olelo::Config.instance['initializers_path'] = ::File.join(app_path, 'config', 'initializers')
+Olelo::Config.instance['plugins_path'] = ::File.join(app_path, 'plugins')
+Olelo::Config.instance['views_path'] = ::File.join(app_path, 'views')
+Olelo::Config.instance['themes_path'] = ::File.join(app_path, 'static', 'themes')
+Olelo::Config.instance['rack.session_secret'] = SecureRandom.hex
+Olelo::Config.instance.load!(::File.join(app_path, 'config', 'config.yml.default'))
+
+if Dir.pwd == app_path
+  puts "Serving from Olelo application directory #{app_path}"
+  data_path = File.join(app_path, '.wiki')
+  Olelo::Config.instance['repository.git'] = { :path => ::File.join(data_path, 'repository'), :bare => false }
+  Olelo::Config.instance['cache_store'] = { :type => 'file', 'file.root' => ::File.join(data_path, 'cache') }
+  Olelo::Config.instance['authentication.yamlfile.store'] = ::File.join(data_path, 'users.yml')
+  Olelo::Config.instance['log.file'] = ::File.join(data_path, 'log')
+elsif File.directory?(::File.join(Dir.pwd, '.git'))
+  puts "Serving out of repository #{Dir.pwd}"
+  data_path = File.join(Dir.pwd, '.wiki')
+  Olelo::Config.instance['repository.git'] = { :path => Dir.pwd, :bare => false }
+  Olelo::Config.instance['cache_store'] = { :type => 'file', 'file.root' => ::File.join(data_path, 'cache') }
+  Olelo::Config.instance['authentication.yamlfile.store'] = ::File.join(data_path, 'users.yml')
+  Olelo::Config.instance['log.file'] = ::File.join(data_path, 'log')
+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'))
+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']
+
+use Rack::Runtime
+use Rack::ShowExceptions if !Olelo::Config['production']
+
+if Olelo::Config['rack.deflater']
+  use Rack::Deflater
+end
+
+use Rack::StaticCache, :urls => ['/static'], :root => app_path
+use Rack::Session::Cookie, :key => 'olelo.session', :secret => Olelo::Config['rack.session_secret']
+use Olelo::Middleware::DegradeMimeType
+
+class LoggerOutput
+  def initialize(logger); @logger = logger; end
+  def write(text); @logger << text; end
+end
+
+use Rack::MethodOverride
+use Rack::CommonLogger, LoggerOutput.new(logger)
+
+if !Olelo::Config['rack.blacklist'].empty?
+  require 'olelo/middleware/blacklist'
+  use Olelo::Middleware::Blacklist, :blacklist => Olelo::Config['rack.blacklist']
+end
+
+use Olelo::Middleware::ForceEncoding
+use Olelo::Middleware::Flash, :set_accessors => %w(error warn info)
+use Rack::RelativeRedirect
+
+Olelo::Initializer.initialize(logger)
+run Olelo::Application.new
+
+logger.info "Olelo started in #{Olelo::Config['production'] ? 'production' : 'development'} mode"

data/config/aspects.rb

@@ -0,0 +1,256 @@
+# Filter aspect configuration aspects.rb
+
+################################################################################
+#
+# Register some simple regular expression filters which are used later
+#
+# Usage:
+#   regexp :filter_name, /regex1/, 'replacement1', /regex2/, 'replacement2'
+#
+################################################################################
+
+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>'
+
+################################################################################
+#
+# Define filter aspects which process pages by sending them
+# through multiple filters. DSL methods can be chained.
+# Available filters are listed on the /system page.
+#
+# Example DSL usage:
+#
+# aspect :aspect_name do          # Create aspect with name "aspect_name"
+#  is_cacheable                   # Aspect supports caching (renders static content)
+#  needs_layout                   # Aspect needs a html layout around the generated content
+#  has_priority 1                 # Aspect has priority 1, lower priorities are preferred
+#  accepts 'text/x-creole'        # Accepted mime types. This is a regular expression
+#  mime    'text/html'            # Generated mime type. Only interesting for aspects which don't need a layout.
+#  filter do                      # Define filter chain
+#    remove_comments              # First filter removes html comments <!--...-->. This filter is defined above.
+#    tag_shortcuts                # Replace tag shortcuts with tags (e.g $$...$$ -> <math>...</math>, <<page>> -> <include page="page"/>)
+#    creole_nowiki                # Replace creole nowiki tags with <notags> to disable tag interpretation (next filter)
+#    tag do                       # Interpret wiki tags. Wiki tags are an extension to default wiki text
+#      creole!                    # Transform creole to html
+#      rubypants                  # Execute rubypants (e.g. replace ... with &hellip;)
+#    end
+#    toc                          # Auto-generate table of contents
+#    link_classifier              # Classify links: Insert classes present for present pages, absent for absent pages, internal, external
+#  end
+# end
+#
+# tag filter options:
+#   tag(:enable => 'html:*') Enable only html tags
+#   tag(:disable => %w(html:* scripting:include)) Disable html tags and scripting:include
+#   tag(:disable => 'html:*') Disable only html tags
+#
+################################################################################
+
+interwiki_map = YAML.load_file(File.join(Config['config_path'], 'interwiki.yml'))
+
+################################################################################
+# Creole aspects configuration
+################################################################################
+
+aspect :page do
+  is_cacheable.needs_layout.has_priority(1)
+  accepts 'text/x-creole'
+  filter do
+    editsection do
+      remove_comments.tag_shortcuts
+      creole_nowiki.tag { creole!.rubypants }
+    end
+    toc.interwiki(:map => interwiki_map).link_classifier
+  end
+end
+
+aspect :s5 do
+  is_cacheable
+  accepts 'text/x-creole'
+  mime 'application/xhtml+xml; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts
+    creole_nowiki.tag { creole!.rubypants }
+    toc.interwiki(:map => interwiki_map).link_classifier
+    html_wrapper!.s5!
+  end
+end
+
+aspect :latex do
+  is_cacheable
+  accepts 'text/x-creole'
+  mime 'text/plain; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts.creole_nowiki
+    tag(:static => true) { creole!.rubypants }
+    toc.interwiki(:map => interwiki_map)
+    html_wrapper!.xslt!(:stylesheet => 'xhtml2latex.xsl')
+  end
+end
+
+################################################################################
+# Mediawiki aspects configuration
+################################################################################
+
+aspect :page do
+  is_cacheable.needs_layout.has_priority(1)
+  accepts 'text/x-mediawiki'
+  filter do
+    editsection do
+      remove_comments.tag_shortcuts
+      mediawiki_nowiki.tag { mediawiki!.rubypants }
+    end
+    toc.interwiki(:map => interwiki_map).link_classifier
+  end
+end
+
+aspect :s5 do
+  is_cacheable
+  accepts 'text/x-mediawiki'
+  mime 'application/xhtml+xml; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts
+    mediawiki_nowiki.tag { mediawiki!.rubypants }
+    toc.interwiki(:map => interwiki_map).link_classifier
+    html_wrapper!.s5!
+  end
+end
+
+aspect :latex do
+  is_cacheable
+  accepts 'text/x-mediawiki'
+  mime 'text/plain; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts.mediawiki_nowiki
+    tag(:static => true) { mediawiki!.rubypants }
+    toc.interwiki(:map => interwiki_map)
+    html_wrapper!.xslt!(:stylesheet => 'xhtml2latex.xsl')
+  end
+end
+
+################################################################################
+# Textile aspects configuration
+################################################################################
+
+aspect :page do
+  is_cacheable.needs_layout.has_priority(1)
+  accepts 'text/x-textile'
+  filter do
+    remove_comments.tag_shortcuts.textile_nowiki
+    tag(:disable => 'html:*') { textile!.rubypants }
+    fix_img_tag.toc
+    interwiki(:map => interwiki_map).link_classifier
+  end
+end
+
+aspect :s5 do
+  is_cacheable
+  accepts 'text/x-textile'
+  mime 'application/xhtml+xml; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts.textile_nowiki
+    tag(:disable => 'html:*') { textile!.rubypants }
+    fix_img_tag.toc
+    interwiki(:map => interwiki_map).link_classifier
+    html_wrapper!.s5!
+  end
+end
+
+aspect :latex do
+  is_cacheable
+  accepts 'text/x-textile'
+  mime 'text/plain; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts.textile_nowiki
+    tag(:static => true, :disable => 'html:*') { textile!.rubypants }
+    toc.interwiki(:map => interwiki_map)
+    html_wrapper!.xslt!(:stylesheet => 'xhtml2latex.xsl')
+  end
+end
+
+################################################################################
+# Markdown aspects configuration
+################################################################################
+
+aspect :page do
+  is_cacheable.needs_layout.has_priority(1)
+  accepts 'text/x-markdown'
+  filter do
+    editsection do
+      remove_comments.tag_shortcuts.markdown_nowiki
+      tag(:disable => 'html:*') { markdown! }
+    end
+    fix_img_tag.toc
+    interwiki(:map => interwiki_map).link_classifier
+  end
+end
+
+aspect :s5 do
+  is_cacheable
+  accepts 'text/x-markdown'
+  mime 'application/xhtml+xml; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts.markdown_nowiki
+    tag(:disable => 'html:*') { markdown! }
+    fix_img_tag.toc
+    interwiki(:map => interwiki_map).link_classifier
+    html_wrapper!.s5!
+  end
+end
+
+aspect :latex do
+  is_cacheable
+  accepts 'text/x-markdown'
+  mime 'text/plain; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts.markdown_nowiki
+    tag(:static => true, :disable => 'html:*') { markdown! }
+    toc.interwiki(:map => interwiki_map)
+    html_wrapper!.xslt!(:stylesheet => 'xhtml2latex.xsl')
+  end
+end
+
+################################################################################
+# Orgmode aspects configuration
+################################################################################
+
+aspect :page do
+  is_cacheable.needs_layout.has_priority(1)
+  accepts 'text/x-orgmode'
+  filter do
+    remove_comments.tag_shortcuts
+    tag { orgmode!.rubypants }
+    fix_img_tag.toc
+    interwiki(:map => interwiki_map).link_classifier
+  end
+end
+
+aspect :s5 do
+  is_cacheable
+  accepts 'text/x-orgmode'
+  mime 'application/xhtml+xml; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts
+    tag { orgmode!.rubypants }
+    fix_img_tag.toc
+    interwiki(:map => interwiki_map).link_classifier
+    html_wrapper!.s5!
+  end
+end
+
+aspect :latex do
+  is_cacheable
+  accepts 'text/x-orgmode'
+  mime 'text/plain; charset=utf-8'
+  filter do
+    remove_comments.tag_shortcuts
+    tag(:static => true) { orgmode!.rubypants }
+    toc.interwiki(:map => interwiki_map)
+    html_wrapper!.xslt!(:stylesheet => 'xhtml2latex.xsl')
+  end
+end