Merge pull request #76 from mario-bermonti:mario-bermonti/issue70

Add functionality for automatically converting base models to json (Map<String, dynamic>)

lib/models/device.dart

@@ -1,9 +1,13 @@
 import 'dart:io';
 
 import 'package:flutter/material.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+part 'device.g.dart';
 
 /// Represents the characteristics of the device on which the data
 /// was collected. It serves as metadata about the data collected.
+@JsonSerializable()
 class Device {
   /// Unique identifier for the participant
   final String participantID;
@@ -46,4 +50,9 @@ class Device {
         "platform: $platform, height: $height, width: $width, "
         "aspectRatio: $aspectRatio)";
   }
+
+  /// Convert the [Device] object to its json representation.
+  /// This method is particularly useful when uploading data to Firebase and
+  /// similar no-sql dbs.
+  Map<String, dynamic> toJson() => _$DeviceToJson(this);
 }

lib/models/session.dart

@@ -1,4 +1,9 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'session.g.dart';
+
 /// Represents the metadata for data collection session.
+@JsonSerializable()
 class Session {
   /// Unique identifier for the participant
   final String participantID;
@@ -24,4 +29,9 @@ class Session {
     return "Session(participantID: $participantID, sessionID: $sessionID, "
         "startTime: $startTime, endTime: $endTime)";
   }
+
+  /// Convert the [Session] object to its json representation.
+  /// This method is particularly useful when uploading data to Firebase and
+  /// similar no-sql dbs.
+  Map<String, dynamic> toJson() => _$SessionToJson(this);
 }

lib/models/trial.dart

@@ -1,6 +1,11 @@
+import 'package:json_annotation/json_annotation.dart';
+
 import 'trial_type.dart';
 
+part 'trial.g.dart';
+
 /// Represents the data of a single trial.
+@JsonSerializable()
 class Trial {
   /// Unique identifier for the participant
   final String participantID;
@@ -34,4 +39,9 @@ class Trial {
     return "Trial(participantID: $participantID, sessionID: $sessionID, "
         "trialType: $trialType, stim: $stim, response: $response)";
   }
+
+  /// Convert the [Trial] object to its json representation.
+  /// This method is particularly useful when uploading data to Firebase and
+  /// similar no-sql dbs.
+  Map<String, dynamic> toJson() => _$TrialToJson(this);
 }

pubspec.yaml

@@ -14,6 +14,7 @@ dependencies:
   sqlite3_flutter_libs: ^0.5.0
   firebase_core: ^2.8.0
   cloud_firestore: ^4.4.5
+  json_annotation: ^4.8.1
 
 dev_dependencies:
   flutter_test:
@@ -22,6 +23,7 @@ dev_dependencies:
   drift_dev: ^2.16.0
   build_runner: ^2.1.11
   test: ^1.21.1
+  json_serializable: ^6.7.1
   # fake_cloud_firestore: ^2.1.0
 
 flutter:

test/models/device_test.dart

@@ -13,4 +13,15 @@ void main() {
 
     expect(device.toString(), strRep);
   });
+
+  test(
+    "Device.toJson returns a valid json representation",
+    () {
+      final Device device = Device(participantID: '101', sessionID: '001');
+
+      final Map<String, dynamic> deviceJson = device.toJson();
+
+      expect(deviceJson, isMap);
+    },
+  );
 }

test/models/session_test.dart

@@ -15,4 +15,20 @@ void main() {
         "endTime: ${session.endTime})";
     expect(session.toString(), strRep);
   });
+
+  test(
+    "Session.toJson() returns a valid json representation",
+    () {
+      final Session session = Session(
+        participantID: '101',
+        sessionID: '001',
+        startTime: DateTime.now(),
+        endTime: DateTime.now(),
+      );
+
+      final Map<String, dynamic> sessionJson = session.toJson();
+
+      expect(sessionJson, isMap);
+    },
+  );
 }

test/models/trial_test.dart

@@ -17,4 +17,21 @@ void main() {
         "response: ${trial.response})";
     expect(trial.toString(), strRep);
   });
+
+  test(
+    "Trial.toJson returns a valid json representation",
+    () {
+      final Trial trial = Trial(
+        participantID: '101',
+        sessionID: '001',
+        trialType: TrialType.practice,
+        stim: 'stimuli',
+        response: 'participant response',
+      );
+
+      final Map<String, dynamic> trialJson = trial.toJson();
+
+      expect(trialJson, isMap);
+    },
+  );
 }