ref: rename hibernation life-cycle events start and stop (#166)

snivilised · Sep 4, 2024 · f25cdf9 · f25cdf9
1 parent 6edd565
commit f25cdf9
Show file tree

Hide file tree

Showing 11 changed files with 72 additions and 72 deletions.
diff --git a/cycle/event-start_test.go → cycle/event-sleep_test.go b/cycle/event-start_test.go → cycle/event-sleep_test.go
@@ -10,17 +10,17 @@ import (
 var _ = Describe("event", func() {
 	var description string
 
-	Context("start", func() {
+	Context("sleep", func() {
 		Context("single", func() {
 			When("listener", func() {
 				It("🧪 should: invoke client's handler", func() {
 					invoked := false
 					o, _ := pref.Get()
 
-					o.Events.Start.On(func(_ string) {
+					o.Events.Sleep.On(func(_ string) {
 						invoked = true
 					})
-					o.Binder.Controls.Start.Dispatch()(description)
+					o.Binder.Controls.Sleep.Dispatch()(description)
 
 					Expect(invoked).To(BeTrue())
 				})
@@ -31,16 +31,16 @@ var _ = Describe("event", func() {
 					invoked := false
 					o, _ := pref.Get()
 
-					o.Events.Start.On(func(_ string) {
+					o.Events.Sleep.On(func(_ string) {
 						invoked = true
 					})
-					o.Binder.Controls.Start.Mute()
-					o.Binder.Controls.Start.Dispatch()(description)
+					o.Binder.Controls.Sleep.Mute()
+					o.Binder.Controls.Sleep.Dispatch()(description)
 					Expect(invoked).To(BeFalse(), "notification not muted")
 
 					invoked = false
-					o.Binder.Controls.Start.Unmute()
-					o.Binder.Controls.Start.Dispatch()(description)
+					o.Binder.Controls.Sleep.Unmute()
+					o.Binder.Controls.Sleep.Dispatch()(description)
 					Expect(invoked).To(BeTrue(), "notification not muted")
 				})
 			})
@@ -52,21 +52,21 @@ var _ = Describe("event", func() {
 					count := 0
 					o, _ := pref.Get()
 
-					o.Events.Start.On(func(_ string) {
+					o.Events.Sleep.On(func(_ string) {
 						count++
 					})
-					o.Events.Start.On(func(_ string) {
+					o.Events.Sleep.On(func(_ string) {
 						count++
 					})
-					o.Binder.Controls.Start.Dispatch()(description)
+					o.Binder.Controls.Sleep.Dispatch()(description)
 					Expect(count).To(Equal(2), "not all listeners were invoked for first notification")
 
 					count = 0
-					o.Events.Start.On(func(_ string) {
+					o.Events.Sleep.On(func(_ string) {
 						count++
 					})
 
-					o.Binder.Controls.Start.Dispatch()(description)
+					o.Binder.Controls.Sleep.Dispatch()(description)
 					Expect(count).To(Equal(3), "not all listeners were invoked for second notification")
 				})
 			})
@@ -76,15 +76,15 @@ var _ = Describe("event", func() {
 					count := 0
 					o, _ := pref.Get()
 
-					o.Events.Start.On(func(_ string) {
+					o.Events.Sleep.On(func(_ string) {
 						count++
 					})
-					o.Events.Start.On(func(_ string) {
+					o.Events.Sleep.On(func(_ string) {
 						count++
 					})
 
-					o.Binder.Controls.Start.Mute()
-					o.Binder.Controls.Start.Dispatch()(description)
+					o.Binder.Controls.Sleep.Mute()
+					o.Binder.Controls.Sleep.Dispatch()(description)
 
 					Expect(count).To(Equal(0), "notification not muted")
 				})
@@ -95,7 +95,7 @@ var _ = Describe("event", func() {
 			It("🧪 should: invoke no-op", func() {
 				o, _ := pref.Get()
 
-				o.Binder.Controls.Start.Dispatch()(description)
+				o.Binder.Controls.Sleep.Dispatch()(description)
 			})
 		})
 	})

diff --git a/cycle/event-stop_test.go → cycle/event-wake_test.go b/cycle/event-stop_test.go → cycle/event-wake_test.go
@@ -10,17 +10,17 @@ import (
 var _ = Describe("event", func() {
 	var description string
 
-	Context("stop", func() {
+	Context("wake", func() {
 		Context("single", func() {
 			When("listener", func() {
 				It("🧪 should: invoke client's handler", func() {
 					invoked := false
 					o, _ := pref.Get()
 
-					o.Events.Stop.On(func(_ string) {
+					o.Events.Wake.On(func(_ string) {
 						invoked = true
 					})
-					o.Binder.Controls.Stop.Dispatch()(description)
+					o.Binder.Controls.Wake.Dispatch()(description)
 
 					Expect(invoked).To(BeTrue())
 				})
@@ -31,16 +31,16 @@ var _ = Describe("event", func() {
 					invoked := false
 					o, _ := pref.Get()
 
-					o.Events.Stop.On(func(_ string) {
+					o.Events.Wake.On(func(_ string) {
 						invoked = true
 					})
-					o.Binder.Controls.Stop.Mute()
-					o.Binder.Controls.Stop.Dispatch()(description)
+					o.Binder.Controls.Wake.Mute()
+					o.Binder.Controls.Wake.Dispatch()(description)
 					Expect(invoked).To(BeFalse(), "notification not muted")
 
 					invoked = false
-					o.Binder.Controls.Stop.Unmute()
-					o.Binder.Controls.Stop.Dispatch()(description)
+					o.Binder.Controls.Wake.Unmute()
+					o.Binder.Controls.Wake.Dispatch()(description)
 					Expect(invoked).To(BeTrue(), "notification not muted")
 				})
 			})
@@ -52,21 +52,21 @@ var _ = Describe("event", func() {
 					count := 0
 					o, _ := pref.Get()
 
-					o.Events.Stop.On(func(_ string) {
+					o.Events.Wake.On(func(_ string) {
 						count++
 					})
-					o.Events.Stop.On(func(_ string) {
+					o.Events.Wake.On(func(_ string) {
 						count++
 					})
-					o.Binder.Controls.Stop.Dispatch()(description)
+					o.Binder.Controls.Wake.Dispatch()(description)
 					Expect(count).To(Equal(2), "not all listeners were invoked for first notification")
 
 					count = 0
-					o.Events.Stop.On(func(_ string) {
+					o.Events.Wake.On(func(_ string) {
 						count++
 					})
 
-					o.Binder.Controls.Stop.Dispatch()(description)
+					o.Binder.Controls.Wake.Dispatch()(description)
 					Expect(count).To(Equal(3), "not all listeners were invoked for second notification")
 				})
 			})
@@ -76,15 +76,15 @@ var _ = Describe("event", func() {
 					count := 0
 					o, _ := pref.Get()
 
-					o.Events.Stop.On(func(_ string) {
+					o.Events.Wake.On(func(_ string) {
 						count++
 					})
-					o.Events.Stop.On(func(_ string) {
+					o.Events.Wake.On(func(_ string) {
 						count++
 					})
 
-					o.Binder.Controls.Stop.Mute()
-					o.Binder.Controls.Stop.Dispatch()(description)
+					o.Binder.Controls.Wake.Mute()
+					o.Binder.Controls.Wake.Dispatch()(description)
 
 					Expect(count).To(Equal(0), "notification not muted")
 				})
@@ -95,7 +95,7 @@ var _ = Describe("event", func() {
 			It("🧪 should: invoke no-op", func() {
 				o, _ := pref.Get()
 
-				o.Binder.Controls.Stop.Dispatch()(description)
+				o.Binder.Controls.Wake.Dispatch()(description)
 			})
 		})
 	})

diff --git a/cycle/events.go b/cycle/events.go
@@ -21,8 +21,8 @@ type (
 		Begin   Event[BeginHandler]
 		Descend Event[NodeHandler]
 		End     Event[EndHandler]
-		Start   Event[HibernateHandler]
-		Stop    Event[HibernateHandler]
+		Wake    Event[HibernateHandler]
+		Sleep   Event[HibernateHandler]
 	}
 
 	// since the Controls are only required internally as they are used
@@ -35,8 +35,8 @@ type (
 		Begin   NotificationCtrl[BeginHandler]
 		Descend NotificationCtrl[NodeHandler]
 		End     NotificationCtrl[EndHandler]
-		Start   NotificationCtrl[HibernateHandler]
-		Stop    NotificationCtrl[HibernateHandler]
+		Wake    NotificationCtrl[HibernateHandler]
+		Sleep   NotificationCtrl[HibernateHandler]
 	}
 )
 
@@ -58,8 +58,8 @@ func NewControls() Controls {
 		Begin:   *NewNotificationCtrl[BeginHandler](nopBegin, broadcastBegin),
 		Descend: *NewNotificationCtrl[NodeHandler](nopNode, broadcastNode),
 		End:     *NewNotificationCtrl[EndHandler](nopEnd, broadcastEnd),
-		Start:   *NewNotificationCtrl[HibernateHandler](nopHibernate, broadcastHibernate),
-		Stop:    *NewNotificationCtrl[HibernateHandler](nopHibernate, broadcastHibernate),
+		Wake:    *NewNotificationCtrl[HibernateHandler](nopHibernate, broadcastHibernate),
+		Sleep:   *NewNotificationCtrl[HibernateHandler](nopHibernate, broadcastHibernate),
 	}
 }
 
@@ -70,8 +70,8 @@ func (e *Events) Bind(cs *Controls) {
 	e.Begin = &cs.Begin
 	e.Descend = &cs.Descend
 	e.End = &cs.End
-	e.Start = &cs.Start
-	e.Stop = &cs.Stop
+	e.Wake = &cs.Wake
+	e.Sleep = &cs.Sleep
 }
 
 // On subscribes to a life cycle event

diff --git a/director-prime_test.go b/director-prime_test.go
@@ -155,7 +155,7 @@ var _ = Describe("Director(Prime)", Ordered, func() {
 							Handler:      noOpHandler,
 						},
 						tv.WithFilter(&pref.FilterOptions{}),
-						tv.WithOnStart(func(_ string) {}),
+						tv.WithOnWake(func(_ string) {}),
 					)).Navigate(ctx)
 
 					Expect(err).To(Succeed())
@@ -180,7 +180,7 @@ var _ = Describe("Director(Prime)", Ordered, func() {
 							Type:        enums.FilterTypeGlob,
 							Pattern:     "*",
 						}),
-						tv.WithOnStop(func(_ string) {}),
+						tv.WithOnSleep(func(_ string) {}),
 					)).Navigate(ctx)
 
 					Expect(err).To(Succeed())
@@ -205,7 +205,7 @@ var _ = Describe("Director(Prime)", Ordered, func() {
 							Type:        enums.FilterTypeGlob,
 							Pattern:     "*",
 						}),
-						tv.WithOnStop(func(_ string) {}),
+						tv.WithOnSleep(func(_ string) {}),
 					)).Navigate(ctx)
 
 					Expect(err).To(Succeed())

diff --git a/enums/notification-en.go b/enums/notification-en.go
@@ -14,7 +14,7 @@ const (
 	NotificationEnd                                          // end-notification
 	NotificationDescend                                      // descend-notification
 	NotificationAscend                                       // ascend-notification
-	NotificationStart                                        // start-notification
-	NotificationStop                                         // stop-notification
+	NotificationWake                                         // wake-notification
+	NotificationSleep                                        // sleep-notification
 	NotificationAll       = math.MaxUint32                   // all-notification
 )
diff --git a/internal/feat/hiber/hibernate-simple-profile.go b/internal/feat/hiber/hibernate-simple-profile.go
@@ -74,7 +74,7 @@ func (p *simple) create() hibernateStates {
 		enums.HibernationPending: state{
 			next: func(node *core.Node, _ override.Inspection) (bool, error) {
 				if p.common.triggers.wake.IsMatch(node) {
-					p.controls.Start.Dispatch()(p.common.triggers.wake.Description())
+					p.controls.Wake.Dispatch()(p.common.triggers.wake.Description())
 					p.transition(enums.HibernationActive)
 
 					if p.common.ho.Behaviour.InclusiveWake {
@@ -89,7 +89,7 @@ func (p *simple) create() hibernateStates {
 		enums.HibernationActive: state{
 			next: func(node *core.Node, _ override.Inspection) (bool, error) {
 				if p.common.triggers.sleep.IsMatch(node) {
-					p.controls.Stop.Dispatch()(p.common.triggers.sleep.Description())
+					p.controls.Sleep.Dispatch()(p.common.triggers.sleep.Description())
 					p.transition(enums.HibernationRetired)
 
 					if p.common.ho.Behaviour.InclusiveSleep {

diff --git a/internal/feat/hiber/hibernate_test.go b/internal/feat/hiber/hibernate_test.go
@@ -65,11 +65,11 @@ var _ = Describe("feature", Ordered, func() {
 							},
 						},
 
-						tv.WithOnStart(func(description string) {
+						tv.WithOnWake(func(description string) {
 							GinkgoWriter.Printf("===> 🔊 Wake: '%v'\n", description)
 						}),
 
-						tv.WithOnStop(func(description string) {
+						tv.WithOnSleep(func(description string) {
 							GinkgoWriter.Printf("===> 🔇 Sleep: '%v'\n", description)
 						}),
 
@@ -154,11 +154,11 @@ var _ = Describe("feature", Ordered, func() {
 					},
 				},
 
-				tv.WithOnStart(func(description string) {
+				tv.WithOnWake(func(description string) {
 					GinkgoWriter.Printf("===> 🔊 Wake: '%v'\n", description)
 				}),
 
-				tv.WithOnStop(func(description string) {
+				tv.WithOnSleep(func(description string) {
 					GinkgoWriter.Printf("===> 🔇 Sleep: '%v'\n", description)
 				}),
 
@@ -202,7 +202,7 @@ var _ = Describe("feature", Ordered, func() {
 
 		Entry(nil, &hibernateTE{
 			NaviTE: helpers.NaviTE{
-				Given:        "start and stop (folders, inclusive:default)",
+				Given:        "wake and sleep (folders, inclusive:default)",
 				Relative:     "RETRO-WAVE",
 				Subscription: enums.SubscribeFolders,
 				Mandatory: []string{"Night Drive", "College",
@@ -235,7 +235,7 @@ var _ = Describe("feature", Ordered, func() {
 
 		Entry(nil, &hibernateTE{
 			NaviTE: helpers.NaviTE{
-				Given:        "start and stop (folders, excl:start, inc:stop, mute)",
+				Given:        "wake and sleep (folders, excl:wake, inc:sleep, mute)",
 				Relative:     "RETRO-WAVE",
 				Subscription: enums.SubscribeFolders,
 				Mandatory: []string{"College", "Northern Council",
@@ -269,7 +269,7 @@ var _ = Describe("feature", Ordered, func() {
 
 		Entry(nil, &hibernateTE{
 			NaviTE: helpers.NaviTE{
-				Given:        "start only (folders, inclusive:default)",
+				Given:        "wake only (folders, inclusive:default)",
 				Relative:     "RETRO-WAVE",
 				Subscription: enums.SubscribeFolders,
 				Mandatory: []string{"Night Drive", "College", "Northern Council",
@@ -295,7 +295,7 @@ var _ = Describe("feature", Ordered, func() {
 
 		Entry(nil, &hibernateTE{
 			NaviTE: helpers.NaviTE{
-				Given:        "stop only (folders, inclusive:default)",
+				Given:        "sleep only (folders, inclusive:default)",
 				Relative:     "RETRO-WAVE",
 				Subscription: enums.SubscribeFolders,
 				Mandatory: []string{"RETRO-WAVE", "Chromatics", "Night Drive", "College",
@@ -322,7 +322,7 @@ var _ = Describe("feature", Ordered, func() {
 
 		Entry(nil, &hibernateTE{
 			NaviTE: helpers.NaviTE{
-				Given:        "stop only (folders, inclusive:default)",
+				Given:        "sleep only (folders, inclusive:default)",
 				Relative:     "RETRO-WAVE",
 				Subscription: enums.SubscribeFolders,
 				Mandatory:    []string{"RETRO-WAVE", "Chromatics"},

diff --git a/internal/feat/hiber/with-filter_test.go b/internal/feat/hiber/with-filter_test.go
@@ -105,10 +105,10 @@ var _ = Describe("feature", Ordered, func() {
 						return rsys.ReadDir(helpers.TrimRoot(dirname))
 					},
 				),
-				tv.WithOnStart(func(description string) {
+				tv.WithOnWake(func(description string) {
 					GinkgoWriter.Printf("===> 🔆 Waking: '%v'\n", description)
 				}),
-				tv.WithOnStop(func(description string) {
+				tv.WithOnSleep(func(description string) {
 					GinkgoWriter.Printf("===> 🌙 Sleeping: '%v'\n", description)
 				}),
 			)).Navigate(ctx)