run.ru @@ -26,7 +26,8 @@ The fellowing [gems][] are required to run git-wiki: - BlueCloth - rubypants -Run `rake bootstrap && ruby git-wiki.rb` and point your browser at <http://0.0.0.0:4567/>. Enjoy! +Run with `mkdir ~/wiki && ./run.ru -sthin -p4567` and point your +browser at <http://0.0.0.0:4567/>. Enjoy! ## Licence DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE @@ -42,41 +43,47 @@ Run `rake bootstrap && ruby git-wiki.rb` and point your browser at <http://0.0.0 0. You just DO WHAT THE FUCK YOU WANT TO. +## See also + +- [WiGit](http://el-tramo.be/software/wigit) – git-wiki in PHP +- [ikiwiki](http://ikiwiki.info/) – a wiki compiler supporting git + ## Quotes <blockquote> [...] the first wiki engine I'd consider worth using for my own projects. -<cite><a href="http://www.dekorte.com/blog/blog.cgi?do=item&id=3319">Steve Dekorte</a></cite> +<cite> +<a href="http://www.dekorte.com/blog/blog.cgi?do=item&id=3319"> +Steve Dekorte</a> +</cite> </blockquote> <blockquote> -Oh, it looks like <a href="http://atonie.org/2008/02/git-wiki">Git Wiki</a> may be the -starting point for what I need... +Oh, it looks like <a href="http://atonie.org/2008/02/git-wiki">Git Wiki</a> +may be the starting point for what I need... <cite><a href="http://tommorris.org/blog/2008/03/09#pid2761430"> Tom Morris on "How to build the perfect wiki"</a></cite> </blockquote> <blockquote> -What makes git-wiki so cool is because it is backed by a git store, you can clone your -wiki just like you could any other git repository. I’ve always wanted a wiki that I could -a.) pull offline when I didn’t have access to the Internets and b.) edit (perhaps in bulk) +What makes git-wiki so cool is because it is backed by a git store, +you can clone your wiki just like you could any other git repository. +I’ve always wanted a wiki that I could a.) pull offline when I didn’t +have access to the Internets and b.) edit (perhaps in bulk) in my favorite text editor. git-wiki allows both. -<cite><a href="http://github.com/willcodeforfoo/git-wiki/wikis">Cloning your wiki</a></cite> +<cite><a href="http://github.com/willcodeforfoo/git-wiki/wikis"> +Cloning your wiki</a></cite> </blockquote> <blockquote> -Numerous people have written diff and merge systems for wikis; TWiki even uses RCS. -If they used git instead, the repository would be tiny, and you could make a personal -copy of the entire wiki to take on the plane with you, then sync your changes back when you're done. -<cite><a href="http://www.advogato.org/person/apenwarr/diary/371.html">Git is the next Unix</a></cite> +Numerous people have written diff and merge systems for wikis; +TWiki even uses RCS. If they used git instead, the repository would be tiny, and +you could make a personal copy of the entire wiki to take on the plane with you, +then sync your changes back when you're done. +<cite><a href="http://www.advogato.org/person/apenwarr/diary/371.html"> +Git is the next Unix</a></cite> </blockquote> -## See also - -- [WiGit](http://el-tramo.be/software/wigit) – git-wiki in PHP -- [ikiwiki](http://ikiwiki.info/) – a wiki compiler supporting git - - [Sinatra]: http://sinatrarb.com [GitHub]: http://github.com/sr/git-wiki [forks]: http://github.com/sr/git-wiki/network README.markdown @@ -2,17 +2,9 @@ require "rubygems" gem "mojombo-grit" -%w(sinatra -grit -haml -sass -redcloth).each { |dependency| require dependency } - -begin - require "thin" -rescue LoadError - puts "# May I suggest you to use Thin?" -end +require "sinatra/base" +require "grit" +require "redcloth" class String def titleize @@ -20,168 +12,188 @@ class String end end -class PageNotFound < Sinatra::NotFound - attr_reader :name +module GitWiki + class << self + attr_accessor :homepage, :extension, :repository + end + + def self.new(repository, extension, homepage) + self.homepage = homepage + self.extension = extension + self.repository = Grit::Repo.new(repository) - def initialize(name) - @name = name + App end -end -class Page - class << self - attr_accessor :repository - attr_accessor :extension + class PageNotFound < Sinatra::NotFound + attr_reader :name + + def initialize(name) + @name = name + end + end - def find_all + class Page + def self.find_all return [] if repository.tree.contents.empty? repository.tree.contents.collect { |blob| new(blob) } end - def find(name) + def self.find(name) page_blob = find_blob(name) raise PageNotFound.new(name) unless page_blob new(page_blob) end - def find_or_create(name) + def self.find_or_create(name) find(name) rescue PageNotFound new(create_blob_for(name)) end - def css_class_for(name) + def self.css_class_for(name) find(name) "exists" rescue PageNotFound "unknown" end - private - def find_blob(page_name) - repository.tree/(page_name + extension) - end - - def create_blob_for(page_name) - Grit::Blob.create(repository, :name => page_name + extension, :data => "") - end - end - - def initialize(blob) - @blob = blob - end - - def to_html - linked = auto_link(wiki_link(content)) - RedCloth.new(linked).to_html - end + def self.repository + GitWiki.repository || raise + end - def to_s - name - end + def self.extension + GitWiki.extension || raise + end - def new? - @blob.id.nil? - end + def self.find_blob(page_name) + repository.tree/(page_name + extension) + end + private_class_method :find_blob - def name - @blob.name.delete(File.extname(@blob.name)) - end + def self.create_blob_for(page_name) + Grit::Blob.create(repository, { + :name => page_name + extension, + :data => "" + }) + end + private_class_method :create_blob_for - def content - @blob.data - end + def initialize(blob) + @blob = blob + end - def update_content(new_content) - return if new_content == content - File.open(file_name, "w") { |f| f << new_content } - add_to_index_and_commit! - end + def to_html + linked = auto_link(wiki_link(content)) + RedCloth.new(linked).to_html + end - private - def add_to_index_and_commit! - Dir.chdir(self.class.repository.path) { self.class.repository.add(@blob.name) } - self.class.repository.commit_index(commit_message) + def to_s + name end - def file_name - File.join(self.class.repository.path, name + self.class.extension) + def new? + @blob.id.nil? end - def commit_message - new? ? "Created #{name}" : "Updated #{name}" + def name + @blob.name.gsub(/#{File.extname(@blob.name)}$/, '') end - def auto_link(string) - string.gsub(/<((https?|ftp|irc):[^'">\s]+)>/xi, %Q{<a href="\\1">\\1</a>}) + def content + @blob.data end - def wiki_link(string) - string.gsub(/([A-Z][a-z]+[A-Z][A-Za-z0-9]+)/) { |page| - %Q{<a class="#{self.class.css_class_for(page)}" href="/#{page}">#{page.titleize}</a>} - } + def update_content(new_content) + return if new_content == content + File.open(file_name, "w") { |f| f << new_content } + add_to_index_and_commit! end -end -use_in_file_templates! + private + def add_to_index_and_commit! + Dir.chdir(self.class.repository.working_dir) { + self.class.repository.add(@blob.name) + } + self.class.repository.commit_index(commit_message) + end -configure do - GitRepository = ENV["GIT_WIKI_REPO"] || File.join(ENV["HOME"], "wiki") - Homepage = "Home" - set_option :haml, :format => :html5, :attr_wrapper => '"' + def file_name + File.join(self.class.repository.working_dir, name + self.class.extension) + end - Page.repository = Grit::Repo.new(GitRepository) - Page.extension = ".textile" -end + def commit_message + new? ? "Created #{name}" : "Updated #{name}" + end -error PageNotFound do - page = request.env["sinatra.error"].name - redirect "/e/#{page}" -end + def auto_link(str) + str.gsub(/<((https?|ftp|irc):[^'">\s]+)>/xi, %Q{<a href="\\1">\\1</a>}) + end -helpers do - def title(title=nil) - @title = title.to_s unless title.nil? - @title + def wiki_link(str) + str.gsub(/([A-Z][a-z]+[A-Z][A-Za-z0-9]+)/) { |page| + %Q{<a class="#{self.class.css_class_for(page)}"} + + %Q{href="/#{page}">#{page.titleize}</a>} + } + end end - def list_item(page) - %Q{<a class="page_name" href="/#{page}">#{page.name.titleize}</a>} - end -end + class App < Sinatra::Base + set :app_file, __FILE__ + set :haml, { :format => :html5, + :attr_wrapper => '"' } + enable :static + use_in_file_templates! -before do - content_type "text/html", :charset => "utf-8" -end + error PageNotFound do + page = request.env["sinatra.error"].name + redirect "/#{page}/edit" + end -get "/" do - redirect "/" + Homepage -end + before do + content_type "text/html", :charset => "utf-8" + end -get "/_stylesheet.css" do - content_type "text/css", :charset => "utf-8" - sass :stylesheet -end + get "/" do + redirect "/" + GitWiki.homepage + end -get "/_list" do - @pages = Page.find_all - haml :list -end + get "/_stylesheet.css" do + content_type "text/css", :charset => "utf-8" + sass :stylesheet + end -get "/:page" do - @page = Page.find(params[:page]) - haml :show -end + get "/_list" do + @pages = Page.find_all + haml :list + end -get "/e/:page" do - @page = Page.find_or_create(params[:page]) - haml :edit -end + get "/:page" do + @page = Page.find(params[:page]) + haml :show + end + + get "/e/:page" do + @page = Page.find_or_create(params[:page]) + haml :edit + end -post "/e/:page" do - @page = Page.find_or_create(params[:page]) - @page.update_content(params[:body]) - redirect "/#{@page}" + post "/e/:page" do + @page = Page.find_or_create(params[:page]) + @page.update_content(params[:body]) + redirect "/#{@page}" + end + + private + def title(title=nil) + @title = title.to_s unless title.nil? + @title + end + + def list_item(page) + %Q{<a class="page_name" href="/#{page}">#{page.name.titleize}</a>} + end + end end __END__ @@ -196,8 +208,8 @@ __END__ %script{:src => '/to-title-case.js', :type => 'text/javascript'} :javascript $(document).ready(function() { - $.hotkeys.add('Ctrl+h', function() { document.location = '/#{Homepage}' }) - $.hotkeys.add('Ctrl+l', function() { document.location = '/_list' }) + $.hotkeys.add('Ctrl+h', function(){document.location = '/#{GitWiki.homepage}'}) + $.hotkeys.add('Ctrl+l', function(){document.location = '/_list'}) /* title-case-ification */ document.title = document.title.toTitleCase(); @@ -214,7 +226,7 @@ __END__ - title @page.name.titleize :javascript $(document).ready(function() { - $.hotkeys.add('Ctrl+e', function() { document.location = '/e/#{@page}' }) + $.hotkeys.add('Ctrl+e', function(){document.location = '/e/#{@page}'}) }) %h1#page_title= title #page_content git-wiki.rb config.ru d8e708df67144a91020fd338f2dfefd6a2c4de9a Simon Rozet simon@rozet.name http://github.com/sr/git-wiki/commit/b50336ac2b93b65bfcaedd1ee90108c9ffbb1018 b50336ac2b93b65bfcaedd1ee90108c9ffbb1018

2009-02-01T13:01:02-08:00

2009-01-21T16:39:56-08:00

Upgrade to Sinatra 0.9 See <http://www.sinatrarb.com/2009/01/18/sinatra-0.9.0.html> for more information on 0.9 * Use a Sinatra::Base subclass * config.ru takes the wiki directory as argument and launch git-wiki on it * Update the README to reflects changes a35cbf94699f2bf978b2ead9ed2115d1cbdb71ae Simon Rozet simon@rozet.name