Merge pull request #251 from Abion47/master

Refactors all usages of Iterable to use List

README.md

@@ -43,16 +43,16 @@ If you do not request user permission or have it granted, the application will f
 import 'package:contacts_service/contacts_service.dart';  
   
 // Get all contacts on device
-Iterable<Contact> contacts = await ContactsService.getContacts();  
+List<Contact> contacts = await ContactsService.getContacts();  
 
 // Get all contacts without thumbnail (faster)
-Iterable<Contact> contacts = await ContactsService.getContacts(withThumbnails: false);
+List<Contact> contacts = await ContactsService.getContacts(withThumbnails: false);
 
 // Android only: Get thumbnail for an avatar afterwards (only necessary if `withThumbnails: false` is used)
 Uint8List avatar = await ContactsService.getAvatar(contact);
   
 // Get contacts matching a string
-Iterable<Contact> johns = await ContactsService.getContacts(query : "john");
+List<Contact> johns = await ContactsService.getContacts(query : "john");
 
 // Add a contact  
 // The contact must have a firstName / lastName to be successfully added  
@@ -86,13 +86,13 @@ String displayName, givenName, middleName, prefix, suffix, familyName;
 String company, jobTitle;
 
 // Email addresses
-Iterable<Item> emails = [];
+List<Item> emails = [];
 
 // Phone numbers
-Iterable<Item> phones = [];
+List<Item> phones = [];
 
 // Post addresses
-Iterable<PostalAddress> postalAddresses = [];
+List<PostalAddress> postalAddresses = [];
 
 // Contact avatar/thumbnail
 Uint8List avatar;

example/lib/contacts_list_page.dart

@@ -22,10 +22,9 @@ class _ContactListPageState extends State<ContactListPage> {
   Future<void> refreshContacts() async {
     // Load without thumbnails initially.
     var contacts = (await ContactsService.getContacts(
-            withThumbnails: false, iOSLocalizedLabels: iOSLocalizedLabels))
-        .toList();
+        withThumbnails: false, iOSLocalizedLabels: iOSLocalizedLabels));
 //      var contacts = (await ContactsService.getContactsForPhone("8554964652"))
-//          .toList();
+//          ;
     setState(() {
       _contacts = contacts;
     });
@@ -41,7 +40,6 @@ class _ContactListPageState extends State<ContactListPage> {
 
   void updateContact() async {
     Contact ninja = _contacts
-        .toList()
         .firstWhere((contact) => contact.familyName.startsWith("Ninja"));
     ninja.avatar = null;
     await ContactsService.updateContact(ninja);
@@ -51,7 +49,7 @@ class _ContactListPageState extends State<ContactListPage> {
 
   _openContactForm() async {
     try {
-      var contact = await ContactsService.openContactForm(
+      var _ = await ContactsService.openContactForm(
           iOSLocalizedLabels: iOSLocalizedLabels);
       refreshContacts();
     } on FormOperationException catch (e) {
@@ -234,43 +232,44 @@ class ContactDetailsPage extends StatelessWidget {
 class AddressesTile extends StatelessWidget {
   AddressesTile(this._addresses);
 
-  final Iterable<PostalAddress> _addresses;
+  final List<PostalAddress> _addresses;
 
   Widget build(BuildContext context) {
     return Column(
       crossAxisAlignment: CrossAxisAlignment.start,
       children: <Widget>[
         ListTile(title: Text("Addresses")),
         Column(
-          children: _addresses
-              .map((a) => Padding(
-                    padding: const EdgeInsets.symmetric(horizontal: 16.0),
-                    child: Column(
-                      children: <Widget>[
-                        ListTile(
-                          title: Text("Street"),
-                          trailing: Text(a.street ?? ""),
-                        ),
-                        ListTile(
-                          title: Text("Postcode"),
-                          trailing: Text(a.postcode ?? ""),
-                        ),
-                        ListTile(
-                          title: Text("City"),
-                          trailing: Text(a.city ?? ""),
-                        ),
-                        ListTile(
-                          title: Text("Region"),
-                          trailing: Text(a.region ?? ""),
-                        ),
-                        ListTile(
-                          title: Text("Country"),
-                          trailing: Text(a.country ?? ""),
-                        ),
-                      ],
+          children: [
+            for (var a in _addresses)
+              Padding(
+                padding: const EdgeInsets.symmetric(horizontal: 16.0),
+                child: Column(
+                  children: <Widget>[
+                    ListTile(
+                      title: Text("Street"),
+                      trailing: Text(a.street ?? ""),
                     ),
-                  ))
-              .toList(),
+                    ListTile(
+                      title: Text("Postcode"),
+                      trailing: Text(a.postcode ?? ""),
+                    ),
+                    ListTile(
+                      title: Text("City"),
+                      trailing: Text(a.city ?? ""),
+                    ),
+                    ListTile(
+                      title: Text("Region"),
+                      trailing: Text(a.region ?? ""),
+                    ),
+                    ListTile(
+                      title: Text("Country"),
+                      trailing: Text(a.country ?? ""),
+                    ),
+                  ],
+                ),
+              ),
+          ],
         ),
       ],
     );
@@ -280,7 +279,7 @@ class AddressesTile extends StatelessWidget {
 class ItemsTile extends StatelessWidget {
   ItemsTile(this._title, this._items);
 
-  final Iterable<Item> _items;
+  final List<Item> _items;
   final String _title;
 
   @override
@@ -290,17 +289,16 @@ class ItemsTile extends StatelessWidget {
       children: <Widget>[
         ListTile(title: Text(_title)),
         Column(
-          children: _items
-              .map(
-                (i) => Padding(
-                  padding: const EdgeInsets.symmetric(horizontal: 16.0),
-                  child: ListTile(
-                    title: Text(i.label ?? ""),
-                    trailing: Text(i.value ?? ""),
-                  ),
+          children: [
+            for (var i in _items)
+              Padding(
+                padding: const EdgeInsets.symmetric(horizontal: 16.0),
+                child: ListTile(
+                  title: Text(i.label ?? ""),
+                  trailing: Text(i.value ?? ""),
                 ),
-              )
-              .toList(),
+              ),
+          ],
         ),
       ],
     );
@@ -323,7 +321,7 @@ class _AddContactPageState extends State<AddContactPage> {
       appBar: AppBar(
         title: Text("Add a contact"),
         actions: <Widget>[
-          FlatButton(
+          TextButton(
             onPressed: () {
               _formKey.currentState.save();
               contact.postalAddresses = [address];

example/lib/contacts_picker_page.dart

@@ -35,7 +35,7 @@ class _ContactPickerPageState extends State<ContactPickerPage> {
       body: SafeArea(
           child: Column(
         children: <Widget>[
-          RaisedButton(
+          ElevatedButton(
             child: const Text('Pick a contact'),
             onPressed: _pickContact,
           ),

example/lib/main.dart

@@ -76,11 +76,11 @@ class _HomePageState extends State<HomePage> {
         child: Column(
           crossAxisAlignment: CrossAxisAlignment.stretch,
           children: <Widget>[
-            RaisedButton(
+            ElevatedButton(
               child: const Text('Contacts list'),
               onPressed: () => _askPermissions('/contactsList'),
             ),
-            RaisedButton(
+            ElevatedButton(
               child: const Text('Native Contacts picker'),
               onPressed: () => _askPermissions('/nativeContactPicker'),
             ),

lib/contacts_service.dart

@@ -13,7 +13,7 @@ class ContactsService {
 
   /// Fetches all contacts, or when specified, the contacts with a name
   /// matching [query]
-  static Future<Iterable<Contact>> getContacts(
+  static Future<List<Contact>> getContacts(
       {String? query,
       bool withThumbnails = true,
       bool photoHighResolution = true,
@@ -29,18 +29,18 @@ class ContactsService {
       'iOSLocalizedLabels': iOSLocalizedLabels,
       'androidLocalizedLabels': androidLocalizedLabels,
     });
-    return contacts.map((m) => Contact.fromMap(m));
+    return contacts.map((m) => Contact.fromMap(m)).toList();
   }
 
   /// Fetches all contacts, or when specified, the contacts with the phone
   /// matching [phone]
-  static Future<Iterable<Contact>> getContactsForPhone(String? phone,
+  static Future<List<Contact>> getContactsForPhone(String? phone,
       {bool withThumbnails = true,
       bool photoHighResolution = true,
       bool orderByGivenName = true,
       bool iOSLocalizedLabels = true,
       bool androidLocalizedLabels = true}) async {
-    if (phone == null || phone.isEmpty) return Iterable.empty();
+    if (phone == null || phone.isEmpty) return List.empty();
 
     Iterable contacts =
         await _channel.invokeMethod('getContactsForPhone', <String, dynamic>{
@@ -51,19 +51,19 @@ class ContactsService {
       'iOSLocalizedLabels': iOSLocalizedLabels,
       'androidLocalizedLabels': androidLocalizedLabels,
     });
-    return contacts.map((m) => Contact.fromMap(m));
+    return contacts.map((m) => Contact.fromMap(m)).toList();
   }
 
   /// Fetches all contacts, or when specified, the contacts with the email
   /// matching [email]
   /// Works only on iOS
-  static Future<Iterable<Contact>> getContactsForEmail(String email,
+  static Future<List<Contact>> getContactsForEmail(String email,
       {bool withThumbnails = true,
       bool photoHighResolution = true,
       bool orderByGivenName = true,
       bool iOSLocalizedLabels = true,
       bool androidLocalizedLabels = true}) async {
-    Iterable contacts =
+    List contacts =
         await _channel.invokeMethod('getContactsForEmail', <String, dynamic>{
       'email': email,
       'withThumbnails': withThumbnails,
@@ -72,7 +72,7 @@ class ContactsService {
       'iOSLocalizedLabels': iOSLocalizedLabels,
       'androidLocalizedLabels': androidLocalizedLabels,
     });
-    return contacts.map((m) => Contact.fromMap(m));
+    return contacts.map((m) => Contact.fromMap(m)).toList();
   }
 
   /// Loads the avatar for the given contact and returns it. If the user does
@@ -132,9 +132,9 @@ class ContactsService {
       'androidLocalizedLabels': androidLocalizedLabels,
     });
     // result contains either :
-    // - an Iterable of contacts containing 0 or 1 contact
+    // - an List of contacts containing 0 or 1 contact
     // - a FormOperationErrorCode value
-    if (result is Iterable) {
+    if (result is List) {
       if (result.isEmpty) {
         return null;
       }
@@ -209,9 +209,9 @@ class Contact {
       jobTitle;
   String? androidAccountTypeRaw, androidAccountName;
   AndroidAccountType? androidAccountType;
-  Iterable<Item>? emails = [];
-  Iterable<Item>? phones = [];
-  Iterable<PostalAddress>? postalAddresses = [];
+  List<Item>? emails = [];
+  List<Item>? phones = [];
+  List<PostalAddress>? postalAddresses = [];
   Uint8List? avatar;
   DateTime? birthday;
 
@@ -234,10 +234,11 @@ class Contact {
     androidAccountTypeRaw = m["androidAccountType"];
     androidAccountType = accountTypeFromString(androidAccountTypeRaw);
     androidAccountName = m["androidAccountName"];
-    emails = (m["emails"] as Iterable?)?.map((m) => Item.fromMap(m));
-    phones = (m["phones"] as Iterable?)?.map((m) => Item.fromMap(m));
-    postalAddresses = (m["postalAddresses"] as Iterable?)
-        ?.map((m) => PostalAddress.fromMap(m));
+    emails = (m["emails"] as List?)?.map((m) => Item.fromMap(m)).toList();
+    phones = (m["phones"] as List?)?.map((m) => Item.fromMap(m)).toList();
+    postalAddresses = (m["postalAddresses"] as List?)
+        ?.map((m) => PostalAddress.fromMap(m))
+        .toList();
     avatar = m["avatar"];
     try {
       birthday = m["birthday"] != null ? DateTime.parse(m["birthday"]) : null;

test/contacts_test.dart

@@ -44,10 +44,10 @@ void main() {
     final contacts = await ContactsService.getContacts();
     expect(contacts.length, 2);
     expect(contacts, everyElement(isInstanceOf<Contact>()));
-    expect(contacts.toList()[0].givenName, 'givenName1');
-    expect(contacts.toList()[1].postalAddresses!.toList()[0].label, 'label');
-    expect(contacts.toList()[1].emails!.toList()[0].label, 'label');
-    expect(contacts.toList()[1].birthday, DateTime(1994, 2, 1));
+    expect(contacts[0].givenName, 'givenName1');
+    expect(contacts[1].postalAddresses![0].label, 'label');
+    expect(contacts[1].emails![0].label, 'label');
+    expect(contacts[1].birthday, DateTime(1994, 2, 1));
   });
 
   test('should get avatar for contact identifiers', () async {
@@ -79,8 +79,8 @@ void main() {
     test('returns contacts if phone number supplied', () async {
       final contacts = await ContactsService.getContactsForPhone('1234567890');
       expect(contacts.length, equals(2));
-      expect(contacts.toList()[0].givenName, 'givenName1');
-      expect(contacts.toList()[1].givenName, 'givenName2');
+      expect(contacts[0].givenName, 'givenName1');
+      expect(contacts[1].givenName, 'givenName2');
     });
   });
 
@@ -91,8 +91,8 @@ void main() {
         'abc@example.net',
       );
       expect(contacts.length, equals(2));
-      expect(contacts.toList()[0].givenName, 'givenName1');
-      expect(contacts.toList()[1].givenName, 'givenName2');
+      expect(contacts[0].givenName, 'givenName1');
+      expect(contacts[1].givenName, 'givenName2');
     });
   });