Skip to content

feat: v2 Enums #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

feat: v2 Enums #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9f7885
feat: added enums
ArthurFreeb Sep 27, 2025
86710f0
Merge branch 'feat/v2' into feat/v2/enum
ArthurFreeb Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/GoatQuery/src/Ast/Literals.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,14 @@ public BooleanLiteral(Token token, bool value) : base(token)
{
Value = value;
}
}
}

public sealed class EnumSymbolLiteral : QueryExpression
{
public string Value { get; set; }

public EnumSymbolLiteral(Token token, string value) : base(token)
{
Value = value;
}
}
78 changes: 77 additions & 1 deletion src/GoatQuery/src/Evaluator/FilterEvaluator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,22 @@ private static Result<Expression> CreateComparisonExpression(string operatorKeyw

private static Result<ConstantExpression> CreateConstantExpression(QueryExpression literal, Expression expression)
{
if (IsEnumOrNullableEnum(expression.Type))
{
if (literal is StringLiteral enumString)
{
return CreateEnumConstantFromString(enumString.Value, expression.Type);
}
if (literal is IntegerLiteral enumInt)
{
return CreateEnumConstantFromInteger(enumInt.Value, expression.Type);
}
if (literal is EnumSymbolLiteral enumSymbol)
{
return CreateEnumConstantFromString(enumSymbol.Value, expression.Type);
}
}

return literal switch
{
IntegerLiteral intLit => CreateIntegerConstant(intLit.Value, expression),
Expand All @@ -236,6 +252,7 @@ private static Result<ConstantExpression> CreateConstantExpression(QueryExpressi
DateTimeLiteral dtLit => Result.Ok(Expression.Constant(dtLit.Value, expression.Type)),
BooleanLiteral boolLit => Result.Ok(Expression.Constant(boolLit.Value, expression.Type)),
NullLiteral _ => Result.Ok(Expression.Constant(null, expression.Type)),
EnumSymbolLiteral enumSym => Result.Fail("Unquoted identifiers are only allowed for enum values"),
_ => Result.Fail($"Unsupported literal type: {literal.GetType().Name}")
};
}
Expand Down Expand Up @@ -563,6 +580,11 @@ private static Result<ConstantExpression> GetIntegerExpressionConstant(int value
{
try
{
if (IsEnumOrNullableEnum(targetType))
{
return CreateEnumConstantFromInteger(value, targetType);
}

// Fetch the underlying type if it's nullable.
var underlyingType = Nullable.GetUnderlyingType(targetType);
var type = underlyingType ?? targetType;
Expand Down Expand Up @@ -591,4 +613,58 @@ private static Result<ConstantExpression> GetIntegerExpressionConstant(int value
return Result.Fail($"Error converting {value} to {targetType.Name}: {ex.Message}");
}
}
}

private static bool IsEnumOrNullableEnum(Type type)
{
var underlying = Nullable.GetUnderlyingType(type) ?? type;
return underlying.IsEnum;
}

private static Result<ConstantExpression> CreateEnumConstantFromString(string value, Type targetType)
{
var isNullable = Nullable.GetUnderlyingType(targetType) != null;
var enumType = Nullable.GetUnderlyingType(targetType) ?? targetType;

try
{
var enumValue = Enum.Parse(enumType, value, ignoreCase: true);

if (isNullable)
{
var nullableType = typeof(Nullable<>).MakeGenericType(enumType);
var boxedNullable = Activator.CreateInstance(nullableType, enumValue);
return Expression.Constant(boxedNullable, targetType);
}

return Expression.Constant(enumValue, targetType);
}
catch (ArgumentException)
{
return Result.Fail($"'{value}' is not a valid value for enum type {enumType.Name}");
}
}

private static Result<ConstantExpression> CreateEnumConstantFromInteger(int intValue, Type targetType)
{
var isNullable = Nullable.GetUnderlyingType(targetType) != null;
var enumType = Nullable.GetUnderlyingType(targetType) ?? targetType;

try
{
var enumValue = Enum.ToObject(enumType, intValue);

if (isNullable)
{
var nullableType = typeof(Nullable<>).MakeGenericType(enumType);
var boxedNullable = Activator.CreateInstance(nullableType, enumValue);
return Expression.Constant(boxedNullable, targetType);
}

return Expression.Constant(enumValue, targetType);
}
catch (Exception ex)
{
return Result.Fail($"Error converting integer {intValue} to enum type {enumType.Name}: {ex.Message}");
}
}
}
3 changes: 2 additions & 1 deletion src/GoatQuery/src/Parser/Parser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ private Result<InfixExpression> ParseFilterStatement()

var statement = new InfixExpression(_currentToken, leftExpression, _currentToken.Literal);

if (!PeekTokenIn(TokenType.STRING, TokenType.INT, TokenType.GUID, TokenType.DATETIME, TokenType.DECIMAL, TokenType.FLOAT, TokenType.DOUBLE, TokenType.DATE, TokenType.NULL, TokenType.BOOLEAN))
if (!PeekTokenIn(TokenType.STRING, TokenType.INT, TokenType.GUID, TokenType.DATETIME, TokenType.DECIMAL, TokenType.FLOAT, TokenType.DOUBLE, TokenType.DATE, TokenType.NULL, TokenType.BOOLEAN, TokenType.IDENT))
{
return Result.Fail("Invalid value type within filter");
}
Expand Down Expand Up @@ -295,6 +295,7 @@ private QueryExpression ParseLiteral(Token token)
TokenType.BOOLEAN => bool.TryParse(token.Literal, out var boolValue)
? new BooleanLiteral(token, boolValue)
: null,
TokenType.IDENT => new EnumSymbolLiteral(token, token.Literal),
_ => null
};
}
Expand Down
12 changes: 10 additions & 2 deletions src/GoatQuery/src/Utilities/PropertyMappingTree.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,19 @@ private static bool ShouldCreateNestedMapping(Type type)

private static bool IsPrimitiveType(Type type)
{
if (type.IsEnum)
return true;

if (type.IsPrimitive || PrimitiveTypes.Contains(type))
return true;

// Handle nullable types
var underlyingType = Nullable.GetUnderlyingType(type);
return underlyingType != null && (underlyingType.IsPrimitive || PrimitiveTypes.Contains(underlyingType));
if (underlyingType == null)
return false;

if (underlyingType.IsEnum)
return true;

return underlyingType.IsPrimitive || PrimitiveTypes.Contains(underlyingType);
}
}
2 changes: 2 additions & 0 deletions src/GoatQuery/tests/Filter/FilterParserTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public sealed class FilterParserTest
[InlineData("dateOfBirth gte 2000-01-01", "dateOfBirth", "gte", "2000-01-01")]
[InlineData("dateOfBirth eq 2023-01-30T09:29:55.1750906Z", "dateOfBirth", "eq", "2023-01-30T09:29:55.1750906Z")]
[InlineData("balance eq null", "balance", "eq", "null")]
[InlineData("status eq Active", "status", "eq", "Active")]
[InlineData("balance ne null", "balance", "ne", "null")]
[InlineData("name eq NULL", "name", "eq", "NULL")]
public void Test_ParsingFilterStatement(string input, string expectedLeft, string expectedOperator, string expectedRight)
Expand Down Expand Up @@ -168,6 +169,7 @@ public void Test_ParsingFilterStatementWithAndAndOr()
[Theory]
[InlineData("manager/firstName eq 'John'", new string[] { "manager", "firstName" }, "eq", "John")]
[InlineData("manager/manager/firstName eq 'John'", new string[] { "manager", "manager", "firstName" }, "eq", "John")]
[InlineData("manager/status eq Active", new string[] { "manager", "status" }, "eq", "Active")]
public void Test_ParsingFilterStatementWithNestedProperty(string input, string[] expectedLeft, string expectedOperator, string expectedRight)
{
var lexer = new QueryLexer(input);
Expand Down
114 changes: 114 additions & 0 deletions src/GoatQuery/tests/Filter/FilterTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,119 @@ public static IEnumerable<object[]> Parameters()
"tags/all(x: x eq 'premium')",
new[] { TestData.Users["Egg"] }
};

// Status enum tests
yield return new object[] {
"status eq 'Active'",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Doe"], TestData.Users["Egg"] }
};

yield return new object[] {
"status eq 'Inactive'",
new[] { TestData.Users["Jane"], TestData.Users["NullUser"] }
};

yield return new object[] {
"status eq 'Suspended'",
new[] { TestData.Users["Harry"] }
};

yield return new object[] {
"status ne 'Active'",
new[] { TestData.Users["Jane"], TestData.Users["Harry"], TestData.Users["NullUser"] }
};

yield return new object[] {
"status ne 'Inactive'",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Harry"], TestData.Users["Doe"], TestData.Users["Egg"] }
};

yield return new object[] {
"status ne 'Suspended'",
new[] { TestData.Users["John"], TestData.Users["Jane"], TestData.Users["Apple"], TestData.Users["Doe"], TestData.Users["Egg"], TestData.Users["NullUser"] }
};

// Status combined with other properties
yield return new object[] {
"status eq 'Active' and age eq 1",
new[] { TestData.Users["Apple"], TestData.Users["Doe"] }
};

yield return new object[] {
"status eq 'Inactive' or age eq 33",
new[] { TestData.Users["Jane"], TestData.Users["Egg"], TestData.Users["NullUser"] }
};

yield return new object[] {
"status eq 'Active' and isEmailVerified eq true",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Doe"] }
};

yield return new object[] {
"status ne 'Active' and age lt 10",
new[] { TestData.Users["Jane"], TestData.Users["Harry"], TestData.Users["NullUser"] }
};

// Manager status tests
yield return new object[] {
"manager/status eq 'Active'",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Egg"] }
};

yield return new object[] {
"manager ne null and manager/status eq 'Active'",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Egg"] }
};

yield return new object[] {
"status eq Active",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Doe"], TestData.Users["Egg"] }
};

yield return new object[] {
"status eq Inactive",
new[] { TestData.Users["Jane"], TestData.Users["NullUser"] }
};

yield return new object[] {
"status eq Suspended",
new[] { TestData.Users["Harry"] }
};

yield return new object[] {
"status ne Active",
new[] { TestData.Users["Jane"], TestData.Users["Harry"], TestData.Users["NullUser"] }
};

yield return new object[] {
"status ne Inactive",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Harry"], TestData.Users["Doe"], TestData.Users["Egg"] }
};

yield return new object[] {
"status ne Suspended",
new[] { TestData.Users["John"], TestData.Users["Jane"], TestData.Users["Apple"], TestData.Users["Doe"], TestData.Users["Egg"], TestData.Users["NullUser"] }
};

yield return new object[] {
"status eq Active and age eq 1",
new[] { TestData.Users["Apple"], TestData.Users["Doe"] }
};

yield return new object[] {
"status eq Active and isEmailVerified eq true",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Doe"] }
};

yield return new object[] {
"manager/status eq Active",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Egg"] }
};

yield return new object[] {
"manager ne null and manager/status eq Active",
new[] { TestData.Users["John"], TestData.Users["Apple"], TestData.Users["Egg"] }
};
}

[Theory]
Expand Down Expand Up @@ -524,6 +637,7 @@ public void Test_Filter(string filter, IEnumerable<User> expected)
[InlineData("addresses/any(addr: addr/nonExistentProperty eq 'test')")]
[InlineData("addresses/invalid(addr: addr/city/name eq 'test')")]
[InlineData("nonExistentCollection/any(item: item eq 'test')")]
[InlineData("firstname eq John")] // Unquoted RHS on non-enum should error
public void Test_InvalidFilterReturnsError(string filter)
{
var query = new Query
Expand Down
Loading