karottenreibe-qwicky 0.0.2 → 0.0.3

data/HISTORY.markdown

@@ -1,3 +1,10 @@
+0.0.3
+=====
+
+*   Fixed bugs when permissions were set badly
+*   Made Qwicky server-ready (see README)
+*   Made settings freezable
+
 0.0.2
 =====
 

data/README.markdown

@@ -106,7 +106,17 @@ in the directory where your database and settings are
 stored, qwicky will automatically run it through
 [Sass] [3] and apply it.
 
-****
+Running Qwucky on a server
+==========================
+
+...is almost cruelly simple.
+
+1.  Set it up as normal, run it, set your settings.
+2.  Freeze your config file by making _qwicky.yml_ non-writable
+    to the user that runs Qwicky.
+3.  Share and enjoy!
+
+
 
 [1]: http://tomayko.com/writings/ruby-markdown-libraries-real-cheap-for-you-two-for-price-of-one
     "Post about why not to use BlueCloth"

data/bin/qwicky

@@ -27,6 +27,10 @@ unless File.exist?(DIR) and File.directory?(DIR)
     exit -1
 end
 
+CONF_FILE = "#{DIR}/qwicky.yml"
+DB_URL = ENV['DATABASE_URL'] || "sqlite3://#{DIR}/qwicky.db"
+STYLES_FILE = "#{DIR}/qwicky.sass"
+
 # Database stuff. {{{1
 class Page
     include DataMapper::Resource
@@ -36,8 +40,19 @@ class Page
     property :content, Text, :nullable => false
 end
 
-DataMapper::setup(:default, "sqlite3://#{DIR}/qwicky.db")
-DataMapper::auto_upgrade!
+DataMapper::setup(:default, DB_URL)
+
+begin
+    DataMapper::auto_upgrade!
+rescue Sqlite3Error => e
+    if e.message =~ %r{unable to open database file}
+        $stderr.puts "Unable to create/open `#{DB_URL}'"
+        $stderr.puts "Please make database file readable and writable."
+        exit -1
+    else
+        raise
+    end
+end
 
 # Markup stuff. {{{1
 module Markup
@@ -182,13 +197,19 @@ class Qwicky
     attr_accessor :conf, :markup
 
     def initialize
-        FileUtils.touch("#{DIR}/qwicky.yml")
+        begin
+            FileUtils.touch(CONF_FILE) unless File.exist?(CONF_FILE)
+        rescue Errno::EACCES
+            $stderr.puts "Unable to create `#{CONF_FILE}'"
+            $stderr.puts "Please make directory writable or manually create a readable config file."
+            exit -1
+        end
 
         @conf = {
             'homepage' => '',
             'markup' => 'text',
         }.merge(
-            open("#{DIR}/qwicky.yml") { |f|
+            open(CONF_FILE) { |f|
                 YAML::load(f) || Hash.new
             }
         )
@@ -207,12 +228,12 @@ class Qwicky
 
     def format text
         markup.format(text).gsub %r{\[\[([^|\]]+)(\|([^\]]+))?\]\]} do |match|
-            page = $3 || $1
+            page = $1
             nexist = Page.first(:name => page).nil?
             klass = nexist ? 'bad' : 'good'
-            title = nexist ? "Create page #{page}" : "Page #{page}"
+            title = nexist ? "Create page `#{page}'" : "Page `#{page}'"
             link = '/' + page
-            "<a href=#{link.inspect} title=#{title.inspect} class='#{klass}'>#{$1}</a>"
+            "<a href=#{link.inspect} title=#{title.inspect} class='#{klass}'>#{$3 || $1}</a>"
         end
     end
 end
@@ -235,7 +256,7 @@ helpers do
 end
 
 before do
-    @editable = true
+    @configurable = File.writable?(CONF_FILE)
 end
 
 get '/' do
@@ -243,19 +264,25 @@ get '/' do
 end
 
 get '/..settings/?' do
-    @editable = false
-    @settings = APP.conf
-    @title = 'Settings'
-    @markups = Markup::Markup.markups
-    haml :settings
+    if File.writable?(CONF_FILE)
+        @settings = APP.conf
+        @title = 'Settings'
+        @markups = Markup::Markup.markups
+        haml :settings
+    else
+        haml "%h1 Unfortunately, the config file for this Qwicky instance is not writable!"
+    end
 end
 
 post '/..settings/?' do
     APP.conf.merge!(params[:settings])
     APP.set_markup
-    open("#{DIR}/qwicky.yml", 'w') { |f|
-        f.write(YAML::dump(APP.conf))
-    }
+
+    if File.writable?(CONF_FILE)
+        open(CONF_FILE, 'w') { |f|
+            f.write(YAML::dump(APP.conf))
+        }
+    end
     
     redirect_home
 end
@@ -273,8 +300,8 @@ end
 get '/..user.stylesheet.css' do
     content_type 'text/css'
 
-    if File.exist?("#{DIR}/qwicky.sass")
-        sass open("#{DIR}/qwicky.sass").read()
+    if File.exist?(STYLES_FILE)
+        sass open(STYLES_FILE).read()
     else
         ''
     end
@@ -288,7 +315,6 @@ get '/..favicon' do
 end
 
 get '/..sitemap' do
-    @editable = false
     @title = 'Sitemap'
     @pages = Page.all.sort_by { |page| page.name }
     haml :sitemap
@@ -383,9 +409,10 @@ __END__
         %a{ :title => 'Go the the main page of this wiki', :href => '/' } Home
         &#8226;
         %a{ :title => 'View what pages this wiki has', :href => '/..sitemap' } Sitemap
-        &#8226;
-        %a{ :title => 'Adjust settings', :href => '/..settings' } Settings
-      - if @editable
+        - if @configurable
+          &#8226;
+          %a{ :title => 'Adjust settings', :href => '/..settings' } Settings
+      - if @page
         %a.edit{ :title => 'Edit this wiki page', :href => "/#{@page.name}/edit" } Edit
       %form{ :action => '/', :method => 'get', :onsubmit => 'return changePage()' }
         %input#location{ :type => 'text', :name => 'location' }
@@ -405,7 +432,7 @@ __END__
         %br/
         If you want to contribute, visit
         %a{ :title => 'Here you can contribute to the project', :href => 'http://wiki.github.com/karottenreibe/qwicky/' } Qwicky's GitHub page
-      - if @editable
+      - if @page
         %a.edit{ :title => 'Edit this wiki page', :href => "/#{@page.name}/edit" } Edit
 
 

data/qwicky.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{qwicky}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors =  ["Fabian Streitel"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: karottenreibe-qwicky
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Fabian Streitel