Merge pull request #4 from chickensoft-games/fix/callbacks

fix: ensure correct callback behavior with reusable states

.gitignore

@@ -9,4 +9,3 @@ obj/
 .generated/
 .vs/
 .DS_Store
-*.g.puml

Chickensoft.LogicBlocks.Example/VendingMachine.cs

@@ -17,7 +17,7 @@ public abstract record State(Context Context) : StateLogic(Context) {
     public record Idle : State,
       IGet<Input.SelectionEntered>, IGet<Input.PaymentReceived> {
       public Idle(Context context) : base(context) {
-        context.OnEnter<Idle>((previous) => context.Output(
+        OnEnter<Idle>((previous) => context.Output(
           new Output.ClearTransactionTimeOutTimer()
         ));
       }
@@ -55,7 +55,7 @@ public TransactionActive(
         Price = price;
         AmountReceived = amountReceived;
 
-        Context.OnEnter<TransactionActive>(
+        OnEnter<TransactionActive>(
          (previous) => Context.Output(
            new Output.RestartTransactionTimeOutTimer()
          )
@@ -97,7 +97,7 @@ public record Started : TransactionActive,
         public Started(
           Context context, ItemType type, int price, int amountReceived
         ) : base(context, type, price, amountReceived) {
-          context.OnEnter<Started>(
+          OnEnter<Started>(
             (previous) => context.Output(new Output.TransactionStarted())
           );
         }
@@ -128,7 +128,7 @@ public Vending(Context context, ItemType type, int price) :
         Type = type;
         Price = price;
 
-        context.OnEnter<Vending>(
+        OnEnter<Vending>(
           (previous) => Context.Output(new Output.BeginVending())
         );
       }

Chickensoft.LogicBlocks.Example/VendingMachine.g.puml

@@ -0,0 +1,32 @@
+@startuml VendingMachine
+state "VendingMachine State" as Chickensoft_LogicBlocks_Example_VendingMachine_State {
+  state "Idle" as Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle {
+    Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle : OnEnter → ClearTransactionTimeOutTimer
+    Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle : OnPaymentReceived → MakeChange
+  }
+  state "TransactionActive" as Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive {
+    state "Started" as Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_Started {
+      Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_Started : OnEnter → TransactionStarted
+    }
+    state "PaymentPending" as Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_PaymentPending
+    Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive : OnEnter → RestartTransactionTimeOutTimer
+    Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive : OnPaymentReceived → MakeChange, TransactionCompleted
+    Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive : OnTransactionTimedOut → MakeChange
+  }
+  state "Vending" as Chickensoft_LogicBlocks_Example_VendingMachine_State_Vending {
+    Chickensoft_LogicBlocks_Example_VendingMachine_State_Vending : OnEnter → BeginVending
+  }
+}
+
+Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle --> Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle : PaymentReceived
+Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle --> Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle : SelectionEntered
+Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle --> Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_Started : SelectionEntered
+Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive --> Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle : TransactionTimedOut
+Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive --> Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_PaymentPending : PaymentReceived
+Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive --> Chickensoft_LogicBlocks_Example_VendingMachine_State_Vending : PaymentReceived
+Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_Started --> Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle : SelectionEntered
+Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_Started --> Chickensoft_LogicBlocks_Example_VendingMachine_State_TransactionActive_Started : SelectionEntered
+Chickensoft_LogicBlocks_Example_VendingMachine_State_Vending --> Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle : VendingCompleted
+
+[*] --> Chickensoft_LogicBlocks_Example_VendingMachine_State_Idle
+@enduml

Chickensoft.LogicBlocks.Generator.Tests/GeneratorTest.cs

@@ -11,7 +11,7 @@ public void GeneratesUml() {
 
     result.Outputs["ToasterOven.puml.g.cs"].ShouldBe("""
     @startuml ToasterOven
-    state "ToasterOven" as State {
+    state "ToasterOven State" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State {
       state "Heating" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Heating {
         state "Toasting" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting {
           Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting : OnEnter → SetTimer

Chickensoft.LogicBlocks.Generator.Tests/test_cases/Heater.cs

@@ -52,26 +52,25 @@ public Heating(Context context, double targetTemp) : base(
       ) {
         var tempSensor = context.Get<ITemperatureSensor>();
 
-        context.OnEnter<Heating>(
+        OnEnter<Heating>(
           (previous) => tempSensor.OnTemperatureChanged += OnTemperatureChanged
         );
 
-        context.OnExit<Heating>(
+        OnExit<Heating>(
           (next) => tempSensor.OnTemperatureChanged -= OnTemperatureChanged
         );
       }
 
-      State IGet<Input.TurnOff>.On(Input.TurnOff input)
-        => new Off(Context, TargetTemp);
+      public State On(Input.TurnOff input) => new Off(Context, TargetTemp);
 
-      State IGet<Input.AirTempSensorChanged>.On(
-        Input.AirTempSensorChanged input
-      ) => input.AirTemp >= TargetTemp
-        ? new Idle(Context, TargetTemp)
-        : this;
+      public State On(Input.AirTempSensorChanged input) =>
+        input.AirTemp >= TargetTemp
+          ? new Idle(Context, TargetTemp)
+          : this;
 
-      State IGet<Input.TargetTempChanged>.On(Input.TargetTempChanged input)
-        => this with { TargetTemp = input.Temp };
+      public State On(Input.TargetTempChanged input) => this with {
+        TargetTemp = input.Temp
+      };
 
       private void OnTemperatureChanged(double airTemp) {
         Context.Input(new Input.AirTempSensorChanged(airTemp));

Chickensoft.LogicBlocks.Generator.Tests/test_cases/Heater.g.puml

@@ -0,0 +1,17 @@
+@startuml Heater
+state "Heater State" as Chickensoft_LogicBlocks_Generator_Tests_Heater_State {
+  state "Off" as Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Off
+  state "Idle" as Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Idle
+  state "Heating" as Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating {
+    Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating : OnTemperatureChanged() → AirTempChanged
+  }
+}
+
+Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating --> Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating : AirTempSensorChanged
+Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating --> Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating : TargetTempChanged
+Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating --> Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Idle : AirTempSensorChanged
+Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating --> Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Off : TurnOff
+Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Off --> Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Heating : TurnOn
+
+[*] --> Chickensoft_LogicBlocks_Generator_Tests_Heater_State_Off
+@enduml

Chickensoft.LogicBlocks.Generator.Tests/test_cases/LightSwitch.g.puml

@@ -0,0 +1,11 @@
+@startuml LightSwitch
+state "LightSwitch State" as Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State {
+  state "On" as Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State_On
+  state "Off" as Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State_Off
+}
+
+Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State_Off --> Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State_On : Toggle
+Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State_On --> Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State_Off : Toggle
+
+[*] --> Chickensoft_LogicBlocks_Generator_Tests_LightSwitch_State_Off
+@enduml

Chickensoft.LogicBlocks.Generator.Tests/test_cases/ToasterOven.cs

@@ -15,10 +15,10 @@ public record StartToasting(int ToastColor) : Input;
   public abstract record State(Context Context) : StateLogic(Context) {
     public record Heating : State, IGet<Input.OpenDoor> {
       public Heating(Context context) : base(context) {
-        Context.OnEnter<Heating>(
+        OnEnter<Heating>(
           (previous) => Context.Output(new Output.TurnHeaterOn())
         );
-        Context.OnExit<Heating>(
+        OnExit<Heating>(
           (next) => Context.Output(new Output.TurnHeaterOff())
         );
       }
@@ -32,10 +32,10 @@ public record Toasting : Heating, IGet<Input.StartBaking> {
       public Toasting(Context context, int toastColor) : base(context) {
         ToastColor = toastColor;
 
-        Context.OnEnter<Toasting>(
+        OnEnter<Toasting>(
           (previous) => Context.Output(new Output.SetTimer(ToastColor))
         );
-        Context.OnExit<Toasting>(
+        OnExit<Toasting>(
           (next) => Context.Output(new Output.ResetTimer())
         );
       }
@@ -51,10 +51,10 @@ public record Baking : Heating, IGet<Input.StartToasting> {
       public Baking(Context context, int temperature) : base(context) {
         Temperature = temperature;
 
-        Context.OnEnter<Baking>(
+        OnEnter<Baking>(
           (previous) => Context.Output(new Output.SetTemperature(Temperature))
         );
-        Context.OnExit<Baking>(
+        OnExit<Baking>(
           (next) => Context.Output(new Output.SetTemperature(0))
         );
       }
@@ -66,10 +66,10 @@ public Baking(Context context, int temperature) : base(context) {
 
     public record DoorOpen : State, IGet<Input.CloseDoor> {
       public DoorOpen(Context context) : base(context) {
-        Context.OnEnter<DoorOpen>(
+        OnEnter<DoorOpen>(
           (previous) => Context.Output(new Output.TurnLampOn())
         );
-        Context.OnExit<DoorOpen>(
+        OnExit<DoorOpen>(
           (next) => Context.Output(new Output.TurnLampOff())
         );
       }

Chickensoft.LogicBlocks.Generator.Tests/test_cases/ToasterOven.g.puml

@@ -0,0 +1,27 @@
+@startuml ToasterOven
+state "ToasterOven State" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State {
+  state "Heating" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Heating {
+    state "Toasting" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting {
+      Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting : OnEnter → SetTimer
+      Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting : OnExit → ResetTimer
+    }
+    state "Baking" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Baking {
+      Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Baking : OnEnter → SetTemperature
+      Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Baking : OnExit → SetTemperature
+    }
+    Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Heating : OnEnter → TurnHeaterOn
+    Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Heating : OnExit → TurnHeaterOff
+  }
+  state "DoorOpen" as Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_DoorOpen {
+    Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_DoorOpen : OnEnter → TurnLampOn
+    Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_DoorOpen : OnExit → TurnLampOff
+  }
+}
+
+Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Baking --> Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting : StartToasting
+Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_DoorOpen --> Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting : CloseDoor
+Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Heating --> Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_DoorOpen : OpenDoor
+Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting --> Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Baking : StartBaking
+
+[*] --> Chickensoft_LogicBlocks_Generator_Tests_ToasterOven_State_Toasting
+@enduml

Chickensoft.LogicBlocks.Generator.Tests/test_cases/partial_split_across_files/PartialLogic1.cs

@@ -16,5 +16,6 @@ public abstract record Output {
     public record OutputA : Output;
     public record OutputEnterA : Output;
     public record OutputExitA : Output;
+    public record OutputSomething : Output;
   }
 }

Chickensoft.LogicBlocks.Generator.Tests/test_cases/partial_split_across_files/PartialLogic1.g.puml

@@ -0,0 +1,13 @@
+@startuml PartialLogic
+state "PartialLogic State" as Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State {
+  state "A" as Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_A {
+    Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_A : DoSomething() → OutputSomething
+    Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_A : OnEnter → OutputEnterA
+    Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_A : OnExit → OutputExitA
+    Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_A : OnOne → OutputA
+  }
+  state "B" as Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_B
+}
+
+Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_A --> Chickensoft_LogicBlocks_Generator_Tests_PartialLogic_State_B : One
+@enduml

Chickensoft.LogicBlocks.Generator.Tests/test_cases/partial_split_across_files/PartialLogic2.cs

@@ -5,10 +5,10 @@ public partial class PartialLogic :
   public abstract partial record State : StateLogic {
     public partial record A : State, IGet<Input.One> {
       public A(Context context) : base(context) {
-        Context.OnEnter<A>(
+        OnEnter<A>(
           (previous) => Context.Output(new Output.OutputEnterA())
         );
-        Context.OnExit<A>(
+        OnExit<A>(
           (next) => Context.Output(new Output.OutputExitA())
         );
       }

Chickensoft.LogicBlocks.Generator.Tests/test_cases/partial_split_across_files/PartialLogic3.cs

@@ -8,6 +8,8 @@ public State On(Input.One input) {
         Context.Output(new Output.OutputA());
         return new B(Context);
       }
+
+      public void DoSomething() => Context.Output(new Output.OutputSomething());
     }
   }
 }

Chickensoft.LogicBlocks.Generator/Chickensoft.LogicBlocks.Generator.csproj

@@ -11,7 +11,7 @@
     <NoWarn>NU5128</NoWarn>
 
     <Title>LogicBlocks Generator</Title>
-    <Version>1.3.0</Version>
+    <Version>2.0.0-beta.1</Version>
     <Description></Description>
     <Copyright>© 2023 Chickensoft Games</Copyright>
     <Authors>Chickensoft</Authors>