jro_apps/redmine Commit - r10778:6062a0a89d50

Merged r10885 from trunk (#12451)....

Jean-Philippe Lang -

r10778:6062a0a89d50

parent child

Context file:

r10778:6062a0a89d50

Collapse all files

lib/redmine/wiki_formatting/macros.rb +1 -1

             # Redmine - project management software
             # Copyright (C) 2006-2012  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 Redmine
               module WikiFormatting
                 module Macros
                   module Definitions
                     # Returns true if +name+ is the name of an existing macro
                     def macro_exists?(name)
                       Redmine::WikiFormatting::Macros.available_macros.key?(name.to_sym)
                     end
                     def exec_macro(name, obj, args, text)
                       macro_options = Redmine::WikiFormatting::Macros.available_macros[name.to_sym]
                       return unless macro_options
                       method_name = "macro_#{name}"
                       unless macro_options[:parse_args] == false
                         args = args.split(',').map(&:strip)
                       end
                       begin
                         if self.class.instance_method(method_name).arity == 3
                           send(method_name, obj, args, text)
                         elsif text
                           raise "This macro does not accept a block of text"
                         else
                           send(method_name, obj, args)
                         end
                       rescue => e
                         "<div class=\"flash error\">Error executing the <strong>#{h name}</strong> macro (#{h e.to_s})</div>".html_safe
                       end
                     end
                     def extract_macro_options(args, *keys)
                       options = {}
-                      while args.last.to_s.strip =~ %r{^(.+)\=(.+)$} && keys.include?($1.downcase.to_sym)
+                      while args.last.to_s.strip =~ %r{^(.+?)\=(.+)$} && keys.include?($1.downcase.to_sym)
                         options[$1.downcase.to_sym] = $2
                         args.pop
                       end
                       return [args, options]
                     end
                   end
                   @@available_macros = {}
                   mattr_accessor :available_macros
                   class << self
                     # Plugins can use this method to define new macros:
                     #
                     #   Redmine::WikiFormatting::Macros.register do
                     #     desc "This is my macro"
                     #     macro :my_macro do |obj, args|
                     #       "My macro output"
                     #     end
                     #
                     #     desc "This is my macro that accepts a block of text"
                     #     macro :my_macro do |obj, args, text|
                     #       "My macro output"
                     #     end
                     #   end
                     def register(&block)
                       class_eval(&block) if block_given?
                     end
                     # Defines a new macro with the given name, options and block.
                     #
                     # Options:
                     # * :desc - A description of the macro
                     # * :parse_args => false - Disables arguments parsing (the whole arguments
                     #   string is passed to the macro)
                     #
                     # Macro blocks accept 2 or 3 arguments:
                     # * obj: the object that is rendered (eg. an Issue, a WikiContent...)
                     # * args: macro arguments
                     # * text: the block of text given to the macro (should be present only if the
                     #   macro accepts a block of text). text is a String or nil if the macro is
                     #   invoked without a block of text.
                     #
                     # Examples:
                     # By default, when the macro is invoked, the coma separated list of arguments
                     # is split and passed to the macro block as an array. If no argument is given
                     # the macro will be invoked with an empty array:
                     #
                     #   macro :my_macro do |obj, args|
                     #     # args is an array
                     #     # and this macro do not accept a block of text
                     #   end
                     #
                     # You can disable arguments spliting with the :parse_args => false option. In
                     # this case, the full string of arguments is passed to the macro:
                     #
                     #   macro :my_macro, :parse_args => false do |obj, args|
                     #     # args is a string
                     #   end
                     #
                     # Macro can optionally accept a block of text:
                     #
                     #   macro :my_macro do |obj, args, text|
                     #     # this macro accepts a block of text
                     #   end
                     #
                     # Macros are invoked in formatted text using double curly brackets. Arguments
                     # must be enclosed in parenthesis if any. A new line after the macro name or the
                     # arguments starts the block of text that will be passe to the macro (invoking
                     # a macro that do not accept a block of text with some text will fail).
                     # Examples:
                     #
                     #   No arguments:
                     #   {{my_macro}}
                     #
                     #   With arguments:
                     #   {{my_macro(arg1, arg2)}}
                     #
                     #   With a block of text:
                     #   {{my_macro
                     #   multiple lines
                     #   of text
                     #   }}
                     #
                     #   With arguments and a block of text
                     #   {{my_macro(arg1, arg2)
                     #   multiple lines
                     #   of text
                     #   }}
                     #
                     # If a block of text is given, the closing tag }} must be at the start of a new line.
                     def macro(name, options={}, &block)
                       options.assert_valid_keys(:desc, :parse_args)
                       unless name.to_s.match(/\A\w+\z/)
                         raise "Invalid macro name: #{name} (only 0-9, A-Z, a-z and _ characters are accepted)"
                       end
                       unless block_given?
                         raise "Can not create a macro without a block!"
                       end
                       name = name.to_sym if name.is_a?(String)
                       available_macros[name] = {:desc => @@desc || ''}.merge(options)
                       @@desc = nil
                       Definitions.send :define_method, "macro_#{name}".downcase, &block
                     end
                     # Sets description for the next macro to be defined
                     def desc(txt)
                       @@desc = txt
                     end
                   end
                   # Builtin macros
                   desc "Sample macro."
                   macro :hello_world do |obj, args, text|
                     h("Hello world! Object: #{obj.class.name}, " +
                       (args.empty? ? "Called with no argument" : "Arguments: #{args.join(', ')}") +
                       " and " + (text.present? ? "a #{text.size} bytes long block of text." : "no block of text.")
                     )
                   end
                   desc "Displays a list of all available macros, including description if available."
                   macro :macro_list do |obj, args|
                     out = ''.html_safe
                     @@available_macros.each do |macro, options|
                       out << content_tag('dt', content_tag('code', macro.to_s))
                       out << content_tag('dd', textilizable(options[:desc]))
                     end
                     content_tag('dl', out)
                   end
                   desc "Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:\n\n" +
                          "  !{{child_pages}} -- can be used from a wiki page only\n" +
                          "  !{{child_pages(Foo)}} -- lists all children of page Foo\n" +
                          "  !{{child_pages(Foo, parent=1)}} -- same as above with a link to page Foo"
                   macro :child_pages do |obj, args|
                     args, options = extract_macro_options(args, :parent)
                     page = nil
                     if args.size > 0
                       page = Wiki.find_page(args.first.to_s, :project => @project)
                     elsif obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)
                       page = obj.page
                     else
                       raise 'With no argument, this macro can be called from wiki pages only.'
                     end
                     raise 'Page not found' if page.nil? || !User.current.allowed_to?(:view_wiki_pages, page.wiki.project)
                     pages = ([page] + page.descendants).group_by(&:parent_id)
                     render_page_hierarchy(pages, options[:parent] ? page.parent_id : page.id)
                   end
                   desc "Include a wiki page. Example:\n\n  !{{include(Foo)}}\n\nor to include a page of a specific project wiki:\n\n  !{{include(projectname:Foo)}}"
                   macro :include do |obj, args|
                     page = Wiki.find_page(args.first.to_s, :project => @project)
                     raise 'Page not found' if page.nil? || !User.current.allowed_to?(:view_wiki_pages, page.wiki.project)
                     @included_wiki_pages ||= []
                     raise 'Circular inclusion detected' if @included_wiki_pages.include?(page.title)
                     @included_wiki_pages << page.title
                     out = textilizable(page.content, :text, :attachments => page.attachments, :headings => false)
                     @included_wiki_pages.pop
                     out
                   end
                   desc "Displays a clickable thumbnail of an attached image. Examples:\n\n<pre>{{thumbnail(image.png)}}\n{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre>"
                   macro :thumbnail do |obj, args|
                     args, options = extract_macro_options(args, :size, :title)
                     filename = args.first
                     raise 'Filename required' unless filename.present?
                     size = options[:size]
                     raise 'Invalid size parameter' unless size.nil? || size.match(/^\d+$/)
                     size = size.to_i
                     size = nil unless size > 0
                     if obj && obj.respond_to?(:attachments) && attachment = Attachment.latest_attach(obj.attachments, filename)
                       title = options[:title] || attachment.title
                       img = image_tag(url_for(:controller => 'attachments', :action => 'thumbnail', :id => attachment, :size => size), :alt => attachment.filename)
                       link_to(img, url_for(:controller => 'attachments', :action => 'show', :id => attachment), :class => 'thumbnail', :title => title)
                     else
                       raise "Attachment #{filename} not found"
                     end
                   end
                 end
               end
             end

test/unit/lib/redmine/wiki_formatting/macros_test.rb +19 0

             # Redmine - project management software
             # Copyright (C) 2006-2012  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.expand_path('../../../../../test_helper', __FILE__)
             class Redmine::WikiFormatting::MacrosTest < ActionView::TestCase
               include ApplicationHelper
               include ActionView::Helpers::TextHelper
               include ActionView::Helpers::SanitizeHelper
               include ERB::Util
               extend ActionView::Helpers::SanitizeHelper::ClassMethods
               fixtures :projects, :roles, :enabled_modules, :users,
                                   :repositories, :changesets,
                                   :trackers, :issue_statuses, :issues,
                                   :versions, :documents,
                                   :wikis, :wiki_pages, :wiki_contents,
                                   :boards, :messages,
                                   :attachments
               def setup
                 super
                 @project = nil
               end
               def teardown
               end
               def test_macro_registration
                 Redmine::WikiFormatting::Macros.register do
                   macro :foo do |obj, args|
                     "Foo: #{args.size} (#{args.join(',')}) (#{args.class.name})"
                   end
                 end
                 assert_equal '<p>Foo: 0 () (Array)</p>', textilizable("{{foo}}")
                 assert_equal '<p>Foo: 0 () (Array)</p>', textilizable("{{foo()}}")
                 assert_equal '<p>Foo: 1 (arg1) (Array)</p>', textilizable("{{foo(arg1)}}")
                 assert_equal '<p>Foo: 2 (arg1,arg2) (Array)</p>', textilizable("{{foo(arg1, arg2)}}")
               end
               def test_macro_registration_parse_args_set_to_false_should_disable_arguments_parsing
                 Redmine::WikiFormatting::Macros.register do
                   macro :bar, :parse_args => false do |obj, args|
                     "Bar: (#{args}) (#{args.class.name})"
                   end
                 end
                 assert_equal '<p>Bar: (args, more args) (String)</p>', textilizable("{{bar(args, more args)}}")
                 assert_equal '<p>Bar: () (String)</p>', textilizable("{{bar}}")
                 assert_equal '<p>Bar: () (String)</p>', textilizable("{{bar()}}")
               end
               def test_macro_registration_with_3_args_should_receive_text_argument
                 Redmine::WikiFormatting::Macros.register do
                   macro :baz do |obj, args, text|
                     "Baz: (#{args.join(',')}) (#{text.class.name}) (#{text})"
                   end
                 end
                 assert_equal "<p>Baz: () (NilClass) ()</p>", textilizable("{{baz}}")
                 assert_equal "<p>Baz: () (NilClass) ()</p>", textilizable("{{baz()}}")
                 assert_equal "<p>Baz: () (String) (line1\nline2)</p>", textilizable("{{baz()\nline1\nline2\n}}")
                 assert_equal "<p>Baz: (arg1,arg2) (String) (line1\nline2)</p>", textilizable("{{baz(arg1, arg2)\nline1\nline2\n}}")
               end
               def test_multiple_macros_on_the_same_line
                 Redmine::WikiFormatting::Macros.macro :foo do |obj, args|
                   args.any? ? "args: #{args.join(',')}" : "no args"
                 end
                 assert_equal '<p>no args no args</p>', textilizable("{{foo}} {{foo}}")
                 assert_equal '<p>args: a,b no args</p>', textilizable("{{foo(a,b)}} {{foo}}")
                 assert_equal '<p>args: a,b args: c,d</p>', textilizable("{{foo(a,b)}} {{foo(c,d)}}")
                 assert_equal '<p>no args args: c,d</p>', textilizable("{{foo}} {{foo(c,d)}}")
               end
               def test_macro_should_receive_the_object_as_argument_when_with_object_and_attribute
                 issue = Issue.find(1)
                 issue.description = "{{hello_world}}"
                 assert_equal '<p>Hello world! Object: Issue, Called with no argument and no block of text.</p>', textilizable(issue, :description)
               end
               def test_macro_should_receive_the_object_as_argument_when_called_with_object_option
                 text = "{{hello_world}}"
                 assert_equal '<p>Hello world! Object: Issue, Called with no argument and no block of text.</p>', textilizable(text, :object => Issue.find(1))
               end
+              def test_extract_macro_options_should_with_args
+                options = extract_macro_options(["arg1", "arg2"], :foo, :size)
+                assert_equal([["arg1", "arg2"], {}], options)
+              end
+              def test_extract_macro_options_should_with_options
+                options = extract_macro_options(["foo=bar", "size=2"], :foo, :size)
+                assert_equal([[], {:foo => "bar", :size => "2"}], options)
+              end
+              def test_extract_macro_options_should_with_args_and_options
+                options = extract_macro_options(["arg1", "arg2", "foo=bar", "size=2"], :foo, :size)
+                assert_equal([["arg1", "arg2"], {:foo => "bar", :size => "2"}], options)
+              end
+              def test_extract_macro_options_should_parse_options_lazily
+                options = extract_macro_options(["params=x=1&y=2"], :params)
+                assert_equal([[], {:params => "x=1&y=2"}], options)
+              end
               def test_macro_exception_should_be_displayed
                 Redmine::WikiFormatting::Macros.macro :exception do |obj, args|
                   raise "My message"
                 end
                 text = "{{exception}}"
                 assert_include '<div class="flash error">Error executing the <strong>exception</strong> macro (My message)</div>', textilizable(text)
               end
               def test_macro_arguments_should_not_be_parsed_by_formatters
                 text = '{{hello_world(http://www.redmine.org, #1)}}'
                 assert_include 'Arguments: http://www.redmine.org, #1', textilizable(text)
               end
               def test_exclamation_mark_should_not_run_macros
                 text = "!{{hello_world}}"
                 assert_equal '<p>{{hello_world}}</p>', textilizable(text)
               end
               def test_exclamation_mark_should_escape_macros
                 text = "!{{hello_world(<tag>)}}"
                 assert_equal '<p>{{hello_world(&lt;tag&gt;)}}</p>', textilizable(text)
               end
               def test_unknown_macros_should_not_be_replaced
                 text = "{{unknown}}"
                 assert_equal '<p>{{unknown}}</p>', textilizable(text)
               end
               def test_unknown_macros_should_parsed_as_text
                 text = "{{unknown(*test*)}}"
                 assert_equal '<p>{{unknown(<strong>test</strong>)}}</p>', textilizable(text)
               end
               def test_unknown_macros_should_be_escaped
                 text = "{{unknown(<tag>)}}"
                 assert_equal '<p>{{unknown(&lt;tag&gt;)}}</p>', textilizable(text)
               end
               def test_html_safe_macro_output_should_not_be_escaped
                 Redmine::WikiFormatting::Macros.macro :safe_macro do |obj, args|
                   "<tag>".html_safe
                 end
                 assert_equal '<p><tag></p>', textilizable("{{safe_macro}}")
               end
               def test_macro_hello_world
                 text = "{{hello_world}}"
                 assert textilizable(text).match(/Hello world!/)
               end
               def test_macro_hello_world_should_escape_arguments
                 text = "{{hello_world(<tag>)}}"
                 assert_include 'Arguments: &lt;tag&gt;', textilizable(text)
               end
               def test_macro_macro_list
                 text = "{{macro_list}}"
                 assert_match %r{<code>hello_world</code>}, textilizable(text)
               end
               def test_macro_include
                 @project = Project.find(1)
                 # include a page of the current project wiki
                 text = "{{include(Another page)}}"
                 assert_include 'This is a link to a ticket', textilizable(text)
                 @project = nil
                 # include a page of a specific project wiki
                 text = "{{include(ecookbook:Another page)}}"
                 assert_include 'This is a link to a ticket', textilizable(text)
                 text = "{{include(ecookbook:)}}"
                 assert_include 'CookBook documentation', textilizable(text)
                 text = "{{include(unknowidentifier:somepage)}}"
                 assert_include 'Page not found', textilizable(text)
               end
               def test_macro_child_pages
                 expected =  "<p><ul class=\"pages-hierarchy\">\n" +
                              "<li><a href=\"/projects/ecookbook/wiki/Child_1\">Child 1</a></li>\n" +
                              "<li><a href=\"/projects/ecookbook/wiki/Child_2\">Child 2</a></li>\n" +
                              "</ul>\n</p>"
                 @project = Project.find(1)
                 # child pages of the current wiki page
                 assert_equal expected, textilizable("{{child_pages}}", :object => WikiPage.find(2).content)
                 # child pages of another page
                 assert_equal expected, textilizable("{{child_pages(Another_page)}}", :object => WikiPage.find(1).content)
                 @project = Project.find(2)
                 assert_equal expected, textilizable("{{child_pages(ecookbook:Another_page)}}", :object => WikiPage.find(1).content)
               end
               def test_macro_child_pages_with_option
                 expected =  "<p><ul class=\"pages-hierarchy\">\n" +
                              "<li><a href=\"/projects/ecookbook/wiki/Another_page\">Another page</a>\n" +
                              "<ul class=\"pages-hierarchy\">\n" +
                              "<li><a href=\"/projects/ecookbook/wiki/Child_1\">Child 1</a></li>\n" +
                              "<li><a href=\"/projects/ecookbook/wiki/Child_2\">Child 2</a></li>\n" +
                              "</ul>\n</li>\n</ul>\n</p>"
                 @project = Project.find(1)
                 # child pages of the current wiki page
                 assert_equal expected, textilizable("{{child_pages(parent=1)}}", :object => WikiPage.find(2).content)
                 # child pages of another page
                 assert_equal expected, textilizable("{{child_pages(Another_page, parent=1)}}", :object => WikiPage.find(1).content)
                 @project = Project.find(2)
                 assert_equal expected, textilizable("{{child_pages(ecookbook:Another_page, parent=1)}}", :object => WikiPage.find(1).content)
               end
               def test_macro_child_pages_without_wiki_page_should_fail
                 assert_match /can be called from wiki pages only/, textilizable("{{child_pages}}")
               end
               def test_macro_thumbnail
                 assert_equal '<p><a href="/attachments/17" class="thumbnail" title="testfile.PNG"><img alt="testfile.PNG" src="/attachments/thumbnail/17" /></a></p>',
                   textilizable("{{thumbnail(testfile.png)}}", :object => Issue.find(14))
               end
               def test_macro_thumbnail_with_size
                 assert_equal '<p><a href="/attachments/17" class="thumbnail" title="testfile.PNG"><img alt="testfile.PNG" src="/attachments/thumbnail/17/200" /></a></p>',
                   textilizable("{{thumbnail(testfile.png, size=200)}}", :object => Issue.find(14))
               end
               def test_macro_thumbnail_with_title
                 assert_equal '<p><a href="/attachments/17" class="thumbnail" title="Cool image"><img alt="testfile.PNG" src="/attachments/thumbnail/17" /></a></p>',
                   textilizable("{{thumbnail(testfile.png, title=Cool image)}}", :object => Issue.find(14))
               end
               def test_macro_thumbnail_with_invalid_filename_should_fail
                 assert_include 'test.png not found',
                   textilizable("{{thumbnail(test.png)}}", :object => Issue.find(14))
               end
               def test_macros_should_not_be_executed_in_pre_tags
                 text = <<-RAW
             {{hello_world(foo)}}
             <pre>
             {{hello_world(pre)}}
             !{{hello_world(pre)}}
             </pre>
             {{hello_world(bar)}}
             RAW
                 expected = <<-EXPECTED
             <p>Hello world! Object: NilClass, Arguments: foo and no block of text.</p>
             <pre>
             {{hello_world(pre)}}
             !{{hello_world(pre)}}
             </pre>
             <p>Hello world! Object: NilClass, Arguments: bar and no block of text.</p>
             EXPECTED
                 assert_equal expected.gsub(%r{[\r\n\t]}, ''), textilizable(text).gsub(%r{[\r\n\t]}, '')
               end
               def test_macros_should_be_escaped_in_pre_tags
                 text = "<pre>{{hello_world(<tag>)}}</pre>"
                 assert_equal "<pre>{{hello_world(&lt;tag&gt;)}}</pre>", textilizable(text)
               end
               def test_macros_should_not_mangle_next_macros_outputs
                 text = '{{macro(2)}} !{{macro(2)}} {{hello_world(foo)}}'
                 assert_equal '<p>{{macro(2)}} {{macro(2)}} Hello world! Object: NilClass, Arguments: foo and no block of text.</p>', textilizable(text)
               end
               def test_macros_with_text_should_not_mangle_following_macros
                 text = <<-RAW
             {{hello_world
             Line of text
             }}
             {{hello_world
             Another line of text
             }}
             RAW
                 expected = <<-EXPECTED
             <p>Hello world! Object: NilClass, Called with no argument and a 12 bytes long block of text.</p>
             <p>Hello world! Object: NilClass, Called with no argument and a 20 bytes long block of text.</p>
             EXPECTED
                 assert_equal expected.gsub(%r{[\r\n\t]}, ''), textilizable(text).gsub(%r{[\r\n\t]}, '')
               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