Make public the class EnumWithValue

axel-op · axel-op · commit bf6d317062dc · 2020-04-12T20:56:19.000+02:00
diff --git a/lib/src/common/model/checks.dart b/lib/src/common/model/checks.dart
@@ -1,30 +1,13 @@
+import 'package:github/src/common/util/utils.dart';
 import 'package:github/src/util.dart';
 import 'package:meta/meta.dart';
 
-@immutable
-abstract class _EnumWithValue {
-  final String _jsonValue;
-  const _EnumWithValue._(this._jsonValue);
-
-  @override
-  String toString() => _jsonValue;
-
-  String toJson() => _jsonValue;
-
-  @override
-  bool operator ==(dynamic other) =>
-      other is _EnumWithValue && _jsonValue == other._jsonValue;
-
-  @override
-  int get hashCode => _jsonValue.hashCode;
-}
-
-class CheckRunAnnotationLevel extends _EnumWithValue {
+class CheckRunAnnotationLevel extends EnumWithValue {
   static const notice = CheckRunAnnotationLevel._('notice');
   static const warning = CheckRunAnnotationLevel._('warning');
   static const failure = CheckRunAnnotationLevel._('failure');
 
-  const CheckRunAnnotationLevel._(String value) : super._(value);
+  const CheckRunAnnotationLevel._(String value) : super(value);
 
   factory CheckRunAnnotationLevel._fromValue(String value) {
     switch (value) {
@@ -56,15 +39,15 @@ class CheckRunAnnotationLevel extends _EnumWithValue {
   bool operator >=(CheckRunAnnotationLevel other) => !(this < other);
 }
 
-class CheckRunConclusion extends _EnumWithValue {
+class CheckRunConclusion extends EnumWithValue {
   static const success = CheckRunConclusion._('success');
   static const failure = CheckRunConclusion._('failure');
   static const neutral = CheckRunConclusion._('neutral');
   static const cancelled = CheckRunConclusion._('cancelled');
   static const timedOut = CheckRunConclusion._('timed_out');
   static const actionRequired = CheckRunConclusion._('action_required');
 
-  const CheckRunConclusion._(String value) : super._(value);
+  const CheckRunConclusion._(String value) : super(value);
 
   factory CheckRunConclusion._fromValue(String value) {
     for (final level in const [
@@ -75,7 +58,7 @@ class CheckRunConclusion extends _EnumWithValue {
       timedOut,
       actionRequired
     ]) {
-      if (level._jsonValue == value) {
+      if (level.value == value) {
         return level;
       }
     }
@@ -84,17 +67,17 @@ class CheckRunConclusion extends _EnumWithValue {
   }
 }
 
-class CheckRunStatus extends _EnumWithValue {
+class CheckRunStatus extends EnumWithValue {
   static const queued = CheckRunStatus._('queued');
   static const inProgress = CheckRunStatus._('in_progress');
   static const completed = CheckRunStatus._('completed');
-  const CheckRunStatus._(String value) : super._(value);
+  const CheckRunStatus._(String value) : super(value);
 }
 
-class CheckRunFilter extends _EnumWithValue {
+class CheckRunFilter extends EnumWithValue {
   static const all = CheckRunFilter._('all');
   static const latest = CheckRunFilter._('latest');
-  const CheckRunFilter._(String value) : super._(value);
+  const CheckRunFilter._(String value) : super(value);
 }
 
 @immutable
diff --git a/lib/src/common/util/utils.dart b/lib/src/common/util/utils.dart
@@ -1,5 +1,31 @@
 import 'package:github/src/common.dart';
 import 'package:github/src/util.dart';
+import 'package:meta/meta.dart';
+
+/// A Json encodable class that mimics an enum,
+/// but with a String value that is used for serialization.
+@immutable
+abstract class EnumWithValue {
+  final String value;
+
+  /// The value will be used when [toJson] or [toString] will be called.
+  /// It will also be used to check if two [EnumWithValue] are equal.
+  const EnumWithValue(this.value);
+
+  @override
+  String toString() => value;
+
+  /// Returns the String value of this.
+  String toJson() => value;
+
+  /// True iff [other] is an [EnumWithValue] with the same value as this object.
+  @override
+  bool operator ==(dynamic other) =>
+      other is EnumWithValue && value == other.value;
+
+  @override
+  int get hashCode => value.hashCode;
+}
 
 /// Marks something as not being ready or complete.
 class NotReadyYet {
@@ -21,7 +47,9 @@ class OnlyWhen {
 ///
 /// The format is "YYYY-MM-DDTHH:mm:ssZ"
 String dateToGitHubIso8601(DateTime date) {
-  if (date == null) return null;
+  if (date == null) {
+    return null;
+  }
   // Regex removes the milliseconds.
   return date.toUtc().toIso8601String().replaceAll(githubDateRemoveRegExp, '');
 }
