##// END OF EJS Templates
Added:...
Jean-Philippe Lang -
r1139:05823373724e
parent child
Show More
@@ -1,161 +1,168
1 1 # redMine - project management software
2 2 # Copyright (C) 2006-2007 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require 'redcloth'
19 19 require 'coderay'
20 20
21 21 module Redmine
22 22 module WikiFormatting
23 23
24 24 private
25 25
26 26 class TextileFormatter < RedCloth
27 27
28 28 # auto_link rule after textile rules so that it doesn't break !image_url! tags
29 29 RULES = [:textile, :inline_auto_link, :inline_auto_mailto, :inline_toc, :inline_macros]
30 30
31 31 def initialize(*args)
32 32 super
33 33 self.hard_breaks=true
34 34 self.no_span_caps=true
35 35 end
36 36
37 37 def to_html(*rules, &block)
38 38 @toc = []
39 39 @macros_runner = block
40 40 super(*RULES).to_s
41 41 end
42 42
43 43 private
44 44
45 45 # Patch for RedCloth. Fixed in RedCloth r128 but _why hasn't released it yet.
46 46 # <a href="http://code.whytheluckystiff.net/redcloth/changeset/128">http://code.whytheluckystiff.net/redcloth/changeset/128</a>
47 47 def hard_break( text )
48 48 text.gsub!( /(.)\n(?!\n|\Z| *([#*=]+(\s|$)|[{|]))/, "\\1<br />" ) if hard_breaks
49 49 end
50 50
51 51 # Patch to add code highlighting support to RedCloth
52 52 def smooth_offtags( text )
53 53 unless @pre_list.empty?
54 54 ## replace <pre> content
55 55 text.gsub!(/<redpre#(\d+)>/) do
56 56 content = @pre_list[$1.to_i]
57 57 if content.match(/<code\s+class="(\w+)">\s?(.+)/m)
58 58 content = "<code class=\"#{$1} CodeRay\">" +
59 59 CodeRay.scan($2, $1).html(:escape => false, :line_numbers => :inline)
60 60 end
61 61 content
62 62 end
63 63 end
64 64 end
65 65
66 66 # Patch to add 'table of content' support to RedCloth
67 67 def textile_p_withtoc(tag, atts, cite, content)
68 68 if tag =~ /^h(\d)$/
69 69 @toc << [$1.to_i, content]
70 70 end
71 71 content = "<a name=\"#{@toc.length}\" class=\"wiki-page\"></a>" + content
72 72 textile_p(tag, atts, cite, content)
73 73 end
74 74
75 75 alias :textile_h1 :textile_p_withtoc
76 76 alias :textile_h2 :textile_p_withtoc
77 77 alias :textile_h3 :textile_p_withtoc
78 78
79 79 def inline_toc(text)
80 80 text.gsub!(/<p>\{\{([<>]?)toc\}\}<\/p>/i) do
81 81 div_class = 'toc'
82 82 div_class << ' right' if $1 == '>'
83 83 div_class << ' left' if $1 == '<'
84 84 out = "<div class=\"#{div_class}\">"
85 85 @toc.each_with_index do |heading, index|
86 86 # remove wiki links from the item
87 87 toc_item = heading.last.gsub(/(\[\[|\]\])/, '')
88 88 out << "<a href=\"##{index+1}\" class=\"heading#{heading.first}\">#{toc_item}</a>"
89 89 end
90 90 out << '</div>'
91 91 out
92 92 end
93 93 end
94 94
95 95 MACROS_RE = /
96 (!)? # escaping
97 (
96 98 \{\{ # opening tag
97 99 ([\w]+) # macro name
98 100 (\(([^\}]*)\))? # optional arguments
99 101 \}\} # closing tag
102 )
100 103 /x unless const_defined?(:MACROS_RE)
101 104
102 105 def inline_macros(text)
103 106 text.gsub!(MACROS_RE) do
104 all, macro = $&, $1.downcase
105 args = ($3 || '').split(',').each(&:strip)
107 esc, all, macro = $1, $2, $3.downcase
108 args = ($5 || '').split(',').each(&:strip)
109 if esc.nil?
106 110 begin
107 111 @macros_runner.call(macro, args)
108 112 rescue => e
109 113 "<div class=\"flash error\">Error executing the <strong>#{macro}</strong> macro (#{e})</div>"
110 114 end || all
115 else
116 all
117 end
111 118 end
112 119 end
113 120
114 121 AUTO_LINK_RE = %r{
115 122 ( # leading text
116 123 <\w+.*?>| # leading HTML tag, or
117 124 [^=<>!:'"/]| # leading punctuation, or
118 125 ^ # beginning of line
119 126 )
120 127 (
121 128 (?:https?://)| # protocol spec, or
122 129 (?:www\.) # www.*
123 130 )
124 131 (
125 132 (\S+?) # url
126 133 (\/)? # slash
127 134 )
128 135 ([^\w\=\/;]*?) # post
129 136 (?=<|\s|$)
130 137 }x unless const_defined?(:AUTO_LINK_RE)
131 138
132 139 # Turns all urls into clickable links (code from Rails).
133 140 def inline_auto_link(text)
134 141 text.gsub!(AUTO_LINK_RE) do
135 142 all, leading, proto, url, post = $&, $1, $2, $3, $6
136 143 if leading =~ /<a\s/i || leading =~ /![<>=]?/
137 144 # don't replace URL's that are already linked
138 145 # and URL's prefixed with ! !> !< != (textile images)
139 146 all
140 147 else
141 148 %(#{leading}<a class="external" href="#{proto=="www."?"http://www.":proto}#{url}">#{proto + url}</a>#{post})
142 149 end
143 150 end
144 151 end
145 152
146 153 # Turns all email addresses into clickable links (code from Rails).
147 154 def inline_auto_mailto(text)
148 155 text.gsub!(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do
149 156 text = $1
150 157 %{<a href="mailto:#{$1}" class="email">#{text}</a>}
151 158 end
152 159 end
153 160 end
154 161
155 162 public
156 163
157 164 def self.to_html(text, options = {}, &block)
158 165 TextileFormatter.new(text).to_html(&block)
159 166 end
160 167 end
161 168 end
@@ -1,81 +1,98
1 1 # redMine - project management software
2 2 # Copyright (C) 2006-2007 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 module Redmine
19 19 module WikiFormatting
20 20 module Macros
21 21 module Definitions
22 22 def exec_macro(name, obj, args)
23 23 method_name = "macro_#{name}"
24 24 send(method_name, obj, args) if respond_to?(method_name)
25 25 end
26 26 end
27 27
28 28 @@available_macros = {}
29 29
30 30 class << self
31 31 # Called with a block to define additional macros.
32 32 # Macro blocks accept 2 arguments:
33 33 # * obj: the object that is rendered
34 34 # * args: macro arguments
35 35 #
36 36 # Plugins can use this method to define new macros:
37 37 #
38 38 # Redmine::WikiFormatting::Macros.register do
39 39 # desc "This is my macro"
40 40 # macro :my_macro do |obj, args|
41 41 # "My macro output"
42 42 # end
43 43 # end
44 44 def register(&block)
45 45 class_eval(&block) if block_given?
46 46 end
47 47
48 48 private
49 49 # Defines a new macro with the given name and block.
50 50 def macro(name, &block)
51 51 name = name.to_sym if name.is_a?(String)
52 52 @@available_macros[name] = @@desc || ''
53 53 @@desc = nil
54 54 raise "Can not create a macro without a block!" unless block_given?
55 55 Definitions.send :define_method, "macro_#{name}".downcase, &block
56 56 end
57 57
58 58 # Sets description for the next macro to be defined
59 59 def desc(txt)
60 60 @@desc = txt
61 61 end
62 62 end
63 63
64 64 # Builtin macros
65 desc "Example macro."
65 desc "Sample macro."
66 66 macro :hello_world do |obj, args|
67 67 "Hello world! Object: #{obj.class.name}, " + (args.empty? ? "Called with no argument." : "Arguments: #{args.join(', ')}")
68 68 end
69 69
70 70 desc "Displays a list of all available macros, including description if available."
71 71 macro :macro_list do
72 72 out = ''
73 73 @@available_macros.keys.collect(&:to_s).sort.each do |macro|
74 74 out << content_tag('dt', content_tag('code', macro))
75 out << content_tag('dd', simple_format(@@available_macros[macro.to_sym]))
75 out << content_tag('dd', textilizable(@@available_macros[macro.to_sym]))
76 76 end
77 77 content_tag('dl', out)
78 78 end
79
80 desc "Include a wiki page. Example:\n\n !{{include(Foo)}}"
81 macro :include do |obj, args|
82 if @project && !@project.wiki.nil?
83 page = @project.wiki.find_page(args.first)
84 if page && page.content
85 @included_wiki_pages ||= []
86 raise 'Circular inclusion detected' if @included_wiki_pages.include?(page.title)
87 @included_wiki_pages << page.title
88 out = textilizable(page.content, :text)
89 @included_wiki_pages.pop
90 out
91 else
92 raise "Page #{args.first} doesn't exist"
93 end
94 end
95 end
79 96 end
80 97 end
81 98 end
@@ -1,152 +1,155
1 1 # redMine - project management software
2 2 # Copyright (C) 2006-2007 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require File.dirname(__FILE__) + '/../../test_helper'
19 19
20 20 class ApplicationHelperTest < HelperTestCase
21 21 include ApplicationHelper
22 22 include ActionView::Helpers::TextHelper
23 23 fixtures :projects, :repositories, :changesets, :trackers, :issue_statuses, :issues, :documents, :versions, :wikis, :wiki_pages, :wiki_contents
24 24
25 25 def setup
26 26 super
27 27 end
28 28
29 29 def test_auto_links
30 30 to_test = {
31 31 'http://foo.bar' => '<a class="external" href="http://foo.bar">http://foo.bar</a>',
32 32 'http://foo.bar/~user' => '<a class="external" href="http://foo.bar/~user">http://foo.bar/~user</a>',
33 33 'http://foo.bar.' => '<a class="external" href="http://foo.bar">http://foo.bar</a>.',
34 34 '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>.',
35 35 'www.foo.bar' => '<a class="external" href="http://www.foo.bar">www.foo.bar</a>',
36 36 '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>',
37 37 'http://foo.bar/page#125' => '<a class="external" href="http://foo.bar/page#125">http://foo.bar/page#125</a>'
38 38 }
39 39 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
40 40 end
41 41
42 42 def test_auto_mailto
43 43 assert_equal '<p><a href="mailto:test@foo.bar" class="email">test@foo.bar</a></p>',
44 44 textilizable('test@foo.bar')
45 45 end
46 46
47 47 def test_inline_images
48 48 to_test = {
49 49 '!http://foo.bar/image.jpg!' => '<img src="http://foo.bar/image.jpg" alt="" />',
50 50 'floating !>http://foo.bar/image.jpg!' => 'floating <div style="float:right"><img src="http://foo.bar/image.jpg" alt="" /></div>',
51 51 'with class !(some-class)http://foo.bar/image.jpg!' => 'with class <img src="http://foo.bar/image.jpg" class="some-class" alt="" />',
52 52 'with style !{width:100px;height100px}http://foo.bar/image.jpg!' => 'with style <img src="http://foo.bar/image.jpg" style="width:100px;height100px;" alt="" />',
53 53 }
54 54 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
55 55 end
56 56
57 57 def test_textile_external_links
58 58 to_test = {
59 59 'This is a "link":http://foo.bar' => 'This is a <a href="http://foo.bar" class="external">link</a>',
60 60 'This is an intern "link":/foo/bar' => 'This is an intern <a href="/foo/bar">link</a>',
61 61 '"link (Link title)":http://foo.bar' => '<a href="http://foo.bar" title="Link title" class="external">link</a>'
62 62 }
63 63 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
64 64 end
65 65
66 66 def test_redmine_links
67 67 issue_link = link_to('#3', {:controller => 'issues', :action => 'show', :id => 3},
68 68 :class => 'issue', :title => 'Error 281 when updating a recipe (New)')
69 69
70 70 changeset_link = link_to('r1', {:controller => 'repositories', :action => 'revision', :id => 1, :rev => 1},
71 71 :class => 'changeset', :title => 'My very first commit')
72 72
73 73 document_link = link_to('Test document', {:controller => 'documents', :action => 'show', :id => 1},
74 74 :class => 'document')
75 75
76 76 version_link = link_to('1.0', {:controller => 'versions', :action => 'show', :id => 2},
77 77 :class => 'version')
78 78
79 79 to_test = {
80 80 '#3, #3 and #3.' => "#{issue_link}, #{issue_link} and #{issue_link}.",
81 81 'r1' => changeset_link,
82 82 'document#1' => document_link,
83 83 'document:"Test document"' => document_link,
84 84 'version#2' => version_link,
85 85 'version:1.0' => version_link,
86 86 'version:"1.0"' => version_link,
87 87 # escaping
88 88 '!#3.' => '#3.',
89 89 '!r1' => 'r1',
90 90 '!document#1' => 'document#1',
91 91 '!document:"Test document"' => 'document:"Test document"',
92 92 '!version#2' => 'version#2',
93 93 '!version:1.0' => 'version:1.0',
94 94 '!version:"1.0"' => 'version:"1.0"',
95 95 }
96 96 @project = Project.find(1)
97 97 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
98 98 end
99 99
100 100 def test_wiki_links
101 101 to_test = {
102 102 '[[CookBook documentation]]' => '<a href="/wiki/ecookbook/CookBook_documentation" class="wiki-page">CookBook documentation</a>',
103 103 '[[Another page|Page]]' => '<a href="/wiki/ecookbook/Another_page" class="wiki-page">Page</a>',
104 104 # page that doesn't exist
105 105 '[[Unknown page]]' => '<a href="/wiki/ecookbook/Unknown_page" class="wiki-page new">Unknown page</a>',
106 106 '[[Unknown page|404]]' => '<a href="/wiki/ecookbook/Unknown_page" class="wiki-page new">404</a>',
107 107 # link to another project wiki
108 108 '[[onlinestore:]]' => '<a href="/wiki/onlinestore/" class="wiki-page">onlinestore</a>',
109 109 '[[onlinestore:|Wiki]]' => '<a href="/wiki/onlinestore/" class="wiki-page">Wiki</a>',
110 110 '[[onlinestore:Start page]]' => '<a href="/wiki/onlinestore/Start_page" class="wiki-page">Start page</a>',
111 111 '[[onlinestore:Start page|Text]]' => '<a href="/wiki/onlinestore/Start_page" class="wiki-page">Text</a>',
112 112 '[[onlinestore:Unknown page]]' => '<a href="/wiki/onlinestore/Unknown_page" class="wiki-page new">Unknown page</a>',
113 113 # escaping
114 114 '![[Another page|Page]]' => '[[Another page|Page]]',
115 115 }
116 116 @project = Project.find(1)
117 117 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
118 118 end
119 119
120 120 def test_macro_hello_world
121 121 text = "{{hello_world}}"
122 122 assert textilizable(text).match(/Hello world!/)
123 # escaping
124 text = "!{{hello_world}}"
125 assert_equal '<p>{{hello_world}}</p>', textilizable(text)
123 126 end
124 127
125 128 def test_date_format_default
126 129 today = Date.today
127 130 Setting.date_format = ''
128 131 assert_equal l_date(today), format_date(today)
129 132 end
130 133
131 134 def test_date_format
132 135 today = Date.today
133 136 Setting.date_format = '%d %m %Y'
134 137 assert_equal today.strftime('%d %m %Y'), format_date(today)
135 138 end
136 139
137 140 def test_time_format_default
138 141 now = Time.now
139 142 Setting.date_format = ''
140 143 Setting.time_format = ''
141 144 assert_equal l_datetime(now), format_time(now)
142 145 assert_equal l_time(now), format_time(now, false)
143 146 end
144 147
145 148 def test_time_format
146 149 now = Time.now
147 150 Setting.date_format = '%d %m %Y'
148 151 Setting.time_format = '%H %M'
149 152 assert_equal now.strftime('%d %m %Y %H %M'), format_time(now)
150 153 assert_equal now.strftime('%H %M'), format_time(now, false)
151 154 end
152 155 end
General Comments 0
You need to be logged in to leave comments. Login now