irwi 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,53 @@
+= Irwi
+
+Irwi is Ruby on Rails plugin which adds wiki functionality to your application.
+
+== Installation
+
+In your application directory call:
+
+  script/plugin install git://github.com/alno/irwi
+
+== Usage
+
+In your application directory call:
+
+  script/generate irwi_wiki
+  
+It will generate:
+* WikiPageController to serve wiki pages
+* WikiPage model to represent page
+* Migration to prepare database
+
+Also it will add to your <tt>routes.rb</tt> something like:
+
+  map.wiki_root '/wiki'
+
+== Template definition
+
+You may create your own templates for controller actions (<tt>show</tt>, <tt>edit</tt> and <tt>history</tt>), in other case default built-in templates will be used.
+
+== Helper definition
+
+Following helpers are defined by default and you may replace them with you own:
+* <tt>wiki_user</tt> - Renders user name or link by given user object. By default renders &lt;Unknown&gt; for <tt>nil</tt> and "User#{user.id}" for others.
+
+== Configuration
+
+Configuration options are acessed via <tt>Irwi.options</tt> object. Currently supported options:
+* <tt>user_class_name</tt> - Name of user model class. By default - 'User'
+* <tt>formatter</tt> - Formatter instance, which process wiki content before output. It should have method <tt>format</tt>, which gets a string and returns it formatted. By default instance of <tt>Irwi::Formatters::RedCloth</tt> is used (requires RedCloth gem). Other built-in formatter is <tt>Irwi::Formatters::BlueCloth</tt> (requires BlueCloth gem).
+* <tt>comparator</tt> - Comparator instance, which builds and renders a set of changes between to texts. By default instance of <tt>Irwi::Comparators::DiffLcs</tt> is used (requires diff-lcs gem).
+
+== Access control
+
+If you want (and it's good idea) to specify which users can see or edit certain pages you should simply override following methods in your controller:
+* <tt>show_allowed?</tt> - should return <tt>true</tt> when it's allowed for current user to see current page (@page). 
+* <tt>history_allowed?</tt> - should return <tt>true</tt> when it's allowed for user to see history of current page (@page) and compare it's versions.
+* <tt>edit_allowed?</tt> - should return <tt>true</tt> when it's allowed for current user to modify current page (@page).
+
+== Localization
+
+TODO
+
+Copyright (c) 2009 Alexey Noskov, released under the MIT license

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "irwi"
+    gem.summary = %Q{Irwi is Ruby on Rails plugin which adds wiki functionality to your application. }
+    gem.description = %Q{Irwi is Ruby on Rails plugin which adds wiki functionality to your application. }
+    gem.email = "alexey.noskov@gmail.com"
+    gem.homepage = "http://github.com/alno/irwi"
+    gem.authors = ["Alexey Noskov"]
+    gem.add_dependency "diff-lcs", ">= 1.1.2"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all specs in spec directory with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = lambda do
+    IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+task :test => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Irwi #{version}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/app/views/base_wiki_pages/_wiki_page_actions.html.erb

@@ -0,0 +1,4 @@
+<ul class="wiki_page_actions">
+  <%= '<li>' + link_to( wt( 'Edit' ), wiki_page_edit_path ) + '</li>' if edit_allowed? %>
+  <%= '<li>' + link_to( wt( 'History' ), wiki_page_history_path ) + '</li>' if history_allowed? %>
+</ul>

data/app/views/base_wiki_pages/_wiki_page_history.html.erb

@@ -0,0 +1,31 @@
+<% if with_form %>
+  <form action="<%=wiki_page_compare_path%>" method="get">
+<% end %>
+
+<table class="wiki_history">
+  <tr class="wiki_history_header">
+    <td><%=wt 'Version' %></td>
+    <td><%=wt 'Date' %></td>
+    <td><%=wt 'Author' %></td>
+    <td><%=wt 'Comment' %></td>
+  </tr>
+  <% versions.reverse.each do |v| %>
+    <tr>
+      <td>
+        <%=v.number%>
+        <% if with_form %>
+          <input type="radio" name="old" value="<%=v.number%>" <%= 'checked="true" ' if v == versions[-1] %>/>
+          <input type="radio" name="new" value="<%=v.number%>" <%= 'checked="true" ' if v == versions[-2] %>/>
+        <% end %>
+      </td>
+      <td><%=l( v.updated_at, :format => :long ) %></td>
+      <td><%= wiki_user( v.updator ) %></td>
+      <td><%= v.comment %></td>
+    </tr>
+  <% end %>
+</table>
+  
+<% if with_form %>
+  <%= submit_tag wt 'Compare selected versions' %>
+  </form>
+<% end %>

data/app/views/base_wiki_pages/_wiki_page_info.html.erb

@@ -0,0 +1,3 @@
+<div class="wiki_page_info">
+  <%=wt "Revised on {{time}} by {{user}}", :time => l( page.updated_at, :format => :long ), :user => wiki_user( page.updator ) %>
+</div>

data/app/views/base_wiki_pages/_wiki_page_style.html.erb

@@ -0,0 +1,69 @@
+<style>
+
+.wiki_page_info {
+  font-style: italic;
+  color: #666;
+  margin-left: 5px; 
+  float: left;
+}
+
+.wiki_page_actions {
+  text-align: right;
+  width: 100%;
+  padding: 0px;
+}
+
+.wiki_page_actions li {
+  display: inline;
+  margin: 0px;
+  padding: 0px;
+}
+
+.wiki_content,
+.wiki_diff,
+.wiki_history {
+  border: 1px dashed #666;
+  margin-top: 10px;
+  margin-bottom: 10px;
+  padding: 10px;
+}
+
+.wiki_history {  
+  width: 100%;
+}
+
+.wiki_history_header td {
+  border-bottom: 2px dashed black; 
+}
+
+.wiki_form {
+  display: block;
+  width: 100%;
+  border: 1px dashed #666;
+}
+
+.wiki_form p {
+  padding: 10px;
+}
+
+.wiki_form p input,
+.wiki_form p textarea {
+  width: 100%;
+}
+
+.wiki_form .submit {
+  margin-left: 20px;
+  margin-bottom: 10px;
+}
+
+.wiki_diff span.added {
+  background: #D4FFAB;
+  color: #509A05;
+}
+
+.wiki_diff span.removed {
+  background: #FFD8D8;
+  color: #EF2828;
+}
+
+</style>

data/app/views/base_wiki_pages/compare.html.erb

@@ -0,0 +1,13 @@
+<%= wiki_page_style %>
+
+<h1><%=wt '{{page_title}} - Comparing versions {{old_version}} and {{new_version}}', :page_title => h( @page.title ), :old_version => @old_version.number, :new_version => @new_version.number %></h1>
+
+<%=wt 'Changes list:' %>
+
+<%= wiki_page_history @page, @versions[1..-1] %>
+
+<%=wt 'Changes in content:' %>
+
+<div class="wiki_diff">
+  <%= wiki_diff @old_version.content, @new_version.content %>
+</div>

data/app/views/base_wiki_pages/edit.html.erb

@@ -0,0 +1,14 @@
+<%= wiki_page_style %>
+
+<h1><%=wt 'Editing wiki page' %></h1>
+
+<% wiki_page_form do |f| %>
+  <%= f.hidden_field :previous_version_number, :value => f.object.last_version_number %>
+  
+  <p><%=wt 'Path:' %><br/><%= f.text_field :path %></p>
+  <p><%=wt 'Title:' %><br /><%= f.text_field :title %></p>
+  <p><%=wt 'Content:' %><br /><%= f.text_area :content %></p>
+  <p><%=wt 'Comment:' %><br /><%= f.text_field :comment %></p>
+  
+  <input type="submit" value="<%=wt 'Save page' %>" class="submit" />
+<% end %>

data/app/views/base_wiki_pages/history.html.erb

@@ -0,0 +1,7 @@
+<%= wiki_page_style %>
+
+<h1><%=wt '{{page_title}} - History', :page_title => @page.title %></h1>
+  
+<%= wiki_page_info %>
+<%= wiki_page_actions %>
+<%= wiki_page_history %>

data/app/views/base_wiki_pages/no.html.erb

@@ -0,0 +1 @@
+<%=wt 'There are no such page. Do you want to <a href="{{edit_url}}">create it</a>?', :edit_url => wiki_page_edit_path %>  

data/app/views/base_wiki_pages/not_allowed.html.erb

@@ -0,0 +1 @@
+<%=wt 'You are not allowed to be here, please go out.' %>  

data/app/views/base_wiki_pages/show.html.erb

@@ -0,0 +1,10 @@
+<%= wiki_page_style %>
+
+<h1><%=h @page.title %></h1>
+  
+<%= wiki_page_info %>
+<%= wiki_page_actions %>
+  
+<div class="wiki_content">
+  <%=wiki_content @page.content %>
+</div>

data/generators/irwi_wiki/irwi_wiki_generator.rb

@@ -0,0 +1,22 @@
+class IrwiWikiGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+              
+      # Controllers
+      m.file 'controllers/wiki_pages_controller.rb', 'app/controllers/wiki_pages_controller.rb'
+        
+      # Helpers
+      m.file 'helpers/wiki_pages_helper.rb', 'app/helpers/wiki_pages_helper.rb'
+      
+      # Models
+      m.file 'models/wiki_page.rb',         'app/models/wiki_page.rb'
+      m.file 'models/wiki_page_version.rb', 'app/models/wiki_page_version.rb'
+        
+      # Migrations
+      m.migration_template 'migrate/create_wiki_pages.rb', 'db/migrate', :migration_file_name => "create_wiki_pages"
+
+      # Routes
+      m.gsub_file 'config/routes.rb', /#{Regexp.quote 'ActionController::Routing::Routes.draw do |map|'}\n/, "\\0\n  map.wiki_root '/wiki'\n"
+    end
+  end
+end

data/generators/irwi_wiki/templates/controllers/wiki_pages_controller.rb

@@ -0,0 +1,5 @@
+class WikiPagesController < ApplicationController
+  
+  acts_as_wiki_pages_controller
+  
+end

data/generators/irwi_wiki/templates/helpers/wiki_pages_helper.rb

@@ -0,0 +1,3 @@
+module WikiPagesHelper
+  include Irwi::Helpers::WikiPagesHelper
+end

data/generators/irwi_wiki/templates/migrate/create_wiki_pages.rb

@@ -0,0 +1,44 @@
+class CreateWikiPages < ActiveRecord::Migration
+
+  def self.up
+    create_table :wiki_pages do |t|
+      t.integer :creator_id
+      t.integer :updator_id
+      
+      t.string :path
+      t.string :title
+      
+      t.text :content
+          
+      t.timestamps
+    end
+    
+    add_index :wiki_pages, :creator_id
+    add_index :wiki_pages, :path, :unique => true
+    
+    create_table :wiki_page_versions do |t|
+      t.integer :page_id, :null => false # Reference to page      
+      t.integer :updator_id # Reference to user, updated page
+      
+      t.integer :number # Version number
+      
+      t.string :comment
+      
+      t.string :path
+      t.string :title
+      
+      t.text :content
+          
+      t.timestamp :updated_at
+    end
+    
+    add_index :wiki_page_versions, :page_id
+    add_index :wiki_page_versions, :updator_id
+  end
+  
+  def self.down
+    drop_table :wiki_page_versions
+    drop_table :wiki_pages
+  end
+  
+end

data/generators/irwi_wiki/templates/models/wiki_page.rb

@@ -0,0 +1,5 @@
+class WikiPage < ActiveRecord::Base
+  
+  acts_as_wiki_page
+  
+end

data/generators/irwi_wiki/templates/models/wiki_page_version.rb

@@ -0,0 +1,5 @@
+class WikiPageVersion < ActiveRecord::Base
+  
+  acts_as_wiki_page_version
+  
+end

data/irwi.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{irwi}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexey Noskov"]
+  s.date = %q{2009-10-25}
+  s.description = %q{Irwi is Ruby on Rails plugin which adds wiki functionality to your application. }
+  s.email = %q{alexey.noskov@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/views/base_wiki_pages/_wiki_page_actions.html.erb",
+     "app/views/base_wiki_pages/_wiki_page_history.html.erb",
+     "app/views/base_wiki_pages/_wiki_page_info.html.erb",
+     "app/views/base_wiki_pages/_wiki_page_style.html.erb",
+     "app/views/base_wiki_pages/compare.html.erb",
+     "app/views/base_wiki_pages/edit.html.erb",
+     "app/views/base_wiki_pages/history.html.erb",
+     "app/views/base_wiki_pages/no.html.erb",
+     "app/views/base_wiki_pages/not_allowed.html.erb",
+     "app/views/base_wiki_pages/show.html.erb",
+     "generators/irwi_wiki/irwi_wiki_generator.rb",
+     "generators/irwi_wiki/templates/controllers/wiki_pages_controller.rb",
+     "generators/irwi_wiki/templates/helpers/wiki_pages_helper.rb",
+     "generators/irwi_wiki/templates/migrate/create_wiki_pages.rb",
+     "generators/irwi_wiki/templates/models/wiki_page.rb",
+     "generators/irwi_wiki/templates/models/wiki_page_version.rb",
+     "irwi.gemspec",
+     "lib/irwi.rb",
+     "lib/irwi/comparators/base.rb",
+     "lib/irwi/comparators/diff_lcs.rb",
+     "lib/irwi/comparators/spans/changed_span.rb",
+     "lib/irwi/comparators/spans/not_changed_span.rb",
+     "lib/irwi/config.rb",
+     "lib/irwi/extensions/controllers/wiki_pages.rb",
+     "lib/irwi/extensions/models/wiki_page.rb",
+     "lib/irwi/extensions/models/wiki_page_version.rb",
+     "lib/irwi/formatters/blue_cloth.rb",
+     "lib/irwi/formatters/red_cloth.rb",
+     "lib/irwi/helpers/wiki_pages_helper.rb",
+     "lib/irwi/support/route_mapper.rb",
+     "lib/irwi/support/template_finder.rb",
+     "rails/init.rb",
+     "spec/comparators/diff_lcs_spec.rb",
+     "spec/config_spec.rb",
+     "spec/extensions/controllers/wiki_pages_spec.rb",
+     "spec/helpers/wiki_pages_helper_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/route_mapper_spec.rb",
+     "spec/support/template_finder_spec.rb",
+     "tasks/riwiki_tasks.rake"
+  ]
+  s.homepage = %q{http://github.com/alno/irwi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Irwi is Ruby on Rails plugin which adds wiki functionality to your application.}
+  s.test_files = [
+    "spec/comparators/diff_lcs_spec.rb",
+     "spec/support/template_finder_spec.rb",
+     "spec/support/route_mapper_spec.rb",
+     "spec/config_spec.rb",
+     "spec/extensions/controllers/wiki_pages_spec.rb",
+     "spec/helpers/wiki_pages_helper_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<diff-lcs>, [">= 1.1.2"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+