birdses 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Maximilian Haack
+
+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,49 @@
+# Birdses
+
+Birdses implements views for [gollum](https://github.com/github/gollum) as a mountable rails engine.
+
+Add Birdses to your rails application in three easy steps:
+
+1. add `gem 'birdses'` to your Gemfile and run `bundle install`
+2. add `mount Birdses::Engine => "/wiki"` to your `config/routes.rb`
+3. init a [git](http://git-scm.com/) repository under `wiki/`  
+   (you can do this by running `rake init_wiki`)
+
+## Caveats
+
+### `current_user`
+
+If you're using an authentication system that provides a `current_user` method (like [devise](https://github.com/plataformatec/devise)), birdses will try to access `.fullname` and `.email` (on `current_user`). It will use these for the commit messages.
+
+### `_url`/`_path`
+
+If you use any magic url mappers (any method that ends with `_path` or `_url`) in the application layout you will have to use the `main_app` [helper](http://edgeguides.rubyonrails.org/engines.html#using-a-class-provided-by-the-application).
+
+For example, I use [Twitter Bootstrap](http://twitter.github.com/bootstrap/) and have a 'Sign Out' link in my navigation bar. For it to work properly with birdses I have to prepend the helper method.
+
+without birdes:
+```haml
+# ...
+- if current_user
+  %li= link_to('Sign Out', destroy_user_session_path, method: :delete)
+# ...
+```
+
+with birdses:
+```haml
+# ...
+- if current_user
+  %li= link_to('Sign Out', main_app.destroy_user_session_path, method: :delete)
+# ...
+```
+
+Otherwise you will get errors like this, when accessing the mounted wiki:
+
+```
+NameError in Birdses/pages#index
+
+Showing /Users/max/code/snap_app/app/views/layouts/application.html.haml where line #43 raised:
+
+undefined local variable or method `destroy_user_session_path' for
+#<#<Class:0x007fd67c3d6418>:0x007fd67afb3508>
+```

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Birdses'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# RSpec as default
+task :default => :spec
+
+desc 'create git repo for the wiki'
+task :init_wiki do
+  sh 'mkdir -p spec/dummy/wiki/'
+  Dir.chdir('spec/dummy/wiki') do
+    sh 'git init && echo "Hi" > home.md && git add . && git commit -m "init"'
+  end
+end
+
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,15 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/birdses/pages.js

@@ -0,0 +1,44 @@
+$(document).ready(function() {
+  // Editor
+  var textarea = $("[id$=page_raw_data]");
+  textarea.hide();
+  var editor = ace.edit("editor");
+  editor.getSession().setValue(textarea.val());
+  editor.setTheme("ace/theme/tomorrow");
+  editor.getSession().setMode("ace/mode/markdown");
+  editor.getSession().setTabSize(2);
+  editor.resize();
+  $("#editor_form").submit(function(){
+    textarea.val(editor.getSession().getValue());
+  });
+
+  // Preview
+  var preview = $('[name$=preview_button]');
+  preview.click(function(event) {
+    event.preventDefault();
+
+    // set the page's name to the value of the hidden preview textbox
+    $('#preview_name').val(function () {
+      var name = $('h2').html();
+      if ('New Page' == name) {
+        name = $('#page_name').val()
+      }
+      return name
+    });
+
+    // set the page's content to the value of the hidden content preview box
+    $('#preview_content').val(editor.getSession().getValue());
+
+    // Toggle the title of the Preview Button
+    $('#editor').toggle();
+    $('#preview').toggle(10, function(){
+      if ($('#preview').is(':visible')) {
+        preview.val('Edit');
+        $('#preview_form').submit();
+      } else {
+        preview.val('Preview');
+      }
+    });
+  });
+});
+

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/birdses/pages.css

@@ -0,0 +1,23 @@
+#editor {
+  position: absolute;
+  margin-top: 25px;
+  width: 80%;
+  height: 80%;
+}
+
+#preview {
+  margin-top: 25px;
+  display: none;
+}
+
+#birdses_pages_nav ul {
+  margin-left: 0;
+  margin-right: 50px;
+  margin-bottom: 20px;
+  list-style: none;
+  float: right;
+}
+
+#birdses_pages_nav li {
+  display: inline;
+}

data/app/controllers/birdses/application_controller.rb

@@ -0,0 +1,2 @@
+class Birdses::ApplicationController < ApplicationController
+end

data/app/controllers/birdses/pages_controller.rb

@@ -0,0 +1,61 @@
+require_dependency "birdses/application_controller"
+
+module Birdses
+  class PagesController < ApplicationController
+    before_filter :get_user
+
+    def index
+      @pages = Page.all
+    end
+
+    def new
+      @page = Page.new
+    end
+
+    def create
+      name    = params[:page][:name]
+      content = params[:page][:raw_data]
+      @page = Page.create(name, content, @user)
+      redirect_to "#{pages_path}/#{name.parameterize}"
+    end
+
+    def show
+      @page = Page.find_by_name(params[:id])
+    end
+
+    def edit
+      @page = Page.find_by_name(params[:id])
+    end
+
+    def update
+      name    = params[:id]
+      content = params[:page][:raw_data]
+      Page.update(name, content, @user)
+      redirect_to "#{pages_path}/#{name.parameterize}"
+    end
+
+    def destroy
+      Page.destroy(params[:id], @user)
+      redirect_to pages_path
+    end
+
+    def preview
+      preview = Page.preview(params[:name], params[:content])
+      @content = preview.formatted_data
+    end
+
+    private
+
+    def get_user
+      name  = 'Anonymous'
+      email = 'anon@example.com'
+      if defined?(current_user)
+        # this rescue is necessary because .try?(:method) does not work on
+        # `current_user`
+        name  = current_user.fullname rescue 'Anonymous'
+        email = current_user.email    rescue 'anon@example.com'
+      end
+      @user = { 'name' => name, 'email' => email }
+    end
+  end
+end

data/app/helpers/birdses/application_helper.rb

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

data/app/helpers/birdses/pages_helper.rb

@@ -0,0 +1,41 @@
+module Birdses
+  module PagesHelper
+    def index?
+      current?(:index) || current_page?(root_url)
+    end
+
+    def new?
+      current?(:new)
+    end
+
+    def edit?
+      current?(:edit)
+    end
+
+    def create_or_update?
+      if new?
+        :create
+      elsif edit?
+        :update
+      end
+    end
+
+    def post_or_put?
+      if new?
+        :post
+      elsif edit?
+        :put
+      end
+    end
+
+    def current?(page)
+      current_page?(controller: 'pages', action: page)
+    end
+
+    def title(page)
+      doc = Nokogiri::HTML::fragment(page.formatted_data, 'UTF-8')
+      h1 = doc.css("h1:first-child")
+      raw("<h1>#{page.name}</h1>") if h1.empty?
+    end
+  end
+end

data/app/models/birdses/page.rb

@@ -0,0 +1,54 @@
+require 'gollum'
+
+module Birdses
+  module Page
+    extend self
+    WIKI_FORMAT = :markdown
+
+    def all
+      wiki.pages
+    end
+
+    def new
+      Struct.new(:name, :raw_data).new('New Page', '')
+    end
+
+    def create(page_name, content, user)
+      wiki.write_page(page_name, WIKI_FORMAT, content,
+                      build_commit(user, "creating #{page_name}"))
+    end
+
+    def update(page_name, content, user)
+      page = find_by_name(page_name)
+      wiki.update_page(page, page.name, page.format, content,
+                       build_commit(user, "updating #{page_name}"))
+    end
+
+    def destroy(page_name, user)
+      page = find_by_name(page_name)
+      wiki.delete_page(page, build_commit(user, "delete #{page_name}"))
+    end
+
+    def find_by_name(name)
+      wiki.page(name)
+    end
+
+    def preview(page_name, content)
+      wiki.preview_page(page_name, content, WIKI_FORMAT)
+    end
+
+    private
+
+    def wiki
+      Gollum::Wiki.new(Rails.root.join('wiki'))
+    end
+
+    def build_commit(user, message)
+      {
+        message: message,
+        name:    user['name'],
+        email:   user['email']
+      }
+    end
+  end
+end

data/app/views/birdses/pages/_editor.html.erb

@@ -0,0 +1,22 @@
+<h2><%= @page.name %></h2>
+
+<%= form_for :page, url: { action: create_or_update? },
+                    method: post_or_put?, html: { id: 'editor_form' } do |f| %>
+  <% if new? %>
+    <%= f.text_field :name %>
+  <% end %>
+  <%= f.text_area :raw_data %>
+  <%= f.submit %>
+  <%= f.submit "Preview", :name => 'preview_button' %>
+  <div id="editor"></div>
+  <div id="preview"></div>
+<% end %>
+
+<%= form_tag "#{pages_path}/doesntmatter/preview", id: 'preview_form',
+                                                   remote: true do -%>
+  <%= hidden_field_tag 'name', 'title', { id: 'preview_name' } %>
+  <%= hidden_field_tag 'content', 'content', { id: 'preview_content' } %>
+<% end %>
+
+<%= javascript_include_tag "birdses/application" %>
+<%= javascript_include_tag "http://d1n0x3qji82z53.cloudfront.net/src-min-noconflict/ace.js" %>

data/app/views/birdses/pages/_nav.html.erb

@@ -0,0 +1,24 @@
+<%= stylesheet_link_tag    "birdses/application", :media => "all" %>
+
+<div id='birdses_pages_nav'>
+  <ul>
+    <% unless index? %>
+      <li>
+        <%= link_to 'Wiki Home', root_url %>
+      </li>
+    <% end %>
+    <li>
+      <%= link_to_unless_current 'New Page', new_page_path %>
+    </li>
+    <% unless index? || new? || edit? %>
+      <li>
+        <%= link_to 'Edit', controller: 'pages', action: :edit,
+                            id: @page.name %>
+      </li>
+      <li>
+        <%= link_to 'Destroy', "#{pages_path}/#{@page.name}", method: :delete,
+                                confirm: "Are you sure?" %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/views/birdses/pages/edit.html.erb

@@ -0,0 +1,2 @@
+<%= render 'nav' %>
+<%= render 'editor' %>

data/app/views/birdses/pages/index.html.erb

@@ -0,0 +1,10 @@
+<%= render 'nav' %>
+<h1>Pages</h1>
+<ul>
+  <% @pages.each do |page| %>
+    <li>
+      <%= link_to page.name, controller: 'pages',
+                             action: :show, id: page.name %>
+    </li>
+  <% end %>
+</ul>