move examples and experimentals to submodules

Author: kamilsk

docs.go

@@ -0,0 +1,7 @@
+// Package retry provides the most advanced interruptible mechanism
+// to perform actions repetitively until successful.
+//
+// The retry based on https://github.com/Rican7/retry but fully reworked
+// and focused on integration with the https://github.com/kamilsk/breaker
+// and the built-in https://pkg.go.dev/context package.
+package retry

errors.go

@@ -11,17 +11,7 @@ func (err Error) Error() string { return string(err) }
 // Unwrap always returns nil means that an error doesn't have other root cause.
 func (err Error) Unwrap() error { return nil }
 
-// equal to go.octolab.org/errors.Unwrap
 func unwrap(err error) error {
-	// compatible with github.com/pkg/errors
-	type causer interface {
-		Cause() error
-	}
-	// compatible with built-in errors since 1.13
-	type wrapper interface {
-		Unwrap() error
-	}
-
 	for err != nil {
 		layer, is := err.(wrapper)
 		if is {
@@ -37,3 +27,13 @@ func unwrap(err error) error {
 	}
 	return err
 }
+
+// compatible with github.com/pkg/errors
+type causer interface {
+	Cause() error
+}
+
+// compatible with built-in errors since 1.13
+type wrapper interface {
+	Unwrap() error
+}

errors_test.go

@@ -17,18 +17,18 @@ func TestError(t *testing.T) {
 }
 
 func TestUnwrap(t *testing.T) {
-	cause := errors.New("root")
-	core := unwrap(causer{layer{cause}})
-	if !reflect.DeepEqual(core, cause) {
+	root := errors.New("root")
+	core := unwrap(cause{layer{root}})
+	if !reflect.DeepEqual(core, root) {
 		t.Error("unexpected behavior")
 	}
 }
 
 // helpers
 
-type causer struct{ error }
+type cause struct{ error }
 
-func (causer causer) Cause() error { return causer.error }
+func (cause cause) Cause() error { return cause.error }
 
 type layer struct{ error }
 

compare_test.go renamed to examples/compare_test.go

@@ -1,4 +1,4 @@
-package retry_test
+package examples_test
 
 import (
 	"context"

examples/docs.go

@@ -0,0 +1,6 @@
+// Package examples contains extended documentation
+// for github.com/kamilsk/retry/v5 module.
+//
+// It contains examples of usage with additional
+// dependencies that are not needed by the module.
+package examples

examples/go.mod

@@ -0,0 +1,7 @@
+module github.com/kamilsk/retry/examples
+
+go 1.13
+
+require github.com/kamilsk/retry/v5 v5.0.0-rc8
+
+replace github.com/kamilsk/retry/v5 => ../

examples/http_test.go

@@ -0,0 +1 @@
+package examples_test

retry.go

@@ -1,8 +1,3 @@
-// Package retry provides the most advanced interruptible mechanism
-// to perform actions repetitively until successful.
-// The retry based on https://github.com/Rican7/retry but fully reworked
-// and focused on integration with the https://github.com/kamilsk/breaker
-// and the built-in https://pkg.go.dev/context package.
 package retry
 
 import (

sandbox/docs.go

@@ -0,0 +1,3 @@
+// Package exp contains experimental unstable
+// features.
+package sandbox

example_test.go renamed to sandbox/example_test.go

@@ -1,16 +1,20 @@
-package retry_test
+// +build go1.13
+
+package sandbox_test
 
 import (
 	"context"
 	"database/sql"
+	"errors"
 	"fmt"
 	"math/rand"
 	"net"
 	"time"
 
+	"github.com/kamilsk/retry/sandbox"
+
 	"github.com/kamilsk/retry/v5"
 	"github.com/kamilsk/retry/v5/backoff"
-	"github.com/kamilsk/retry/v5/exp"
 	"github.com/kamilsk/retry/v5/jitter"
 	"github.com/kamilsk/retry/v5/strategy"
 )
@@ -31,8 +35,8 @@ func Example() {
 		),
 
 		// experimental
-		exp.CheckError(
-			exp.NetworkError(exp.Skip),
+		sandbox.CheckError(
+			sandbox.NetworkError(sandbox.Skip),
 			DatabaseError(),
 		),
 	}
@@ -60,10 +64,10 @@ func SendRequest(ctx context.Context) error {
 }
 
 func DatabaseError() func(error) bool {
-	blacklist := []error{sql.ErrNoRows, sql.ErrConnDone, sql.ErrTxDone}
+	deprecated := []error{sql.ErrNoRows, sql.ErrConnDone, sql.ErrTxDone}
 	return func(err error) bool {
-		for _, preset := range blacklist {
-			if err == preset {
+		for _, deprecated := range deprecated {
+			if errors.Is(err, deprecated) {
 				return false
 			}
 		}

sandbox/go.mod

@@ -0,0 +1,7 @@
+module github.com/kamilsk/retry/sandbox
+
+go 1.11
+
+require github.com/kamilsk/retry/v5 v5.0.0-rc8
+
+replace github.com/kamilsk/retry/v5 => ../

exp/experimental.go renamed to sandbox/strategy.go

@@ -1,4 +1,4 @@
-package exp
+package sandbox
 
 import "net"
 
@@ -9,7 +9,7 @@ const (
 
 // A Breaker carries a cancellation signal to interrupt an action execution.
 //
-// It is a subset of the built-in Context and github.com/kamilsk/breaker interfaces.
+// It is a subset of the built-in context and github.com/kamilsk/breaker interfaces.
 type Breaker = interface {
 	// Done returns a channel that's closed when a cancellation signal occurred.
 	Done() <-chan struct{}

exp/experimental_test.go renamed to sandbox/strategy_test.go

@@ -1,4 +1,4 @@
-package exp_test
+package sandbox_test
 
 import (
 	"context"
@@ -7,7 +7,7 @@ import (
 	"net"
 	"testing"
 
-	. "github.com/kamilsk/retry/v5/exp"
+	. "github.com/kamilsk/retry/sandbox"
 )
 
 func TestCheckError(t *testing.T) {

strategy/strategy.go

@@ -5,7 +5,7 @@ import "time"
 
 // A Breaker carries a cancellation signal to interrupt an action execution.
 //
-// It is a subset of the built-in Context and github.com/kamilsk/breaker interfaces.
+// It is a subset of the built-in context and github.com/kamilsk/breaker interfaces.
 type Breaker = interface {
 	// Done returns a channel that's closed when a cancellation signal occurred.
 	Done() <-chan struct{}