Merge pull request #718 from SteveDunn/stj-namespace-bug-717

Fix: System.Text.Json factories fail to generate if assembly name has hyphens

docs/site/Writerside/topics/tutorials/Using-with-JSON.md

@@ -89,9 +89,13 @@ var json = JsonSerializer.Serialize(weather, ctx.Weather);
 Weather w2 = JsonSerializer.Deserialize(json, ctx.Weather)!;
 ```
 
+<note>
+The namespace used to generate the factory is based on the project name. If the project name contains illegal characters, such as commas, hyphens, or dots, they are replaced with underscores. 
+</note>
+
 The STJ converter factory is generated automatically if referencing the new STJ types in the `System.Text.Json.Serialization` namespace.
 
-You can turn this off via the `SystemTextJsonConverterFactoryGeneration` flag in config (either globally, or per value object)
+You can turn this off via the `SystemTextJsonConverterFactoryGeneration` flag in config (either globally or per value object)
 
 ## Summary
 

samples/WebApplication/Program.cs

@@ -26,7 +26,7 @@
     // the following extension method is available if you specify `GenerateSwashbuckleMappingExtensionMethod` - as shown above
 
     opt.MapVogenTypesInWebApplication();
-    opt.MapVogenTypesInWebApplicationShared();
+    opt.MapVogenTypesInWebApplication_Shared();
 
     // the following schema filter is generated if you specify GenerateSwashbuckleSchemaFilter as shown above
     // opt.SchemaFilter<MyVogenSchemaFilter>();

src/Vogen/GenerateCodeForBsonSerializers.cs

@@ -169,12 +169,12 @@ public static void TryRegister() { }
 
         string ClassNameForRegistering()
         {
-            var assemblyName = new SanitizedAssemblyName(compilation.AssemblyName);
+            string projectName = ProjectName.FromAssemblyName(compilation.AssemblyName ?? "").Value;
 
             string s = "BsonSerializationRegister";
-            if(assemblyName.Value.Length > 0)
+            if(projectName.Length > 0)
             {
-                s = $"{s}For{assemblyName}";
+                s = $"{s}For{projectName}";
             }
 
             return s;

src/Vogen/GenerateCodeForSystemTextJsonConverterFactories.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.CodeAnalysis;
+using Vogen.Types;
 
 namespace Vogen;
 
@@ -27,10 +28,10 @@ public static void WriteIfNeeded(VogenConfiguration? globalConfig,
 
 
         var entries = workItems.Where(i => i.Config.Conversions.HasFlag(Conversions.SystemTextJson)).Select(BuildEntry);
+
+        var fullNamespace = ProjectName.FromAssemblyName(compilation.Assembly.Name);
 
-        var fullNamespace = compilation.Assembly.Name;
-
-        var ns = string.IsNullOrEmpty(fullNamespace) ? string.Empty : $"namespace {fullNamespace};";
+        var ns = $"namespace {fullNamespace};";
 
         string source =
             $$"""

src/Vogen/Types/ProjectName.cs

@@ -4,11 +4,17 @@ internal class ProjectName
 {
     private ProjectName(string value) => Value = value;
 
+    /// <summary>
+    /// Replaces [., -] with [_] for use as type type names etc.
+    /// </summary>
+    /// <param name="assemblyName"></param>
+    /// <returns></returns>
     public static ProjectName FromAssemblyName(string assemblyName)
     {
-        assemblyName = assemblyName.Replace(".", "");
-        assemblyName = assemblyName.Replace(",", "");
-        assemblyName = assemblyName.Replace(" ", "");
+        assemblyName = assemblyName.Replace(".", "_");
+        assemblyName = assemblyName.Replace(",", "_");
+        assemblyName = assemblyName.Replace(" ", "_");
+        assemblyName = assemblyName.Replace("-", "_");
 
         return new(assemblyName);
     }

tests/Shared/ProjectBuilder.cs

@@ -44,6 +44,7 @@ public sealed class ProjectBuilder
     private TargetFramework? _targetFramework;
     private bool _excludeStj;
     private LanguageVersion _languageVersion = LanguageVersion.Default;
+    private string _assemblyName = "generator";
 
     public ProjectBuilder WithTargetFramework(TargetFramework targetFramework)
     {
@@ -273,6 +274,13 @@ public ProjectBuilder WithUserSource(string userSource)
         return this;
     }
 
+    public ProjectBuilder WithAssemblyName(string assemblyName)
+    {
+        _assemblyName = assemblyName;
+
+        return this;
+    }
+
     public ProjectBuilder WithNugetPackages(IEnumerable<NuGetPackage> packages)
     {
         foreach (var nuGetPackage in packages)
@@ -322,8 +330,8 @@ internal static class IsExternalInit {}
         options = options.WithSpecificDiagnosticOptions(diagnostics);
 
         var compilation = CSharpCompilation.Create(
-            assemblyName: "generator",
-            syntaxTrees: new[] { usersSyntaxTree, isExternalInitSyntaxTree },
+            assemblyName: _assemblyName,
+            syntaxTrees: [usersSyntaxTree, isExternalInitSyntaxTree],
             _references,
             options);
 

tests/SnapshotTests/BugFixes/Bug717_Stj_does_not_escape_dashed_namespace.cs

@@ -0,0 +1,30 @@
+using System.Threading.Tasks;
+using Vogen;
+
+namespace SnapshotTests.BugFixes;
+
+// See https://github.com/SteveDunn/Vogen/issues/717
+public class Bug717_Stj_does_not_escape_dashed_namespace
+{
+    [Fact]
+    public async Task Test()
+    {
+        var source = """
+
+                     using System;
+                     using Vogen;
+                     using System.Text.Json;
+                     
+                     namespace My_Namespace;
+                     
+                     [ValueObject(typeof(Guid))]
+                     public partial struct Vo;
+                     """;
+
+        await new SnapshotRunner<ValueObjectGenerator>()
+            .WithAssemblyName("MY-PROJECT")
+            .WithSource(source)
+            .IgnoreInitialCompilationErrors()
+            .RunOnAllFrameworks();
+    }
+}