Consolidated utils from src/util.dart into src/common/utils/utils.dart

robbecker-wf · robbecker-wf · commit 8c33a5ba70e7 · 2020-04-20T16:46:38.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 6.2.1
+ - Consolidated utils from src/util.dart into src/common/utils/utils.dart
+
 ## 6.2.0
  - Added Checks API https://github.com/SpinlockLabs/github.dart/pull/182
  - Bug fix: Fix setRepositorySubscription to be a PUT instead of a POST https://github.com/SpinlockLabs/github.dart/commit/5b5d7656ce9ce1cb06e15651da06e7e192bc19e1
diff --git a/lib/src/common/activity_service.dart b/lib/src/common/activity_service.dart
@@ -3,7 +3,7 @@ import 'dart:convert';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/model/users.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 import 'package:http/http.dart' as http;
 
 /// The [ActivityService] handles communication with activity related methods
diff --git a/lib/src/common/checks_service.dart b/lib/src/common/checks_service.dart
@@ -1,7 +1,7 @@
 import 'dart:convert';
 
 import 'package:github/github.dart';
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 import 'package:meta/meta.dart';
 
 const _previewHeader = 'application/vnd.github.antiope-preview+json';
diff --git a/lib/src/common/github.dart b/lib/src/common/github.dart
@@ -1,7 +1,7 @@
 import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 import 'package:http/http.dart' as http;
 import 'package:http_parser/http_parser.dart' as http_parser;
 import 'package:meta/meta.dart';
diff --git a/lib/src/common/model/checks.dart b/lib/src/common/model/checks.dart
@@ -1,5 +1,4 @@
 import 'package:github/src/common/util/utils.dart';
-import 'package:github/src/util.dart';
 import 'package:meta/meta.dart';
 
 class CheckRunAnnotationLevel extends EnumWithValue {
diff --git a/lib/src/common/model/repos.dart b/lib/src/common/model/repos.dart
@@ -1,5 +1,4 @@
 import 'package:github/src/common.dart';
-import 'package:github/src/util.dart';
 import 'package:json_annotation/json_annotation.dart';
 part 'repos.g.dart';
 
diff --git a/lib/src/common/orgs_service.dart b/lib/src/common/orgs_service.dart
@@ -2,7 +2,7 @@ import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 import 'package:http/http.dart' as http;
 
 /// The [OrganizationsService] handles communication with organization
diff --git a/lib/src/common/pulls_service.dart b/lib/src/common/pulls_service.dart
@@ -2,7 +2,7 @@ import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 
 /// The [PullRequestsService] handles communication with pull request
 /// methods of the GitHub API.
diff --git a/lib/src/common/repos_service.dart b/lib/src/common/repos_service.dart
@@ -4,7 +4,7 @@ import 'package:github/src/common.dart';
 import 'package:github/src/common/model/repos_releases.dart';
 import 'package:github/src/common/model/users.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 import 'package:http/http.dart' as http;
 import 'package:meta/meta.dart';
 
diff --git a/lib/src/common/users_service.dart b/lib/src/common/users_service.dart
@@ -2,7 +2,7 @@ import 'dart:async';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/model/users.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 import 'package:http/http.dart' as http;
 
 /// The [UsersService] handles communication with user related methods of the
diff --git a/lib/src/common/util/oauth2.dart b/lib/src/common/util/oauth2.dart
@@ -1,7 +1,6 @@
 import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
-import 'package:github/src/util.dart';
 import 'package:http/http.dart' as http;
 
 /// OAuth2 Flow Helper
diff --git a/lib/src/common/util/pagination.dart b/lib/src/common/util/pagination.dart
@@ -4,7 +4,6 @@ import 'dart:convert' show jsonDecode;
 import 'package:http/http.dart' as http;
 
 import '../../common.dart';
-import '../../util.dart';
 
 /// Internal Helper for dealing with GitHub Pagination.
 class PaginationHelper {
diff --git a/lib/src/common/util/utils.dart b/lib/src/common/util/utils.dart
@@ -1,5 +1,4 @@
 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,
@@ -92,3 +91,99 @@ abstract class StatusCodes {
 
   static bool isClientError(int code) => code > 400 && code < 500;
 }
+
+final RegExp githubDateRemoveRegExp = RegExp(r'\.\d*');
+
+const v3ApiMimeType = 'application/vnd.github.v3+json';
+
+String buildQueryString(Map<String, dynamic> params) {
+  final queryString = StringBuffer();
+
+  if (params.isNotEmpty && !params.values.every((value) => value == null)) {
+    queryString.write('?');
+  }
+
+  var i = 0;
+  for (final key in params.keys) {
+    i++;
+    if (params[key] == null) {
+      continue;
+    }
+    queryString.write('$key=${Uri.encodeComponent(params[key].toString())}');
+    if (i != params.keys.length) {
+      queryString.write('&');
+    }
+  }
+  return queryString.toString();
+}
+
+dynamic copyOf(dynamic input) {
+  if (input is Iterable) {
+    return List.from(input);
+  } else if (input is Map) {
+    return Map.from(input);
+  } else {
+    throw Exception('type could not be copied');
+  }
+}
+
+/// Puts a [name] and [value] into the [map] if [value] is not null. If [value]
+/// is null, nothing is added.
+void putValue(String name, dynamic value, Map<String, dynamic> map) {
+  if (value != null) {
+    map[name] = value;
+  }
+}
+
+List<MapEntry<dynamic, dynamic>> mapToList(Map<dynamic, dynamic> input) {
+  final out = <MapEntry<dynamic, dynamic>>[];
+  for (final key in input.keys) {
+    out.add(MapEntry<dynamic, dynamic>(key, input[key]));
+  }
+  return out;
+}
+
+/// Internal method to handle null for parsing dates.
+DateTime parseDateTime(String input) {
+  if (input == null) {
+    return null;
+  }
+
+  return DateTime.parse(input);
+}
+
+/// Returns a new map containing only the entries of [input] whose value is not null.
+///
+/// If [recursive] is true, nested maps are also filtered.
+Map<K, V> createNonNullMap<K, V>(Map<K, V> input, {bool recursive = true}) {
+  final map = <K, V>{};
+  for (final entry in input.entries) {
+    if (entry.value != null) {
+      map[entry.key] = recursive && entry.value is Map
+          ? createNonNullMap(entry.value as Map, recursive: recursive)
+          : entry.value;
+    }
+  }
+  return map;
+}
+
+// TODO: only used in test – delete?
+int parseFancyNumber(String input) {
+  input = input.trim();
+  if (input.contains(',')) {
+    input = input.replaceAll(',', '');
+  }
+
+  const multipliers = {'h': 100, 'k': 1000, 'ht': 100000, 'm': 1000000};
+  int value;
+
+  if (!multipliers.keys.any((m) => input.endsWith(m))) {
+    value = int.parse(input);
+  } else {
+    final m = multipliers.keys.firstWhere((m) => input.endsWith(m));
+    input = input.substring(0, input.length - m.length);
+    value = num.parse(input) * multipliers[m];
+  }
+
+  return value;
+}
diff --git a/lib/src/util.dart b/lib/src/util.dart
diff --git a/test/experiment/fancy_numbers.dart b/test/experiment/fancy_numbers.dart
@@ -1,4 +1,4 @@
-import 'package:github/src/util.dart';
+import 'package:github/src/common/util/utils.dart';
 
 void main() {
   test('1k', 1000);
diff --git a/test/git_test.dart b/test/git_test.dart
@@ -2,7 +2,6 @@ import 'dart:async';
 import 'dart:convert';
 
 import 'package:github/src/common.dart';
-import 'package:github/src/util.dart';
 import 'package:http/http.dart' as http;
 import 'package:mockito/mockito.dart';
 import 'package:test/test.dart';

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import 'package:github/src/common/util/utils.dart';`
`2`		`-import 'package:github/src/util.dart';`
`3`	`2`	`import 'package:meta/meta.dart';`
`4`	`3`
`5`	`4`	`class CheckRunAnnotationLevel extends EnumWithValue {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import 'package:github/src/common.dart';`
`2`		`-import 'package:github/src/util.dart';`
`3`	`2`	`import 'package:json_annotation/json_annotation.dart';`
`4`	`3`	`part 'repos.g.dart';`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import 'package:github/src/util.dart';`
	`1`	`+import 'package:github/src/common/util/utils.dart';`
`2`	`2`
`3`	`3`	`void main() {`
`4`	`4`	`test('1k', 1000);`