ref: internalise (#26)

core/core-defs.go

@@ -3,10 +3,32 @@ package core
 // core contains universal definitions and handles cross cutting concerns
 // try to keep to a minimum to reduce rippling changes
 
-type TraverseResult interface {
-}
+type (
+	// TraverseResult
+	TraverseResult interface {
+	}
 
-type DuffResult struct {
-}
+	// Client is the callback invoked for each file system node found
+	// during traversal.
+	Client func(node *Node) error
+)
 
-type Client func(node *Node) error
+type (
+	// SimpleHandler is a function that takes no parameters and can
+	// be used by any notification with this signature.
+	SimpleHandler func()
+
+	// BeginHandler invoked before traversal begins
+	BeginHandler func(root string)
+
+	// EndHandler invoked at the end of traversal
+	EndHandler func(result TraverseResult)
+
+	// HibernateHandler is a generic handler that is used by hibernation
+	// to indicate wake or sleep.
+	HibernateHandler func(description string)
+
+	// NodeHandler is a generic handler that is for any notification that contains
+	// the traversal node, such as directory ascend or descend.
+	NodeHandler func(node *Node)
+)

driver.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/snivilised/extendio/bus"
 	"github.com/snivilised/traverse/core"
+	"github.com/snivilised/traverse/internal/services"
 	"github.com/snivilised/traverse/internal/types"
 	"github.com/snivilised/traverse/kernel"
 	"github.com/snivilised/traverse/pref"
@@ -22,18 +23,18 @@ type duffNavigator struct {
 }
 
 func (n *duffNavigator) Navigate() (core.TraverseResult, error) {
-	return core.DuffResult{}, nil
+	return types.NavigateResult{}, nil
 }
 
 func init() {
 	h := bus.Handler{
 		Handle: func(_ context.Context, m bus.Message) {
 			m.Data.(types.ContextExpiry).Expired()
 		},
-		Matcher: core.TopicContextExpired,
+		Matcher: services.TopicContextExpired,
 	}
 
-	core.Broker.RegisterHandler(badge, h)
+	services.Broker.RegisterHandler(badge, h)
 }
 
 // replaces the runner in extendio, although it not
@@ -54,11 +55,9 @@ func Walk() Driver {
 	}
 }
 
-func Run(options ...pref.Option) Driver {
+func Run() Driver {
 	return &driver{
-		session: &session{
-			accelerationOptions: options,
-		},
+		session: &session{},
 	}
 }
 

hiber/hibernation-defs.go

@@ -4,7 +4,7 @@ import (
 	"context"
 
 	"github.com/snivilised/extendio/bus"
-	"github.com/snivilised/traverse/core"
+	"github.com/snivilised/traverse/internal/services"
 )
 
 const (
@@ -29,14 +29,14 @@ func init() {
 			//
 			_ = m.Data
 		},
-		Matcher: core.TopicOptionsAnnounce,
+		Matcher: services.TopicOptionsAnnounce,
 	}
 
-	core.Broker.RegisterHandler(badge, h)
+	services.Broker.RegisterHandler(badge, h)
 }
 
 // subscribe to options.before
 func RestoreOptions() {
-	// called bny resume to load options from json file and
+	// called by resume to load options from json file and
 	// setup registry to reflect this
 }

core/broker.go → internal/services/broker.go

@@ -1,20 +1,19 @@
-package core
+package services
 
-import (
-	"github.com/snivilised/extendio/bus"
-)
+import "github.com/snivilised/extendio/bus"
 
 const (
 	format               = "%03d"
+	TopicContextExpired  = "context.expired"
 	TopicOptionsAnnounce = "options.announce"
 	TopicOptionsBefore   = "options.before"
 	TopicOptionsComplete = "options.complete"
-	TopicContextExpired  = "context.expired"
 )
 
 var (
 	Broker *bus.Broker
 	topics = []string{
+		TopicContextExpired,
 		TopicOptionsAnnounce,
 		TopicOptionsBefore,
 		TopicOptionsComplete,

internal/types/definitions.go

@@ -1,5 +1,13 @@
 package types
 
-type ContextExpiry interface {
-	Expired() // ??? ctx context.Context, cancel context.CancelFunc
-}
+// package types
+
+type (
+	ContextExpiry interface {
+		Expired() // ??? ctx context.Context, cancel context.CancelFunc
+	}
+
+	// NavigateResult
+	NavigateResult struct {
+	}
+)

pref/options.go

@@ -6,9 +6,9 @@ import (
 	"runtime"
 
 	"github.com/snivilised/extendio/bus"
-	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/cycle"
 	"github.com/snivilised/traverse/enums"
+	"github.com/snivilised/traverse/internal/services"
 )
 
 // package: pref contains user option definitions; do not use anything in kernel (cyclic)
@@ -22,10 +22,10 @@ func init() {
 		Handle: func(_ context.Context, m bus.Message) {
 			_ = m.Data
 		},
-		Matcher: core.TopicOptionsAnnounce,
+		Matcher: services.TopicOptionsAnnounce,
 	}
 
-	core.Broker.RegisterHandler(badge, h)
+	services.Broker.RegisterHandler(badge, h)
 }
 
 type (

session.go

@@ -3,8 +3,6 @@ package traverse
 import (
 	"context"
 	"time"
-
-	"github.com/snivilised/traverse/pref"
 )
 
 type Session interface {
@@ -13,10 +11,9 @@ type Session interface {
 }
 
 type session struct {
-	started             time.Time
-	ctx                 context.Context
-	cancel              context.CancelFunc
-	accelerationOptions []pref.Option
+	started time.Time
+	ctx     context.Context
+	cancel  context.CancelFunc
 }
 
 func (s *session) StartedAt() time.Time {

traverse_test.go

@@ -25,9 +25,7 @@ var _ = Describe("Traverse", func() {
 
 					_, err := traverse.Walk().Primary(
 						"/root-path",
-						func(node *core.Node) error {
-							_ = node
-
+						func(_ *core.Node) error {
 							return nil
 						},
 						pref.WithSubscription(enums.SubscribeFiles),
@@ -67,16 +65,13 @@ var _ = Describe("Traverse", func() {
 					// something like "context.expired"
 					//
 					ctx := context.Background()
-					_, err := traverse.Run(
-						pref.WithContext(ctx),
-					).Primary(
+					_, err := traverse.Run().Primary(
 						"/root-path",
-						func(node *core.Node) error {
-							_ = node
-
+						func(_ *core.Node) error {
 							return nil
 						},
 						pref.WithSubscription(enums.SubscribeFiles),
+						pref.WithContext(ctx),
 					).Navigate()
 					Expect(err).To(Succeed())
 				})
@@ -87,17 +82,14 @@ var _ = Describe("Traverse", func() {
 					defer leaktest.Check(GinkgoT())()
 
 					ctx, cancel := context.WithCancel(context.Background())
-					_, err := traverse.Run(
-						pref.WithContext(ctx),
-						pref.WithCancel(cancel),
-					).Primary(
+					_, err := traverse.Run().Primary(
 						"/root-path",
-						func(node *core.Node) error {
-							_ = node
-
+						func(_ *core.Node) error {
 							return nil
 						},
 						pref.WithSubscription(enums.SubscribeFiles),
+						pref.WithContext(ctx),
+						pref.WithCancel(cancel),
 					).Navigate()
 					Expect(err).To(Succeed())
 				})
@@ -107,10 +99,10 @@ var _ = Describe("Traverse", func() {
 				It("should: run primary navigation successfully", func() {
 					defer leaktest.Check(GinkgoT())()
 
-					ctx := context.Background()
-					_, err := traverse.Run(
-						pref.WithContext(ctx),
-					).Resume(
+					// for resume, the context should be set in the
+					// restore function
+					//
+					_, err := traverse.Run().Resume(
 						"/from-restore-path",
 					).Navigate()
 					Expect(err).To(Succeed())