Merge pull request #14 from MORYX-Industry/feature/rework-step-and-states-creation

A step is now considered to live in a dedicated Resource package: Creating a
step Soldering would create a package <project>.Resources.Soldering and put
all related resource files into that project.

States are considered to be added for a certain context, usually a resource.
When a context is found (as provided by moryx add states <CONTEXT>), all
provided states and a <Context>StateBase will be created inside a States
folder next to the file which contains the given context.

Author: seveneleven

.github/workflows/.build-and-publish.yml

@@ -75,13 +75,13 @@ jobs:
         with:
           dotnet-version: ${{ needs.Variables.outputs.dotnet_sdk_version }}
 
-      - name: ♺ Execute nuget restore
-        run: nuget restore
-        if: steps.cache-nuget.outputs.cache-hit != 'true'
-
       - name: 🧰 Setup BuildToolkit
         uses: moryx-industry/setup-buildtoolkit@v1
 
+      - name: ♺ Execute nuget restore
+        run: dotnet restore
+        if: steps.cache-nuget.outputs.cache-hit != 'true'
+
       - name: 🔨 Execute dotnet build
         run: |
           .\set-version.ps1 -RefName ${{ github.ref_name }} -IsTag ${{ github.ref_type == 'tag' && 1 || 0 }} -BuildNumber ${{ github.run_number }} -CommitHash ${{ github.sha }}

Moryx.Cli.sln

@@ -20,6 +20,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionIt
 		Directory.Build.targets = Directory.Build.targets
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Moryx.Cli.Commands.Tests", "src\Tests\Moryx.Cli.Commands.Tests\Moryx.Cli.Commands.Tests.csproj", "{4C082129-3A6D-4A72-80DC-8A9D3A71A79F}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -46,12 +48,17 @@ Global
 		{F6E69A2A-F183-4A01-8629-CEBBB0417ED6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{F6E69A2A-F183-4A01-8629-CEBBB0417ED6}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{F6E69A2A-F183-4A01-8629-CEBBB0417ED6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4C082129-3A6D-4A72-80DC-8A9D3A71A79F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4C082129-3A6D-4A72-80DC-8A9D3A71A79F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4C082129-3A6D-4A72-80DC-8A9D3A71A79F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4C082129-3A6D-4A72-80DC-8A9D3A71A79F}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{E65D2591-A889-4F42-A6F5-AECAFB77DBB0} = {6FC4CD2F-8BFA-4EC1-84A9-D3670BA92E4D}
+		{4C082129-3A6D-4A72-80DC-8A9D3A71A79F} = {6FC4CD2F-8BFA-4EC1-84A9-D3670BA92E4D}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {99BD1616-551D-473A-A6DB-6A9C0F030AB7}

NuGet.Config

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageRestore>
+    <!-- Allow NuGet to download missing packages -->
+    <add key="enabled" value="True" />
+
+    <!-- Automatically check for missing packages during build in Visual Studio -->
+    <add key="automatic" value="True" />
+  </packageRestore>
+
+  <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>

README.md

@@ -24,6 +24,31 @@ Adds a product 'name'
 
     moryx add product <NAME>
 
+
+## `add state`
+
+Adds a 'state machine' to a specified context. It adds a folder `States` next
+to the file that contains the context including a `StateBase` and `State` files
+for each provided state. The context will be updated to implement `IStateContext`.
+
+Adding further states later is possible and would add the new states and update
+the existing `StateBase` accordingly.
+
+_Note_: Adding states to the `States` folder may lead conflicts if you try to 
+create states for several contexts that live inside the same path. We recommend
+to move those 'to be contexts' to separate directories or libraries before
+adding state machines in order to maintain a clean project structure.
+
+
+### Usage
+
+    moryx add states <CONTEXT> --states <Comma separated list of states>
+
+Example
+
+    moryx add states AssemblingCell --states "Initialing, Running, Testing"
+
+
 
 ## `add step`
 

myget.feeds

@@ -9,23 +9,27 @@ public static class AddResources
         public static CommandResult Exec(TemplateSettings settings, IEnumerable<string> resources)
         {
             return CommandBase.Exec(settings, (filenames)
-                => resources.Select(resource => AddThing.Exec(
-                    settings,
-                    new AddConfig
+                => resources.Select(resource =>
+                {
+                    var addConfig = new AddConfig
                     {
                         SolutionName = settings.AppName,
                         ThingName = $"{resource}Resource",
                         Thing = "resource",
-                        ThingPlaceholders = 
+                        ThingPlaceholders =
                         [
-                            Template.Template.ResourcePlaceholder, 
+                            Template.Template.ResourcePlaceholder,
                             Template.Template.ResourcePlaceholder2
                         ],
-                    },
-                    filenames.Resource()
-                    ))
-                    .ToArray()
-                    .Flatten());
+                    };
+                    return AddThing.Exec(
+                        settings,
+                        addConfig,
+                        filenames.Resource()
+                    );
+                })
+                .ToArray()
+                .Flatten());
         }
     }
 }

src/Moryx.Cli.Commands/AddResources.cs

@@ -4,6 +4,8 @@
 using Moryx.Cli.Template.StateBaseTemplate;
 using Moryx.Cli.Template.Exceptions;
 using Moryx.Cli.Template.StateTemplate;
+using Moryx.Cli.Template.Components;
+using Moryx.AbstractionLayer.Resources;
 
 namespace Moryx.Cli.Commands
 {
@@ -19,16 +21,17 @@ internal static CommandResult Exec(TemplateSettings settings, string resource, I
 
         private static CommandResult Add(TemplateSettings settings, List<string> cleanedResourceNames, string resource, IEnumerable<string> states)
         {
-            if (!ResourceExists(settings, resource))
+            var resourceFile = FindResource(settings, resource);
+            if (string.IsNullOrEmpty(resourceFile))
             {
-                return CommandResult.WithError($"Resource `{resource}` not found. Make sure that a `{resource}.cs` exists in the project.");
+                return CommandResult.WithError($"`{resource}` not found. Make sure that a type `{resource}` exists in the project.");
             }
 
             var projectFileNames = cleanedResourceNames.InitialProjects();
-            var StateBaseFileName = cleanedResourceNames.StateBaseFile();
+            var stateBaseFileName = cleanedResourceNames.StateBaseFile();
 
-            var dictionary = Template.Template.PrepareFileStructure(settings.AppName, StateBaseFileName, projectFileNames);
-            var targetPath = Path.Combine(settings.TargetDirectory, "src", $"{settings.AppName}.Resources", resource);
+            var dictionary = Template.Template.PrepareFileStructure(settings.AppName, stateBaseFileName, projectFileNames);
+            var targetPath = Path.Combine(Path.GetDirectoryName(resourceFile)!, "States");
             var newStateBaseFileName = Path.Combine(targetPath, $"{resource}StateBase.cs");
 
             if (!File.Exists(newStateBaseFileName))
@@ -44,13 +47,14 @@ private static CommandResult Add(TemplateSettings settings, List<string> cleaned
                     {
                         { Template.Template.AppPlaceholder, settings.AppName },
                         { Template.Template.StateBasePlaceholder, $"{resource}StateBase" },
+                        { Template.Template.CellPlaceholder, $"{resource}" },
                         { Template.Template.ResourcePlaceholder, resource },
                     });
 
-                if(!states.Any())
+                if (!states.Any())
                 {
-                    states = 
-                    [ 
+                    states =
+                    [
                         "Idle",
                         "ReadyToWork",
                         "Running",
@@ -92,6 +96,7 @@ private static CommandResult Add(TemplateSettings settings, List<string> cleaned
                             { Template.Template.AppPlaceholder, settings.AppName },
                             { Template.Template.StatePlaceholder, stateType },
                             { Template.Template.ResourcePlaceholder, resource },
+                            { Template.Template.CellPlaceholder, resource },
                             { Template.Template.StateBasePlaceholder, $"{resource}StateBase" },
                             });
 
@@ -114,7 +119,7 @@ private static CommandResult Add(TemplateSettings settings, List<string> cleaned
 
             UpdateResource(
                 settings,
-                resource, 
+                resource,
                 success => msg.Add(success),
                 warning => warnings.Add(warning));
 
@@ -123,51 +128,69 @@ private static CommandResult Add(TemplateSettings settings, List<string> cleaned
 
         private static void UpdateResource(TemplateSettings settings, string resource, Action<string> onSuccess, Action<string> onWarning)
         {
-            var dir = Path.Combine(settings.TargetDirectory, "src", $"{settings.AppName}.Resources");
-            var files = Directory.GetFiles(
-                dir,
-                $"{resource}.cs",
-                new EnumerationOptions
-                {
-                    ReturnSpecialDirectories = false,
-                    RecurseSubdirectories = true
-                });
-            if(files.Length == 0)
-            {
-                onWarning($"Filename `{resource}.cs` not found. Could not update resource.");
-                return;
-            }
-            if (files.Length > 1)
+            var candidate = FindResource(settings, resource);
+
+            if (string.IsNullOrEmpty(candidate))
             {
-                onWarning($"Filename `{resource}.cs` is ambiguous. Could not update resource.");
+                onWarning($"Type `{resource}` not found. Could not update resource.");
                 return;
             }
-            var filename = files.Single();
 
             try
             {
-            var template = StateTemplate.FromFile(filename);
-            template = template.ImplementIStateContext(resource);
-            template.SaveToFile(filename);
-                onSuccess($"Updated `{resource}.cs`");
+                var template = StateTemplate.FromFile(candidate);
+                template = template.ImplementIStateContext(resource);
+                template.SaveToFile(candidate);
+                onSuccess($"Updated `{Path.GetFileName(candidate)}`");
             }
             catch (Exception)
             {
-                onWarning($"Failed to update `{resource}.cs`");
+                onWarning($"Failed to update `{Path.GetFileName(candidate)}`");
             }
         }
 
-        private static bool ResourceExists(TemplateSettings settings, string resource)
+        private static string FindResource(TemplateSettings settings, string resourceName)
         {
+            var dir = Path.Combine(settings.TargetDirectory, "src");
             var files = Directory.GetFiles(
-                Path.Combine(settings.TargetDirectory),
-                $"{resource}.cs",
+                dir,
+                $"*.cs",
                 new EnumerationOptions
                 {
                     ReturnSpecialDirectories = false,
                     RecurseSubdirectories = true
-                });
-            return files.Length > 0;
+                })
+                .AsEnumerable();
+
+            var promisingCandidate = files.FirstOrDefault(f => f.EndsWith($"{resourceName}.cs"));
+            if (!string.IsNullOrEmpty(promisingCandidate))
+            {
+                files = files.Prepend(promisingCandidate);
+            }
+
+            var candidate = string.Empty;
+            foreach (var file in files)
+            {
+                if (ContainsType(file, resourceName))
+                {
+                    candidate = file;
+                    break;
+                }
+            }
+            return candidate;
+        }
+
+        private static bool ContainsType(string filename, string typeName)
+        {
+            try
+            {
+                var file = CSharpFile.FromFile(filename);
+                return file.Types.Any(t => t == typeName);
+            }
+            catch
+            {
+                return false;
+            }
         }
     }
 }

src/Moryx.Cli.Commands/AddStates.cs

@@ -1,24 +1,49 @@
-using Moryx.Cli.Template;
+using Microsoft.Build.Construction;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.MSBuild;
+using Moryx.Cli.Commands.Components;
+using Moryx.Cli.Template;
 using Moryx.Cli.Template.Models;
+using Moryx.Configuration;
+using System.Diagnostics;
 
 namespace Moryx.Cli.Commands
 {
     public static class AddStep
     {
         public static CommandResult Exec(TemplateSettings settings, string step)
         {
-            return CommandBase.Exec(settings, (filenames)
-                => AddThing.Exec(
+            return CommandBase.Exec(settings, (filenames) =>
+            {
+                var addConfig = new AddConfig
+                {
+                    SolutionName = settings.AppName,
+                    ThingName = step,
+                    Thing = "step",
+                    ThingPlaceholders = [Template.Template.StepPlaceholder],
+                };
+                var namespacePlaceholder = new Dictionary<string, string> {
+
+                    { $"{Template.Template.AppPlaceholder}.Resources", $"{settings.AppName}.Resources.{step}" },
+                    { $"{settings.AppName}.Resources", $"{settings.AppName}.Resources.{step}" }
+                };
+                var replacements = new StringReplacements(addConfig)
+                    .AddFileNamePatterns(namespacePlaceholder)
+                    .AddContentPatterns(namespacePlaceholder)
+                    ;
+                
+                return AddThing.Exec(
                     settings,
-                    new AddConfig
+                    addConfig,
+                    filenames.Step(),
+                    (createdFiles) =>
                     {
-                        SolutionName = settings.AppName,
-                        ThingName = step,
-                        Thing = "step",
-                        ThingPlaceholders = [Template.Template.StepPlaceholder],
+                        var projectFileName = createdFiles.FirstOrDefault(f => f.EndsWith(".csproj"));
+                        SolutionFileManipulation.AddProjectToSolution(settings, projectFileName);
                     },
-                    filenames.Step()
-                    ));
+                    replacements
+                );
+            });
         }
     }
 }

src/Moryx.Cli.Commands/AddStep.cs

@@ -9,16 +9,9 @@ public static class AddSteps
         public static CommandResult Exec(TemplateSettings settings, IEnumerable<string> cells)
         {
             return CommandBase.Exec(settings, (filenames) 
-                => cells.Select(step => AddThing.Exec(
+                => cells.Select(step => AddStep.Exec(
                     settings,
-                    new AddConfig
-                    {
-                        SolutionName = settings.AppName,
-                        ThingName = step,
-                        Thing = "step",
-                        ThingPlaceholders = [Template.Template.StepPlaceholder],
-                    },
-                    filenames.Step()
+                    step
                     ))
                     .ToArray()
                     .Flatten());