Merge pull request #64 from solid-software/task/hidden-deps-api-integration

Task/Hide dependencies & refactor

Author: solid-danylokhvan

README.md

@@ -51,37 +51,40 @@ import 'package:language_tool_textfield/language_tool_textfield.dart';
 To start using the plugin, copy this code or follow the example project in 'languagetool_textfield/example'
 
 ```dart
-// Create a base API client
-final _languageTool = LanguageToolClient(
+// Create a text controller for the Widget
+final _controller = LanguageToolController();
+
+// Use the text field widget in your layout
+child: LanguageToolTextField(
+  controller: _controller,
+
   // A language code like en-US, de-DE, fr, or auto to guess
   // the language automatically.
   // language = 'auto' by default.
   language: 'en-US',
 );
 
-// Add input debouncing
-final _debouncedLangService = DebounceLangToolService(
-  LangToolService(_languageTool),
-  const Duration(milliseconds: 500),
-);
+// Don't forget to dispose the controller
+_controller.dispose();
+```
 
-// Create a text controller for the Widget
-final _controller = ColoredTextEditingController(
-    languageCheckService: _debouncedLangService
-);
+## Using Debounce and Throttle in LanguageTool TextField
 
-// Use the text field widget in your layout
-child: LanguageToolTextField(
-  style: const TextStyle(),
-  decoration: const InputDecoration(),
-  coloredController: _controller,
-  mistakePopup: MistakePopup(popupRenderer: PopupOverlayRenderer()),
-);
+To incorporate the debounce or throttle functionality into the `LanguageTool TextField`, follow these steps:
 
-// Don't forget to dispose the controller
-_controller.dispose();
+Create a `LanguageToolController` and provide the desired debounce/throttle delay duration and delay type:
+   ```dart
+   final _controller = LanguageToolController(
+     // If the delay value is [Duration.zero], no delay is applied.
+     delay: Duration(milliseconds: 500), // Set the debounce/throttle delay duration here
+     delayType: DelayType.debouncing, // Choose either DelayType.debouncing or DelayType.throttling
+   );
 ```
 
+  `DelayType.debouncing` - Calls a function when a user hasn't carried out the event in a specific amount of time.
+
+  `DelayType.throttling` - Calls a function at intervals of a specified amount of time while the user is carrying out the event.
+
 ## Legal
 
 This is an unofficial plugin. We are not affiliated with LanguageTool.

example/lib/main.dart

@@ -20,24 +20,8 @@ class App extends StatefulWidget {
 }
 
 class _AppState extends State<App> {
-  /// Initialize LanguageToolClient
-  static final LanguageToolClient _languageTool = LanguageToolClient(
-    // A language code like en-US, de-DE, fr, or auto to guess
-    // the language automatically.
-    // language = 'auto' by default.
-    language: 'en-US',
-  );
-
-  /// Initialize DebounceLangToolService
-  static final DebounceLangToolService _debouncedLangService =
-      DebounceLangToolService(
-    LangToolService(_languageTool),
-    const Duration(milliseconds: 500),
-  );
-
-  /// Initialize ColoredTextEditingController
-  final ColoredTextEditingController _controller =
-      ColoredTextEditingController(languageCheckService: _debouncedLangService);
+  /// Initialize LanguageToolController
+  final LanguageToolController _controller = LanguageToolController();
 
   static const List<MainAxisAlignment> alignments = [
     MainAxisAlignment.center,
@@ -54,10 +38,8 @@ class _AppState extends State<App> {
           mainAxisAlignment: alignments[currentAlignmentIndex],
           children: [
             LanguageToolTextField(
-              style: const TextStyle(),
-              decoration: const InputDecoration(),
-              coloredController: _controller,
-              mistakePopup: MistakePopup(popupRenderer: PopupOverlayRenderer()),
+              controller: _controller,
+              language: 'en-US',
             ),
             DropdownMenu(
               hintText: "Select alignment...",
@@ -69,7 +51,7 @@ class _AppState extends State<App> {
                 DropdownMenuEntry(value: 1, label: "Top alignment"),
                 DropdownMenuEntry(value: 2, label: "Bottom alignment"),
               ],
-            )
+            ),
           ],
         ),
       ),

lib/client/language_tool_client.dart

@@ -8,10 +8,6 @@ import 'package:languagetool_textfield/domain/writing_mistake.dart';
 ///
 /// Read more @ https://languagetool.org/http-api/swagger-ui/#/
 class LanguageToolClient {
-  /// A language code like en-US, de-DE, fr,
-  /// or auto to guess the language automatically
-  final String language;
-
   /// Url of LanguageTool API.
   static const _url = 'api.languagetoolplus.com';
 
@@ -21,6 +17,10 @@ class LanguageToolClient {
     'Accept': 'application/json',
   };
 
+  /// A language code like en-US, de-DE, fr,
+  /// or auto to guess the language automatically
+  String language;
+
   /// Constructor for [LanguageToolClient].
   LanguageToolClient({this.language = 'auto'});
 

…ers/colored_text_editing_controller.dart …ontrollers/language_tool_controller.dartlib/core/controllers/colored_text_editing_controller.dart renamed to lib/core/controllers/language_tool_controller.dart lib/core/controllers/colored_text_editing_controller.dart renamed to lib/core/controllers/language_tool_controller.dart

@@ -3,44 +3,76 @@ import 'dart:math';
 import 'package:collection/collection.dart';
 import 'package:flutter/gestures.dart';
 import 'package:flutter/material.dart';
+import 'package:languagetool_textfield/client/language_tool_client.dart';
+import 'package:languagetool_textfield/core/enums/delay_type.dart';
 import 'package:languagetool_textfield/core/enums/mistake_type.dart';
 import 'package:languagetool_textfield/domain/highlight_style.dart';
 import 'package:languagetool_textfield/domain/language_check_service.dart';
 import 'package:languagetool_textfield/domain/mistake.dart';
+import 'package:languagetool_textfield/implementations/debounce_lang_tool_service.dart';
+import 'package:languagetool_textfield/implementations/lang_tool_service.dart';
+import 'package:languagetool_textfield/implementations/throttling_lang_tool_service.dart';
 import 'package:languagetool_textfield/utils/closed_range.dart';
 import 'package:languagetool_textfield/utils/keep_latest_response_service.dart';
 import 'package:languagetool_textfield/utils/mistake_popup.dart';
 
 /// A TextEditingController with overrides buildTextSpan for building
 /// marked TextSpans with tap recognizer
-class ColoredTextEditingController extends TextEditingController {
+class LanguageToolController extends TextEditingController {
   /// Color scheme to highlight mistakes
   final HighlightStyle highlightStyle;
 
-  /// Language tool API index
-  final LanguageCheckService languageCheckService;
+  /// Represents the type of delay for language checking.
+  ///
+  /// [DelayType.debouncing] - Calls a function when a user hasn't carried out
+  /// the event in a specific amount of time.
+  ///
+  /// [DelayType.throttling] - Calls a function at intervals of a specified
+  /// amount of time while the user is carrying out the event.
+  final DelayType delayType;
 
-  /// Create an instance of [KeepLatestResponseService]
-  ///  to handle asynchronous operations
-  final latestResponseService = KeepLatestResponseService();
+  /// Represents the duration of the delay for language checking.
+  ///
+  /// If the delay is [Duration.zero], no delaying is applied.
+  final Duration delay;
 
-  /// List which contains Mistake objects spans are built from
-  List<Mistake> _mistakes = [];
+  /// Create an instance of [LanguageToolClient] instance
+  final _languageToolClient = LanguageToolClient();
+
+  /// Create an instance of [KeepLatestResponseService]
+  /// to handle asynchronous operations
+  final _latestResponseService = KeepLatestResponseService();
 
   /// List of that is used to dispose recognizers after mistakes rebuilt
   final List<TapGestureRecognizer> _recognizers = [];
 
-  /// Reference to the popup widget
-  MistakePopup? popupWidget;
+  /// Language tool API index
+  LanguageCheckService? _languageCheckService;
 
   /// Reference to the focus of the LanguageTool TextField
   FocusNode? focusNode;
 
+  /// List which contains Mistake objects spans are built from
+  List<Mistake> _mistakes = [];
+
+  /// Reference to the popup widget
+  MistakePopup? popupWidget;
+
   /// Represents the scroll offset value of the LanguageTool TextField.
   double? scrollOffset;
 
   Object? _fetchError;
 
+  /// The language used for spellchecking in the text field.
+  ///
+  /// A language code like en-US, de-DE, fr, or auto to guess
+  /// the language automatically.
+  String get language => _languageToolClient.language;
+
+  set language(String language) {
+    _languageToolClient.language = language;
+  }
+
   /// An error that may have occurred during the API fetch.
   Object? get fetchError => _fetchError;
 
@@ -51,10 +83,26 @@ class ColoredTextEditingController extends TextEditingController {
   }
 
   /// Controller constructor
-  ColoredTextEditingController({
-    required this.languageCheckService,
+  LanguageToolController({
     this.highlightStyle = const HighlightStyle(),
-  });
+    this.delay = Duration.zero,
+    this.delayType = DelayType.debouncing,
+  }) {
+    _languageCheckService = _getLanguageCheckService();
+  }
+
+  LanguageCheckService _getLanguageCheckService() {
+    final languageToolService = LangToolService(_languageToolClient);
+
+    if (delay == Duration.zero) return languageToolService;
+
+    switch (delayType) {
+      case DelayType.debouncing:
+        return DebounceLangToolService(languageToolService, delay);
+      case DelayType.throttling:
+        return ThrottlingLangToolService(languageToolService, delay);
+    }
+  }
 
   /// Close the popup widget
   void _closePopup() => popupWidget?.popupRenderer.dismiss();
@@ -78,7 +126,7 @@ class ColoredTextEditingController extends TextEditingController {
 
   @override
   void dispose() {
-    languageCheckService.dispose();
+    _languageCheckService?.dispose();
     super.dispose();
   }
 
@@ -114,8 +162,8 @@ class ColoredTextEditingController extends TextEditingController {
     }
     _recognizers.clear();
 
-    final mistakesWrapper = await latestResponseService.processLatestOperation(
-      () => languageCheckService.findMistakes(newText),
+    final mistakesWrapper = await _latestResponseService.processLatestOperation(
+      () => _languageCheckService?.findMistakes(newText) ?? Future(() => null),
     );
     final mistakes = mistakesWrapper?.result();
     _fetchError = mistakesWrapper?.error;

lib/core/enums/delay_type.dart

@@ -0,0 +1,8 @@
+///Enumerate delay types
+enum DelayType {
+  /// A debouncing used to debounce the API calls.
+  debouncing,
+
+  /// A throttling used to throttle the API calls.
+  throttling,
+}

lib/domain/language_check_service.dart

@@ -7,7 +7,7 @@ abstract class LanguageCheckService {
   const LanguageCheckService();
 
   /// Returns found mistakes in the given [text].
-  Future<Result<List<Mistake>>> findMistakes(String text);
+  Future<Result<List<Mistake>>?> findMistakes(String text);
 
   /// Disposes resources of this [LanguageCheckService].
   Future<void> dispose() async {

lib/domain/typedefs.dart

@@ -1,13 +1,13 @@
 import 'package:flutter/widgets.dart';
-import 'package:languagetool_textfield/core/controllers/colored_text_editing_controller.dart';
+import 'package:languagetool_textfield/core/controllers/language_tool_controller.dart';
 import 'package:languagetool_textfield/domain/mistake.dart';
 import 'package:languagetool_textfield/utils/popup_overlay_renderer.dart';
 
 /// Callback used to build popup body
 typedef MistakeBuilderCallback = Widget Function({
   required PopupOverlayRenderer popupRenderer,
   required Mistake mistake,
-  required ColoredTextEditingController controller,
+  required LanguageToolController controller,
   required Offset mistakePosition,
 });
 
@@ -16,5 +16,5 @@ typedef ShowPopupCallback = void Function(
   BuildContext context,
   Mistake mistake,
   Offset mistakePosition,
-  ColoredTextEditingController controller,
+  LanguageToolController controller,
 );

lib/implementations/throttling_lang_tool_service.dart

@@ -19,9 +19,11 @@ class ThrottlingLangToolService extends LanguageCheckService {
   ) : throttling = Throttling(duration: throttlingDuration);
 
   @override
-  Future<Result<List<Mistake>>> findMistakes(String text) {
+  Future<Result<List<Mistake>>?> findMistakes(String text) async {
     final future = throttling.throttle(() => baseService.findMistakes(text))
-        as Future<Result<List<Mistake>>?>;
+        as Future<Result<List<Mistake>>?>?;
+
+    if (future == null) return null;
 
     return future.then((res) => res ?? Result.success(<Mistake>[].toList()));
   }

lib/languagetool_textfield.dart

@@ -1,7 +1,8 @@
 library languagetool_textfield;
 
 export 'client/language_tool_client.dart';
-export 'core/controllers/colored_text_editing_controller.dart';
+export 'core/controllers/language_tool_controller.dart';
+export 'core/enums/delay_type.dart';
 export 'core/model/category.dart';
 export 'core/model/language_tool_raw.dart';
 export 'core/model/match.dart';