🎨 update and improve rST output of documents (#22)

Author: ianardee

lib/mindee/parsing/prediction/common_fields/locale.rb

@@ -20,7 +20,7 @@ class Locale
     attr_reader :value
 
     # @param prediction [Hash]
-    def initialize(prediction)
+    def initialize(prediction, _page_id = nil)
       value_key = if prediction.include? 'value'
                     'value'
                   else

lib/mindee/parsing/prediction/eu/license_plate/license_plate_v1.rb

@@ -6,9 +6,9 @@
 module Mindee
   module Prediction
     module EU
-      # License plate prediction.
+      # License Plate v1 prediction results.
       class LicensePlateV1 < Prediction
-        # A list of license plates.
+        # List of all license plates found in the image.
         # @return [Array<Mindee::TextField>]
         attr_reader :license_plates
 
@@ -23,9 +23,9 @@ def initialize(prediction, page_id)
         end
 
         def to_s
-          license_plates = @license_plates.map(&:value).join(', ')
+          license_plates = @license_plates.join("\n #{' ' * 16}")
           out_str = String.new
-          out_str << "\n:License plates: #{license_plates}".rstrip
+          out_str << "\n:License Plates: #{license_plates}".rstrip
           out_str[1..].to_s
         end
       end

lib/mindee/parsing/prediction/financial_document/financial_document_v1.rb

@@ -2,7 +2,7 @@
 
 require_relative '../common_fields'
 require_relative '../base'
-require_relative 'invoice_line_item'
+require_relative 'line_item'
 
 module Mindee
   module Prediction
@@ -60,7 +60,7 @@ class FinancialDocumentV1 < Prediction
       # @return [Array<Mindee::CompanyRegistration>]
       attr_reader :supplier_company_registrations
       # Line items details.
-      # @return [Array<Mindee::InvoiceLineItem>]
+      # @return [Array<Mindee::FinancialDocumentLineItem>]
       attr_reader :line_items
       # Time as seen on the receipt in HH:MM format.
       # @return [Mindee::TextField]
@@ -83,7 +83,6 @@ class FinancialDocumentV1 < Prediction
       # @param page_id [Integer, nil]
       def initialize(prediction, page_id) # rubocop:todo Metrics/AbcSize
         super
-
         @time = TextField.new(prediction['time'], page_id)
         @category = TextField.new(prediction['category'], page_id)
         @subcategory = TextField.new(prediction['subcategory'], page_id)
@@ -100,7 +99,6 @@ def initialize(prediction, page_id) # rubocop:todo Metrics/AbcSize
         @invoice_number = TextField.new(prediction['invoice_number'], page_id)
         @supplier_name = TextField.new(prediction['supplier_name'], page_id)
         @supplier_address = TextField.new(prediction['supplier_address'], page_id)
-
         @reference_numbers = []
         prediction['reference_numbers'].each do |item|
           @reference_numbers.push(TextField.new(item, page_id))
@@ -121,14 +119,12 @@ def initialize(prediction, page_id) # rubocop:todo Metrics/AbcSize
         prediction['supplier_company_registrations'].each do |item|
           @supplier_company_registrations.push(CompanyRegistration.new(item, page_id))
         end
-
         @total_tax = AmountField.new(
           { value: nil, confidence: 0.0 }, page_id
         )
-
         @line_items = []
         prediction['line_items'].each do |item|
-          @line_items.push(InvoiceLineItem.new(item, page_id))
+          @line_items.push(FinancialDocumentLineItem.new(item, page_id))
         end
         reconstruct(page_id)
       end
@@ -153,39 +149,35 @@ def to_s
         out_str << "\n:Supplier address: #{@supplier_address}".rstrip
         out_str << "\n:Supplier company registrations: #{supplier_company_registrations}".rstrip
         out_str << "\n:Supplier payment details: #{supplier_payment_details}".rstrip
-
         out_str << "\n:Customer name: #{@customer_name}".rstrip
         out_str << "\n:Customer address: #{@customer_address}".rstrip
         out_str << "\n:Customer company registrations: #{customer_company_registrations}".rstrip
-
         out_str << "\n:Tip: #{@tip}".rstrip
-
         out_str << "\n:Taxes: #{taxes}".rstrip
         out_str << "\n:Total taxes: #{@total_tax}".rstrip
         out_str << "\n:Total net: #{@total_net}".rstrip
         out_str << "\n:Total amount: #{@total_amount}".rstrip
-
+        out_str << "\n:Line Items:"
         out_str << line_items_to_s
-
         out_str[1..].to_s
       end
 
       private
 
+      def line_item_separator(char)
+        "  +#{char * 22}+#{char * 9}+#{char * 9}+#{char * 10}+#{char * 18}+#{char * 38}+"
+      end
+
       def line_items_to_s
-        line_item_separator = "#{'=' * 22} #{'=' * 8} #{'=' * 9} #{'=' * 10} #{'=' * 18} #{'=' * 36}"
-        line_items = @line_items.map(&:to_s).join("\n")
+        return '' if @line_items.empty?
 
+        line_items = @line_items.map(&:to_s).join("\n#{line_item_separator('-')}\n  ")
         out_str = String.new
-        out_str << "\n\n:Line Items:"
-
-        return out_str if line_items.empty?
-
-        out_str << "\n#{line_item_separator}"
-        out_str << "\nCode                   QTY      Price     Amount     Tax (Rate)         Description"
-        out_str << "\n#{line_item_separator}"
-        out_str << "\n#{line_items}"
-        out_str << "\n#{line_item_separator}"
+        out_str << "\n#{line_item_separator('-')}"
+        out_str << "\n  | Code#{' ' * 17}| QTY     | Price   | Amount   | Tax (Rate)       | Description#{' ' * 26}|"
+        out_str << "\n#{line_item_separator('=')}"
+        out_str << "\n  #{line_items}"
+        out_str << "\n#{line_item_separator('-')}"
       end
 
       def reconstruct(page_id)

lib/mindee/parsing/prediction/invoice/invoice_line_item.rb renamed to lib/mindee/parsing/prediction/financial_document/line_item.rb

@@ -4,7 +4,7 @@
 
 module Mindee
   # Line items for invoices
-  class InvoiceLineItem
+  class FinancialDocumentLineItem
     # @return [String] The product code referring to the item.
     attr_reader :product_code
     # @return [String]
@@ -42,17 +42,15 @@ def initialize(prediction, page_id)
     def to_s
       tax = Field.float_to_string(@tax_amount)
       tax << " (#{Field.float_to_string(@tax_rate)}%)" unless @tax_rate.nil?
-
       description = @description.nil? ? '' : @description
       description = "#{description[0..32]}..." if description.size > 35
-
       out_str = String.new
-      out_str << format('%- 22s', @product_code)
-      out_str << " #{format('%- 8s', Field.float_to_string(@quantity))}"
-      out_str << " #{format('%- 9s', Field.float_to_string(@unit_price))}"
-      out_str << " #{format('%- 10s', Field.float_to_string(@total_amount))}"
-      out_str << " #{format('%- 18s', tax)}"
-      out_str << " #{description}"
+      out_str << format('| %- 20s', @product_code)
+      out_str << " #{format('| %- 7s', Field.float_to_string(@quantity))}"
+      out_str << " #{format('| %- 7s', Field.float_to_string(@unit_price))}"
+      out_str << " #{format('| %- 8s', Field.float_to_string(@total_amount))}"
+      out_str << " #{format('| %- 16s', tax)}"
+      out_str << " #{format('| %- 37s|', description)}"
     end
   end
 end

lib/mindee/parsing/prediction/fr/bank_account_details/bank_account_details_v1.rb

@@ -6,15 +6,15 @@
 module Mindee
   module Prediction
     module FR
-      # French bank account information (RIB)
+      # Bank Account Details v1 prediction results.
       class BankAccountDetailsV1 < Prediction
-        # The account's IBAN.
+        # The International Bank Account Number (IBAN).
         # @return [Mindee::TextField]
         attr_reader :iban
-        # The account holder's name.
+        # The name of the account holder as seen on the document.
         # @return [Mindee::TextField]
         attr_reader :account_holder_name
-        # The bank's SWIFT code.
+        # The bank's SWIFT Business Identifier Code (BIC).
         # @return [Mindee::TextField]
         attr_reader :swift
 
@@ -30,8 +30,8 @@ def initialize(prediction, page_id)
         def to_s
           out_str = String.new
           out_str << "\n:IBAN: #{@iban}".rstrip
-          out_str << "\n:Account holder name: #{@account_holder_name}".rstrip
-          out_str << "\n:SWIFT: #{@swift}".rstrip
+          out_str << "\n:Account Holder's Name: #{@account_holder_name}".rstrip
+          out_str << "\n:SWIFT Code: #{@swift}".rstrip
           out_str[1..].to_s
         end
       end

lib/mindee/parsing/prediction/fr/carte_vitale/carte_vitale_v1.rb

@@ -6,18 +6,18 @@
 module Mindee
   module Prediction
     module FR
-      # French Carte Vitale
+      # Carte Vitale v1 prediction results.
       class CarteVitaleV1 < Prediction
-        # List of given (first) names of the cardholder.
+        # The given name(s) of the card holder.
         # @return [Array<Mindee::TextField>]
         attr_reader :given_names
-        # The surname (last name) of the cardholder.
+        # The surname of the card holder.
         # @return [Mindee::TextField]
         attr_reader :surname
-        # The social security number of the cardholder.
+        # The Social Security Number (Numéro de Sécurité Sociale) of the card holder
         # @return [Mindee::TextField]
         attr_reader :social_security
-        # The issuance date of the card.
+        # The date the card was issued.
         # @return [Mindee::DateField]
         attr_reader :issuance_date
 
@@ -35,12 +35,12 @@ def initialize(prediction, page_id)
         end
 
         def to_s
-          given_names = @given_names.map(&:value).join(', ')
+          given_names = @given_names.join("\n #{' ' * 15}")
           out_str = String.new
-          out_str << "\n:Given names: #{given_names}".rstrip
+          out_str << "\n:Given Name(s): #{given_names}".rstrip
           out_str << "\n:Surname: #{@surname}".rstrip
           out_str << "\n:Social Security Number: #{@social_security}".rstrip
-          out_str << "\n:Issuance date: #{@issuance_date}".rstrip
+          out_str << "\n:Issuance Date: #{@issuance_date}".rstrip
           out_str[1..].to_s
         end
       end

lib/mindee/parsing/prediction/fr/id_card/id_card_v1.rb

@@ -6,39 +6,39 @@
 module Mindee
   module Prediction
     module FR
-      # French national ID card
+      # Carte Nationale d'Identité v1 prediction results.
       class IdCardV1 < Prediction
-        # The authority which has issued the card.
-        # @return [Array<Mindee::TextField>]
-        attr_reader :authority
-        # Indicates if it is the recto side, the verso side or both.
+        # The side of the document which is visible.
         # @return [Mindee::TextField]
         attr_reader :document_side
-        # The card number.
+        # The identification card number.
         # @return [Mindee::TextField]
         attr_reader :id_number
-        # The expiration date of the card.
-        # @return [Mindee::DateField]
-        attr_reader :expiry_date
-        # The surname (last name) of the cardholder.
+        # The given name(s) of the card holder.
+        # @return [Array<Mindee::TextField>]
+        attr_reader :given_names
+        # The surname of the card holder.
         # @return [Mindee::TextField]
         attr_reader :surname
-        # List of first (given) names of the cardholder.
-        # @return [Mindee::TextField]
-        attr_reader :given_names
-        # The date of birth of the cardholder.
+        # The date of birth of the card holder.
         # @return [Mindee::DateField]
         attr_reader :birth_date
-        # The place of birth of the cardholder.
+        # The place of birth of the card holder.
         # @return [Mindee::TextField]
         attr_reader :birth_place
-        # The sex or gender of the cardholder.
+        # The expiry date of the identification card.
+        # @return [Mindee::DateField]
+        attr_reader :expiry_date
+        # The name of the issuing authority.
+        # @return [Mindee::TextField]
+        attr_reader :authority
+        # The gender of the card holder.
         # @return [Mindee::TextField]
         attr_reader :gender
-        # The value of the first MRZ line.
+        # Machine Readable Zone, first line
         # @return [Mindee::TextField]
         attr_reader :mrz1
-        # The value of the second MRZ line.
+        # Machine Readable Zone, second line
         # @return [Mindee::TextField]
         attr_reader :mrz2
 
@@ -49,33 +49,34 @@ def initialize(prediction, page_id)
           @document_side = TextField.new(prediction['document_side'], page_id) if page_id
           @authority = TextField.new(prediction['authority'], page_id)
           @id_number = TextField.new(prediction['id_number'], page_id)
+          @given_names = []
+          prediction['given_names'].each do |item|
+            @given_names.push(TextField.new(item, page_id))
+          end
+          @surname = TextField.new(prediction['surname'], page_id)
           @birth_date = DateField.new(prediction['birth_date'], page_id)
-          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
           @birth_place = TextField.new(prediction['birth_place'], page_id)
+          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+          @authority = TextField.new(prediction['authority'], page_id)
           @gender = TextField.new(prediction['gender'], page_id)
-          @surname = TextField.new(prediction['surname'], page_id)
           @mrz1 = TextField.new(prediction['mrz1'], page_id)
           @mrz2 = TextField.new(prediction['mrz2'], page_id)
-          @given_names = []
-          prediction['given_names'].each do |item|
-            @given_names.push(TextField.new(item, page_id))
-          end
         end
 
         def to_s
-          given_names = @given_names.map(&:value).join(', ')
+          given_names = @given_names.join("\n #{' ' * 15}")
           out_str = String.new
-          out_str << "\n:Document side: #{@document_side}".rstrip if @document_side
-          out_str << "\n:Authority: #{@authority}".rstrip
-          out_str << "\n:Given names: #{given_names}".rstrip
+          out_str << "\n:Document Side: #{@document_side}".rstrip if @document_side
+          out_str << "\n:Identity Number: #{@id_number}".rstrip
+          out_str << "\n:Given Name(s): #{given_names}".rstrip
           out_str << "\n:Surname: #{@surname}".rstrip
+          out_str << "\n:Date of Birth: #{@birth_date}".rstrip
+          out_str << "\n:Place of Birth: #{@birth_place}".rstrip
+          out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+          out_str << "\n:Issuing Authority: #{@authority}".rstrip
           out_str << "\n:Gender: #{@gender}".rstrip
-          out_str << "\n:ID Number: #{@id_number}".rstrip
-          out_str << "\n:Birth date: #{@birth_date}".rstrip
-          out_str << "\n:Birth place: #{@birth_place}".rstrip
-          out_str << "\n:Expiry date: #{@expiry_date}".rstrip
-          out_str << "\n:MRZ 1: #{@mrz1}".rstrip
-          out_str << "\n:MRZ 2: #{@mrz2}".rstrip
+          out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
+          out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
           out_str[1..].to_s
         end
       end