Refactor and deprecate parts of ObservableList... (#12)

* Refactor ObservableList, start more deprecations. * More tests and fixes. * Fix remaining tests. * Add changelog for 0.18 * Dartfmt. * Fix bad merge. * Tiny changes.
google · Nov 22, 2016 · ca00061 · ca00061
1 parent 3d1cbce
commit ca00061
Show file tree

Hide file tree

Showing 12 changed files with 921 additions and 681 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,21 @@
+## 0.18.0
+
+* Refactor and deprecate `ObservableList`-specific API
+    * `ObservableList.applyChangeRecords`
+    * `ObservableList.calculateChangeRecords`
+    * `ObservableList.withLength`
+    * `ObservableList.deliverListChanges`
+    * `ObservableList.discardListChanges`
+    * `ObservableList.hasListChanges`
+    * `ObservableList.listChanges`
+    * `ObservableList.notifyListChange`
+* Potentially breaking: `ObservableList` may no longer be extended
+
+It is also considered deprecated to be notified of `length`, `isEmpty`
+and `isNotEmpty` `PropertyChangeRecord`s on `ObservableList` - in a
+future release `ObservableList.changes` will be
+`Stream<List<ListChangeRecord>>`.
+
 ## 0.17.0+1
 
 * Revert `PropertyChangeMixin`, which does not work in dart2js

diff --git a/lib/observable.dart b/lib/observable.dart
@@ -5,10 +5,10 @@
 library observable;
 
 export 'src/change_notifier.dart' show ChangeNotifier, PropertyChangeNotifier;
+export 'src/collections.dart' show ObservableList;
 export 'src/differs.dart' show Differ, EqualityDiffer, ListDiffer, MapDiffer;
 export 'src/records.dart'
     show ChangeRecord, ListChangeRecord, MapChangeRecord, PropertyChangeRecord;
 export 'src/observable.dart';
-export 'src/observable_list.dart';
 export 'src/observable_map.dart';
 export 'src/to_observable.dart';
diff --git a/lib/src/change_notifier.dart b/lib/src/change_notifier.dart
@@ -49,7 +49,6 @@ class ChangeNotifier<C extends ChangeRecord> implements Observable<C> {
   ///
   /// Returns `true` if changes were emitted.
   @override
-  @protected
   @mustCallSuper
   bool deliverChanges() {
     List<ChangeRecord> changes;

diff --git a/lib/src/collections.dart b/lib/src/collections.dart
@@ -0,0 +1 @@
+export 'collections/observable_list.dart';