irwi_mod 0.0.1

data/lib/irwi_mod.rb

@@ -0,0 +1,46 @@
+require 'active_support/dependencies'
+require 'rails_autolink' if defined?(Rails)
+
+module IrwiMod
+
+  module Formatters
+    autoload :BlueCloth, 'irwi_mod/formatters/blue_cloth'
+    autoload :RedCloth, 'irwi_mod/formatters/red_cloth'
+    autoload :SimpleHtml, 'irwi_mod/formatters/simple_html'
+    autoload :WikiCloth, 'irwi_mod/formatters/wiki_cloth'
+  end
+
+  module Comparators
+    autoload :DiffLcs, 'irwi_mod/comparators/diff_lcs'
+    autoload :Base, 'irwi_mod/comparators/base'
+    module Spans
+      autoload :ChangedSpan, 'irwi_mod/comparators/spans/changed_span'
+      autoload :NotChangedSpan, 'irwi_mod/comparators/spans/not_changed_span'
+    end
+  end
+
+  module Extensions; end
+
+  module Paginators
+    autoload :None, 'irwi_mod/paginators/none'
+    autoload :WillPaginate, 'irwi_mod/paginators/will_paginate'
+  end
+
+  module Support
+    autoload :TemplateFinder, 'irwi_mod/support/template_finder'
+  end
+
+  def self.config
+    require 'irwi_mod/config'
+
+    @@config ||= IrwiMod::Config.new
+  end
+
+end
+
+require 'irwi_mod/extensions/controllers'
+require 'irwi_mod/extensions/models'
+require 'irwi_mod/support/route_mapper' # Routes
+require 'irwi_mod/helpers'
+
+ActionController::Base.append_view_path File.expand_path('../../app/views', __FILE__) # Append default views

data/lib/irwi_mod/comparators/base.rb

@@ -0,0 +1,20 @@
+require 'irwi_mod/comparators/spans/changed_span'
+require 'irwi_mod/comparators/spans/not_changed_span'
+
+class IrwiMod::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 )
+    IrwiMod::Comparators::Spans::NotChangedSpan.new( value )
+  end
+
+  def new_changed( action, old_value, new_value )
+    IrwiMod::Comparators::Spans::ChangedSpan.new( action, old_value, new_value )
+  end
+
+end

data/lib/irwi_mod/comparators/diff_lcs.rb

@@ -0,0 +1,54 @@
+require 'irwi_mod/comparators/base'
+
+class IrwiMod::Comparators::DiffLcs < IrwiMod::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.each do |change|
+      case change.action
+        when '=' then
+          if !changes.empty? && changes.last.action == '=' # Append to last not changed span, if exists
+            changes.last.value << change.old_element
+          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
+          elsif !changes.empty? && changes.last.action == '!' # Append to last replace, if exists (it's necessary when replacing short string with a new long)
+            changes.last.new_value << change.new_element
+          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
+            changes.last.new_value << change.new_element
+          else
+            changes << new_changed( '!', change.old_element, change.new_element )
+          end
+
+      end
+    end
+
+    changes
+  end
+
+end

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

@@ -0,0 +1,18 @@
+class IrwiMod::Comparators::Spans::ChangedSpan
+
+  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

data/lib/irwi_mod/comparators/spans/not_changed_span.rb

@@ -0,0 +1,20 @@
+class IrwiMod::Comparators::Spans::NotChangedSpan
+
+  attr_accessor :value
+
+  def initialize( v )
+    @value = v
+  end
+
+  def to_s
+    @value.to_s
+  end
+
+  def action
+    '='
+  end
+
+  alias_method :old_value, :value
+  alias_method :new_value, :value
+
+end

data/lib/irwi_mod/config.rb

@@ -0,0 +1,83 @@
+require 'active_support'
+
+class IrwiMod::Config
+
+  attr_accessor :controller_name
+  attr_accessor :user_class_name
+  attr_accessor :page_class_name
+  attr_accessor :page_version_class_name
+  attr_accessor :page_attachment_class_name
+  attr_accessor :page_version_foreign_key
+
+  # Object using to format content
+  attr_writer :formatter
+
+  def formatter
+    @formatter ||= begin
+                     require 'irwi_mod/formatters/red_cloth'
+                     
+                     self.formatter = IrwiMod::Formatters::RedCloth.new
+                   end	
+  end
+
+  # Object using to compare pages
+  attr_writer :comparator
+  
+  def comparator
+    @comparator ||= begin
+                      require 'irwi_mod/comparators/diff_lcs'
+                      
+                      self.comparator = IrwiMod::Comparators::DiffLcs.new
+                    end	
+  end
+
+  # Object using to paginate collections
+  attr_writer :paginator
+    
+  def paginator
+    @paginator ||= begin
+                     require 'irwi_mod/paginators/none'
+                     
+                     self.paginator = IrwiMod::Paginators::None.new
+                   end	
+  end
+
+  def initialize
+    @controller_name = 'wiki_pages'
+    @user_class_name = 'User'
+    @page_class_name = 'WikiPage'
+    @page_version_class_name = 'WikiPageVersion'
+    @page_attachment_class_name = nil
+    @page_version_foreign_key = 'page_id'
+  end   
+
+  def page_class
+    page_class_name.constantize
+  end
+
+  def page_version_class
+    page_version_class_name.constantize
+  end
+
+  def page_attachment_class
+    page_attachment_class_name.constantize
+  end
+
+  def user_class
+    user_class_name.constantize
+  end
+
+  def system_pages
+    @system_pages ||= {
+      'all' => 'all'
+    }
+  end
+
+  # Add system page
+  # @param action [String,Symbol] controller action
+  # @param path [String] path in routes
+  def add_system_page( action, path )
+    system_pages[ action.to_s ] = path.to_s
+  end
+
+end

data/lib/irwi_mod/extensions/controllers.rb

@@ -0,0 +1,18 @@
+require 'action_controller'
+
+module IrwiMod::Extensions::Controllers
+  autoload :WikiPages, 'irwi_mod/extensions/controllers/wiki_pages'
+  autoload :WikiPageAttachments, 'irwi_mod/extensions/controllers/wiki_page_attachments'
+end
+
+ActionController::Base.instance_eval do
+
+  # @param config [Hash] config for controller class
+  # @option page_class
+  #
+  def acts_as_wiki_pages_controller( config = {} )
+    include IrwiMod::Extensions::Controllers::WikiPages
+    include IrwiMod::Extensions::Controllers::WikiPageAttachments if IrwiMod::config.page_attachment_class_name
+  end
+
+end

data/lib/irwi_mod/extensions/controllers/wiki_page_attachments.rb

@@ -0,0 +1,21 @@
+module IrwiMod::Extensions::Controllers::WikiPageAttachments
+
+  def add_attachment
+    attachment = page_attachment_class.new(params[:wiki_page_attachment])
+    attachment.save!
+    redirect_to url_for(:path => attachment.page.path, :action => :edit)
+  end
+
+  def remove_attachment
+    attachment = page_attachment_class.find(params[:attachment_id])
+    attachment.destroy
+    redirect_to url_for(:path => attachment.page.path, :action => :edit)
+  end
+
+  protected
+
+  def page_attachment_class
+    IrwiMod.config.page_attachment_class
+  end
+
+end

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

@@ -0,0 +1,167 @@
+module IrwiMod::Extensions::Controllers::WikiPages
+
+  module ClassMethods
+
+    def page_class
+      @page_class ||= IrwiMod.config.page_class
+    end
+
+    def set_page_class(arg)
+      @page_class = arg
+    end
+
+  end
+
+  module InstanceMethods
+
+    include IrwiMod::Extensions::Controllers::WikiPageAttachments
+    include IrwiMod::Support::TemplateFinder
+
+    def index
+      return not_allowed unless show_allowed?
+      
+      do_search
+      render_template 'index'
+    end
+    
+    def show
+      return not_allowed unless show_allowed?
+
+      render_template( @page.new_record? ? 'no' : 'show' )
+    end
+
+    def history
+      return not_allowed unless history_allowed?
+
+      @versions = IrwiMod.config.paginator.paginate( @page.versions, :page => params[:page] ) # Paginating them
+
+      render_template( @page.new_record? ? 'no' : 'history' )
+    end
+
+    def compare
+      return not_allowed unless history_allowed?
+
+      if @page.new_record?
+        render_template 'no'
+      else
+        new_num = params[:new].to_i || @page.last_version_number # Last version number
+        old_num = params[:old].to_i || 1 # First version number
+
+        old_num, new_num = new_num, old_num if new_num < old_num # Swapping them if last < first
+
+        versions = @page.versions.between( old_num, new_num ) # Loading all versions between first and last
+
+        @versions = IrwiMod.config.paginator.paginate( versions, :page => params[:page] ) # Paginating them
+
+        @new_version = @versions.first.number == new_num ? @versions.first : versions.first # Loading next version
+        @old_version = @versions.last.number == old_num ? @versions.last : versions.last # Loading previous version
+
+        render_template 'compare'
+      end
+    end
+
+    def new
+      return not_allowed unless show_allowed? && edit_allowed?
+
+      render_template 'new'
+    end
+
+    def edit
+      return not_allowed unless show_allowed? && edit_allowed?
+
+      render_template 'edit'
+    end
+
+    def update
+      return not_allowed unless params[:page] && (@page.new_record? || edit_allowed?) # Check for rights (but not for new record, for it we will use second check only)
+
+      @page.attributes = params[:page] # Assign new attributes
+      @page.comment = params[:page][:comment]
+
+      return not_allowed unless edit_allowed? # Double check: used beacause action may become invalid after attributes update
+      
+      @page.updator = @main_current_user # Assing user, which updated page
+      @page.creator = @main_current_user if @page.new_record? # Assign it's creator if it's new page
+
+      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'
+      end
+    end
+
+    def destroy
+      return not_allowed unless destroy_allowed?
+
+      @page.destroy
+
+      redirect_to url_for( :action => :show )
+    end
+
+    def all
+      do_search
+      render_template 'all'
+    end
+
+    protected
+    def do_search
+      @pages = IrwiMod.config.paginator.paginate( page_class, :page => params[:page] ) # Loading and paginating all pages
+    end
+    # Retrieves wiki_page_class for this controller
+    def page_class
+      self.class.page_class
+    end
+
+    # Renders user-specified or default template
+    def render_template( template )
+      render "#{template_dir template}/#{template}", :status => (case template when 'no' then 404 when 'not_allowed' then 403 else 200 end)
+    end
+
+    # Initialize @main_current_user instance variable
+    def setup_main_current_user
+      @main_current_user = respond_to?( :main_current_user, true ) ? main_current_user : nil # Find user by main_current_user method or return nil
+    end
+
+    # Initialize @page instance variable
+    def setup_page
+      @page = page_class.find_by_path_or_new( params[:path] || '' ) # Find existing page by path or create new
+    end
+
+    # Method, which called when user tries to visit
+    def not_allowed
+      render_template 'not_allowed'
+    end
+
+    # Check is it allowed for current user to see current page. Designed to be redefined by application programmer
+    def show_allowed?
+      true
+    end
+
+    # Check is it allowed for current user see current page history. Designed to be redefined by application programmer
+    def history_allowed?
+      show_allowed?
+    end
+
+    # Check is it allowed for current user edit current page. Designed to be redefined by application programmer
+    def edit_allowed?
+      show_allowed?
+    end
+
+    # Check is it allowed for current user destroy current page. Designed to be redefined by application programmer
+    def destroy_allowed?
+      edit_allowed?
+    end
+
+  end
+
+  def self.included( base )
+    base.send :extend, IrwiMod::Extensions::Controllers::WikiPages::ClassMethods
+    base.send :include, IrwiMod::Extensions::Controllers::WikiPages::InstanceMethods
+
+    base.before_filter :setup_main_current_user # Setup @setup_main_current_user instance variable before each action
+    # Setup @page instance variable before each action
+    base.before_filter :setup_page, :only => [ :show, :history, :compare, :new, :edit, :update, :destroy, :add_attachment ]
+    base.helper_method :show_allowed?, :edit_allowed?, :history_allowed?, :destroy_allowed? # Access control methods are avaliable in views
+  end
+
+end