Merge pull request #29 from ucan-wg/feat/reorganize-packages

feat: reorganize packages
ucan-wg · Sep 24, 2024 · 4a65550 · 4a65550
2 parents 6161f2e + 93dd3ef
commit 4a65550
Show file tree

Hide file tree

Showing 37 changed files with 61 additions and 22 deletions.
diff --git a/capability/command/command.go → pkg/command/command.go b/capability/command/command.go → pkg/command/command.go
diff --git a/capability/command/command_errors.go → pkg/command/command_errors.go b/capability/command/command_errors.go → pkg/command/command_errors.go
diff --git a/capability/command/command_test.go → pkg/command/command_test.go b/capability/command/command_test.go → pkg/command/command_test.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/ucan-wg/go-ucan/capability/command"
+	"github.com/ucan-wg/go-ucan/pkg/command"
 )
 
 func TestTop(t *testing.T) {

diff --git a/pkg/meta/meta.go b/pkg/meta/meta.go
@@ -2,12 +2,16 @@ package meta
 
 import (
 	"errors"
+	"fmt"
+	"reflect"
 
 	"github.com/ipld/go-ipld-prime"
 	"github.com/ipld/go-ipld-prime/datamodel"
 	"github.com/ipld/go-ipld-prime/node/basicnode"
 )
 
+var ErrUnsupported = errors.New("failure adding unsupported type to meta")
+
 var ErrNotFound = errors.New("key-value not found in meta")
 
 // Meta is a container for meta key-value pairs in a UCAN token.
@@ -113,8 +117,20 @@ func (m *Meta) Add(key string, val any) error {
 	case datamodel.Node:
 		m.Values[key] = val
 	default:
-		panic("invalid value type")
+		return fmt.Errorf("%w: %s", ErrUnsupported, fqtn(val))
 	}
 	m.Keys = append(m.Keys, key)
 	return nil
 }
+
+func fqtn(val any) string {
+	var name string
+
+	t := reflect.TypeOf(val)
+	for t.Kind() == reflect.Pointer {
+		name += "*"
+		t = t.Elem()
+	}
+
+	return name + t.PkgPath() + "." + t.Name()
+}
diff --git a/pkg/meta/meta_test.go b/pkg/meta/meta_test.go
@@ -0,0 +1,23 @@
+package meta_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"github.com/ucan-wg/go-ucan/pkg/meta"
+	"gotest.tools/v3/assert"
+)
+
+func TestMeta_Add(t *testing.T) {
+	t.Parallel()
+
+	type Unsupported struct{}
+
+	t.Run("error if not primative or Node", func(t *testing.T) {
+		t.Parallel()
+
+		err := (&meta.Meta{}).Add("invalid", &Unsupported{})
+		require.ErrorIs(t, err, meta.ErrUnsupported)
+		assert.ErrorContains(t, err, "*github.com/ucan-wg/go-ucan/pkg/meta_test.Unsupported")
+	})
+}
diff --git a/capability/policy/glob.go → pkg/policy/glob.go b/capability/policy/glob.go → pkg/policy/glob.go
diff --git a/capability/policy/glob_test.go → pkg/policy/glob_test.go b/capability/policy/glob_test.go → pkg/policy/glob_test.go
diff --git a/capability/policy/ipld.go → pkg/policy/ipld.go b/capability/policy/ipld.go → pkg/policy/ipld.go
@@ -9,7 +9,7 @@ import (
 	"github.com/ipld/go-ipld-prime/must"
 	"github.com/ipld/go-ipld-prime/node/basicnode"
 
-	"github.com/ucan-wg/go-ucan/capability/policy/selector"
+	"github.com/ucan-wg/go-ucan/pkg/policy/selector"
 )
 
 func FromIPLD(node datamodel.Node) (Policy, error) {

diff --git a/capability/policy/ipld_errors.go → pkg/policy/ipld_errors.go b/capability/policy/ipld_errors.go → pkg/policy/ipld_errors.go
diff --git a/capability/policy/ipld_test.go → pkg/policy/ipld_test.go b/capability/policy/ipld_test.go → pkg/policy/ipld_test.go
diff --git a/capability/policy/literal/literal.go → pkg/policy/literal/literal.go b/capability/policy/literal/literal.go → pkg/policy/literal/literal.go
diff --git a/capability/policy/match.go → pkg/policy/match.go b/capability/policy/match.go → pkg/policy/match.go
@@ -8,7 +8,7 @@ import (
 	"github.com/ipld/go-ipld-prime/datamodel"
 	"github.com/ipld/go-ipld-prime/must"
 
-	"github.com/ucan-wg/go-ucan/capability/policy/selector"
+	"github.com/ucan-wg/go-ucan/pkg/policy/selector"
 )
 
 // Match determines if the IPLD node matches the policy document.

diff --git a/capability/policy/match_test.go → pkg/policy/match_test.go b/capability/policy/match_test.go → pkg/policy/match_test.go
@@ -11,8 +11,8 @@ import (
 	"github.com/ipld/go-ipld-prime/node/basicnode"
 	"github.com/stretchr/testify/require"
 
-	"github.com/ucan-wg/go-ucan/capability/policy/literal"
-	"github.com/ucan-wg/go-ucan/capability/policy/selector"
+	"github.com/ucan-wg/go-ucan/pkg/policy/literal"
+	"github.com/ucan-wg/go-ucan/pkg/policy/selector"
 )
 
 func TestMatch(t *testing.T) {

diff --git a/capability/policy/policy.go → pkg/policy/policy.go b/capability/policy/policy.go → pkg/policy/policy.go
@@ -5,7 +5,7 @@ package policy
 import (
 	"github.com/ipld/go-ipld-prime"
 
-	"github.com/ucan-wg/go-ucan/capability/policy/selector"
+	"github.com/ucan-wg/go-ucan/pkg/policy/selector"
 )
 
 const (

diff --git a/capability/policy/selector/parsing.go → pkg/policy/selector/parsing.go b/capability/policy/selector/parsing.go → pkg/policy/selector/parsing.go
diff --git a/capability/policy/selector/selector.go → pkg/policy/selector/selector.go b/capability/policy/selector/selector.go → pkg/policy/selector/selector.go
diff --git a/capability/policy/selector/selector_test.go → pkg/policy/selector/selector_test.go b/capability/policy/selector/selector_test.go → pkg/policy/selector/selector_test.go
diff --git a/capability/policy/selector/supported_test.go → pkg/policy/selector/supported_test.go b/capability/policy/selector/supported_test.go → pkg/policy/selector/supported_test.go
@@ -12,7 +12,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/ucan-wg/go-ucan/capability/policy/selector"
+	"github.com/ucan-wg/go-ucan/pkg/policy/selector"
 )
 
 // TestSupported Forms runs tests against the Selector according to the

diff --git a/delegation/delegation.go → tokens/delegation/delegation.go b/delegation/delegation.go → tokens/delegation/delegation.go
@@ -18,10 +18,10 @@ import (
 	"github.com/ipfs/go-cid"
 	"github.com/libp2p/go-libp2p/core/crypto"
 
-	"github.com/ucan-wg/go-ucan/capability/command"
-	"github.com/ucan-wg/go-ucan/capability/policy"
 	"github.com/ucan-wg/go-ucan/did"
+	"github.com/ucan-wg/go-ucan/pkg/command"
 	"github.com/ucan-wg/go-ucan/pkg/meta"
+	"github.com/ucan-wg/go-ucan/pkg/policy"
 )
 
 // Token is an immutable type that holds the fields of a UCAN delegation.

diff --git a/delegation/delegation.ipldsch → tokens/delegation/delegation.ipldsch b/delegation/delegation.ipldsch → tokens/delegation/delegation.ipldsch
diff --git a/delegation/delegation_test.go → tokens/delegation/delegation_test.go b/delegation/delegation_test.go → tokens/delegation/delegation_test.go
@@ -8,10 +8,10 @@ import (
 	"github.com/stretchr/testify/require"
 	"gotest.tools/v3/golden"
 
-	"github.com/ucan-wg/go-ucan/capability/command"
-	"github.com/ucan-wg/go-ucan/capability/policy"
-	"github.com/ucan-wg/go-ucan/delegation"
 	"github.com/ucan-wg/go-ucan/did"
+	"github.com/ucan-wg/go-ucan/pkg/command"
+	"github.com/ucan-wg/go-ucan/pkg/policy"
+	"github.com/ucan-wg/go-ucan/tokens/delegation"
 )
 
 const (

diff --git a/delegation/ipld.go → tokens/delegation/ipld.go b/delegation/ipld.go → tokens/delegation/ipld.go
@@ -12,7 +12,7 @@ import (
 	"github.com/libp2p/go-libp2p/core/crypto"
 
 	"github.com/ucan-wg/go-ucan/did"
-	"github.com/ucan-wg/go-ucan/internal/envelope"
+	"github.com/ucan-wg/go-ucan/tokens/internal/envelope"
 )
 
 // ToSealed wraps the delegation token in an envelope, generates the

diff --git a/delegation/options.go → tokens/delegation/options.go b/delegation/options.go → tokens/delegation/options.go
diff --git a/delegation/schema.go → tokens/delegation/schema.go b/delegation/schema.go → tokens/delegation/schema.go
@@ -10,8 +10,8 @@ import (
 	"github.com/ipld/go-ipld-prime/node/bindnode"
 	"github.com/ipld/go-ipld-prime/schema"
 
-	"github.com/ucan-wg/go-ucan/internal/envelope"
 	"github.com/ucan-wg/go-ucan/pkg/meta"
+	"github.com/ucan-wg/go-ucan/tokens/internal/envelope"
 )
 
 // [Tag] is the string used as a key within the SigPayload that identifies

diff --git a/delegation/schema_test.go → tokens/delegation/schema_test.go b/delegation/schema_test.go → tokens/delegation/schema_test.go
@@ -11,8 +11,8 @@ import (
 	"github.com/stretchr/testify/require"
 	"gotest.tools/v3/golden"
 
-	"github.com/ucan-wg/go-ucan/delegation"
-	"github.com/ucan-wg/go-ucan/internal/envelope"
+	"github.com/ucan-wg/go-ucan/tokens/delegation"
+	"github.com/ucan-wg/go-ucan/tokens/internal/envelope"
 )
 
 //go:embed delegation.ipldsch

diff --git a/delegation/testdata/new.dagjson → tokens/delegation/testdata/new.dagjson b/delegation/testdata/new.dagjson → tokens/delegation/testdata/new.dagjson
diff --git a/delegation/testdata/root.dagjson → tokens/delegation/testdata/root.dagjson b/delegation/testdata/root.dagjson → tokens/delegation/testdata/root.dagjson
diff --git a/internal/envelope/cid.go → tokens/internal/envelope/cid.go b/internal/envelope/cid.go → tokens/internal/envelope/cid.go
diff --git a/internal/envelope/cid_test.go → tokens/internal/envelope/cid_test.go b/internal/envelope/cid_test.go → tokens/internal/envelope/cid_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"gotest.tools/v3/golden"
 
-	"github.com/ucan-wg/go-ucan/internal/envelope"
+	"github.com/ucan-wg/go-ucan/tokens/internal/envelope"
 )
 
 func TestCidFromBytes(t *testing.T) {

diff --git a/internal/envelope/example_test.go → tokens/internal/envelope/example_test.go b/internal/envelope/example_test.go → tokens/internal/envelope/example_test.go
@@ -16,7 +16,7 @@ import (
 	"github.com/ipld/go-ipld-prime/schema"
 	"github.com/libp2p/go-libp2p/core/crypto"
 	"github.com/stretchr/testify/require"
-	"github.com/ucan-wg/go-ucan/internal/envelope"
+	"github.com/ucan-wg/go-ucan/tokens/internal/envelope"
 	"gotest.tools/v3/golden"
 )
 

diff --git a/internal/envelope/ipld.go → tokens/internal/envelope/ipld.go b/internal/envelope/ipld.go → tokens/internal/envelope/ipld.go
@@ -41,7 +41,7 @@ import (
 	"github.com/libp2p/go-libp2p/core/crypto"
 
 	"github.com/ucan-wg/go-ucan/did"
-	"github.com/ucan-wg/go-ucan/internal/varsig"
+	"github.com/ucan-wg/go-ucan/tokens/internal/varsig"
 )
 
 const varsigHeaderKey = "h"

diff --git a/internal/envelope/ipld_test.go → tokens/internal/envelope/ipld_test.go b/internal/envelope/ipld_test.go → tokens/internal/envelope/ipld_test.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"github.com/ucan-wg/go-ucan/internal/envelope"
+	"github.com/ucan-wg/go-ucan/tokens/internal/envelope"
 	"gotest.tools/v3/golden"
 )
 

diff --git a/internal/envelope/testdata/example.dagcbor → ...nternal/envelope/testdata/example.dagcbor b/internal/envelope/testdata/example.dagcbor → ...nternal/envelope/testdata/example.dagcbor
diff --git a/internal/envelope/testdata/example.dagjson → ...nternal/envelope/testdata/example.dagjson b/internal/envelope/testdata/example.dagjson → ...nternal/envelope/testdata/example.dagjson
diff --git a/internal/envelope/testdata/example.ipldsch → ...nternal/envelope/testdata/example.ipldsch b/internal/envelope/testdata/example.ipldsch → ...nternal/envelope/testdata/example.ipldsch
diff --git a/internal/varsig/varsig.go → tokens/internal/varsig/varsig.go b/internal/varsig/varsig.go → tokens/internal/varsig/varsig.go
diff --git a/internal/varsig/varsig_test.go → tokens/internal/varsig/varsig_test.go b/internal/varsig/varsig_test.go → tokens/internal/varsig/varsig_test.go
@@ -8,7 +8,7 @@ import (
 	"github.com/libp2p/go-libp2p/core/crypto/pb"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/ucan-wg/go-ucan/internal/varsig"
+	"github.com/ucan-wg/go-ucan/tokens/internal/varsig"
 )
 
 func TestDecode(t *testing.T) {