Nanotone/overflow table layout (#21648)

* Refactor ExtrasGeneratorV2 to handle list-and-loops better

* Remove top_level_key from HashConverter specs

* Fix expand_collection tests

* Fix subquestion-sorting bug per code review

* Fix some merge conflicts

* Build out table layout for overflow page redesign

* Make 21-0781V2 overflow fixture more realistic for redesign layouting

* Update PDF test fixtures for old and new overflow pages

* Fix tests

* fix faling tests and add italic tag for no response text

* fix linting issue

---------

Co-authored-by: Yang Yang <yangyang@navapbc.com>

Author: asiisii

lib/pdf_fill/extras_generator_v2.rb

@@ -10,9 +10,10 @@ class ExtrasGeneratorV2 < ExtrasGenerator
     class Question
       attr_accessor :section_index, :overflow
 
-      def initialize(metadata)
+      def initialize(question_text, metadata)
         @section_index = nil
         @number = metadata[:question_num]
+        @text = question_text
         @subquestions = []
         @overflow = false
       end
@@ -28,50 +29,60 @@ def sorted_subquestions
         end
       end
 
-      def render(pdf, list_format: false)
-        sorted_subquestions.each do |subq|
-          value = subq[:value].to_s.gsub('\n', '<br/>')
+      def sorted_subquestions_markup
+        sorted_subquestions.map do |subq|
           metadata = subq[:metadata]
-          prefix = "#{metadata[:question_num]}#{metadata[:question_suffix]}. #{metadata[:question_text].humanize}"
-          i = metadata[:i]
-          prefix += " Line #{i + 1}" if i.present?
-
-          if list_format
-            pdf.markup("<p>#{prefix}: <b>#{value}</b></p>")
-          else
-            pdf.markup("<p>#{prefix}:</p>")
-            pdf.markup("<b>#{value}</b>")
-          end
+          label = metadata[:question_label].presence || metadata[:question_text]
+          value = subq[:value].to_s.gsub("\n", '<br/>')
+          value = "<i>#{value}</i>" if value == 'no response'
+          "<tr><td style='width:91'>#{label}:</td><td>#{value}</td></tr>"
         end
       end
+
+      def render(pdf, list_format: false)
+        pdf.markup("<h3>#{@number}. #{@text}</h3>") unless list_format
+        pdf.markup(['<table>', sorted_subquestions_markup, '</table>'].flatten.join, text: { margin_bottom: 10 })
+      end
     end
 
     class ListQuestion < Question
-      def initialize(metadata)
+      def initialize(question_text, metadata)
         super
+        @item_label = metadata[:item_label]
         @items = []
-        @array_question_text = metadata[:array_question_text]
       end
 
       def add_text(value, metadata)
         @overflow ||= metadata.fetch(:overflow, true)
         i = metadata[:i]
-        @items[i] ||= Question.new(metadata)
+        @items[i] ||= Question.new(nil, metadata)
         @items[i].add_text(value, metadata)
       end
 
       def render(pdf)
-        pdf.markup("<h4>#{@number}. #{@array_question_text}</h4>")
-        @items.each do |question|
+        pdf.markup("<h3>#{@number}. #{@text}</h3>")
+        @items.each.with_index(1) do |question, index|
+          pdf.markup(
+            "<table><tr><th><i>#{@item_label} #{index}</i></th></tr></table>",
+            table: {
+              cell: {
+                borders: [:bottom],
+                border_width: 1,
+                padding: [5, 0, 3.5, 0]
+              }
+            },
+            text: { margin_bottom: -2 }
+          )
           question.render(pdf, list_format: true)
         end
       end
     end
 
-    def initialize(form_name: nil, submit_date: nil, start_page: 1, sections: nil)
+    def initialize(form_name: nil, submit_date: nil, question_key: nil, start_page: 1, sections: nil)
       super()
       @form_name = form_name
       @submit_date = submit_date
+      @question_key = question_key
       @start_page = start_page
       @sections = sections
       @questions = {}
@@ -86,7 +97,8 @@ def set_font(pdf)
     def add_text(value, metadata)
       question_num = metadata[:question_num]
       if @questions[question_num].blank?
-        @questions[question_num] = (metadata[:i].blank? ? Question : ListQuestion).new(metadata)
+        question_text = @question_key[question_num]
+        @questions[question_num] = (metadata[:i].blank? ? Question : ListQuestion).new(question_text, metadata)
       end
       @questions[question_num].add_text(value, metadata)
     end
@@ -200,15 +212,18 @@ def register_source_sans_font(pdf)
 
     def set_markup_options(pdf)
       pdf.markup_options = {
-        heading2: { style: :normal, size: 13, margin_top: 12 },
-        heading3: { style: :bold, size: 10.5, margin_top: 10 },
-        heading4: { style: :normal, size: 10.5 },
+        heading2: { style: :normal, size: 13, margin_top: 12, margin_bottom: -4 },
+        heading3: { style: :bold, size: 10.5, margin_top: 10, margin_bottom: -2 },
         table: {
           cell: {
             border_width: 0,
-            padding: [2, 0, 2, 0]
+            padding: [1, 0, 1, 0]
           }
         },
+        text: {
+          leading: 0.5,
+          size: 10.5
+        },
         list: { bullet: { char: '✓', margin: 0 }, content: { margin: 4 }, vertical_margin: 0 }
       }
     end

lib/pdf_fill/filler.rb

@@ -176,6 +176,7 @@ def make_hash_converter(form_id, form_class, submit_date, fill_options)
           ExtrasGeneratorV2.new(
             form_name: form_id.sub(/V2\z/, ''),
             submit_date:,
+            question_key: form_class::QUESTION_KEY,
             start_page: form_class::START_PAGE,
             sections: form_class::SECTIONS
           )

lib/pdf_fill/forms/form_base.rb

@@ -9,6 +9,7 @@ class FormBase
 
       START_PAGE = 1
       SECTIONS = nil
+      QUESTION_KEY = nil
 
       def self.date_strftime
         '%m/%d/%Y'

lib/pdf_fill/forms/va210781v2.rb

@@ -22,20 +22,23 @@ class Va210781v2 < FormBase
             limit: 12, # limit: 28 (with combs removed)
             question_num: 1,
             question_suffix: 'A',
+            question_label: 'First',
             question_text: 'VETERAN/SERVICE MEMBER\'S NAME. First Name'
           },
           'middleInitial' => {
             key: 'F[0].#subform[2].VeteransMiddleInitial1[0]',
             limit: 1,
             question_num: 1,
             question_suffix: 'B',
+            question_label: 'Middle Initial',
             question_text: 'VETERAN/SERVICE MEMBER\'S NAME. Middle Initial'
           },
           'last' => {
             key: 'F[0].#subform[2].VeteransLastName[0]',
             limit: 18, # limit: 45 (with combs removed)
             question_num: 1,
             question_suffix: 'C',
+            question_label: 'Last',
             question_text: 'VETERAN/SERVICE MEMBER\'S NAME. Last Name'
           }
         },
@@ -143,6 +146,7 @@ class Va210781v2 < FormBase
         'events' => {
           limit: 6,
           first_key: 'details',
+          item_label: 'Event',
           question_text: 'Traumatic event(s) information',
           question_num: 9,
           'details' => {
@@ -538,6 +542,7 @@ class Va210781v2 < FormBase
         'treatmentProvidersDetails' => {
           limit: 3,
           first_key: 'facilityInfo',
+          item_label: 'Treatment facility',
           question_text: 'TREATMENT INFORMATION',
           question_num: 13,
           'facilityInfo' => {
@@ -628,39 +633,48 @@ class Va210781v2 < FormBase
       }.freeze
       # rubocop:enable Layout/LineLength
 
+      QUESTION_KEY = {
+        1 => 'Veteran/Service member\'s name',
+        2 => 'Social security number',
+        3 => 'VA file number',
+        4 => 'Date of birth',
+        5 => 'Veteran\'s service number',
+        6 => 'Telephone number',
+        7 => 'Email address',
+        8 => 'Type of in-service traumatic event(s)',
+        9 => 'Traumatic event(s) information',
+        10 => 'Behavioral Changes Following In-service Personal Traumatic Event(s)',
+        11 => 'Was an official report filed?',
+        12 => 'Possible sources of evidence following the traumatic event(s)',
+        13 => 'Treatment information',
+        14 => 'Remarks',
+        16 => 'Veteran/service member\'s signature'
+      }.freeze
+
       SECTIONS = [
         {
           label: 'Section I: Veteran\'s Identification Information',
-          question_nums: (1..7).to_a,
-          top_level_keys: %w[
-            veteranFullName vaFileNumber veteranDateOfBirth veteranServiceNumber veteranPhone veteranIntPhone
-            email emailOverflow
-          ]
+          question_nums: (1..7).to_a
         },
         {
           label: 'Section II: Traumatic Event(s) Information',
-          question_nums: [8, 9],
-          top_level_keys: ['events']
+          question_nums: [8, 9]
         },
         {
           label: 'Section III: Additional Information Associated with the In-service Traumatic Event(s)',
-          question_nums: [10, 11, 12],
-          top_level_keys: %w[behaviors behaviorsDetails reportsDetails evidence]
+          question_nums: [10, 11, 12]
         },
         {
           label: 'Section IV: Treatment Information',
-          question_nums: [13],
-          top_level_keys: ['treatmentProvidersDetails']
+          question_nums: [13]
         },
         {
           label: 'Section V: Remarks',
-          question_nums: [14],
-          top_level_keys: %w[additionalInformation additionalInformationOverflow]
+          question_nums: [14]
         },
         {
           label: 'Section VII: Certification and Signature',
-          question_nums: [15],
-          top_level_keys: %w[signature signatureDate]
+          question_nums: [15]
         }
       ].freeze
 

lib/pdf_fill/hash_converter.rb

@@ -64,16 +64,16 @@ def overflow?(key_data, value, from_array_overflow = false)
 
     def add_to_extras(key_data, v, i, overflow: true, array_key_data: nil)
       return if v.blank? || key_data.nil?
-      return if key_data[:question_num].blank? || key_data[:question_text].blank?
+      return if key_data[:question_num].blank? || (key_data[:question_text].blank? && key_data[:question_label].blank?)
 
       i = nil if key_data[:skip_index]
       v = "$#{v}" if key_data[:dollar]
       v = v.extras_value if v.is_a?(PdfFill::FormValue)
-      array_question_text = array_key_data.try(:[], :question_text)
+      item_label = array_key_data.try(:[], :item_label)
       @extras_generator.add_text(
         v,
-        key_data.slice(:question_num, :question_suffix, :question_text).merge(
-          i:, overflow:, array_question_text:
+        key_data.slice(:question_num, :question_suffix, :question_text, :question_label).merge(
+          i:, overflow:, item_label:
         )
       )
     end

spec/fixtures/pdf_fill/21-0781V2/overflow.json

@@ -2,9 +2,9 @@
   "vaFileNumber": "12345678",
   "veteranSocialSecurityNumber": "123456789",
   "veteranFullName": {
-    "first": "XXXXXXXXXXXXX",
-    "middle": "Tester",
-    "last": "XXXXXXXXXXXXXXXXXX"
+    "first": "Laura",
+    "middle": "J",
+    "last": "Rodriguez-Wittgenstein"
   },
   "veteranDateOfBirth": "1981-11-05",
   "veteranServiceNumber": "987654321",
@@ -20,8 +20,8 @@
   },
   "events": [
     {
-      "details": "Lorem ipsum dolor sit amet.",
-      "location": "abcdefghijklmn opqrstuvwxyz1234a bpqrstuvwxyz1234a",
+      "details": "Corpsman on medical ship in Da Nang harbor, Vietnam",
+      "location": "Stationed on U.S.S. XYZ",
       "timing": "Summer of '70",
       "otherReports": { "police": true },
       "agency": "SVI",
@@ -31,15 +31,15 @@
       "country": "USA"
     },
     {
-      "details": "Lorem ipsum dolor sit amet.",
-      "location": "abcdefghijklmn opqrstuvwxyz1234a bpqrstuvwxyz1234a",
+      "details": "Mugged",
+      "location": "Back alley in Big Town, USA",
       "timing": "June 2007",
       "unlistedReport": "incident report"
     },
     {
-      "details": "Lorem ipsum dolor sit amet..",
-      "location": "abcdefghijklmn opqrstuvwxyz1234a bpqrstuvwxyz1234a",
-      "timing": "February 14, 2020",
+      "details": "I would be minding my own business and this other soldier would use his rank to force me to do push ups and sit ups and other stuff even when we were off duty.\nIf I refused the next day would be worse during work hours and he would like to the chain of command that I had done something wrong. He would harass and belittle me. I tried to tell someone but nobody cared, I would just get in more trouble.",
+      "location": "Fort Belvior, VA",
+      "timing": "June 2007",
       "militaryReports": { "restricted": true }
     },
     {
@@ -124,6 +124,7 @@
       "noDates": true
     }
   ],
+  "additionalInformation": "The traumatic event I experienced during my service has had a profound and lasting impact on my mental health. Since the incident, I have struggled with symptoms of Post-Traumatic Stress Disorder (PTSD), depression, and anxiety, which have significantly affected my daily life and well-being.\nAfter the event, I began to notice intense feelings of fear and helplessness whenever I was reminded of the experience. These flashbacks were frequent and uncontrollable, often triggered by loud noises, crowded places, or even certain smells. The emotional distress caused by these flashbacks would leave me feeling overwhelmed, panicked, and unable to function. At times, it felt as though I was reliving the traumatic experience, and I had difficulty distinguishing the past from the present.\nI also developed chronic insomnia. I found it difficult to fall asleep, and when I did manage to sleep, I was frequently awakened by nightmares of the traumatic event. These disturbed nights left me feeling exhausted and unable to perform basic tasks during the day. The lack of rest contributed to a decline in my physical health, as I struggled with fatigue, headaches, and an overall sense of lethargy.\nSocially, I became increasingly withdrawn. I avoided interactions with friends, family, and even fellow service members, as I felt disconnected and unable to trust anyone. My relationships suffered as I became irritable, short-tempered, and emotionally distant. I found it hard to experience joy or satisfaction in anything, including activities I once enjoyed, such as hobbies and socializing.\nLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
   "optionIndicator": "notEnrolled",
   "signatureDate": "2016-01-31"
 }

spec/fixtures/pdf_fill/21-0781V2/overflow.pdf

@@ -10,7 +10,7 @@
 
   describe PdfFill::ExtrasGeneratorV2::Question do
     subject do
-      question = described_class.new(add_text_calls.first[1])
+      question = described_class.new('First name', add_text_calls.first[1])
       add_text_calls.each { |call| question.add_text(*call) }
       question
     end
@@ -47,7 +47,7 @@
     end
 
     it 'populates section indices correctly' do
-      questions = [1, 9, 42, 7].index_with { |question_num| described_class::Question.new(question_num:) }
+      questions = [1, 9, 42, 7].index_with { |question_num| described_class::Question.new(nil, question_num:) }
       subject.instance_variable_set(:@questions, questions)
       subject.populate_section_indices!
       indices = subject.instance_variable_get(:@questions).values.map(&:section_index)