irwi 0.2.2 → 0.2.3

data/README.rdoc

@@ -70,6 +70,14 @@ If you want (and it's good idea) to specify which users can see or edit certain
 * <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).
 
+== Attachments
+
+Irwi allows easy attachment integration in your wiki. There area several simple steps to add attachments to wiki pages:
+* Call <tt>irwi_wiki_attachments</tt> generator. It will create WikiPageAttachment class.
+* Include <tt>config.gem "paperclip"</tt> in your <tt>environment.rb</tt> or, if you prefer another library modify generated code for it.
+* Append to initializer (or create a new one) something like <tt>Irwi.config.page_attachment_class_name = 'WikiPageAttachment'</tt>.
+* Run <tt>rake db:migrate</tt> and start using attachments in your wiki!
+
 == Localization
 
 == Rails prior to 2.3
@@ -80,4 +88,12 @@ If you have Rails prior to 2.3 when you should also call:
   
 To generate default wiki views.
 
+== Contributors
+
+* Alexey Noskov (http://github.com/alno)
+* Ravi Bhim (http://github.com/ravibhim)
+* http://github.com/valodzka
+
+Feel free to add yourself when you add new features.
+
 Copyright (c) 2009 Alexey Noskov, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

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

@@ -2,6 +2,12 @@
 
 <h1><%=wt 'Editing wiki page' %></h1>
 
+<% if params[:preview] %>
+<div class="wiki_content">
+  <%=wiki_content @page.content %>
+</div>
+<% end %>
+
 <% wiki_page_form do |f| %>
   <%= f.hidden_field :previous_version_number, :value => f.object.last_version_number %>
   
@@ -9,18 +15,10 @@
   <p><%=wt 'Content:' %><br /><%= f.text_area :content %></p>
   <p><%=wt 'Comment on this change (optional):' %><br /><%= f.text_field :comment %></p>
   
-  <input type="submit" value="<%=wt 'Save page' %>" class="submit" />
+  <input type="submit" name="save" value="<%=wt 'Save page' %>" class="submit" />
+  <input type="submit" name="preview" value="<%=wt 'Preview' %>" class="submit" />
+  <input type="submit" name="cancel" value="<%=wt 'Cancel' %>" class="submit" />
 <% end %>
 
+<% wiki_page_attachments(@page) %>
 
-<%- @page.attachments.each do |attachment| %>
-  <%= image_tag attachment.wiki_page_attachment.url(:thumb) %>
-  <%= "Attachment_#{attachment.id}" %>
-  <%= link_to wt('Remove'), wiki_remove_page_attachment_path(attachment.id), :method => :delete %>
-<% end %>
-
-<% form_for :wiki_page_attachment, Irwi.config.page_attachment_class.new, :url => wiki_add_page_attachment_path(@page), :html => { :multipart => true } do |form| %>
-  <%= form.file_field :wiki_page_attachment %>
-  <%= form.hidden_field :page_id, :value => @page.id %>
-  <%= form.submit 'Add Attachment' %>
-<% end %>

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

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

data/generators/{irwi_wiki_updates/irwi_wiki_updates_generator.rb → irwi_wiki_attachments/irwi_wiki_attachments_generator.rb}

@@ -1,4 +1,4 @@
-class IrwiWikiUpdatesGenerator < Rails::Generator::Base
+class IrwiWikiAttachmentsGenerator < Rails::Generator::Base
   
   def manifest
     record do |m|

data/irwi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{irwi}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexey Noskov", "Ravi Bhim"]
-  s.date = %q{2010-06-14}
+  s.date = %q{2010-06-24}
   s.description = %q{Irwi is Ruby on Rails plugin which adds wiki functionality to your application. }
   s.email = %q{alexey.noskov@gmail.com ravi.bhim@yahoo.com}
   s.extra_rdoc_files = [
@@ -40,10 +40,9 @@ Gem::Specification.new do |s|
      "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",
-     "generators/irwi_wiki_updates/irwi_wiki_updates_generator.rb",
-     "generators/irwi_wiki_updates/templates/migrate/create_wiki_page_attachments.rb",
-     "generators/irwi_wiki_updates/templates/migrate/touched_file.txt",
-     "generators/irwi_wiki_updates/templates/models/wiki_page_attachment.rb",
+     "generators/irwi_wiki_attachments/irwi_wiki_attachments_generator.rb",
+     "generators/irwi_wiki_attachments/templates/migrate/create_wiki_page_attachments.rb",
+     "generators/irwi_wiki_attachments/templates/models/wiki_page_attachment.rb",
      "generators/irwi_wiki_views/irwi_wiki_views_generator.rb",
      "irwi.gemspec",
      "lib/irwi.rb",
@@ -69,6 +68,7 @@ Gem::Specification.new do |s|
      "spec/comparators/diff_lcs_spec.rb",
      "spec/config_spec.rb",
      "spec/extensions/controllers/wiki_pages_spec.rb",
+     "spec/extensions/models/wiki_page_spec.rb",
      "spec/formatters/red_cloth_spec.rb",
      "spec/helpers/wiki_page_attachments_helper_spec.rb",
      "spec/helpers/wiki_pages_helper_spec.rb",
@@ -92,6 +92,7 @@ Gem::Specification.new do |s|
      "spec/spec_helper.rb",
      "spec/comparators/diff_lcs_spec.rb",
      "spec/extensions/controllers/wiki_pages_spec.rb",
+     "spec/extensions/models/wiki_page_spec.rb",
      "spec/config_spec.rb",
      "spec/paginators/will_paginate_spec.rb",
      "spec/paginators/none_spec.rb",

data/lib/irwi/config.rb

@@ -6,7 +6,10 @@ class Irwi::Config
   
   attr_accessor_with_default :page_class_name, 'WikiPage'
   attr_accessor_with_default :page_version_class_name, 'WikiPageVersion'
-  attr_accessor_with_default :page_attachment_class_name, 'WikiPageAttachment'  
+  attr_accessor_with_default :page_attachment_class_name do
+    # Can be for example 'WikiPageAttachment'  
+    nil
+  end
   
   attr_accessor_with_default :page_version_foreign_key, 'page_id'
   
@@ -42,7 +45,7 @@ class Irwi::Config
   def page_attachment_class
     page_attachment_class_name.constantize
   end
-  
+
   def user_class
     user_class_name.constantize
   end
@@ -60,4 +63,4 @@ class Irwi::Config
     system_pages[ action.to_s ] = path.to_s
   end
   
-end
+end

data/lib/irwi/extensions/controllers/wiki_pages.rb

@@ -76,7 +76,7 @@ module Irwi::Extensions::Controllers::WikiPages
       @page.updator = @current_user # Assing user, which updated page
       @page.creator = @current_user if @page.new_record? # Assign it's creator if it's new page
            
-      if @page.save
+      if !params[:preview] && (params[:cancel] || @page.save)
         redirect_to url_for( :action => :show, :path => @page.path.split('/') ) # redirect to new page's path (if it changed)
       else
         render_template 'edit'
@@ -156,4 +156,4 @@ module Irwi::Extensions::Controllers::WikiPages
     base.helper_method :show_allowed?, :edit_allowed?, :history_allowed?, :destroy_allowed? # Access control methods are avaliable in views
   end
   
-end
+end

data/lib/irwi/extensions/models/wiki_page.rb

@@ -40,7 +40,10 @@ module Irwi::Extensions::Models::WikiPage
     base.belongs_to :updator, :class_name => Irwi.config.user_class_name
     
     base.has_many :versions, :class_name => Irwi.config.page_version_class_name, :foreign_key => Irwi.config.page_version_foreign_key, :order => 'id DESC'
-    base.has_many :attachments, :class_name => Irwi.config.page_attachment_class_name, :foreign_key => Irwi.config.page_version_foreign_key
+
+    if Irwi::config.page_attachment_class_name
+      base.has_many :attachments, :class_name => Irwi.config.page_attachment_class_name, :foreign_key => Irwi.config.page_version_foreign_key
+    end
     
     base.after_save :create_new_version
   end

data/lib/irwi/helpers/wiki_pages_helper.rb

@@ -49,8 +49,14 @@ module Irwi::Helpers::WikiPagesHelper
   end
   
   def wiki_linkify( str )
-    str.gsub /\[\[([^\[\]]+)\]\]/ do |m|
-      "<a href=\"#{wiki_link $1}\">#{$1}</a>"
+    str.gsub /\[\[
+                (?:([^\[\]\|]+)\|)?
+                ([^\[\]]+)
+               \]\]
+               (\w+)?/xu do |m|
+      text = "#$2#$3"
+      link = $1 || $2
+      "<a href=\"#{wiki_link link}\">#{text}</a>"
     end
   end
   
@@ -108,5 +114,24 @@ module Irwi::Helpers::WikiPagesHelper
     
     render :partial => "#{template_dir '_wiki_page_history'}/wiki_page_history", :locals => { :page => page, :versions => versions, :with_form => (versions.size > 1) }
   end
+
+  def wiki_page_attachments(page)
+    return unless Irwi::config.page_attachment_class_name
+
+    page.attachments.each do |attachment| 
+      concat image_tag(attachment.wiki_page_attachment.url(:thumb))
+      concat "Attachment_#{attachment.id}" 
+      concat link_to(wt('Remove'), wiki_remove_page_attachment_path(attachment.id), :method => :delete)
+    end 
+
+    form_for(:wiki_page_attachment, 
+             Irwi.config.page_attachment_class.new, 
+             :url => wiki_add_page_attachment_path(@page), 
+             :html => { :multipart => true }) do |form|
+      concat form.file_field :wiki_page_attachment 
+      concat form.hidden_field :page_id, :value => @page.id 
+      concat form.submit 'Add Attachment'
+    end
+  end
     
 end

data/rails/init.rb

@@ -29,6 +29,16 @@ ActionController::Base.instance_eval do
   #
   def acts_as_wiki_pages_controller( config = {} )
     include Irwi::Extensions::Controllers::WikiPages
+    include Irwi::Extensions::Controllers::WikiPageAttachments if Irwi::config.page_attachment_class_name
+  end
+  
+end
+
+Module.class_eval do
+  
+  def acts_as_wiki_pages_helper( config = {} )
+    include Irwi::Helpers::WikiPagesHelper
+    include Irwi::Helpers::WikiPageAttachmentsHelper if Irwi::config.page_attachment_class_name
   end
   
 end

data/spec/extensions/models/wiki_page_spec.rb

@@ -0,0 +1,79 @@
+require "spec/spec_helper"
+
+require "active_record"
+
+describe Irwi::Extensions::Models::WikiPage do  
+  
+  class AbstractPage < ActiveRecord::Base
+    
+        
+    def self.columns
+      c = ActiveRecord::ConnectionAdapters::Column
+      
+      [
+        c.new("title", nil, "string", false), 
+        c.new("path", nil, "string", false), 
+        c.new("content", nil, "text", false)
+      ]
+    end
+    
+  end
+  
+  it { should_not be_nil }
+    
+  before :all do
+    Irwi::config.page_attachment_class_name = nil
+    
+    @cls = Class.new AbstractPage do      
+      include Irwi::Extensions::Models::WikiPage
+    end
+  end
+  
+  context "class" do    
+    
+    it { @cls.should respond_to(:find) }        
+    it { @cls.should respond_to(:find_by_path_or_new) }
+    
+  end
+  
+  context "instance" do
+    
+    before :each do      
+      @obj = @cls.new
+    end
+    
+    it { @obj.should respond_to(:save) }
+    it { @obj.should respond_to(:destroy) }
+    
+    it { @obj.should respond_to(:comment) }
+    it { @obj.should respond_to(:previous_version_number) }
+    
+    it { @obj.should respond_to(:versions) }
+    
+    it { @obj.should_not respond_to(:attachments) }    
+                
+  end
+  
+  context "with attachments" do
+    
+    before :all do
+      Irwi::config.page_attachment_class_name = 'WikiPageAttachment'
+      
+      @cls = Class.new AbstractPage do      
+        include Irwi::Extensions::Models::WikiPage
+      end
+    end
+    
+    context "instance" do
+    
+      before :each do      
+        @obj = @cls.new
+      end
+            
+      it { @obj.should respond_to(:attachments) }    
+                  
+    end
+      
+  end
+  
+end

data/spec/helpers/wiki_page_attachments_helper_spec.rb

@@ -7,6 +7,7 @@ describe Irwi::Helpers::WikiPageAttachmentsHelper do
   context "included in class" do
     
     before(:each) do
+      Irwi.config.page_attachment_class_name = 'WikiPageAttachment'
       @m = Object.new
       @m.send :extend, Irwi::Helpers::WikiPagesHelper
     end
@@ -14,10 +15,6 @@ describe Irwi::Helpers::WikiPageAttachmentsHelper do
     describe :wiki_show_attachment do
       before do
         class WikiPageAttachment; end
-        module ActiveRecord
-          class RecordNotFound < StandardError
-          end
-        end
       end
 
       it 'replaces Attachment_1_thumb with its corresponding image tag' do

data/spec/helpers/wiki_pages_helper_spec.rb

@@ -110,10 +110,11 @@ describe Irwi::Helpers::WikiPagesHelper do
     end
     
     specify "should linkify string" do
-      
-      @m.should_receive(:wiki_link).with('Some other page').and_return('url')
+      @m.should_receive(:wiki_link).exactly(3).times.with('Some other page').and_return('url')
       
       @m.wiki_linkify( '[[Some other page]] - link' ).should == '<a href="url">Some other page</a> - link'
+      @m.wiki_linkify( '[[Some other page|Go other page]] - link' ).should == '<a href="url">Go other page</a> - link'
+      @m.wiki_linkify( '[[Some other page]]s are there' ).should == '<a href="url">Some other pages</a> are there'
     end
     
     specify "should generate link for non-existent page" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Alexey Noskov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-14 00:00:00 +04:00
+date: 2010-06-24 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,10 +79,9 @@ files:
 - 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
-- generators/irwi_wiki_updates/irwi_wiki_updates_generator.rb
-- generators/irwi_wiki_updates/templates/migrate/create_wiki_page_attachments.rb
-- generators/irwi_wiki_updates/templates/migrate/touched_file.txt
-- generators/irwi_wiki_updates/templates/models/wiki_page_attachment.rb
+- generators/irwi_wiki_attachments/irwi_wiki_attachments_generator.rb
+- generators/irwi_wiki_attachments/templates/migrate/create_wiki_page_attachments.rb
+- generators/irwi_wiki_attachments/templates/models/wiki_page_attachment.rb
 - generators/irwi_wiki_views/irwi_wiki_views_generator.rb
 - irwi.gemspec
 - lib/irwi.rb
@@ -108,6 +107,7 @@ files:
 - spec/comparators/diff_lcs_spec.rb
 - spec/config_spec.rb
 - spec/extensions/controllers/wiki_pages_spec.rb
+- spec/extensions/models/wiki_page_spec.rb
 - spec/formatters/red_cloth_spec.rb
 - spec/helpers/wiki_page_attachments_helper_spec.rb
 - spec/helpers/wiki_pages_helper_spec.rb
@@ -155,6 +155,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/comparators/diff_lcs_spec.rb
 - spec/extensions/controllers/wiki_pages_spec.rb
+- spec/extensions/models/wiki_page_spec.rb
 - spec/config_spec.rb
 - spec/paginators/will_paginate_spec.rb
 - spec/paginators/none_spec.rb