jro_apps/redmine Commit - r3518:58792737394c

Makes the wiki sidebar editable (#5208)....

Jean-Philippe Lang -

r3518:58792737394c

parent child

Context file:

r3518:58792737394c

Collapse all files

app/controllers/wiki_controller.rb +1 -1

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'diff'
             class WikiController < ApplicationController
               default_search_scope :wiki_pages
               before_filter :find_wiki, :authorize
               before_filter :find_existing_page, :only => [:rename, :protect, :history, :diff, :annotate, :add_attachment, :destroy]
               verify :method => :post, :only => [:destroy, :protect], :redirect_to => { :action => :index }
               helper :attachments
               include AttachmentsHelper
               helper :watchers
               # display a page (in editing mode if it doesn't exist)
               def index
                 page_title = params[:page]
                 @page = @wiki.find_or_new_page(page_title)
                 if @page.new_record?
-                  if User.current.allowed_to?(:edit_wiki_pages, @project)
+                  if User.current.allowed_to?(:edit_wiki_pages, @project) && editable?
                     edit
                     render :action => 'edit'
                   else
                     render_404
                   end
                   return
                 end
                 if params[:version] && !User.current.allowed_to?(:view_wiki_edits, @project)
                   # Redirects user to the current version if he's not allowed to view previous versions
                   redirect_to :version => nil
                   return
                 end
                 @content = @page.content_for_version(params[:version])
                 if User.current.allowed_to?(:export_wiki_pages, @project)
                   if params[:format] == 'html'
                     export = render_to_string :action => 'export', :layout => false
                     send_data(export, :type => 'text/html', :filename => "#{@page.title}.html")
                     return
                   elsif params[:format] == 'txt'
                     send_data(@content.text, :type => 'text/plain', :filename => "#{@page.title}.txt")
                     return
                   end
                 end
                 @editable = editable?
                 render :action => 'show'
               end
               # edit an existing page or a new one
               def edit
                 @page = @wiki.find_or_new_page(params[:page])
                 return render_403 unless editable?
                 @page.content = WikiContent.new(:page => @page) if @page.new_record?
                 @content = @page.content_for_version(params[:version])
                 @content.text = initial_page_content(@page) if @content.text.blank?
                 # don't keep previous comment
                 @content.comments = nil
                 if request.get?
                   # To prevent StaleObjectError exception when reverting to a previous version
                   @content.version = @page.content.version
                 else
                   if !@page.new_record? && @content.text == params[:content][:text]
                     attachments = Attachment.attach_files(@page, params[:attachments])
                     render_attachment_warning_if_needed(@page)
                     # don't save if text wasn't changed
                     redirect_to :action => 'index', :id => @project, :page => @page.title
                     return
                   end
                   #@content.text = params[:content][:text]
                   #@content.comments = params[:content][:comments]
                   @content.attributes = params[:content]
                   @content.author = User.current
                   # if page is new @page.save will also save content, but not if page isn't a new record
                   if (@page.new_record? ? @page.save : @content.save)
                     attachments = Attachment.attach_files(@page, params[:attachments])
                     render_attachment_warning_if_needed(@page)
                     call_hook(:controller_wiki_edit_after_save, { :params => params, :page => @page})
                     redirect_to :action => 'index', :id => @project, :page => @page.title
                   end
                 end
               rescue ActiveRecord::StaleObjectError
                 # Optimistic locking exception
                 flash[:error] = l(:notice_locking_conflict)
               end
               # rename a page
               def rename
                 return render_403 unless editable?
                 @page.redirect_existing_links = true
                 # used to display the *original* title if some AR validation errors occur
                 @original_title = @page.pretty_title
                 if request.post? && @page.update_attributes(params[:wiki_page])
                   flash[:notice] = l(:notice_successful_update)
                   redirect_to :action => 'index', :id => @project, :page => @page.title
                 end
               end
               def protect
                 @page.update_attribute :protected, params[:protected]
                 redirect_to :action => 'index', :id => @project, :page => @page.title
               end
               # show page history
               def history
                 @version_count = @page.content.versions.count
                 @version_pages = Paginator.new self, @version_count, per_page_option, params['p']
                 # don't load text
                 @versions = @page.content.versions.find :all,
                                                         :select => "id, author_id, comments, updated_on, version",
                                                         :order => 'version DESC',
                                                         :limit  =>  @version_pages.items_per_page + 1,
                                                         :offset =>  @version_pages.current.offset
                 render :layout => false if request.xhr?
               end
               def diff
                 @diff = @page.diff(params[:version], params[:version_from])
                 render_404 unless @diff
               end
               def annotate
                 @annotate = @page.annotate(params[:version])
                 render_404 unless @annotate
               end
               # Removes a wiki page and its history
               # Children can be either set as root pages, removed or reassigned to another parent page
               def destroy
                 return render_403 unless editable?
                 @descendants_count = @page.descendants.size
                 if @descendants_count > 0
                   case params[:todo]
                   when 'nullify'
                     # Nothing to do
                   when 'destroy'
                     # Removes all its descendants
                     @page.descendants.each(&:destroy)
                   when 'reassign'
                     # Reassign children to another parent page
                     reassign_to = @wiki.pages.find_by_id(params[:reassign_to_id].to_i)
                     return unless reassign_to
                     @page.children.each do |child|
                       child.update_attribute(:parent, reassign_to)
                     end
                   else
                     @reassignable_to = @wiki.pages - @page.self_and_descendants
                     return
                   end
                 end
                 @page.destroy
                 redirect_to :action => 'special', :id => @project, :page => 'Page_index'
               end
               # display special pages
               def special
                 page_title = params[:page].downcase
                 case page_title
                 # show pages index, sorted by title
                 when 'page_index', 'date_index'
                   # eager load information about last updates, without loading text
                   @pages = @wiki.pages.find :all, :select => "#{WikiPage.table_name}.*, #{WikiContent.table_name}.updated_on",
                                                   :joins => "LEFT JOIN #{WikiContent.table_name} ON #{WikiContent.table_name}.page_id = #{WikiPage.table_name}.id",
                                                   :order => 'title'
                   @pages_by_date = @pages.group_by {|p| p.updated_on.to_date}
                   @pages_by_parent_id = @pages.group_by(&:parent_id)
                 # export wiki to a single html file
                 when 'export'
                   if User.current.allowed_to?(:export_wiki_pages, @project)
                     @pages = @wiki.pages.find :all, :order => 'title'
                     export = render_to_string :action => 'export_multiple', :layout => false
                     send_data(export, :type => 'text/html', :filename => "wiki.html")
                   else
                     redirect_to :action => 'index', :id => @project, :page => nil
                   end
                   return
                 else
                   # requested special page doesn't exist, redirect to default page
                   redirect_to :action => 'index', :id => @project, :page => nil
                   return
                 end
                 render :action => "special_#{page_title}"
               end
               def preview
                 page = @wiki.find_page(params[:page])
                 # page is nil when previewing a new page
                 return render_403 unless page.nil? || editable?(page)
                 if page
                   @attachements = page.attachments
                   @previewed = page.content
                 end
                 @text = params[:content][:text]
                 render :partial => 'common/preview'
               end
               def add_attachment
                 return render_403 unless editable?
                 attachments = Attachment.attach_files(@page, params[:attachments])
                 render_attachment_warning_if_needed(@page)
                 redirect_to :action => 'index', :page => @page.title
               end
             private
               def find_wiki
                 @project = Project.find(params[:id])
                 @wiki = @project.wiki
                 render_404 unless @wiki
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Finds the requested page and returns a 404 error if it doesn't exist
               def find_existing_page
                 @page = @wiki.find_page(params[:page])
                 render_404 if @page.nil?
               end
               # Returns true if the current user is allowed to edit the page, otherwise false
               def editable?(page = @page)
                 page.editable_by?(User.current)
               end
               # Returns the default content of a new wiki page
               def initial_page_content(page)
                 helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)
                 extend helper unless self.instance_of?(helper)
                 helper.instance_method(:initial_page_content).bind(self).call(page)
               end
             end

app/models/wiki.rb +6 0

             # Redmine - project management software
             # Copyright (C) 2006-2009  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class Wiki < ActiveRecord::Base
               belongs_to :project
               has_many :pages, :class_name => 'WikiPage', :dependent => :destroy, :order => 'title'
               has_many :redirects, :class_name => 'WikiRedirect', :dependent => :delete_all
               acts_as_watchable
               validates_presence_of :start_page
               validates_format_of :start_page, :with => /^[^,\.\/\?\;\|\:]*$/
               def visible?(user=User.current)
                 !user.nil? && user.allowed_to?(:view_wiki_pages, project)
               end
+              # Returns the wiki page that acts as the sidebar content
+              # or nil if no such page exists
+              def sidebar
+                @sidebar ||= find_page('Sidebar', :with_redirect => false)
+              end
               # find the page with the given title
               # if page doesn't exist, return a new page
               def find_or_new_page(title)
                 title = start_page if title.blank?
                 find_page(title) || WikiPage.new(:wiki => self, :title => Wiki.titleize(title))
               end
               # find the page with the given title
               def find_page(title, options = {})
                 title = start_page if title.blank?
                 title = Wiki.titleize(title)
                 page = pages.find_by_title(title)
                 if !page && !(options[:with_redirect] == false)
                   # search for a redirect
                   redirect = redirects.find_by_title(title)
                   page = find_page(redirect.redirects_to, :with_redirect => false) if redirect
                 end
                 page
               end
               # Finds a page by title
               # The given string can be of one of the forms: "title" or "project:title"
               # Examples:
               #   Wiki.find_page("bar", project => foo)
               #   Wiki.find_page("foo:bar")
               def self.find_page(title, options = {})
                 project = options[:project]
                 if title.to_s =~ %r{^([^\:]+)\:(.*)$}
                   project_identifier, title = $1, $2
                   project = Project.find_by_identifier(project_identifier) || Project.find_by_name(project_identifier)
                 end
                 if project && project.wiki
                   page = project.wiki.find_page(title)
                   if page && page.content
                     page
                   end
                 end
               end
               # turn a string into a valid page title
               def self.titleize(title)
                 # replace spaces with _ and remove unwanted caracters
                 title = title.gsub(/\s+/, '_').delete(',./?;|:') if title
                 # upcase the first letter
                 title = (title.slice(0..0).upcase + (title.slice(1..-1) || '')) if title
                 title
               end
             end

app/models/wiki_content.rb +4 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'zlib'
             class WikiContent < ActiveRecord::Base
               set_locking_column :version
               belongs_to :page, :class_name => 'WikiPage', :foreign_key => 'page_id'
               belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
               validates_presence_of :text
               validates_length_of :comments, :maximum => 255, :allow_nil => true
               acts_as_versioned
               def visible?(user=User.current)
                 page.visible?(user)
               end
               def project
                 page.project
               end
+              def attachments
+                page.nil? ? [] : page.attachments
+              end
               # Returns the mail adresses of users that should be notified
               def recipients
                 notified = project.notified_users
                 notified.reject! {|user| !visible?(user)}
                 notified.collect(&:mail)
               end
               class Version
                 belongs_to :page, :class_name => '::WikiPage', :foreign_key => 'page_id'
                 belongs_to :author, :class_name => '::User', :foreign_key => 'author_id'
                 attr_protected :data
                 acts_as_event :title => Proc.new {|o| "#{l(:label_wiki_edit)}: #{o.page.title} (##{o.version})"},
                               :description => :comments,
                               :datetime => :updated_on,
                               :type => 'wiki-page',
                               :url => Proc.new {|o| {:controller => 'wiki', :id => o.page.wiki.project_id, :page => o.page.title, :version => o.version}}
                 acts_as_activity_provider :type => 'wiki_edits',
                                           :timestamp => "#{WikiContent.versioned_table_name}.updated_on",
                                           :author_key => "#{WikiContent.versioned_table_name}.author_id",
                                           :permission => :view_wiki_edits,
                                           :find_options => {:select => "#{WikiContent.versioned_table_name}.updated_on, #{WikiContent.versioned_table_name}.comments, " +
                                                                        "#{WikiContent.versioned_table_name}.#{WikiContent.version_column}, #{WikiPage.table_name}.title, " +
                                                                        "#{WikiContent.versioned_table_name}.page_id, #{WikiContent.versioned_table_name}.author_id, " +
                                                                        "#{WikiContent.versioned_table_name}.id",
                                                             :joins => "LEFT JOIN #{WikiPage.table_name} ON #{WikiPage.table_name}.id = #{WikiContent.versioned_table_name}.page_id " +
                                                                       "LEFT JOIN #{Wiki.table_name} ON #{Wiki.table_name}.id = #{WikiPage.table_name}.wiki_id " +
                                                                       "LEFT JOIN #{Project.table_name} ON #{Project.table_name}.id = #{Wiki.table_name}.project_id"}
                 def text=(plain)
                   case Setting.wiki_compression
                   when 'gzip'
                   begin
                     self.data = Zlib::Deflate.deflate(plain, Zlib::BEST_COMPRESSION)
                     self.compression = 'gzip'
                   rescue
                     self.data = plain
                     self.compression = ''
                   end
                   else
                     self.data = plain
                     self.compression = ''
                   end
                   plain
                 end
                 def text
                   @text ||= case compression
                   when 'gzip'
                      Zlib::Inflate.inflate(data)
                   else
                     # uncompressed data
                     data
                   end
                 end
                 def project
                   page.project
                 end
                 # Returns the previous version or nil
                 def previous
                   @previous ||= WikiContent::Version.find(:first,
                                                           :order => 'version DESC',
                                                           :include => :author,
                                                           :conditions => ["wiki_content_id = ? AND version < ?", wiki_content_id, version])
                 end
               end
             end

app/models/wiki_page.rb +9 0

             # Redmine - project management software
             # Copyright (C) 2006-2009  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'diff'
             require 'enumerator'
             class WikiPage < ActiveRecord::Base
               belongs_to :wiki
               has_one :content, :class_name => 'WikiContent', :foreign_key => 'page_id', :dependent => :destroy
               acts_as_attachable :delete_permission => :delete_wiki_pages_attachments
               acts_as_tree :dependent => :nullify, :order => 'title'
               acts_as_watchable
               acts_as_event :title => Proc.new {|o| "#{l(:label_wiki)}: #{o.title}"},
                             :description => :text,
                             :datetime => :created_on,
                             :url => Proc.new {|o| {:controller => 'wiki', :id => o.wiki.project, :page => o.title}}
               acts_as_searchable :columns => ['title', 'text'],
                                  :include => [{:wiki => :project}, :content],
                                  :project_key => "#{Wiki.table_name}.project_id"
               attr_accessor :redirect_existing_links
               validates_presence_of :title
               validates_format_of :title, :with => /^[^,\.\/\?\;\|\s]*$/
               validates_uniqueness_of :title, :scope => :wiki_id, :case_sensitive => false
               validates_associated :content
+              # Wiki pages that are protected by default
+              DEFAULT_PROTECTED_PAGES = %w(sidebar)
+              def after_initialize
+                if new_record? && DEFAULT_PROTECTED_PAGES.include?(title.to_s.downcase)
+                  self.protected = true
+                end
+              end
               def visible?(user=User.current)
                 !user.nil? && user.allowed_to?(:view_wiki_pages, project)
               end
               def title=(value)
                 value = Wiki.titleize(value)
                 @previous_title = read_attribute(:title) if @previous_title.blank?
                 write_attribute(:title, value)
               end
               def before_save
                 self.title = Wiki.titleize(title)
                 # Manage redirects if the title has changed
                 if !@previous_title.blank? && (@previous_title != title) && !new_record?
                   # Update redirects that point to the old title
                   wiki.redirects.find_all_by_redirects_to(@previous_title).each do |r|
                     r.redirects_to = title
                     r.title == r.redirects_to ? r.destroy : r.save
                   end
                   # Remove redirects for the new title
                   wiki.redirects.find_all_by_title(title).each(&:destroy)
                   # Create a redirect to the new title
                   wiki.redirects << WikiRedirect.new(:title => @previous_title, :redirects_to => title) unless redirect_existing_links == "0"
                   @previous_title = nil
                 end
               end
               def before_destroy
                 # Remove redirects to this page
                 wiki.redirects.find_all_by_redirects_to(title).each(&:destroy)
               end
               def pretty_title
                 WikiPage.pretty_title(title)
               end
               def content_for_version(version=nil)
                 result = content.versions.find_by_version(version.to_i) if version
                 result ||= content
                 result
               end
               def diff(version_to=nil, version_from=nil)
                 version_to = version_to ? version_to.to_i : self.content.version
                 version_from = version_from ? version_from.to_i : version_to - 1
                 version_to, version_from = version_from, version_to unless version_from < version_to
                 content_to = content.versions.find_by_version(version_to)
                 content_from = content.versions.find_by_version(version_from)
                 (content_to && content_from) ? WikiDiff.new(content_to, content_from) : nil
               end
               def annotate(version=nil)
                 version = version ? version.to_i : self.content.version
                 c = content.versions.find_by_version(version)
                 c ? WikiAnnotate.new(c) : nil
               end
               def self.pretty_title(str)
                 (str && str.is_a?(String)) ? str.tr('_', ' ') : str
               end
               def project
                 wiki.project
               end
               def text
                 content.text if content
               end
               # Returns true if usr is allowed to edit the page, otherwise false
               def editable_by?(usr)
                 !protected? || usr.allowed_to?(:protect_wiki_pages, wiki.project)
               end
               def attachments_deletable?(usr=User.current)
                 editable_by?(usr) && super(usr)
               end
               def parent_title
                 @parent_title || (self.parent && self.parent.pretty_title)
               end
               def parent_title=(t)
                 @parent_title = t
                 parent_page = t.blank? ? nil : self.wiki.find_page(t)
                 self.parent = parent_page
               end
               protected
               def validate
                 errors.add(:parent_title, :invalid) if !@parent_title.blank? && parent.nil?
                 errors.add(:parent_title, :circular_dependency) if parent && (parent == self || parent.ancestors.include?(self))
                 errors.add(:parent_title, :not_same_project) if parent && (parent.wiki_id != wiki_id)
               end
             end
             class WikiDiff
               attr_reader :diff, :words, :content_to, :content_from
               def initialize(content_to, content_from)
                 @content_to = content_to
                 @content_from = content_from
                 @words = content_to.text.split(/(\s+)/)
                 @words = @words.select {|word| word != ' '}
                 words_from = content_from.text.split(/(\s+)/)
                 words_from = words_from.select {|word| word != ' '}
                 @diff = words_from.diff @words
               end
             end
             class WikiAnnotate
               attr_reader :lines, :content
               def initialize(content)
                 @content = content
                 current = content
                 current_lines = current.text.split(/\r?\n/)
                 @lines = current_lines.collect {|t| [nil, nil, t]}
                 positions = []
                 current_lines.size.times {|i| positions << i}
                 while (current.previous)
                   d = current.previous.text.split(/\r?\n/).diff(current.text.split(/\r?\n/)).diffs.flatten
                   d.each_slice(3) do |s|
                     sign, line = s[0], s[1]
                     if sign == '+' && positions[line] && positions[line] != -1
                       if @lines[positions[line]][0].nil?
                         @lines[positions[line]][0] = current.version
                         @lines[positions[line]][1] = current.author
                       end
                     end
                   end
                   d.each_slice(3) do |s|
                     sign, line = s[0], s[1]
                     if sign == '-'
                       positions.insert(line, -1)
                     else
                       positions[line] = nil
                     end
                   end
                   positions.compact!
                   # Stop if every line is annotated
                   break unless @lines.detect { |line| line[0].nil? }
                   current = current.previous
                 end
                 @lines.each { |line| line[0] ||= current.version }
               end
             end

app/views/wiki/_sidebar.rhtml +4 0

+            <% if @wiki && @wiki.sidebar -%>
+              <%= textilizable @wiki.sidebar.content, :text %>
+            <% end -%>
             <h3><%= l(:label_wiki) %></h3>
             <%= link_to l(:field_start_page), {:action => 'index', :page => nil} %><br />
             <%= link_to l(:label_index_by_title), {:action => 'special', :page => 'Page_index'} %><br />
             <%= link_to l(:label_index_by_date), {:action => 'special', :page => 'Date_index'} %><br />

test/functional/wiki_controller_test.rb +11 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.dirname(__FILE__) + '/../test_helper'
             require 'wiki_controller'
             # Re-raise errors caught by the controller.
             class WikiController; def rescue_action(e) raise e end; end
             class WikiControllerTest < ActionController::TestCase
               fixtures :projects, :users, :roles, :members, :member_roles, :enabled_modules, :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions, :attachments
               def setup
                 @controller = WikiController.new
                 @request    = ActionController::TestRequest.new
                 @response   = ActionController::TestResponse.new
                 User.current = nil
               end
               def test_index_routing
                 assert_routing(
                   {:method => :get, :path => '/projects/567/wiki'},
                   :controller => 'wiki', :action => 'index', :id => '567'
                 )
                 assert_routing(
                   {:method => :get, :path => '/projects/567/wiki/lalala'},
                   :controller => 'wiki', :action => 'index', :id => '567', :page => 'lalala'
                 )
                 assert_generates(
                   '/projects/567/wiki',
                   :controller => 'wiki', :action => 'index', :id => '567', :page => nil
                 )
               end
               def test_show_start_page
                 get :index, :id => 'ecookbook'
                 assert_response :success
                 assert_template 'show'
                 assert_tag :tag => 'h1', :content => /CookBook documentation/
                 # child_pages macro
                 assert_tag :ul, :attributes => { :class => 'pages-hierarchy' },
                            :child => { :tag => 'li',
                                        :child => { :tag => 'a', :attributes => { :href => '/projects/ecookbook/wiki/Page_with_an_inline_image' },
                                                                 :content => 'Page with an inline image' } }
               end
               def test_show_page_with_name
                 get :index, :id => 1, :page => 'Another_page'
                 assert_response :success
                 assert_template 'show'
                 assert_tag :tag => 'h1', :content => /Another page/
                 # Included page with an inline image
                 assert_tag :tag => 'p', :content => /This is an inline image/
                 assert_tag :tag => 'img', :attributes => { :src => '/attachments/download/3',
                                                            :alt => 'This is a logo' }
               end
+              def test_show_with_sidebar
+                page = Project.find(1).wiki.pages.new(:title => 'Sidebar')
+                page.content = WikiContent.new(:text => 'Side bar content for test_show_with_sidebar')
+                page.save!
+                get :index, :id => 1, :page => 'Another_page'
+                assert_response :success
+                assert_tag :tag => 'div', :attributes => {:id => 'sidebar'},
+                                          :content => /Side bar content for test_show_with_sidebar/
+              end
               def test_show_unexistent_page_without_edit_right
                 get :index, :id => 1, :page => 'Unexistent page'
                 assert_response 404
               end
               def test_show_unexistent_page_with_edit_right
                 @request.session[:user_id] = 2
                 get :index, :id => 1, :page => 'Unexistent page'
                 assert_response :success
                 assert_template 'edit'
               end
               def test_edit_routing
                 assert_routing(
                   {:method => :get, :path => '/projects/567/wiki/my_page/edit'},
                   :controller => 'wiki', :action => 'edit', :id => '567', :page => 'my_page'
                 )
                 assert_recognizes(#TODO: use PUT to page path, adjust forms accordingly
                   {:controller => 'wiki', :action => 'edit', :id => '567', :page => 'my_page'},
                   {:method => :post, :path => '/projects/567/wiki/my_page/edit'}
                 )
               end
               def test_create_page
                 @request.session[:user_id] = 2
                 post :edit, :id => 1,
                             :page => 'New page',
                             :content => {:comments => 'Created the page',
                                          :text => "h1. New page\n\nThis is a new page",
                                          :version => 0}
                 assert_redirected_to :action => 'index', :id => 'ecookbook', :page => 'New_page'
                 page = Project.find(1).wiki.find_page('New page')
                 assert !page.new_record?
                 assert_not_nil page.content
                 assert_equal 'Created the page', page.content.comments
               end
               def test_create_page_with_attachments
                 @request.session[:user_id] = 2
                 assert_difference 'WikiPage.count' do
                   assert_difference 'Attachment.count' do
                     post :edit, :id => 1,
                                 :page => 'New page',
                                 :content => {:comments => 'Created the page',
                                              :text => "h1. New page\n\nThis is a new page",
                                              :version => 0},
                                 :attachments => {'1' => {'file' => uploaded_test_file('testfile.txt', 'text/plain')}}
                   end
                 end
                 page = Project.find(1).wiki.find_page('New page')
                 assert_equal 1, page.attachments.count
                 assert_equal 'testfile.txt', page.attachments.first.filename
               end
               def test_preview_routing
                 assert_routing(
                   {:method => :post, :path => '/projects/567/wiki/CookBook_documentation/preview'},
                   :controller => 'wiki', :action => 'preview', :id => '567', :page => 'CookBook_documentation'
                 )
               end
               def test_preview
                 @request.session[:user_id] = 2
                 xhr :post, :preview, :id => 1, :page => 'CookBook_documentation',
                                                :content => { :comments => '',
                                                              :text => 'this is a *previewed text*',
                                                              :version => 3 }
                 assert_response :success
                 assert_template 'common/_preview'
                 assert_tag :tag => 'strong', :content => /previewed text/
               end
               def test_preview_new_page
                 @request.session[:user_id] = 2
                 xhr :post, :preview, :id => 1, :page => 'New page',
                                                :content => { :text => 'h1. New page',
                                                              :comments => '',
                                                              :version => 0 }
                 assert_response :success
                 assert_template 'common/_preview'
                 assert_tag :tag => 'h1', :content => /New page/
               end
               def test_history_routing
                 assert_routing(
                   {:method => :get, :path => '/projects/1/wiki/CookBook_documentation/history'},
                   :controller => 'wiki', :action => 'history', :id => '1', :page => 'CookBook_documentation'
                 )
               end
               def test_history
                 get :history, :id => 1, :page => 'CookBook_documentation'
                 assert_response :success
                 assert_template 'history'
                 assert_not_nil assigns(:versions)
                 assert_equal 3, assigns(:versions).size
                 assert_select "input[type=submit][name=commit]"
               end
               def test_history_with_one_version
                 get :history, :id => 1, :page => 'Another_page'
                 assert_response :success
                 assert_template 'history'
                 assert_not_nil assigns(:versions)
                 assert_equal 1, assigns(:versions).size
                 assert_select "input[type=submit][name=commit]", false
               end
               def test_diff_routing
                 assert_routing(
                   {:method => :get, :path => '/projects/1/wiki/CookBook_documentation/diff/2/vs/1'},
                   :controller => 'wiki', :action => 'diff', :id => '1', :page => 'CookBook_documentation', :version => '2', :version_from => '1'
                 )
               end
               def test_diff
                 get :diff, :id => 1, :page => 'CookBook_documentation', :version => 2, :version_from => 1
                 assert_response :success
                 assert_template 'diff'
                 assert_tag :tag => 'span', :attributes => { :class => 'diff_in'},
                                            :content => /updated/
               end
               def test_annotate_routing
                 assert_routing(
                   {:method => :get, :path => '/projects/1/wiki/CookBook_documentation/annotate/2'},
                   :controller => 'wiki', :action => 'annotate', :id => '1', :page => 'CookBook_documentation', :version => '2'
                 )
               end
               def test_annotate
                 get :annotate, :id => 1, :page =>  'CookBook_documentation', :version => 2
                 assert_response :success
                 assert_template 'annotate'
                 # Line 1
                 assert_tag :tag => 'tr', :child => { :tag => 'th', :attributes => {:class => 'line-num'}, :content => '1' },
                                          :child => { :tag => 'td', :attributes => {:class => 'author'}, :content => /John Smith/ },
                                          :child => { :tag => 'td', :content => /h1\. CookBook documentation/ }
                 # Line 2
                 assert_tag :tag => 'tr', :child => { :tag => 'th', :attributes => {:class => 'line-num'}, :content => '2' },
                                          :child => { :tag => 'td', :attributes => {:class => 'author'}, :content => /redMine Admin/ },
                                          :child => { :tag => 'td', :content => /Some updated \[\[documentation\]\] here/ }
               end
               def test_rename_routing
                 assert_routing(
                   {:method => :get, :path => '/projects/22/wiki/ladida/rename'},
                   :controller => 'wiki', :action => 'rename', :id => '22', :page => 'ladida'
                 )
                 assert_recognizes(
                   #TODO: should be moved into a update action and use a PUT to the page URI
                   {:controller => 'wiki', :action => 'rename', :id => '22', :page => 'ladida'},
                   {:method => :post, :path => '/projects/22/wiki/ladida/rename'}
                 )
               end
               def test_rename_with_redirect
                 @request.session[:user_id] = 2
                 post :rename, :id => 1, :page => 'Another_page',
                                         :wiki_page => { :title => 'Another renamed page',
                                                         :redirect_existing_links => 1 }
                 assert_redirected_to :action => 'index', :id => 'ecookbook', :page => 'Another_renamed_page'
                 wiki = Project.find(1).wiki
                 # Check redirects
                 assert_not_nil wiki.find_page('Another page')
                 assert_nil wiki.find_page('Another page', :with_redirect => false)
               end
               def test_rename_without_redirect
                 @request.session[:user_id] = 2
                 post :rename, :id => 1, :page => 'Another_page',
                                         :wiki_page => { :title => 'Another renamed page',
                                                         :redirect_existing_links => "0" }
                 assert_redirected_to :action => 'index', :id => 'ecookbook', :page => 'Another_renamed_page'
                 wiki = Project.find(1).wiki
                 # Check that there's no redirects
                 assert_nil wiki.find_page('Another page')
               end
               def test_destroy_routing
                 assert_recognizes(
                   #TODO: should use DELETE on page URI
                   {:controller => 'wiki', :action => 'destroy', :id => '22', :page => 'ladida'},
                   {:method => :post, :path => 'projects/22/wiki/ladida/destroy'}
                 )
               end
               def test_destroy_child
                 @request.session[:user_id] = 2
                 post :destroy, :id => 1, :page => 'Child_1'
                 assert_redirected_to :action => 'special', :id => 'ecookbook', :page => 'Page_index'
               end
               def test_destroy_parent
                 @request.session[:user_id] = 2
                 assert_no_difference('WikiPage.count') do
                   post :destroy, :id => 1, :page => 'Another_page'
                 end
                 assert_response :success
                 assert_template 'destroy'
               end
               def test_destroy_parent_with_nullify
                 @request.session[:user_id] = 2
                 assert_difference('WikiPage.count', -1) do
                   post :destroy, :id => 1, :page => 'Another_page', :todo => 'nullify'
                 end
                 assert_redirected_to :action => 'special', :id => 'ecookbook', :page => 'Page_index'
                 assert_nil WikiPage.find_by_id(2)
               end
               def test_destroy_parent_with_cascade
                 @request.session[:user_id] = 2
                 assert_difference('WikiPage.count', -3) do
                   post :destroy, :id => 1, :page => 'Another_page', :todo => 'destroy'
                 end
                 assert_redirected_to :action => 'special', :id => 'ecookbook', :page => 'Page_index'
                 assert_nil WikiPage.find_by_id(2)
                 assert_nil WikiPage.find_by_id(5)
               end
               def test_destroy_parent_with_reassign
                 @request.session[:user_id] = 2
                 assert_difference('WikiPage.count', -1) do
                   post :destroy, :id => 1, :page => 'Another_page', :todo => 'reassign', :reassign_to_id => 1
                 end
                 assert_redirected_to :action => 'special', :id => 'ecookbook', :page => 'Page_index'
                 assert_nil WikiPage.find_by_id(2)
                 assert_equal WikiPage.find(1), WikiPage.find_by_id(5).parent
               end
               def test_special_routing
                 assert_routing(
                   {:method => :get, :path => '/projects/567/wiki/page_index'},
                   :controller => 'wiki', :action => 'special', :id => '567', :page => 'page_index'
                 )
                 assert_routing(
                   {:method => :get, :path => '/projects/567/wiki/Page_Index'},
                   :controller => 'wiki', :action => 'special', :id => '567', :page => 'Page_Index'
                 )
                 assert_routing(
                   {:method => :get, :path => '/projects/567/wiki/date_index'},
                   :controller => 'wiki', :action => 'special', :id => '567', :page => 'date_index'
                 )
                 assert_routing(
                   {:method => :get, :path => '/projects/567/wiki/export'},
                   :controller => 'wiki', :action => 'special', :id => '567', :page => 'export'
                 )
               end
               def test_page_index
                 get :special, :id => 'ecookbook', :page => 'Page_index'
                 assert_response :success
                 assert_template 'special_page_index'
                 pages = assigns(:pages)
                 assert_not_nil pages
                 assert_equal Project.find(1).wiki.pages.size, pages.size
                 assert_tag :ul, :attributes => { :class => 'pages-hierarchy' },
                                 :child => { :tag => 'li', :child => { :tag => 'a', :attributes => { :href => '/projects/ecookbook/wiki/CookBook_documentation' },
                                                           :content => 'CookBook documentation' },
                                             :child => { :tag => 'ul',
                                                         :child => { :tag => 'li',
                                                                     :child => { :tag => 'a', :attributes => { :href => '/projects/ecookbook/wiki/Page_with_an_inline_image' },
                                                                                              :content => 'Page with an inline image' } } } },
                                 :child => { :tag => 'li', :child => { :tag => 'a', :attributes => { :href => '/projects/ecookbook/wiki/Another_page' },
                                                                                    :content => 'Another page' } }
               end
               def test_not_found
                 get :index, :id => 999
                 assert_response 404
               end
               def test_protect_routing
                 assert_routing(
                   {:method => :post, :path => 'projects/22/wiki/ladida/protect'},
                   {:controller => 'wiki', :action => 'protect', :id => '22', :page => 'ladida'}
                 )
               end
               def test_protect_page
                 page = WikiPage.find_by_wiki_id_and_title(1, 'Another_page')
                 assert !page.protected?
                 @request.session[:user_id] = 2
                 post :protect, :id => 1, :page => page.title, :protected => '1'
                 assert_redirected_to :action => 'index', :id => 'ecookbook', :page => 'Another_page'
                 assert page.reload.protected?
               end
               def test_unprotect_page
                 page = WikiPage.find_by_wiki_id_and_title(1, 'CookBook_documentation')
                 assert page.protected?
                 @request.session[:user_id] = 2
                 post :protect, :id => 1, :page => page.title, :protected => '0'
                 assert_redirected_to :action => 'index', :id => 'ecookbook', :page => 'CookBook_documentation'
                 assert !page.reload.protected?
               end
               def test_show_page_with_edit_link
                 @request.session[:user_id] = 2
                 get :index, :id => 1
                 assert_response :success
                 assert_template 'show'
                 assert_tag :tag => 'a', :attributes => { :href => '/projects/1/wiki/CookBook_documentation/edit' }
               end
               def test_show_page_without_edit_link
                 @request.session[:user_id] = 4
                 get :index, :id => 1
                 assert_response :success
                 assert_template 'show'
                 assert_no_tag :tag => 'a', :attributes => { :href => '/projects/1/wiki/CookBook_documentation/edit' }
               end
               def test_edit_unprotected_page
                 # Non members can edit unprotected wiki pages
                 @request.session[:user_id] = 4
                 get :edit, :id => 1, :page => 'Another_page'
                 assert_response :success
                 assert_template 'edit'
               end
               def test_edit_protected_page_by_nonmember
                 # Non members can't edit protected wiki pages
                 @request.session[:user_id] = 4
                 get :edit, :id => 1, :page => 'CookBook_documentation'
                 assert_response 403
               end
               def test_edit_protected_page_by_member
                 @request.session[:user_id] = 2
                 get :edit, :id => 1, :page => 'CookBook_documentation'
                 assert_response :success
                 assert_template 'edit'
               end
               def test_history_of_non_existing_page_should_return_404
                 get :history, :id => 1, :page => 'Unknown_page'
                 assert_response 404
               end
             end

test/unit/wiki_page_test.rb +7 0

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.dirname(__FILE__) + '/../test_helper'
             class WikiPageTest < ActiveSupport::TestCase
               fixtures :projects, :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions
               def setup
                 @wiki = Wiki.find(1)
                 @page = @wiki.pages.first
               end
               def test_create
                 page = WikiPage.new(:wiki => @wiki)
                 assert !page.save
                 assert_equal 1, page.errors.count
                 page.title = "Page"
                 assert page.save
                 page.reload
+                assert !page.protected?
                 @wiki.reload
                 assert @wiki.pages.include?(page)
               end
+              def test_sidebar_should_be_protected_by_default
+                page = @wiki.find_or_new_page('sidebar')
+                assert page.new_record?
+                assert page.protected?
+              end
               def test_find_or_new_page
                 page = @wiki.find_or_new_page("CookBook documentation")
                 assert_kind_of WikiPage, page
                 assert !page.new_record?
                 page = @wiki.find_or_new_page("Non existing page")
                 assert_kind_of WikiPage, page
                 assert page.new_record?
               end
               def test_parent_title
                 page = WikiPage.find_by_title('Another_page')
                 assert_nil page.parent_title
                 page = WikiPage.find_by_title('Page_with_an_inline_image')
                 assert_equal 'CookBook documentation', page.parent_title
               end
               def test_assign_parent
                 page = WikiPage.find_by_title('Another_page')
                 page.parent_title = 'CookBook documentation'
                 assert page.save
                 page.reload
                 assert_equal WikiPage.find_by_title('CookBook_documentation'), page.parent
               end
               def test_unassign_parent
                 page = WikiPage.find_by_title('Page_with_an_inline_image')
                 page.parent_title = ''
                 assert page.save
                 page.reload
                 assert_nil page.parent
               end
               def test_parent_validation
                 page = WikiPage.find_by_title('CookBook_documentation')
                 # A page that doesn't exist
                 page.parent_title = 'Unknown title'
                 assert !page.save
                 assert_equal I18n.translate('activerecord.errors.messages.invalid'), page.errors.on(:parent_title)
                 # A child page
                 page.parent_title = 'Page_with_an_inline_image'
                 assert !page.save
                 assert_equal I18n.translate('activerecord.errors.messages.circular_dependency'), page.errors.on(:parent_title)
                 # The page itself
                 page.parent_title = 'CookBook_documentation'
                 assert !page.save
                 assert_equal I18n.translate('activerecord.errors.messages.circular_dependency'), page.errors.on(:parent_title)
                 page.parent_title = 'Another_page'
                 assert page.save
               end
               def test_destroy
                 page = WikiPage.find(1)
                 page.destroy
                 assert_nil WikiPage.find_by_id(1)
                 # make sure that page content and its history are deleted
                 assert WikiContent.find_all_by_page_id(1).empty?
                 assert WikiContent.versioned_class.find_all_by_page_id(1).empty?
               end
               def test_destroy_should_not_nullify_children
                 page = WikiPage.find(2)
                 child_ids = page.child_ids
                 assert child_ids.any?
                 page.destroy
                 assert_nil WikiPage.find_by_id(2)
                 children = WikiPage.find_all_by_id(child_ids)
                 assert_equal child_ids.size, children.size
                 children.each do |child|
                   assert_nil child.parent_id
                 end
               end
             end

test/unit/wiki_test.rb +19 0

             # encoding: utf-8
             #
             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.dirname(__FILE__) + '/../test_helper'
             class WikiTest < ActiveSupport::TestCase
               fixtures :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions
               def test_create
                 wiki = Wiki.new(:project => Project.find(2))
                 assert !wiki.save
                 assert_equal 1, wiki.errors.count
                 wiki.start_page = "Start page"
                 assert wiki.save
               end
               def test_update
                 @wiki = Wiki.find(1)
                 @wiki.start_page = "Another start page"
                 assert @wiki.save
                 @wiki.reload
                 assert_equal "Another start page", @wiki.start_page
               end
               def test_titleize
                 assert_equal 'Page_title_with_CAPITALES', Wiki.titleize('page title with CAPITALES')
                 assert_equal 'テスト', Wiki.titleize('テスト')
               end
+              context "#sidebar" do
+                setup do
+                  @wiki = Wiki.find(1)
+                end
+                should "return nil if undefined" do
+                  assert_nil @wiki.sidebar
+                end
+                should "return a WikiPage if defined" do
+                  page = @wiki.pages.new(:title => 'Sidebar')
+                  page.content = WikiContent.new(:text => 'Side bar content for test_show_with_sidebar')
+                  page.save!
+                  assert_kind_of WikiPage, @wiki.sidebar
+                  assert_equal 'Sidebar', @wiki.sidebar.title
+                end
+              end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages