Changed method name as per feedback

Makefile

@@ -1,3 +1,3 @@
 test:
-	@go test -tags="integration" -race -coverprofile=profile.cov -v $(shell go list ./... | grep -vE 'cmd|mocks|testdata|testutil')
+	@go test -tags="integration" -race -coverprofile=profile.cov -v $(shell go list ./... | grep -vE 'example|mocks|testdata|testutil')
 	@go tool cover -func=profile.cov | grep total

example/transfer_money.go

@@ -0,0 +1 @@
+package example

go.mod

@@ -1,4 +1,4 @@
-module github.com/aneshas/tx
+module github.com/aneshas/tx/v2
 
 go 1.21.0
 

option.go

@@ -6,7 +6,7 @@ type Option func(tx *TX)
 // not cause the transaction to be rolled back.
 //
 // The transaction will still be committed but the actual error will be returned
-// by the Do method.
+// by the WithTransaction method.
 func WithIgnoredErrors(errs ...error) Option {
 	return func(tx *TX) {
 		tx.ignoreErrs = append(tx.ignoreErrs, errs...)

pgxtxv5/pgx_test.go

@@ -41,7 +41,7 @@ func TestShould_Rollback_Pgx_Transaction(t *testing.T) {
 func doPgx(t *testing.T, transactor *tx.TX, name string, fail bool) {
 	t.Helper()
 
-	err := transactor.Do(context.TODO(), func(ctx context.Context) error {
+	err := transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		ttx, _ := pgxtxv5.From(ctx)
 
 		_, err := ttx.Exec(ctx, `insert into cats (name) values($1)`, name)

sqltx/sql_test.go

@@ -45,7 +45,7 @@ func TestShould_Rollback_Sql_Transaction(t *testing.T) {
 func doSql(t *testing.T, transactor *tx.TX, name string, fail bool) {
 	t.Helper()
 
-	err := transactor.Do(context.TODO(), func(ctx context.Context) error {
+	err := transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		ttx, _ := sqltx.From(ctx)
 
 		_, err := ttx.Exec(`insert into cats (name) values($1)`, name)

testutil/db.go

@@ -27,13 +27,6 @@ func WithUnsuccessfulTransactionStart(with error) Option {
 	}
 }
 
-func WithSuccessfulTransactionStart() Option {
-	return func(db *DB) {
-		tx := mocks.NewTransaction(db.t)
-		db.EXPECT().Begin(mock.Anything).Return(tx, nil).Once()
-	}
-}
-
 func WithSuccessfulCommit() Option {
 	return func(db *DB) {
 		tx := mocks.NewTransaction(db.t)

tx.go

@@ -9,8 +9,14 @@ import (
 type key struct{}
 
 // Transactor is a helper transactor interface added for brevity purposes, so you don't have to define your own
+// See TX
 type Transactor interface {
-	Do(ctx context.Context, f func(ctx context.Context) error) error
+	// WithTransaction will wrap f in a sql transaction depending on the DB provider.
+	// This is mostly useful for when we want to control the transaction scope from
+	// application layer, for example application service/command handler.
+	// If f fails with an error, transactor will automatically try to roll the transaction back and report back any errors,
+	// otherwise, the implicit transaction will be committed.
+	WithTransaction(ctx context.Context, f func(ctx context.Context) error) error
 }
 
 // DB represents an interface to a db capable of starting a transaction
@@ -41,12 +47,12 @@ type TX struct {
 	ignoreErrs []error
 }
 
-// Do will execute func f in a sql transaction.
+// WithTransaction will wrap f in a sql transaction depending on the DB provider.
 // This is mostly useful for when we want to control the transaction scope from
 // application layer, for example application service/command handler.
-// If f fails with an error, transactor will automatically try to roll back the transaction and report back any errors,
-// otherwise the implicit transaction will be committed.
-func (t *TX) Do(ctx context.Context, f func(ctx context.Context) error) error {
+// If f fails with an error, transactor will automatically try to roll the transaction back and report back any errors,
+// otherwise, the implicit transaction will be committed.
+func (t *TX) WithTransaction(ctx context.Context, f func(ctx context.Context) error) error {
 	tx, err := t.db.Begin(ctx) // add tx options if different isolation levels are needed
 	if err != nil {
 		return fmt.Errorf("tx: could not start transaction: %w", err)

tx_test.go

@@ -19,7 +19,7 @@ func TestShould_Report_Transaction_Begin_Error(t *testing.T) {
 	)
 	transactor := tx.New(db)
 
-	err := transactor.Do(context.TODO(), func(ctx context.Context) error {
+	err := transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		return nil
 	})
 
@@ -33,7 +33,7 @@ func TestShould_Commit_Transaction_On_No_Error(t *testing.T) {
 	)
 	transactor := tx.New(db)
 
-	err := transactor.Do(context.TODO(), func(ctx context.Context) error {
+	err := transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		return nil
 	})
 
@@ -49,7 +49,7 @@ func TestShould_Rollback_Transaction_On_Error(t *testing.T) {
 
 	wantErr := fmt.Errorf("something bad occurred")
 
-	err := transactor.Do(context.TODO(), func(ctx context.Context) error {
+	err := transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		return wantErr
 	})
 
@@ -67,7 +67,7 @@ func TestShould_Report_Unsuccessful_Rollback(t *testing.T) {
 
 	wantErr := fmt.Errorf("process error")
 
-	err := transactor.Do(context.TODO(), func(ctx context.Context) error {
+	err := transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		return wantErr
 	})
 
@@ -88,7 +88,7 @@ func TestShould_Rollback_Transaction_On_Panic_And_RePanic(t *testing.T) {
 		}
 	}()
 
-	_ = transactor.Do(context.TODO(), func(ctx context.Context) error {
+	_ = transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		panic("something very bad occurred")
 	})
 }
@@ -102,7 +102,7 @@ func TestShould_Still_Commit_On_Ignored_Error_And_Propagate_Error(t *testing.T)
 	)
 	transactor := tx.New(db, tx.WithIgnoredErrors(wantErr))
 
-	err := transactor.Do(context.TODO(), func(ctx context.Context) error {
+	err := transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		return wantErr
 	})
 
@@ -116,7 +116,7 @@ func TestShould_Retrieve_Tx_From_Context(t *testing.T) {
 	)
 	transactor := tx.New(db)
 
-	_ = transactor.Do(context.TODO(), func(ctx context.Context) error {
+	_ = transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		ttx, ok := tx.From[tx.Transaction](ctx)
 
 		assert.True(t, ok)
@@ -133,7 +133,7 @@ func TestShould_Not_Retrieve_Conn_From_Context_On_Mismatched_Type(t *testing.T)
 	)
 	transactor := tx.New(db)
 
-	_ = transactor.Do(context.TODO(), func(ctx context.Context) error {
+	_ = transactor.WithTransaction(context.TODO(), func(ctx context.Context) error {
 		_, ok := tx.From[mocks.Transaction](ctx)
 
 		assert.False(t, ok)