Merge pull request #11 from avast/remove_units_func

remove Units function

Author: JaSei

Makefile

@@ -57,7 +57,7 @@ build:
 	go build
 
 release: ## Release new version
-	git tag | grep -q $(VERSION) && echo This version was released! Increase VERSION! || git tag $(VERSION) && git push origin $(VERSION)
+	git tag | grep -q $(VERSION) && echo This version was released! Increase VERSION! || git tag $(VERSION) && git push origin $(VERSION) && git tag v$(VERSION) && git push origin v$(VERSION)
 
 # Absolutely awesome: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
 help:

README.md

@@ -64,6 +64,15 @@ nonintuitive interface (for me)
 
 ### BREAKING CHANGES
 
+1.0.2 -> 2.0.0
+
+* argument of `retry.Delay` is final delay (no multiplication by `retry.Units`
+anymore)
+
+* function `retry.Units` are removed
+
+* [more about this breaking change](https://github.com/avast/retry-go/issues/7)
+
 0.3.0 -> 1.0.0
 
 * `retry.Retry` function are changed to `retry.Do` function
@@ -133,7 +142,7 @@ Attempts set count of retry default is 10
 ```go
 func Delay(delay time.Duration) Option
 ```
-Delay set delay between retry default are 1e5 units
+Delay set delay between retry default is 100ms
 
 #### func  OnRetry
 
@@ -175,14 +184,6 @@ skip retry if special error example:
     	})
     )
 
-#### func  Units
-
-```go
-func Units(units time.Duration) Option
-```
-Units set unit of delay (probably only for tests purpose) default are
-microsecond
-
 #### type RetryIfFunc
 
 ```go

VERSION

@@ -1 +1 @@
-1.0.2
+2.0.0

options.go

@@ -14,7 +14,6 @@ type OnRetryFunc func(n uint, err error)
 type config struct {
 	attempts uint
 	delay    time.Duration
-	units    time.Duration
 	onRetry  OnRetryFunc
 	retryIf  RetryIfFunc
 }
@@ -31,21 +30,13 @@ func Attempts(attempts uint) Option {
 }
 
 // Delay set delay between retry
-// default are 1e5 units
+// default is 100ms
 func Delay(delay time.Duration) Option {
 	return func(c *config) {
 		c.delay = delay
 	}
 }
 
-// Units set unit of delay (probably only for tests purpose)
-// default are microsecond
-func Units(units time.Duration) Option {
-	return func(c *config) {
-		c.units = units
-	}
-}
-
 // OnRetry function callback are called each retry
 //
 // log each retry example:
@@ -54,7 +45,7 @@ func Units(units time.Duration) Option {
 //		func() error {
 //			return errors.New("some error")
 //		},
-//		retry.OnRetry(func(n unit, err error) {
+//		retry.OnRetry(func(n uint, err error) {
 //			log.Printf("#%d: %s\n", n, err)
 //		}),
 //	)

retry.go

@@ -45,6 +45,15 @@ SEE ALSO
 
 BREAKING CHANGES
 
+1.0.2 -> 2.0.0
+
+* argument of `retry.Delay` is final delay (no multiplication by `retry.Units` anymore)
+
+* function `retry.Units` are removed
+
+* [more about this breaking change](https://github.com/avast/retry-go/issues/7)
+
+
 0.3.0 -> 1.0.0
 
 * `retry.Retry` function are changed to `retry.Do` function
@@ -70,8 +79,7 @@ func Do(retryableFunc RetryableFunc, opts ...Option) error {
 	//default
 	config := &config{
 		attempts: 10,
-		delay:    1e5,
-		units:    time.Microsecond,
+		delay:    100 * time.Millisecond,
 		onRetry:  func(n uint, err error) {},
 		retryIf:  func(err error) bool { return true },
 	}
@@ -100,7 +108,7 @@ func Do(retryableFunc RetryableFunc, opts ...Option) error {
 			}
 
 			delayTime := config.delay * (1 << (n - 1))
-			time.Sleep((time.Duration)(delayTime) * config.units)
+			time.Sleep(delayTime)
 		} else {
 			return nil
 		}

retry_test.go

@@ -13,7 +13,7 @@ func TestDoAllFailed(t *testing.T) {
 	err := Do(
 		func() error { return errors.New("test") },
 		OnRetry(func(n uint, err error) { retrySum += n }),
-		Units(time.Nanosecond),
+		Delay(time.Nanosecond),
 	)
 	assert.Error(t, err)
 
@@ -57,7 +57,7 @@ func TestRetryIf(t *testing.T) {
 		RetryIf(func(err error) bool {
 			return err.Error() != "special"
 		}),
-		Units(time.Nanosecond),
+		Delay(time.Nanosecond),
 	)
 	assert.Error(t, err)