jro_apps/redmine Commit - r9991:e2d6f0af4e49

Adds an option to macro definition to disable arguments parsing (#11578)....

Jean-Philippe Lang -

r9991:e2d6f0af4e49

parent child

Context file:

r9991:e2d6f0af4e49

Collapse all files

app/helpers/application_helper.rb +1 -2

               # Macros substitution
               def parse_macros(text, project, obj, attr, only_path, options)
                 text.gsub!(MACROS_RE) do
-                  esc, all, macro = $1, $2, $3.downcase
+                  esc, all, macro, args = $1, $2, $3.downcase, $5.to_s
-                  args = ($5 || '').split(',').each(&:strip)
                   if esc.nil?
                     begin
                       exec_macro(macro, obj, args)

lib/redmine/wiki_formatting/macros.rb +31 -7

                 module Macros
                   module Definitions
                     def exec_macro(name, obj, args)
+                      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
                       send(method_name, obj, args) if respond_to?(method_name)
                     end
                   end
                   @@available_macros = {}
+                  mattr_accessor :available_macros
                   class << self
                     # Called with a block to define additional macros.
                       class_eval(&block) if block_given?
                     end
-                  private
+                    # Defines a new macro with the given name, options and block.
-                    # Defines a new macro with the given name and block.
-                    def macro(name, &block)
+                    # Options:
+                    # * :parse_args => false - Disables arguments parsing (the whole arguments string
+                    #   is passed to the macro)
+                    #
+                    # Examples:
+                    # By default, when the macro is invoked, the coma separated list of arguments
+                    # is parsed and passed to the macro block as an array:
+                    #
+                    #   macro :my_macro do |obj, args|
+                    #     # args is an array
+                    #   end
+                    #
+                    # You can disable arguments parsing with the :parse_args => false option:
+                    #
+                    #   macro :my_macro, :parse_args => false do |obj, args|
+                    #     # args is a string
+                    #   end
+                    def macro(name, options={}, &block)
                       name = name.to_sym if name.is_a?(String)
-                      @@available_macros[name] = @@desc || ''
+                      @@available_macros[name] = {:desc => @@desc || ''}.merge(options)
                       @@desc = nil
                       raise "Can not create a macro without a block!" unless block_given?
                       Definitions.send :define_method, "macro_#{name}".downcase, &block
                   desc "Displays a list of all available macros, including description if available."
                   macro :macro_list do |obj, args|
                     out = ''.html_safe
-                    @@available_macros.keys.collect(&:to_s).sort.each do |macro|
+                    @@available_macros.each do |macro, options|
-                      out << content_tag('dt', content_tag('code', macro))
+                      out << content_tag('dt', content_tag('code', macro.to_s))
-                      out << content_tag('dd', textilizable(@@available_macros[macro.to_sym]))
+                      out << content_tag('dd', textilizable(options[:desc]))
                     end
                     content_tag('dl', out)
                   end

test/unit/lib/redmine/wiki_formatting/macros_test.rb +17 -3

@@ -43,12 +43,26 class Redmine::WikiFormatting::MacrosTest < ActionView::TestCase
43	def test_macro_registration	43	def test_macro_registration
44	Redmine::WikiFormatting::Macros.register do	44	Redmine::WikiFormatting::Macros.register do
45	macro :foo do \|obj, args\|	45	macro :foo do \|obj, args\|
46	"Foo macro output"	46	"Foo: #{args.size} (#{args.join(',')}) (#{args.class.name})"
47	end	47	end
48	end	48	end
49		49
50	text = "{{foo}}"	50	assert_equal '<p>Foo: 0 () (Array)</p>', textilizable("{{foo}}")
51	assert_equal '<p>Foo ~~macro output~~</p>', textilizable(~~text~~)	51	assert_equal '<p>Foo: 0 () (Array)</p>', textilizable("{{foo()}}")
		52	assert_equal '<p>Foo: 1 (arg1) (Array)</p>', textilizable("{{foo(arg1)}}")
		53	assert_equal '<p>Foo: 2 (arg1,arg2) (Array)</p>', textilizable("{{foo(arg1, arg2)}}")
		54	end
		55
		56	def test_macro_registration_parse_args_set_to_false_should_disable_arguments_parsing
		57	Redmine::WikiFormatting::Macros.register do
		58	macro :bar, :parse_args => false do \|obj, args\|
		59	"Bar: (#{args}) (#{args.class.name})"
		60	end
		61	end
		62
		63	assert_equal '<p>Bar: (args, more args) (String)</p>', textilizable("{{bar(args, more args)}}")
		64	assert_equal '<p>Bar: () (String)</p>', textilizable("{{bar}}")
		65	assert_equal '<p>Bar: () (String)</p>', textilizable("{{bar()}}")
52	end	66	end
53		67
54	def test_macro_hello_world	68	def test_macro_hello_world

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