jro_apps/redmine Commit - r884:8a8f819d273e

Added wiki macros support. 2 builtin macros are defined: hello_world (sample macro that displays the arguments) and macro_list (display the list of installed macros)....

Jean-Philippe Lang -

r884:8a8f819d273e

parent child

Context file:

r884:8a8f819d273e

Collapse all files

lib/redmine/wiki_formatting/macros.rb created 644 +81 0

@@ -0,0 +1,81
	1	# redMine - project management software
	2	# Copyright (C) 2006-2007 Jean-Philippe Lang
	3	#
	4	# This program is free software; you can redistribute it and/or
	5	# modify it under the terms of the GNU General Public License
	6	# as published by the Free Software Foundation; either version 2
	7	# of the License, or (at your option) any later version.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
	17
	18	module Redmine
	19	module WikiFormatting
	20	module Macros
	21	module Definitions
	22	def exec_macro(name, obj, args)
	23	method_name = "macro_#{name}"
	24	send(method_name, obj, args) if respond_to?(method_name)
	25	end
	26	end
	27
	28	@@available_macros = {}
	29
	30	class << self
	31	# Called with a block to define additional macros.
	32	# Macro blocks accept 2 arguments:
	33	# * obj: the object that is rendered
	34	# * args: macro arguments
	35	#
	36	# Plugins can use this method to define new macros:
	37	#
	38	# Redmine::WikiFormatting::Macros.register do
	39	# desc "This is my macro"
	40	# macro :my_macro do \|obj, args\|
	41	# "My macro output"
	42	# end
	43	# end
	44	def register(&block)
	45	class_eval(&block) if block_given?
	46	end
	47
	48	private
	49	# Defines a new macro with the given name and block.
	50	def macro(name, &block)
	51	name = name.to_sym if name.is_a?(String)
	52	@@available_macros[name] = @@desc \|\| ''
	53	@@desc = nil
	54	raise "Can not create a macro without a block!" unless block_given?
	55	Definitions.send :define_method, "macro_#{name}".downcase, &block
	56	end
	57
	58	# Sets description for the next macro to be defined
	59	def desc(txt)
	60	@@desc = txt
	61	end
	62	end
	63
	64	# Builtin macros
	65	desc "Example macro."
	66	macro :hello_world do \|obj, args\|
	67	"Hello world! Object: #{obj.class.name}, " + (args.empty? ? "Called with no argument." : "Arguments: #{args.join(', ')}")
	68	end
	69
	70	desc "Displays a list of all available macros, including description if available."
	71	macro :macro_list do
	72	out = ''
	73	@@available_macros.keys.collect(&:to_s).sort.each do \|macro\|
	74	out << content_tag('dt', content_tag('code', macro))
	75	out << content_tag('dd', simple_format(@@available_macros[macro.to_sym]))
	76	end
	77	content_tag('dl', out)
	78	end
	79	end
	80	end
	81	end

app/helpers/application_helper.rb +20 -5

             # 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.
             module ApplicationHelper
+              include Redmine::WikiFormatting::Macros::Definitions
               def current_role
                 @current_role ||= User.current.role_for_project(@project)
               end
               # Return true if user is authorized for controller/action, otherwise false
               def authorize_for(controller, action)
                 User.current.allowed_to?({:controller => controller, :action => action}, @project)
               end
               # Display a link if user is authorized
               def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
                 link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])
               end
               # Display a link to user's account page
               def link_to_user(user)
                 link_to user.name, :controller => 'account', :action => 'show', :id => user
               end
               def link_to_issue(issue)
                 link_to "#{issue.tracker.name} ##{issue.id}", :controller => "issues", :action => "show", :id => issue
               end
               def toggle_link(name, id, options={})
                 onclick = "Element.toggle('#{id}'); "
                 onclick << (options[:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ")
                 onclick << "return false;"
                 link_to(name, "#", :onclick => onclick)
               end
               def show_and_goto_link(name, id, options={})
                 onclick = "Element.show('#{id}'); "
                 onclick << (options[:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ")
                 onclick << "location.href='##{id}-anchor'; "
                 onclick << "return false;"
                 link_to(name, "#", options.merge(:onclick => onclick))
               end
               def image_to_function(name, function, html_options = {})
                 html_options.symbolize_keys!
                 tag(:input, html_options.merge({
                     :type => "image", :src => image_path(name),
                     :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};"
                     }))
               end
               def prompt_to_remote(name, text, param, url, html_options = {})
                 html_options[:onclick] = "promptToRemote('#{text}', '#{param}', '#{url_for(url)}'); return false;"
                 link_to name, {}, html_options
               end
               def format_date(date)
                 return nil unless date
                 @date_format ||= (Setting.date_format.to_i == 0 ? l(:general_fmt_date) : "%Y-%m-%d")
                 date.strftime(@date_format)
               end
               def format_time(time)
                 return nil unless time
                 @date_format_setting ||= Setting.date_format.to_i
                 time = time.to_time if time.is_a?(String)
                 @date_format_setting == 0 ? l_datetime(time) : (time.strftime("%Y-%m-%d") + ' ' + l_time(time))
               end
               def authoring(created, author)
                 time_tag = content_tag('acronym', distance_of_time_in_words(Time.now, created), :title => format_time(created))
                 l(:label_added_time_by, author.name, time_tag)
               end
               def day_name(day)
                 l(:general_day_names).split(',')[day-1]
               end
               def month_name(month)
                 l(:actionview_datehelper_select_month_names).split(',')[month-1]
               end
               def pagination_links_full(paginator, options={}, html_options={})
                 page_param = options.delete(:page_param) || :page
                 html = ''
                 html << link_to_remote(('&#171; ' + l(:label_previous)),
                                         {:update => "content", :url => options.merge(page_param => paginator.current.previous)},
                                         {:href => url_for(:params => options.merge(page_param => paginator.current.previous))}) + ' ' if paginator.current.previous
                 html << (pagination_links_each(paginator, options) do |n|
                   link_to_remote(n.to_s,
                                   {:url => {:params => options.merge(page_param => n)}, :update => 'content'},
                                   {:href => url_for(:params => options.merge(page_param => n))})
                 end || '')
                 html << ' ' + link_to_remote((l(:label_next) + ' &#187;'),
                                              {:update => "content", :url => options.merge(page_param => paginator.current.next)},
                                              {:href => url_for(:params => options.merge(page_param => paginator.current.next))}) if paginator.current.next
                 html
               end
               def set_html_title(text)
                 @html_header_title = text
               end
               def html_title
                 title = []
                 title << @project.name if @project
                 title << @html_header_title
                 title << Setting.app_title
                 title.compact.join(' - ')
               end
               ACCESSKEYS = {:edit => 'e',
                             :preview => 'r',
                             :quick_search => 'f',
                             :search => '4',
-                            }.freeze
+                            }.freeze unless const_defined?(:ACCESSKEYS)
               def accesskey(s)
                 ACCESSKEYS[s]
               end
-              # format text according to system settings
+              # Formats text according to system settings.
-              def textilizable(text, options = {})
+              # 2 ways to call this method:
-                return "" if text.blank?
+              # * with a String: textilizable(text, options)
+              # * with an object and one of its attribute: textilizable(issue, :description, options)
+              def textilizable(*args)
+                options = args.last.is_a?(Hash) ? args.pop : {}
+                case args.size
+                when 1
+                  obj = nil
+                  text = args.shift || ''
+                when 2
+                  obj = args.shift
+                  text = obj.send(args.shift)
+                else
+                  raise ArgumentError, 'invalid arguments to textilizable'
+                end
                 # when using an image link, try to use an attachment, if possible
                 attachments = options[:attachments]
                 if attachments
                   text = text.gsub(/!([<>=]*)(\S+\.(gif|jpg|jpeg|png))!/) do |m|
                     align = $1
                     filename = $2
                     rf = Regexp.new(filename,  Regexp::IGNORECASE)
                     # search for the picture in attachments
                     if found = attachments.detect { |att| att.filename =~ rf }
                       image_url = url_for :controller => 'attachments', :action => 'download', :id => found.id
                       "!#{align}#{image_url}!"
                     else
                       "!#{align}#{filename}!"
                     end
                   end
                 end
                 text = (Setting.text_formatting == 'textile') ?
-                  Redmine::WikiFormatting.to_html(text) : simple_format(auto_link(h(text)))
+                  Redmine::WikiFormatting.to_html(text) { |macro, args| exec_macro(macro, obj, args) } :
+                  simple_format(auto_link(h(text)))
                 # different methods for formatting wiki links
                 case options[:wiki_links]
                 when :local
                   # used for local links to html files
                   format_wiki_link = Proc.new {|project, title| "#{title}.html" }
                 when :anchor
                   # used for single-file wiki export
                   format_wiki_link = Proc.new {|project, title| "##{title}" }
                 else
                   format_wiki_link = Proc.new {|project, title| url_for :controller => 'wiki', :action => 'index', :id => project, :page => title }
                 end
                 project = options[:project] || @project
                 # turn wiki links into html links
                 # example:
                 #   [[mypage]]
                 #   [[mypage|mytext]]
                 # wiki links can refer other project wikis, using project name or identifier:
                 #   [[project:]] -> wiki starting page
                 #   [[project:|mytext]]
                 #   [[project:mypage]]
                 #   [[project:mypage|mytext]]
                 text = text.gsub(/\[\[([^\]\|]+)(\|([^\]\|]+))?\]\]/) do |m|
                   link_project = project
                   page = $1
                   title = $3
                   if page =~ /^([^\:]+)\:(.*)$/
                     link_project = Project.find_by_name($1) || Project.find_by_identifier($1)
                     page = title || $2
                     title = $1 if page.blank?
                   end
                   if link_project && link_project.wiki
                     # check if page exists
                     wiki_page = link_project.wiki.find_page(page)
                     link_to((title || page), format_wiki_link.call(link_project, Wiki.titleize(page)),
                                              :class => ('wiki-page' + (wiki_page ? '' : ' new')))
                   else
                     # project or wiki doesn't exist
                     title || page
                   end
                 end
                 # turn issue and revision ids into links
                 # example:
                 #   #52 -> <a href="/issues/show/52">#52</a>
                 #   r52 -> <a href="/repositories/revision/6?rev=52">r52</a> (project.id is 6)
                 text = text.gsub(%r{([\s,-^])(#|r)(\d+)(?=[[:punct:]]|\s|<|$)}) do |m|
                   leading, otype, oid = $1, $2, $3
                   link = nil
                   if otype == 'r'
                     if project && (changeset = project.changesets.find_by_revision(oid))
                       link = link_to("r#{oid}", {:controller => 'repositories', :action => 'revision', :id => project.id, :rev => oid}, :class => 'changeset',
                                                 :title => truncate(changeset.comments, 100))
                     end
                   else
                     if issue = Issue.find_by_id(oid.to_i, :include => [:project, :status], :conditions => Project.visible_by(User.current))
                       link = link_to("##{oid}", {:controller => 'issues', :action => 'show', :id => oid}, :class => 'issue',
                                                 :title => "#{truncate(issue.subject, 100)} (#{issue.status.name})")
                       link = content_tag('del', link) if issue.closed?
                     end
                   end
                   leading + (link || "#{otype}#{oid}")
                 end
                 text
               end
               # Same as Rails' simple_format helper without using paragraphs
               def simple_format_without_paragraph(text)
                 text.to_s.
                   gsub(/\r\n?/, "\n").                    # \r\n and \r -> \n
                   gsub(/\n\n+/, "<br /><br />").          # 2+ newline  -> 2 br
                   gsub(/([^\n]\n)(?=[^\n])/, '\1<br />')  # 1 newline   -> br
               end
               def error_messages_for(object_name, options = {})
                 options = options.symbolize_keys
                 object = instance_variable_get("@#{object_name}")
                 if object && !object.errors.empty?
                   # build full_messages here with controller current language
                   full_messages = []
                   object.errors.each do |attr, msg|
                     next if msg.nil?
                     msg = msg.first if msg.is_a? Array
                     if attr == "base"
                       full_messages << l(msg)
                     else
                       full_messages << "&#171; " + (l_has_string?("field_" + attr) ? l("field_" + attr) : object.class.human_attribute_name(attr)) + " &#187; " + l(msg) unless attr == "custom_values"
                     end
                   end
                   # retrieve custom values error messages
                   if object.errors[:custom_values]
                     object.custom_values.each do |v|
                       v.errors.each do |attr, msg|
                         next if msg.nil?
                         msg = msg.first if msg.is_a? Array
                         full_messages << "&#171; " + v.custom_field.name + " &#187; " + l(msg)
                       end
                     end
                   end
                   content_tag("div",
                     content_tag(
                       options[:header_tag] || "span", lwr(:gui_validation_error, full_messages.length) + ":"
                     ) +
                     content_tag("ul", full_messages.collect { |msg| content_tag("li", msg) }),
                     "id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation"
                   )
                 else
                   ""
                 end
               end
               def lang_options_for_select(blank=true)
                 (blank ? [["(auto)", ""]] : []) +
                   GLoc.valid_languages.collect{|lang| [ ll(lang.to_s, :general_lang_name), lang.to_s]}.sort{|x,y| x.first <=> y.first }
               end
               def label_tag_for(name, option_tags = nil, options = {})
                 label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (options.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "")
                 content_tag("label", label_text)
               end
               def labelled_tabular_form_for(name, object, options, &proc)
                 options[:html] ||= {}
                 options[:html].store :class, "tabular"
                 form_for(name, object, options.merge({ :builder => TabularFormBuilder, :lang => current_language}), &proc)
               end
               def check_all_links(form_name)
                 link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
                 " | " +
                 link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)")
               end
               def context_menu_link(name, url, options={})
                 options[:class] ||= ''
                 if options.delete(:selected)
                   options[:class] << ' icon-checked disabled'
                   options[:disabled] = true
                 end
                 if options.delete(:disabled)
                   options.delete(:method)
                   options.delete(:confirm)
                   options.delete(:onclick)
                   options[:class] << ' disabled'
                   url = '#'
                 end
                 link_to name, url, options
               end
               def calendar_for(field_id)
                 image_tag("calendar.png", {:id => "#{field_id}_trigger",:class => "calendar-trigger"}) +
                 javascript_tag("Calendar.setup({inputField : '#{field_id}', ifFormat : '%Y-%m-%d', button : '#{field_id}_trigger' });")
               end
               def wikitoolbar_for(field_id)
                 return '' unless Setting.text_formatting == 'textile'
                 javascript_include_tag('jstoolbar') + javascript_tag("var toolbar = new jsToolBar($('#{field_id}')); toolbar.draw();")
               end
               def content_for(name, content = nil, &block)
                 @has_content ||= {}
                 @has_content[name] = true
                 super(name, content, &block)
               end
               def has_content?(name)
                 (@has_content && @has_content[name]) || false
               end
             end
             class TabularFormBuilder < ActionView::Helpers::FormBuilder
               include GLoc
               def initialize(object_name, object, template, options, proc)
                 set_language_if_valid options.delete(:lang)
                 @object_name, @object, @template, @options, @proc = object_name, object, template, options, proc
               end
               (field_helpers - %w(radio_button hidden_field) + %w(date_select)).each do |selector|
                 src = <<-END_SRC
                 def #{selector}(field, options = {})
                   return super if options.delete :no_label
                   label_text = l(options[:label]) if options[:label]
                   label_text ||= l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym)
                   label_text << @template.content_tag("span", " *", :class => "required") if options.delete(:required)
                   label = @template.content_tag("label", label_text,
                                 :class => (@object && @object.errors[field] ? "error" : nil),
                                 :for => (@object_name.to_s + "_" + field.to_s))
                   label + super
                 end
                 END_SRC
                 class_eval src, __FILE__, __LINE__
               end
               def select(field, choices, options = {}, html_options = {})
                 label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (options.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "")
                 label = @template.content_tag("label", label_text,
                               :class => (@object && @object.errors[field] ? "error" : nil),
                               :for => (@object_name.to_s + "_" + field.to_s))
                 label + super
               end
             end

app/views/issues/show.rhtml +1 -1

             <div class="contextual">
             <%= show_and_goto_link(l(:label_add_note), 'add-note', :class => 'icon icon-note') if authorize_for('issues', 'add_note') %>
             <%= link_to_if_authorized l(:button_edit), {:controller => 'issues', :action => 'edit', :id => @issue}, :class => 'icon icon-edit', :accesskey => accesskey(:edit) %>
             <%= link_to_if_authorized l(:button_log_time), {:controller => 'timelog', :action => 'edit', :issue_id => @issue}, :class => 'icon icon-time' %>
             <%= watcher_tag(@issue, User.current) %>
             <%= link_to_if_authorized l(:button_copy), {:controller => 'projects', :action => 'add_issue', :id => @project, :copy_from => @issue }, :class => 'icon icon-copy' %>
             <%= link_to_if_authorized l(:button_move), {:controller => 'projects', :action => 'move_issues', :id => @project, "issue_ids[]" => @issue.id }, :class => 'icon icon-move' %>
             <%= link_to_if_authorized l(:button_delete), {:controller => 'issues', :action => 'destroy', :id => @issue}, :confirm => l(:text_are_you_sure), :method => :post, :class => 'icon icon-del' %>
             </div>
             <h2><%= @issue.tracker.name %> #<%= @issue.id %></h2>
             <div class="issue">
                     <h3><%=h @issue.subject %></h3>
                     <p class="author">
                     <%= authoring @issue.created_on, @issue.author %>.
                     <%= l(:label_updated_time, distance_of_time_in_words(Time.now, @issue.updated_on)) if @issue.created_on != @issue.updated_on %>.
                     </p>
             <table width="100%">
             <tr>
                 <td style="width:15%"><b><%=l(:field_status)%> :</b></td><td style="width:35%"><%= @issue.status.name %></td>
                 <td style="width:15%"><b><%=l(:field_start_date)%> :</b></td><td style="width:35%"><%= format_date(@issue.start_date) %></td>
             </tr>
             <tr>
                 <td><b><%=l(:field_priority)%> :</b></td><td><%= @issue.priority.name %></td>
                 <td><b><%=l(:field_due_date)%> :</b></td><td><%= format_date(@issue.due_date) %></td>
             </tr>
             <tr>
                 <td><b><%=l(:field_assigned_to)%> :</b></td><td><%= @issue.assigned_to ? link_to_user(@issue.assigned_to) : "-" %></td>
                 <td><b><%=l(:field_done_ratio)%> :</b></td><td><%= @issue.done_ratio %> %</td>
             </tr>
             <tr>
                 <td><b><%=l(:field_category)%> :</b></td><td><%=h @issue.category ? @issue.category.name : "-" %></td>
                 <% if User.current.allowed_to?(:view_time_entries, @project) %>
                 <td><b><%=l(:label_spent_time)%> :</b></td>
                 <td><%= @issue.spent_hours > 0 ? (link_to lwr(:label_f_hour, @issue.spent_hours), {:controller => 'timelog', :action => 'details', :issue_id => @issue}, :class => 'icon icon-time') : "-" %></td>
                 <% end %>
             </tr>
             <tr>
                 <td><b><%=l(:field_fixed_version)%> :</b></td><td><%= @issue.fixed_version ? link_to_version(@issue.fixed_version) : "-" %></td>
                 <% if @issue.estimated_hours %>
                 <td><b><%=l(:field_estimated_hours)%> :</b></td><td><%= lwr(:label_f_hour, @issue.estimated_hours) %></td>
                 <% end %>
             </tr>
             <tr>
             <% n = 0
             for custom_value in @custom_values %>
                 <td valign="top"><b><%= custom_value.custom_field.name %> :</b></td><td valign="top"><%= simple_format(h(show_value(custom_value))) %></td>
             <% n = n + 1
                if (n > 1)
                     n = 0 %>
                     </tr><tr>
              <%end
             end %>
             </tr>
             </table>
             <hr />
             <% if @issue.changesets.any? %>
             <div style="float:right;">
               <em><%= l(:label_revision_plural) %>: <%= @issue.changesets.collect{|changeset| link_to(changeset.revision, :controller => 'repositories', :action => 'revision', :id => @project, :rev => changeset.revision)}.join(", ") %></em>
             </div>
             <% end %>
             <p><strong><%=l(:field_description)%></strong></p>
-            <%= textilizable @issue.description, :attachments => @issue.attachments %>
+            <%= textilizable @issue, :description, :attachments => @issue.attachments %>
             <% if @issue.attachments.any? %>
             <%= link_to_attachments @issue.attachments, :delete_url => (authorize_for('issues', 'destroy_attachment') ? {:controller => 'issues', :action => 'destroy_attachment', :id => @issue} : nil) %>
             <% end %>
             <% if authorize_for('issue_relations', 'new') || @issue.relations.any? %>
             <hr />
             <div id="relations">
             <%= render :partial => 'relations' %>
             </div>
             <% end %>
             </div>
             <% if authorize_for('issues', 'change_status') and @status_options and !@status_options.empty? %>
               <% form_tag({:controller => 'issues', :action => 'change_status', :id => @issue}) do %>
               <p><%=l(:label_change_status)%> :
               <select name="new_status_id">
               <%= options_from_collection_for_select @status_options, "id", "name" %>
               </select>
               <%= submit_tag l(:button_change) %></p>
               <% end %>
             <% end %>
             <% if @journals.any? %>
             <div id="history">
             <h3><%=l(:label_history)%></h3>
             <%= render :partial => 'history', :locals => { :journals => @journals } %>
             </div>
             <% end %>
             <% if authorize_for('issues', 'add_note') %>
               <a name="add-note-anchor"></a>
               <div id="add-note" class="box" style="display:none;">
               <h3><%= l(:label_add_note) %></h3>
               <% form_tag({:controller => 'issues', :action => 'add_note', :id => @issue}, :class => "tabular", :multipart => true) do %>
               <p><label for="notes"><%=l(:field_notes)%></label>
                 <%= text_area_tag 'notes', '', :cols => 60, :rows => 10, :class => 'wiki-edit'  %></p>
                 <%= wikitoolbar_for 'notes' %>
                 <%= render :partial => 'attachments/form' %>
               <%= submit_tag l(:button_add) %>
               <%= toggle_link l(:button_cancel), 'add-note' %>
               <% end %>
               </div>
             <% end %>
             <div class="contextual">
             <%= l(:label_export_to) %><%= link_to 'PDF', {:format => 'pdf'}, :class => 'icon icon-pdf' %>
             </div>
             &nbsp;
             <% set_html_title "#{@issue.tracker.name} ##{@issue.id}: #{@issue.subject}" %>
             <% content_for :sidebar do %>
                 <%= render :partial => 'issues/sidebar' %>
             <% end %>

app/views/wiki/_content.rhtml +1 -1

             <div class="wiki">
-              <%= textilizable content.text, :attachments => content.page.attachments %>
+              <%= textilizable content, :text, :attachments => content.page.attachments %>
             </div>

app/views/wiki/export.rhtml +1 -1

             <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
             <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
             <head>
             <title><%=h @page.pretty_title %></title>
             <meta http-equiv="content-type" content="text/html; charset=utf-8" />
             <style>
             body { font:80% Verdana,Tahoma,Arial,sans-serif; }
             h1, h2, h3, h4 {  font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
             </style>
             </head>
             <body>
-            <%= textilizable @content.text, :wiki_links => :local %>
+            <%= textilizable @content, :text, :wiki_links => :local %>
             </body>
             </html>

app/views/wiki/export_multiple.rhtml +1 -1

             <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
             <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
             <head>
             <title><%=h @wiki.project.name %></title>
             <meta http-equiv="content-type" content="text/html; charset=utf-8" />
             <style>
             body { font:80% Verdana,Tahoma,Arial,sans-serif; }
             h1, h2, h3, h4 {  font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
             </style>
             </head>
             <body>
             <strong><%= l(:label_index_by_title) %></strong>
             <ul>
             <% @pages.each do |page| %>
                 <li><a href="#<%= page.title %>"><%= page.pretty_title %></a></li>
             <% end %>
             </ul>
             <% @pages.each do |page| %>
             <hr />
             <a name="<%= page.title %>" />
-            <%= textilizable page.content.text, :wiki_links => :anchor %>
+            <%= textilizable page.content ,:text, :wiki_links => :anchor %>
             <% end %>
             </body>
             </html>

lib/redmine/wiki_formatting.rb +43 -5

+            # 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 'redcloth'
             require 'coderay'
-            require 'pp'
             module Redmine
               module WikiFormatting
               private
                 class TextileFormatter < RedCloth
-                  RULES = [:inline_auto_link, :inline_auto_mailto, :textile, :inline_toc]
+                  RULES = [:inline_auto_link, :inline_auto_mailto, :textile, :inline_toc, :inline_macros]
                   def initialize(*args)
                     super
                     self.hard_breaks=true
                     self.no_span_caps=true
                   end
-                  def to_html
+                  def to_html(*rules, &block)
                     @toc = []
+                    @macros_runner = block
                     super(*RULES).to_s
                   end
                 private
                   # Patch for RedCloth.  Fixed in RedCloth r128 but _why hasn't released it yet.
                   # <a href="http://code.whytheluckystiff.net/redcloth/changeset/128">http://code.whytheluckystiff.net/redcloth/changeset/128</a>
                   def hard_break( text )
                     text.gsub!( /(.)\n(?!\n|\Z| *([#*=]+(\s|$)|[{|]))/, "\\1<br />" ) if hard_breaks
                   end
                   # Patch to add code highlighting support to RedCloth
                   def smooth_offtags( text )
                     unless @pre_list.empty?
                       ## replace <pre> content
                       text.gsub!(/<redpre#(\d+)>/) do
                         content = @pre_list[$1.to_i]
                         if content.match(/<code\s+class="(\w+)">\s?(.+)/m)
                           content = "<code class=\"#{$1} CodeRay\">" +
                             CodeRay.scan($2, $1).html(:escape => false, :line_numbers => :inline)
                         end
                         content
                       end
                     end
                   end
                   # Patch to add 'table of content' support to RedCloth
                   def textile_p_withtoc(tag, atts, cite, content)
                     if tag =~ /^h(\d)$/
                       @toc << [$1.to_i, content]
                     end
                     content = "<a name=\"#{@toc.length}\" class=\"wiki-page\"></a>" + content
                     textile_p(tag, atts, cite, content)
                   end
                   alias :textile_h1 :textile_p_withtoc
                   alias :textile_h2 :textile_p_withtoc
                   alias :textile_h3 :textile_p_withtoc
                   def inline_toc(text)
                     text.gsub!(/<p>\{\{([<>]?)toc\}\}<\/p>/i) do
                       div_class = 'toc'
                       div_class << ' right' if $1 == '>'
                       div_class << ' left' if $1 == '<'
                       out = "<div class=\"#{div_class}\">"
                       @toc.each_with_index do |heading, index|
                         # remove wiki links from the item
                         toc_item = heading.last.gsub(/(\[\[|\]\])/, '')
                         out << "<a href=\"##{index+1}\" class=\"heading#{heading.first}\">#{toc_item}</a>"
                       end
                       out << '</div>'
                       out
                     end
                   end
+                  MACROS_RE = /
+                                \{\{                        # opening tag
+                                ([\w]+)                     # macro name
+                                (\(([^\}]*)\))?             # optional arguments
+                                \}\}                        # closing tag
+                              /x unless const_defined?(:MACROS_RE)
+                  def inline_macros(text)
+                    text.gsub!(MACROS_RE) do
+                      all, macro = $&, $1.downcase
+                      args = ($3 || '').split(',').each(&:strip)
+                      begin
+                        @macros_runner.call(macro, args)
+                      rescue => e
+                        "<div class=\"flash error\">Error executing the <strong>#{macro}</strong> macro (#{e})</div>"
+                      end || all
+                    end
+                  end
                   AUTO_LINK_RE = %r{
                                     (                          # leading text
                                       <\w+.*?>|                # leading HTML tag, or
                                       [^=<>!:'"/]|             # leading punctuation, or
                                       ^                        # beginning of line
                                     )
                                     (
                                       (?:https?://)|           # protocol spec, or
                                       (?:www\.)                # www.*
                                     )
                                     (
                                       (\S+?)                   # url
                                       (\/)?                    # slash
                                     )
                                     ([^\w\=\/;]*?)               # post
                                     (?=<|\s|$)
                                    }x unless const_defined?(:AUTO_LINK_RE)
                   # Turns all urls into clickable links (code from Rails).
                   def inline_auto_link(text)
                     text.gsub!(AUTO_LINK_RE) do
                       all, leading, proto, url, post = $&, $1, $2, $3, $6
                       if leading =~ /<a\s/i || leading =~ /![<>=]?/
                         # don't replace URL's that are already linked
                         # and URL's prefixed with ! !> !< != (textile images)
                         all
                       else
                         %(#{leading}<a class="external" href="#{proto=="www."?"http://www.":proto}#{url}">#{proto + url}</a>#{post})
                       end
                     end
                   end
                   # Turns all email addresses into clickable links (code from Rails).
                   def inline_auto_mailto(text)
                     text.gsub!(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do
                       text = $1
                       %{<a href="mailto:#{$1}" class="email">#{text}</a>}
                     end
                   end
                 end
               public
-                def self.to_html(text, options = {})
+                def self.to_html(text, options = {}, &block)
-                  TextileFormatter.new(text).to_html
+                  TextileFormatter.new(text).to_html(&block)
                 end
               end
             end

test/unit/helpers/application_helper_test.rb +5 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 ApplicationHelperTest < HelperTestCase
               include ApplicationHelper
               include ActionView::Helpers::TextHelper
               fixtures :projects, :repositories, :changesets, :trackers, :issue_statuses, :issues
               def setup
                 super
               end
               def test_auto_links
                 to_test = {
                   'http://foo.bar' => '<a class="external" href="http://foo.bar">http://foo.bar</a>',
                   'http://foo.bar/~user' => '<a class="external" href="http://foo.bar/~user">http://foo.bar/~user</a>',
                   'http://foo.bar.' => '<a class="external" href="http://foo.bar">http://foo.bar</a>.',
                   'http://foo.bar/foo.bar#foo.bar.' => '<a class="external" href="http://foo.bar/foo.bar#foo.bar">http://foo.bar/foo.bar#foo.bar</a>.',
                   'www.foo.bar' => '<a class="external" href="http://www.foo.bar">www.foo.bar</a>',
                   'http://foo.bar/page?p=1&t=z&s=' => '<a class="external" href="http://foo.bar/page?p=1&#38;t=z&#38;s=">http://foo.bar/page?p=1&#38;t=z&#38;s=</a>',
                   'http://foo.bar/page#125' => '<a class="external" href="http://foo.bar/page#125">http://foo.bar/page#125</a>'
                 }
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
               def test_auto_mailto
                 assert_equal '<p><a href="mailto:test@foo.bar" class="email">test@foo.bar</a></p>',
                   textilizable('test@foo.bar')
               end
               def test_textile_tags
                 to_test = {
                   # inline images
                   '!http://foo.bar/image.jpg!' => '<img src="http://foo.bar/image.jpg" alt="" />',
                   'floating !>http://foo.bar/image.jpg!' => 'floating <div style="float:right"><img src="http://foo.bar/image.jpg" alt="" /></div>',
                   # textile links
                   'This is a "link":http://foo.bar' => 'This is a <a href="http://foo.bar" class="external">link</a>',
                   'This is an intern "link":/foo/bar' => 'This is an intern <a href="/foo/bar">link</a>',
                   '"link (Link title)":http://foo.bar' => '<a href="http://foo.bar" title="Link title" class="external">link</a>'
                 }
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
               def test_redmine_links
                 issue_link = link_to('#3', {:controller => 'issues', :action => 'show', :id => 3},
                                            :class => 'issue', :title => 'Error 281 when updating a recipe (New)')
                 changeset_link = link_to('r1', {:controller => 'repositories', :action => 'revision', :id => 1, :rev => 1},
                                                :class => 'changeset', :title => 'My very first commit')
                 to_test = {
                   '#3, #3 and #3.' => "#{issue_link}, #{issue_link} and #{issue_link}.",
                   'r1' => changeset_link
                 }
                 @project = Project.find(1)
                 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
               end
+              def test_macro_hello_world
+                text = "{{hello_world}}"
+                assert textilizable(text).match(/Hello world!/)
+              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