channel [nfc]: Rename StreamStore/Impl to ChannelStore/Impl, and rename file

Fixes parts of #631

Author: Khader-1

lib/model/stream.dart renamed to lib/model/channel.dart

@@ -2,13 +2,13 @@ import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
 
-/// The portion of [PerAccountStore] for streams, topics, and stuff about them.
+/// The portion of [PerAccountStore] for channels, topics, and stuff about them.
 ///
 /// This type is useful for expressing the needs of other parts of the
 /// implementation of [PerAccountStore], to avoid circularity.
 ///
-/// The data structures described here are implemented at [StreamStoreImpl].
-mixin StreamStore {
+/// The data structures described here are implemented at [ChannelStoreImpl].
+mixin ChannelStore {
   Map<int, ZulipStream> get streams;
   Map<String, ZulipStream> get streamsByName;
   Map<int, Subscription> get subscriptions;
@@ -67,13 +67,13 @@ mixin StreamStore {
   }
 }
 
-/// The implementation of [StreamStore] that does the work.
+/// The implementation of [ChannelStore] that does the work.
 ///
 /// Generally the only code that should need this class is [PerAccountStore]
 /// itself.  Other code accesses this functionality through [PerAccountStore],
-/// or through the mixin [StreamStore] which describes its interface.
-class StreamStoreImpl with StreamStore {
-  factory StreamStoreImpl({required InitialSnapshot initialSnapshot}) {
+/// or through the mixin [ChannelStore] which describes its interface.
+class ChannelStoreImpl with ChannelStore {
+  factory ChannelStoreImpl({required InitialSnapshot initialSnapshot}) {
     final subscriptions = Map.fromEntries(initialSnapshot.subscriptions.map(
       (subscription) => MapEntry(subscription.streamId, subscription)));
 
@@ -92,15 +92,15 @@ class StreamStoreImpl with StreamStore {
       forStream[item.topicName] = item.visibilityPolicy;
     }
 
-    return StreamStoreImpl._(
+    return ChannelStoreImpl._(
       streams: streams,
       streamsByName: streams.map((_, stream) => MapEntry(stream.name, stream)),
       subscriptions: subscriptions,
       topicVisibility: topicVisibility,
     );
   }
 
-  StreamStoreImpl._({
+  ChannelStoreImpl._({
     required this.streams,
     required this.streamsByName,
     required this.subscriptions,

lib/model/internal_link.dart

@@ -4,7 +4,7 @@ import 'package:json_annotation/json_annotation.dart';
 import '../api/model/narrow.dart';
 import 'narrow.dart';
 import 'store.dart';
-import 'stream.dart';
+import 'channel.dart';
 
 part 'internal_link.g.dart';
 
@@ -245,7 +245,7 @@ enum _NarrowOperator {
 ///
 /// Returns null if the operand has an unexpected shape, or has the old shape
 /// (stream name but no ID) and we don't know of a stream by the given name.
-int? _parseStreamOperand(String operand, StreamStore store) {
+int? _parseStreamOperand(String operand, ChannelStore store) {
   // "New" (2018) format: ${stream_id}-${stream_name} .
   final match = RegExp(r'^(\d+)(?:-.*)?$').firstMatch(operand);
   final newFormatStreamId = (match != null) ? int.parse(match.group(1)!, radix: 10) : null;

lib/model/store.dart

@@ -23,7 +23,7 @@ import 'database.dart';
 import 'message.dart';
 import 'message_list.dart';
 import 'recent_dm_conversations.dart';
-import 'stream.dart';
+import 'channel.dart';
 import 'typing_status.dart';
 import 'unreads.dart';
 
@@ -201,7 +201,7 @@ abstract class GlobalStore extends ChangeNotifier {
 /// This class does not attempt to poll an event queue
 /// to keep the data up to date.  For that behavior, see
 /// [UpdateMachine].
-class PerAccountStore extends ChangeNotifier with StreamStore, MessageStore {
+class PerAccountStore extends ChangeNotifier with ChannelStore, MessageStore {
   /// Construct a store for the user's data, starting from the given snapshot.
   ///
   /// The global store must already have been updated with
@@ -226,7 +226,7 @@ class PerAccountStore extends ChangeNotifier with StreamStore, MessageStore {
     connection ??= globalStore.apiConnectionFromAccount(account);
     assert(connection.zulipFeatureLevel == account.zulipFeatureLevel);
 
-    final streams = StreamStoreImpl(initialSnapshot: initialSnapshot);
+    final streams = ChannelStoreImpl(initialSnapshot: initialSnapshot);
     return PerAccountStore._(
       globalStore: globalStore,
       connection: connection,
@@ -272,7 +272,7 @@ class PerAccountStore extends ChangeNotifier with StreamStore, MessageStore {
     required this.userSettings,
     required this.users,
     required this.typingStatus,
-    required StreamStoreImpl streams,
+    required ChannelStoreImpl streams,
     required MessageStoreImpl messages,
     required this.unreads,
     required this.recentDmConversationsView,
@@ -340,10 +340,10 @@ class PerAccountStore extends ChangeNotifier with StreamStore, MessageStore {
   UserTopicVisibilityPolicy topicVisibilityPolicy(int streamId, String topic) =>
     _streams.topicVisibilityPolicy(streamId, topic);
 
-  final StreamStoreImpl _streams;
+  final ChannelStoreImpl _streams;
 
   @visibleForTesting
-  StreamStoreImpl get debugStreamStore => _streams;
+  ChannelStoreImpl get debugStreamStore => _streams;
 
   ////////////////////////////////
   // Messages, and summaries of messages.

lib/model/unreads.dart

@@ -9,7 +9,7 @@ import '../api/model/events.dart';
 import '../log.dart';
 import 'algorithms.dart';
 import 'narrow.dart';
-import 'stream.dart';
+import 'channel.dart';
 
 /// The view-model for unread messages.
 ///
@@ -39,7 +39,7 @@ class Unreads extends ChangeNotifier {
   factory Unreads({
     required UnreadMessagesSnapshot initial,
     required int selfUserId,
-    required StreamStore streamStore,
+    required ChannelStore streamStore,
   }) {
     final streams = <int, Map<String, QueueList<int>>>{};
     final dms = <DmNarrow, QueueList<int>>{};
@@ -81,7 +81,7 @@ class Unreads extends ChangeNotifier {
     required this.selfUserId,
   });
 
-  final StreamStore streamStore;
+  final ChannelStore streamStore;
 
   // TODO excluded for now; would need to handle nuances around muting etc.
   // int count;
@@ -145,7 +145,7 @@ class Unreads extends ChangeNotifier {
   }
 
   /// The "strict" unread count for this stream,
-  /// using [StreamStore.isTopicVisible].
+  /// using [ChannelStore.isTopicVisible].
   ///
   /// If the stream is muted, this will count only topics that are
   /// actively unmuted.
@@ -166,7 +166,7 @@ class Unreads extends ChangeNotifier {
   }
 
   /// The "broad" unread count for this stream,
-  /// using [StreamStore.isTopicVisibleInStream].
+  /// using [ChannelStore.isTopicVisibleInStream].
   ///
   /// This includes topics that have no visibility policy of their own,
   /// even if the stream itself is muted.

test/model/stream_test.dart renamed to test/model/channel_test.dart

@@ -5,7 +5,7 @@ import 'package:zulip/api/model/events.dart';
 import 'package:zulip/api/model/initial_snapshot.dart';
 import 'package:zulip/api/model/model.dart';
 import 'package:zulip/model/store.dart';
-import 'package:zulip/model/stream.dart';
+import 'package:zulip/model/channel.dart';
 
 import '../example_data.dart' as eg;
 import 'test_store.dart';
@@ -14,7 +14,7 @@ void main() {
   group('Unified stream/sub data', () {
     /// Check that `streams`, `streamsByName`, and `subscriptions` all agree
     /// and point to the same objects where applicable.
-    void checkUnified(StreamStore store) {
+    void checkUnified(ChannelStore store) {
       check(store.streamsByName).length.equals(store.streams.length);
       for (final MapEntry(key: streamId, value: stream)
            in store.streams.entries) {

test/model/store_test.dart

@@ -163,7 +163,7 @@ void main() {
   });
 
   group('PerAccountStore.handleEvent', () {
-    // Mostly this method just dispatches to StreamStore and MessageStore etc.,
+    // Mostly this method just dispatches to ChannelStore and MessageStore etc.,
     // and so most of the tests live in the test files for those
     // (but they call the handleEvent method because it's the entry point).
 

test/model/unreads_test.dart

@@ -16,7 +16,7 @@ void main() {
   // These variables are the common state operated on by each test.
   // Each test case calls [prepare] to initialize them.
   late Unreads model;
-  late PerAccountStore streamStore; // TODO reduce this to StreamStore
+  late PerAccountStore streamStore; // TODO reduce this to ChannelStore
   late int notifiedCount;
 
   void checkNotified({required int count}) {