Skip to content

Commit

Permalink
ref: rename traverse to tv (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
@plastikfan
plastikfan committed May 20, 2024
1 parent 2e0ef67 commit 584876b
Show file tree
Hide file tree
Showing 9 changed files with 98 additions and 97 deletions.
2 changes: 1 addition & 1 deletion builders.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package traverse
package tv

import (
"errors"
Expand Down
37 changes: 19 additions & 18 deletions director-error_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
package traverse_test
package tv_test

import (
"fmt"

. "github.com/onsi/ginkgo/v2" //nolint:revive // ok
. "github.com/onsi/gomega" //nolint:revive // ok

"github.com/snivilised/traverse"
tv "github.com/snivilised/traverse"
"github.com/snivilised/traverse/internal/services"
)

type traverseErrorTE struct {
given string
using *traverse.Using
as *traverse.As
using *tv.Using
as *tv.As
}

var _ = Describe("director error", Ordered, func() {
var handler traverse.Client
var handler tv.Client

BeforeAll(func() {
handler = func(_ *traverse.Node) error {
handler = func(_ *tv.Node) error {
return nil
}
})
Expand All @@ -46,48 +46,49 @@ var _ = Describe("director error", Ordered, func() {
func(entry *traverseErrorTE) string {
return fmt.Sprintf("given: %v, 🧪 should fail", entry.given)
},

Entry(nil, &traverseErrorTE{
given: "using missing root path",
using: &traverse.Using{
Subscription: traverse.SubscribeFiles,
using: &tv.Using{
Subscription: tv.SubscribeFiles,
Handler: handler,
},
}),

Entry(nil, &traverseErrorTE{
given: "using missing subscription",
using: &traverse.Using{
using: &tv.Using{
Root: "/root-traverse-path",
Handler: handler,
},
}),

Entry(nil, &traverseErrorTE{
given: "using missing handler",
using: &traverse.Using{
using: &tv.Using{
Root: "/root-traverse-path",
Subscription: traverse.SubscribeFiles,
Subscription: tv.SubscribeFiles,
},
}),

Entry(nil, &traverseErrorTE{
given: "as missing restore from path",
as: &traverse.As{
Using: traverse.Using{
as: &tv.As{
Using: tv.Using{
Root: "/root-traverse-path",
Subscription: traverse.SubscribeFiles,
Subscription: tv.SubscribeFiles,
Handler: handler,
},
Strategy: traverse.ResumeStrategySpawn,
Strategy: tv.ResumeStrategySpawn,
},
}),

Entry(nil, &traverseErrorTE{
given: "as missing resume strategy",
as: &traverse.As{
Using: traverse.Using{
as: &tv.As{
Using: tv.Using{
Root: "/root-traverse-path",
Subscription: traverse.SubscribeFiles,
Subscription: tv.SubscribeFiles,
Handler: handler,
},
From: "/restore-from-path",
Expand Down
2 changes: 1 addition & 1 deletion director.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package traverse
package tv

import (
"github.com/snivilised/traverse/core"
Expand Down
144 changes: 72 additions & 72 deletions director_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package traverse_test
package tv_test

import (
"context"
Expand All @@ -7,7 +7,7 @@ import (
. "github.com/onsi/ginkgo/v2" //nolint:revive // ok
. "github.com/onsi/gomega" //nolint:revive // ok

"github.com/snivilised/traverse"
tv "github.com/snivilised/traverse"
"github.com/snivilised/traverse/core"
"github.com/snivilised/traverse/internal/services"
"github.com/snivilised/traverse/pref"
Expand All @@ -24,7 +24,7 @@ var _ = Describe("Traverse", Ordered, func() {
var restore pref.Option

BeforeAll(func() {
restore = func(o *traverse.Options) error {
restore = func(o *tv.Options) error {
o.Events.Begin.On(func(_ string) {})

return nil
Expand All @@ -44,15 +44,15 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: walk primary navigation successfully", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Walk().Configure().Extent(traverse.Prime(
traverse.Using{
_, err := tv.Walk().Configure().Extent(tv.Prime(
tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
traverse.WithSubscription(traverse.SubscribeFiles),
tv.WithSubscription(tv.SubscribeFiles),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -63,17 +63,17 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: walk resume navigation successfully", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Walk().Configure().Extent(traverse.Resume(
traverse.As{
Using: traverse.Using{
_, err := tv.Walk().Configure().Extent(tv.Resume(
tv.As{
Using: tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
From: RestorePath,
Strategy: traverse.ResumeStrategyFastward,
Strategy: tv.ResumeStrategyFastward,
},
restore,
)).Navigate()
Expand Down Expand Up @@ -104,16 +104,16 @@ var _ = Describe("Traverse", Ordered, func() {
// something like "context.expired"
//
ctx := context.Background()
_, err := traverse.Run().Configure().Extent(traverse.Prime(
traverse.Using{
_, err := tv.Run().Configure().Extent(tv.Prime(
tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
traverse.WithSubscription(traverse.SubscribeFiles),
traverse.WithContext(ctx),
tv.WithSubscription(tv.SubscribeFiles),
tv.WithContext(ctx),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -126,17 +126,17 @@ var _ = Describe("Traverse", Ordered, func() {

ctx, cancel := context.WithCancel(context.Background())

_, err := traverse.Run().Configure().Extent(traverse.Prime(
traverse.Using{
_, err := tv.Run().Configure().Extent(tv.Prime(
tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
traverse.WithSubscription(traverse.SubscribeFiles),
traverse.WithContext(ctx),
traverse.WithCancel(cancel),
tv.WithSubscription(tv.SubscribeFiles),
tv.WithContext(ctx),
tv.WithCancel(cancel),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -147,17 +147,17 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: perform run navigation successfully", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Run().Configure().Extent(traverse.Resume(
traverse.As{
Using: traverse.Using{
_, err := tv.Run().Configure().Extent(tv.Resume(
tv.As{
Using: tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
From: RestorePath,
Strategy: traverse.ResumeStrategySpawn,
Strategy: tv.ResumeStrategySpawn,
},
restore,
)).Navigate()
Expand All @@ -174,16 +174,16 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: register ok", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Walk().Configure().Extent(traverse.Prime(
traverse.Using{
_, err := tv.Walk().Configure().Extent(tv.Prime(
tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
traverse.WithSubscription(traverse.SubscribeFiles),
traverse.WithHibernation(&core.FilterDef{}),
tv.WithSubscription(tv.SubscribeFiles),
tv.WithHibernation(&core.FilterDef{}),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -194,16 +194,16 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: register ok", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Walk().Configure().Extent(traverse.Prime(
traverse.Using{
_, err := tv.Walk().Configure().Extent(tv.Prime(
tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
traverse.WithSubscription(traverse.SubscribeFiles),
traverse.WithFilter(&core.FilterDef{}),
tv.WithSubscription(tv.SubscribeFiles),
tv.WithFilter(&core.FilterDef{}),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -214,16 +214,16 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: register ok", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Walk().Configure().Extent(traverse.Prime(
traverse.Using{
_, err := tv.Walk().Configure().Extent(tv.Prime(
tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
traverse.WithSubscription(traverse.SubscribeFiles),
traverse.WithSampling(files, folders),
tv.WithSubscription(tv.SubscribeFiles),
tv.WithSampling(files, folders),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -236,19 +236,19 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: register ok", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Run().Configure().Extent(traverse.Resume(
traverse.As{
Using: traverse.Using{
_, err := tv.Run().Configure().Extent(tv.Resume(
tv.As{
Using: tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
From: RestorePath,
Strategy: traverse.ResumeStrategySpawn,
Strategy: tv.ResumeStrategySpawn,
},
traverse.WithHibernation(&core.FilterDef{}),
tv.WithHibernation(&core.FilterDef{}),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -259,19 +259,19 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: register ok", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Run().Configure().Extent(traverse.Resume(
traverse.As{
Using: traverse.Using{
_, err := tv.Run().Configure().Extent(tv.Resume(
tv.As{
Using: tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
From: RestorePath,
Strategy: traverse.ResumeStrategySpawn,
Strategy: tv.ResumeStrategySpawn,
},
traverse.WithFilter(&core.FilterDef{}),
tv.WithFilter(&core.FilterDef{}),
)).Navigate()

Expect(err).To(Succeed())
Expand All @@ -282,19 +282,19 @@ var _ = Describe("Traverse", Ordered, func() {
It("🧪 should: register ok", func() {
defer leaktest.Check(GinkgoT())()

_, err := traverse.Run().Configure().Extent(traverse.Resume(
traverse.As{
Using: traverse.Using{
_, err := tv.Run().Configure().Extent(tv.Resume(
tv.As{
Using: tv.Using{
Root: RootPath,
Subscription: traverse.SubscribeFiles,
Handler: func(_ *traverse.Node) error {
Subscription: tv.SubscribeFiles,
Handler: func(_ *tv.Node) error {
return nil
},
},
From: RestorePath,
Strategy: traverse.ResumeStrategySpawn,
Strategy: tv.ResumeStrategySpawn,
},
traverse.WithSampling(files, folders),
tv.WithSampling(files, folders),
)).Navigate()

Expect(err).To(Succeed())
Expand Down
Loading

0 comments on commit 584876b

Please sign in to comment.