12522: Add constraint rejection messages to XLSForm export

app/models/forms/export.rb

@@ -69,13 +69,17 @@ def to_xls
       # Write sheet headings at row index 0
       questions.row(0).push("type")
 
-      # translation columns
       locales.each do |locale|
         questions.row(0).push("label::#{language_name(locale)} (#{locale})",
           "hint::#{language_name(locale)} (#{locale})")
       end
 
-      questions.row(0).push("name", "required", "relevant", "constraint", "choice_filter")
+      questions.row(0).push("name", "required", "relevant", "choice_filter", "constraint")
+
+      locales.each do |locale|
+        questions.row(0).push("constraint message::#{language_name(locale)} (#{locale})")
+      end
+
       settings.row(0).push("form_title", "form_id", "version", "default_language")
 
       group_depth = 1 # assume base level
@@ -141,6 +145,7 @@ def to_xls
           conditions_to_push = conditions_to_xls(q.display_conditions, q.display_if)
 
           constraints_to_push = ""
+          constraint_msg_to_push = Array.new(locales.length, "")
           q.constraints.each_with_index do |c, c_index|
             # constraint rules should be placed in parentheses and separated by "and"
             # https://docs.getodk.org/form-logic/#validating-and-restricting-responses
@@ -149,8 +154,20 @@ def to_xls
             # add "and" unless we're at the end
             constraints_to_push += " and " unless c_index + 1 == q.constraints.length
 
-            # TODO: add support for constraint messages ("rejection_msg" in NEMO)
+            # Write translated constraint message columns ("rejection_msg" in NEMO)
             # https://xlsform.org/en/#constraint-message
+            # NEMO allows multiple constraint messages for each rule, whereas XLSForm only supports one message per row.
+            # Thus, if there are multiple constraints or rules for this question, combine all provided messages into one string (per locale), separated by a semicolon
+            locales.each_with_index do |locale, locale_index|
+              # Attempt to get a message for that constraint for that language (may be nil if a translation is not provided)
+              constraint_message = c.rejection_msg_translations&.dig(locale.to_s)
+
+              if constraint_message.present?
+                constraint_msg_to_push[locale_index] += constraint_message
+                # Add semicolon concatenator, unless at the end
+                constraint_msg_to_push[locale_index] += "; " unless c_index + 1 == q.constraints.length
+              end
+            end
           end
 
           # if we have an option set, identify and save it so that we can add it to the choices sheet later.
@@ -187,7 +204,11 @@ def to_xls
                 end
 
                 questions.row(row_index + l_index).push(name_to_push,
-                  q.required.to_s, conditions_to_push, constraints_to_push, choice_filter)
+                  q.required.to_s, conditions_to_push, choice_filter, constraints_to_push)
+
+                constraint_msg_to_push.each do |message|
+                  questions.row(row_index + l_index).push(message)
+                end
 
                 # define the choice_filter cell for the following row, e.g, "state=${selected_state}"
                 choice_filter = "#{level_name}=${#{name_to_push}}"
@@ -207,7 +228,11 @@ def to_xls
                   q.question.hint_translations&.dig(locale.to_s))
               end
               questions.row(row_index).push(q.code, q.required.to_s,
-                conditions_to_push, constraints_to_push, choice_filter)
+                conditions_to_push, choice_filter, constraints_to_push)
+
+              constraint_msg_to_push.each do |message|
+                questions.row(row_index).push(message)
+              end
             end
           else # no option set present
             # Write the question row as normal
@@ -218,7 +243,11 @@ def to_xls
                 q.question.hint_translations&.dig(locale.to_s))
             end
             questions.row(row_index).push(q.code, q.required.to_s,
-              conditions_to_push, constraints_to_push, choice_filter)
+              conditions_to_push, choice_filter, constraints_to_push)
+
+            constraint_msg_to_push.each do |message|
+              questions.row(row_index).push(message)
+            end
           end
         end