refactor!: hide debouncing and throttling fields from public API

refactor!: rename baseService to _languageCheckService
move debounce and throttling decorators to wrappers folder
rename LangToolService to LanguageToolService

Author: andrew-bekhiet-solid

lib/languagetool_textfield.dart

@@ -12,9 +12,9 @@ export 'src/domain/highlight_style.dart';
 export 'src/domain/language_check_service.dart';
 export 'src/domain/mistake.dart';
 export 'src/domain/writing_mistake.dart';
-export 'src/implementations/debounce_lang_tool_service.dart';
-export 'src/implementations/lang_tool_service.dart';
-export 'src/implementations/throttling_lang_tool_service.dart';
+export 'src/language_check_services/language_tool_service.dart';
 export 'src/presentation/language_tool_text_field.dart';
 export 'src/utils/mistake_popup.dart';
 export 'src/utils/popup_overlay_renderer.dart';
+export 'src/wrappers/debounce_language_tool_service.dart';
+export 'src/wrappers/throttling_language_tool_service.dart';

lib/src/core/controllers/language_tool_controller.dart

@@ -3,18 +3,10 @@ import 'dart:math';
 import 'package:collection/collection.dart';
 import 'package:flutter/gestures.dart';
 import 'package:flutter/material.dart';
-import 'package:languagetool_textfield/src/client/language_tool_client.dart';
-import 'package:languagetool_textfield/src/core/enums/delay_type.dart';
+import 'package:languagetool_textfield/languagetool_textfield.dart';
 import 'package:languagetool_textfield/src/core/enums/mistake_type.dart';
-import 'package:languagetool_textfield/src/domain/highlight_style.dart';
-import 'package:languagetool_textfield/src/domain/language_check_service.dart';
-import 'package:languagetool_textfield/src/domain/mistake.dart';
-import 'package:languagetool_textfield/src/implementations/debounce_lang_tool_service.dart';
-import 'package:languagetool_textfield/src/implementations/lang_tool_service.dart';
-import 'package:languagetool_textfield/src/implementations/throttling_lang_tool_service.dart';
 import 'package:languagetool_textfield/src/utils/closed_range.dart';
 import 'package:languagetool_textfield/src/utils/keep_latest_response_service.dart';
-import 'package:languagetool_textfield/src/utils/mistake_popup.dart';
 
 /// A TextEditingController with overrides buildTextSpan for building
 /// marked TextSpans with tap recognizer
@@ -127,15 +119,15 @@ class LanguageToolController extends TextEditingController {
     required Duration delay,
     required LanguageToolClient languageToolClient,
   }) {
-    final languageToolService = LangToolService(languageToolClient);
+    final languageToolService = LanguageToolService(languageToolClient);
 
     if (delay == Duration.zero) return languageToolService;
 
     switch (delayType) {
       case DelayType.debouncing:
-        return DebounceLangToolService(languageToolService, delay);
+        return DebounceLanguageToolService(languageToolService, delay);
       case DelayType.throttling:
-        return ThrottlingLangToolService(languageToolService, delay);
+        return ThrottlingLanguageToolService(languageToolService, delay);
     }
   }
 

lib/src/implementations/debounce_lang_tool_service.dart

@@ -5,7 +5,7 @@ import 'package:languagetool_textfield/src/domain/writing_mistake.dart';
 import 'package:languagetool_textfield/src/utils/result.dart';
 
 /// An implementation of language check service with language tool service.
-class LangToolService extends LanguageCheckService {
+class LanguageToolService extends LanguageCheckService {
   /// An instance of this class that is used to interact with LanguageTool API.
   final LanguageToolClient languageTool;
 
@@ -17,8 +17,8 @@ class LangToolService extends LanguageCheckService {
     languageTool.language = language;
   }
 
-  /// Creates a new instance of the [LangToolService].
-  LangToolService(this.languageTool);
+  /// Creates a new instance of the [LanguageToolService].
+  LanguageToolService(this.languageTool);
 
   @override
   Future<Result<List<Mistake>>> findMistakes(String text) async {

…c/implementations/lang_tool_service.dart …heck_services/language_tool_service.dartlib/src/implementations/lang_tool_service.dart renamed to lib/src/language_check_services/language_tool_service.dart lib/src/implementations/lang_tool_service.dart renamed to lib/src/language_check_services/language_tool_service.dart

@@ -0,0 +1,40 @@
+import 'package:languagetool_textfield/src/domain/language_check_service.dart';
+import 'package:languagetool_textfield/src/domain/mistake.dart';
+import 'package:languagetool_textfield/src/utils/result.dart';
+import 'package:throttling/throttling.dart';
+
+/// A language check service with debouncing.
+class DebounceLanguageToolService extends LanguageCheckService {
+  /// A base language check service.
+  final LanguageCheckService _languageCheckService;
+
+  /// A debouncing used to debounce the API calls.
+  final Debouncing<Future<Result<List<Mistake>>?>> _debouncing;
+
+  @override
+  String get language => _languageCheckService.language;
+
+  @override
+  set language(String language) {
+    _languageCheckService.language = language;
+  }
+
+  /// Creates a new instance of the [DebounceLanguageToolService] class.
+  DebounceLanguageToolService(
+    this._languageCheckService,
+    Duration debouncingDuration,
+  ) : _debouncing = Debouncing(duration: debouncingDuration);
+
+  @override
+  Future<Result<List<Mistake>>?> findMistakes(String text) async {
+    return await _debouncing
+        .debounce(() => _languageCheckService.findMistakes(text));
+  }
+
+  // ignore: proper_super_calls
+  @override
+  Future<void> dispose() async {
+    _debouncing.close();
+    await _languageCheckService.dispose();
+  }
+}

lib/src/wrappers/debounce_language_tool_service.dart

@@ -4,36 +4,38 @@ import 'package:languagetool_textfield/src/utils/result.dart';
 import 'package:throttling/throttling.dart';
 
 /// A language check service with debouncing.
-class ThrottlingLangToolService extends LanguageCheckService {
+class ThrottlingLanguageToolService extends LanguageCheckService {
   /// A base language check service that is used to interact
   /// with the language check API.
-  final LanguageCheckService baseService;
+  final LanguageCheckService _languageCheckService;
 
   /// A throttling used to throttle the API calls.
-  final Throttling<Future<Result<List<Mistake>>?>> throttling;
+  final Throttling<Future<Result<List<Mistake>>?>> _throttling;
 
   @override
-  String get language => baseService.language;
+  String get language => _languageCheckService.language;
 
   @override
   set language(String language) {
-    baseService.language = language;
+    _languageCheckService.language = language;
   }
 
-  /// Creates a new instance of the [ThrottlingLangToolService] class.
-  ThrottlingLangToolService(
-    this.baseService,
+  /// Creates a new instance of the [ThrottlingLanguageToolService] class.
+  ThrottlingLanguageToolService(
+    this._languageCheckService,
     Duration throttlingDuration,
-  ) : throttling = Throttling(duration: throttlingDuration);
+  ) : _throttling = Throttling(duration: throttlingDuration);
 
   @override
-  Future<Result<List<Mistake>>?> findMistakes(String text) async =>
-      throttling.throttle(() => baseService.findMistakes(text));
+  Future<Result<List<Mistake>>?> findMistakes(String text) async {
+    return await _throttling
+        .throttle(() => _languageCheckService.findMistakes(text));
+  }
 
   // ignore: proper_super_calls
   @override
   Future<void> dispose() async {
-    throttling.close();
-    await baseService.dispose();
+    _throttling.close();
+    await _languageCheckService.dispose();
   }
 }