wiki 0.0.1

data/lib/wiki/server_helpers.rb

@@ -0,0 +1,66 @@
+module ServerHelpers
+
+  def cross_origin
+    headers 'Access-Control-Allow-Origin' => "*" if request.env['HTTP_ORIGIN']
+  end
+
+  def resolve_links string
+    string.
+      gsub(/\[\[([^\]]+)\]\]/i) {
+                  |name|
+                  name.gsub!(/^\[\[(.*)\]\]/, '\1')
+
+                  slug = name.gsub(/\s/, '-')
+                  slug = slug.gsub(/[^A-Za-z0-9-]/, '').downcase
+                  '<a class="internal" href="/'+slug+'.html" data-page-name="'+slug+'" >'+name+'</a>'
+              }.
+      gsub(/\[(http.*?) (.*?)\]/i, '<a class="external" href="\1" rel="nofollow">\2</a>')
+  end
+
+  def openid_consumer
+    @openid_consumer ||= OpenID::Consumer.new(session, OpenID::Store::Filesystem.new("#{farm_status}/tmp/openid"))
+  end
+
+  def authenticated?
+    session[:authenticated] == true
+  end
+
+  def identified?
+    Store.exists? "#{farm_status}/open_id.identifier"
+  end
+
+  def claimed?
+    Store.exists? "#{farm_status}/open_id.identity"
+  end
+
+  def authenticate!
+    session[:authenticated] = true
+    redirect "/"
+  end
+
+  def oops status, message
+    haml :oops, :layout => false, :locals => {:status => status, :message => message}
+  end
+
+  def serve_resources_locally?(site)
+    !!ENV['FARM_DOMAINS'] && ENV['FARM_DOMAINS'].split(',').any?{|domain| site.end_with?(domain)}
+  end
+
+  def serve_page(name, site=request.host)
+    cross_origin
+    halt 404 unless farm_page(site).exists?(name)
+    JSON.pretty_generate farm_page(site).get(name)
+  end
+
+  def synopsis page
+    text = page['synopsis']
+    p1 = page['story'] && page['story'][0]
+    p2 = page['story'] && page['story'][1]
+    text ||= p1 && p1['text'] if p1 && p1['type'] == 'paragraph'
+    text ||= p2 && p2['text'] if p2 && p2['type'] == 'paragraph'
+    text ||= p1 && p1['text'] || p2 && p2['text'] || page['story'] && "A page with #{page['story'].length} paragraphs." || "A page with no story."
+    return text
+  end
+
+end
+

data/lib/wiki/stores/ReadMe.md

@@ -0,0 +1,26 @@
+We support several wiki page persistence mechanisms called Stores.
+Currently the server includes all versions and selects one with
+an environment variable.
+
+File Store
+==========
+
+Pages are stored in flat files under `data` in the subdirectory
+`pages`. File names are the slugs with no suffix.
+A second subdirectory, `status`, contains additional metadata
+such as the site's favicon.png.
+
+When the server is operated as a wiki site farm,
+data and status subdirectories are pushed several levels deeper
+in the file hierarchy under `data/farm/*` where * is replaced
+with the virtual host domain name.
+The existence of the farm subdirectory configures the server
+into farm mode.
+
+Couch Store
+===========
+
+Pages are stored as Couch documents with fully qualified
+names following the conventions established in the File Store.
+An environment variable indicates that the server should
+be in farm mode.

data/lib/wiki/stores/all.rb

@@ -0,0 +1,3 @@
+require File.expand_path('store', File.dirname(__FILE__))
+require File.expand_path('file',  File.dirname(__FILE__))
+require File.expand_path('couch', File.dirname(__FILE__))

data/lib/wiki/stores/couch.rb

@@ -0,0 +1,121 @@
+require 'time'  # for Time#iso8601
+
+class CouchStore < Store
+  class << self
+
+    attr_writer :db   # used by specs
+
+    def db
+      unless @db
+        couchdb_server = ENV['COUCHDB_URL'] || raise('please set ENV["COUCHDB_URL"]')
+        @db = CouchRest.database!("#{couchdb_server}/sfw")
+        begin
+          @db.save_doc "_id" => "_design/recent-changes", :views => {}
+        rescue RestClient::Conflict
+          # design document already exists, do nothing
+        end
+      end
+      @db
+    end
+
+    ### GET
+
+    def get_text(path)
+      path = relative_path(path)
+      begin
+        db.get(path)['data']
+      rescue RestClient::ResourceNotFound
+        nil
+      end
+    end
+
+    def get_blob(path)
+      blob = get_text path
+      Base64.decode64 blob if blob
+    end
+
+    ### PUT
+
+    def put_text(path, text, metadata={})
+      path = relative_path(path)
+      metadata = metadata.each{ |k,v| metadata[k] = relative_path(v) }
+      attrs = {
+        'data' => text,
+        'updated_at' => Time.now.utc.iso8601
+      }.merge! metadata
+
+      begin
+        db.save_doc attrs.merge('_id' => path)
+      rescue RestClient::Conflict
+        doc = db.get path
+        doc.merge! attrs
+        doc.save
+      end
+      text
+    end
+
+    def put_blob(path, blob)
+      put_text path, Base64.strict_encode64(blob)
+      blob
+    end
+
+    ### COLLECTIONS
+
+    def annotated_pages(pages_dir)
+      changes = pages pages_dir
+      changes.map do |change|
+        page = JSON.parse change['value']['data']
+        page.merge! 'updated_at' => Time.parse(change['value']['updated_at'])
+        page.merge! 'name' => change['value']['name']
+        page
+      end
+    end
+
+    ### UTILITY
+
+    def pages(pages_dir)
+      pages_dir = relative_path pages_dir
+      pages_dir_safe = CGI.escape pages_dir
+      begin
+        db.view("recent-changes/#{pages_dir_safe}")['rows']
+      rescue RestClient::ResourceNotFound
+        create_view 'recent-changes', pages_dir
+        db.view("recent-changes/#{pages_dir_safe}")['rows']
+      end
+    end
+
+    def create_view(design_name, view_name)
+      design = db.get "_design/#{design_name}"
+      design['views'][view_name] = {
+        :map => "
+          function(doc) {
+            if (doc.directory == '#{view_name}')
+              emit(doc._id, doc)
+          }
+        "
+      }
+      design.save
+    end
+
+    def farm?(_)
+      !!ENV['FARM_MODE']
+    end
+
+    def mkdir(_)
+      # do nothing
+    end
+
+    def exists?(path)
+      !(get_text path).nil?
+    end
+
+    def relative_path(path)
+      raise "Please set @app_root" unless @app_root
+      path.match(%r[^#{Regexp.escape @app_root}/?(.+?)$]) ? $1 : path
+    end
+
+  end
+
+end
+
+

data/lib/wiki/stores/file.rb

@@ -0,0 +1,53 @@
+class FileStore < Store
+  class << self
+
+    ### GET
+
+    def get_text(path)
+      File.read path if File.exist? path
+    end
+
+    def get_blob(path)
+      File.binread path if File.exist? path
+    end
+
+    ### PUT
+
+    def put_text(path, text, metadata=nil)
+      # Note: metadata is ignored for filesystem storage
+      File.open(path, 'w'){ |file| file.write text }
+      text
+    end
+
+    def put_blob(path, blob)
+      File.open(path, 'wb'){ |file| file.write blob }
+      blob
+    end
+
+    ### COLLECTIONS
+
+    def annotated_pages(pages_dir)
+      Dir.foreach(pages_dir).reject{|name|name =~ /^\./}.collect do |name|
+        page = get_page(File.join pages_dir, name)
+        page.merge!({
+          'name' => name,
+          'updated_at' => File.new("#{pages_dir}/#{name}").mtime
+        })
+      end
+    end
+
+    ### UTILITY
+
+    def farm?(data_root)
+      ENV['FARM_MODE'] || File.exists?(File.join data_root, "farm")
+    end
+
+    def mkdir(directory)
+      FileUtils.mkdir_p directory
+    end
+
+    def exists?(path)
+      File.exists?(path)
+    end
+  end
+end

data/lib/wiki/stores/store.rb

@@ -0,0 +1,38 @@
+class Store
+  class << self
+
+    attr_writer :app_root
+
+    def set(store_classname, app_root)
+      # @store_class is literally the class FileStore by default, or if a class name is passed in, another subclass of Store
+      @store_class = store_classname ? Kernel.const_get(store_classname) : FileStore
+      @store_class.app_root = app_root
+      @store_class
+    end
+
+    def method_missing(*args)
+      # For any method not implemented in *this* class, pass the method call through to the designated Store subclass
+      @store_class.send(*args)
+    end
+
+    ### GET
+
+    def get_hash(path)
+      json = get_text path
+      JSON.parse json if json
+    end
+
+    alias_method :get_page, :get_hash
+
+    ### PUT
+
+    def put_hash(path, ruby_data, metadata={})
+      json = JSON.pretty_generate(ruby_data)
+      put_text path, json, metadata
+      ruby_data
+    end
+
+    alias_method :put_page, :put_hash
+
+  end
+end

data/lib/wiki/version.rb

@@ -0,0 +1,3 @@
+module Wiki
+  VERSION = "0.0.1"
+end

data/lib/wiki/views/client/Gruntfile.js

@@ -0,0 +1,50 @@
+module.exports = function (grunt) {
+  grunt.loadNpmTasks('grunt-browserify');
+  grunt.loadNpmTasks('grunt-contrib-coffee');
+  grunt.loadNpmTasks('grunt-contrib-watch');
+
+  grunt.initConfig({
+    browserify: {
+      client: {
+        src: ['client.coffee'],
+        dest: 'client.js',
+        options: {
+          transform: ['coffeeify'],
+          debug: true
+        }
+      },
+      testClient: {
+        src: ['testclient.coffee', 'plugins/*/test.coffee'],
+        dest: 'test/testclient.js',
+        options: {
+          transform: ['coffeeify'],
+          debug: true
+        }
+      }
+    },
+
+    coffee: {
+      plugins: {
+        expand: true,
+        src: ['plugins/**/*.coffee'],
+        ext: '.js'
+      } 
+    },
+
+    watch: {
+      all: {
+        files: [
+          '<%= browserify.testClient.src %>',
+          '<%= browserify.client.src %>',
+          '<%= coffee.plugins.src %>',
+          'lib/**/*.coffee'
+        ],
+        tasks: ['browserify', 'coffee']
+      }
+    }
+  });
+
+  grunt.registerTask('build', ['coffee', 'browserify']);
+  grunt.registerTask('default', ['build']);
+
+};

data/lib/wiki/views/client/ReadMe.md

@@ -0,0 +1,67 @@
+Client Goals
+============
+
+A server offers direct restful read/write access to pages it owns and proxy access to pages held elsewhere in federated space.
+A page is owned if it was created with the server or has been cloned and edited such that it is believed to be the most authoritative copy of a page previously owned elsewhere.
+A server operates as a proxy to the rest of the federated wiki.
+In this role it reformats data and metadata providing a unified experience.
+It is welcome to collect behavioral statistics in order to improve this experience by anticipating permitted peer-to-peer server operations.
+
+In summary, the server's client side exists to:
+
+* Offer to a user a browsing experience that is independent of any specific server.
+* Support writing, editing and curating of one server in a way that offers suitable influence over others.
+
+Working with Browserify
+=======================
+
+The client side is written in CoffeeScript, and built with Browserify.
+If you are not checking in changes you need not concern yourself with this.
+We've checked in the generated Javascript for the client application.
+
+If you do want to check in changes, install node v0.6.x
+
+* On Linux download the source from [GitHub](https://github.com/joyent/node)
+* On Windows get the installer from the [main node.js site](http://nodejs.org).
+* On Mac you should be able to choose either.
+
+Once node is installed come back to this directory and run:
+
+* `npm install` To install CoffeeScript, Browserify, and all their dependencies.
+
+You can now use:
+
+* `npm start` To build the main client.
+* `npm test` To build the test client.
+
+These commands build client.js and test/testclient.js from client.coffee and
+testclient.coffee respectively.  They use their entry files to require the
+rest of the coffee script they need from the source CS files in /lib.
+
+We also have a cool automated talking (Mac only) Perl build script that uses
+a globally installed browserify via `npm install -g browserify`, it watches
+for changes, builds the clients automatically, and gives a verbal report
+when you have syntax errors.
+
+Testing
+=======
+
+All the client tests can be run by visiting /runtests.html on your server
+or by running the full ruby test suite. Information about the libraries we
+are using for testing can be found at:
+
+* http://visionmedia.github.com/mocha/
+* https://github.com/LearnBoost/expect.js
+* http://sinonjs.org/
+
+CoffeeScript hints
+==================
+
+We recommend taking time to learn the CoffeeScript syntax and the rationale for the Javascript idioms it employs. Start here:
+
+  http://jashkenas.github.com/coffee-script/
+
+We used a Javascript to Coffeescript converter to create the first draft of client.coffee. You may find this converter useful for importing sample codes. 
+
+  http://ricostacruz.com/js2coffee/
+

data/lib/wiki/views/client/build-test.bat

@@ -0,0 +1,10 @@
+@ECHO OFF
+::
+:: Used on Windows to build testclient.js as npm start and test don't work!
+::
+
+:: Build testclient.js - need to expand .\plugins\*\test.coffee as wildcard does not work on Windows
+
+echo "Building test\testclient.js"
+
+.\node_modules\.bin\browserify.cmd testclient.coffee .\plugins\calendar\test.coffee .\plugins\changes\test.coffee .\plugins\efficiency\test.coffee .\plugins\report\test.coffee .\plugins\txtzyme\test.coffee -o test\testclient.js