ref:(persist): define equals on comparison (#215)

snivilised · Oct 15, 2024 · ae9768f · ae9768f
1 parent 4dfbd51
commit ae9768f
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/internal/persist/equals.go → internal/persist/comparison.go b/internal/persist/equals.go → internal/persist/comparison.go
@@ -46,8 +46,8 @@ func (UnequalPtrError[T, O]) Unwrap() error {
 	return locale.ErrUnEqualConversion
 }
 
-func Equals(comparison *Comparison) error {
-	return equalOptions(comparison.O, comparison.JO)
+func (c *Comparison) Equals() error {
+	return equalOptions(c.O, c.JO)
 }
 
 // equalOptions compare the pref.Options instance to the derived json instance json.Options.

diff --git a/internal/persist/json-matcher_test.go b/internal/persist/json-matcher_test.go
@@ -28,10 +28,10 @@ func (m *MarshalJSONMatcher) Match(actual interface{}) (bool, error) {
 		return false, fmt.Errorf("❌ matcher expected a *json.Options instance (%T)", jo)
 	}
 
-	if err := persist.Equals(&persist.Comparison{
+	if err := (&persist.Comparison{
 		O:  m.o,
 		JO: jo,
-	}); err != nil {
+	}).Equals(); err != nil {
 		m.err = err
 		return false, err
 	}
@@ -65,10 +65,10 @@ func (m *UnMarshalJSONMatcher) Match(actual interface{}) (bool, error) {
 		return false, fmt.Errorf("❌ matcher expected a *pref.Options instance (%T)", o)
 	}
 
-	if err := persist.Equals(&persist.Comparison{
+	if err := (&persist.Comparison{
 		O:  o,
 		JO: m.jo,
-	}); err != nil {
+	}).Equals(); err != nil {
 		m.err = err
 		return false, err
 	}

diff --git a/internal/persist/marshaler.go b/internal/persist/marshaler.go
@@ -64,10 +64,10 @@ func Marshal(request *MarshalRequest) (*MarshalResult, error) {
 		return nil, err
 	}
 
-	if err := Equals(&Comparison{
+	if err := (&Comparison{
 		O:  request.O,
 		JO: jo,
-	}); err != nil {
+	}).Equals(); err != nil {
 		return result, err
 	}
 
@@ -99,8 +99,8 @@ func Unmarshal(request *UnmarshalRequest, tampers ...TamperFunc) (*UnmarshalResu
 		JO:     mr.JO,
 	}
 
-	return &result, Equals(&Comparison{
+	return &result, (&Comparison{
 		O:  result.O,
 		JO: result.JO,
-	})
+	}).Equals()
 }
diff --git a/internal/persist/marshaler_test.go b/internal/persist/marshaler_test.go
@@ -70,10 +70,10 @@ func marshal(entry *marshalTE, tfs nef.TraverseFS) *tampered {
 		entry.tweak(result)
 	}
 
-	e := persist.Equals(&persist.Comparison{
+	e := (&persist.Comparison{
 		O:  o,
 		JO: result.JO,
-	})
+	}).Equals()
 
 	Expect(e).NotTo(Succeed(), "MARSHAL")
 	if e != nil && entry.checkerTE != nil && entry.checkerTE.checker != nil {
@@ -99,10 +99,10 @@ func unmarshal(entry *marshalTE, tfs nef.TraverseFS, restorePath string, t *tamp
 	Expect(err).To(Succeed(), "UNMARSHAL")
 
 	// unequal error:
-	e := persist.Equals(&persist.Comparison{
+	e := (&persist.Comparison{
 		O:  t.o,
 		JO: state.JO,
-	})
+	}).Equals()
 
 	Expect(e).NotTo(Succeed(), "UNMARSHAL")
 
@@ -431,9 +431,9 @@ var _ = Describe("Marshaler", Ordered, func() {
 		Context("UnequalPtrError", func() {
 			When("pref.Options is nil", func() {
 				It("🧪 should: return UnequalPtrError", func() {
-					err := persist.Equals(&persist.Comparison{
+					err := (&persist.Comparison{
 						JO: &json.Options{},
-					})
+					}).Equals()
 
 					Expect(err).NotTo(Succeed())
 					Expect(errors.Is(err, locale.ErrUnEqualConversion)).To(BeTrue(),
@@ -446,9 +446,9 @@ var _ = Describe("Marshaler", Ordered, func() {
 				It("🧪 should: return UnequalPtrError", func() {
 					o, _, _ := opts.Get()
 
-					err := persist.Equals(&persist.Comparison{
+					err := (&persist.Comparison{
 						O: o,
-					})
+					}).Equals()
 
 					Expect(err).NotTo(Succeed())
 					Expect(errors.Is(err, locale.ErrUnEqualConversion)).To(BeTrue(),