irwi 0.2.4 → 0.4.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 [name of plugin creator]
+Copyright (c) 2009 Alexey Noskov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -8,13 +8,13 @@ Setup gemcutter as gem source:
 
   sudo gem install gemcutter
   gem tumble
-  
+
 And install irwi gem (recommended):
 
   sudo gem install irwi
-  
+
 And add to your environment.rb:
- 
+
   config.gem "irwi", :source => "http://gemcutter.org"
 
 Or in your application directory call:
@@ -58,15 +58,15 @@ Following helpers are defined by default and you may replace them with you own:
 Configuration options are acessed via <tt>Irwi.config</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). Option accepts formatter instance, not class, so correct usage is:
-  
+
   Irwi.config.formatter = Irwi::Formatters::BlueCloth.new
-  
+
 * <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>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).
 
@@ -83,14 +83,14 @@ Irwi allows easy attachment integration in your wiki. There area several simple
 == Rails prior to 2.3
 
 If you have Rails prior to 2.3 when you should also call:
-  
+
   script/generate irwi_wiki_views
-  
+
 To generate default wiki views.
 
 == I18n Issues
 
-If you get some weird errors like 
+If you get some weird errors like
 
   missing interpolation argument in "%{count} %B %Y, %H:%M"
 

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

@@ -1,3 +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 ) %>
+  <%=(wt "Revised on %{time} by %{user}", :time => l( page.updated_at, :format => :long ), :user => wiki_user( page.updator ) ).html_safe %>
 </div>

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

@@ -1,6 +1,6 @@
 <%= 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>
+<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:' %>
 

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

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

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

@@ -1 +1 @@
-<%=wt 'There are no such page. Do you want to <a href="{{new_url}}">create it</a>?', :new_url => wiki_page_new_path %>  
+<%=(wt 'There are no such page. Do you want to <a href="%{new_url}">create it</a>?', :new_url => wiki_page_new_path ).html_safe %>  

data/lib/generators/irwi_wiki/irwi_wiki_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record/migration'
+
+class IrwiWikiGenerator < Rails::Generators::Base
+
+  include Rails::Generators::Migration
+  extend ActiveRecord::Generators::Migration
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  def generate_wiki
+
+    # Controllers
+    copy_file 'controllers/wiki_pages_controller.rb', 'app/controllers/wiki_pages_controller.rb'
+
+    # Helpers
+    copy_file 'helpers/wiki_pages_helper.rb', 'app/helpers/wiki_pages_helper.rb'
+
+    # Models
+    copy_file 'models/wiki_page.rb',         'app/models/wiki_page.rb'
+    copy_file 'models/wiki_page_version.rb', 'app/models/wiki_page_version.rb'
+
+    # Migrations
+    migration_template 'migrate/create_wiki_pages.rb', 'db/migrate/create_wiki_pages'
+
+    # Routes
+    route "wiki_root '/wiki'"
+  end
+
+end

data/{generators → lib/generators}/irwi_wiki/templates/controllers/wiki_pages_controller.rb

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

data/{generators → lib/generators}/irwi_wiki/templates/helpers/wiki_pages_helper.rb

@@ -1,3 +1,3 @@
 module WikiPagesHelper
   acts_as_wiki_pages_helper
-end
+end

data/{generators → lib/generators}/irwi_wiki/templates/migrate/create_wiki_pages.rb

@@ -4,41 +4,41 @@ class CreateWikiPages < ActiveRecord::Migration
     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 :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
+
+end

data/{generators → lib/generators}/irwi_wiki/templates/models/wiki_page.rb

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

data/{generators → lib/generators}/irwi_wiki/templates/models/wiki_page_version.rb

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

data/lib/generators/irwi_wiki_attachments/irwi_wiki_attachments_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/active_record/migration'
+
+class IrwiWikiAttachmentsGenerator < Rails::Generators::Base
+
+  include Rails::Generators::Migration
+  extend ActiveRecord::Generators::Migration
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  def generate_attachments
+    %w[create_wiki_page_attachments].each do |mig|
+      unless Dir.entries(File.join(Rails.root,'db','migrate')).grep(/#{mig}/).present?
+        migration_template "migrate/#{mig}.rb", "db/migrate/#{mig}"
+        sleep(1) # To avoid migration file version collision.
+      end
+    end
+
+    # Models
+    copy_file 'models/wiki_page_attachment.rb', 'app/models/wiki_page_attachment.rb'
+  end
+
+end

data/{generators → lib/generators}/irwi_wiki_attachments/templates/migrate/create_wiki_page_attachments.rb

@@ -2,18 +2,18 @@ class CreateWikiPageAttachments < ActiveRecord::Migration
 
   def self.up
     create_table :wiki_page_attachments do |t|
-      t.integer :page_id, :null => false # Reference to page      
+      t.integer :page_id, :null => false # Reference to page
       t.string   :wiki_page_attachment_file_name
       t.string   :wiki_page_attachment_content_type
       t.integer  :wiki_page_attachment_file_size
-          
+
       t.timestamps
     end
-    
+
   end
-  
+
   def self.down
     drop_table :wiki_page_attachments
   end
-  
-end
+
+end

data/{generators → lib/generators}/irwi_wiki_attachments/templates/models/wiki_page_attachment.rb

@@ -6,4 +6,4 @@ class WikiPageAttachment < ActiveRecord::Base
     validates_attachment_presence :wiki_page_attachment, :message => " is missing."
     validates_attachment_content_type :wiki_page_attachment, :content_type => ['image/jpeg','image/jpg','image/png','image/x-png','image/gif','image/pjpeg'], :message => ' must be a JPEG, PNG or GIF.'
   end
-end
+end

data/lib/generators/irwi_wiki_views/irwi_wiki_views_generator.rb

@@ -0,0 +1,13 @@
+class IrwiWikiViewsGenerator < Rails::Generators::Base
+
+  source_root File.expand_path("../../../../app/views/base_wiki_pages", __FILE__)
+
+  def views
+    empty_directory 'app/views/base_wiki_pages'
+
+    Dir.foreach source_root do |file| # Searching for files in app/views
+      copy_file( file, 'app/views/base_wiki_pages/' + file ) if file != '.' && file != '..'
+    end
+  end
+
+end

data/lib/irwi.rb

@@ -1,16 +1,43 @@
+require 'active_support/dependencies'
+
 module Irwi
 
-  module Formatters; end
-  module Comparators; end
+  module Formatters
+    autoload :BlueCloth, 'irwi/formatters/blue_cloth'
+    autoload :RedCloth, 'irwi/formatters/red_cloth'
+  end
+
+  module Comparators
+    autoload :DiffLcs, 'irwi/comparators/diff_lcs'
+    autoload :Base, 'irwi/comparators/base'
+    module Spans
+      autoload :ChangedSpan, 'irwi/comparators/spans/changed_span'
+      autoload :NotChangedSpan, 'irwi/comparators/spans/not_changed_span'
+    end
+  end
+
   module Extensions; end
-  module Helpers; end
-  module Paginators; end
-  module Support; end
-  
+
+  module Paginators
+    autoload :None, 'irwi/paginators/none'
+    autoload :WillPaginate, 'irwi/paginators/will_paginate'
+  end
+
+  module Support
+    autoload :TemplateFinder, 'irwi/support/template_finder'
+  end
+
   def self.config
     require 'irwi/config'
 
     @@config ||= Irwi::Config.new
   end
-  
+
 end
+
+require 'irwi/extensions/controllers'
+require 'irwi/extensions/models'
+require 'irwi/support/route_mapper' # Routes
+require 'irwi/helpers'
+
+ActionController::Base.append_view_path File.expand_path('../../app/views', __FILE__) # Append default views

data/lib/irwi/comparators/base.rb

@@ -2,19 +2,19 @@ require 'irwi/comparators/spans/changed_span'
 require 'irwi/comparators/spans/not_changed_span'
 
 class Irwi::Comparators::Base
-    
+
   def render_changes( old_text, new_text )
     build_changes( old_text, new_text ).join('').gsub( /\r?\n/, '<br />' )
   end
-  
+
   protected
-  
+
   def new_not_changed( value )
     Irwi::Comparators::Spans::NotChangedSpan.new( value )
   end
-  
+
   def new_changed( action, old_value, new_value )
     Irwi::Comparators::Spans::ChangedSpan.new( action, old_value, new_value )
   end
-    
-end
+
+end

data/lib/irwi/comparators/diff_lcs.rb

@@ -1,17 +1,17 @@
 require 'irwi/comparators/base'
 
 class Irwi::Comparators::DiffLcs < Irwi::Comparators::Base
-  
+
   def initialize
     super
-    
+
     require 'diff/lcs'
   end
-  
+
   def build_changes( old_text, new_text )
-    diffs = Diff::LCS.sdiff( (old_text || '').mb_chars, (new_text || '').mb_chars ) # Building symmetric diff sequence    
-    changes = [] # Array for our result changes 
-    
+    diffs = Diff::LCS.sdiff( (old_text || '').mb_chars, (new_text || '').mb_chars ) # Building symmetric diff sequence
+    changes = [] # Array for our result changes
+
     diffs.each do |change|
       case change.action
         when '=' then
@@ -20,7 +20,7 @@ class Irwi::Comparators::DiffLcs < Irwi::Comparators::Base
           else
             changes << new_not_changed( change.old_element )
           end
-          
+
         when '+' then
           if !changes.empty? && changes.last.action == '+' # Append to last addition, if exists
             changes.last.new_value << change.new_element
@@ -29,14 +29,14 @@ class Irwi::Comparators::DiffLcs < Irwi::Comparators::Base
           else
             changes << new_changed( '+', nil, change.new_element )
           end
-          
+
         when '-' then
           if !changes.empty? && changes.last.action == '-' # Append to last deletion, if exists
             changes.last.old_value << change.old_element
           else
             changes << new_changed( '-', change.old_element, nil )
           end
-          
+
         when '!' then
           if !changes.empty? && changes.last.action == '!' # Append to last replace, if exists
             changes.last.old_value << change.old_element
@@ -44,11 +44,11 @@ class Irwi::Comparators::DiffLcs < Irwi::Comparators::Base
           else
             changes << new_changed( '!', change.old_element, change.new_element )
           end
-        
+
       end
     end
 
     changes
   end
-    
-end
+
+end

data/lib/irwi/comparators/spans/changed_span.rb

@@ -1,18 +1,18 @@
 class Irwi::Comparators::Spans::ChangedSpan
-    
-  attr_accessor :action, :old_value, :new_value 
-    
+
+  attr_accessor :action, :old_value, :new_value
+
   def initialize( act, ov, nv )
     @action = act
     @old_value = ov
     @new_value = nv
   end
-    
+
   def to_s
     s = ''
     s << "<span class=\"removed\">#{@old_value}</span>" if @old_value
     s << "<span class=\"added\">#{@new_value}</span>" if @new_value
     s
   end
-    
-end
+
+end