Add ToFullString() method on QueryLayer and ResourceFieldAttribute

Author: bkoelman

src/JsonApiDotNetCore.Annotations/Resources/Annotations/ResourceFieldAttribute.cs

@@ -129,6 +129,11 @@ protected void AssertIsIdentifiable(object? resource)
         return _publicName ?? (_property != null ? _property.Name : base.ToString());
     }
 
+    public string ToFullString()
+    {
+        return $"{_type?.PublicName}:{ToString()}";
+    }
+
     /// <inheritdoc />
     public override bool Equals(object? obj)
     {

src/JsonApiDotNetCore/Queries/FieldSelection.cs

@@ -34,40 +34,51 @@ public FieldSelectors GetOrCreateSelectors(ResourceType resourceType)
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
 
         var writer = new IndentingStringWriter(builder);
-        WriteSelection(writer);
+        WriteSelection(writer, toFullString);
 
         return builder.ToString();
     }
 
-    internal void WriteSelection(IndentingStringWriter writer)
+    internal void WriteSelection(IndentingStringWriter writer, bool toFullString)
     {
         using (writer.Indent())
         {
             foreach (ResourceType type in GetResourceTypes())
             {
                 writer.WriteLine($"{nameof(FieldSelectors)}<{type.ClrType.Name}>");
-                WriterSelectors(writer, type);
+                WriterSelectors(writer, toFullString, type);
             }
         }
     }
 
-    private void WriterSelectors(IndentingStringWriter writer, ResourceType type)
+    private void WriterSelectors(IndentingStringWriter writer, bool toFullString, ResourceType type)
     {
         using (writer.Indent())
         {
             foreach ((ResourceFieldAttribute field, QueryLayer? nextLayer) in GetOrCreateSelectors(type))
             {
                 if (nextLayer == null)
                 {
-                    writer.WriteLine(field.ToString());
+                    writer.WriteLine(toFullString ? field.ToFullString() : field.ToString());
                 }
                 else
                 {
-                    nextLayer.WriteLayer(writer, $"{field.PublicName}: ");
+                    string prefix = $"{(toFullString ? field.ToFullString() : field.ToString())}: ";
+                    nextLayer.WriteLayer(writer, toFullString, prefix);
                 }
             }
         }

src/JsonApiDotNetCore/Queries/QueryLayer.cs

@@ -29,45 +29,55 @@ public QueryLayer(ResourceType resourceType)
     }
 
     public override string ToString()
+    {
+        return InnerToString(false);
+    }
+
+    public string ToFullString()
+    {
+        return InnerToString(true);
+    }
+
+    private string InnerToString(bool toFullString)
     {
         var builder = new StringBuilder();
 
         var writer = new IndentingStringWriter(builder);
-        WriteLayer(writer, null);
+        WriteLayer(writer, toFullString, null);
 
         return builder.ToString();
     }
 
-    internal void WriteLayer(IndentingStringWriter writer, string? prefix)
+    internal void WriteLayer(IndentingStringWriter writer, bool toFullString, string? prefix)
     {
         writer.WriteLine($"{prefix}{nameof(QueryLayer)}<{ResourceType.ClrType.Name}>");
 
         using (writer.Indent())
         {
             if (Include is { Elements.Count: > 0 })
             {
-                writer.WriteLine($"{nameof(Include)}: {Include}");
+                writer.WriteLine($"{nameof(Include)}: {(toFullString ? Include.ToFullString() : Include.ToString())}");
             }
 
             if (Filter != null)
             {
-                writer.WriteLine($"{nameof(Filter)}: {Filter}");
+                writer.WriteLine($"{nameof(Filter)}: {(toFullString ? Filter.ToFullString() : Filter.ToString())}");
             }
 
             if (Sort != null)
             {
-                writer.WriteLine($"{nameof(Sort)}: {Sort}");
+                writer.WriteLine($"{nameof(Sort)}: {(toFullString ? Sort.ToFullString() : Sort.ToString())}");
             }
 
             if (Pagination != null)
             {
-                writer.WriteLine($"{nameof(Pagination)}: {Pagination}");
+                writer.WriteLine($"{nameof(Pagination)}: {(toFullString ? Pagination.ToFullString() : Pagination.ToString())}");
             }
 
             if (Selection is { IsEmpty: false })
             {
                 writer.WriteLine(nameof(Selection));
-                Selection.WriteSelection(writer);
+                Selection.WriteSelection(writer, toFullString);
             }
         }
     }

test/JsonApiDotNetCoreTests/UnitTests/Queries/QueryExpressionTests.cs

@@ -2,6 +2,7 @@
 using FluentAssertions;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
@@ -179,6 +180,104 @@ public void Expressions_can_accept_visitor(QueryExpression left, QueryExpression
         right.Accept(EmptyQueryExpressionVisitor.Instance, null).Should().BeNull();
     }
 
+    [Fact]
+    public void Can_convert_QueryLayer_to_string()
+    {
+        // Arrange
+        QueryLayer queryLayer = TestQueryLayerFactory.Instance.Default();
+
+        // Act
+        string text = queryLayer.ToString();
+
+        // Assert
+        text.Should().Be("""
+            QueryLayer<DerivedTestResource>
+            {
+              Include: parent.children
+              Filter: and(contains(text,'example'),not(equals(text,'example')))
+              Sort: -count(children)
+              Pagination: Page number: 2, size: 5
+              Selection
+              {
+                FieldSelectors<DerivedTestResource>
+                {
+                  text
+                  parent: QueryLayer<DerivedTestResource>
+                  {
+                    Selection
+                    {
+                      FieldSelectors<DerivedTestResource>
+                      {
+                        text
+                      }
+                    }
+                  }
+                  children: QueryLayer<DerivedTestResource>
+                  {
+                    Selection
+                    {
+                      FieldSelectors<DerivedTestResource>
+                      {
+                        text
+                      }
+                    }
+                  }
+                }
+              }
+            }
+
+            """);
+    }
+
+    [Fact]
+    public void Can_convert_QueryLayer_to_full_string()
+    {
+        // Arrange
+        QueryLayer queryLayer = TestQueryLayerFactory.Instance.Default();
+
+        // Act
+        string text = queryLayer.ToFullString();
+
+        // Assert
+        text.Should().Be("""
+            QueryLayer<DerivedTestResource>
+            {
+              Include: baseTestResources:parent.baseTestResources:children
+              Filter: and(contains(baseTestResources:text,'example'),not(equals(baseTestResources:text,'example')))
+              Sort: -count(baseTestResources:children)
+              Pagination: Page number: 2, size: 5
+              Selection
+              {
+                FieldSelectors<DerivedTestResource>
+                {
+                  derivedTestResources:text
+                  derivedTestResources:parent: QueryLayer<DerivedTestResource>
+                  {
+                    Selection
+                    {
+                      FieldSelectors<DerivedTestResource>
+                      {
+                        derivedTestResources:text
+                      }
+                    }
+                  }
+                  derivedTestResources:children: QueryLayer<DerivedTestResource>
+                  {
+                    Selection
+                    {
+                      FieldSelectors<DerivedTestResource>
+                      {
+                        derivedTestResources:text
+                      }
+                    }
+                  }
+                }
+              }
+            }
+
+            """);
+    }
+
     [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
     private class BaseTestResource : Identifiable<Guid>
     {
@@ -202,6 +301,7 @@ private sealed class TestExpressionFactory
         private readonly AttrAttribute _textAttribute;
         private readonly RelationshipAttribute _parentRelationship;
         private readonly RelationshipAttribute _childrenRelationship;
+
         public static TestExpressionFactory Instance { get; } = new();
 
         private TestExpressionFactory()
@@ -262,7 +362,7 @@ public LiteralConstantExpression LiteralConstant()
 
         public LogicalExpression Logical()
         {
-            return new LogicalExpression(LogicalOperator.Or, Comparison(), MatchText());
+            return new LogicalExpression(LogicalOperator.And, MatchText(), Not());
         }
 
         public MatchTextExpression MatchText()
@@ -364,4 +464,63 @@ private EmptyQueryExpressionVisitor()
         {
         }
     }
+
+    private sealed class TestQueryLayerFactory
+    {
+        public static TestQueryLayerFactory Instance { get; } = new();
+
+        private TestQueryLayerFactory()
+        {
+        }
+
+        public QueryLayer Default()
+        {
+            var options = new JsonApiOptions();
+
+            var builder = new ResourceGraphBuilder(options, NullLoggerFactory.Instance);
+            builder.Add<BaseTestResource, Guid>();
+            builder.Add<DerivedTestResource, Guid>();
+            IResourceGraph resourceGraph = builder.Build();
+
+            ResourceType resourceType = resourceGraph.GetResourceType<DerivedTestResource>();
+            AttrAttribute textAttribute = resourceType.GetAttributeByPropertyName(nameof(DerivedTestResource.Text));
+            RelationshipAttribute parentRelationship = resourceType.GetRelationshipByPropertyName(nameof(DerivedTestResource.Parent));
+            RelationshipAttribute childrenRelationship = resourceType.GetRelationshipByPropertyName(nameof(DerivedTestResource.Children));
+
+            return new QueryLayer(resourceType)
+            {
+                Include = TestExpressionFactory.Instance.Include(),
+                Filter = TestExpressionFactory.Instance.Logical(),
+                Sort = TestExpressionFactory.Instance.Sort(),
+                Pagination = TestExpressionFactory.Instance.Pagination(),
+                Selection = new FieldSelection
+                {
+                    [resourceType] = new FieldSelectors
+                    {
+                        [textAttribute] = null,
+                        [parentRelationship] = new QueryLayer(resourceType)
+                        {
+                            Selection = new FieldSelection
+                            {
+                                [resourceType] = new FieldSelectors
+                                {
+                                    [textAttribute] = null
+                                }
+                            }
+                        },
+                        [childrenRelationship] = new QueryLayer(resourceType)
+                        {
+                            Selection = new FieldSelection
+                            {
+                                [resourceType] = new FieldSelectors
+                                {
+                                    [textAttribute] = null
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+        }
+    }
 }