Consolidate 2 json.dart files into 1. make new GithubJson part of common.

robbecker-wf · robbecker-wf · commit 16fb464c4d97 · 2020-04-11T14:15:35.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 6.2.0
+ - Bug fix: Fix setRepositorySubscription to be a PUT instead of a POST https://github.com/SpinlockLabs/github.dart/commit/5b5d7656ce9ce1cb06e15651da06e7e192bc19e1
+ - Bug fix: Repository clone URLs were null. DEPRECATED `Repository.cloneUrls` use `cloneUrl`,`gitUrl`,`sshUrl`, or `svnUrl` instead.
+ - Bug fix: Use a shared json encoder util to remove nulls from maps and lists, encode all dates for github. https://github.com/SpinlockLabs/github.dart/pull/182
+
 ## 6.1.3
  - Add missing fields for Notification https://github.com/SpinlockLabs/github.dart/pull/210
  - Can now create draft PRs https://github.com/SpinlockLabs/github.dart/pull/212
diff --git a/lib/src/common/activity_service.dart b/lib/src/common/activity_service.dart
@@ -3,7 +3,6 @@ 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/json.dart';
 import 'package:github/src/util.dart';
 import 'package:http/http.dart' as http;
 
diff --git a/lib/src/common/gists_service.dart b/lib/src/common/gists_service.dart
@@ -2,7 +2,6 @@ import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/json.dart';
 
 /// The [GistsService] handles communication with gist
 /// methods of the GitHub API.
diff --git a/lib/src/common/git_service.dart b/lib/src/common/git_service.dart
@@ -2,7 +2,6 @@ import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/json.dart';
 
 /// The [GitService] handles communication with git related methods of the
 /// GitHub API.
diff --git a/lib/src/common/issues_service.dart b/lib/src/common/issues_service.dart
@@ -4,7 +4,6 @@ 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/json.dart';
 
 /// The [IssuesService] handles communication with issues related methods of the
 /// GitHub API.
diff --git a/lib/src/common/misc_service.dart b/lib/src/common/misc_service.dart
@@ -1,6 +1,5 @@
 import 'dart:async';
 import 'package:github/src/common.dart';
-import 'package:github/src/json.dart';
 
 /// The [MiscService] handles communication with misc related methods of the
 /// GitHub API.
diff --git a/lib/src/common/model/repos.dart b/lib/src/common/model/repos.dart
@@ -190,7 +190,7 @@ class Repository {
 }
 
 /// Repository Clone Urls
-@Deprecated("These URLs are available on the Repository class")
+@Deprecated('These URLs are available on the Repository class')
 @JsonSerializable()
 class CloneUrls {
   /// Git Protocol
diff --git a/lib/src/common/orgs_service.dart b/lib/src/common/orgs_service.dart
@@ -2,7 +2,6 @@ import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/json.dart';
 import 'package:github/src/util.dart';
 import 'package:http/http.dart' as http;
 
diff --git a/lib/src/common/pulls_service.dart b/lib/src/common/pulls_service.dart
@@ -2,7 +2,6 @@ import 'dart:async';
 import 'dart:convert';
 import 'package:github/src/common.dart';
 import 'package:github/src/common/util/pagination.dart';
-import 'package:github/src/json.dart';
 import 'package:github/src/util.dart';
 
 /// The [PullRequestsService] handles communication with pull request
diff --git a/lib/src/common/repos_service.dart b/lib/src/common/repos_service.dart
@@ -4,7 +4,6 @@ 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/json.dart';
 import 'package:github/src/util.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,6 @@ 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/json.dart';
 import 'package:github/src/util.dart';
 import 'package:http/http.dart' as http;
 
diff --git a/lib/src/common/util/json.dart b/lib/src/common/util/json.dart
@@ -1,2 +1,61 @@
+import 'dart:convert';
+
+import 'package:github/src/common/util/utils.dart';
+
+
 /// Creates a Model Object from the JSON [input]
 typedef JSONConverter<S, T> = T Function(S input);
+
+
+/// Internal class for Json encoding
+/// that should be used instead of `dart:convert`.
+///
+/// It contains methods that ensures that converted Json
+/// will work with the GitHub API.
+class GitHubJson {
+  const GitHubJson._();
+
+  /// Called only if an object is of a non primitive type.
+  ///
+  /// If [object] is a [DateTime], it converts it to a String whose format is compatible with the API.
+  /// Else, it uses the default behavior of [JsonEncoder] which is to call `toJson` method onto [object].
+  ///
+  /// If [object] is not a [DateTime] and don't have a `toJson` method, an exception will be thrown
+  /// but handled by [JsonEncoder].
+  /// Do not catch it.
+  static dynamic _toEncodable(dynamic object) {
+    if (object is DateTime) {
+      return dateToGitHubIso8601(object);
+    }
+    // `toJson` could return a [Map] or a [List],
+    // so we have to delete null values in them.
+    return _checkObject(object.toJson());
+  }
+
+  /// Encodes [object] to a Json String compatible with the GitHub API.
+  /// It should be used instead of `jsonEncode`.
+  ///
+  /// Equivalent to `jsonEncode` except that
+  /// it converts [DateTime] to a proper String for the GitHub API,
+  /// and it also deletes keys associated with null values in maps before converting them.
+  ///
+  /// The obtained String can be decoded using `jsonDecode`.
+  static String encode(Object object, {String indent}) {
+    final encoder = JsonEncoder.withIndent(indent, _toEncodable);
+    return encoder.convert(_checkObject(object));
+  }
+
+  /// Deletes keys associated with null values
+  /// in every map contained in [object].
+  static dynamic _checkObject(dynamic object) {
+    if (object is Map) {
+      return Map.fromEntries(object.entries
+          .where((e) => e.value != null)
+          .map((e) => MapEntry(e.key, _checkObject(e.value))));
+    }
+    if (object is List) {
+      return object.map(_checkObject).toList();
+    }
+    return object;
+  }
+}
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/json.dart';
 import 'package:github/src/util.dart';
 import 'package:http/http.dart' as http;
 
diff --git a/lib/src/json.dart b/lib/src/json.dart
diff --git a/lib/src/server/hooks.dart b/lib/src/server/hooks.dart
@@ -1,7 +1,6 @@
 import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
-import 'package:github/src/json.dart';
 import 'package:json_annotation/json_annotation.dart';
 import '../common.dart';
 
diff --git a/test/data_object_test.dart b/test/data_object_test.dart
@@ -1,6 +1,5 @@
 import 'dart:convert';
 
-import 'package:github/src/json.dart';
 import 'package:test/test.dart';
 import 'package:github/github.dart';
 
diff --git a/test/experiment/error_handling.dart b/test/experiment/error_handling.dart
@@ -1,7 +1,6 @@
 import 'dart:io';
 
 import 'package:github/github.dart';
-import 'package:github/src/json.dart';
 
 import '../helper/http.dart';
 
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/json.dart';
 import 'package:github/src/util.dart';
 import 'package:http/http.dart' as http;
 import 'package:mockito/mockito.dart';

Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ class Repository {`
`190`	`190`	`}`
`191`	`191`
`192`	`192`	`/// Repository Clone Urls`
`193`		`-@Deprecated("These URLs are available on the Repository class")`
	`193`	`+@Deprecated('These URLs are available on the Repository class')`
`194`	`194`	`@JsonSerializable()`
`195`	`195`	`class CloneUrls {`
`196`	`196`	`/// Git Protocol`