rails-wiki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aaa5b76e359711bd8dc4aa0e183906b335bce16d
+  data.tar.gz: f3c24e3ec96ae567912750f402331420e12ecb7a
+SHA512:
+  metadata.gz: 82b49289f36a9d89d5df6ca1f4e740b9761c9c2fe32a0a745124e657a3738b68f9075f6f9c53ec966e34784773700486c527c9a5528dc59133ba6e00b31ff590
+  data.tar.gz: 7d859845c6c6f10347cdef24afca2658208e6a46e1b85a3b41effbd6b698f95f2e48ec807a695bb7ec06cbc903a01cad2d4704841ad5c351299d6080d803fa7f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Hans Gerwitz
+
+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/README.md

@@ -0,0 +1,55 @@
+# Rails Wiki
+
+A small Rails engine that provides a git-based Markdown wiki.
+
+WARNING: this has been abstracted from a proprietary tool, and so is poorly documented and lacks a standalone test suite. It would be premature to include it as a blind dependency.
+
+## How it Works
+
+Rails Wiki is based on [gollum-lib](https://github.com/gollum/gollum-lib). None of [Gollum](https://github.com/gollum/gollum/wiki)'s layout (e.g. sidebars, headers, footers) are implemented, and a many of the text filters (e.g. macros, code, diagrams) have been disabled. Also unlike Gollum, the hierarchy of pages is considered meaningful.
+
+The storage structure will be familiar to users of Middleman or Jekyll. Each page is an `.md` file with YAML frontmatter for metadata. Other files are treated as attachments to the page associated with their containing directory.
+
+All storage is via a local Git repository. Optionally, a remote can be specified and changes will be pushed to it.
+
+_TODO: review and document remote behavior_
+
+## Installation
+
+Add Rails Wiki to your Gemfile
+
+    gem 'rails-wiki'
+
+Your application controller needs to provide two methods:
+
+- `auth_required` is called on every request
+- `current_user` returns a _user object_
+
+The user object must response to `.name` and `.email` with string values.
+
+## Configuration
+
+In your `routes.rb`, specify a mount point:
+
+    mount Wiki::Engine, at: '/wiki'
+
+In your `config/environment/*` files, configure the wiki:
+
+    require 'rails-wiki'
+    Wiki.local_directory = 'db/wiki'
+
+_TODO: move this configuration to an initializer?_
+
+## Usage
+
+Pathnames that begin with underscore (`_`) are reserved.
+
+## Feature Roadmap
+
+1. Markdown link rooting
+1. Recursive page deletion
+1. Individual attachment deletion
+1. Path redirection rules
+1. Configurable help paths
+1. Nicer attachment upload
+1. Nicer page editing

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Wiki'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/inject.js

@@ -0,0 +1,34 @@
+// inserts text at cursor, or before and after selection
+// based on http://stackoverflow.com/a/12815163/5610
+jQuery.fn.extend({
+  inject: function(insertTextPre, insertTextPost){
+    return this.each(function(i) {
+      if (document.selection) {
+        // IE
+        this.focus();
+        sel = document.selection.createRange();
+        sel.text = insertTextPre + insertTextPost;
+        this.focus();
+      }
+      else if (this.selectionStart || this.selectionStart == '0') {
+        // modern browser
+        var startPos = this.selectionStart;
+        var endPos = this.selectionEnd;
+        var scrollTop = this.scrollTop;
+        this.value = this.value.substring(0,     startPos)+insertTextPre+this.value.substring(startPos,endPos)+insertTextPost+this.value.substring(endPos,this.value.length);
+        this.focus();
+        this.selectionStart = startPos + insertTextPre.length;
+        this.selectionEnd = ((startPos + insertTextPre.length) + this.value.substring(startPos,endPos).length);
+        this.scrollTop = scrollTop;
+      } else {
+        // no selection, only use prefix
+        if (document.queryCommandSupported('insertText')) {
+            document.execCommand('insertText', false, text);
+        } else {
+          this.value += insertTextPre;
+          this.focus();
+        }
+      }
+    })
+  }
+});

data/app/assets/javascripts/wiki/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/wiki/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/wiki/application_controller.rb

@@ -0,0 +1,33 @@
+module Wiki
+  # inherit from host app for current_user and auth_required
+  class ApplicationController < ::ApplicationController
+
+    before_filter :auth_required
+
+    layout 'layouts/wiki'
+
+    def display
+      @home = Rails.configuration.wiki.home_page
+
+      ext = File.extname(request.path_info).downcase
+      if ext.blank? || ext == ".html"
+        @page = Rails.configuration.wiki.find_page(params[:path])
+        if @page.nil?
+          raise Exception.new("Attempt to create orphan page")
+        elsif @page.new_page?
+          redirect_to controller: :pages, action: :new
+        else
+          render 'wiki/pages/show'
+        end
+      else
+        @attachment = Rails.configuration.wiki.find_attachment(params[:path], ext)
+        if @attachment.blank?
+          raise ActionController::RoutingError.new('File Not Found')
+        else
+          send_file @attachment.filesystem_path, type: @attachment.mime_type, disposition: 'inline'
+        end
+      end
+    end
+
+  end
+end

data/app/controllers/wiki/pages_controller.rb

@@ -0,0 +1,80 @@
+class Wiki::PagesController < Wiki::ApplicationController
+
+  layout 'layouts/wiki'
+
+  def index
+    select = params[:select]
+    query = params[:query]
+    if query
+      @query = query
+      @pages = Rails.configuration.wiki.search(query)
+    else
+      @pages = Rails.configuration.wiki.all_pages
+    end
+  end
+
+  def log
+    @changes_by_path = Rails.configuration.wiki.changelog.group_by{|c| c[:path]}
+  end
+
+  def new
+    @page = Rails.configuration.wiki.find_page(params[:path])
+    render :edit
+  end
+
+  def create
+    @page = Rails.configuration.wiki.create_page(params[:path])
+    @page.update(page_params)
+    if @page.save(current_user)
+      redirect_to @page
+    else
+      render :edit
+    end
+  end
+
+  def edit
+    Rails.configuration.wiki.pull_repo
+    @page = Rails.configuration.wiki.find_page(params[:path])
+  end
+
+  def update
+    @page = Rails.configuration.wiki.find_page(params[:path])
+    @page.update(page_params)
+    if @page.save(current_user)
+      redirect_to @page
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    return_path = root_path
+    # ext = File.extname(request.path_info).downcase
+    # if ext.blank? || ext == "html"
+      page = Rails.configuration.wiki.find_page(params[:path])
+      parent_path = page.parent_path
+      if parent_path.empty?
+        return_path = root_path
+      else
+        return_path = page_path(parent_path)
+      end
+      page.destroy!(current_user)
+      # TODO: recurse pages and attachments
+
+    # else
+    #   file = Rails.configuration.wiki.find_file(params[:path] + '.' + params[:format])
+    #   return_path = page_path(file.parent_path)
+    #   file.destroy!(current_user)
+    # end
+
+    # TODO: look for first *valid* parent
+    redirect_to return_path
+  end
+
+private
+
+  def page_params
+    params.require(:page).permit(:name, :content, uploaded_files: [])
+  end
+
+end

data/app/helpers/wiki/application_helper.rb

@@ -0,0 +1,4 @@
+module Wiki
+  module ApplicationHelper
+  end
+end

data/app/helpers/wiki/wiki_helper.rb

@@ -0,0 +1,8 @@
+module Wiki
+  module WikiHelper
+    def wiki_changes(max=10)
+      changes = Rails.configuration.wiki.changelog.first(max)
+      "<ol>#{render partial: "wiki/change", collection: changes}</ol>".html_safe
+    end
+  end
+end

data/app/models/wiki/attachment.rb

@@ -0,0 +1,116 @@
+require 'active_model'
+
+module Wiki
+class Attachment
+
+  include ActiveModel::AttributeMethods
+  include ActiveModel::Conversion
+  include ActiveModel::Dirty
+  extend ActiveModel::Naming
+
+  define_attribute_methods :name, :content
+
+  attr_accessor :wiki, :name, :content, :path, :format
+  alias :id :path
+
+  def name=(value)
+    name_will_change!
+    @name=value unless value.nil?
+  end
+
+  def content=(value)
+    content_will_change!
+    @content=value unless value.nil?
+  end
+
+  def to_s
+    self.path
+  end
+
+  def path
+    @path
+  end
+
+  def update(hash)
+    self.name = hash[:name]
+    self.content = hash[:content]
+
+    return true
+  end
+
+  def initialize(params={})
+    wiki = params[:wiki]
+    gollum_file = params[:gollum_file]
+    path = params[:path]
+
+    if wiki
+      @wiki = wiki
+    end
+    if gollum_file
+      self.gollum_file = gollum_file
+    elsif path
+      safepath = path.downcase
+      @path = safepath
+      new_file = @wiki.find_gollum_file(safepath)
+      if new_file
+        self.gollum_file = new_file
+      end
+    end
+  end
+
+  def gollum_file=(file)
+    @gollum_file = file
+    @name = file.name
+    @format = File.extname(file.name).split('.').last.to_sym
+    # filename = ::Attachment.basename(fullname, ext)
+    @path = file.url_path + file.name
+  end
+
+  def gollum_file
+    @gollum_file
+  end
+
+  def filesystem_path
+    return File.join(@wiki.base_path, @path)
+  end
+
+  def mime_type
+    @gollum_file.mime_type
+  end
+
+  def to_param
+    @path
+  end
+
+  def parent_path
+    parent_path = File.dirname(@path)
+    (parent_path == '.') ? '' : parent_path + '/'
+  end
+
+  def destroy!(user)
+    commit_options = {name: user.name, email: user.email, message: "removed #{@path}"}
+    Rails.logger.debug("removing #{@path}")
+
+    committer = Gollum::Committer.new(@wiki.gollum_wiki, commit_options)
+    committer.delete(@path)
+
+    committer.after_commit do |index, _sha|
+      dir = File.dirname(@path)
+      dir = '' if dir == '.'
+
+      @wiki.gollum_wiki.clear_cache
+      committer.update_working_dir(dir, parent_path, @format)
+    end
+
+    @wiki.pull_repo
+    committer.commit
+    @wiki.push_repo
+  end
+
+  def persisted?
+    # TODO: make this a real dirty flag
+    true
+  end
+
+end
+end

data/app/models/wiki/page.rb

@@ -0,0 +1,213 @@
+require 'active_model'
+
+module Wiki
+class Page
+  # a gollum page facade
+
+  @@format = :markdown
+
+#  include ActiveModel::Model
+  include ActiveModel::AttributeMethods
+  include ActiveModel::Conversion
+  include ActiveModel::Dirty
+  extend ActiveModel::Naming
+
+  define_attribute_methods :name, :content
+
+  attr_accessor :wiki, :name, :content, :path, :uploaded_files
+  alias :id :path
+
+  def name=(value)
+    name_will_change!
+    @name=value unless value.nil?
+  end
+
+  def content=(value)
+    content_will_change!
+    @content=value unless value.nil?
+  end
+
+  def to_param
+    @path
+  end
+
+  def path
+    @path
+  end
+
+  def update(hash)
+    self.name = hash[:name]
+    self.content = hash[:content]
+    @uploaded_files = hash[:uploaded_files]
+
+    return true
+  end
+
+  def initialize(params={})
+    wiki = params[:wiki]
+    gollum_page = params[:gollum_page]
+    path = params[:path]
+
+    if wiki
+      @wiki = wiki
+    end
+    if gollum_page
+      self.gollum_page = gollum_page
+    elsif path
+      safepath = path.downcase
+      @path = safepath
+      new_page = @wiki.find_gollum_page(safepath)
+      if new_page
+        self.gollum_page = new_page
+      else
+        @name = safepath.split('/').last
+        @blank = true
+      end
+    end
+  end
+
+  def gollum_page=(new_gp)
+    @gollum_page = new_gp
+    @name = new_gp.name
+    @path = new_gp.url_path
+    @content = new_gp.raw_data
+  end
+
+  def gollum_page
+    @gollum_page
+  end
+
+  def new_page?
+    @blank && true
+  end
+
+  # may be out of sync with @content!
+  def html
+    @gollum_page.formatted_data unless @blank
+  end
+
+  def metadata
+    @gollum_page.metadata
+  end
+
+  # def to_param
+  #   @gollum_page.url_path unless @blank
+  # end
+
+  def author
+    @gollum_page.versions.first.author.name unless @blank
+  end
+  def authored_date
+    @gollum_page.versions.first.authored_date unless @blank
+  end
+
+  def history_url
+    # @@format is :markdown, so let's presume
+    @wiki.history_url + @path + '.md'
+  end
+
+  def parents
+    parents = []
+    ancestors = @path.split('/')
+    for i in 1..(ancestors.length - 1) do
+      parent_name = ancestors.take(i).join('/')
+      parents << @wiki.find_page(parent_name)
+    end
+    return parents
+  end
+
+  def parent_path
+    parent_path = File.dirname(@path)
+    (parent_path == '.') ? '' : parent_path # + '/'
+  end
+
+  def children
+    @wiki.pages_under_path(@path)
+  end
+
+  def attachments
+    return @wiki.files_under_path(@path)
+  end
+
+  def save(user)
+    if @blank
+      commit = {name: user.name, email: user.email, message: "created #{@path}"}
+      Rails.logger.debug("creating #{@path}")
+
+      @wiki.pull_repo
+      @wiki.gollum_wiki.write_page(@name, @@format, @content, commit, self.parent_path)
+
+      @gollum_page = @wiki.find_gollum_page(@path)
+      @blank = false
+    else
+      commit = {name: user.name, email: user.email, message: "updated #{@path}"}
+      Rails.logger.debug("saving #{@path}")
+
+      @wiki.pull_repo
+      @wiki.gollum_wiki.update_page(@gollum_page, @name, @@format, @content, commit)
+    end
+
+    if @uploaded_files.present?
+      Rails.logger.debug("found #{@uploaded_files.length} new files for #{@path}")
+      head = @wiki.gollum_wiki.repo.head
+
+      # NOTE: may raise Gollum::DuplicatePageError
+      commit_options = {
+        message: "added #{@uploaded_files.length} attachments to #{@path}",
+        name: user.name,
+        email: user.email
+      }
+      committer = Gollum::Committer.new(@wiki.gollum_wiki, commit_options)
+
+      self.uploaded_files.each do |uploaded|
+        # TODO: maybe this should be creating then saving new files
+        fullname = uploaded.original_filename
+        ext = File.extname(fullname)
+        format = ext.split('.').last
+        filename = File.basename(fullname, ext)
+        contents = uploaded.read
+        fsdir = File.join(@wiki.gollum_wiki.path, @path)
+        pathname = File.join(@path, fullname)
+
+        if !FileTest::directory?(fsdir)
+          Dir::mkdir(fsdir)
+        end
+        fspath = File.join(fsdir, fullname)
+        File.open(fspath, 'wb') do |file|
+          file.write(contents)
+          Rails.logger.debug("uploaded #{format} to #{fspath}")
+        end
+
+        committer.index.add(pathname, contents)
+        # committer.add_to_index(@path, filename, format, contents)
+        # # committer.add_to_index(@path, filename, format, "file")
+        committer.after_commit do |committer, sha|
+          @wiki.gollum_wiki.clear_cache
+          committer.update_working_dir(@path, filename, format)
+        end
+      end
+      committer.commit
+    end
+
+    @wiki.push_repo
+    changes_applied
+  end
+
+  def destroy!(user)
+    commit = {name: user.name, email: user.email, message: "removed #{@path}"}
+    Rails.logger.debug("removing #{@path}")
+    @wiki.gollum_wiki.delete_page(@gollum_page, commit)
+    @wiki.push_repo
+  end
+
+  def inspect
+    "Wiki::Page '#{@path}' (#{@gollum_page})"
+  end
+
+  def persisted?
+    # TODO: make this a real dirty flag
+    ! self.new_page?
+  end
+
+end
+end