Merge pull request #5 from chickensoft-games/chore/v2.0.0

chore: update to v2.0.0

Author: Joanna May

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

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

Chickensoft.LogicBlocks.Generator/src/LogicBlocksGenerator.cs

@@ -329,11 +329,11 @@ CancellationToken token
     var graph = implementation.Graph;
 
     var transitions = new List<string>();
-    foreach (var stateId in implementation.StatesById) {
+    foreach (var stateId in implementation.StatesById.OrderBy(id => id.Key)) {
       var state = stateId.Value;
-      foreach (var inputToStates in state.InputToStates) {
+      foreach (var inputToStates in state.InputToStates.OrderBy(id => id.Key)) {
         var inputId = inputToStates.Key;
-        foreach (var destStateId in inputToStates.Value) {
+        foreach (var destStateId in inputToStates.Value.OrderBy(id => id)) {
           var dest = implementation.StatesById[destStateId];
           transitions.Add(
             $"{state.UmlId} --> " +
@@ -347,7 +347,9 @@ CancellationToken token
 
     var initialStates = new List<string>();
 
-    foreach (var initialStateId in implementation.InitialStateIds) {
+    foreach (
+      var initialStateId in implementation.InitialStateIds.OrderBy(id => id)
+    ) {
       initialStates.Add(
         "[*] --> " + implementation.StatesById[initialStateId].UmlId
       );

Chickensoft.LogicBlocks/Chickensoft.LogicBlocks.csproj

@@ -13,7 +13,7 @@
     <DebugType>portable</DebugType>
 
     <Title>LogicBlocks</Title>
-    <Version>2.0.0-beta.1</Version>
+    <Version>2.0.0</Version>
     <Description>State management in a box.</Description>
     <Copyright>© 2023 Chickensoft</Copyright>
     <Authors>Chickensoft</Authors>

README.md

@@ -142,10 +142,16 @@ You can find the latest version of LogicBlocks on [nuget][logic-blocks-nuget].
 dotnet add package Chickensoft.LogicBlocks
 ```
 
-To use the LogicBlocks source generator, add the following to your `.csproj` file. Make sure to replace `1.3.0` with the latest version of the [LogicBlocks generator from nuget][logic-blocks-gen-nuget].
+To use the LogicBlocks source generator, add the following to your `.csproj` file. Make sure to replace `2.0.0` with the latest version of the [LogicBlocks generator from nuget][logic-blocks-gen-nuget].
 
 ```xml
-  <PackageReference Include="Chickensoft.LogicBlocks.Generator" Version="1.3.0" PrivateAssets="all" OutputItemType="analyzer" />
+  <PackageReference Include="Chickensoft.LogicBlocks.Generator" Version="2.0.0" PrivateAssets="all" OutputItemType="analyzer" />
+```
+
+Once you have both packages installed, you can force diagram generation with the following command in your project:
+
+```sh
+dotnet build --no-incremental
 ```
 
 ## 🙋‍♀️ How to Use LogicBlocks
@@ -417,6 +423,10 @@ Vending --> Idle : VendingCompleted
 @enduml
 ```
 
+> 💡 The snippet above is simplified for the sake of example. The actual generator output is a bit more verbose, but it renders the same diagram. The extra verbosity is required to identify states correctly to avoid naming collisions between nested states.
+>
+> If you want a more advanced look, check out the various `*.puml` files throughout the various packages in the LogicBlocks repository. These files are generated by the LogicBlocks Generator from the included examples and test cases that are used to verify that LogicBlocks is working as intended. Next to each `*.puml` file is a LogicBlock source file with the `[StateMachine]` attribute that informs the generator to create the diagram code. Check out the source and compare it to the diagram code to see what the generator is doing under the hood.
+
 ### Viewing Diagrams with PlantUML
 
 You can copy and paste the generated UML into [PlantText] to generate a diagram online.