From a5361b5e0f5f7746cf02336bcd8d89b8310f6042 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Mon, 21 Mar 2022 09:46:46 +0000 Subject: [PATCH] refactor: Deprecate Is() in favor of Eq() which behaves the same --- gomockctx.go | 18 +++++++++++++++--- gomockctx_test.go | 8 ++++++-- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/gomockctx.go b/gomockctx.go index bd07c14..4bdc495 100644 --- a/gomockctx.go +++ b/gomockctx.go @@ -49,16 +49,28 @@ func New(parent context.Context) context.Context { return context.WithValue(parent, ctxKey, newCtxID()) } -// Is accepts a context with a gomockctx ID value (as returned from New), and -// returns a gomock.Matcher which returns true for the given context, of any +// Eq accepts a context with a gomockctx ID value (as returned from New), and +// returns a gomock.Matcher which returns true for the given context, and any // child contexts of it. // // If ctx was not returned from New, the resulting matcher will ALWAYS return // false. -func Is(ctx context.Context) gomock.Matcher { +func Eq(ctx context.Context) gomock.Matcher { return WithValue(ctxKey, getValue(ctx)) } +// Is accepts a context with a gomockctx ID value (as returned from New), and +// returns a gomock.Matcher which returns true for the given context, and any +// child contexts of it. +// +// If ctx was not returned from New, the resulting matcher will ALWAYS return +// false. +// +// Deprecated: Renamed to Eq(). +func Is(ctx context.Context) gomock.Matcher { + return Eq(ctx) +} + // ID returns the gomockctx ID value in the given context, or a empty string if // the context does not have a gomockctx ID value. func ID(ctx context.Context) string { diff --git a/gomockctx_test.go b/gomockctx_test.go index 4e59398..f3cb351 100644 --- a/gomockctx_test.go +++ b/gomockctx_test.go @@ -34,7 +34,7 @@ func TestNew(t *testing.T) { assert.Len(t, ids, limit) } -func TestIs(t *testing.T) { +func TestEq(t *testing.T) { type strKey string type args struct { @@ -100,7 +100,7 @@ func TestIs(t *testing.T) { } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - got := Is(tt.args.ctx) + got := Eq(tt.args.ctx) assert.Implements(t, (*gomock.Matcher)(nil), got) @@ -109,6 +109,10 @@ func TestIs(t *testing.T) { } } +func TestIs(t *testing.T) { + TestEq(t) +} + func TestID(t *testing.T) { tests := []struct { name string