Class: Mindee::V1::Product::Receipt::ReceiptV5LineItem

Inherits:
Mindee::V1::Parsing::Standard::FeatureField show all
Includes:
Mindee::V1::Parsing::Standard
Defined in:
lib/mindee/v1/product/receipt/receipt_v5_line_item.rb

Overview

List of all line items on the receipt.

Instance Attribute Summary collapse

Attributes inherited from Mindee::V1::Parsing::Standard::AbstractField

#bounding_box, #confidence, #page_id, #polygon

Instance Method Summary collapse

Methods inherited from Mindee::V1::Parsing::Standard::FeatureField

#format_for_display

Methods inherited from Mindee::V1::Parsing::Standard::AbstractField

array_confidence, array_sum, float_to_string

Constructor Details

#initialize(prediction, page_id) ⇒ ReceiptV5LineItem

Returns a new instance of ReceiptV5LineItem.

Parameters:

  • prediction (Hash)
  • page_id (Integer, nil) 


28
29
30
31
32
33
34
35
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 28

def initialize(prediction, page_id)
  super
  @description = prediction['description']
  @quantity = prediction['quantity']
  @total_amount = prediction['total_amount']
  @unit_price = prediction['unit_price']
  @page_id = page_id
end

Instance Attribute Details

#description ⇒ String (readonly)

The item description.

Returns:

  • (String) 


15
16
17
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 15

def description
  @description
end

#quantity ⇒ Float (readonly)

The item quantity.

Returns:

  • (Float) 


18
19
20
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 18

def quantity
  @quantity
end

#total_amount ⇒ Float (readonly)

The item total amount.

Returns:

  • (Float) 


21
22
23
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 21

def total_amount
  @total_amount
end

#unit_price ⇒ Float (readonly)

The item unit price.

Returns:

  • (Float) 


24
25
26
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 24

def unit_price
  @unit_price
end

Instance Method Details

#printable_values ⇒ Hash

Returns:

  • (Hash) 


38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 38

def printable_values
  printable = {} # @type var printable: Hash[Symbol, String]
  printable[:description] = format_for_display(@description)
  printable[:quantity] =
    @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
  printable[:total_amount] =
    @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
  printable[:unit_price] =
    @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
  printable
end

#table_printable_values ⇒ Hash

Returns:

  • (Hash) 


51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 51

def table_printable_values
  printable = {} # @type var printable: Hash[Symbol, String]
  printable[:description] = format_for_display(@description, 36)
  printable[:quantity] =
    @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
  printable[:total_amount] =
    @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
  printable[:unit_price] =
    @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
  printable
end

#to_s ⇒ String

Returns:

  • (String) 


75
76
77
78
79
80
81
82
83
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 75

def to_s
  printable = printable_values
  out_str = String.new
  out_str << "\n  :Description: #{printable[:description]}"
  out_str << "\n  :Quantity: #{printable[:quantity]}"
  out_str << "\n  :Total Amount: #{printable[:total_amount]}"
  out_str << "\n  :Unit Price: #{printable[:unit_price]}"
  out_str
end

#to_table_line ⇒ String

Returns:

  • (String) 


64
65
66
67
68
69
70
71
72
 
# File 'lib/mindee/v1/product/receipt/receipt_v5_line_item.rb', line 64

def to_table_line
  printable = table_printable_values
  out_str = String.new
  out_str << format('| %- 37s', printable[:description])
  out_str << format('| %- 9s', printable[:quantity])
  out_str << format('| %- 13s', printable[:total_amount])
  out_str << format('| %- 11s', printable[:unit_price])
  out_str << '|'
end