Rename 'work.DataMapper' to 'work.UnitDataMapper'. (#74)

freerware · Oct 9, 2022 · 7fee27a · 7fee27a
1 parent d300bff
commit 7fee27a
Show file tree

Hide file tree

Showing 10 changed files with 129 additions and 37 deletions.
diff --git a/Makefile b/Makefile
@@ -37,7 +37,7 @@ mocks-v3:
 
 mocks-v4:
 	@echo making v4 mocks...
-	@mockgen -source=v4/data_mapper.go -destination=v4/internal/mock/data_mapper.go -package=mock -mock_names=DataMapper=DataMapper
+	@mockgen -source=v4/unit_data_mapper.go -destination=v4/internal/mock/unit_data_mapper.go -package=mock -mock_names=UnitDataMapper=UnitDataMapper
 	@echo done!
 
 mocks: mocks-v3 mocks-v4

diff --git a/v4/best_effort_unit_test.go b/v4/best_effort_unit_test.go
@@ -37,7 +37,7 @@ type BestEffortUnitTestSuite struct {
 	sut work.Unit
 
 	// mocks.
-	mappers map[work.TypeName]*mock.DataMapper
+	mappers map[work.TypeName]*mock.UnitDataMapper
 	scope   tally.TestScope
 	mc      *gomock.Controller
 
@@ -116,12 +116,12 @@ func (s *BestEffortUnitTestSuite) Setup() {
 
 	// initialize mocks.
 	s.mc = gomock.NewController(s.T())
-	s.mappers = make(map[work.TypeName]*mock.DataMapper)
-	s.mappers[fooTypeName] = mock.NewDataMapper(s.mc)
-	s.mappers[barTypeName] = mock.NewDataMapper(s.mc)
+	s.mappers = make(map[work.TypeName]*mock.UnitDataMapper)
+	s.mappers[fooTypeName] = mock.NewUnitDataMapper(s.mc)
+	s.mappers[barTypeName] = mock.NewUnitDataMapper(s.mc)
 
 	// construct SUT.
-	dm := make(map[work.TypeName]work.DataMapper)
+	dm := make(map[work.TypeName]work.UnitDataMapper)
 	for t, m := range s.mappers {
 		dm[t] = m
 	}

diff --git a/v4/internal/mock/unit_data_mapper.go b/v4/internal/mock/unit_data_mapper.go
diff --git a/v4/sql_unit_test.go b/v4/sql_unit_test.go
@@ -43,7 +43,7 @@ type SQLUnitTestSuite struct {
 	_db     sqlmock.Sqlmock
 	scope   tally.TestScope
 	mc      *gomock.Controller
-	mappers map[work.TypeName]*mock.DataMapper
+	mappers map[work.TypeName]*mock.UnitDataMapper
 
 	// metrics scope names and tags.
 	scopePrefix                      string
@@ -112,16 +112,16 @@ func (s *SQLUnitTestSuite) Setup() {
 
 	// initialize mocks.
 	s.mc = gomock.NewController(s.T())
-	s.mappers = make(map[work.TypeName]*mock.DataMapper)
-	s.mappers[fooTypeName] = mock.NewDataMapper(s.mc)
-	s.mappers[barTypeName] = mock.NewDataMapper(s.mc)
+	s.mappers = make(map[work.TypeName]*mock.UnitDataMapper)
+	s.mappers[fooTypeName] = mock.NewUnitDataMapper(s.mc)
+	s.mappers[barTypeName] = mock.NewUnitDataMapper(s.mc)
 
 	var err error
 	s.db, s._db, err = sqlmock.New()
 	s.Require().NoError(err)
 
 	// construct SUT.
-	dm := make(map[work.TypeName]work.DataMapper)
+	dm := make(map[work.TypeName]work.UnitDataMapper)
 	for t, m := range s.mappers {
 		dm[t] = m
 	}

diff --git a/v4/unit/alias.go b/v4/unit/alias.go
@@ -211,7 +211,7 @@ var (
 type MapperContext = work.MapperContext
 
 // DataMapper represents a creator, modifier, and deleter of entities.
-type DataMapper = work.DataMapper
+type DataMapper = work.UnitDataMapper
 
 // DataMapperFunc represents a data mapper function that performs a single
 // operation, such as insert, update, or delete.

diff --git a/v4/data_mapper.go → v4/unit_data_mapper.go b/v4/data_mapper.go → v4/unit_data_mapper.go
@@ -18,7 +18,7 @@ package work
 import "context"
 
 // DataMapper represents a creator, modifier, and deleter of entities.
-type DataMapper interface {
+type UnitDataMapper interface {
 	Insert(context.Context, MapperContext, ...interface{}) error
 	Update(context.Context, MapperContext, ...interface{}) error
 	Delete(context.Context, MapperContext, ...interface{}) error

diff --git a/v4/unit_options.go b/v4/unit_options.go
@@ -130,7 +130,7 @@ var (
 	}
 
 	// UnitDataMappers specifies the option to provide the data mappers for the work unit.
-	UnitDataMappers = func(dm map[TypeName]DataMapper) UnitOption {
+	UnitDataMappers = func(dm map[TypeName]UnitDataMapper) UnitOption {
 		return func(o *UnitOptions) {
 			if dm == nil || len(dm) == 0 {
 				return

diff --git a/v4/unit_options_test.go b/v4/unit_options_test.go
@@ -57,7 +57,7 @@ func (s *UnitOptionsTestSuite) TestUnitDBOption() {
 
 func (s *UnitOptionsTestSuite) TestUnitDataMappers_Nil() {
 	// arrange.
-	var dm map[work.TypeName]work.DataMapper
+	var dm map[work.TypeName]work.UnitDataMapper
 
 	// action.
 	work.UnitDataMappers(dm)(s.sut)
@@ -70,7 +70,7 @@ func (s *UnitOptionsTestSuite) TestUnitDataMappers_Nil() {
 
 func (s *UnitOptionsTestSuite) TestUnitDataMappers_NotNil() {
 	// arrange.
-	dm := make(map[work.TypeName]work.DataMapper)
+	dm := make(map[work.TypeName]work.UnitDataMapper)
 	mc := gomock.NewController(s.T())
 	fooTypeName := work.TypeNameOf(test.Foo{})
 	dm[fooTypeName] = mock.NewDataMapper(mc)

diff --git a/v4/unit_test.go b/v4/unit_test.go
@@ -36,7 +36,7 @@ type UnitTestSuite struct {
 
 	// mocks.
 	scope   tally.TestScope
-	mappers map[work.TypeName]*mock.DataMapper
+	mappers map[work.TypeName]*mock.UnitDataMapper
 	mc      *gomock.Controller
 
 	// metrics scope names and tags.
@@ -60,14 +60,14 @@ func (s *UnitTestSuite) SetupTest() {
 
 	// initialize mocks.
 	s.mc = gomock.NewController(s.T())
-	s.mappers = make(map[work.TypeName]*mock.DataMapper)
-	s.mappers[fooTypeName] = mock.NewDataMapper(s.mc)
-	s.mappers[barTypeName] = mock.NewDataMapper(s.mc)
-	s.mappers[bizTypeName] = mock.NewDataMapper(s.mc)
-	s.mappers[bazTypeName] = mock.NewDataMapper(s.mc)
+	s.mappers = make(map[work.TypeName]*mock.UnitDataMapper)
+	s.mappers[fooTypeName] = mock.NewUnitDataMapper(s.mc)
+	s.mappers[barTypeName] = mock.NewUnitDataMapper(s.mc)
+	s.mappers[bizTypeName] = mock.NewUnitDataMapper(s.mc)
+	s.mappers[bazTypeName] = mock.NewUnitDataMapper(s.mc)
 
 	// construct SUT.
-	dm := make(map[work.TypeName]work.DataMapper)
+	dm := make(map[work.TypeName]work.UnitDataMapper)
 	for t, m := range s.mappers {
 		dm[t] = m
 	}
@@ -97,7 +97,7 @@ func (s *UnitTestSuite) TestUnit_NewUnit_NoDataMappers() {
 
 	// action.
 	var err error
-	dm := map[work.TypeName]work.DataMapper{}
+	dm := map[work.TypeName]work.UnitDataMapper{}
 	opts := []work.UnitOption{work.UnitDataMappers(dm)}
 	s.sut, err = work.NewUnit(opts...)
 
@@ -123,8 +123,8 @@ func (s *UnitTestSuite) TestUnit_Add_MissingDataMapper() {
 	entities := []interface{}{
 		test.Foo{ID: 28},
 	}
-	mappers := map[work.TypeName]work.DataMapper{
-		work.TypeNameOf(test.Bar{}): &mock.DataMapper{},
+	mappers := map[work.TypeName]work.UnitDataMapper{
+		work.TypeNameOf(test.Bar{}): &mock.UnitDataMapper{},
 	}
 	var err error
 	opts := []work.UnitOption{work.UnitDataMappers(mappers)}
@@ -196,8 +196,8 @@ func (s *UnitTestSuite) TestUnit_Alter_MissingDataMapper() {
 	entities := []interface{}{
 		test.Foo{ID: 28},
 	}
-	mappers := map[work.TypeName]work.DataMapper{
-		work.TypeNameOf(test.Bar{}): &mock.DataMapper{},
+	mappers := map[work.TypeName]work.UnitDataMapper{
+		work.TypeNameOf(test.Bar{}): &mock.UnitDataMapper{},
 	}
 	var err error
 	opts := []work.UnitOption{work.UnitDataMappers(mappers)}
@@ -269,8 +269,8 @@ func (s *UnitTestSuite) TestUnit_Remove_MissingDataMapper() {
 	entities := []interface{}{
 		test.Bar{ID: "28"},
 	}
-	mappers := map[work.TypeName]work.DataMapper{
-		work.TypeNameOf(test.Foo{}): &mock.DataMapper{},
+	mappers := map[work.TypeName]work.UnitDataMapper{
+		work.TypeNameOf(test.Foo{}): &mock.UnitDataMapper{},
 	}
 	var err error
 	opts := []work.UnitOption{work.UnitDataMappers(mappers)}
@@ -342,8 +342,8 @@ func (s *UnitTestSuite) TestUnit_Register_MissingDataMapper() {
 	entities := []interface{}{
 		test.Bar{ID: "28"},
 	}
-	mappers := map[work.TypeName]work.DataMapper{
-		work.TypeNameOf(test.Foo{}): &mock.DataMapper{},
+	mappers := map[work.TypeName]work.UnitDataMapper{
+		work.TypeNameOf(test.Foo{}): &mock.UnitDataMapper{},
 	}
 	var err error
 	opts := []work.UnitOption{work.UnitDataMappers(mappers)}

diff --git a/v4/uniter_test.go b/v4/uniter_test.go
@@ -35,7 +35,7 @@ type UniterTestSuite struct {
 	// mocks.
 	db      *sql.DB
 	_db     sqlmock.Sqlmock
-	mappers map[work.TypeName]*mock.DataMapper
+	mappers map[work.TypeName]*mock.UnitDataMapper
 }
 
 func TestUniterTestSuite(t *testing.T) {
@@ -51,16 +51,16 @@ func (s *UniterTestSuite) SetupTest() {
 	barTypeName := work.TypeNameOf(bar)
 
 	// initialize mocks.
-	s.mappers = make(map[work.TypeName]*mock.DataMapper)
-	s.mappers[fooTypeName] = &mock.DataMapper{}
-	s.mappers[barTypeName] = &mock.DataMapper{}
+	s.mappers = make(map[work.TypeName]*mock.UnitDataMapper)
+	s.mappers[fooTypeName] = &mock.UnitDataMapper{}
+	s.mappers[barTypeName] = &mock.UnitDataMapper{}
 
 	var err error
 	s.db, s._db, err = sqlmock.New()
 	s.Require().NoError(err)
 
 	// construct SUT.
-	dm := make(map[work.TypeName]work.DataMapper)
+	dm := make(map[work.TypeName]work.UnitDataMapper)
 	for t, m := range s.mappers {
 		dm[t] = m
 	}