chiliproject_side_by_side_wiki_edit 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.0 2012-09-28
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joris Kraak
+
+MIT License
+
+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/Manifest.txt

@@ -0,0 +1,15 @@
+.gitignore
+Gemfile
+History.txt
+LICENSE
+Manifest.txt
+README.md
+Rakefile
+assets/javascripts/side_by_side_edit.js
+chiliproject_side_by_side_wiki_edit.gemspec
+init.rb
+lib/chiliproject_side_by_side_wiki_edit.rb
+lib/chiliproject_side_by_side_wiki_edit/hooks/view_wiki_edit_hook.rb
+lib/chiliproject_side_by_side_wiki_edit/version.rb
+lib/tasks/chiliproject_side_by_side_wiki_edit_tasks.rb
+rails/init.rb

data/README.md

@@ -0,0 +1,35 @@
+# ChiliProject - Side by side wiki edit plugin
+
+* http://github.com/bauglir/chiliproject_side_by_side_wiki_edit/
+
+This plugin adds a checkbox on wiki edit pages to put the editor and the
+preview window side by side.
+
+The layout of the page is completely handled client-side. Rendering of
+the preview is handled by ChiliProject itself server-side. This allows
+liquid macros and such to work properly
+
+## Installation
+
+In your 'Gemfile', add:
+```
+gem chiliproject_side_by_side_wiki_edit
+```
+
+Then run either `bundle install` or `bundle update` depending on your situation.
+
+Next, in your 'Rakefile', add:
+```
+require 'tasks/chiliproject_side_by_side_wiki_edit_tasks'
+```
+
+Run the installation task
+```
+RAILS_ENV=production rake chiliproject_side_by_side_wiki_edit:install
+```
+
+Finally cycle your application server to enable the plugin
+
+## LICENSE:
+
+Refer to the [LICENSE](https://github.com/bauglir/chiliproject_side_by_side_wiki_edit/blob/master/LICENSE) file

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/assets/javascripts/side_by_side_edit.js

@@ -0,0 +1,46 @@
+jQuery(function() {
+  var $ = jQuery;
+  var editor = $('textarea.wiki-edit');
+  var preview = $('div#preview');
+  var preview_link = $('input[name=commit]').next();
+
+  var disable = function() {
+    editor.parentsUntil('p').parent().removeAttr('style');
+    preview.removeAttr('style');
+    $('#content').append(preview);
+  };
+
+  var enable = function() {
+    var editorParent = editor.parentsUntil('p').parent();
+
+    editorParent.css('width', '49%').before(preview);
+    preview.css({ 'float': 'right', 'width': '49%', 'margin-top': '5ex', 'overflow-y': 'scroll' });
+    preview.height(editor.height() + 5);
+
+    editor.scroll(preview, scroll_preview);
+    editor.scroll();
+
+    if($('fieldset.preview').length === 0) {
+      preview_link.click();
+    }
+  };
+
+  var scroll_preview = function(event) {
+    var source_position = this.scrollTop / (this.scrollHeight - $(this).innerHeight());
+    var target = $(event.data);
+
+    target.scrollTop(source_position * (target[0].scrollHeight - target.innerHeight()));
+  }
+
+  var toggle_mode = function() {
+    if(this.checked) {
+      enable();
+    } else {
+      disable();
+    }
+  }
+
+  preview_link.after($('<label for="side_by_side_mode">Show editor and preview side-by-side</label>'))
+              .after($('<input id="side_by_side_mode" type="checkbox" />'));
+  $('#side_by_side_mode').on('click', toggle_mode);
+});

data/chiliproject_side_by_side_wiki_edit.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/chiliproject_side_by_side_wiki_edit/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joris Kraak"]
+  gem.email         = ["me@joriskraak.nl"]
+  gem.description   = %q{Allows side by side editor/preview functionality for ChiliProject wiki pages}
+  gem.summary       = %q{This plugin adds a checkbox to the edit page for ChiliProject wiki pages, which allows a user to switch between the default behavior and a side by side editor/preview mode}
+  gem.homepage      = "http://github.com/bauglir/chiliproject_side_by_side_wiki_edit"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "chiliproject_side_by_side_wiki_edit"
+  gem.require_paths = ["lib"]
+  gem.version       = ChiliprojectSideBySideWikiEdit::VERSION
+end

data/init.rb

@@ -0,0 +1,12 @@
+require 'redmine'
+
+Redmine::Plugin.register :chiliproject_side_by_side_wiki_edit do
+  name 'Chiliproject Side By Side Wiki Edit plugin'
+  author 'Joris Kraak'
+  description 'This plugin enables an option to show the preview of a wiki page, side-by-side with the wiki editor'
+  version ChiliprojectSideBySideWikiEdit::VERSION
+  url 'http://github.com/bauglir/chiliproject_side_by_side_wiki_edit'
+  author_url 'http://majorfail.com'
+end
+
+require 'chiliproject_side_by_side_wiki_edit/hooks/view_wiki_edit_hook'

data/lib/chiliproject_side_by_side_wiki_edit.rb

@@ -0,0 +1,4 @@
+require "chiliproject_side_by_side_wiki_edit/version"
+
+module ChiliprojectSideBySideWikiEdit
+end

data/lib/chiliproject_side_by_side_wiki_edit/hooks/view_wiki_edit_hook.rb

@@ -0,0 +1,11 @@
+module ChiliprojectSideBySideWikiEdit
+  module Hooks
+    class ViewWikiEditHook < Redmine::Hook::ViewListener
+      def view_layouts_base_html_head(context = {})
+        if context[:controller] && context[:controller].is_a?(WikiController) && (context[:controller].action_name == 'edit')
+          javascript_include_tag '/plugin_assets/chiliproject_side_by_side_wiki_edit/javascripts/side_by_side_edit.js'
+        end
+      end
+    end
+  end
+end

data/lib/chiliproject_side_by_side_wiki_edit/version.rb

@@ -0,0 +1,3 @@
+module ChiliprojectSideBySideWikiEdit
+  VERSION = "0.1.0"
+end

data/lib/tasks/chiliproject_side_by_side_wiki_edit_tasks.rb

@@ -0,0 +1,73 @@
+require 'rake'
+require 'rake/tasklib'
+
+class ChiliprojectSideBySideWikiEditTasks < Rake::TaskLib
+  def initialize
+    define
+  end
+
+  def define
+    namespace :chiliproject_side_by_side_wiki_edit do
+      desc "Install ChiliprojectSideBySideWikiEdit plugin (include assets, etc)"
+      task :install => [:symlink_assets]
+
+      desc "Uninstalls ChiliprojectSideBySideWikiEdit plugin (removes database modifications, removes assets, etc)"
+      task :uninstall => [:environment] do
+        puts "Removing link to ChiliprojectSideBySideWikiEdit assets (stylesheets, js, etc)..."
+        remove_symlink asset_destination_dir
+        puts post_uninstall_steps
+      end
+
+      task :symlink_assets => [:environment] do
+        # HACK: Symlinks the files from plugindir/assets to the appropriate place in
+        # the rails application
+        puts "Symlinking assets (stylesheets, etc)..."
+        add_symlink asset_source_dir, asset_destination_dir
+      end
+    end
+  end
+
+  private
+    def application_root
+      File.expand_path(RAILS_ROOT)
+    end
+
+    def gem_root
+      @gem_root ||= File.expand_path(File.dirname(__FILE__) + "/../..")
+    end
+
+    def asset_destination_dir
+      @destination_dir ||= File.expand_path("#{application_root}/public/plugin_assets/chiliproject_side_by_side_wiki_edit")
+    end
+
+    def asset_source_dir
+      @source_dir ||= File.expand_path(gem_root + "/assets")
+    end
+
+    def remove_symlink(symlink_file)
+      system("unlink #{symlink_file}") if File.exists?(symlink_file)
+    end
+
+    def add_symlink(source, destination)
+      remove_symlink destination
+      system("ln -s #{source} #{destination}")
+    end
+
+    def post_uninstall_steps
+      [
+        "!!!!! MANUAL STEPS !!!!!",
+        "\t1. In your 'Gemfile', remove:",
+        "\t\tgem 'chiliproject_side_by_side_wiki_edit'",
+        "",
+        "\t2. In your 'Rakefile', remove:",
+        "\t\trequire 'tasks/chiliproject_side_by_side_wiki_edit_tasks'",
+        "",
+        "\t3. Run 'bundle' (or 'bundle install') to update your Gemfile.lock",
+        "",
+        "\t4. Cycle your application server (mongrel, unicorn, etc)",
+        "\n",
+      ].join("\n")
+    end
+end
+
+ChiliprojectSideBySideWikiEditTasks.new

data/rails/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../init"

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: chiliproject_side_by_side_wiki_edit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joris Kraak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-28 00:00:00.000000000 Z
+dependencies: []
+description: Allows side by side editor/preview functionality for ChiliProject wiki
+  pages
+email:
+- me@joriskraak.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.md
+- Rakefile
+- assets/javascripts/side_by_side_edit.js
+- chiliproject_side_by_side_wiki_edit.gemspec
+- init.rb
+- lib/chiliproject_side_by_side_wiki_edit.rb
+- lib/chiliproject_side_by_side_wiki_edit/hooks/view_wiki_edit_hook.rb
+- lib/chiliproject_side_by_side_wiki_edit/version.rb
+- lib/tasks/chiliproject_side_by_side_wiki_edit_tasks.rb
+- rails/init.rb
+homepage: http://github.com/bauglir/chiliproject_side_by_side_wiki_edit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1310505938391298615
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1310505938391298615
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This plugin adds a checkbox to the edit page for ChiliProject wiki pages,
+  which allows a user to switch between the default behavior and a side by side editor/preview
+  mode
+test_files: []