Update mvi_base

Author: brianegan

mvi_base/analysis_options.yaml

@@ -1,14 +1,32 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
 analyzer:
-#   exclude:
-#     - path/to/excluded/files/**
-
-# Lint rules and documentation, see http://dart-lang.github.io/linter/lints
-linter:
-  rules:
-    - cancel_subscriptions
-    - hash_and_equals
-    - iterable_contains_unrelated_type
-    - list_remove_unrelated_type
-    - test_types_in_equals
-    - unrelated_type_equality_checks
-    - valid_regexps
+  language:
+    strict-casts: true
+    strict-inference: true
+    strict-raw-types: true
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

mvi_base/lib/mvi_base.dart

@@ -5,5 +5,5 @@ export 'src/mvi_core.dart';
 export 'src/mvi_stats.dart';
 export 'src/mvi_todo.dart';
 export 'src/mvi_todos_list.dart';
-export 'src/todos_interactor.dart';
+export 'src/todo_list_interactor.dart';
 export 'src/user_interactor.dart';

mvi_base/lib/src/models/todo.dart

@@ -9,11 +9,10 @@ class Todo {
   final String note;
   final String task;
 
-  Todo(this.task, {this.complete = false, String note = '', String id})
-    : this.note = note ?? '',
-      this.id = id ?? Uuid().generateV4();
+  Todo(this.task, {this.complete = false, this.note = '', String? id})
+    : id = id ?? Uuid().generateV4();
 
-  Todo copyWith({bool complete, String id, String note, String task}) {
+  Todo copyWith({bool? complete, String? id, String? note, String? task}) {
     return Todo(
       task ?? this.task,
       complete: complete ?? this.complete,
@@ -48,7 +47,7 @@ class Todo {
   static Todo fromEntity(TodoEntity entity) {
     return Todo(
       entity.task,
-      complete: entity.complete ?? false,
+      complete: entity.complete,
       note: entity.note,
       id: entity.id ?? Uuid().generateV4(),
     );

mvi_base/lib/src/models/user.dart

@@ -5,11 +5,13 @@ import 'package:todos_repository_core/todos_repository_core.dart';
 class User {
   final String displayName;
 
-  User(this.displayName);
+  User({required this.displayName});
 
-  UserEntity toEntity() => UserEntity(displayName: displayName);
+  UserEntity toEntity() =>
+      UserEntity(displayName: displayName, id: '', photoUrl: '');
 
-  static User fromEntity(UserEntity entity) => User(entity.displayName);
+  static User fromEntity(UserEntity entity) =>
+      User(displayName: entity.displayName);
 
   @override
   String toString() {

mvi_base/lib/src/mvi_core.dart

@@ -4,7 +4,7 @@ import 'package:meta/meta.dart';
 import 'package:rxdart/rxdart.dart';
 
 abstract class MviDisposable {
-  Future tearDown();
+  Future<void> tearDown();
 }
 
 // A class that should contain a number of broadcast StreamControllers. These
@@ -21,7 +21,7 @@ class MviPresenter<ViewModel> extends Stream<ViewModel>
   final BehaviorSubject<ViewModel> _subject;
   final List<StreamSubscription<dynamic>> subscriptions = [];
 
-  MviPresenter({@required Stream<ViewModel> stream, ViewModel initialModel})
+  MviPresenter({required Stream<ViewModel> stream, ViewModel? initialModel})
     : _subject = _createSubject<ViewModel>(stream, initialModel);
 
   // Get the current state. Useful for initial renders or re-renders when we
@@ -30,29 +30,29 @@ class MviPresenter<ViewModel> extends Stream<ViewModel>
 
   void setUp() {}
 
+  @override
   @mustCallSuper
-  Future tearDown() => Future.wait(
-    [_subject.close()]..addAll(subscriptions.map((s) => s.cancel())),
-  );
+  Future<void> tearDown() =>
+      Future.wait([_subject.close(), ...subscriptions.map((s) => s.cancel())]);
 
-  static _createSubject<ViewState>(
+  static BehaviorSubject<ViewState> _createSubject<ViewState>(
     Stream<ViewState> model,
-    ViewState initialState,
+    ViewState? initialState,
   ) {
-    StreamSubscription<ViewState> subscription;
-    BehaviorSubject<ViewState> _subject;
+    late StreamSubscription<ViewState> subscription;
+    late BehaviorSubject<ViewState> subject;
+
     void onListen() {
       subscription = model.listen(
-        _subject.add,
-        onError: _subject.addError,
-        onDone: _subject.close,
+        subject.add,
+        onError: subject.addError,
+        onDone: subject.close,
       );
     }
 
-    ;
     void onCancel() => subscription.cancel();
 
-    _subject = initialState == null
+    subject = initialState == null
         ? BehaviorSubject<ViewState>(
             onListen: onListen,
             onCancel: onCancel,
@@ -64,19 +64,21 @@ class MviPresenter<ViewModel> extends Stream<ViewModel>
             onCancel: onCancel,
           );
 
-    return _subject;
+    return subject;
   }
 
   @override
   StreamSubscription<ViewModel> listen(
-    void Function(ViewModel event) onData, {
-    Function onError,
-    void Function() onDone,
-    bool cancelOnError,
-  }) => _subject.stream.listen(
-    onData,
-    onError: onError,
-    onDone: onDone,
-    cancelOnError: cancelOnError,
-  );
+    void Function(ViewModel event)? onData, {
+    Function? onError,
+    void Function()? onDone,
+    bool? cancelOnError,
+  }) {
+    return _subject.stream.listen(
+      onData,
+      onError: onError,
+      onDone: onDone,
+      cancelOnError: cancelOnError,
+    );
+  }
 }

mvi_base/lib/src/mvi_stats.dart

@@ -3,7 +3,7 @@ import 'package:mvi_base/src/mvi_core.dart';
 import 'package:rxdart/rxdart.dart';
 
 class StatsPresenter extends MviPresenter<StatsModel> {
-  StatsPresenter(TodosInteractor interactor)
+  StatsPresenter(TodoListInteractor interactor)
     : super(
         stream: Rx.combineLatest2(
           interactor.todos.map(_numActive),

mvi_base/lib/src/mvi_todo.dart

@@ -1,29 +1,28 @@
 import 'dart:async';
 
-import 'package:meta/meta.dart';
 import 'package:mvi_base/src/models/models.dart';
 import 'package:mvi_base/src/mvi_core.dart';
-import 'package:mvi_base/src/todos_interactor.dart';
+import 'package:mvi_base/src/todo_list_interactor.dart';
 
 mixin DetailView implements MviView {
   final deleteTodo = StreamController<String>.broadcast(sync: true);
 
   final updateTodo = StreamController<Todo>.broadcast(sync: true);
 
   @override
-  Future tearDown() {
+  Future<void> tearDown() {
     return Future.wait([deleteTodo.close(), updateTodo.close()]);
   }
 }
 
 class DetailPresenter extends MviPresenter<Todo> {
   final DetailView _view;
-  final TodosInteractor _interactor;
+  final TodoListInteractor _interactor;
 
   DetailPresenter({
-    @required String id,
-    @required DetailView view,
-    @required TodosInteractor interactor,
+    required String id,
+    required DetailView view,
+    required TodoListInteractor interactor,
   }) : _view = view,
        _interactor = interactor,
        super(stream: interactor.todo(id));

mvi_base/lib/src/mvi_todos_list.dart

@@ -1,10 +1,9 @@
 import 'dart:async';
 
-import 'package:meta/meta.dart';
+import 'package:collection/equality.dart';
 import 'package:mvi_base/src/models/models.dart';
-import 'package:mvi_base/src/models/user.dart';
 import 'package:mvi_base/src/mvi_core.dart';
-import 'package:mvi_base/src/todos_interactor.dart';
+import 'package:mvi_base/src/todo_list_interactor.dart';
 import 'package:mvi_base/src/user_interactor.dart';
 import 'package:rxdart/rxdart.dart';
 
@@ -17,15 +16,22 @@ class TodosListModel {
   final User user;
 
   TodosListModel({
-    this.activeFilter,
-    this.allComplete,
-    this.hasCompletedTodos,
-    this.visibleTodos,
-    this.loading,
-    this.user,
+    required this.activeFilter,
+    required this.allComplete,
+    required this.hasCompletedTodos,
+    required this.visibleTodos,
+    required this.loading,
+    required this.user,
   });
 
-  factory TodosListModel.initial() => TodosListModel(loading: true);
+  factory TodosListModel.initial() => TodosListModel(
+    loading: true,
+    activeFilter: VisibilityFilter.all,
+    allComplete: false,
+    hasCompletedTodos: false,
+    visibleTodos: [],
+    user: User(displayName: ''),
+  );
 
   @override
   String toString() {
@@ -40,7 +46,7 @@ class TodosListModel {
           activeFilter == other.activeFilter &&
           allComplete == other.allComplete &&
           hasCompletedTodos == other.hasCompletedTodos &&
-          visibleTodos == other.visibleTodos &&
+          const ListEquality<Todo>().equals(visibleTodos, other.visibleTodos) &&
           loading == other.loading &&
           user == other.user;
 
@@ -69,7 +75,8 @@ class TodosListView implements MviView {
     VisibilityFilter.all,
   );
 
-  Future<List<dynamic>> tearDown() {
+  @override
+  Future<void> tearDown() {
     return Future.wait([
       addTodo.close(),
       deleteTodo.close(),
@@ -83,12 +90,12 @@ class TodosListView implements MviView {
 
 class TodosListPresenter extends MviPresenter<TodosListModel> {
   final TodosListView _view;
-  final TodosInteractor _interactor;
+  final TodoListInteractor _interactor;
 
   TodosListPresenter({
-    @required TodosListView view,
-    @required TodosInteractor todosInteractor,
-    @required UserInteractor userInteractor,
+    required TodosListView view,
+    required TodoListInteractor todosInteractor,
+    required UserInteractor userInteractor,
   }) : _view = view,
        _interactor = todosInteractor,
        super(
@@ -109,7 +116,7 @@ class TodosListPresenter extends MviPresenter<TodosListModel> {
 
   static Stream<TodosListModel> _buildStream(
     TodosListView view,
-    TodosInteractor interactor,
+    TodoListInteractor interactor,
     UserInteractor repository,
   ) {
     return Rx.defer(() async* {
@@ -145,7 +152,6 @@ class TodosListPresenter extends MviPresenter<TodosListModel> {
       case VisibilityFilter.completed:
         return todos.where((todo) => todo.complete).toList();
       case VisibilityFilter.all:
-      default:
         return todos;
     }
   }

mvi_base/lib/src/todos_interactor.dart renamed to mvi_base/lib/src/todo_list_interactor.dart

@@ -1,12 +1,14 @@
 import 'dart:async';
 
+import 'package:collection/collection.dart';
 import 'package:mvi_base/mvi_base.dart';
+import 'package:rxdart/rxdart.dart';
 import 'package:todos_repository_core/todos_repository_core.dart';
 
-class TodosInteractor {
+class TodoListInteractor {
   final ReactiveTodosRepository repository;
 
-  TodosInteractor(this.repository);
+  TodoListInteractor(this.repository);
 
   Stream<List<Todo>> get todos {
     return repository.todos().map(
@@ -16,10 +18,8 @@ class TodosInteractor {
 
   Stream<Todo> todo(String id) {
     return todos
-        .map((todos) {
-          return todos.firstWhere((todo) => todo.id == id, orElse: () => null);
-        })
-        .where((todo) => todo != null);
+        .map((todos) => todos.firstWhereOrNull((todo) => todo.id == id))
+        .whereNotNull();
   }
 
   Stream<bool> get allComplete => todos.map(_allComplete);

mvi_base/lib/src/user_interactor.dart

@@ -8,5 +8,6 @@ class UserInteractor {
 
   UserInteractor(UserRepository repository) : _repository = repository;
 
-  Future<User> login() async => User((await _repository.login()).displayName);
+  Future<User> login() async =>
+      User(displayName: (await _repository.login()).displayName);
 }