Add section headers to PDF overflow page (#20894)

nanotone · web-flow · commit c30771c72ac8 · 2025-03-03T11:03:55.000-05:00
* Add section headers to PDF overflow page

* Fix rubocop complaints

* Fix test regressions

* Consolidate calculation of section index

* Add unit test for HashConverter top_level_key logic

* Add new test for sorting questions by section index

* Fix rubocop complaints

* Add new test for populate_section_indices

* Revert some unnecessary reformatting

* Nevermind, collapse this call after all for method length
diff --git a/lib/pdf_fill/extras_generator.rb b/lib/pdf_fill/extras_generator.rb
@@ -4,11 +4,12 @@ module PdfFill
   class ExtrasGenerator
     attr_reader :extras_redesign
 
-    def initialize(form_name: nil, extras_redesign: false, start_page: 1)
+    def initialize(extras_redesign: false, form_name: nil, start_page: 1, sections: nil)
       @generate_blocks = []
       @form_name = form_name
       @extras_redesign = extras_redesign
       @start_page = start_page
+      @sections = sections
     end
 
     def create_block(value, metadata)
@@ -26,7 +27,7 @@ def create_block(value, metadata)
     end
 
     def add_text(value, metadata)
-      unless text?
+      unless text? || extras_redesign
         @generate_blocks << {
           metadata: {},
           block: lambda do |pdf|
@@ -45,10 +46,22 @@ def text?
       @generate_blocks.size.positive?
     end
 
+    def populate_section_indices!
+      return if @sections.blank?
+
+      @generate_blocks.each do |generate_block|
+        metadata = generate_block[:metadata]
+        if metadata[:top_level_key].present?
+          metadata[:section_index] = @sections.index { |sec| sec[:top_level_keys].include?(metadata[:top_level_key]) }
+        end
+      end
+    end
+
     def sort_generate_blocks
       @generate_blocks.sort_by do |generate_block|
         metadata = generate_block[:metadata]
         [
+          metadata[:section_index] || -1,
           metadata[:question_num] || -1,
           metadata[:i] || 99_999,
           metadata[:question_suffix] || '',
@@ -101,14 +114,27 @@ def generate_pdf(file_path, generate_blocks)
       end
     end
 
+    def render_new_section(pdf, section_index)
+      return unless @extras_redesign && @sections.present?
+
+      pdf.move_down(20)
+      pdf.text(@sections[section_index][:label], { size: 14 })
+    end
+
     def render_pdf_content(pdf, generate_blocks)
+      current_section_index = nil
       box_height = 25
       pdf.bounding_box(
         [pdf.bounds.left, pdf.bounds.top - box_height],
         width: pdf.bounds.width,
         height: pdf.bounds.height - box_height
       ) do
         generate_blocks.each do |block|
+          section_index = block[:metadata][:section_index]
+          if section_index.present? && section_index != current_section_index
+            render_new_section(pdf, section_index)
+            current_section_index = section_index
+          end
           block[:block].call(pdf)
         end
       end
@@ -118,6 +144,7 @@ def generate
       folder = 'tmp/pdfs'
       FileUtils.mkdir_p(folder)
       file_path = "#{folder}/extras_#{SecureRandom.uuid}.pdf"
+      populate_section_indices!
       generate_blocks = sort_generate_blocks
       generate_pdf(file_path, generate_blocks)
       file_path
diff --git a/lib/pdf_fill/filler.rb b/lib/pdf_fill/filler.rb
@@ -138,10 +138,12 @@ def process_form(form_id, form_data, form_class, file_name_extension, fill_optio
       folder = 'tmp/pdfs'
       FileUtils.mkdir_p(folder)
       file_path = "#{folder}/#{form_id}_#{file_name_extension}.pdf"
-      start_page = form_class.const_defined?(:START_PAGE) ? form_class::START_PAGE : 1
-      hash_converter = HashConverter.new(form_id.sub(/V2\z/, ''), form_class.date_strftime,
-                                         fill_options.fetch(:extras_redesign, false), start_page)
-
+      extras_generator = ExtrasGenerator.new(
+        extras_redesign: fill_options.fetch(:extras_redesign, false),
+        form_name: form_id.sub(/V2\z/, ''),
+        start_page: form_class::START_PAGE, sections: form_class::SECTIONS
+      )
+      hash_converter = HashConverter.new(form_class.date_strftime, extras_generator)
       new_hash = hash_converter.transform_data(
         form_data: form_class.new(form_data).merge_fields(fill_options),
         pdftk_keys: form_class::KEY
@@ -151,10 +153,7 @@ def process_form(form_id, form_data, form_class, file_name_extension, fill_optio
       template_path = has_template ? form_class::TEMPLATE : "lib/pdf_fill/forms/pdfs/#{form_id}.pdf"
 
       (form_id == SavedClaim::CaregiversAssistanceClaim::FORM ? UNICODE_PDF_FORMS : PDF_FORMS).fill_form(
-        template_path,
-        file_path,
-        new_hash,
-        flatten: Rails.env.production?
+        template_path, file_path, new_hash, flatten: Rails.env.production?
       )
 
       combine_extras(file_path, hash_converter.extras_generator)
diff --git a/lib/pdf_fill/forms/form_base.rb b/lib/pdf_fill/forms/form_base.rb
@@ -7,6 +7,9 @@ module Forms
     class FormBase
       attr_reader :form_data
 
+      START_PAGE = 1
+      SECTIONS = nil
+
       def self.date_strftime
         '%m/%d/%Y'
       end
diff --git a/lib/pdf_fill/forms/va210781v2.rb b/lib/pdf_fill/forms/va210781v2.rb
@@ -615,6 +615,36 @@ class Va210781v2 < FormBase
       }.freeze
       # rubocop:enable Layout/LineLength
 
+      SECTIONS = [
+        {
+          label: 'Section I: Veteran\'s Identification Information',
+          top_level_keys: %w[
+            veteranFullName vaFileNumber veteranDateOfBirth veteranServiceNumber veteranPhone veteranIntPhone
+            email emailOverflow
+          ]
+        },
+        {
+          label: 'Section II: Traumatic Event(s) Information',
+          top_level_keys: ['events']
+        },
+        {
+          label: 'Section III: Additional Information Associated with the In-service Traumatic Event(s)',
+          top_level_keys: %w[workBehaviors healthBehaviors otherBehaviors behaviorsDetails reportsDetails evidence]
+        },
+        {
+          label: 'Section IV: Treatment Information',
+          top_level_keys: ['treatmentProvidersDetails']
+        },
+        {
+          label: 'Section V: Remarks',
+          top_level_keys: %w[additionalInformation additionalInformationOverflow]
+        },
+        {
+          label: 'Section VII: Certification and Signature',
+          top_level_keys: %w[signature signatureDate]
+        }
+      ].freeze
+
       def merge_fields(_options = {})
         @form_data['veteranFullName'] = extract_middle_i(@form_data, 'veteranFullName')
         @form_data = expand_ssn(@form_data)
diff --git a/lib/pdf_fill/hash_converter.rb b/lib/pdf_fill/hash_converter.rb
@@ -11,10 +11,10 @@ class HashConverter
 
     attr_reader :extras_generator
 
-    def initialize(form_name, date_strftime, extras_redesign = false, start_page = 1)
+    def initialize(date_strftime, extras_generator)
       @pdftk_form = {}
       @date_strftime = date_strftime
-      @extras_generator = ExtrasGenerator.new(form_name:, extras_redesign:, start_page:)
+      @extras_generator = extras_generator
     end
 
     def convert_value(v, key_data, is_overflow = false)
@@ -63,7 +63,7 @@ def overflow?(key_data, value, from_array_overflow = false)
       limit.present? && value.size > limit
     end
 
-    def add_to_extras(key_data, v, i)
+    def add_to_extras(key_data, v, i, top_level_key)
       return if v.blank?
       return if key_data.try(:[], :question_text).blank?
 
@@ -73,25 +73,25 @@ def add_to_extras(key_data, v, i)
       @extras_generator.add_text(
         v,
         key_data.slice(:question_num, :question_suffix, :question_text).merge(
-          i:
+          i:, top_level_key:
         )
       )
     end
 
-    def add_array_to_extras(arr, pdftk_keys)
+    def add_array_to_extras(arr, pdftk_keys, top_level_key)
       arr.each_with_index do |v, i|
         i = nil if pdftk_keys[:always_overflow]
         if v.is_a?(Hash)
           v.each do |key, val|
-            add_to_extras(pdftk_keys[key], convert_value(val, pdftk_keys[key], true), i)
+            add_to_extras(pdftk_keys[key], convert_value(val, pdftk_keys[key], true), i, top_level_key)
           end
         else
-          add_to_extras(pdftk_keys, convert_value(v, pdftk_keys, true), i)
+          add_to_extras(pdftk_keys, convert_value(v, pdftk_keys, true), i, top_level_key)
         end
       end
     end
 
-    def set_value(v, key_data, i, from_array_overflow = false)
+    def set_value(v, key_data, i, from_array_overflow = false, top_level_key = nil)
       k = key_data[:key]
       return if k.blank?
 
@@ -100,7 +100,7 @@ def set_value(v, key_data, i, from_array_overflow = false)
       new_value = convert_value(v, key_data)
 
       if overflow?(key_data, new_value, from_array_overflow)
-        add_to_extras(key_data, new_value, i)
+        add_to_extras(key_data, new_value, i, top_level_key)
 
         new_value = EXTRAS_TEXT
       end
@@ -123,7 +123,7 @@ def check_for_overflow(arr, pdftk_keys)
       false
     end
 
-    def transform_array(form_data, pdftk_keys)
+    def transform_array(form_data, pdftk_keys, top_level_key)
       has_overflow = check_for_overflow(form_data, pdftk_keys)
 
       if has_overflow
@@ -133,34 +133,36 @@ def transform_array(form_data, pdftk_keys)
           form_data: { first_key => EXTRAS_TEXT },
           pdftk_keys:,
           i: 0,
-          from_array_overflow: true
+          from_array_overflow: true,
+          top_level_key:
         )
 
-        add_array_to_extras(form_data, pdftk_keys)
+        add_array_to_extras(form_data, pdftk_keys, top_level_key)
       else
         form_data.each_with_index do |v, idx|
-          transform_data(form_data: v, pdftk_keys:, i: idx)
+          transform_data(form_data: v, pdftk_keys:, i: idx, top_level_key:)
         end
       end
     end
 
-    def transform_data(form_data:, pdftk_keys:, i: nil, from_array_overflow: false)
+    def transform_data(form_data:, pdftk_keys:, i: nil, from_array_overflow: false, top_level_key: nil)
       return if form_data.nil? || pdftk_keys.nil?
 
       case form_data
       when Array
-        transform_array(form_data, pdftk_keys)
+        transform_array(form_data, pdftk_keys, top_level_key)
       when Hash
         form_data.each do |k, v|
           transform_data(
             form_data: v,
             pdftk_keys: pdftk_keys[k],
             i:,
-            from_array_overflow:
+            from_array_overflow:,
+            top_level_key: top_level_key || k
           )
         end
       else
-        set_value(form_data, pdftk_keys, i, from_array_overflow)
+        set_value(form_data, pdftk_keys, i, from_array_overflow, top_level_key)
       end
 
       @pdftk_form
diff --git a/spec/fixtures/pdf_fill/21-0781V2/overflow_redesign_extras.pdf b/spec/fixtures/pdf_fill/21-0781V2/overflow_redesign_extras.pdf
diff --git a/spec/lib/pdf_fill/extras_generator_spec.rb b/spec/lib/pdf_fill/extras_generator_spec.rb
@@ -4,13 +4,38 @@
 require 'pdf_fill/extras_generator'
 
 describe PdfFill::ExtrasGenerator do
-  subject do
-    described_class.new
+  subject { described_class.new(sections:) }
+
+  let(:sections) { nil }
+
+  describe '#populate_section_indices!' do
+    let(:sections) do
+      [
+        {
+          label: 'Section I',
+          top_level_keys: %w[veteranFullName vaFileNumber veteranDateOfBirth]
+        },
+        {
+          label: 'Section II',
+          top_level_keys: ['events']
+        }
+      ]
+    end
+
+    it 'populates section indices correctly' do
+      blocks = %w[veteranFullName events evidence vaFileNumber].map do |top_level_key|
+        { metadata: { top_level_key: } }
+      end
+      subject.instance_variable_set(:@generate_blocks, blocks)
+      subject.populate_section_indices!
+      indices = subject.instance_variable_get(:@generate_blocks).map { |block| block[:metadata][:section_index] }
+      expect(indices).to eq([0, 1, nil, 0])
+    end
   end
 
   describe '#sort_generate_blocks' do
-    it 'sorts the blocks correctly' do
-      metadatas = [
+    let(:metadatas) do
+      [
         {
           question_num: 1
         },
@@ -41,7 +66,9 @@
           question_suffix: 'B'
         }
       ]
+    end
 
+    it 'sorts the blocks correctly' do
       subject.instance_variable_set(:@generate_blocks, metadatas.reverse.map do |metadata|
         {
           metadata:
@@ -52,6 +79,26 @@
         expect(generate_block[:metadata]).to eq(metadatas[i])
       end
     end
+
+    context 'when section metadata is provided' do
+      let(:metadatas) do
+        [
+          { section_index: 0, question_num: 2, question_suffix: 'A', question_text: 'First Name' },
+          { section_index: 0, question_num: 2, question_suffix: 'B', question_text: 'Last Name' },
+          { section_index: 0, question_num: 3, question_text: 'Email Address' },
+          { section_index: 1, question_num: 1, question_text: 'Remarks' },
+          { section_index: 1, question_num: 4, question_text: 'Additional Remarks' }
+        ]
+      end
+
+      it 'sorts the blocks correctly, even if question numbers are jumbled' do
+        subject.instance_variable_set(:@generate_blocks, metadatas.reverse.map { |metadata| { metadata: } })
+
+        subject.sort_generate_blocks.each_with_index do |generate_block, i|
+          expect(generate_block[:metadata]).to eq(metadatas[i])
+        end
+      end
+    end
   end
 
   describe '#generate' do
diff --git a/spec/lib/pdf_fill/hash_converter_spec.rb b/spec/lib/pdf_fill/hash_converter_spec.rb
