🍴 Merge #238: Forked Scopes

lib/src/televerse/conversation/conversation.dart

@@ -383,7 +383,7 @@ class Conversation {
     _bot._handlerScopes.add(
       HandlerScope(
         isConversation: true,
-        name: scopeName,
+        options: ScopeOptions(name: scopeName),
         predicate: (ctx) =>
             _isSameChat(ctx.update, chatId) && filter(ctx.update),
         types: UpdateType.values,

lib/src/televerse/models/chat_id.dart

@@ -19,18 +19,19 @@ abstract class ID {
   ///
   /// If the passed [value] is neither an integer nor a string, this method will throw a [TeleverseException].
   static ID create(dynamic value) {
-    switch (value.runtimeType) {
-      case int:
-        return ChatID.create(value);
-      case String:
-        return SupergroupID.create(value);
-      default:
-        throw TeleverseException(
-          "The passed value is not a valid chat id. The value must be an integer or a string.",
-          description: "The passed value is of type ${value.runtimeType}.",
-          type: TeleverseExceptionType.invalidParameter,
-        );
+    if (value is int) {
+      return ChatID.create(value);
     }
+
+    if (value is String) {
+      return ChannelID.create(value);
+    }
+
+    throw TeleverseException(
+      "The passed value is not a valid chat id. The value must be an integer or a string.",
+      description: "The passed value is of type ${value.runtimeType}.",
+      type: TeleverseExceptionType.invalidParameter,
+    );
   }
 
   /// Returns the id as a string or an integer.

lib/src/televerse/models/handler_scope.dart

@@ -2,17 +2,6 @@ part of 'models.dart';
 
 /// A Handler Scope is used to define the scope and related information of a handler method.
 class HandlerScope {
-  /// Optional. The name of the handler. (For debugging purposes)
-  final String? name;
-
-  /// Whether the handler is a special handler.
-  ///
-  /// True if it's a command handler or a RegExp handler.
-  ///
-  /// - If it's a command handler, we set `args` to the parameter of the command.
-  /// - If it's a RegExp handler, we'll set the `MessageContext.matches` to the matches of the RegExp.
-  final bool special;
-
   /// If it's a command handler, we set `args` to the parameter of the command.
   final bool isCommand;
 
@@ -23,6 +12,8 @@ class HandlerScope {
   final RegExp? pattern;
 
   /// Handler
+  ///
+  /// Required unless [isConversation] is `true`.
   final Handler? handler;
 
   /// The update type
@@ -37,9 +28,14 @@ class HandlerScope {
   /// Chat ID of the conversation.
   final ID? chatId;
 
+  /// Scope Options - Additional parameters for the scope.
+  final ScopeOptions? options;
+
+  /// Flag whether already executed
+  bool isExecuted;
+
   /// Creates a new [HandlerScope].
-  const HandlerScope({
-    this.name,
+  HandlerScope({
     this.handler,
     required this.predicate,
     required this.types,
@@ -48,6 +44,18 @@ class HandlerScope {
     this.pattern,
     this.isConversation = false,
     this.chatId,
-  })  : special = isCommand || isRegExp,
-        assert(handler != null || isConversation);
+    this.options,
+    this.isExecuted = false,
+  }) : assert(handler != null || isConversation);
+
+  /// Whether the scope is forked or not.
+  bool get forked => options?.forked ?? false;
+
+  /// Name of the scope
+  String? get name => options?.name;
+
+  /// Sets executiion status to true.
+  void executed() {
+    isExecuted = true;
+  }
 }

lib/src/televerse/models/scope_options.dart

@@ -0,0 +1,33 @@
+part of '../../../televerse.dart';
+
+/// Represents additional options that can be passed to create Handler Scope
+class ScopeOptions {
+  /// Name of the Handler Scope.
+  ///
+  /// This can be used to remove a Handler later on your code.
+  final String? name;
+
+  /// Whether the scope is forked.
+  ///
+  /// By default fork is set to `false` that is once a matching scope is found
+  /// the processor only executes that particular scope and skips all the rest.
+  ///
+  /// When fork is set to `true` the successive Handler Scope is also considered
+  /// and executed if it satisfies the predicate.
+  final bool forked;
+
+  /// Constructs a `ScopeOption`.
+  ///
+  /// - [name] - Name of the Handler Scope. This can be used to remove the scope later.
+  ///
+  /// - [forked] - A flag used to determine whether the succeeding handler should also be executed
+  const ScopeOptions({
+    this.forked = false,
+    this.name,
+  });
+
+  /// Constructs a `ScopeOption` that is forked. This scope will allow the processing of subsequent handler scope as well.
+  ///
+  /// - [name] - Name of the Handler Scope. This can be used to remove the scope later.
+  const ScopeOptions.forked({this.name}) : forked = true;
+}

lib/src/utils/utils.dart

@@ -110,28 +110,13 @@ enum _GetMeStatus {
 class _PendingCall {
   final Function fn;
   final List<dynamic> params;
+  final Map<Symbol, dynamic> namedParams;
 
   const _PendingCall({
     required this.fn,
     required this.params,
+    this.namedParams = const <Symbol, dynamic>{},
   });
-
-  void call() {
-    switch (params.length) {
-      case 0:
-        fn.call();
-        break;
-      case 1:
-        fn.call(params[0]);
-        break;
-      case 2:
-        fn.call(params[0], params[1]);
-        break;
-      case 3:
-        fn.call(params[0], params[1], params[2]);
-        break;
-    }
-  }
 }
 
 /// Extension on `Chat` to create ID of the chat

lib/televerse.dart

@@ -24,6 +24,7 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:io' as io;
 import 'dart:math';
+import 'dart:mirrors';
 import 'package:dio/dio.dart';
 import 'package:televerse/telegram.dart';
 import 'package:televerse/televerse.dart';
@@ -60,6 +61,7 @@ part 'src/televerse/builders/message_content_generator.dart';
 
 /// Extras
 part 'src/televerse/extras/tg_exceptions.dart';
+part 'src/televerse/models/scope_options.dart';
 
 /// The main class of the library.
 ///

pubspec.yaml

@@ -10,7 +10,7 @@ topics:
   - bot-framework
 
 environment:
-  sdk: ">=2.17.7 <4.0.0"
+  sdk: ">=3.0.0 <4.0.0"
 
 dependencies:
   dio: ^5.4.0