Merge pull request #59 from qmuntal/renameany

Rewrite interface{} to any

README.md

@@ -19,18 +19,18 @@ phoneCall := stateless.NewStateMachine(stateOffHook)
 phoneCall.Configure(stateOffHook).Permit(triggerCallDialed, stateRinging)
 
 phoneCall.Configure(stateRinging).
-  OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...interface{}) error {
+  OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...any) error {
     onDialed(args[0].(string))
     return nil
   }).
   Permit(triggerCallConnected, stateConnected)
 
 phoneCall.Configure(stateConnected).
-  OnEntry(func(_ context.Context, _ ...interface{}) error {
+  OnEntry(func(_ context.Context, _ ...any) error {
     startCallTimer()
     return nil
   }).
-  OnExit(func(_ context.Context, _ ...interface{}) error {
+  OnExit(func(_ context.Context, _ ...any) error {
     stopCallTimer()
     return nil
   }).
@@ -126,10 +126,10 @@ The state machine will choose between multiple transitions based on guard clause
 
 ```go
 phoneCall.Configure(stateOffHook).
-  Permit(triggerCallDialled, stateRinging, func(_ context.Context, _ ...interface{}) bool {
+  Permit(triggerCallDialled, stateRinging, func(_ context.Context, _ ...any) bool {
     return IsValidNumber()
   }).
-  Permit(triggerCallDialled, stateBeeping, func(_ context.Context, _ ...interface{}) bool {
+  Permit(triggerCallDialled, stateBeeping, func(_ context.Context, _ ...any) bool {
     return !IsValidNumber()
   })
 ```
@@ -146,7 +146,7 @@ Strongly-typed parameters can be assigned to triggers:
 stateMachine.SetTriggerParameters(triggerCallDialed, reflect.TypeOf(""))
 
 stateMachine.Configure(stateRinging).
-  OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...interface{}) error {
+  OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...any) error {
     fmt.Println(args[0].(string))
     return nil
   })
@@ -174,7 +174,7 @@ Alternatively, a state can be marked reentrant so its entry and exit events will
 ```go
 stateMachine.Configure(stateAssigned).
   PermitReentry(triggerAssigned).
-  OnEntry(func(_ context.Context, _ ...interface{}) error {
+  OnEntry(func(_ context.Context, _ ...any) error {
     startCallTimer()
     return nil
   })

config.go

@@ -20,13 +20,13 @@ func GetTransition(ctx context.Context) Transition {
 
 // ActionFunc describes a generic action function.
 // The context will always contain Transition information.
-type ActionFunc = func(ctx context.Context, args ...interface{}) error
+type ActionFunc = func(ctx context.Context, args ...any) error
 
 // GuardFunc defines a generic guard function.
-type GuardFunc = func(ctx context.Context, args ...interface{}) bool
+type GuardFunc = func(ctx context.Context, args ...any) bool
 
 // DestinationSelectorFunc defines a functions that is called to select a dynamic destination.
-type DestinationSelectorFunc = func(ctx context.Context, args ...interface{}) (State, error)
+type DestinationSelectorFunc = func(ctx context.Context, args ...any) (State, error)
 
 // StateConfiguration is the configuration for a single state value.
 type StateConfiguration struct {

example_test.go

@@ -37,27 +37,27 @@ func Example() {
 		Permit(triggerCallDialed, stateRinging)
 
 	phoneCall.Configure(stateRinging).
-		OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...interface{}) error {
+		OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...any) error {
 			onDialed(args[0].(string))
 			return nil
 		}).
 		Permit(triggerCallConnected, stateConnected)
 
 	phoneCall.Configure(stateConnected).
 		OnEntry(startCallTimer).
-		OnExit(func(_ context.Context, _ ...interface{}) error {
+		OnExit(func(_ context.Context, _ ...any) error {
 			stopCallTimer()
 			return nil
 		}).
-		InternalTransition(triggerMuteMicrophone, func(_ context.Context, _ ...interface{}) error {
+		InternalTransition(triggerMuteMicrophone, func(_ context.Context, _ ...any) error {
 			onMute()
 			return nil
 		}).
-		InternalTransition(triggerUnmuteMicrophone, func(_ context.Context, _ ...interface{}) error {
+		InternalTransition(triggerUnmuteMicrophone, func(_ context.Context, _ ...any) error {
 			onUnmute()
 			return nil
 		}).
-		InternalTransition(triggerSetVolume, func(_ context.Context, args ...interface{}) error {
+		InternalTransition(triggerSetVolume, func(_ context.Context, args ...any) error {
 			onSetVolume(args[0].(int))
 			return nil
 		}).
@@ -111,7 +111,7 @@ func onDialed(callee string) {
 	fmt.Printf("[Phone Call] placed for : [%s]\n", callee)
 }
 
-func startCallTimer(_ context.Context, _ ...interface{}) error {
+func startCallTimer(_ context.Context, _ ...any) error {
 	fmt.Println("[Timer:] Call started at 11:00am")
 	return nil
 }

graph.go

@@ -180,15 +180,15 @@ func (g *graph) formatOneLine(fromNodeName, toNodeName, label string) string {
 	return sb.String()
 }
 
-func clusterStr(state interface{}, quote, init bool) string {
+func clusterStr(state any, quote, init bool) string {
 	s := fmt.Sprint(state)
 	if init {
 		s += "-init"
 	}
 	return esc("cluster_"+s, quote)
 }
 
-func str(v interface{}, quote bool) string {
+func str(v any, quote bool) string {
 	return esc(fmt.Sprint(v), quote)
 }
 

graph_test.go

@@ -45,19 +45,19 @@ func withGuards() *stateless.StateMachine {
 	sm := stateless.NewStateMachine("B")
 	sm.SetTriggerParameters("X", reflect.TypeOf(0))
 	sm.Configure("A").
-		Permit("X", "D", func(_ context.Context, args ...interface{}) bool {
+		Permit("X", "D", func(_ context.Context, args ...any) bool {
 			return args[0].(int) == 3
 		})
 
 	sm.Configure("B").
 		SubstateOf("A").
-		Permit("X", "C", func(_ context.Context, args ...interface{}) bool {
+		Permit("X", "C", func(_ context.Context, args ...any) bool {
 			return args[0].(int) == 2
 		})
 	return sm
 }
 
-func œ(_ context.Context, args ...interface{}) bool {
+func œ(_ context.Context, args ...any) bool {
 	return args[0].(int) == 2
 }
 
@@ -88,23 +88,23 @@ func phoneCall() *stateless.StateMachine {
 		Permit(triggerCallDialed, stateRinging)
 
 	phoneCall.Configure(stateRinging).
-		OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...interface{}) error {
+		OnEntryFrom(triggerCallDialed, func(_ context.Context, args ...any) error {
 			return nil
 		}).
 		Permit(triggerCallConnected, stateConnected)
 
 	phoneCall.Configure(stateConnected).
 		OnEntry(startCallTimer).
-		OnExit(func(_ context.Context, _ ...interface{}) error {
+		OnExit(func(_ context.Context, _ ...any) error {
 			return nil
 		}).
-		InternalTransition(triggerMuteMicrophone, func(_ context.Context, _ ...interface{}) error {
+		InternalTransition(triggerMuteMicrophone, func(_ context.Context, _ ...any) error {
 			return nil
 		}).
-		InternalTransition(triggerUnmuteMicrophone, func(_ context.Context, _ ...interface{}) error {
+		InternalTransition(triggerUnmuteMicrophone, func(_ context.Context, _ ...any) error {
 			return nil
 		}).
-		InternalTransition(triggerSetVolume, func(_ context.Context, args ...interface{}) error {
+		InternalTransition(triggerSetVolume, func(_ context.Context, args ...any) error {
 			return nil
 		}).
 		Permit(triggerLeftMessage, stateOffHook).

statemachine.go

@@ -10,10 +10,10 @@ import (
 )
 
 // State is used to to represent the possible machine states.
-type State = interface{}
+type State = any
 
 // Trigger is used to represent the triggers that cause state transitions.
-type Trigger = interface{}
+type Trigger = any
 
 // FiringMode enumerate the different modes used when Fire-ing a trigger.
 type FiringMode uint8
@@ -145,12 +145,12 @@ func (sm *StateMachine) MustState() State {
 }
 
 // PermittedTriggers see PermittedTriggersCtx.
-func (sm *StateMachine) PermittedTriggers(args ...interface{}) ([]Trigger, error) {
+func (sm *StateMachine) PermittedTriggers(args ...any) ([]Trigger, error) {
 	return sm.PermittedTriggersCtx(context.Background(), args...)
 }
 
 // PermittedTriggersCtx returns the currently-permissible trigger values.
-func (sm *StateMachine) PermittedTriggersCtx(ctx context.Context, args ...interface{}) ([]Trigger, error) {
+func (sm *StateMachine) PermittedTriggersCtx(ctx context.Context, args ...any) ([]Trigger, error) {
 	sr, err := sm.currentState(ctx)
 	if err != nil {
 		return nil, err
@@ -206,12 +206,12 @@ func (sm *StateMachine) IsInStateCtx(ctx context.Context, state State) (bool, er
 }
 
 // CanFire see CanFireCtx.
-func (sm *StateMachine) CanFire(trigger Trigger, args ...interface{}) (bool, error) {
+func (sm *StateMachine) CanFire(trigger Trigger, args ...any) (bool, error) {
 	return sm.CanFireCtx(context.Background(), trigger, args...)
 }
 
 // CanFireCtx returns true if the trigger can be fired in the current state.
-func (sm *StateMachine) CanFireCtx(ctx context.Context, trigger Trigger, args ...interface{}) (bool, error) {
+func (sm *StateMachine) CanFireCtx(ctx context.Context, trigger Trigger, args ...any) (bool, error) {
 	sr, err := sm.currentState(ctx)
 	if err != nil {
 		return false, err
@@ -229,7 +229,7 @@ func (sm *StateMachine) SetTriggerParameters(trigger Trigger, argumentTypes ...r
 }
 
 // Fire see FireCtx
-func (sm *StateMachine) Fire(trigger Trigger, args ...interface{}) error {
+func (sm *StateMachine) Fire(trigger Trigger, args ...any) error {
 	return sm.FireCtx(context.Background(), trigger, args...)
 }
 
@@ -246,7 +246,7 @@ func (sm *StateMachine) Fire(trigger Trigger, args ...interface{}) error {
 //
 // The context is passed down to all actions and callbacks called within the scope of this method.
 // There is no context error checking, although it may be implemented in future releases.
-func (sm *StateMachine) FireCtx(ctx context.Context, trigger Trigger, args ...interface{}) error {
+func (sm *StateMachine) FireCtx(ctx context.Context, trigger Trigger, args ...any) error {
 	return sm.internalFire(ctx, trigger, args...)
 }
 
@@ -313,7 +313,7 @@ func (sm *StateMachine) stateRepresentation(state State) (sr *stateRepresentatio
 	return
 }
 
-func (sm *StateMachine) internalFire(ctx context.Context, trigger Trigger, args ...interface{}) error {
+func (sm *StateMachine) internalFire(ctx context.Context, trigger Trigger, args ...any) error {
 	switch sm.firingMode {
 	case FiringImmediate:
 		return sm.internalFireOne(ctx, trigger, args...)
@@ -327,10 +327,10 @@ func (sm *StateMachine) internalFire(ctx context.Context, trigger Trigger, args
 type queuedTrigger struct {
 	Context context.Context
 	Trigger Trigger
-	Args    []interface{}
+	Args    []any
 }
 
-func (sm *StateMachine) internalFireQueued(ctx context.Context, trigger Trigger, args ...interface{}) error {
+func (sm *StateMachine) internalFireQueued(ctx context.Context, trigger Trigger, args ...any) error {
 	sm.firingMutex.Lock()
 	sm.eventQueue.PushBack(queuedTrigger{Context: ctx, Trigger: trigger, Args: args})
 	sm.firingMutex.Unlock()
@@ -354,7 +354,7 @@ func (sm *StateMachine) internalFireQueued(ctx context.Context, trigger Trigger,
 	return nil
 }
 
-func (sm *StateMachine) internalFireOne(ctx context.Context, trigger Trigger, args ...interface{}) (err error) {
+func (sm *StateMachine) internalFireOne(ctx context.Context, trigger Trigger, args ...any) (err error) {
 	sm.ops.Add(1)
 	defer sm.ops.Add(^uint64(0))
 	var (
@@ -380,7 +380,7 @@ func (sm *StateMachine) internalFireOne(ctx context.Context, trigger Trigger, ar
 		transition := Transition{Source: source, Destination: t.Destination, Trigger: trigger}
 		err = sm.handleReentryTrigger(ctx, representativeState, transition, args...)
 	case *dynamicTriggerBehaviour:
-		var destination interface{}
+		var destination any
 		destination, err = t.Destination(ctx, args...)
 		if err == nil {
 			transition := Transition{Source: source, Destination: destination, Trigger: trigger}
@@ -400,7 +400,7 @@ func (sm *StateMachine) internalFireOne(ctx context.Context, trigger Trigger, ar
 	return
 }
 
-func (sm *StateMachine) handleReentryTrigger(ctx context.Context, sr *stateRepresentation, transition Transition, args ...interface{}) error {
+func (sm *StateMachine) handleReentryTrigger(ctx context.Context, sr *stateRepresentation, transition Transition, args ...any) error {
 	if err := sr.Exit(ctx, transition, args...); err != nil {
 		return err
 	}
@@ -423,7 +423,7 @@ func (sm *StateMachine) handleReentryTrigger(ctx context.Context, sr *stateRepre
 	return nil
 }
 
-func (sm *StateMachine) handleTransitioningTrigger(ctx context.Context, sr *stateRepresentation, transition Transition, args ...interface{}) error {
+func (sm *StateMachine) handleTransitioningTrigger(ctx context.Context, sr *stateRepresentation, transition Transition, args ...any) error {
 	if err := sr.Exit(ctx, transition, args...); err != nil {
 		return err
 	}
@@ -446,7 +446,7 @@ func (sm *StateMachine) handleTransitioningTrigger(ctx context.Context, sr *stat
 	return nil
 }
 
-func (sm *StateMachine) enterState(ctx context.Context, sr *stateRepresentation, transition Transition, args ...interface{}) (*stateRepresentation, error) {
+func (sm *StateMachine) enterState(ctx context.Context, sr *stateRepresentation, transition Transition, args ...any) (*stateRepresentation, error) {
 	// Enter the new state
 	err := sr.Enter(ctx, transition, args...)
 	if err != nil {