Improve readability

app/helpers/formatting_helper.rb

@@ -1,13 +1,16 @@
 module FormattingHelper
-  def ensure_punctuation(value)
+  def format_ending(value)
     return value if value.blank?
 
-    value.match?(/[[:punct:]]\z/) && !value.match?(/[%(){}\[\]]\z/) ? value : "#{value}."
+    ends_with_any_punctuation = value.match?(/[[:punct:]]\z/)
+    ends_with_special_char = value.match?(/[%(){}\[\]]\z/)
+
+    ends_with_any_punctuation && !ends_with_special_char ? value : "#{value}."
   end
 
-  def downcase_first_letter(sentence)
+  def downcase_first_letter(text)
-    return sentence if sentence.blank?
+    return text if text.blank?
 
-    sentence[0].downcase + sentence[1..]
+    text[0].downcase + text[1..]
   end
 end

app/models/form/question.rb

@@ -207,7 +207,7 @@ class Form::Question
 
   def error_display_label
     label = error_label || check_answer_label || header || id.humanize
-    ensure_punctuation(label)
+    format_ending(label)
   end
 
   def unanswered_error_message

app/services/bulk_upload/lettings/year2023/row_parser.rb

@@ -544,9 +544,9 @@ private
 
       fields.each do |field|
         if setup_question?(question)
-          errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))), category: :setup)
+          errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))), category: :setup)
         else
-          errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))))
+          errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))))
         end
       end
     end
@@ -1608,7 +1608,7 @@ private
     field_127.present? ? 1 : 0
   end
 
-  def downcase(sentence)
+  def downcase(text)
-    downcase_first_letter(sentence)
+    downcase_first_letter(text)
   end
 end

app/services/bulk_upload/lettings/year2024/row_parser.rb

@@ -568,9 +568,9 @@ private
 
       fields.each do |field|
         if setup_question?(question)
-          errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))), category: :setup)
+          errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))), category: :setup)
         else
-          errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))))
+          errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))))
         end
       end
     end
@@ -1643,7 +1643,7 @@ private
     Organisation.find(bulk_upload.organisation_id)
   end
 
-  def downcase(sentence)
+  def downcase(text)
-    downcase_first_letter(sentence)
+    downcase_first_letter(text)
   end
 end

app/services/bulk_upload/sales/year2023/row_parser.rb

@@ -1271,13 +1271,13 @@ private
         fields.each do |field|
           if errors[field].none?
             block_log_creation!
-            errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))), category: :setup)
+            errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))), category: :setup)
           end
         end
       else
         fields.each do |field|
           unless errors.any? { |e| fields.include?(e.attribute) }
-            errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))))
+            errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))))
           end
         end
       end
@@ -1336,7 +1336,7 @@ private
     end
   end
 
-  def downcase(sentence)
+  def downcase(text)
-    downcase_first_letter(sentence)
+    downcase_first_letter(text)
   end
 end

app/services/bulk_upload/sales/year2024/row_parser.rb

@@ -1407,13 +1407,13 @@ private
         fields.each do |field|
           if errors[field].none?
             block_log_creation!
-            errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))), category: :setup)
+            errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))), category: :setup)
           end
         end
       else
         fields.each do |field|
           unless errors.any? { |e| fields.include?(e.attribute) }
-            errors.add(field, I18n.t("validations.invalid_option", question: ensure_punctuation(downcase(QUESTIONS[field]))))
+            errors.add(field, I18n.t("validations.invalid_option", question: format_ending(downcase(QUESTIONS[field]))))
           end
         end
       end
@@ -1510,7 +1510,7 @@ private
     Organisation.find(bulk_upload.organisation_id)
   end
 
-  def downcase(sentence)
+  def downcase(text)
-    downcase_first_letter(sentence)
+    downcase_first_letter(text)
   end
 end