[#6] - Exponent is no longer optional

MethodCallRetrier.go

@@ -26,11 +26,10 @@ type MethodCallRetrier struct {
 	errorList []error
 }
 
-/* MethodCallRetrier.New returns a new MethodCallRetrier. */
-func New(waitTime int64, maxRetries int64, exponent *int64) *MethodCallRetrier {
-	if exponent == nil {
-		defaultInt := int64(1)
-		exponent = &defaultInt
+/* New returns a new MethodCallRetrier. */
+func New(waitTime int64, maxRetries int64, exponent int64) *MethodCallRetrier {
+	if exponent < 1 {
+		exponent = 1
 	}
 
 	if maxRetries < 1 {
@@ -41,12 +40,13 @@ func New(waitTime int64, maxRetries int64, exponent *int64) *MethodCallRetrier {
 		waitTime = 0
 	}
 
-	return &MethodCallRetrier{waitTime: waitTime, maxRetries: maxRetries, exponent: *exponent}
+	return &MethodCallRetrier{waitTime: waitTime, maxRetries: maxRetries, exponent: exponent}
 }
 
 /*
-Retries a function with a maximum number of retries and a wait time. Functionally equivalent to ExecuteWithRetry() but
-accepts a function to maintain type safety in userland instead and removes the requirement of a user type assertion.
+ExecuteFuncWithRetry retries a function with a maximum number of retries and a wait time. Functionally equivalent to
+ExecuteWithRetry() but accepts a function to maintain type safety in userland instead and removes the requirement of a
+user type assertion.
 */
 func (r *MethodCallRetrier) ExecuteFuncWithRetry(function func() error) []error {
 	defer func() {

README.md

@@ -15,15 +15,15 @@ Extremely useful for retrying HTTP calls in distributed systems, or anything els
 Installation
 -
 
-`go get github.com/j7mbo/MethodCallRetrier`
+`go get github.com/j7mbo/MethodCallRetrier/v2`
 
 Usage
 -
 
 Initialise the object with some options:
 
 ```
-MethodCallRetrier.New(waitTime int64, maxRetries int64, exponent *int64) 
+MethodCallRetrier.New(waitTime int64, maxRetries int64, exponent int64) 
 ```
 
 Call `ExecuteWithRetry` with your object and method you want to retry:

Retrier_test.go

@@ -14,7 +14,7 @@ type RetrierTestSuite struct {
 }
 
 func (s *RetrierTestSuite) SetupTest() {
-	s.retrier = New(0, 1, nil)
+	s.retrier = New(0, 1, 1)
 }
 
 func TestRetrierTestSuite(t *testing.T) {
@@ -74,7 +74,7 @@ func (s *RetrierTestSuite) TestRetrierRetriesCorrectNumberOfTimes() {
 
 	testObj.On(methodName, "").Return(errors.New(""))
 
-	_, _ = New(0, 5, nil).ExecuteWithRetry(&testObj, methodName, "")
+	_, _ = New(0, 5, 1).ExecuteWithRetry(&testObj, methodName, "")
 
 	testObj.AssertNumberOfCalls(s.T(), methodName, 5)
 
@@ -84,15 +84,15 @@ func (s *RetrierTestSuite) TestRetrierRetriesCorrectNumberOfTimes() {
 func (s *RetrierTestSuite) TestRetrierWorksWithNegativeMaxRetries() {
 	arg := "testArg"
 
-	results, _ := New(-1, -1, nil).ExecuteWithRetry(RetryObject{}, "MethodReturningString", arg)
+	results, _ := New(-1, -1, 1).ExecuteWithRetry(RetryObject{}, "MethodReturningString", arg)
 
 	s.Assert().EqualValues(results[0].String(), arg)
 }
 
 func (s *RetrierTestSuite) TestRetrierDefaultsToOneRetryGivenZeroMaxRetries() {
 	testObj := RetryMockObject{}
 
-	New(0, 0, nil).ExecuteFuncWithRetry(testObj.MethodToBeCalledToReturnResultAndError)
+	New(0, 0, 1).ExecuteFuncWithRetry(testObj.MethodToBeCalledToReturnResultAndError)
 
 	s.Assert().Equal(1, testObj.timesCalled)
 }
@@ -103,7 +103,7 @@ func (s *RetrierTestSuite) TestRetrierReturnsAllErrorsPlusOurError() {
 
 	testObj.On(methodName, "").Return(errors.New(""))
 
-	_, errs := New(0, 5, nil).ExecuteWithRetry(&testObj, methodName, "")
+	_, errs := New(0, 5, 1).ExecuteWithRetry(&testObj, methodName, "")
 
 	s.Assert().Len(errs, 6)
 }
@@ -112,7 +112,7 @@ func (s *RetrierTestSuite) TestRetrierWorksWhenErrorIsNotLastReturnParamOnObject
 	testObj := RetryObject{}
 	methodName := "MethodReturningErrorInRandomPosition"
 
-	_, errs := New(1, 1, nil).ExecuteWithRetry(&testObj, methodName, "")
+	_, errs := New(1, 1, 1).ExecuteWithRetry(&testObj, methodName, "")
 
 	s.Assert().IsType(errors.New(""), errs[0])
 }
@@ -121,15 +121,15 @@ func (s *RetrierTestSuite) TestRetrierWorksWhenMultipleReturnParamsAreErrors() {
 	testObj := RetryObject{}
 	methodName := "MethodReturningMultipleErrors"
 
-	_, errs := New(0, 5, nil).ExecuteWithRetry(&testObj, methodName, "")
+	_, errs := New(0, 5, 1).ExecuteWithRetry(&testObj, methodName, "")
 
 	s.Assert().Len(errs, 11)
 }
 
 func (s *RetrierTestSuite) TestRetrierWorksWithUserFunction() {
 	var num int
 
-	errs := New(0, 3, nil).ExecuteFuncWithRetry(func() error {
+	errs := New(0, 3, 1).ExecuteFuncWithRetry(func() error {
 		num = 42
 
 		return nil
@@ -140,7 +140,7 @@ func (s *RetrierTestSuite) TestRetrierWorksWithUserFunction() {
 }
 
 func (s *RetrierTestSuite) TestRetrierWithUserFunctionReturnsCorrectNumberOfErrors() {
-	errs := New(0, 3, nil).ExecuteFuncWithRetry(func() error {
+	errs := New(0, 3, 1).ExecuteFuncWithRetry(func() error {
 		return errors.New("")
 	})
 
@@ -150,7 +150,7 @@ func (s *RetrierTestSuite) TestRetrierWithUserFunctionReturnsCorrectNumberOfErro
 func (s *RetrierTestSuite) TestRetrierWorksWithUserFunctionCalledCorrectNumberOfTimes() {
 	testObj := RetryMockObject{}
 
-	New(0, 3, nil).ExecuteFuncWithRetry(testObj.MethodToBeCalledToReturnResultAndError)
+	New(0, 3, 1).ExecuteFuncWithRetry(testObj.MethodToBeCalledToReturnResultAndError)
 
 	s.Assert().Equal(3, testObj.timesCalled)
 }

go.mod

@@ -1,3 +1,3 @@
-module github.com/j7mbo/MethodCallRetrier
+module github.com/j7mbo/MethodCallRetrier/v2
 
 require github.com/stretchr/testify v1.3.0