Clean a bit totals

angelodlfrtr · Jun 24, 2022 · c0c106a · c0c106a
1 parent d926347
commit c0c106a
Show file tree

Hide file tree

Showing 10 changed files with 196 additions and 109 deletions.
diff --git a/Makefile b/Makefile
@@ -1,5 +1,6 @@
 .PHONY: lint
 lint:
+	go vet ./...
 	golangci-lint run
 
 .PHONY: test

diff --git a/build.go b/build.go
@@ -6,7 +6,6 @@ import (
 	"time"
 
 	"github.com/go-pdf/fpdf"
-	"github.com/leekchan/accounting"
 	"github.com/shopspring/decimal"
 )
 
@@ -101,6 +100,7 @@ func (doc *Document) Build() (*fpdf.Fpdf, error) {
 	return doc.pdf, nil
 }
 
+// appendTitle to document
 func (doc *Document) appendTitle() {
 	title := doc.typeAsString()
 
@@ -116,6 +116,7 @@ func (doc *Document) appendTitle() {
 	doc.pdf.CellFormat(80, 10, doc.encodeString(title), "0", 0, "C", false, 0, "")
 }
 
+// appendMetas to document
 func (doc *Document) appendMetas() {
 	// Append ref
 	refString := fmt.Sprintf("%s: %s", doc.Options.TextRefTitle, doc.Ref)
@@ -143,6 +144,7 @@ func (doc *Document) appendMetas() {
 	doc.pdf.CellFormat(80, 4, doc.encodeString(dateString), "0", 0, "R", false, 0, "")
 }
 
+// appendDescription to document
 func (doc *Document) appendDescription() {
 	if len(doc.Description) > 0 {
 		doc.pdf.SetY(doc.pdf.GetY() + 10)
@@ -151,6 +153,7 @@ func (doc *Document) appendDescription() {
 	}
 }
 
+// drawsTableTitles in document
 func (doc *Document) drawsTableTitles() {
 	// Draw table titles
 	doc.pdf.SetX(10)
@@ -260,6 +263,7 @@ func (doc *Document) drawsTableTitles() {
 	)
 }
 
+// appendItems to document
 func (doc *Document) appendItems() {
 	doc.drawsTableTitles()
 
@@ -290,6 +294,7 @@ func (doc *Document) appendItems() {
 	}
 }
 
+// appendNotes to document
 func (doc *Document) appendNotes() {
 	if len(doc.Notes) == 0 {
 		return
@@ -310,76 +315,8 @@ func (doc *Document) appendNotes() {
 	doc.pdf.SetY(currentY)
 }
 
+// appendTotal to document
 func (doc *Document) appendTotal() {
-	ac := accounting.Accounting{
-		Symbol:    doc.Options.CurrencySymbol,
-		Precision: doc.Options.CurrencyPrecision,
-		Thousand:  doc.Options.CurrencyThousand,
-		Decimal:   doc.Options.CurrencyDecimal,
-	}
-
-	// Get total (without tax)
-	total, _ := decimal.NewFromString("0")
-
-	for _, item := range doc.Items {
-		total = total.Add(item.totalWithoutTaxAndWithDiscount())
-	}
-
-	// Apply document discount
-	totalWithDiscount := decimal.NewFromFloat(0)
-	if doc.Discount != nil {
-		discountType, discountNumber := doc.Discount.getDiscount()
-
-		if discountType == "amount" {
-			totalWithDiscount = total.Sub(discountNumber)
-		} else {
-			// Percent
-			toSub := total.Mul(discountNumber.Div(decimal.NewFromFloat(100)))
-			totalWithDiscount = total.Sub(toSub)
-		}
-	}
-
-	// Tax
-	totalTax := decimal.NewFromFloat(0)
-	if doc.Discount == nil {
-		for _, item := range doc.Items {
-			totalTax = totalTax.Add(item.taxWithDiscount())
-		}
-	} else {
-		discountType, discountAmount := doc.Discount.getDiscount()
-		discountPercent := discountAmount
-		if discountType == "amount" {
-			// Get percent from total discounted
-			discountPercent = discountAmount.Mul(decimal.NewFromFloat(100)).Div(totalWithDiscount)
-		}
-
-		for _, item := range doc.Items {
-			if item.Tax != nil {
-				taxType, taxAmount := item.Tax.getTax()
-				if taxType == "amount" {
-					// If tax type is amount, juste add amount to tax
-					totalTax = totalTax.Add(taxAmount)
-				} else {
-					// Else, remove doc discount % from item total without tax and item discount
-					itemTotal := item.totalWithoutTaxAndWithDiscount()
-					toSub := discountPercent.Mul(itemTotal).Div(decimal.NewFromFloat(100))
-					itemTotalDiscounted := itemTotal.Sub(toSub)
-
-					// Then recompute tax on itemTotalDiscounted
-					itemTaxDiscounted := taxAmount.Mul(itemTotalDiscounted).Div(decimal.NewFromFloat(100))
-
-					totalTax = totalTax.Add(itemTaxDiscounted)
-				}
-			}
-		}
-	}
-
-	// finalTotal
-	totalWithTax := total.Add(totalTax)
-	if doc.Discount != nil {
-		totalWithTax = totalWithDiscount.Add(totalTax)
-	}
-
 	doc.pdf.SetY(doc.pdf.GetY() + 10)
 	doc.pdf.SetFont(doc.Options.Font, "", LargeTextFontSize)
 	doc.pdf.SetTextColor(
@@ -398,12 +335,22 @@ func (doc *Document) appendTotal() {
 	doc.pdf.SetX(162)
 	doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
 	doc.pdf.Rect(160, doc.pdf.GetY(), 40, 10, "F")
-	doc.pdf.CellFormat(40, 10, doc.encodeString(ac.FormatMoneyDecimal(total)), "0", 0, "L", false, 0, "")
+	doc.pdf.CellFormat(
+		40,
+		10,
+		doc.encodeString(doc.ac.FormatMoneyDecimal(doc.TotalWithoutTaxAndWithoutDocumentDiscount())),
+		"0",
+		0,
+		"L",
+		false,
+		0,
+		"",
+	)
 
 	if doc.Discount != nil {
 		baseY := doc.pdf.GetY() + 10
 
-		// Draw DISCOUNTED title
+		// Draw discounted title
 		doc.pdf.SetXY(120, baseY)
 		doc.pdf.SetFillColor(doc.Options.DarkBgColor[0], doc.Options.DarkBgColor[1], doc.Options.DarkBgColor[2])
 		doc.pdf.Rect(120, doc.pdf.GetY(), 40, 15, "F")
@@ -426,13 +373,15 @@ func (doc *Document) appendTotal() {
 			descString.WriteString("-")
 			descString.WriteString(discountAmount.String())
 			descString.WriteString(" % / -")
-			descString.WriteString(ac.FormatMoneyDecimal(total.Sub(totalWithDiscount)))
+			descString.WriteString(doc.ac.FormatMoneyDecimal(
+				doc.TotalWithoutTaxAndWithoutDocumentDiscount().Sub(doc.TotalWithoutTax())),
+			)
 		} else {
 			descString.WriteString("-")
-			descString.WriteString(ac.FormatMoneyDecimal(discountAmount))
+			descString.WriteString(doc.ac.FormatMoneyDecimal(discountAmount))
 			descString.WriteString(" / -")
 			descString.WriteString(
-				discountAmount.Mul(decimal.NewFromFloat(100)).Div(total).StringFixed(2),
+				discountAmount.Mul(decimal.NewFromFloat(100)).Div(doc.TotalWithoutTax()).StringFixed(2),
 			)
 			descString.WriteString(" %")
 		}
@@ -446,43 +395,74 @@ func (doc *Document) appendTotal() {
 			doc.Options.BaseTextColor[2],
 		)
 
-		// Draw DISCOUNT amount
+		// Draw discount amount
 		doc.pdf.SetY(baseY)
 		doc.pdf.SetX(162)
 		doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
 		doc.pdf.Rect(160, doc.pdf.GetY(), 40, 15, "F")
-		doc.pdf.CellFormat(40, 15, doc.encodeString(ac.FormatMoneyDecimal(totalWithDiscount)), "0", 0, "L", false, 0, "")
+		doc.pdf.CellFormat(
+			40,
+			15,
+			doc.encodeString(doc.ac.FormatMoneyDecimal(doc.TotalWithoutTax())),
+			"0",
+			0,
+			"L",
+			false,
+			0,
+			"",
+		)
 		doc.pdf.SetY(doc.pdf.GetY() + 15)
 	} else {
 		doc.pdf.SetY(doc.pdf.GetY() + 10)
 	}
 
-	// Draw TAX title
+	// Draw tax title
 	doc.pdf.SetX(120)
 	doc.pdf.SetFillColor(doc.Options.DarkBgColor[0], doc.Options.DarkBgColor[1], doc.Options.DarkBgColor[2])
 	doc.pdf.Rect(120, doc.pdf.GetY(), 40, 10, "F")
 	doc.pdf.CellFormat(38, 10, doc.encodeString(doc.Options.TextTotalTax), "0", 0, "R", false, 0, "")
 
-	// Draw TAX amount
+	// Draw tax amount
 	doc.pdf.SetX(162)
 	doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
 	doc.pdf.Rect(160, doc.pdf.GetY(), 40, 10, "F")
-	doc.pdf.CellFormat(40, 10, doc.encodeString(ac.FormatMoneyDecimal(totalTax)), "0", 0, "L", false, 0, "")
+	doc.pdf.CellFormat(
+		40,
+		10,
+		doc.encodeString(doc.ac.FormatMoneyDecimal(doc.Tax())),
+		"0",
+		0,
+		"L",
+		false,
+		0,
+		"",
+	)
 
-	// Draw TOTAL TTC title
+	// Draw total with tax title
 	doc.pdf.SetY(doc.pdf.GetY() + 10)
 	doc.pdf.SetX(120)
 	doc.pdf.SetFillColor(doc.Options.DarkBgColor[0], doc.Options.DarkBgColor[1], doc.Options.DarkBgColor[2])
 	doc.pdf.Rect(120, doc.pdf.GetY(), 40, 10, "F")
 	doc.pdf.CellFormat(38, 10, doc.encodeString(doc.Options.TextTotalWithTax), "0", 0, "R", false, 0, "")
 
-	// Draw TOTAL TTC amount
+	// Draw total with tax amount
 	doc.pdf.SetX(162)
 	doc.pdf.SetFillColor(doc.Options.GreyBgColor[0], doc.Options.GreyBgColor[1], doc.Options.GreyBgColor[2])
 	doc.pdf.Rect(160, doc.pdf.GetY(), 40, 10, "F")
-	doc.pdf.CellFormat(40, 10, doc.encodeString(ac.FormatMoneyDecimal(totalWithTax)), "0", 0, "L", false, 0, "")
+	doc.pdf.CellFormat(
+		40,
+		10,
+		doc.encodeString(doc.ac.FormatMoneyDecimal(doc.TotalWithTax())),
+		"0",
+		0,
+		"L",
+		false,
+		0,
+		"",
+	)
 }
 
+// appendPaymentTerm to document
 func (doc *Document) appendPaymentTerm() {
 	if len(doc.PaymentTerm) > 0 {
 		paymentTermString := fmt.Sprintf(

diff --git a/contact.go b/contact.go
@@ -15,6 +15,7 @@ type Contact struct {
 	Address *Address `json:"address,omitempty"`
 }
 
+// appendContactTODoc append the contact to the document
 func (c *Contact) appendContactTODoc(
 	x float64,
 	y float64,
@@ -93,11 +94,13 @@ func (c *Contact) appendContactTODoc(
 	return doc.pdf.GetY()
 }
 
+// appendCompanyContactToDoc append the company contact to the document
 func (c *Contact) appendCompanyContactToDoc(doc *Document) float64 {
 	x, y, _, _ := doc.pdf.GetMargins()
 	return c.appendContactTODoc(x, y, true, "L", doc)
 }
 
+// appendCustomerContactToDoc append the customer contact to the document
 func (c *Contact) appendCustomerContactToDoc(doc *Document) float64 {
 	return c.appendContactTODoc(130, BaseMarginTop+25, true, "R", doc)
 }
diff --git a/discount.go b/discount.go
@@ -10,6 +10,7 @@ type Discount struct {
 	Amount  string `json:"amount,omitempty"`  // Discount in amount ex 123.40
 }
 
+// getDiscount as return the discount type and value
 func (t *Discount) getDiscount() (string, decimal.Decimal) {
 	tax := "0"
 	taxType := "percent"

diff --git a/document.go b/document.go
@@ -2,11 +2,13 @@ package generator
 
 import (
 	"github.com/go-pdf/fpdf"
+	"github.com/leekchan/accounting"
 )
 
 // Document define base document
 type Document struct {
 	pdf *fpdf.Fpdf
+	ac  accounting.Accounting
 
 	Options      *Options      `json:"options,omitempty"`
 	Header       *HeaderFooter `json:"header,omitempty"`
@@ -38,10 +40,12 @@ func (doc *Document) SetUnicodeTranslator(fn UnicodeTranslateFunc) {
 	doc.Options.UnicodeTranslateFunc = fn
 }
 
+// encodeString encodes the string using doc.Options.UnicodeTranslateFunc
 func (doc *Document) encodeString(str string) string {
 	return doc.Options.UnicodeTranslateFunc(str)
 }
 
+// typeAsString return the document type as string
 func (d *Document) typeAsString() string {
 	if d.Type == Invoice {
 		return d.Options.TextTypeInvoice

diff --git a/generator.go b/generator.go
@@ -4,6 +4,7 @@ package generator
 import (
 	"github.com/creasty/defaults"
 	"github.com/go-pdf/fpdf"
+	"github.com/leekchan/accounting"
 )
 
 // New return a new documents with provided types and defaults
@@ -15,8 +16,17 @@ func New(docType string, options *Options) (*Document, error) {
 		Type:    docType,
 	}
 
+	// Prepare pdf
 	doc.pdf = fpdf.New("P", "mm", "A4", "")
 	doc.Options.UnicodeTranslateFunc = doc.pdf.UnicodeTranslatorFromDescriptor("")
 
+	// Prepare accounting
+	doc.ac = accounting.Accounting{
+		Symbol:    doc.Options.CurrencySymbol,
+		Precision: doc.Options.CurrencyPrecision,
+		Thousand:  doc.Options.CurrencyThousand,
+		Decimal:   doc.Options.CurrencyDecimal,
+	}
+
 	return doc, nil
 }
diff --git a/header_footer.go b/header_footer.go
@@ -22,6 +22,7 @@ func (hf *HeaderFooter) ApplyFunc(pdf *fpdf.Fpdf, fn fnc) {
 	pdf.SetHeaderFunc(fn)
 }
 
+// applyHeader apply header to document
 func (hf *HeaderFooter) applyHeader(doc *Document) error {
 	if err := defaults.Set(hf); err != nil {
 		return err
@@ -71,6 +72,7 @@ func (hf *HeaderFooter) applyHeader(doc *Document) error {
 	return nil
 }
 
+// applyFooter apply footer to document
 func (hf *HeaderFooter) applyFooter(doc *Document) error {
 	if err := defaults.Set(hf); err != nil {
 		return err