Fixed linter issues (#71)

f3ath · web-flow · commit 12d13fb432d5 · 2019-12-20T13:41:25.000-08:00
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -0,0 +1 @@
+include: package:pedantic/analysis_options.yaml
diff --git a/example/cars_server.dart b/example/cars_server.dart
@@ -4,6 +4,7 @@ import 'dart:io';
 import 'package:json_api/server.dart';
 import 'package:json_api/src/server/server_document_factory.dart';
 import 'package:json_api/url_design.dart';
+import 'package:pedantic/pedantic.dart';
 
 import 'cars_server/controller.dart';
 import 'cars_server/dao.dart';
@@ -63,6 +64,6 @@ Future<HttpServer> createServer(InternetAddress addr, int port) async {
       ServerDocumentFactory(urlDesign, pagination: pagination);
   final jsonApiServer = JsonApiServer(urlDesign, controller, documentFactory);
 
-  httpServer.forEach(jsonApiServer.serve);
+  unawaited(httpServer.forEach(jsonApiServer.serve));
   return httpServer;
 }
diff --git a/example/cars_server/controller.dart b/example/cars_server/controller.dart
@@ -205,6 +205,6 @@ class CarsController implements JsonApiController {
     return resource;
   }
 
-  Map<T, R> _filter<T, R>(Map<T, R> map, bool f(T t)) =>
+  Map<T, R> _filter<T, R>(Map<T, R> map, bool Function(T t) f) =>
       {...map}..removeWhere((k, _) => !f(k));
 }
diff --git a/example/cars_server/dao.dart b/example/cars_server/dao.dart
@@ -49,11 +49,14 @@ abstract class DAO<T> {
 }
 
 class ModelDAO extends DAO<Model> {
+  @override
   Resource toResource(Model _) =>
       Resource('models', _.id, attributes: {'name': _.name});
 
+  @override
   void insert(Model model) => _collection[model.id] = model;
 
+  @override
   Model create(Resource r) {
     return Model(r.id)..name = r.attributes['name'];
   }
@@ -66,17 +69,21 @@ class ModelDAO extends DAO<Model> {
 }
 
 class CityDAO extends DAO<City> {
+  @override
   Resource toResource(City _) =>
       Resource('cities', _.id, attributes: {'name': _.name});
 
+  @override
   void insert(City city) => _collection[city.id] = city;
 
+  @override
   City create(Resource r) {
     return City(r.id)..name = r.attributes['name'];
   }
 }
 
 class CompanyDAO extends DAO<Company> {
+  @override
   Resource toResource(Company company) =>
       Resource('companies', company.id, attributes: {
         'name': company.name,
@@ -90,11 +97,13 @@ class CompanyDAO extends DAO<Company> {
         'models': company.models.map((_) => Identifier('models', _)).toList()
       });
 
+  @override
   void insert(Company company) {
     company.updatedAt = DateTime.now();
     _collection[company.id] = company;
   }
 
+  @override
   Company create(Resource r) {
     return Company(r.id)
       ..name = r.attributes['name']
@@ -104,7 +113,7 @@ class CompanyDAO extends DAO<Company> {
   @override
   int deleteById(String id) {
     final company = fetchById(id);
-    int deps = company.headquarters == null ? 0 : 1;
+    var deps = company.headquarters == null ? 0 : 1;
     deps += company.models.length;
     _collection.remove(id);
     return deps;
diff --git a/example/cars_server/job_queue.dart b/example/cars_server/job_queue.dart
@@ -10,6 +10,6 @@ class Job {
   Resource resource;
 
   Job(Future<Resource> create) : id = Uuid().v4() {
-    create.then((_) => this.resource = _);
+    create.then((_) => resource = _);
   }
 }
diff --git a/example/cars_server/model.dart b/example/cars_server/model.dart
@@ -1,7 +1,7 @@
 class Company {
   final String id;
   String headquarters;
-  final models = Set<String>();
+  final models = <String>{};
 
   /// Company name
   String name;
diff --git a/lib/src/client/json_api_client.dart b/lib/src/client/json_api_client.dart
@@ -195,7 +195,7 @@ class JsonApiClient {
         ..body = json.encode(doc);
 
   Future<Response<D>> _call<D extends PrimaryData>(
-      http.Request request, D decodePrimaryData(Object _)) async {
+      http.Request request, D Function(Object _) decodePrimaryData) async {
     final response =
         await http.Response.fromStream(await httpClient.send(request));
     _onHttpCall(request, response);
@@ -217,6 +217,7 @@ class JsonApiClient {
 
 /// Defines the hook which gets called when the HTTP response is received from
 /// the HTTP Client.
-typedef void OnHttpCall(http.Request request, http.Response response);
+typedef OnHttpCall = void Function(
+    http.Request request, http.Response response);
 
-_doNothing(http.Request request, http.Response response) {}
+void _doNothing(http.Request request, http.Response response) {}
diff --git a/lib/src/document/api.dart b/lib/src/document/api.dart
@@ -9,7 +9,7 @@ class Api {
   final Map<String, Object> meta;
 
   Api({this.version, Map<String, Object> meta})
-      : this.meta = meta == null ? null : Map.unmodifiable(meta);
+      : meta = meta == null ? null : Map.unmodifiable(meta);
 
   static Api fromJson(Object json) {
     if (json is Map) {
diff --git a/lib/src/document/document.dart b/lib/src/document/document.dart
@@ -20,27 +20,27 @@ class Document<Data extends PrimaryData> {
 
   /// Create a document with primary data
   Document(this.data, {Map<String, Object> meta, this.api})
-      : this.errors = null,
-        this.meta = (meta == null) ? null : Map.unmodifiable(meta);
+      : errors = null,
+        meta = (meta == null) ? null : Map.unmodifiable(meta);
 
   /// Create a document with errors (no primary data)
   Document.error(Iterable<JsonApiError> errors,
       {Map<String, Object> meta, this.api})
-      : this.data = null,
-        this.meta = (meta == null) ? null : Map.unmodifiable(meta),
-        this.errors = List.unmodifiable(errors);
+      : data = null,
+        meta = (meta == null) ? null : Map.unmodifiable(meta),
+        errors = List.unmodifiable(errors);
 
   /// Create an empty document (no primary data and no errors)
   Document.empty(Map<String, Object> meta, {this.api})
-      : this.data = null,
-        this.meta = (meta == null) ? null : Map.unmodifiable(meta),
-        this.errors = null {
+      : data = null,
+        meta = (meta == null) ? null : Map.unmodifiable(meta),
+        errors = null {
     ArgumentError.checkNotNull(meta, 'meta');
   }
 
   /// Reconstructs a document with the specified primary data
   static Document<Data> fromJson<Data extends PrimaryData>(
-      Object json, Data primaryData(Object json)) {
+      Object json, Data Function(Object json) primaryData) {
     if (json is Map) {
       Api api;
       if (json.containsKey('jsonapi')) {
diff --git a/lib/src/document/identifier.dart b/lib/src/document/identifier.dart
@@ -23,5 +23,6 @@ class Identifier {
       other.type == type &&
       other.id == id;
 
-  String toString() => "Identifier($type:$id)";
+  @override
+  String toString() => 'Identifier($type:$id)';
 }
diff --git a/lib/src/document/identifier_object.dart b/lib/src/document/identifier_object.dart
@@ -16,7 +16,7 @@ class IdentifierObject {
   /// Creates an instance of [IdentifierObject].
   /// [type] and [id] can not be null.
   IdentifierObject(this.type, this.id, {Map<String, Object> meta})
-      : this.meta = (meta == null) ? null : Map.unmodifiable(meta) {
+      : meta = (meta == null) ? null : Map.unmodifiable(meta) {
     ArgumentError.checkNotNull(type);
     ArgumentError.checkNotNull(id);
   }
diff --git a/lib/src/document/link.dart b/lib/src/document/link.dart
@@ -26,7 +26,7 @@ class Link {
     throw DecodingException('Can not decode links map from $json');
   }
 
-  toJson() => uri.toString();
+  Object toJson() => uri.toString();
 
   @override
   String toString() => uri.toString();
@@ -49,7 +49,8 @@ class LinkObject extends Link {
     throw DecodingException('Can not decode LinkObject from $json');
   }
 
-  toJson() => {
+  @override
+  Object toJson() => {
         'href': uri.toString(),
         if (meta != null) ...{'meta': meta}
       };
diff --git a/lib/src/document/primary_data.dart b/lib/src/document/primary_data.dart
@@ -15,8 +15,8 @@ abstract class PrimaryData {
   final Map<String, Link> links;
 
   PrimaryData({Iterable<ResourceObject> included, Map<String, Link> links})
-      : this.included = (included == null) ? null : List.unmodifiable(included),
-        this.links = (links == null) ? null : Map.unmodifiable(links);
+      : included = (included == null) ? null : List.unmodifiable(included),
+        links = (links == null) ? null : Map.unmodifiable(links);
 
   /// The `self` link. May be null.
   Link get self => (links ?? {})['self'];
diff --git a/lib/src/document/relationship.dart b/lib/src/document/relationship.dart
@@ -50,6 +50,7 @@ class Relationship extends PrimaryData {
   }
 
   /// Top-level JSON object
+  @override
   Map<String, Object> toJson() => {
         ...super.toJson(),
         if (links != null) ...{'links': links}
@@ -85,6 +86,7 @@ class ToOne extends Relationship {
     throw DecodingException('Can not decode ToOne from $json');
   }
 
+  @override
   Map<String, Object> toJson() => {
         ...super.toJson(),
         ...{'data': linkage}
@@ -124,6 +126,7 @@ class ToMany extends Relationship {
     throw DecodingException('Can not decode ToMany from $json');
   }
 
+  @override
   Map<String, Object> toJson() => {
         ...super.toJson(),
         'data': linkage,
diff --git a/lib/src/nullable.dart b/lib/src/nullable.dart
@@ -1,3 +1,3 @@
-_Fun<U, V> nullable<V, U>(U f(V v)) => (v) => v == null ? null : f(v);
+_Fun<U, V> nullable<V, U>(U Function(V v) f) => (v) => v == null ? null : f(v);
 
-typedef U _Fun<U, V>(V v);
+typedef _Fun<U, V> = U Function(V v);
diff --git a/lib/src/query/include.dart b/lib/src/query/include.dart
@@ -20,6 +20,7 @@ class Include extends QueryParameters with IterableMixin<String> {
   static Include fromUri(Uri uri) =>
       Include((uri.queryParameters['include'] ?? '').split(','));
 
+  @override
   Iterator<String> get iterator => _resources.iterator;
 
   final List<String> _resources;
diff --git a/lib/src/server/http_method.dart b/lib/src/server/http_method.dart
@@ -1,7 +1,7 @@
 class HttpMethod {
   final String _name;
 
-  HttpMethod(String name) : this._name = name.toUpperCase();
+  HttpMethod(String name) : _name = name.toUpperCase();
 
   bool isPost() => _name == 'POST';
 
diff --git a/lib/src/server/response/error_response.dart b/lib/src/server/response/error_response.dart
@@ -7,6 +7,7 @@ class ErrorResponse extends JsonApiResponse {
 
   const ErrorResponse(int status, this.errors) : super(status);
 
+  @override
   Document buildDocument(ServerDocumentFactory builder, Uri self) =>
       builder.makeErrorDocument(errors);
 
diff --git a/lib/src/server/routing/route_factory.dart b/lib/src/server/routing/route_factory.dart
@@ -5,7 +5,7 @@ class RouteFactory implements MatchCase<Route> {
   const RouteFactory();
 
   @override
-  unmatched() => InvalidRoute();
+  Route unmatched() => InvalidRoute();
 
   @override
   Route collection(String type) => CollectionRoute(type);
diff --git a/lib/src/server/server_document_factory.dart b/lib/src/server/server_document_factory.dart
@@ -67,8 +67,8 @@ class ServerDocumentFactory {
           ToMany(
             identifiers.map(IdentifierObject.fromIdentifier),
             links: {
-              "self": Link(self),
-              "related": Link(_url.related(type, id, relationship))
+              'self': Link(self),
+              'related': Link(_url.related(type, id, relationship))
             },
           ),
           api: _api);
diff --git a/lib/src/url_design/path_based_url_design.dart b/lib/src/url_design/path_based_url_design.dart
@@ -11,6 +11,7 @@ class PathBasedUrlDesign implements UrlDesign {
   PathBasedUrlDesign(this.base);
 
   /// Returns a URL for the primary resource collection of type [type]
+  @override
   Uri collection(
     String type,
   ) =>
@@ -19,16 +20,19 @@ class PathBasedUrlDesign implements UrlDesign {
   /// Returns a URL for the related resource/collection.
   /// The [type] and [id] identify the primary resource and the [relationship]
   /// is the relationship name.
+  @override
   Uri related(String type, String id, String relationship) =>
       _appendToBase([type, id, relationship]);
 
   /// Returns a URL for the relationship itself.
   /// The [type] and [id] identify the primary resource and the [relationship]
   /// is the relationship name.
+  @override
   Uri relationship(String type, String id, String relationship) =>
       _appendToBase([type, id, _relationships, relationship]);
 
   /// Returns a URL for the primary resource of type [type] with id [id]
+  @override
   Uri resource(String type, String id) => _appendToBase([type, id]);
 
   @override
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: json_api
-version: 3.1.0
+version: 3.1.0+1
 homepage: https://github.com/f3ath/json-api-dart
 description: JSON:API Client for Flutter, Web and VM. Supports JSON:API v1.0 (http://jsonapi.org)
 environment:
@@ -8,6 +8,7 @@ dependencies:
   http: ^0.12.0
   collection: ^1.14.11
 dev_dependencies:
+  pedantic: ^1.0.0
   test: ^1.9.2
   json_matcher: ^0.2.3
   stream_channel: ^2.0.0
diff --git a/test/functional/test_server.dart b/test/functional/test_server.dart
@@ -1,10 +1,10 @@
 import 'dart:io';
 
-import "package:stream_channel/stream_channel.dart";
+import 'package:stream_channel/stream_channel.dart';
 
 import '../../example/cars_server.dart';
 
-hybridMain(StreamChannel channel, Object message) async {
+void hybridMain(StreamChannel channel, Object message) async {
   final port = 8080;
   await createServer(InternetAddress.loopbackIPv4, port);
   channel.sink.add(port);
diff --git a/test/unit/document/api_test.dart b/test/unit/document/api_test.dart
@@ -7,9 +7,9 @@ import 'package:test/test.dart';
 void main() {
   test('Api can be json-encoded', () {
     final api = Api.fromJson(
-        json.decode(json.encode(Api(version: "1.0", meta: {"foo": "bar"}))));
-    expect("1.0", api.version);
-    expect("bar", api.meta["foo"]);
+        json.decode(json.encode(Api(version: '1.0', meta: {'foo': 'bar'}))));
+    expect('1.0', api.version);
+    expect('bar', api.meta['foo']);
   });
 
   test('Empty/null properties are not encoded', () {
diff --git a/test/unit/document/meta_members_test.dart b/test/unit/document/meta_members_test.dart
diff --git a/test/unit/document/resource_object_test.dart b/test/unit/document/resource_object_test.dart
diff --git a/test/unit/url_design/path_based_url_design_test.dart b/test/unit/url_design/path_based_url_design_test.dart

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+include: package:pedantic/analysis_options.yaml`
Original file line number	Diff line number	Diff line change
`@@ -205,6 +205,6 @@ class CarsController implements JsonApiController {`
`205`	`205`	`return resource;`
`206`	`206`	`}`
`207`	`207`
`208`		`- Map<T, R> _filter<T, R>(Map<T, R> map, bool f(T t)) =>`
	`208`	`+ Map<T, R> _filter<T, R>(Map<T, R> map, bool Function(T t) f) =>`
`209`	`209`	`{...map}..removeWhere((k, _) => !f(k));`
`210`	`210`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,6 @@ class Job {`
`10`	`10`	`Resource resource;`
`11`	`11`
`12`	`12`	`Job(Future<Resource> create) : id = Uuid().v4() {`
`13`		`- create.then((_) => this.resource = _);`
	`13`	`+ create.then((_) => resource = _);`
`14`	`14`	`}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,6 @@ class Identifier {`
`23`	`23`	`other.type == type &&`
`24`	`24`	`other.id == id;`
`25`	`25`
`26`		`- String toString() => "Identifier($type:$id)";`
	`26`	`+ @override`
	`27`	`+ String toString() => 'Identifier($type:$id)';`
`27`	`28`	`}`