gitki 0.1.0

data/README.rdoc

@@ -0,0 +1,74 @@
+= gitki
+
+== DESCRIPTION:
+
+Gitki is a wiki using git to store data.
+
+== DEMO:
+
+http://gitki.oyguj.org/
+
+== SYNOPSIS:
+
+Setup:
+
+  git clone git://github.com/jugyo/gitki.git
+  cd gitki
+  git submodule update --init
+  cd ~
+  mkdir gitki.git
+  cd gitki.git
+  git init --bare
+
+Run as standalon server:
+
+  ./app.rb
+
+Run on mod_rails:
+
+See
+http://www.sinatrarb.com/book.html#deployment_passenger
+
+== CONFIGURATION:
+
+setting.yml
+
+  title: wiki title
+  git_store: git repository path to store data (ex ~/gitki.git)
+  markup: markup type (textile or markdown)
+
+== REQUIREMENTS:
+
+* sinatra
+* RedCloth or rdiscount
+
+To install them as follows:
+
+  sudo gem install sinatra RedCloth rdiscount
+
+See Also: http://github.com/georgi/git_store/tree/master
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008-2009 jugyo
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'spec/rake/spectask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+desc "default task"
+task :default => [:spec]
+
+name = 'gitki'
+version = '0.1.0'
+
+spec = Gem::Specification.new do |s|
+  s.name = name
+  s.version = version
+  s.summary = "Gitki is a wiki using git to store data."
+  s.description = "Gitki is a wiki using git to store data."
+  s.files = %w(Rakefile README.rdoc ChangeLog app.rb config.ru console setting.yml) + 
+            Dir.glob("{lib,spec,bin,public,vendor,views}/**/*")
+  s.executables = ["gitki"]
+  s.add_dependency("sinatra", ">= 0.9.4")
+  s.authors = %w(jugyo)
+  s.email = 'jugyo.org@gmail.com'
+  s.homepage = 'http://github.com/jugyo/gitki'
+  s.rubyforge_project = 'gitki'
+  s.has_rdoc = false
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+end
+
+task :gemspec do
+  filename = "#{name}.gemspec"
+  open(filename, 'w') do |f|
+    f.write spec.to_ruby
+  end
+  puts <<-EOS
+  Successfully generated gemspec
+  Name: #{name}
+  Version: #{version}
+  File: #{filename}
+  EOS
+end
+
+task :install => [ :package ] do
+  sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [ :clean ] do
+  sh %{sudo gem uninstall #{name}}
+end
+
+desc 'run all specs'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['-c']
+end
+
+CLEAN.include ['pkg']

data/app.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'sinatra'
+require 'mime/types'
+require 'yaml'
+require 'lib/gitki'
+include Gitki
+
+configure do
+  BASE_DIR = File.expand_path(File.dirname(__FILE__)) unless defined? BASE_DIR
+  SETTING = YAML.load(open("#{BASE_DIR}/setting.yml")) unless defined? SETTING
+
+  SETTING['markup'] ||= 'textile'
+  raise 'Invalid markup type.' unless markup_types.include?(SETTING['markup'])
+
+  set SETTING
+  set :haml, {:format => :html5}
+  enable :sessions
+
+  Gitki.setup(SETTING['git_store'])
+
+  repo_path = File.expand_path SETTING['git_store']
+  puts <<-EOS
+
+#{'#' * 60}
+
+  Wiki repository is '#{repo_path}'.
+  You can clone it as follows:
+
+   % git clone <user>@<host>:#{repo_path}
+
+#{'#' * 60}
+
+  EOS
+end
+
+before do
+  store.refresh!
+  content_type "text/html", :charset => "utf-8"
+end
+
+get '/css' do
+  content_type 'text/css', :charset => 'utf-8'
+  sass :styles
+end
+
+get '/files/:name' do
+  content_type MIME::Types.type_for(params[:name]).first.content_type
+  Attachment.find(params[:name])
+end
+
+get '/' do
+  wiki 'home'
+end
+
+get '/pages' do
+  @pages = Page.find_all
+  haml :pages
+end
+
+get '/:name' do
+  wiki params[:name]
+end
+
+get '/raw/:name' do
+  content_type 'text/plain', :charset => 'utf-8'
+  Page.find(params[:name]).raw
+end
+
+not_found do
+  haml '#error-message Not found'
+end
+
+helpers do
+  def navigation
+    markup(Page.find('navigation').body)
+  end
+
+  def markup(text)
+    self.__send__(options.markup, text)
+  end
+
+  def wiki(name)
+    @name = name
+    @page = Page.find(@name) || not_found
+    haml :page
+  end
+end

data/bin/gitki

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+system 'rackup', File.dirname(__FILE__) + '/gitki.ru'

data/bin/gitki.ru

@@ -0,0 +1,13 @@
+ENV['RACK_ENV'] ||= 'production'
+
+pwd = Dir.pwd
+git_dir = File.exists?("#{pwd}/.git") ? "#{pwd}/.git" : pwd
+
+SETTING = {
+  'title' => 'Gitki',
+  'git_store' => git_dir,
+  'markup' => 'textile',
+}
+$: << File.dirname(__FILE__) + '/../'
+require 'app'
+run Sinatra::Application

data/config.ru

@@ -0,0 +1,3 @@
+ENV['RACK_ENV'] ||= 'production'
+require 'app'
+run Sinatra::Application

data/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + '/lib'
+
+require 'rubygems'
+require 'irb'
+require 'yaml'
+require 'gitki'
+
+SETTING = YAML.load(open("#{File.dirname(__FILE__)}/setting.yml"))
+Gitki.setup(SETTING['git_store'])
+include Gitki
+IRB.start

data/lib/gitki.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+$: << File.dirname(__FILE__) + '/../vendor/git_store/lib'
+
+require 'rubygems'
+require 'git_store'
+require 'redcloth' rescue nil
+require 'rdiscount' rescue nil
+
+module Gitki
+  class << self
+    def setup(git_store_path)
+      @@store = GitStore.new(File.expand_path(git_store_path), 'master', true) # use bare repository
+      Page.setup('wiki')
+      Attachment.setup('files')
+      if @@store.objects.empty?
+        create_defaults
+      end
+    end
+
+    def create_defaults
+      @@store[Page.dir + '/home'] = read_file('home_template.haml')
+      @@store[Page.dir + '/navigation'] = read_file('navigation_template.haml')
+      @@store[Attachment.dir + '/gitki.png'] = read_file('gitki.png')
+      @@store.commit 'Created defaults'
+    end
+
+    def read_file(name)
+      open(File.dirname(__FILE__) + '/' + name).read
+    end
+  end
+
+  def markup_types
+    ['html', 'textile', 'markdown']
+  end
+
+  def store
+    @@store
+  end
+
+  def textile(text)
+    RedCloth.new(text).to_html
+  end
+
+  def markdown(text)
+    RDiscount.new(text).to_html
+  end
+
+  def html(text)
+    text
+  end
+
+  class Page
+    class << self
+      attr_reader :dir
+      def setup(dir)
+        @dir = dir
+      end
+
+      def find_all
+        pages = {}
+        store[dir].to_hash.each do |name, text|
+          pages[name] = self.new(text)
+        end
+        pages
+      end
+
+      def find(name)
+        data = store[store_path(name)]
+        if data
+          self.new(data)
+        else
+          nil
+        end
+      end
+
+      def store_path(name)
+        File.join(dir, name)
+      end
+    end
+
+    attr_reader :title, :body, :raw
+
+    def initialize(raw)
+      @raw = raw
+      @title, @body = split_title_and_body(raw)
+    end
+
+    private
+
+    def split_title_and_body(raw)
+      return nil if raw.nil? || raw.empty?
+      lines = raw.split("\n")
+      title = lines.shift
+      lines.shift
+      body = lines.join("\n")
+      [title, body]
+    end
+  end
+
+  class Attachment
+    class << self
+      attr_reader :dir
+      def setup(dir)
+        @dir = dir
+      end
+
+      def find(name)
+        store[store_path(name)]
+      end
+
+      def store_path(name)
+        File.join(dir, name)
+      end
+    end
+  end
+end

data/lib/home_template.haml

@@ -0,0 +1,17 @@
+Home
+
+Gitki is a wiki using git to store data.
+
+h3. Source
+
+"http://github.com/jugyo/gitki/tree/master":http://github.com/jugyo/gitki/tree/master
+
+h3. Examples
+
+* list
+* list
+
+# list
+# list
+
+!/files/gitki.png!

data/lib/navigation_template.haml

@@ -0,0 +1,4 @@
+Navigation
+
+* "Home":/
+* "Pages":/pages

data/setting.yml

@@ -0,0 +1,3 @@
+title: Gitki!!
+git_store: ~/gitki.git
+markup: textile

data/spec/gitki_spec.rb

@@ -0,0 +1,104 @@
+$: << File.dirname(__FILE__) + '/../'
+require 'lib/gitki'
+require 'tmpdir'
+require 'ruby-debug'
+require 'fileutils'
+
+include Gitki
+
+describe Gitki do
+  REPO = File.join Dir.tmpdir, 'git_store_test'
+
+  before(:each) do
+    FileUtils.rm_rf REPO
+    Dir.mkdir REPO
+    Dir.chdir(REPO) do |path|
+      system 'git', 'init', '--bare'
+    end
+  end
+
+  describe 'repository is empty' do
+    it 'should create defaults' do
+      Gitki.should_receive(:create_defaults)
+      Gitki.setup(REPO)
+    end
+
+    it 'should return 2 pages' do
+      Gitki.setup(REPO)
+
+      pages = Page.find_all
+      pages.size.should == 2
+
+      page = Page.find('home')
+      page.title.should == "Home"
+
+      page = Page.find('navigation')
+      page.title.should == "Navigation"
+    end
+
+    it 'should return a file' do
+      Gitki.setup(REPO)
+      file = Attachment.find('gitki.png').should_not be_nil
+    end
+  end
+
+  describe 'repository is not empty' do
+    before(:each) do
+      store = GitStore.new(REPO, 'master', true)
+      store['test.txt'] = 'test'
+      store.commit 'Added test.txt'
+    end
+
+    it 'should not create defaults' do
+      Gitki.should_not_receive(:create_defaults)
+      Gitki.setup(REPO)
+    end
+  end
+
+  describe Page do
+    before(:each) do
+      Gitki.setup(REPO)
+      @@store.delete('wiki/home')
+      @@store.delete('wiki/navigation')
+    end
+
+    describe 'create 2 page' do
+      before(:each) do
+        @@store[Page.dir + '/foo'] = <<-EOS
+foo
+
+foo foo foo
+        EOS
+        @@store[Page.dir + '/bar'] = <<-EOS
+bar
+
+bar bar bar
+        EOS
+      end
+
+      it 'should return 2 pages' do
+        pages = Page.find_all
+        pages.size.should == 2
+
+        page = pages['foo']
+        page.title.should == 'foo'
+        page.body.should == 'foo foo foo'
+
+        page = pages['bar']
+        page.title.should == 'bar'
+        page.body.should == 'bar bar bar'
+      end
+    end
+  end
+
+  describe Attachment do
+    before(:each) do
+      Gitki.setup(REPO)
+      Gitki.store['files/test.txt'] = 'test'
+    end
+
+    it 'should get file content' do
+      Attachment.find('test.txt').should == 'test'
+    end
+  end
+end