Skip to content

Commit

Permalink
#126 support for custom argument builders
Browse files Browse the repository at this point in the history
  • Loading branch information
@Husqvik
Husqvik committed Jan 29, 2023
1 parent c323364 commit 1f6c1ba
Show file tree
Hide file tree
Showing 4 changed files with 340 additions and 152 deletions.
123 changes: 85 additions & 38 deletions src/GraphQlClientGenerator/BaseClasses.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,53 +138,32 @@ private static IList CreateCompatibleList(Type targetContainerType, Type element

internal static class GraphQlQueryHelper
{
private static readonly Regex RegexWhiteSpace = new Regex(@"\s", RegexOptions.Compiled);
private static readonly Regex RegexGraphQlIdentifier = new Regex(@"^[_A-Za-z][_0-9A-Za-z]*$", RegexOptions.Compiled);

public static string GetIndentation(int level, byte indentationSize)
{
return new String(' ', level * indentationSize);
}

public static string EscapeGraphQlStringValue(string value)
{
return value.Replace("\\", "\\\\").Replace("\"", "\\\"");
}

public static string BuildArgumentValue(object value, string formatMask, GraphQlBuilderOptions options, int level)
{
var serializer = options.ArgumentBuilder ?? DefaultGraphQlArgumentBuilder.Instance;
if (serializer.TryBuild(new GraphQlArgumentBuilderContext { Value = value, FormatMask = formatMask, Options = options, Level = level }, out var serializedValue))
return serializedValue;

if (value is null)
return "null";

#if !GRAPHQL_GENERATOR_DISABLE_NEWTONSOFT_JSON
if (value is JValue jValue)
{
switch (jValue.Type)
{
case JTokenType.Null: return "null";
case JTokenType.Integer:
case JTokenType.Float:
case JTokenType.Boolean:
return BuildArgumentValue(jValue.Value, null, options, level);
case JTokenType.String:
return "\"" + ((string)jValue.Value).Replace("\"", "\\\"") + "\"";
default:
return "\"" + jValue.Value + "\"";
}
}

if (value is JProperty jProperty)
{
if (RegexWhiteSpace.IsMatch(jProperty.Name))
throw new ArgumentException($"JSON object keys used as GraphQL arguments must not contain whitespace; key: {jProperty.Name}");

return $"{jProperty.Name}:{(options.Formatting == Formatting.Indented ? " " : null)}{BuildArgumentValue(jProperty.Value, null, options, level)}";
}

if (value is JObject jObject)
return BuildEnumerableArgument(jObject, null, options, level + 1, '{', '}');
#endif

var enumerable = value as IEnumerable;
if (!String.IsNullOrEmpty(formatMask) && enumerable == null)
return
value is IFormattable formattable
? "\"" + formattable.ToString(formatMask, CultureInfo.InvariantCulture) + "\""
? $"\"{EscapeGraphQlStringValue(formattable.ToString(formatMask, CultureInfo.InvariantCulture))}\""
: throw new ArgumentException($"Value must implement {nameof(IFormattable)} interface to use a format mask. ", nameof(value));

if (value is Enum @enum)
Expand All @@ -194,19 +173,19 @@ value is IFormattable formattable
return @bool ? "true" : "false";

if (value is DateTime dateTime)
return "\"" + dateTime.ToString("O") + "\"";
return $"\"{dateTime.ToString("O")}\"";

if (value is DateTimeOffset dateTimeOffset)
return "\"" + dateTimeOffset.ToString("O") + "\"";
return $"\"{dateTimeOffset.ToString("O")}\"";

if (value is IGraphQlInputObject inputObject)
return BuildInputObject(inputObject, options, level + 2);

if (value is Guid)
return "\"" + value + "\"";
return $"\"{value}\"";

if (value is String @string)
return "\"" + @string.Replace("\"", "\\\"") + "\"";
return $"\"{EscapeGraphQlStringValue(@string)}\"";

if (enumerable != null)
return BuildEnumerableArgument(enumerable, formatMask, options, level, '[', ']');
Expand All @@ -215,10 +194,10 @@ value is IFormattable formattable
return Convert.ToString(value, CultureInfo.InvariantCulture);

var argumentValue = Convert.ToString(value, CultureInfo.InvariantCulture);
return "\"" + argumentValue + "\"";
return $"\"{argumentValue}\"";
}

private static string BuildEnumerableArgument(IEnumerable enumerable, string formatMask, GraphQlBuilderOptions options, int level, char openingSymbol, char closingSymbol)
public static string BuildEnumerableArgument(IEnumerable enumerable, string formatMask, GraphQlBuilderOptions options, int level, char openingSymbol, char closingSymbol)
{
var builder = new StringBuilder();
builder.Append(openingSymbol);
Expand Down Expand Up @@ -262,7 +241,7 @@ public static string BuildInputObject(IGraphQlInputObject inputObject, GraphQlBu
var queryBuilderParameter = propertyValue.Value as QueryBuilderParameter;
var value =
queryBuilderParameter?.Name != null
? "$" + queryBuilderParameter.Name
? $"${queryBuilderParameter.Name}"
: BuildArgumentValue(queryBuilderParameter == null ? propertyValue.Value : queryBuilderParameter.Value, propertyValue.FormatMask, options, level);

builder.Append(isIndentedFormatting ? GetIndentation(level, options.IndentationSize) : separator);
Expand Down Expand Up @@ -343,6 +322,73 @@ private static string ConvertEnumToString(Enum @enum)
}
}

public interface IGraphQlArgumentBuilder
{
bool TryBuild(GraphQlArgumentBuilderContext context, out string graphQlString);
}

public class GraphQlArgumentBuilderContext
{
public object Value { get; set; }
public string FormatMask { get; set; }
public GraphQlBuilderOptions Options { get; set; }
public int Level { get; set; }
}

public class DefaultGraphQlArgumentBuilder : IGraphQlArgumentBuilder
{
private static readonly Regex RegexWhiteSpace = new Regex(@"\s", RegexOptions.Compiled);

public static readonly DefaultGraphQlArgumentBuilder Instance = new();

public bool TryBuild(GraphQlArgumentBuilderContext context, out string graphQlString)
{
#if !GRAPHQL_GENERATOR_DISABLE_NEWTONSOFT_JSON
if (context.Value is JValue jValue)
{
switch (jValue.Type)
{
case JTokenType.Null:
graphQlString = "null";
return true;

case JTokenType.Integer:
case JTokenType.Float:
case JTokenType.Boolean:
graphQlString = GraphQlQueryHelper.BuildArgumentValue(jValue.Value, null, context.Options, context.Level);
return true;

case JTokenType.String:
graphQlString = $"\"{GraphQlQueryHelper.EscapeGraphQlStringValue((string)jValue.Value)}\"";
return true;

default:
graphQlString = $"\"{jValue.Value}\"";
return true;
}
}

if (context.Value is JProperty jProperty)
{
if (RegexWhiteSpace.IsMatch(jProperty.Name))
throw new ArgumentException($"JSON object keys used as GraphQL arguments must not contain whitespace; key: {jProperty.Name}");

graphQlString = $"{jProperty.Name}:{(context.Options.Formatting == Formatting.Indented ? " " : null)}{GraphQlQueryHelper.BuildArgumentValue(jProperty.Value, null, context.Options, context.Level)}";
return true;
}

if (context.Value is JObject jObject)
{
graphQlString = GraphQlQueryHelper.BuildEnumerableArgument(jObject, null, context.Options, context.Level + 1, '{', '}');
return true;
}
#endif

graphQlString = null;
return false;
}
}

internal struct InputPropertyInfo
{
public string Name { get; set; }
Expand Down Expand Up @@ -544,6 +590,7 @@ public class GraphQlBuilderOptions
{
public Formatting Formatting { get; set; }
public byte IndentationSize { get; set; } = 2;
public IGraphQlArgumentBuilder ArgumentBuilder { get; set; }
}

public abstract partial class GraphQlQueryBuilder : IGraphQlQueryBuilder
Expand Down
123 changes: 85 additions & 38 deletions test/GraphQlClientGenerator.Test/ExpectedSingleFileGenerationContext/FullClientCSharpFile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,53 +158,32 @@ namespace GraphQlGenerator.Test

internal static class GraphQlQueryHelper
{
private static readonly Regex RegexWhiteSpace = new Regex(@"\s", RegexOptions.Compiled);
private static readonly Regex RegexGraphQlIdentifier = new Regex(@"^[_A-Za-z][_0-9A-Za-z]*$", RegexOptions.Compiled);

public static string GetIndentation(int level, byte indentationSize)
{
return new String(' ', level * indentationSize);
}

public static string EscapeGraphQlStringValue(string value)
{
return value.Replace("\\", "\\\\").Replace("\"", "\\\"");
}

public static string BuildArgumentValue(object value, string formatMask, GraphQlBuilderOptions options, int level)
{
var serializer = options.ArgumentBuilder ?? DefaultGraphQlArgumentBuilder.Instance;
if (serializer.TryBuild(new GraphQlArgumentBuilderContext { Value = value, FormatMask = formatMask, Options = options, Level = level }, out var serializedValue))
return serializedValue;

if (value is null)
return "null";

#if !GRAPHQL_GENERATOR_DISABLE_NEWTONSOFT_JSON
if (value is JValue jValue)
{
switch (jValue.Type)
{
case JTokenType.Null: return "null";
case JTokenType.Integer:
case JTokenType.Float:
case JTokenType.Boolean:
return BuildArgumentValue(jValue.Value, null, options, level);
case JTokenType.String:
return "\"" + ((string)jValue.Value).Replace("\"", "\\\"") + "\"";
default:
return "\"" + jValue.Value + "\"";
}
}

if (value is JProperty jProperty)
{
if (RegexWhiteSpace.IsMatch(jProperty.Name))
throw new ArgumentException($"JSON object keys used as GraphQL arguments must not contain whitespace; key: {jProperty.Name}");

return $"{jProperty.Name}:{(options.Formatting == Formatting.Indented ? " " : null)}{BuildArgumentValue(jProperty.Value, null, options, level)}";
}

if (value is JObject jObject)
return BuildEnumerableArgument(jObject, null, options, level + 1, '{', '}');
#endif

var enumerable = value as IEnumerable;
if (!String.IsNullOrEmpty(formatMask) && enumerable == null)
return
value is IFormattable formattable
? "\"" + formattable.ToString(formatMask, CultureInfo.InvariantCulture) + "\""
? $"\"{EscapeGraphQlStringValue(formattable.ToString(formatMask, CultureInfo.InvariantCulture))}\""
: throw new ArgumentException($"Value must implement {nameof(IFormattable)} interface to use a format mask. ", nameof(value));

if (value is Enum @enum)
Expand All @@ -214,19 +193,19 @@ namespace GraphQlGenerator.Test
return @bool ? "true" : "false";

if (value is DateTime dateTime)
return "\"" + dateTime.ToString("O") + "\"";
return $"\"{dateTime.ToString("O")}\"";

if (value is DateTimeOffset dateTimeOffset)
return "\"" + dateTimeOffset.ToString("O") + "\"";
return $"\"{dateTimeOffset.ToString("O")}\"";

if (value is IGraphQlInputObject inputObject)
return BuildInputObject(inputObject, options, level + 2);

if (value is Guid)
return "\"" + value + "\"";
return $"\"{value}\"";

if (value is String @string)
return "\"" + @string.Replace("\"", "\\\"") + "\"";
return $"\"{EscapeGraphQlStringValue(@string)}\"";

if (enumerable != null)
return BuildEnumerableArgument(enumerable, formatMask, options, level, '[', ']');
Expand All @@ -235,10 +214,10 @@ namespace GraphQlGenerator.Test
return Convert.ToString(value, CultureInfo.InvariantCulture);

var argumentValue = Convert.ToString(value, CultureInfo.InvariantCulture);
return "\"" + argumentValue + "\"";
return $"\"{argumentValue}\"";
}

private static string BuildEnumerableArgument(IEnumerable enumerable, string formatMask, GraphQlBuilderOptions options, int level, char openingSymbol, char closingSymbol)
public static string BuildEnumerableArgument(IEnumerable enumerable, string formatMask, GraphQlBuilderOptions options, int level, char openingSymbol, char closingSymbol)
{
var builder = new StringBuilder();
builder.Append(openingSymbol);
Expand Down Expand Up @@ -282,7 +261,7 @@ namespace GraphQlGenerator.Test
var queryBuilderParameter = propertyValue.Value as QueryBuilderParameter;
var value =
queryBuilderParameter?.Name != null
? "$" + queryBuilderParameter.Name
? $"${queryBuilderParameter.Name}"
: BuildArgumentValue(queryBuilderParameter == null ? propertyValue.Value : queryBuilderParameter.Value, propertyValue.FormatMask, options, level);

builder.Append(isIndentedFormatting ? GetIndentation(level, options.IndentationSize) : separator);
Expand Down Expand Up @@ -363,6 +342,73 @@ namespace GraphQlGenerator.Test
}
}

public interface IGraphQlArgumentBuilder
{
bool TryBuild(GraphQlArgumentBuilderContext context, out string graphQlString);
}

public class GraphQlArgumentBuilderContext
{
public object Value { get; set; }
public string FormatMask { get; set; }
public GraphQlBuilderOptions Options { get; set; }
public int Level { get; set; }
}

public class DefaultGraphQlArgumentBuilder : IGraphQlArgumentBuilder
{
private static readonly Regex RegexWhiteSpace = new Regex(@"\s", RegexOptions.Compiled);

public static readonly DefaultGraphQlArgumentBuilder Instance = new();

public bool TryBuild(GraphQlArgumentBuilderContext context, out string graphQlString)
{
#if !GRAPHQL_GENERATOR_DISABLE_NEWTONSOFT_JSON
if (context.Value is JValue jValue)
{
switch (jValue.Type)
{
case JTokenType.Null:
graphQlString = "null";
return true;

case JTokenType.Integer:
case JTokenType.Float:
case JTokenType.Boolean:
graphQlString = GraphQlQueryHelper.BuildArgumentValue(jValue.Value, null, context.Options, context.Level);
return true;

case JTokenType.String:
graphQlString = $"\"{GraphQlQueryHelper.EscapeGraphQlStringValue((string)jValue.Value)}\"";
return true;

default:
graphQlString = $"\"{jValue.Value}\"";
return true;
}
}

if (context.Value is JProperty jProperty)
{
if (RegexWhiteSpace.IsMatch(jProperty.Name))
throw new ArgumentException($"JSON object keys used as GraphQL arguments must not contain whitespace; key: {jProperty.Name}");

graphQlString = $"{jProperty.Name}:{(context.Options.Formatting == Formatting.Indented ? " " : null)}{GraphQlQueryHelper.BuildArgumentValue(jProperty.Value, null, context.Options, context.Level)}";
return true;
}

if (context.Value is JObject jObject)
{
graphQlString = GraphQlQueryHelper.BuildEnumerableArgument(jObject, null, context.Options, context.Level + 1, '{', '}');
return true;
}
#endif

graphQlString = null;
return false;
}
}

internal struct InputPropertyInfo
{
public string Name { get; set; }
Expand Down Expand Up @@ -564,6 +610,7 @@ namespace GraphQlGenerator.Test
{
public Formatting Formatting { get; set; }
public byte IndentationSize { get; set; } = 2;
public IGraphQlArgumentBuilder ArgumentBuilder { get; set; }
}

public abstract partial class GraphQlQueryBuilder : IGraphQlQueryBuilder
Expand Down
Loading

0 comments on commit 1f6c1ba

Please sign in to comment.