Change RequestMatchers to work like Mutators (#104)

BREAKING CHANGE: Change RequestMatchers to work like Mutators

README.md

@@ -24,12 +24,12 @@
     <img src="https://github.com/seborama/govcr/actions/workflows/codeql-analysis.yml/badge.svg?branch=master" alt="govcr">
   </a>
 
-  <a href="https://pkg.go.dev/github.com/seborama/govcr/v12">
+  <a href="https://pkg.go.dev/github.com/seborama/govcr/v13">
     <img src="https://img.shields.io/badge/godoc-reference-blue.svg" alt="govcr">
   </a>
 
-  <a href="https://goreportcard.com/report/github.com/seborama/govcr/v12">
-    <img src="https://goreportcard.com/badge/github.com/seborama/govcr/v12" alt="govcr">
+  <a href="https://goreportcard.com/report/github.com/seborama/govcr/v13">
+    <img src="https://goreportcard.com/badge/github.com/seborama/govcr/v13" alt="govcr">
   </a>
 </p>
 
@@ -77,7 +77,7 @@ This project is an adaptation for Google's Go / Golang programming language.
 func TestExample1() {
     vcr := govcr.NewVCR(
         govcr.NewCassetteLoader("MyCassette1.json"),
-        govcr.WithRequestMatcher(govcr.NewMethodURLRequestMatcher()), // use a "relaxed" request matcher
+        govcr.WithRequestMatchers(govcr.NewMethodURLRequestMatchers()...), // use a "relaxed" request matcher
     )
 
     vcr.Client.Get("http://example.com/foo")
@@ -97,15 +97,15 @@ We use a "relaxed" request matcher because `example.com` injects an "`Age`" head
 ## Install
 
 ```bash
-go get github.com/seborama/govcr/v12@latest
+go get github.com/seborama/govcr/v13@latest
 ```
 
 For all available releases, please check the [releases](https://github.com/seborama/govcr/releases) tab on github.
 
 And your source code would use this import:
 
 ```go
-import "github.com/seborama/govcr/v12"
+import "github.com/seborama/govcr/v13"
 ```
 
 For versions of **govcr** before v5 (which don't use go.mod), use a dependency manager to lock the version you wish to use (perhaps v4)!
@@ -135,7 +135,7 @@ go get gopkg.in/seborama/govcr.v4
 
 **govcr** is a wrapper around the Go `http.Client`. It can record live HTTP traffic to files (called "**cassettes**") and later replay HTTP requests ("**tracks**") from them instead of live HTTP calls.
 
-The code documentation can be found on [godoc](https://pkg.go.dev/github.com/seborama/govcr/v12).
+The code documentation can be found on [godoc](https://pkg.go.dev/github.com/seborama/govcr/v13).
 
 When using **govcr**'s `http.Client`, the request is matched against the **tracks** on the '**cassette**':
 
@@ -161,7 +161,7 @@ This structure contains parameters for configuring your **govcr** recorder.
 Settings are populated via `With*` options:
 
 - Use `WithClient` to provide a custom http.Client otherwise the default Go http.Client will be used.
-- See `vcrsettings.go` for more options such as `WithRequestMatcher`, `WithTrackRecordingMutators`, `WithTrackReplayingMutators`, ...
+- See `vcrsettings.go` for more options such as `WithRequestMatchers`, `WithTrackRecordingMutators`, `WithTrackReplayingMutators`, ...
 - TODO: `WithLogging` enables logging to help understand what **govcr** is doing internally.
 
 [(toc)](#table-of-content)
@@ -178,7 +178,7 @@ This may be the case when the request contains a timestamp or a dynamically chan
 
 You can create your own matcher on any part of the request and in any manner (like ignoring or modifying some headers, etc).
 
-The input parameters received by a `RequestMatcherFunc` are scoped to the `RequestMatcher`. It is safe to modify them as needed. This affects the other `RequestMatcherFunc`'s in the `RequestMatcher`. But it does **not** permeate to the original incoming HTTP request or the tracks read from or written to the cassette.
+The input parameters received by a `RequestMatcher` are scoped to the `RequestMatchers`. This affects the other `RequestMatcher`'s. But it does **not** permeate throughout the VCR to the original incoming HTTP request or the tracks read from or written to the cassette.
 
 [(toc)](#table-of-content)
 
@@ -437,7 +437,7 @@ vcr := govcr.NewVCR(
 The command is located in the `cmd/govcr` folder, to install it:
 
 ```bash
-go install github.com/seborama/govcr/v12/cmd/govcr@latest
+go install github.com/seborama/govcr/v13/cmd/govcr@latest
 ```
 
 Example usage:
@@ -473,20 +473,18 @@ This example shows how to handle situations where a header in the request needs
 This could be necessary because the header value is not predictable or changes for each request.
 
 ```go
-vcr.SetRequestMatcher(
-    govcr.NewRequestMatcherCollection(
-        govcr.DefaultMethodMatcher,
-        govcr.DefaultURLMatcher,
-        func(httpRequest, trackRequest *track.Request) bool {
-            // we can safely mutate our inputs:
-            // mutations affect other RequestMatcherFunc's but _not_ the
-            // original HTTP request or the cassette Tracks.
-            httpRequest.Header.Del("X-Custom-Timestamp")
-            trackRequest.Header.Del("X-Custom-Timestamp")
-
-            return govcr.DefaultHeaderMatcher(httpRequest, trackRequest)
-        },
-    ),
+vcr.SetRequestMatchers(
+    govcr.DefaultMethodMatcher,
+    govcr.DefaultURLMatcher,
+    func(httpRequest, trackRequest *track.Request) bool {
+        // we can safely mutate our inputs:
+        // mutations affect other RequestMatcher's but _not_ the
+        // original HTTP request or the cassette Tracks.
+        httpRequest.Header.Del("X-Custom-Timestamp")
+        trackRequest.Header.Del("X-Custom-Timestamp")
+
+        return govcr.DefaultHeaderMatcher(httpRequest, trackRequest)
+    },
 )
 ```
 
@@ -508,7 +506,7 @@ How you specifically tackle this in practice really depends on how the API you a
 // See TestExample3 in tests for fully working example.
 vcr := govcr.NewVCR(
     govcr.NewCassetteLoader(exampleCassetteName3),
-    govcr.WithRequestMatcherFuncs(
+    govcr.WithRequestMatchers(
         func(httpRequest, trackRequest *track.Request) bool {
             // Remove the header from comparison.
             // Note: this removal is only scoped to the request matcher, it does not affect the original HTTP request

cassette/cassette.go

@@ -14,11 +14,11 @@ import (
 	"github.com/google/uuid"
 	"github.com/pkg/errors"
 
-	"github.com/seborama/govcr/v12/cassette/track"
-	"github.com/seborama/govcr/v12/compression"
-	cryptoerr "github.com/seborama/govcr/v12/encryption/errors"
-	govcrerr "github.com/seborama/govcr/v12/errors"
-	"github.com/seborama/govcr/v12/stats"
+	"github.com/seborama/govcr/v13/cassette/track"
+	"github.com/seborama/govcr/v13/compression"
+	cryptoerr "github.com/seborama/govcr/v13/encryption/errors"
+	govcrerr "github.com/seborama/govcr/v13/errors"
+	"github.com/seborama/govcr/v13/stats"
 )
 
 // Cassette contains a set of tracks.

cassette/cassette_test.go

@@ -8,9 +8,9 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v12/cassette"
-	"github.com/seborama/govcr/v12/cassette/track"
-	"github.com/seborama/govcr/v12/encryption"
+	"github.com/seborama/govcr/v13/cassette"
+	"github.com/seborama/govcr/v13/cassette/track"
+	"github.com/seborama/govcr/v13/encryption"
 )
 
 func Test_cassette_GzipFilter(t *testing.T) {

cassette/cassette_wb_test.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/seborama/govcr/v12/stats"
+	"github.com/seborama/govcr/v13/stats"
 )
 
 func Test_cassette_NumberOfTracks_PanicsWhenNoCassette(t *testing.T) {

cassette/track/http_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v12/cassette/track"
+	"github.com/seborama/govcr/v13/cassette/track"
 )
 
 func TestRequest_Clone(t *testing.T) {

cassette/track/mutator.go

@@ -5,8 +5,9 @@ import (
 	"regexp"
 )
 
+// Predicate is a function signature that takes a Track and returns a boolean.
 // It is used to construct conditional mutators.
-type Predicate func(trk *Track) bool
+type Predicate func(*Track) bool
 
 // Any accepts one or more predicates and returns a new predicate that will evaluate
 // to true when any the supplied predicate is true, otherwise false.

cassette/track/mutator_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v12/cassette/track"
+	"github.com/seborama/govcr/v13/cassette/track"
 )
 
 func Test_Mutator_On(t *testing.T) {

cassette/track/track.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	trkerr "github.com/seborama/govcr/v12/cassette/track/errors"
+	trkerr "github.com/seborama/govcr/v13/cassette/track/errors"
 )
 
 // Track is a recording (HTTP Request + Response) in a cassette.

cassette/track/track_test.go

@@ -13,7 +13,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v12/cassette/track"
+	"github.com/seborama/govcr/v13/cassette/track"
 )
 
 func TestTrack_ToHTTPResponse(t *testing.T) {

cmd/govcr/main.go

@@ -7,8 +7,8 @@ import (
 
 	"github.com/pkg/errors"
 
-	"github.com/seborama/govcr/v12/cassette"
-	"github.com/seborama/govcr/v12/encryption"
+	"github.com/seborama/govcr/v13/cassette"
+	"github.com/seborama/govcr/v13/encryption"
 )
 
 func main() {

concurrency_test.go

@@ -15,8 +15,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v12"
-	"github.com/seborama/govcr/v12/stats"
+	"github.com/seborama/govcr/v13"
+	"github.com/seborama/govcr/v13/stats"
 )
 
 func TestConcurrencySafety(t *testing.T) {

controlpanel.go

@@ -3,8 +3,8 @@ package govcr
 import (
 	"net/http"
 
-	"github.com/seborama/govcr/v12/cassette/track"
-	"github.com/seborama/govcr/v12/stats"
+	"github.com/seborama/govcr/v13/cassette/track"
+	"github.com/seborama/govcr/v13/stats"
 )
 
 // ControlPanel holds the parts of a VCR that can be interacted with.
@@ -18,9 +18,14 @@ func (controlPanel *ControlPanel) Stats() *stats.Stats {
 	return controlPanel.vcrTransport().stats()
 }
 
-// SetRequestMatcher sets a new RequestMatcher to the VCR.
-func (controlPanel *ControlPanel) SetRequestMatcher(requestMatcher RequestMatcher) {
-	controlPanel.vcrTransport().SetRequestMatcher(requestMatcher)
+// SetRequestMatchers sets a new set of RequestMatcher's to the VCR.
+func (controlPanel *ControlPanel) SetRequestMatchers(requestMatcher ...RequestMatcher) {
+	controlPanel.vcrTransport().SetRequestMatchers(requestMatcher...)
+}
+
+// AddRequestMatchers sets a new set of RequestMatcher's to the VCR.
+func (controlPanel *ControlPanel) AddRequestMatchers(requestMatcher ...RequestMatcher) {
+	controlPanel.vcrTransport().AddRequestMatchers(requestMatcher...)
 }
 
 // SetReadOnlyMode sets the VCR to read-only mode (true) or to normal read-write (false).

controlpanel_wb_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/seborama/govcr/v12/cassette/track"
+	"github.com/seborama/govcr/v13/cassette/track"
 )
 
 func TestControlPanel_SetRecordingMutators(t *testing.T) {

encryption/.study/rsa.go

@@ -11,7 +11,7 @@ import (
 	"github.com/pkg/errors"
 	"golang.org/x/crypto/ssh"
 
-	cryptoerr "github.com/seborama/govcr/v12/encryption/errors"
+	cryptoerr "github.com/seborama/govcr/v13/encryption/errors"
 )
 
 // nolint: deadcode

encryption/aesgcm.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	cryptoerr "github.com/seborama/govcr/v12/encryption/errors"
+	cryptoerr "github.com/seborama/govcr/v13/encryption/errors"
 )
 
 // NewAESGCMWithRandomNonceGenerator creates a new Cryptor initialised with an

encryption/aesgcm_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v12/encryption"
+	"github.com/seborama/govcr/v13/encryption"
 )
 
 func TestCryptor_AESGCM(t *testing.T) {

encryption/chacha20poly1305_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v12/encryption"
+	"github.com/seborama/govcr/v13/encryption"
 )
 
 func TestCryptor_ChaCha20Poly1305(t *testing.T) {

examples/Example1_test.go

@@ -4,9 +4,10 @@ import (
 	"os"
 	"testing"
 
-	"github.com/seborama/govcr/v12"
-	"github.com/seborama/govcr/v12/stats"
 	"github.com/stretchr/testify/assert"
+
+	"github.com/seborama/govcr/v13"
+	"github.com/seborama/govcr/v13/stats"
 )
 
 const exampleCassetteName1 = "temp-fixtures/TestExample1.cassette.json"
@@ -17,7 +18,7 @@ func TestExample1(t *testing.T) {
 
 	vcr := govcr.NewVCR(
 		govcr.NewCassetteLoader(exampleCassetteName1),
-		govcr.WithRequestMatcher(govcr.NewMethodURLRequestMatcher()), // use a "relaxed" request matcher
+		govcr.WithRequestMatchers(govcr.NewMethodURLRequestMatchers()...), // use a "relaxed" request matcher
 	)
 
 	// The first request will be live and transparently recorded by govcr since the cassette is empty
@@ -37,7 +38,7 @@ func TestExample1(t *testing.T) {
 	// No live HTTP request is placed to the live server
 	vcr = govcr.NewVCR(
 		govcr.NewCassetteLoader(exampleCassetteName1),
-		govcr.WithRequestMatcher(govcr.NewMethodURLRequestMatcher()), // use a "relaxed" request matcher
+		govcr.WithRequestMatchers(govcr.NewMethodURLRequestMatchers()...), // use a "relaxed" request matcher
 	)
 
 	vcr.HTTPClient().Get("http://example.com/foo")

examples/Example2_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/seborama/govcr/v12"
+	"github.com/seborama/govcr/v13"
 )
 
 const exampleCassetteName2 = "temp-fixtures/TestExample2.cassette.json"

examples/Example3_test.go

@@ -7,8 +7,8 @@ import (
 	"testing"
 
 	"github.com/google/uuid"
-	"github.com/seborama/govcr/v12"
-	"github.com/seborama/govcr/v12/cassette/track"
+	"github.com/seborama/govcr/v13"
+	"github.com/seborama/govcr/v13/cassette/track"
 	"github.com/stretchr/testify/require"
 )
 
@@ -21,7 +21,7 @@ func TestExample3(t *testing.T) {
 	// Instantiate VCR.
 	vcr := govcr.NewVCR(
 		govcr.NewCassetteLoader(exampleCassetteName3),
-		govcr.WithRequestMatcherFuncs(
+		govcr.WithRequestMatchers(
 			func(httpRequest, trackRequest *track.Request) bool {
 				// Remove the header from comparison.
 				// Note: this removal is only scoped to the request matcher, it does not affect the original HTTP request

examples/Example4_test.go

@@ -4,9 +4,9 @@ import (
 	"os"
 	"testing"
 
-	"github.com/seborama/govcr/v12"
-	"github.com/seborama/govcr/v12/encryption"
-	"github.com/seborama/govcr/v12/stats"
+	"github.com/seborama/govcr/v13"
+	"github.com/seborama/govcr/v13/encryption"
+	"github.com/seborama/govcr/v13/stats"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -22,7 +22,7 @@ func TestExample4(t *testing.T) {
 			WithCipher(
 				encryption.NewChaCha20Poly1305WithRandomNonceGenerator,
 				"test-fixtures/TestExample4.unsafe.key"),
-		govcr.WithRequestMatcher(govcr.NewMethodURLRequestMatcher()), // use a "relaxed" request matcher
+		govcr.WithRequestMatchers(govcr.NewMethodURLRequestMatchers()...), // use a "relaxed" request matcher
 	)
 
 	// The first request will be live and transparently recorded by govcr since the cassette is empty

go.mod

@@ -1,4 +1,4 @@
-module github.com/seborama/govcr/v12
+module github.com/seborama/govcr/v13
 
 go 1.17