Remove Identity

Author: f3ath

example/server/in_memory_repo.dart

@@ -28,11 +28,11 @@ class InMemoryRepo implements Repository {
   }
 
   @override
-  Stream<Identity> addMany(
-      String type, String id, String rel, Iterable<Identity> ids) {
+  Stream<Identifier> addMany(
+      String type, String id, String rel, Iterable<Identifier> ids) {
     final many = _many(type, id, rel);
     many.addAll(ids.map(Reference.of));
-    return Stream.fromIterable(many);
+    return Stream.fromIterable(many).map((e) => e.toIdentifier());
   }
 
   @override
@@ -47,21 +47,25 @@ class InMemoryRepo implements Repository {
 
   @override
   Future<void> replaceOne(
-      String type, String id, String rel, Identity? one) async {
+      String type, String id, String rel, Identifier? one) async {
     _model(type, id).one[rel] = nullable(Reference.of)(one);
   }
 
   @override
-  Stream<Identity> deleteMany(
-          String type, String id, String rel, Iterable<Identity> many) =>
-      Stream.fromIterable(_many(type, id, rel)..removeAll(many.map(Reference.of)));
+  Stream<Identifier> deleteMany(
+          String type, String id, String rel, Iterable<Identifier> many) =>
+      Stream.fromIterable(
+              _many(type, id, rel)..removeAll(many.map(Reference.of)))
+          .map((it) => it.toIdentifier());
 
   @override
-  Stream<Identity> replaceMany(
-          String type, String id, String rel, Iterable<Identity> many) =>
-      Stream.fromIterable(_many(type, id, rel)
-        ..clear()
-        ..addAll(many.map(Reference.of)));
+  Stream<Identifier> replaceMany(
+      String type, String id, String rel, Iterable<Identifier> many) {
+    final set = _many(type, id, rel);
+    set.clear();
+    set.addAll(many.map(Reference.of));
+    return Stream.fromIterable(set).map((it) => it.toIdentifier());
+  }
 
   Map<String, Model> _collection(String type) =>
       (_storage[type] ?? (throw CollectionNotFound()));

example/server/repository.dart

@@ -16,26 +16,26 @@ abstract class Repository {
   /// Throws [CollectionNotFound].
   /// Throws [ResourceNotFound].
   /// Throws [RelationshipNotFound].
-  Stream<Identity> addMany(
-      String type, String id, String rel, Iterable<Identity> refs);
+  Stream<Identifier> addMany(
+      String type, String id, String rel, Iterable<Identifier> many);
 
   /// Delete the resource
   Future<void> delete(String type, String id);
 
   /// Updates the model
   Future<void> update(String type, String id, ModelProps props);
 
-  Future<void> replaceOne(String type, String id, String rel, Identity? ref);
+  Future<void> replaceOne(String type, String id, String rel, Identifier? one);
 
   /// Deletes refs from the to-many relationship.
   /// Returns the new actual refs.
-  Stream<Identity> deleteMany(
-      String type, String id, String rel, Iterable<Identity> refs);
+  Stream<Identifier> deleteMany(
+      String type, String id, String rel, Iterable<Identifier> many);
 
   /// Replaces refs in the to-many relationship.
   /// Returns the new actual refs.
-  Stream<Identity> replaceMany(
-      String type, String id, String rel, Iterable<Identity> refs);
+  Stream<Identifier> replaceMany(
+      String type, String id, String rel, Iterable<Identifier> many);
 }
 
 class CollectionNotFound implements Exception {}
@@ -44,11 +44,12 @@ class ResourceNotFound implements Exception {}
 
 class RelationshipNotFound implements Exception {}
 
-class Reference with Identity {
+class Reference {
   Reference(this.type, this.id);
 
-  static Reference of(Identity identity) => Reference(identity.type, identity.id);
+  static Reference of(Identifier id) => Reference(id.type, id.id);
 
+  Identifier toIdentifier() => Identifier(type, id);
   @override
   final String type;
   @override
@@ -111,10 +112,10 @@ class Model extends ModelProps {
     });
     one.forEach((key, value) {
       res.relationships[key] =
-          (value == null ? ToOne.empty() : ToOne(Identifier.of(value)));
+          (value == null ? ToOne.empty() : ToOne(value.toIdentifier()));
     });
     many.forEach((key, value) {
-      res.relationships[key] = ToMany(value.map(Identifier.of));
+      res.relationships[key] = ToMany(value.map((it) => it.toIdentifier()));
     });
     return res;
   }

example/server/repository_controller.dart

@@ -68,8 +68,7 @@ class RepositoryController implements Controller {
     final refs = await repo
         .addMany(target.type, target.id, target.relationship, many)
         .toList();
-    return Response.ok(
-        OutboundDataDocument.many(ToMany(refs.map(Identifier.of))));
+    return Response.ok(OutboundDataDocument.many(ToMany(refs)));
   }
 
   @override
@@ -94,13 +93,12 @@ class RepositoryController implements Controller {
     if (rel is ToOne) {
       final ref = rel.identifier;
       await repo.replaceOne(target.type, target.id, target.relationship, ref);
-      return Response.ok(OutboundDataDocument.one(
-          ref == null ? ToOne.empty() : ToOne(Identifier.of(ref))));
+      return Response.ok(
+          OutboundDataDocument.one(ref == null ? ToOne.empty() : ToOne(ref)));
     }
     if (rel is ToMany) {
       final ids = await repo
           .replaceMany(target.type, target.id, target.relationship, rel)
-          .map(Identifier.of)
           .toList();
       return Response.ok(OutboundDataDocument.many(ToMany(ids)));
     }
@@ -113,7 +111,6 @@ class RepositoryController implements Controller {
     final rel = (await _decode(request)).asToMany();
     final ids = await repo
         .deleteMany(target.type, target.id, target.relationship, rel)
-        .map(Identifier.of)
         .toList();
     return Response.ok(OutboundDataDocument.many(ToMany(ids)));
   }
@@ -125,11 +122,12 @@ class RepositoryController implements Controller {
 
     if (model.one.containsKey(target.relationship)) {
       return Response.ok(OutboundDataDocument.one(
-          ToOne(nullable(Identifier.of)(model.one[target.relationship]))));
+          ToOne(model.one[target.relationship]?.toIdentifier())));
     }
-    final many = model.many[target.relationship];
+    final many =
+        model.many[target.relationship]?.map((it) => it.toIdentifier());
     if (many != null) {
-      final doc = OutboundDataDocument.many(ToMany(many.map(Identifier.of)));
+      final doc = OutboundDataDocument.many(ToMany(many));
       return Response.ok(doc);
     }
     throw RelationshipNotFound();

lib/document.dart

@@ -3,7 +3,6 @@ library document;
 
 export 'package:json_api/src/document/error_object.dart';
 export 'package:json_api/src/document/identifier.dart';
-export 'package:json_api/src/document/identity.dart';
 export 'package:json_api/src/document/inbound_document.dart';
 export 'package:json_api/src/document/link.dart';
 export 'package:json_api/src/document/many.dart';

lib/src/document/identifier.dart

@@ -1,17 +1,25 @@
-import 'package:json_api/src/document/identity.dart';
+import 'package:json_api/src/document/resource.dart';
 
 /// A Resource Identifier object
-class Identifier with Identity {
+class Identifier {
   Identifier(this.type, this.id);
 
-  static Identifier of(Identity identity) =>
-      Identifier(identity.type, identity.id);
+  static Identifier of(Resource resource) =>
+      Identifier(resource.type, resource.id);
 
-  @override
   final String type;
-  @override
   final String id;
 
+  String get key => '$type:$id';
+
+  // /// True if the [other] identifier references the same object.
+  // bool hasSameReference(Identifier other) =>
+  //     type == other.type && id == other.id;
+
+  /// True if this identifier identifies the [resource].
+  bool identifies(Resource resource) =>
+      type == resource.type && id == resource.id;
+
   /// Identifier meta-data.
   final meta = <String, Object?>{};
 

lib/src/document/identity.dart

@@ -1,14 +1,12 @@
-import 'package:json_api/src/document/identity.dart';
 import 'package:json_api/src/document/link.dart';
 import 'package:json_api/src/document/resource_properties.dart';
 
-class Resource with ResourceProperties, Identity {
+class Resource with ResourceProperties {
   Resource(this.type, this.id);
 
-  @override
   final String type;
-  @override
   final String id;
+  String get key => '$type:$id';
 
   /// Resource links
   final links = <String, Link>{};

lib/src/document/resource.dart

@@ -1,2 +1,3 @@
+/// Nullable function application.
 U? Function(V? v) nullable<V, U>(U Function(V v) f) =>
     (v) => v == null ? null : f(v);

lib/src/nullable.dart

@@ -95,13 +95,13 @@ void main() {
 
     test('Fetch a to-one relationship', () async {
       await client.fetchToOne(post.type, post.id, 'author').then((r) {
-        expect(Identity.same(r.relationship.identifier!, alice), isTrue);
+        expect(r.relationship.identifier!.identifies(alice), isTrue);
       });
     });
 
     test('Fetch a to-many relationship', () async {
       await client.fetchToMany(post.type, post.id, 'comments').then((r) {
-        expect(Identity.same(r.relationship.single, comment), isTrue);
+        expect(r.relationship.single.identifies(comment), isTrue);
       });
     });