Merge pull request #53 from fogfish/user-guide

Update User Guide
fogfish · Mar 19, 2023 · 15fa7ac · 15fa7ac
2 parents 1081a3f + 9e5fcde
commit 15fa7ac
Show file tree

Hide file tree

Showing 7 changed files with 346 additions and 298 deletions.
diff --git a/doc/user-guide.md b/doc/user-guide.md
diff --git a/examples/http-recursion/main.go b/examples/http-recursion/main.go
@@ -44,7 +44,7 @@ func request(page int) (*seq, http.Arrow) {
 		ø.Param("page", page),
 		ø.Accept.JSON,
 		ƒ.Status.OK,
-		ƒ.Recv(&seq),
+		ƒ.Body(&seq),
 	)
 }
 

diff --git a/examples/http-request/main.go b/examples/http-request/main.go
@@ -34,7 +34,7 @@ func request() http.Arrow {
 		// specify requirements to the response
 		ƒ.Status.OK,
 		ƒ.ContentType.JSON,
-		ƒ.Recv(&data),
+		ƒ.Body(&data),
 	)
 }
 

diff --git a/examples/http-response-chain/main.go b/examples/http-response-chain/main.go
@@ -48,7 +48,7 @@ func (hof *Heap) uuid() http.Arrow {
 
 		ƒ.Status.OK,
 		ƒ.ContentType.JSON,
-		ƒ.Recv(&hof.ID),
+		ƒ.Body(&hof.ID),
 	)
 }
 
@@ -62,7 +62,7 @@ func (hof *Heap) post() http.Arrow {
 		ø.Send(&hof.ID.UUID),
 
 		ƒ.Status.OK,
-		ƒ.Recv(&hof.HTTPBin),
+		ƒ.Body(&hof.HTTPBin),
 	)
 }
 

diff --git a/examples/http-response/main.go b/examples/http-response/main.go
@@ -53,7 +53,7 @@ func request() (*HTTPBin, http.Arrow) {
 		// HTTP Response
 		ƒ.Status.OK,
 		ƒ.ContentType.JSON,
-		ƒ.Recv(&data),
+		ƒ.Body(&data),
 
 		// asserts
 		data.validate,

diff --git a/http/recv/arrows.go b/http/recv/arrows.go
@@ -629,10 +629,10 @@ const (
 	Via              = HeaderOf[string]("Via")
 )
 
-// Recv applies auto decoders for response and returns either binary or
+// Body applies auto decoders for response and returns either binary or
 // native Go data structure. The Content-Type header give a hint to decoder.
 // Supply the pointer to data target data structure.
-func Recv[T any](out *T) http.Arrow {
+func Body[T any](out *T) http.Arrow {
 	return func(cat *http.Context) error {
 		err := decode(
 			cat.Response.Header.Get("Content-Type"),
@@ -645,6 +645,12 @@ func Recv[T any](out *T) http.Arrow {
 	}
 }
 
+// Recv is alias for Body, maintained only for compatibility
+func Recv[T any](out *T) http.Arrow {
+	return Body(out)
+}
+
+// Match received payload to defined pattern
 func Expect[T any](expect T) http.Arrow {
 	return func(cat *http.Context) error {
 		var actual T
@@ -728,26 +734,11 @@ func Match(val string) http.Arrow {
 	}
 }
 
-func equiv(pat, val map[string]any) bool {
-	for k, p := range pat {
-		v, has := val[k]
-		if !has {
-			return false
-		}
-
-		if p == "_" {
-			continue
-		}
-
-		if !equivVal(p, v) {
-			return false
-		}
+func equivVal(pat, val any) bool {
+	if pp, ok := pat.(string); ok && pp == "_" {
+		return true
 	}
 
-	return true
-}
-
-func equivVal(pat, val any) bool {
 	switch vv := val.(type) {
 	case string:
 		pp, ok := pat.(string)
@@ -786,8 +777,23 @@ func equivVal(pat, val any) bool {
 		if !ok {
 			return false
 		}
-		return equiv(pp, vv)
+		return equivMap(pp, vv)
 	}
 
 	return false
 }
+
+func equivMap(pat, val map[string]any) bool {
+	for k, p := range pat {
+		v, has := val[k]
+		if !has {
+			return false
+		}
+
+		if !equivVal(p, v) {
+			return false
+		}
+	}
+
+	return true
+}
diff --git a/http/recv/arrows_test.go b/http/recv/arrows_test.go
@@ -255,32 +255,38 @@ func TestHeaderUndefinedWithVal(t *testing.T) {
 	)
 }
 
-func TestRecvJSON(t *testing.T) {
+func TestBodyJSON(t *testing.T) {
 	type Site struct {
 		Site string `json:"site"`
 	}
 
 	ts := mock()
 	defer ts.Close()
 
-	var site Site
-	req := µ.GET(
-		ø.URI("%s/json", ø.Authority(ts.URL)),
-		ƒ.Status.OK,
-		ƒ.ContentType.ApplicationJSON,
-		ƒ.ContentType.JSON,
-		ƒ.Recv(&site),
-	)
-	cat := µ.New()
-	err := cat.IO(context.Background(), req)
+	for _, arrow := range []func(out *Site) µ.Arrow{
+		ƒ.Body[Site],
+		ƒ.Recv[Site],
+	} {
 
-	it.Then(t).Should(
-		it.Nil(err),
-		it.Equal(site.Site, "example.com"),
-	)
+		var site Site
+		req := µ.GET(
+			ø.URI("%s/json", ø.Authority(ts.URL)),
+			ƒ.Status.OK,
+			ƒ.ContentType.ApplicationJSON,
+			ƒ.ContentType.JSON,
+			arrow(&site),
+		)
+		cat := µ.New()
+		err := cat.IO(context.Background(), req)
+
+		it.Then(t).Should(
+			it.Nil(err),
+			it.Equal(site.Site, "example.com"),
+		)
+	}
 }
 
-func TestRecvForm(t *testing.T) {
+func TestBodyForm(t *testing.T) {
 	type Site struct {
 		Site string `json:"site"`
 	}
@@ -293,7 +299,7 @@ func TestRecvForm(t *testing.T) {
 		ø.URI("%s/form", ø.Authority(ts.URL)),
 		ƒ.Status.OK,
 		ƒ.ContentType.Form,
-		ƒ.Recv(&site),
+		ƒ.Body(&site),
 	)
 	cat := µ.New()
 	err := cat.IO(context.Background(), req)
@@ -395,6 +401,9 @@ func TestMatch(t *testing.T) {
 			`{"c":1.1}`,
 			`{"f":true}`,
 			`{"a":"a", "b":101, "c":1.1}`,
+			`{"d":["_", "_", "_"]}`,
+			`{"d":["a", "_", "_"]}`,
+			`{"d":["_", "b", "_"]}`,
 			`{"d":["a", "b", "c"]}`,
 			`{"e":{"a":"_"}}`,
 			`{"e":{"a":"a"}}`,