Merge pull request #171 from philippgille/rename-proto-package-to-pro…

…tobuf

Rename proto package to protobuf

README.md

@@ -117,7 +117,7 @@ This repository contains the subpackage `encoding`, which is an abstraction and
 
 - [X] JSON
 - [X] [gob](https://blog.golang.org/gobs-of-data)
-- [X] [proto](https://pkg.go.dev/google.golang.org/protobuf/proto)
+- [X] [protobuf](https://pkg.go.dev/google.golang.org/protobuf)
 
 More formats will be supported in the future (e.g. XML).
 
@@ -132,7 +132,7 @@ Differences between the formats:
 - Depending on the use case, the custom (un-)marshal methods of one of the formats might be easier to implement
   - JSON: [`MarshalJSON() ([]byte, error)`](https://pkg.go.dev/encoding/json#Marshaler) and [`UnmarshalJSON([]byte) error`](https://pkg.go.dev/encoding/json#Unmarshaler)
   - gob: [`GobEncode() ([]byte, error)`](https://pkg.go.dev/encoding/gob#GobEncoder) and [`GobDecode([]byte) error`](https://pkg.go.dev/encoding/gob#GobDecoder)
-  - proto: [`Marshal(proto.Message) ([]byte, error)`](https://pkg.go.dev/google.golang.org/protobuf/proto#Marshal) and [`Unmarshal([]byte, proto.Message) error`](https://pkg.go.dev/google.golang.org/protobuf/proto#Unmarshal)
+  - protobuf: [`Marshal(proto.Message) ([]byte, error)`](https://pkg.go.dev/google.golang.org/protobuf/proto#Marshal) and [`Unmarshal([]byte, proto.Message) error`](https://pkg.go.dev/google.golang.org/protobuf/proto#Unmarshal)
 
 ### Roadmap
 

build/build.sh

@@ -25,6 +25,6 @@ done
 # Examples
 echo "building examples"
 (cd "$SCRIPT_DIR"/../examples/redis && go build -v) || (cd "$WORKING_DIR" && echo " failed" && exit 1)
-(cd "$SCRIPT_DIR"/../examples/proto_encoding && go build -v) || (cd "$WORKING_DIR" && echo " failed" && exit 1)
+(cd "$SCRIPT_DIR"/../examples/protobuf_encoding && go build -v) || (cd "$WORKING_DIR" && echo " failed" && exit 1)
 
 cd "$WORKING_DIR"

build/update-deps.sh

@@ -29,6 +29,6 @@ done
 
 # Examples
 (cd "$SCRIPT_DIR"/../examples/redis && go get $(go list -f '{{if not (or .Main .Indirect)}}{{.Path}}{{end}}' -m all) && go mod tidy) || (cd "$WORKING_DIR" && echo "update failed" && exit 1)
-(cd "$SCRIPT_DIR"/../examples/proto_encoding && go get $(go list -f '{{if not (or .Main .Indirect)}}{{.Path}}{{end}}' -m all) && go mod tidy) || (cd "$WORKING_DIR" && echo "update failed" && exit 1)
+(cd "$SCRIPT_DIR"/../examples/protobuf_encoding && go get $(go list -f '{{if not (or .Main .Indirect)}}{{.Path}}{{end}}' -m all) && go mod tidy) || (cd "$WORKING_DIR" && echo "update failed" && exit 1)
 
 cd "$WORKING_DIR"

encoding/protobuf/go.mod

@@ -0,0 +1,5 @@
+module github.com/philippgille/gokv/encoding/protobuf
+
+go 1.20
+
+require google.golang.org/protobuf v1.31.0

encoding/proto/proto.go → encoding/protobuf/protobuf.go

@@ -1,4 +1,4 @@
-package proto
+package protobuf
 
 import (
 	"errors"

examples/proto_encoding/README.md → examples/protobuf_encoding/README.md

@@ -1,5 +1,5 @@
-Proto encoding example
-======================
+Protobuf encoding example
+=========================
 
 For this example we already generated the Go file from the `.proto` file, so you can run it with `go run .`.
 
@@ -30,13 +30,13 @@ m := reflectedField.Interface().(map[string][]byte)
 rawVal := m["foo123"]
 fmt.Printf("Raw value: %s\n", rawVal)
 // Prints:
-//	Raw value:
-//	John Doe����johndoe@example.com"
+// Raw value:
+// John Doe����johndoe@example.com"
 //
-//	0123-456789"
+// 0123-456789"
 //
-//	0987-654321*
-//	           󟛪����
+// 0987-654321*
+//            󟛪����
 ```
 
 The reflection usage is only required because the example uses the `gomap` in-memory store. If it was using Redis or another remote store, you could just create a plain (non-`gokv`) client and retrieve the value with that. It would lead to the same result.

examples/proto_encoding/addressbook.proto → examples/protobuf_encoding/addressbook.proto

@@ -10,7 +10,7 @@ package tutorial;
 
 import "google/protobuf/timestamp.proto";
 
-option go_package = "github.com/philippgille/gokv/examples/proto_encoding/tutorialpb";
+option go_package = "github.com/philippgille/gokv/examples/protobuf_encoding/tutorialpb";
 
 message Person {
   string name = 1;

examples/proto_encoding/go.mod → examples/protobuf_encoding/go.mod

@@ -1,15 +1,15 @@
-module github.com/philippgille/gokv/examples/proto_encoding
+module github.com/philippgille/gokv/examples/protobuf_encoding
 
 go 1.20
 
 require (
 	github.com/philippgille/gokv v0.6.0
-	github.com/philippgille/gokv/encoding/proto v0.0.0
+	github.com/philippgille/gokv/encoding/protobuf v0.0.0
 	github.com/philippgille/gokv/gomap v0.6.0
 	google.golang.org/protobuf v1.32.0
 )
 
-replace github.com/philippgille/gokv/encoding/proto => ../../encoding/proto
+replace github.com/philippgille/gokv/encoding/protobuf => ../../encoding/protobuf
 
 require (
 	github.com/philippgille/gokv/encoding v0.6.0 // indirect

examples/proto_encoding/main.go → examples/protobuf_encoding/main.go

@@ -5,16 +5,16 @@ import (
 	"math/rand"
 
 	"github.com/philippgille/gokv"
-	"github.com/philippgille/gokv/encoding/proto"
-	"github.com/philippgille/gokv/examples/proto_encoding/tutorialpb"
+	"github.com/philippgille/gokv/encoding/protobuf"
+	"github.com/philippgille/gokv/examples/protobuf_encoding/tutorialpb"
 	"github.com/philippgille/gokv/gomap"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )
 
 func main() {
-	// Create store with customized options (using the proto codec)
+	// Create store with customized options (using the protobuf codec)
 	options := gomap.Options{
-		Codec: proto.Codec,
+		Codec: protobuf.Codec,
 	}
 	store := gomap.NewStore(options)
 	defer store.Close()