Merge pull request #343 from invopop/org-name-fix-validation

Org.Name: require either given or surname

Author: samlown

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+### Changed
+
+- `org.Name`: either given **or** surname are required, as opposed to both at the same time.
+
 ### Added
 
 - `head`: validation rule to check for the presence of stamps

bill/discounts.go

@@ -13,16 +13,17 @@ import (
 
 // LineDiscount represents an amount deducted from the line, and will be
 // applied before taxes.
-// TODO: use UNTDID 5189 code list
 type LineDiscount struct {
 	// Percentage if fixed amount not applied
 	Percent *num.Percentage `json:"percent,omitempty" jsonschema:"title=Percent"`
 	// Fixed discount amount to apply (calculated if percent present).
-	Amount num.Amount `json:"amount" jsonschema:"title=Value" jsonschema_extras:"calculated=true"`
+	Amount num.Amount `json:"amount" jsonschema:"title=Amount" jsonschema_extras:"calculated=true"`
 	// Reason code.
 	Code string `json:"code,omitempty" jsonschema:"title=Code"`
 	// Text description as to why the discount was applied
 	Reason string `json:"reason,omitempty" jsonschema:"title=Reason"`
+
+	// TODO: support UNTDID 5189 codes
 }
 
 // Validate checks the line discount's fields.

org/name.go

@@ -19,11 +19,11 @@ type Name struct {
 	// Additional prefix to add to name, like Mrs. or Mr.
 	Prefix string `json:"prefix,omitempty" jsonschema:"title=Prefix"`
 	// Person's given or first name
-	Given string `json:"given" jsonschema:"title=Given"`
+	Given string `json:"given,omitempty" jsonschema:"title=Given"`
 	// Middle names or initials
 	Middle string `json:"middle,omitempty" jsonschema:"title=Middle"`
 	// Second or Family name.
-	Surname string `json:"surname" jsonschema:"title=Surname"`
+	Surname string `json:"surname,omitempty" jsonschema:"title=Surname"`
 	// Additional second of family name.
 	Surname2 string `json:"surname2,omitempty" jsonschema:"title=Second Surname"`
 	// Titles to include after the name.
@@ -41,8 +41,16 @@ func (n *Name) Validate() error {
 func (n *Name) ValidateWithContext(ctx context.Context) error {
 	return tax.ValidateStructWithRegime(ctx, n,
 		validation.Field(&n.UUID),
-		validation.Field(&n.Given, validation.Required),
-		validation.Field(&n.Surname, validation.Required),
+		validation.Field(&n.Given,
+			validation.When(n.Surname == "",
+				validation.Required,
+			),
+		),
+		validation.Field(&n.Surname,
+			validation.When(n.Given == "",
+				validation.Required,
+			),
+		),
 		validation.Field(&n.Meta),
 	)
 }

org/name_test.go

@@ -0,0 +1,53 @@
+package org_test
+
+import (
+	"testing"
+
+	"github.com/invopop/gobl/org"
+	"github.com/stretchr/testify/require"
+)
+
+func TestNameValidation(t *testing.T) {
+	tests := []struct {
+		name string
+		n    *org.Name
+		err  string
+	}{
+		{
+			name: "empty",
+			n:    &org.Name{},
+
+			err: "given: cannot be blank; surname: cannot be blank.",
+		},
+		{
+			name: "given",
+			n: &org.Name{
+				Given: "John",
+			},
+		},
+		{
+			name: "surname",
+			n: &org.Name{
+				Surname: "Doe",
+			},
+		},
+		{
+			name: "both",
+			n: &org.Name{
+				Given:   "John",
+				Surname: "Doe",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := tt.n.Validate()
+			if tt.err == "" {
+				require.NoError(t, err)
+				return
+			}
+			require.ErrorContains(t, err, tt.err)
+		})
+	}
+}