Allow start page, per_page, number of pages options to pagination helper

robrbecker · robrbecker · commit 78f23ef8e3e6 · 2021-03-06T21:09:43.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 8.0.0-nullsafe.2
+  - 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
 
diff --git a/lib/src/common/repos_service.dart b/lib/src/common/repos_service.dart
@@ -241,13 +241,12 @@ class RepositoriesService extends Service {
   /// Lists the tags of the specified repository.
   ///
   /// API docs: https://developer.github.com/v3/repos/#list-tags
-  Stream<Tag> listTags(RepositorySlug slug) {
+  Stream<Tag> listTags(RepositorySlug slug,
+      {int page = 1, int? pages, int perPage = 30}) {
     ArgumentError.checkNotNull(slug);
     return PaginationHelper(github).objects<Map<String, dynamic>, Tag>(
-      'GET',
-      '/repos/${slug.fullName}/tags',
-      (i) => Tag.fromJson(i),
-    );
+        'GET', '/repos/${slug.fullName}/tags', (i) => Tag.fromJson(i),
+        pages: pages, params: {'page': page, 'per_page': perPage});
   }
 
   /// Lists the branches of the specified repository.
diff --git a/lib/src/common/util/pagination.dart b/lib/src/common/util/pagination.dart
@@ -27,7 +27,9 @@ class PaginationHelper {
     } else {
       params = Map.from(params);
     }
-    assert(!params.containsKey('page'));
+
+    var page = params['page'] ?? 1;
+    params['page'] = page;
 
     // ignore: literal_only_boolean_expressions
     while (true) {
@@ -69,9 +71,7 @@ class PaginationHelper {
         break;
       }
 
-      final nextUrl = Uri.parse(next);
-      final nextPageArg = nextUrl.queryParameters['page']!;
-      params['page'] = nextPageArg;
+      params['page'] = ++page;
     }
   }
 
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: github
-version: 8.0.0-nullsafe.1
+version: 8.0.0-nullsafe.2
 description: A high-level GitHub API Client Library that uses Github's v3 API
 homepage: https://github.com/SpinlockLabs/github.dart
 

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,9 @@ class PaginationHelper {`
`27`	`27`	`} else {`
`28`	`28`	`params = Map.from(params);`
`29`	`29`	`}`
`30`		`- assert(!params.containsKey('page'));`
	`30`	`+`
	`31`	`+ var page = params['page'] ?? 1;`
	`32`	`+ params['page'] = page;`
`31`	`33`
`32`	`34`	`// ignore: literal_only_boolean_expressions`
`33`	`35`	`while (true) {`
`@@ -69,9 +71,7 @@ class PaginationHelper {`
`69`	`71`	`break;`
`70`	`72`	`}`
`71`	`73`
`72`		`- final nextUrl = Uri.parse(next);`
`73`		`- final nextPageArg = nextUrl.queryParameters['page']!;`
`74`		`- params['page'] = nextPageArg;`
	`74`	`+ params['page'] = ++page;`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`