irwi 0.0.0

data/lib/irwi.rb

@@ -0,0 +1,7 @@
+module Irwi
+  
+  def self.config
+    @@config ||= Irwi::Config.new
+  end
+  
+end

data/lib/irwi/comparators/base.rb

@@ -0,0 +1,17 @@
+class Irwi::Comparators::Base
+    
+  def render_changes( old_text, new_text )
+    build_changes( old_text, new_text ).join('')
+  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

data/lib/irwi/comparators/diff_lcs.rb

@@ -0,0 +1,52 @@
+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 || '', new_text || '' ) # 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/comparators/spans/changed_span.rb

@@ -0,0 +1,18 @@
+class Irwi::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/comparators/spans/not_changed_span.rb

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

data/lib/irwi/config.rb

@@ -0,0 +1,18 @@
+class Irwi::Config
+  
+  attr_accessor_with_default :user_class_name, 'User'
+  
+  attr_accessor_with_default :page_class_name, 'WikiPage'
+  attr_accessor_with_default :page_version_class_name, 'WikiPageVersion'
+  
+  attr_accessor_with_default :page_version_foreign_key, 'page_id'
+  
+  attr_accessor_with_default :formatter do
+    Irwi::Formatters::RedCloth.new
+  end
+  
+  attr_accessor_with_default :comparator do
+    Irwi::Comparators::DiffLcs.new
+  end
+  
+end

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

@@ -0,0 +1,123 @@
+module Irwi::Extensions::Controllers::WikiPages
+  
+  module ClassMethods
+    
+    def page_class
+      @page_class ||= Irwi.config.page_class_name.constantize
+    end
+    
+    def set_page_class(arg)
+      @page_class = arg
+    end
+    
+  end
+  
+  module InstanceMethods
+    
+    include Irwi::Support::TemplateFinder
+    
+    def show
+      return not_allowed unless show_allowed?
+      
+      render_template( @page.new_record? ? 'no' : 'show' )
+    end
+    
+    def history
+      return not_allowed unless show_allowed? && history_allowed?
+      
+      render_template( @page.new_record? ? 'no' : 'history' )
+    end
+    
+    def compare
+      return not_allowed unless show_allowed? && history_allowed?
+      
+      if @page.new_record?
+        render_template 'no'
+      else
+        @versions = @page.versions.between( params[:old] || 1, params[:new] || @page.last_version_number ).all # Loading all versions between first and last
+        
+        @new_version = @versions.last # Loading next version
+        @old_version = @versions.first # Loading previous version
+        
+        render_template 'compare'
+      end
+    end
+    
+    def edit
+      return not_allowed unless show_allowed? && edit_allowed?
+      
+      render_template 'edit'
+    end
+    
+    def update
+      return not_allowed unless @page.new_record? || ( show_allowed? && 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
+      
+      return not_allowed unless show_allowed? && edit_allowed? # Double check: used beacause action may become invalid after attributes update
+        
+      @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
+        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
+    
+    protected
+    
+    # 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}"
+    end
+    
+    # Initialize @current_user instance variable
+    def setup_current_user
+      @current_user = respond_to?( :current_user ) ? current_user : nil # Find user by current_user method or return nil
+    end
+    
+    # Initialize @page instance variable
+    def setup_page
+      @page = page_class.find_by_path_or_new( params[:path].join('/') ) # 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?
+      true
+    end
+    
+    # Check is it allowed for current user edit current page. Designed to be redefined by application programmer
+    def edit_allowed?
+      true
+    end
+    
+  end
+
+  def self.included( base )
+    base.send :extend, Irwi::Extensions::Controllers::WikiPages::ClassMethods
+    base.send :include, Irwi::Extensions::Controllers::WikiPages::InstanceMethods
+    
+    base.before_filter :setup_current_user # Setup @current_user instance variable before each action    
+    base.before_filter :setup_page # Setup @page instance variable before each action
+    
+    base.helper_method :show_allowed?, :edit_allowed?, :history_allowed? # Access control methods are avaliable in views
+  end
+  
+end

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

@@ -0,0 +1,46 @@
+module Irwi::Extensions::Models::WikiPage
+  
+  module ClassMethods
+    
+    def find_by_path_or_new( path )
+      self.find_by_path( path ) || self.new( :path => path )
+    end
+    
+  end
+  
+  module InstanceMethods
+    
+    # Retrieve number of last version
+    def last_version_number
+      last = versions.last
+      last ? last.number : 0
+    end
+    
+    protected
+        
+    def create_new_version
+      n = last_version_number
+      
+      v = versions.build
+      v.attributes = attributes.slice( *v.attribute_names )
+      v.number = n + 1
+      v.save!
+    end
+    
+  end
+  
+  def self.included( base )
+    base.send :extend, Irwi::Extensions::Models::WikiPage::ClassMethods
+    base.send :include, Irwi::Extensions::Models::WikiPage::InstanceMethods
+    
+    base.send :attr_accessor, :comment, :previous_version_number
+    
+    base.belongs_to :creator, :class_name => Irwi.config.user_class_name
+    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 ASC'
+    
+    base.after_save :create_new_version
+  end
+  
+end

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

@@ -0,0 +1,40 @@
+module Irwi::Extensions::Models::WikiPageVersion
+  
+  module ClassMethods
+        
+  end
+  
+  module InstanceMethods    
+    
+    def next
+      self.class.first :conditions => ["id > ? AND page_id = ?", id, page_id], :order => 'id ASC'
+    end
+  
+    def previous
+      self.class.first :conditions => ["id < ? AND page_id = ?", id, page_id], :order => 'id DESC'
+    end
+    
+    protected
+    
+    def raise_on_update
+      raise ActiveRecordError.new "Cann't modify existent version"
+    end
+    
+  end
+  
+  def self.included( base )
+    base.send :extend, Irwi::Extensions::Models::WikiPageVersion::ClassMethods
+    base.send :include, Irwi::Extensions::Models::WikiPageVersion::InstanceMethods
+    
+    base.belongs_to :page, :class_name => Irwi.config.page_class_name
+    base.belongs_to :updator, :class_name => Irwi.config.user_class_name
+    
+    base.before_update :raise_on_update
+    
+    base.named_scope :between, lambda { | first, last | 
+      first, last = last, first if last < first # Reordering if neeeded
+      { :conditions => [ 'number >= ? AND number <= ?', first, last ] }
+    }
+  end
+  
+end

data/lib/irwi/formatters/blue_cloth.rb

@@ -0,0 +1,11 @@
+class Irwi::Formatters::BlueCloth
+  
+  def initialize
+    require 'bluecloth'
+  end
+  
+  def format( text )
+    BlueCloth.new( text ).to_html
+  end
+  
+end

data/lib/irwi/formatters/red_cloth.rb

@@ -0,0 +1,11 @@
+class Irwi::Formatters::RedCloth
+  
+  def initialize
+    require 'redcloth'
+  end
+    
+  def format( text )
+    ::RedCloth.new( text ).to_html
+  end
+  
+end

data/lib/irwi/helpers/wiki_pages_helper.rb

@@ -0,0 +1,83 @@
+module Irwi::Helpers::WikiPagesHelper
+  
+  include Irwi::Support::TemplateFinder
+  
+  # Edit form for wiki page model
+  def wiki_page_form( config = {}, &block )
+    form_for( :page, @page, { :url => url_for( :action => :update ), :html=> { :class => 'wiki_form' } }.merge!( config ), &block )
+  end
+  
+  def wiki_page_edit_path
+    url_for( :action => :edit )
+  end
+  
+  def wiki_page_history_path
+    url_for( :action => :history )
+  end
+  
+  def wiki_page_compare_path
+    url_for( :action => :compare )
+  end
+  
+  def wiki_page_path
+    url_for( :action => :show )
+  end
+  
+  def wiki_content( text )
+    sanitize( Irwi.config.formatter.format( text ) )
+  end
+  
+  def wiki_diff( old_text, new_text )
+    Irwi.config.comparator.render_changes( old_text, new_text )
+  end
+  
+  def wiki_user( user )
+    return '<Unknown>' if user.nil?
+    
+    "User##{user.id}"
+  end
+  
+  ##
+  # Instead of having to translate strings and defining a default value:
+  #
+  #     t("Hello World!", :default => 'Hello World!')
+  #
+  # We define this method to define the value only once:
+  #
+  #     wt("Hello World!")
+  #
+  # Note that interpolation still works ...
+  #
+  #     wt("Hello {{world}}!", :world => @world)
+  #
+  def wt(msg, *args)
+    config = args.extract_options!
+    config[:default] = msg
+    config[:scope] = 'wiki'
+    I18n.t(msg, config)
+  end
+  
+  def wiki_page_style    
+    render :partial => "#{template_dir '_wiki_page_style'}/wiki_page_style"
+  end
+  
+  def wiki_page_info(page = nil)
+    page ||= @page # By default take page from instance variable
+    
+    render :partial => "#{template_dir '_wiki_page_info'}/wiki_page_info", :locals => { :page => page }
+  end
+  
+  def wiki_page_actions(page = nil)
+    page ||= @page # By default take page from instance variable
+    
+    render :partial => "#{template_dir '_wiki_page_actions'}/wiki_page_actions", :locals => { :page => page }
+  end
+  
+  def wiki_page_history(page = nil,versions = nil)
+    page ||= @page # By default take page from instance variable
+    versions ||= page.versions
+    
+    render :partial => "#{template_dir '_wiki_page_history'}/wiki_page_history", :locals => { :page => page, :versions => versions, :with_form => (versions.size > 1) }
+  end
+    
+end