Refactored existing tests to use friendlier models

Author: Bart Koelman

src/JsonApiDotNetCore/QueryStrings/Internal/ResourceDefinitionQueryableParameterReader.cs

@@ -56,7 +56,7 @@ public virtual void Read(string parameterName, StringValues parameterValue)
 
         private object GetQueryableHandler(string parameterName)
         {
-            Type resourceType = _request.PrimaryResource.ResourceType;
+            Type resourceType = (_request.SecondaryResource ?? _request.PrimaryResource).ResourceType;
             object handler = _resourceDefinitionAccessor.GetQueryableHandlerForQueryStringParameter(resourceType, parameterName);
 
             if (handler != null && _request.Kind != EndpointKind.Primary)

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/CallableResource.cs

@@ -0,0 +1,8 @@
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceDefinitions.Reading
+{
+    public interface IClientSettingsProvider
+    {
+        bool IsIncludePlanetMoonsBlocked { get; }
+        bool ArePlanetsWithPrivateNameHidden { get; }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/CallableResourceDefinition.cs

@@ -0,0 +1,19 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceDefinitions.Reading
+{
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
+    public sealed class Moon : Identifiable
+    {
+        [Attr]
+        public string Name { get; set; }
+
+        [Attr]
+        public decimal SolarRadius { get; set; }
+
+        [HasOne]
+        public Planet OrbitsAround { get; set; }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/IClientSettingsProvider.cs

@@ -0,0 +1,33 @@
+using System.Linq;
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Resources;
+using Microsoft.Extensions.Primitives;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceDefinitions.Reading
+{
+    [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
+    public sealed class MoonDefinition : JsonApiResourceDefinition<Moon>
+    {
+        public MoonDefinition(IResourceGraph resourceGraph)
+            : base(resourceGraph)
+        {
+            // This constructor will be resolved from the container, which means
+            // you can take on any dependency that is also defined in the container.
+        }
+
+        public override QueryStringParameterHandlers<Moon> OnRegisterQueryableHandlersForQueryStringParameters()
+        {
+            return new QueryStringParameterHandlers<Moon>
+            {
+                ["isLargerThanTheSun"] = FilterByRadius
+            };
+        }
+
+        private static IQueryable<Moon> FilterByRadius(IQueryable<Moon> source, StringValues parameterValue)
+        {
+            bool isFilterOnLargerThan = bool.Parse(parameterValue);
+            return isFilterOnLargerThan ? source.Where(moon => moon.SolarRadius > 1m) : source.Where(moon => moon.SolarRadius <= 1m);
+        }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/IUserRolesService.cs

@@ -5,9 +5,9 @@
 
 namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceDefinitions.Reading
 {
-    public sealed class CallableResourcesController : JsonApiController<CallableResource>
+    public sealed class MoonsController : JsonApiController<Moon>
     {
-        public CallableResourcesController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<CallableResource> resourceService)
+        public MoonsController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<Moon> resourceService)
             : base(options, loggerFactory, resourceService)
         {
         }

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/Moon.cs

@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceDefinitions.Reading
+{
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
+    public sealed class Planet : Identifiable
+    {
+        [Attr]
+        public string PublicName { get; set; }
+
+        [Attr]
+        public string PrivateName { get; set; }
+
+        [Attr]
+        public bool HasRingSystem { get; set; }
+
+        [Attr]
+        public decimal SolarMass { get; set; }
+
+        [HasMany]
+        public ISet<Moon> Moons { get; set; }
+
+        [HasOne]
+        public Star BelongsTo { get; set; }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/MoonDefinition.cs

@@ -0,0 +1,61 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using JetBrains.Annotations;
+using JsonApiDotNetCore;
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Errors;
+using JsonApiDotNetCore.Queries.Expressions;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+using JsonApiDotNetCore.Serialization.Objects;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceDefinitions.Reading
+{
+    [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
+    public sealed class PlanetDefinition : JsonApiResourceDefinition<Planet>
+    {
+        private readonly IClientSettingsProvider _clientSettingsProvider;
+
+        public PlanetDefinition(IResourceGraph resourceGraph, IClientSettingsProvider clientSettingsProvider)
+            : base(resourceGraph)
+        {
+            // This constructor will be resolved from the container, which means
+            // you can take on any dependency that is also defined in the container.
+
+            _clientSettingsProvider = clientSettingsProvider;
+        }
+
+        public override IReadOnlyCollection<IncludeElementExpression> OnApplyIncludes(IReadOnlyCollection<IncludeElementExpression> existingIncludes)
+        {
+            if (_clientSettingsProvider.IsIncludePlanetMoonsBlocked &&
+                existingIncludes.Any(include => include.Relationship.Property.Name == nameof(Planet.Moons)))
+            {
+                throw new JsonApiException(new Error(HttpStatusCode.BadRequest)
+                {
+                    Title = "Including moons is not permitted."
+                });
+            }
+
+            return existingIncludes;
+        }
+
+        public override FilterExpression OnApplyFilter(FilterExpression existingFilter)
+        {
+            if (_clientSettingsProvider.ArePlanetsWithPrivateNameHidden)
+            {
+                ResourceContext resourceContext = ResourceGraph.GetResourceContext<Planet>();
+                AttrAttribute privateNameAttribute = resourceContext.Attributes.Single(attribute => attribute.Property.Name == nameof(Planet.PrivateName));
+
+                FilterExpression hasNoPrivateName = new ComparisonExpression(ComparisonOperator.Equals, new ResourceFieldChainExpression(privateNameAttribute),
+                    new NullConstantExpression());
+
+                return existingFilter == null
+                    ? hasNoPrivateName
+                    : new LogicalExpression(LogicalOperator.And, ArrayFactory.Create(hasNoPrivateName, existingFilter));
+            }
+
+            return existingFilter;
+        }
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/CallableResourcesController.cs renamed to test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceDefinitions/Reading/MoonsController.cs

@@ -0,0 +1,15 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCoreExampleTests.IntegrationTests.ResourceDefinitions.Reading
+{
+    public sealed class PlanetsController : JsonApiController<Planet>
+    {
+        public PlanetsController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<Planet> resourceService)
+            : base(options, loggerFactory, resourceService)
+        {
+        }
+    }
+}