Merge pull request #180 from losiu97/fix/add-match-none

BUGFIX add MATCH_NONE to tag matching options

lib/core/translation/matching_algorithm_localization_mapper.dart

@@ -19,6 +19,8 @@ String translateMatchingAlgorithmDescription(
       return S.of(context)!.documentContainsAWordSimilarToThisWord;
     case MatchingAlgorithm.auto:
       return S.of(context)!.learnMatchingAutomatically;
+    case MatchingAlgorithm.none:
+      return S.of(context)!.disableMatching;
   }
 }
 
@@ -39,5 +41,7 @@ String translateMatchingAlgorithmName(
       return S.of(context)!.fuzzy;
     case MatchingAlgorithm.auto:
       return S.of(context)!.auto;
+    case MatchingAlgorithm.none:
+      return S.of(context)!.none;
   }
 }

lib/features/edit_label/view/label_form.dart

@@ -1,10 +1,12 @@
 import 'package:flutter/material.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
 import 'package:paperless_api/paperless_api.dart';
 import 'package:paperless_mobile/core/translation/matching_algorithm_localization_mapper.dart';
 import 'package:paperless_mobile/core/type/types.dart';
 import 'package:paperless_mobile/extensions/flutter_extensions.dart';
+import 'package:paperless_mobile/features/home/view/model/api_version.dart';
 import 'package:paperless_mobile/generated/l10n/app_localizations.dart';
 
 import 'package:paperless_mobile/helpers/message_helpers.dart';
@@ -57,13 +59,17 @@ class _LabelFormState<T extends Label> extends State<LabelForm<T>> {
   @override
   void initState() {
     super.initState();
-    _enableMatchFormField = (widget.initialValue?.matchingAlgorithm ??
+    var matchingAlgorithm = (widget.initialValue?.matchingAlgorithm ??
-            MatchingAlgorithm.defaultValue) !=
+        MatchingAlgorithm.defaultValue);
-        MatchingAlgorithm.auto;
+    _enableMatchFormField = matchingAlgorithm != MatchingAlgorithm.auto &&
+        matchingAlgorithm != MatchingAlgorithm.none;
   }
 
   @override
   Widget build(BuildContext context) {
+    List<MatchingAlgorithm> selectableMatchingAlgorithmValues =
+        getSelectableMatchingAlgorithmValues(
+            context.watch<ApiVersion>().hasMultiUserSupport);
     return Scaffold(
       resizeToAvoidBottomInset: false,
       floatingActionButton: FloatingActionButton.extended(
@@ -103,10 +109,11 @@ class _LabelFormState<T extends Label> extends State<LabelForm<T>> {
               onChanged: (val) {
                 setState(() {
                   _errors = {};
-                  _enableMatchFormField = val != MatchingAlgorithm.auto.value;
+                  _enableMatchFormField = val != MatchingAlgorithm.auto.value &&
+                      val != MatchingAlgorithm.none.value;
                 });
               },
-              items: MatchingAlgorithm.values
+              items: selectableMatchingAlgorithmValues
                   .map(
                     (algo) => DropdownMenuItem<int?>(
                       child: Text(
@@ -139,6 +146,18 @@ class _LabelFormState<T extends Label> extends State<LabelForm<T>> {
     );
   }
 
+  List<MatchingAlgorithm> getSelectableMatchingAlgorithmValues(
+      bool hasMultiUserSupport) {
+    var selectableMatchingAlgorithmValues = MatchingAlgorithm.values;
+    if (!hasMultiUserSupport) {
+      selectableMatchingAlgorithmValues = selectableMatchingAlgorithmValues
+          .where((matchingAlgorithm) =>
+              matchingAlgorithm != MatchingAlgorithm.none)
+          .toList();
+    }
+    return selectableMatchingAlgorithmValues;
+  }
+
   void _onSubmit() async {
     if (_formKey.currentState?.saveAndValidate() ?? false) {
       try {
@@ -146,11 +165,6 @@ class _LabelFormState<T extends Label> extends State<LabelForm<T>> {
           ...widget.initialValue?.toJson() ?? {},
           ..._formKey.currentState!.value
         };
-        if (mergedJson[Label.matchingAlgorithmKey] ==
-            MatchingAlgorithm.auto.value) {
-          // If auto is selected, the match will be removed.
-          mergedJson[Label.matchKey] = '';
-        }
         final parsed = widget.fromJsonT(mergedJson);
         final createdLabel = await widget.submitButtonConfig.onSubmit(parsed);
         Navigator.pop(context, createdLabel);

lib/features/labels/view/pages/labels_page.dart

@@ -16,9 +16,11 @@ import 'package:paperless_mobile/features/edit_label/view/impl/edit_corresponden
 import 'package:paperless_mobile/features/edit_label/view/impl/edit_document_type_page.dart';
 import 'package:paperless_mobile/features/edit_label/view/impl/edit_storage_path_page.dart';
 import 'package:paperless_mobile/features/edit_label/view/impl/edit_tag_page.dart';
+import 'package:paperless_mobile/features/home/view/model/api_version.dart';
 import 'package:paperless_mobile/features/labels/cubit/label_cubit.dart';
 import 'package:paperless_mobile/features/labels/view/widgets/label_tab_view.dart';
 import 'package:paperless_mobile/generated/l10n/app_localizations.dart';
+import 'package:provider/provider.dart';
 
 class LabelsPage extends StatefulWidget {
   const LabelsPage({Key? key}) : super(key: key);
@@ -267,98 +269,70 @@ class _LabelsPageState extends State<LabelsPage> with SingleTickerProviderStateM
   void _openEditCorrespondentPage(Correspondent correspondent) {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(EditCorrespondentPage(correspondent: correspondent)),
-        builder: (_) => RepositoryProvider.value(
-          value: context.read<LabelRepository>(),
-          child: EditCorrespondentPage(correspondent: correspondent),
-        ),
-      ),
     );
   }
 
   void _openEditDocumentTypePage(DocumentType docType) {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(EditDocumentTypePage(documentType: docType)),
-        builder: (_) => RepositoryProvider.value(
-          value: context.read<LabelRepository>(),
-          child: EditDocumentTypePage(documentType: docType),
-        ),
-      ),
     );
   }
 
   void _openEditTagPage(Tag tag) {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(EditTagPage(tag: tag)),
-        builder: (_) => RepositoryProvider.value(
-          value: context.read<LabelRepository>(),
-          child: EditTagPage(tag: tag),
-        ),
-      ),
     );
   }
 
   void _openEditStoragePathPage(StoragePath path) {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(EditStoragePathPage(
-        builder: (_) => RepositoryProvider.value(
+        storagePath: path,
-          value: context.read<LabelRepository>(),
+      )),
-          child: EditStoragePathPage(
-            storagePath: path,
-          ),
-        ),
-      ),
     );
   }
 
   void _openAddCorrespondentPage() {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(const AddCorrespondentPage()),
-        builder: (_) => RepositoryProvider.value(
-          value: context.read<LabelRepository>(),
-          child: const AddCorrespondentPage(),
-        ),
-      ),
     );
   }
 
   void _openAddDocumentTypePage() {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(const AddDocumentTypePage()),
-        builder: (_) => RepositoryProvider.value(
-          value: context.read<LabelRepository>(),
-          child: const AddDocumentTypePage(),
-        ),
-      ),
     );
   }
 
   void _openAddTagPage() {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(const AddTagPage()),
-        builder: (_) => RepositoryProvider.value(
-          value: context.read<LabelRepository>(),
-          child: const AddTagPage(),
-        ),
-      ),
     );
   }
 
   void _openAddStoragePathPage() {
     Navigator.push(
       context,
-      MaterialPageRoute(
+      _buildLabelPageRoute(const AddStoragePathPage()),
-        builder: (_) => RepositoryProvider.value(
+    );
-          value: context.read<LabelRepository>(),
+  }
-          child: const AddStoragePathPage(),
+
-        ),
+  MaterialPageRoute<dynamic> _buildLabelPageRoute(Widget page) {
-      ),
+    return MaterialPageRoute(
+        builder: (_) => MultiProvider(
+            providers: [
+              Provider.value(value: context.read<LabelRepository>()),
+              Provider.value(value: context.read<ApiVersion>())
+            ],
+            child: page
+        )
     );
   }
 }

packages/mock_server/lib/mock_server.dart

@@ -104,7 +104,7 @@ class LocalMockApiServer {
         "name": body?['name'],
         "color": body?['color'],
         "text_color": "#000000",
-        "match": "",
+        "match": body?['match'],
         "matching_algorithm": body?['matching_algorithm'],
         "is_insensitive": body?['is_insensitive'],
         "is_inbox_tag": false,
@@ -129,7 +129,7 @@ class LocalMockApiServer {
         "name": body?['name'],
         "color": body?['color'],
         "text_color": "#000000",
-        "match": "",
+        "match": body?['match'],
         "matching_algorithm": body?['matching_algorithm'],
         "is_insensitive": body?['is_insensitive'],
         "is_inbox_tag": false,

packages/mock_server/pubspec.yaml

@@ -13,7 +13,7 @@ dependencies:
   logging: ^1.1.1
   flutter:
     sdk: flutter
-  http: ^1.0.0
+  http: ^0.13.4
 
 dev_dependencies:
   flutter_test:

packages/paperless_api/lib/src/models/labels/label_model.dart

@@ -15,7 +15,7 @@ abstract class Label extends Equatable implements Comparable {
   final int? id;
   final String name;
   final String? slug;
-  final String? match;
+  final String match;
   final MatchingAlgorithm matchingAlgorithm;
   final bool? isInsensitive;
   final int? documentCount;
@@ -26,7 +26,7 @@ abstract class Label extends Equatable implements Comparable {
     this.id,
     required this.name,
     this.matchingAlgorithm = MatchingAlgorithm.defaultValue,
-    this.match,
+    this.match = "",
     this.isInsensitive = true,
     this.documentCount,
     this.slug,

packages/paperless_api/lib/src/models/labels/matching_algorithm.dart

@@ -2,6 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 @JsonEnum(valueField: 'value')
 enum MatchingAlgorithm {
+  none(0, "None: Disable matching"),
   anyWord(1, "Any: Match one of the following words"),
   allWords(2, "All: Match all of the following words"),
   exactMatch(3, "Exact: Match the following string"),