Skip to content

Deprecated isNull/isNotNull/orElse/orElseValue on non-nullable expres… #331

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

Merged
jonasfj merged 1 commit into from
Dec 15, 2025
+190 −0
Merged

Deprecated isNull/isNotNull/orElse/orElseValue on non-nullable expres… #331

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
190 changes: 190 additions & 0 deletions typed_sql/lib/src/typed_sql.expr_ext.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,31 @@

part of 'typed_sql.dart';

/// Deprecation notice for `.isNull()` on non-nullable `Expr<T>`.
///
/// We have `.isNull()` on `Expr<T?>` which also matches `Expr<T>`, so we
/// overwrite `.isNull()` on `Expr<T>`, such that we can warn users from using
/// it. There is nothing dangerous about using `.isNull()` on a non-nullable
/// expression, it's the same as an unnecessary null-check in Dart.
const _isNullOnNonNullableDeprecation =
'Avoid using `.isNull()` on a non-nullable `Expr<T>`, '
'this will always evaluate to `TRUE`';

/// Deprecation notice for `.isNotNull()` on non-nullable `Expr<T>`.
const _isNotNullOnNonNullableDeprecation =
'Avoid using `.isNotNull()` on a non-nullable `Expr<T>`, '
'this will always evaluate to `FALSE`';

/// Deprecation notice for `.orElse()` on non-nullable `Expr<T>`.
const _orElseOnNonNullableDeprecation =
'Avoid using `.orElse(value)` on a non-nullable `Expr<T>`, '
'this will never evaluate to `value`, because `this` cannot be `NULL`';

/// Deprecation notice for `.orValueElse()` on non-nullable `Expr<T>`.
const _orElseValueOnNonNullableDeprecation =
'Avoid using `.orElseValue(value)` on a non-nullable `Expr<T>`, '
'this will never evaluate to `value`, because `this` cannot be `NULL`';

/// Extension methods for accessing the encoded value of a custom data type
/// expression.
extension CustomTypeExt<S> on Expr<CustomDataType<S>> {
Expand Down Expand Up @@ -386,6 +411,53 @@ extension ExpressionBool on Expr<bool> {
/// {@macro notEquals}
Expr<bool> notEqualsValue(bool? other) => notEquals(toExpr(other));

/// {@macro isNull}
///
/// {@template isNull-non-nullable-deprecation}
/// > [!WARNING]
/// > This will **always returns `TRUE`** because `this` is a
/// > _non-nullable expression_.
/// >
/// > **Avoid** using this method, it is always unnecessary.
/// {@endtemplate}
/// @nodoc
@Deprecated(_isNullOnNonNullableDeprecation)
Expr<bool> isNull() => isNotDistinctFrom(Expr.null$);

/// {@macro isNotNull}
///
/// {@template isNotNull-non-nullable-deprecation}
/// > [!WARNING]
/// > This will **always returns `FALSE`** because `this` is a
/// > _non-nullable expression_.
/// >
/// > **Avoid** using this method, it is always unnecessary.
/// {@endtemplate}
/// @nodoc
@Deprecated(_isNotNullOnNonNullableDeprecation)
Expr<bool> isNotNull() => isNull().not();

/// {@macro orElse}
///
/// {@template orElse-non-nullable-deprecation}
///
/// > [!WARNING]
/// > This will **never return [value]** because `this` is a
/// > _non-nullable expression_.
/// >
/// > **Avoid** using this method, it is always unnecessary.
/// {@endtemplate}
/// @nodoc
@Deprecated(_orElseOnNonNullableDeprecation)
Expr<bool> orElse(Expr<bool> value) => OrElseExpression._(this, value);

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseValueOnNonNullableDeprecation)
Expr<bool> orElseValue(bool value) => orElse(toExpr(value));

/// Negate this expression.
///
/// This is equivalent to `NOT this` in SQL.
Expand Down Expand Up @@ -470,6 +542,34 @@ extension ExpressionString on Expr<String> {
/// {@macro notEquals}
Expr<bool> notEqualsValue(String? other) => notEquals(toExpr(other));

/// {@macro isNull}
///
/// {@macro isNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNullOnNonNullableDeprecation)
Expr<bool> isNull() => isNotDistinctFrom(Expr.null$);

/// {@macro isNotNull}
///
/// {@macro isNotNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNotNullOnNonNullableDeprecation)
Expr<bool> isNotNull() => isNull().not();

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseOnNonNullableDeprecation)
Expr<String> orElse(Expr<String> value) => OrElseExpression._(this, value);

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseValueOnNonNullableDeprecation)
Expr<String> orElseValue(String value) => orElse(toExpr(value));

/// Check if the string is empty.
///
/// This is equivalent to `this = ''` in SQL.
Expand Down Expand Up @@ -855,6 +955,34 @@ extension ExpressionNum<T extends num> on Expr<T> {
/// {@macro notEquals}
Expr<bool> notEqualsValue(T? other) => notEquals(toExpr(other));

/// {@macro isNull}
///
/// {@macro isNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNullOnNonNullableDeprecation)
Expr<bool> isNull() => isNotDistinctFrom(Expr.null$);

/// {@macro isNotNull}
///
/// {@macro isNotNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNotNullOnNonNullableDeprecation)
Expr<bool> isNotNull() => isNull().not();

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseOnNonNullableDeprecation)
Expr<T> orElse(Expr<T> value) => OrElseExpression._(this, value);

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseValueOnNonNullableDeprecation)
Expr<T> orElseValue(T value) => orElse(toExpr(value));

/// {@macro lessThan}
Expr<bool> operator <(Expr<T> other) => ExpressionLessThan(this, other);

Expand Down Expand Up @@ -915,6 +1043,35 @@ extension ExpressionDateTime on Expr<DateTime> {
/// {@macro notEquals}
Expr<bool> notEqualsValue(DateTime? other) => notEquals(toExpr(other));

/// {@macro isNull}
///
/// {@macro isNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNullOnNonNullableDeprecation)
Expr<bool> isNull() => isNotDistinctFrom(Expr.null$);

/// {@macro isNotNull}
///
/// {@macro isNotNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNotNullOnNonNullableDeprecation)
Expr<bool> isNotNull() => isNull().not();

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseOnNonNullableDeprecation)
Expr<DateTime> orElse(Expr<DateTime> value) =>
OrElseExpression._(this, value);

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseValueOnNonNullableDeprecation)
Expr<DateTime> orElseValue(DateTime value) => orElse(toExpr(value));

// TODO: Decide if we want to support storing a Duration
// Expression<bool> difference(Expression<DateTime> value) =>

Expand Down Expand Up @@ -960,3 +1117,36 @@ extension ExpressionDateTime on Expr<DateTime> {

// TODO: More features... maybe there is a duration in SQL?
}

/// Extension methods for [JsonValue] expressions.
extension ExpressionJsonValue on Expr<JsonValue> {
/// {@macro isNull}
///
/// {@macro isNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNullOnNonNullableDeprecation)
Expr<bool> isNull() =>
ExpressionIsNotDistinctFrom<JsonValue>(this, Expr.null$);

/// {@macro isNotNull}
///
/// {@macro isNotNull-non-nullable-deprecation}
/// @nodoc
@Deprecated(_isNotNullOnNonNullableDeprecation)
Expr<bool> isNotNull() => isNull().not();

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseOnNonNullableDeprecation)
Expr<JsonValue> orElse(Expr<JsonValue> value) =>
OrElseExpression._(this, value);

/// {@macro orElse}
///
/// {@macro orElse-non-nullable-deprecation}
/// @nodoc
@Deprecated(_orElseValueOnNonNullableDeprecation)
Expr<JsonValue> orElseValue(JsonValue value) => orElse(toExpr(value));
}