mindee 3.1.1 → 3.3.0

data/lib/mindee/product/fr/id_card/id_card_v2.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v2_document'
+require_relative 'id_card_v2_page'
+
+module Mindee
+  module Product
+    module FR
+      # Carte Nationale d'Identité module.
+      module IdCard
+        # Carte Nationale d'Identité V2 prediction inference.
+        class IdCardV2 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'idcard_fr'
+          @endpoint_version = '2'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = IdCardV2Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(IdCardV2Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/id_card/id_card_v2_document.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module IdCard
+        # Carte Nationale d'Identité V2 document prediction.
+        class IdCardV2Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The alternate name of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :alternate_name
+          # The name of the issuing authority.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :authority
+          # The date of birth of the card holder.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :birth_date
+          # The place of birth of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :birth_place
+          # The card access number (CAN).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :card_access_number
+          # The document number.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :document_number
+          # The expiry date of the identification card.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :expiry_date
+          # The gender of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :gender
+          # The given name(s) of the card holder.
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
+          attr_reader :given_names
+          # The date of issue of the identification card.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :issue_date
+          # The Machine Readable Zone, first line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz1
+          # The Machine Readable Zone, second line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz2
+          # The Machine Readable Zone, third line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz3
+          # The nationality of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :nationality
+          # The surname of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :surname
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @alternate_name = StringField.new(prediction['alternate_name'], page_id)
+            @authority = StringField.new(prediction['authority'], page_id)
+            @birth_date = DateField.new(prediction['birth_date'], page_id)
+            @birth_place = StringField.new(prediction['birth_place'], page_id)
+            @card_access_number = StringField.new(prediction['card_access_number'], page_id)
+            @document_number = StringField.new(prediction['document_number'], page_id)
+            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+            @gender = StringField.new(prediction['gender'], page_id)
+            @given_names = []
+            prediction['given_names'].each do |item|
+              @given_names.push(StringField.new(item, page_id))
+            end
+            @issue_date = DateField.new(prediction['issue_date'], page_id)
+            @mrz1 = StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = StringField.new(prediction['mrz2'], page_id)
+            @mrz3 = StringField.new(prediction['mrz3'], page_id)
+            @nationality = StringField.new(prediction['nationality'], page_id)
+            @surname = StringField.new(prediction['surname'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            given_names = @given_names.join("\n #{' ' * 15}")
+            out_str = String.new
+            out_str << "\n:Nationality: #{@nationality}".rstrip
+            out_str << "\n:Card Access Number: #{@card_access_number}".rstrip
+            out_str << "\n:Document Number: #{@document_number}".rstrip
+            out_str << "\n:Given Name(s): #{given_names}".rstrip
+            out_str << "\n:Surname: #{@surname}".rstrip
+            out_str << "\n:Alternate Name: #{@alternate_name}".rstrip
+            out_str << "\n:Date of Birth: #{@birth_date}".rstrip
+            out_str << "\n:Place of Birth: #{@birth_place}".rstrip
+            out_str << "\n:Gender: #{@gender}".rstrip
+            out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+            out_str << "\n:Mrz Line 1: #{@mrz1}".rstrip
+            out_str << "\n:Mrz Line 2: #{@mrz2}".rstrip
+            out_str << "\n:Mrz Line 3: #{@mrz3}".rstrip
+            out_str << "\n:Date of Issue: #{@issue_date}".rstrip
+            out_str << "\n:Issuing Authority: #{@authority}".rstrip
+            out_str[1..].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/id_card/id_card_v2_page.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v2_document'
+
+module Mindee
+  module Product
+    module FR
+      module IdCard
+        # Carte Nationale d'Identité V2 page.
+        class IdCardV2Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = IdCardV2PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Carte Nationale d'Identité V2 page prediction.
+        class IdCardV2PagePrediction < IdCardV2Document
+          include Mindee::Parsing::Standard
+
+          # The sides of the document which are visible.
+          # @return [Mindee::Parsing::Standard::ClassificationField]
+          attr_reader :document_side
+          # The document type or format.
+          # @return [Mindee::Parsing::Standard::ClassificationField]
+          attr_reader :document_type
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            @document_side = ClassificationField.new(prediction['document_side'], page_id)
+            @document_type = ClassificationField.new(prediction['document_type'], page_id)
+            super(prediction, page_id)
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:Document Type: #{@document_type}".rstrip
+            out_str << "\n:Document Sides: #{@document_side}".rstrip
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/invoice/invoice_v4.rb

@@ -6,10 +6,10 @@ require_relative 'invoice_v4_page'
 
 module Mindee
   module Product
+    # Invoice module.
     module Invoice
-      # Invoice document.
+      # Invoice V4 prediction inference.
       class InvoiceV4 < Mindee::Parsing::Common::Inference
-        include Mindee::Parsing::Common
         @endpoint_name = 'invoices'
         @endpoint_version = '4'
 

data/lib/mindee/product/invoice/invoice_v4_document.rb

@@ -9,202 +9,162 @@ module Mindee
       # Invoice V4 document prediction.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
-
-        # Locale information.
-        # @return [Mindee::Parsing::Standard::Locale]
-        attr_reader :locale
-        # The nature of the invoice.
+        # The address of the customer.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_address
+        # List of company registrations associated to the customer.
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
+        attr_reader :customer_company_registrations
+        # The name of the customer or client.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_name
+        # The date the purchase was made.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date
+        # One of: 'INVOICE', 'CREDIT NOTE'.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :document_type
-        # The total amount with tax included.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_amount
-        # The total amount without the tax value.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_net
-        # The total tax.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_tax
-        # The creation date of the invoice.
+        # The date on which the payment is due.
         # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :date
-        # The invoice number.
-        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :due_date
+        # The invoice number or identifier.
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :invoice_number
-        # List of Reference numbers including PO number.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # List of line item details.
+        # @return [Array<Mindee::Product::Invoice::InvoiceV4LineItem>]
+        attr_reader :line_items
+        # The locale detected on the document.
+        # @return [Mindee::Parsing::Standard::LocaleField]
+        attr_reader :locale
+        # List of Reference numbers, including PO number.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
-        # The due date of the invoice.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :due_date
-        # The list of taxes.
-        # @return [Mindee::Parsing::Standard::Taxes]
-        attr_reader :taxes
-        # The name of the customer.
-        # @return [Mindee::Parsing::Standard::TextField]
-        attr_reader :customer_name
-        # The address of the customer.
-        # @return [Mindee::Parsing::Standard::TextField]
-        attr_reader :customer_address
-        # The company registration information for the customer.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
-        attr_reader :customer_company_registrations
-        # The supplier's name.
-        # @return [Mindee::Parsing::Standard::TextField]
-        attr_reader :supplier_name
-        # The supplier's address.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # The address of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_address
-        # The payment information.
-        # @return [Array<Mindee::Parsing::Standard::PaymentDetails>]
-        attr_reader :supplier_payment_details
-        # The supplier's company registration information.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        # List of company registrations associated to the supplier.
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :supplier_company_registrations
-        # Line items details.
-        # @return [Array<Mindee::InvoiceV4LineItem>]
-        attr_reader :line_items
+        # The name of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_name
+        # List of payment details associated to the supplier.
+        # @return [Array<Mindee::Parsing::Standard::PaymentDetailsField>]
+        attr_reader :supplier_payment_details
+        # List of tax line details.
+        # @return [Mindee::Parsing::Standard::Taxes]
+        attr_reader :taxes
+        # The total amount paid: includes taxes, tips, fees, and other charges.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_amount
+        # The net amount paid: does not include taxes, fees, and discounts.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_net
 
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
           super()
-          @locale = Locale.new(prediction['locale'])
-          @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @total_amount = AmountField.new(prediction['total_amount'], page_id)
-          @total_net = AmountField.new(prediction['total_net'], page_id)
-          @customer_address = TextField.new(prediction['customer_address'], page_id)
-          @customer_name = TextField.new(prediction['customer_name'], page_id)
+          @customer_address = StringField.new(prediction['customer_address'], page_id)
+          @customer_company_registrations = []
+          prediction['customer_company_registrations'].each do |item|
+            @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
+          end
+          @customer_name = StringField.new(prediction['customer_name'], page_id)
           @date = DateField.new(prediction['date'], page_id)
+          @document_type = ClassificationField.new(prediction['document_type'], page_id)
           @due_date = DateField.new(prediction['due_date'], page_id)
-          @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)
+          @invoice_number = StringField.new(prediction['invoice_number'], page_id)
+          @line_items = []
+          prediction['line_items'].each do |item|
+            @line_items.push(InvoiceV4LineItem.new(item, page_id))
+          end
+          @locale = LocaleField.new(prediction['locale'], page_id)
           @reference_numbers = []
           prediction['reference_numbers'].each do |item|
-            @reference_numbers.push(TextField.new(item, page_id))
-          end
-          @customer_company_registrations = []
-          prediction['customer_company_registrations'].each do |item|
-            @customer_company_registrations.push(CompanyRegistration.new(item, page_id))
-          end
-          @taxes = Taxes.new(prediction['taxes'], page_id)
-          @supplier_payment_details = []
-          prediction['supplier_payment_details'].each do |item|
-            @supplier_payment_details.push(PaymentDetails.new(item, page_id))
+            @reference_numbers.push(StringField.new(item, page_id))
           end
+          @supplier_address = StringField.new(prediction['supplier_address'], page_id)
           @supplier_company_registrations = []
           prediction['supplier_company_registrations'].each do |item|
-            @supplier_company_registrations.push(CompanyRegistration.new(item, page_id))
+            @supplier_company_registrations.push(CompanyRegistrationField.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(InvoiceV4LineItem.new(item, page_id))
+          @supplier_name = StringField.new(prediction['supplier_name'], page_id)
+          @supplier_payment_details = []
+          prediction['supplier_payment_details'].each do |item|
+            @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
           end
-          reconstruct(page_id)
+          @taxes = Taxes.new(prediction['taxes'], page_id)
+          @total_amount = AmountField.new(prediction['total_amount'], page_id)
+          @total_net = AmountField.new(prediction['total_net'], page_id)
         end
 
         # @return [String]
         def to_s
-          customer_company_registrations = @customer_company_registrations.map(&:value).join('; ')
-          supplier_payment_details = @supplier_payment_details.map(&:to_s).join("\n                 ")
-          supplier_company_registrations = @supplier_company_registrations.map(&:to_s).join('; ')
-          reference_numbers = @reference_numbers.map(&:to_s).join(', ')
+          reference_numbers = @reference_numbers.join("\n #{' ' * 19}")
+          supplier_payment_details = @supplier_payment_details.join("\n #{' ' * 26}")
+          supplier_company_registrations = @supplier_company_registrations.join("\n #{' ' * 32}")
+          customer_company_registrations = @customer_company_registrations.join("\n #{' ' * 32}")
+          line_items = line_items_to_s
           out_str = String.new
           out_str << "\n:Locale: #{@locale}".rstrip
-          out_str << "\n:Document type: #{@document_type}".rstrip
-          out_str << "\n:Invoice number: #{@invoice_number}".rstrip
-          out_str << "\n:Reference numbers: #{reference_numbers}".rstrip
-          out_str << "\n:Invoice date: #{@date}".rstrip
-          out_str << "\n:Invoice due date: #{@due_date}".rstrip
-          out_str << "\n:Supplier name: #{@supplier_name}".rstrip
-          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:Invoice Number: #{@invoice_number}".rstrip
+          out_str << "\n:Reference Numbers: #{reference_numbers}".rstrip
+          out_str << "\n:Purchase Date: #{@date}".rstrip
+          out_str << "\n:Due Date: #{@due_date}".rstrip
+          out_str << "\n:Total Net: #{@total_net}".rstrip
+          out_str << "\n:Total Amount: #{@total_amount}".rstrip
           out_str << "\n:Taxes:#{@taxes}".rstrip
-          out_str << "\n:Total net: #{@total_net}".rstrip
-          out_str << "\n:Total tax: #{@total_tax}".rstrip
-          out_str << "\n:Total amount: #{@total_amount}".rstrip
+          out_str << "\n:Supplier Payment Details: #{supplier_payment_details}".rstrip
+          out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
+          out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
+          out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
+          out_str << "\n:Customer Name: #{@customer_name}".rstrip
+          out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
+          out_str << "\n:Customer Address: #{@customer_address}".rstrip
+          out_str << "\n:Document Type: #{@document_type}".rstrip
           out_str << "\n:Line Items:"
-          out_str << line_items_to_s
+          out_str << line_items
           out_str[1..].to_s
         end
 
         private
 
-        def line_item_separator(char)
-          "  +#{char * 22}+#{char * 9}+#{char * 9}+#{char * 10}+#{char * 18}+#{char * 38}+"
+        # @param char [String]
+        # @return [String]
+        def line_items_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 38}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 12}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 12}"
+          out_str << '+'
+          out_str
         end
 
+        # @return [String]
         def line_items_to_s
           return '' if @line_items.empty?
 
-          line_items = @line_items.map(&:to_s).join("\n#{line_item_separator('-')}\n  ")
+          line_items = @line_items.map(&:to_table_line).join("\n#{line_items_separator('-')}\n  ")
           out_str = String.new
-          out_str << "\n#{line_item_separator('-')}"
-          out_str << "\n  | Code#{' ' * 17}| QTY     | Price   | Amount   | Tax (Rate)       | Description #{' ' * 25}|"
-          out_str << "\n#{line_item_separator('=')}"
+          out_str << "\n#{line_items_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Description                          |'
+          out_str << ' Product code |'
+          out_str << ' Quantity |'
+          out_str << ' Tax Amount |'
+          out_str << ' Tax Rate (%) |'
+          out_str << ' Total Amount |'
+          out_str << ' Unit Price |'
+          out_str << "\n#{line_items_separator('=')}"
           out_str << "\n  #{line_items}"
-          out_str << "\n#{line_item_separator('-')}"
-        end
-
-        def reconstruct(page_id)
-          construct_total_tax_from_taxes(page_id)
-          return unless page_id.nil?
-
-          construct_total_excl_from_tcc_and_taxes(page_id)
-          construct_total_incl_from_taxes_plus_excl(page_id)
-          construct_total_tax_from_totals(page_id)
-        end
-
-        def construct_total_excl_from_tcc_and_taxes(page_id)
-          return if @total_amount.value.nil? || taxes.empty? || !@total_net.value.nil?
-
-          total_excl = {
-            'value' => @total_amount.value - @taxes.map(&:value).sum,
-            'confidence' => TextField.array_confidence(@taxes) * @total_amount.confidence,
-          }
-          @total_net = AmountField.new(total_excl, page_id, reconstructed: true)
-        end
-
-        def construct_total_incl_from_taxes_plus_excl(page_id)
-          return if @total_net.value.nil? || @taxes.empty? || !@total_amount.value.nil?
-
-          total_incl = {
-            'value' => @taxes.map(&:value).sum + @total_net.value,
-            'confidence' => TextField.array_confidence(@taxes) * @total_net.confidence,
-          }
-          @total_amount = AmountField.new(total_incl, page_id, reconstructed: true)
-        end
-
-        def construct_total_tax_from_taxes(page_id)
-          return if @taxes.empty?
-
-          total_tax = {
-            'value' => @taxes.map(&:value).sum,
-            'confidence' => TextField.array_confidence(@taxes),
-          }
-          return unless total_tax['value'].positive?
-
-          @total_tax = AmountField.new(total_tax, page_id, reconstructed: true)
-        end
-
-        def construct_total_tax_from_totals(page_id)
-          return if !@total_tax.value.nil? || @total_amount.value.nil? || @total_net.value.nil?
-
-          total_tax = {
-            'value' => @total_amount.value - @total_net.value,
-            'confidence' => TextField.array_confidence(@taxes),
-          }
-          return unless total_tax['value'] >= 0
-
-          @total_tax = AmountField.new(total_tax, page_id, reconstructed: true)
+          out_str << "\n#{line_items_separator('-')}"
+          out_str
         end
       end
     end

data/lib/mindee/product/invoice/invoice_v4_line_item.rb

@@ -5,61 +5,85 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module Invoice
-      # Line items for Invoice V4
-      class InvoiceV4LineItem
-        include Mindee::Parsing::Common
+      # List of line item details.
+      class InvoiceV4LineItem < Mindee::Parsing::Standard::FeatureField
         include Mindee::Parsing::Standard
-        # @return [String] The product code referring to the item.
-        attr_reader :product_code
+        # The item description.
         # @return [String]
         attr_reader :description
+        # The product code referring to the item.
+        # @return [String]
+        attr_reader :product_code
+        # The item quantity
         # @return [Float]
         attr_reader :quantity
+        # The item tax amount.
         # @return [Float]
-        attr_reader :unit_price
+        attr_reader :tax_amount
+        # The item tax rate in percentage.
         # @return [Float]
-        attr_reader :total_amount
-        # @return [Float] The item tax rate percentage.
         attr_reader :tax_rate
+        # The item total amount.
         # @return [Float]
-        attr_reader :tax_amount
+        attr_reader :total_amount
+        # The item unit price.
         # @return [Float]
-        attr_reader :confidence
-        # @return [Integer]
-        attr_reader :page_id
-        # @return [Mindee::Geometry::Quadrilateral]
-        attr_reader :bounding_box
-        # @return [Array<Mindee::Geometry::Polygon>]
-        attr_reader :polygon
+        attr_reader :unit_price
 
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @description = prediction['description']
           @product_code = prediction['product_code']
           @quantity = prediction['quantity']
-          @unit_price = prediction['unit_price']
-          @total_amount = prediction['total_amount']
           @tax_amount = prediction['tax_amount']
           @tax_rate = prediction['tax_rate']
-          @description = prediction['description']
+          @total_amount = prediction['total_amount']
+          @unit_price = prediction['unit_price']
           @page_id = page_id
         end
 
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:description] = format_for_display(@description, 36)
+          printable[:product_code] = format_for_display(@product_code, nil)
+          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
+          printable[:tax_amount] = @tax_amount.nil? ? '' : Field.float_to_string(@tax_amount)
+          printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
+          printable[:total_amount] = @total_amount.nil? ? '' : Field.float_to_string(@total_amount)
+          printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+          printable
+        end
+
         # @return [String]
-        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
+        def to_table_line
+          printable = printable_values
           out_str = String.new
-          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)}"
+          out_str << format('| %- 37s', printable[:description])
+          out_str << format('| %- 13s', printable[:product_code])
+          out_str << format('| %- 9s', printable[:quantity])
+          out_str << format('| %- 11s', printable[:tax_amount])
+          out_str << format('| %- 13s', printable[:tax_rate])
+          out_str << format('| %- 13s', printable[:total_amount])
+          out_str << format('| %- 11s', printable[:unit_price])
           out_str << '|'
         end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Description: #{printable[:description]}"
+          out_str << "\n  :Product code: #{printable[:product_code]}"
+          out_str << "\n  :Quantity: #{printable[:quantity]}"
+          out_str << "\n  :Tax Amount: #{printable[:tax_amount]}"
+          out_str << "\n  :Tax Rate (%): #{printable[:tax_rate]}"
+          out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+          out_str << "\n  :Unit Price: #{printable[:unit_price]}"
+          out_str
+        end
       end
     end
   end

data/lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb

@@ -6,6 +6,7 @@ require_relative 'invoice_splitter_v1_page'
 
 module Mindee
   module Product
+    # Invoice Splitter module.
     module InvoiceSplitter
       # Invoice Splitter V1 prediction inference.
       class InvoiceSplitterV1 < Mindee::Parsing::Common::Inference