Skip to content
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.

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

#feat: Add value or absent option #449

Merged
merged 5 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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: 12 additions & 0 deletions codegen/gql_tristate_value/lib/src/value.dart
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ sealed class Value<T extends Object> {
/// If the value is non-null, it will be serialized as the value.
const factory Value.present(T? value) = PresentValue<T>;

/// If the value is non-null, it will be serialized as the value.
/// If the value is null. It will not be serialized.
factory Value.ofNullable(T? value) {
if (value == null) {
return AbsentValue();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can this be const?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be... My mistake. I am used to having a lint prefer_const_constructors 😅 Thanks 🙏

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah I know, gql_pedantic should be modernized at some point ;)

}
return Value.present(value);
}

/// Returns the value if present (no matter if null or non-null), otherwise throws a [StateError].
T? get requireValue => switch (this) {
PresentValue(:final value) => value,
Expand Down Expand Up @@ -51,4 +60,7 @@ class PresentValue<T extends Object> extends Value<T> {

@override
int get hashCode => value.hashCode;

@override
String toString() => '$runtimeType(value: $value)';
}
114 changes: 94 additions & 20 deletions codegen/gql_tristate_value/test/value_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,107 @@ import 'package:gql_tristate_value/gql_tristate_value.dart';
import 'package:test/test.dart';

void main() {
test("requireValue on absent throws", () {
final absent = const AbsentValue();
group(
'requireValue',
() {
test('on $AbsentValue throws', () {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove the $ from the test strings.

I like static test names better if possible, dynamic ones make filtering by test name harder, and the test names generally become weird:

Screenshot 2024-02-20 at 17 51 10

Copy link
Collaborator

@knaeckeKami knaeckeKami Feb 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-02-20 at 17 52 59

Also breaks IntellIj "rerun test" feature

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For sure ${Value.ofNullable} should not be there. I forgot to check how it looks like in logs.
But personally I like to use e.g. $AbsentValue, because it's very helpful when refactoring the code. You don't have to remember about every place in the code where you have just a string with the class name.
But I changed all the names to static ones 👌

final absent = const AbsentValue();

expect(() => absent.requireValue, throwsA(isA<StateError>()));
});
expect(() => absent.requireValue, throwsA(isA<StateError>()));
});

test("requireValue on present returns value", () {
final present = Value.present(42);
test('on $PresentValue with valuereturns value', () {
final present = Value.present(42);

expect(present.requireValue, equals(42));
});
expect(present.requireValue, equals(42));
});

test("requireValue on null returns null", () {
final nullValue = Value<String>.present(null);
test('on $PresentValue with null returns null', () {
final nullValue = Value<String>.present(null);

expect(nullValue.requireValue, isNull);
});
expect(nullValue.requireValue, isNull);
});

test("valueOrNull on absent returns null", () {
final absent = const AbsentValue();
test('on ${Value.ofNullable} with value returns value', () {
final present = Value.ofNullable(42);

expect(absent.valueOrNull, isNull);
});
expect(present.requireValue, equals(42));
});

test("valueOrNull on present returns value", () {
final present = Value.present(42);
test('on ${Value.ofNullable} with null throws', () {
final nullValue = Value<String>.ofNullable(null);

expect(present.valueOrNull, equals(42));
});
expect(() => nullValue.requireValue, throwsA(isA<StateError>()));
});
},
);

group(
'valueOrNull ',
() {
test('on $AbsentValue returns null', () {
final absent = const AbsentValue();

expect(absent.valueOrNull, isNull);
});

test('on $PresentValue with value returns value', () {
final present = Value.present(42);

expect(present.valueOrNull, equals(42));
});

test('on ${Value.ofNullable} with value returns value', () {
final present = Value.ofNullable(42);

expect(present.valueOrNull, equals(42));
});

test('on ${Value.ofNullable} with null returns null', () {
final present = Value<String>.ofNullable(null);

expect(present.valueOrNull, isNull);
});
},
);

group(
'isPresent ',
() {
test('on $AbsentValue returns false', () {
final absent = const AbsentValue();

expect(absent.isPresent, false);
});

test('on $PresentValue with value returns true', () {
final present = Value.present(42);

expect(present.isPresent, true);
});

test('on ${Value.ofNullable} with value returns true', () {
final present = Value.ofNullable(42);

expect(present.isPresent, true);
});

test('on ${Value.ofNullable} with null returns false', () {
final present = Value<String>.ofNullable(null);

expect(present.isPresent, false);
});
},
);

group(
'toString ',
() {
test('on $PresentValue', () {
final present = Value.present(42);

expect(present.toString(), 'PresentValue<int>(value: 42)');
});
},
);
}
Loading