Merge pull request #67 from graph-gophers/use-modules

Migrate from dep to modules

Author: tonyghita

.travis.yml

@@ -1,12 +1,11 @@
 language: go
 
 go:
-  - 1.8
-  - 1.x
+  - 1.15
+  - 1.14
 
 install:
-  - go get -u github.com/golang/dep/...
-  - dep ensure
+  - go mod install
 
 script:
   - go test -v -race -coverprofile=coverage.txt -covermode=atomic

Godeps/Godeps.json

@@ -86,3 +86,14 @@ type Cache interface {
 	Clear()
 }
 ```
+
+## Upgrade from v5 to v6
+
+We add major version release because we switched to using Go Modules from dep,
+and drop build tags for older versions of Go (1.9).
+
+The preferred import method includes the major version tag.
+
+```go
+import "github.com/graph-gophers/dataloader/v6"
+```

Godeps/Readme

@@ -1,22 +1,23 @@
+package lru_cache_test
+
 // This is an exmaple of using go-cache as a long term cache solution for
 // dataloader.
-package main
 
 import (
 	"context"
 	"fmt"
 
+	dataloader "github.com/graph-gophers/dataloader/v6"
 	lru "github.com/hashicorp/golang-lru"
-	"github.com/nicksrandall/dataloader"
 )
 
 // Cache implements the dataloader.Cache interface
-type Cache struct {
+type cache struct {
 	*lru.ARCCache
 }
 
 // Get gets an item from the cache
-func (c *Cache) Get(_ context.Context, key dataloader.Key) (dataloader.Thunk, bool) {
+func (c *cache) Get(_ context.Context, key dataloader.Key) (dataloader.Thunk, bool) {
 	v, ok := c.ARCCache.Get(key)
 	if ok {
 		return v.(dataloader.Thunk), ok
@@ -25,12 +26,12 @@ func (c *Cache) Get(_ context.Context, key dataloader.Key) (dataloader.Thunk, bo
 }
 
 // Set sets an item in the cache
-func (c *Cache) Set(_ context.Context, key dataloader.Key, value dataloader.Thunk) {
+func (c *cache) Set(_ context.Context, key dataloader.Key, value dataloader.Thunk) {
 	c.ARCCache.Add(key, value)
 }
 
 // Delete deletes an item in the cache
-func (c *Cache) Delete(_ context.Context, key dataloader.Key) bool {
+func (c *cache) Delete(_ context.Context, key dataloader.Key) bool {
 	if c.ARCCache.Contains(key) {
 		c.ARCCache.Remove(key)
 		return true
@@ -39,14 +40,14 @@ func (c *Cache) Delete(_ context.Context, key dataloader.Key) bool {
 }
 
 // Clear cleasrs the cache
-func (c *Cache) Clear() {
+func (c *cache) Clear() {
 	c.ARCCache.Purge()
 }
 
-func main() {
-	// go-cache will automaticlly cleanup expired items on given diration
+func ExampleGolangLRU() {
+	// go-cache will automaticlly cleanup expired items on given duration.
 	c, _ := lru.NewARC(100)
-	cache := &Cache{c}
+	cache := &cache{ARCCache: c}
 	loader := dataloader.NewBatchedLoader(batchFunc, dataloader.WithCache(cache))
 
 	// immediately call the future function from loader
@@ -55,14 +56,15 @@ func main() {
 		// handle error
 	}
 
-	fmt.Printf("identity: %s\n", result)
+	fmt.Printf("identity: %s", result)
+	// Output: identity: some key
 }
 
 func batchFunc(_ context.Context, keys dataloader.Keys) []*dataloader.Result {
 	var results []*dataloader.Result
 	// do some pretend work to resolve keys
 	for _, key := range keys {
-		results = append(results, &dataloader.Result{key.String(), nil})
+		results = append(results, &dataloader.Result{Data: key.String()})
 	}
 	return results
 }

Gopkg.lock

@@ -1,13 +1,13 @@
-package main
+package no_cache_test
 
 import (
 	"context"
 	"fmt"
 
-	"github.com/graph-gophers/dataloader"
+	dataloader "github.com/graph-gophers/dataloader/v6"
 )
 
-func main() {
+func ExampleNoCache() {
 	// go-cache will automaticlly cleanup expired items on given diration
 	cache := &dataloader.NoCache{}
 	loader := dataloader.NewBatchedLoader(batchFunc, dataloader.WithCache(cache))
@@ -17,14 +17,15 @@ func main() {
 		// handle error
 	}
 
-	fmt.Printf("identity: %s\n", result)
+	fmt.Printf("identity: %s", result)
+	// Output: identity: some key
 }
 
 func batchFunc(_ context.Context, keys dataloader.Keys) []*dataloader.Result {
 	var results []*dataloader.Result
 	// do some pretend work to resolve keys
 	for _, key := range keys {
-		results = append(results, &dataloader.Result{key.String(), nil})
+		results = append(results, &dataloader.Result{Data: key.String()})
 	}
 	return results
 }

Gopkg.toml

@@ -1,13 +1,13 @@
 // This is an exmaple of using go-cache as a long term cache solution for
 // dataloader.
-package main
+package ttl_cache_test
 
 import (
 	"context"
 	"fmt"
 	"time"
 
-	"github.com/nicksrandall/dataloader"
+	dataloader "github.com/graph-gophers/dataloader/v6"
 	cache "github.com/patrickmn/go-cache"
 )
 
@@ -44,7 +44,7 @@ func (c *Cache) Clear() {
 	c.c.Flush()
 }
 
-func main() {
+func ExampleTTLCache() {
 	// go-cache will automaticlly cleanup expired items on given diration
 	c := cache.New(15*time.Minute, 15*time.Minute)
 	cache := &Cache{c}
@@ -56,14 +56,15 @@ func main() {
 		// handle error
 	}
 
-	fmt.Printf("identity: %s\n", result)
+	fmt.Printf("identity: %s", result)
+	// Output: identity: some key
 }
 
 func batchFunc(_ context.Context, keys dataloader.Keys) []*dataloader.Result {
 	var results []*dataloader.Result
 	// do some pretend work to resolve keys
 	for _, key := range keys {
-		results = append(results, &dataloader.Result{key.String(), nil})
+		results = append(results, &dataloader.Result{Data: key.String()})
 	}
 	return results
 }

MIGRATE.md

@@ -0,0 +1,10 @@
+module github.com/graph-gophers/dataloader/v6
+
+go 1.15
+
+require (
+	github.com/hashicorp/golang-lru v0.5.4
+	github.com/opentracing/opentracing-go v1.2.0
+	github.com/patrickmn/go-cache v2.1.0+incompatible
+	github.com/stretchr/testify v1.6.1 // indirect
+)