Merge pull request #244 from SpinlockLabs/nullsafe

nullsafe migration

Author: robrbecker

.github/workflows/dart.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     container:
-      image:  google/dart:latest
+      image: google/dart:2.12
 
     steps:
     - uses: actions/checkout@v1

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 8.0.0
+  - Allow start page, per_page, number of pages options to pagination helper
+  - Allow page options for listTags
+
+## 8.0.0-nullsafe.1
+  - Update to null safety
+
 ## 7.0.4
  - Add hasPages attribute to Repository https://github.com/SpinlockLabs/github.dart/pull/238
 
@@ -69,7 +76,7 @@
 - For web: browser specific helper methods have moved. use import `package:github/browser_helper.dart` (renderMarkdown, and createAvatorImage)
 - `createGithubClient(...)` has been removed. Just create a GitHub object directly now.
 - `findAuthenticationFromEnvironment` now works in both server/flutter and web environments
-  - On the web, it will check the query string first, then localstorage
+  - On the web, it will check the query string first, then session storage
 - all static methods are now factory constructors
 - fromJSON is now fromJson everywhere
 - toJSON is now toJson everywhere

build.yaml

@@ -0,0 +1,8 @@
+targets:
+  $default:
+    builders:
+      json_serializable:
+        options:
+          # Options configure how source code is generated for every
+          # `@JsonSerializable`-annotated class in the package.
+          field_rename: snake

example/common.dart

@@ -12,9 +12,9 @@ export 'package:github/browser_helper.dart';
 /// view source button, then you don't need to call this method
 Future<void> initViewSourceButton(String script) async {
   // query the DOM for the view source button, handle clicks
-  document.querySelector('#view-source')?.onClick?.listen((_) {
+  document.querySelector('#view-source')?.onClick.listen((_) {
     final popup = window.open('view_source.html?script=$script', 'View Source');
-    String code;
+    String? code;
 
     var fetched = false;
     var ready = false;

example/emoji.dart

@@ -3,7 +3,7 @@ import 'dart:html';
 
 import 'common.dart';
 
-Element emojiDiv;
+Element? emojiDiv;
 
 Future<void> main() async {
   await initViewSourceButton('emoji.dart');
@@ -25,23 +25,23 @@ Future<void> loadEmojis() async {
     h.append(
         ImageElement(src: url, width: 64, height: 64)..classes.add('emoji'));
     h.append(ParagraphElement()..text = ':$name:');
-    emojiDiv.append(h);
+    emojiDiv!.append(h);
   });
 }
 
-String lastQuery;
+String? lastQuery;
 
-void filter(String query) {
+void filter(String? query) {
   if (lastQuery != null && lastQuery == query) {
     return;
   }
   lastQuery = query;
-  final boxes = emojiDiv.children;
+  final boxes = emojiDiv!.children;
   for (final box in boxes) {
-    final boxName = box.querySelector('p');
-    final t = boxName.text;
+    final boxName = box.querySelector('p')!;
+    final t = boxName.text!;
     final name = t.substring(1, t.length - 1);
-    if (name.contains(query)) {
+    if (name.contains(query!)) {
       box.style.display = 'inline';
     } else {
       box.style.display = 'none';

example/index.dart

@@ -2,10 +2,10 @@ import 'dart:html';
 import 'common.dart';
 
 void main() {
-  final InputElement tokenInput = querySelector('#token');
-  tokenInput.value = github.auth.token ?? '';
-  window.sessionStorage['GITHUB_TOKEN'] = tokenInput.value;
+  final tokenInput = querySelector('#token') as InputElement;
+  tokenInput.value = github.auth!.token ?? '';
+  window.sessionStorage['GITHUB_TOKEN'] = tokenInput.value!;
   tokenInput.onKeyUp.listen((_) {
-    window.sessionStorage['GITHUB_TOKEN'] = tokenInput.value;
+    window.sessionStorage['GITHUB_TOKEN'] = tokenInput.value!;
   });
 }

example/languages.dart

@@ -3,31 +3,22 @@ import 'dart:html';
 import 'package:github/github.dart';
 import 'common.dart';
 
-DivElement tableDiv;
+DivElement? tableDiv;
 
-LanguageBreakdown breakdown;
+late LanguageBreakdown breakdown;
 
 Future<void> main() async {
   await initViewSourceButton('languages.dart');
-  tableDiv = querySelector('#table');
+  tableDiv = querySelector('#table') as DivElement?;
   await loadRepository();
 }
 
 Future<void> loadRepository() async {
-  var user = 'dart-lang';
-  var reponame = 'sdk';
-
   final params = queryString;
+  var user = params['user'] ?? 'dart-lang';
+  var reponame = params['repo'] ?? 'sdk';
 
-  if (params.containsKey('user')) {
-    user = params['user'];
-  }
-
-  if (params.containsKey('repo')) {
-    reponame = params['repo'];
-  }
-
-  document.getElementById('name').setInnerHtml('$user/$reponame');
+  document.getElementById('name')!.setInnerHtml('$user/$reponame');
 
   final repo = RepositorySlug(user, reponame);
   breakdown = await github.repositories.listLanguages(repo);
@@ -44,7 +35,7 @@ void reloadTable({int accuracy = 4}) {
   isReloadingTable = true;
   final md = generateMarkdown(accuracy);
   github.misc.renderMarkdown(md).then((html) {
-    tableDiv.setInnerHtml(html, treeSanitizer: NodeTreeSanitizer.trusted);
+    tableDiv!.setInnerHtml(html, treeSanitizer: NodeTreeSanitizer.trusted);
     isReloadingTable = false;
   });
 }
@@ -62,7 +53,7 @@ String generateMarkdown(int accuracy) {
   data.sort((a, b) => b[1].compareTo(a[1]));
 
   data.forEach((info) {
-    final String name = info[0];
+    final String? name = info[0];
     final int bytes = info[1];
     final num percentage = (bytes / total) * 100;
     md += '|$name|$bytes|${percentage.toStringAsFixed(accuracy)}|\n';

example/organization.dart

@@ -4,25 +4,25 @@ import 'dart:html';
 import 'package:github/github.dart';
 import 'common.dart';
 
-DivElement $output;
-InputElement $input;
-ButtonElement $btn;
+DivElement? $output;
+InputElement? $input;
+ButtonElement? $btn;
 
 Future<void> main() async {
   await initViewSourceButton('organization.dart');
-  $output = querySelector('#output');
-  $input = querySelector('#input');
-  $btn = querySelector('#submit');
-  $input.onChange.listen((_) {
-    loadOrganization($input.value);
+  $output = querySelector('#output') as DivElement?;
+  $input = querySelector('#input') as InputElement?;
+  $btn = querySelector('#submit') as ButtonElement?;
+  $input!.onChange.listen((_) {
+    loadOrganization($input!.value);
   });
-  $btn.onClick.listen((_) {
-    loadOrganization($input.value);
+  $btn!.onClick.listen((_) {
+    loadOrganization($input!.value);
   });
-  $btn.click();
+  $btn!.click();
 }
 
-Future<void> loadOrganization(String orgToLoad) async {
+Future<void> loadOrganization(String? orgToLoad) async {
   try {
     final org = await github.organizations.get(orgToLoad);
     final html = '''
@@ -32,8 +32,8 @@ Future<void> loadOrganization(String orgToLoad) async {
 <br/>Followers: ${org.followersCount}
 <br/>Following: ${org.followingCount}
 ''';
-    $output.innerHtml = html;
+    $output!.innerHtml = html;
   } on OrganizationNotFound {
-    $output.innerHtml = 'Not found.';
+    $output!.innerHtml = 'Not found.';
   }
 }

example/readme.dart

@@ -4,11 +4,9 @@ import 'package:github/github.dart';
 
 import 'common.dart';
 
-DivElement readmeDiv;
-
 Future<void> main() async {
   await initViewSourceButton('readme.dart');
-  readmeDiv = querySelector('#readme');
+  var readmeDiv = querySelector('#readme')!;
   var repo = RepositorySlug('SpinlockLabs', 'github.dart');
   final readme = await github.repositories.getReadme(repo);
   final html = await github.misc.renderMarkdown(readme.text);

example/releases.dart

@@ -4,11 +4,11 @@ import 'package:github/github.dart';
 
 import 'common.dart';
 
-DivElement releasesDiv;
+DivElement? releasesDiv;
 
 Future<void> main() async {
   await initViewSourceButton('releases.dart');
-  releasesDiv = querySelector('#releases');
+  releasesDiv = querySelector('#releases') as DivElement?;
   loadReleases();
 }
 
@@ -19,17 +19,14 @@ void loadReleases() {
       .toList()
       .then((releases) {
     for (final release in releases) {
-      releasesDiv.appendHtml('''
+      releasesDiv!.appendHtml('''
       <div class="repo box" id="release-${release.id}">
         <h1>${release.name}</h1>
       </div>
       ''', treeSanitizer: NodeTreeSanitizer.trusted);
-      final rel = releasesDiv.querySelector('#release-${release.id}');
+      final rel = releasesDiv!.querySelector('#release-${release.id}');
       void append(String key, String value) {
-        if (value == null) {
-          return;
-        }
-        rel.appendHtml('<br/><b>$key</b>: $value',
+        rel!.appendHtml('<br/><b>$key</b>: $value',
             treeSanitizer: NodeTreeSanitizer.trusted);
       }
 

example/repos.dart

@@ -5,54 +5,55 @@ import 'package:github/github.dart';
 
 import 'common.dart';
 
-DivElement repositoriesDiv;
-List<Repository> repos;
+DivElement? repositoriesDiv;
+List<Repository>? repos;
 
 Map<String, Comparator<Repository>> sorts = {
   'stars': (Repository a, Repository b) =>
       b.stargazersCount.compareTo(a.stargazersCount),
   'forks': (Repository a, Repository b) => b.forksCount.compareTo(a.forksCount),
-  'created': (Repository a, Repository b) => b.createdAt.compareTo(a.createdAt),
-  'pushed': (Repository a, Repository b) => b.pushedAt.compareTo(a.pushedAt),
+  'created': (Repository a, Repository b) =>
+      b.createdAt!.compareTo(a.createdAt!),
+  'pushed': (Repository a, Repository b) => b.pushedAt!.compareTo(a.pushedAt!),
   'size': (Repository a, Repository b) => b.size.compareTo(a.size)
 };
 
 Future<void> main() async {
   await initViewSourceButton('repos.dart');
 
-  repositoriesDiv = querySelector('#repos');
+  repositoriesDiv = querySelector('#repos') as DivElement?;
 
   loadRepos();
 
-  querySelector('#reload').onClick.listen((event) {
+  querySelector('#reload')!.onClick.listen((event) {
     loadRepos();
   });
 
   sorts.keys.forEach((name) {
-    querySelector('#sort-$name').onClick.listen((event) {
+    querySelector('#sort-$name')!.onClick.listen((event) {
       if (_reposCache == null) {
         loadRepos(sorts[name]);
       }
-      updateRepos(_reposCache, sorts[name]);
+      updateRepos(_reposCache!, sorts[name]);
     });
   });
 }
 
-List<Repository> _reposCache;
+List<Repository>? _reposCache;
 
 void updateRepos(
   List<Repository> repos, [
-  int Function(Repository a, Repository b) compare,
+  int Function(Repository a, Repository b)? compare,
 ]) {
-  document.querySelector('#repos').children.clear();
+  document.querySelector('#repos')!.children.clear();
   repos.sort(compare);
   for (final repo in repos) {
-    repositoriesDiv.appendHtml('''
+    repositoriesDiv!.appendHtml('''
         <div class="repo" id="repo_${repo.name}">
           <div class="line"></div>
           <h2><a href="${repo.htmlUrl}">${repo.name}</a></h2>
-          ${repo.description != "" && repo.description != null ? "<b>Description</b>: ${repo.description}<br/>" : ""}
-          <b>Language</b>: ${repo.language ?? "Unknown"}
+          ${repo.description != "" ? "<b>Description</b>: ${repo.description}<br/>" : ""}
+          <b>Language</b>: ${repo.language}
           <br/>
           <b>Default Branch</b>: ${repo.defaultBranch}
           <br/>
@@ -69,15 +70,15 @@ void updateRepos(
   }
 }
 
-void loadRepos([int Function(Repository a, Repository b) compare]) {
-  final title = querySelector('#title');
-  if (title.text.contains('(')) {
+void loadRepos([int Function(Repository a, Repository b)? compare]) {
+  final title = querySelector('#title')!;
+  if (title.text!.contains('(')) {
     title.replaceWith(HeadingElement.h2()
       ..text = 'GitHub for Dart - Repositories'
       ..id = 'title');
   }
 
-  var user = 'SpinlockLabs';
+  String? user = 'SpinlockLabs';
 
   if (queryString.containsKey('user')) {
     user = queryString['user'];
@@ -86,13 +87,13 @@ void loadRepos([int Function(Repository a, Repository b) compare]) {
   if (queryString.containsKey('sort') && compare == null) {
     final sorter = queryString['sort'];
     if (sorts.containsKey(sorter)) {
-      compare = sorts[sorter];
+      compare = sorts[sorter!];
     }
   }
 
   compare ??= (a, b) => a.name.compareTo(b.name);
 
-  github.repositories.listUserRepositories(user).toList().then((repos) {
+  github.repositories.listUserRepositories(user!).toList().then((repos) {
     _reposCache = repos;
     updateRepos(repos, compare);
   });