Refactor ApplicationHelper#format_object to accept options as a hash (#39997).

Patch by Go MAEDA (user:maeda).


git-svn-id: https://svn.redmine.org/redmine/trunk@22933 e93f8b46-1217-0410-a6f0-8f06a7374b81

7 files changed, 25 insertions, 10 deletions

diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
index ea9bf8c52..f7b92a983 100644
--- a/app/helpers/application_helper.rb
+++ b/app/helpers/application_helper.rb
@@ -251,13 +251,28 @@ module ApplicationHelper
   end
 
   # Helper that formats object for html or text rendering
-  def format_object(object, html=true, &block)
+  # Options:
+  # * :html - If true, format the object as HTML (default: true)
+  def format_object(object, *args, &block)
+    options =
+      if args.first.is_a?(Hash)
+        args.first
+      elsif !args.empty?
+        # Support the old syntax `format_object(object, html_flag)`
+        # TODO: Display a deprecation warning in a future version, then remove this
+        {:html => args.first}
+      else
+        {}
+      end
+
+    html = options.fetch(:html, true)
+
     if block
       object = yield object
     end
     case object
     when Array
-      formatted_objects = object.map {|o| format_object(o, html)}
+      formatted_objects = object.map {|o| format_object(o, html: html)}
       html ? safe_join(formatted_objects, ', ') : formatted_objects.join(', ')
     when Time, ActiveSupport::TimeWithZone
       format_time(object)
@@ -302,7 +317,7 @@ module ApplicationHelper
         if f.nil? || f.is_a?(String)
           f
         else
-          format_object(f, html, &block)
+          format_object(f, html: html, &block)
         end
       else
         object.value.to_s
diff --git a/app/helpers/custom_fields_helper.rb b/app/helpers/custom_fields_helper.rb
index 2a188cd0a..a6149909d 100644
--- a/app/helpers/custom_fields_helper.rb
+++ b/app/helpers/custom_fields_helper.rb
@@ -164,12 +164,12 @@ module CustomFieldsHelper
 
   # Return a string used to display a custom value
   def show_value(custom_value, html=true)
-    format_object(custom_value, html)
+    format_object(custom_value, html: html)
   end
 
   # Return a string used to display a custom value
   def format_value(value, custom_field)
-    format_object(custom_field.format.formatted_value(self, custom_field, value, false), false)
+    format_object(custom_field.format.formatted_value(self, custom_field, value, false), html: false)
   end
 
   # Return an array of custom field formats which can be used in select_tag
diff --git a/app/helpers/queries_helper.rb b/app/helpers/queries_helper.rb
index 47f7db0f2..b5ce6addd 100644
--- a/app/helpers/queries_helper.rb
+++ b/app/helpers/queries_helper.rb
@@ -305,7 +305,7 @@ module QueriesHelper
     when :watcher_users
       value.to_a.join("\n")
     else
-      format_object(value, false) do |value|
+      format_object(value, html: false) do |value|
         case value.class.name
         when 'Float'
           sprintf("%.2f", value).gsub('.', l(:general_csv_decimal_separator))
diff --git a/app/helpers/roles_helper.rb b/app/helpers/roles_helper.rb
index f360c1176..9c56a6a74 100644
--- a/app/helpers/roles_helper.rb
+++ b/app/helpers/roles_helper.rb
@@ -35,7 +35,7 @@ module RolesHelper
           ]
           fields = names + roles.collect do |role|
             if role.setable_permissions.include?(p)
-              format_object(role.permissions.include?(p.name), false)
+              format_object(role.permissions.include?(p.name), html: false)
             else
               ''
             end
diff --git a/app/helpers/timelog_helper.rb b/app/helpers/timelog_helper.rb
index 17c903c9a..92104495c 100644
--- a/app/helpers/timelog_helper.rb
+++ b/app/helpers/timelog_helper.rb
@@ -84,7 +84,7 @@ module TimelogHelper
           "##{obj.id}"
         end
       else
-        format_object(obj, html)
+        format_object(obj, html: html)
       end
     elsif cf = criteria_options[:custom_field]
       format_value(value, cf)
diff --git a/lib/redmine/field_format.rb b/lib/redmine/field_format.rb
index 148cccadc..7d7fe42bc 100644
--- a/lib/redmine/field_format.rb
+++ b/lib/redmine/field_format.rb
@@ -250,7 +250,7 @@ module Redmine
         casted = cast_value(custom_field, value, customized)
         if html && custom_field.url_pattern.present?
           texts_and_urls = Array.wrap(casted).map do |single_value|
-            text = view.format_object(single_value, false).to_s
+            text = view.format_object(single_value, html: false).to_s
             url = url_from_pattern(custom_field, single_value, customized)
             [text, url]
           end
diff --git a/test/unit/lib/redmine/field_format/numeric_format_test.rb b/test/unit/lib/redmine/field_format/numeric_format_test.rb
index 9e624f309..db86a0f5c 100644
--- a/test/unit/lib/redmine/field_format/numeric_format_test.rb
+++ b/test/unit/lib/redmine/field_format/numeric_format_test.rb
@@ -56,7 +56,7 @@ class Redmine::NumericFieldFormatTest < ActionView::TestCase
     to_test = {'en' => '1234.56', 'de' => '1234,56'}
     to_test.each do |locale, expected|
       with_locale locale do
-        assert_equal expected, format_object(issue.reload.custom_field_values.last, false)
+        assert_equal expected, format_object(issue.reload.custom_field_values.last, html: false)
       end
     end
   end