feat: openfoodfacts#233 - explicitly deprecated parameters lc and cc

Impacted files: * `api_getProduct_test.dart`: not using deprecated parameter `lc` anymore * `ProductListQueryConfiguration.dart`: deprecated parameters `lc` and `cc` * `ProductQueryConfigurations.dart`: deprecated parameters `lc` and `cc` * `ProductSearchQueryConfiguration.dart`: deprecated parameters `lc` and `cc` * `TaxonomyAdditive.dart`: deprecated parameter cc` * `TaxonomyAllergen.dart`: deprecated parameter cc` * `TaxonomyCategory.dart`: deprecated parameter cc` * `TaxonomyCountry.dart`: deprecated parameter cc` * `TaxonomyIngredient.dart`: deprecated parameter cc` * `TaxonomyLabel.dart`: deprecated parameter cc` * `TaxonomyLanguage.dart`: deprecated parameter cc`
monsieurtanuki · Nov 15, 2021 · 6714df9 · 6714df9
1 parent e3bbb90
commit 6714df9
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 18 deletions.
diff --git a/lib/model/TaxonomyAdditive.dart b/lib/model/TaxonomyAdditive.dart
@@ -336,7 +336,7 @@ class TaxonomyAdditiveQueryConfiguration extends TaxonomyQueryConfiguration<
   TaxonomyAdditiveQueryConfiguration({
     required List<String> tags,
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyAdditiveField> fields = const [],
     List<Parameter> additionalParameters = const [],

diff --git a/lib/model/TaxonomyAllergen.dart b/lib/model/TaxonomyAllergen.dart
@@ -80,7 +80,7 @@ class TaxonomyAllergenQueryConfiguration extends TaxonomyQueryConfiguration<
   TaxonomyAllergenQueryConfiguration({
     required List<String> tags,
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyAllergenField> fields = const [],
     List<Parameter> additionalParameters = const [],

diff --git a/lib/model/TaxonomyCategory.dart b/lib/model/TaxonomyCategory.dart
@@ -335,7 +335,7 @@ class TaxonomyCategoryQueryConfiguration extends TaxonomyQueryConfiguration<
   TaxonomyCategoryQueryConfiguration({
     required List<String> tags,
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     bool includeChildren = false,
     List<TaxonomyCategoryField> fields = const [],
@@ -353,7 +353,7 @@ class TaxonomyCategoryQueryConfiguration extends TaxonomyQueryConfiguration<
 
   TaxonomyCategoryQueryConfiguration.roots({
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     bool includeChildren = false,
     List<TaxonomyCategoryField> fields = const [],

diff --git a/lib/model/TaxonomyCountry.dart b/lib/model/TaxonomyCountry.dart
@@ -104,7 +104,7 @@ class TaxonomyCountryQueryConfiguration
   TaxonomyCountryQueryConfiguration({
     required List<String> tags,
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyCountryField> fields = const [],
     List<Parameter> additionalParameters = const [],

diff --git a/lib/model/TaxonomyIngredient.dart b/lib/model/TaxonomyIngredient.dart
@@ -472,7 +472,7 @@ class TaxonomyIngredientQueryConfiguration extends TaxonomyQueryConfiguration<
   TaxonomyIngredientQueryConfiguration({
     required List<String> tags,
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyIngredientField> fields = const [],
     List<Parameter> additionalParameters = const [],
@@ -490,7 +490,7 @@ class TaxonomyIngredientQueryConfiguration extends TaxonomyQueryConfiguration<
 
   TaxonomyIngredientQueryConfiguration.roots({
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyIngredientField> fields = const [],
     List<Parameter> additionalParameters = const [],

diff --git a/lib/model/TaxonomyLabel.dart b/lib/model/TaxonomyLabel.dart
@@ -280,7 +280,7 @@ class TaxonomyLabelQueryConfiguration
   TaxonomyLabelQueryConfiguration({
     required List<String> tags,
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyLabelField> fields = const [],
     List<Parameter> additionalParameters = const [],
@@ -297,7 +297,7 @@ class TaxonomyLabelQueryConfiguration
 
   TaxonomyLabelQueryConfiguration.roots({
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyLabelField> fields = const [],
     List<Parameter> additionalParameters = const [],

diff --git a/lib/model/TaxonomyLanguage.dart b/lib/model/TaxonomyLanguage.dart
@@ -95,7 +95,7 @@ class TaxonomyLanguageQueryConfiguration extends TaxonomyQueryConfiguration<
   TaxonomyLanguageQueryConfiguration({
     required List<String> tags,
     List<OpenFoodFactsLanguage>? languages = const [],
-    String? cc,
+    @Deprecated('Use parameter country instead') String? cc,
     OpenFoodFactsCountry? country,
     List<TaxonomyLanguageField> fields = const [],
     List<Parameter> additionalParameters = const [],

diff --git a/lib/utils/ProductListQueryConfiguration.dart b/lib/utils/ProductListQueryConfiguration.dart
@@ -12,8 +12,9 @@ class ProductListQueryConfiguration extends AbstractQueryConfiguration {
     this.barcodes, {
     final OpenFoodFactsLanguage? language,
     final List<OpenFoodFactsLanguage> languages = const [],
-    final String? lc,
-    final String? cc,
+    @Deprecated('Use parameters language or languages instead')
+        final String? lc,
+    @Deprecated('Use parameter country instead') final String? cc,
     final OpenFoodFactsCountry? country,
     final List<ProductField>? fields,
     int? page,

diff --git a/lib/utils/ProductQueryConfigurations.dart b/lib/utils/ProductQueryConfigurations.dart
@@ -13,8 +13,9 @@ class ProductQueryConfiguration extends AbstractQueryConfiguration {
     this.barcode, {
     final OpenFoodFactsLanguage? language,
     final List<OpenFoodFactsLanguage> languages = const [],
-    final String? lc,
-    final String? cc,
+    @Deprecated('Use parameters language or languages instead')
+        final String? lc,
+    @Deprecated('Use parameter country instead') final String? cc,
     final OpenFoodFactsCountry? country,
     final List<ProductField>? fields,
   }) : super(

diff --git a/lib/utils/ProductSearchQueryConfiguration.dart b/lib/utils/ProductSearchQueryConfiguration.dart
@@ -11,8 +11,9 @@ class ProductSearchQueryConfiguration extends AbstractQueryConfiguration {
   ProductSearchQueryConfiguration({
     final OpenFoodFactsLanguage? language,
     final List<OpenFoodFactsLanguage> languages = const [],
-    final String? lc,
-    final String? cc,
+    @Deprecated('Use parameters language or languages instead')
+        final String? lc,
+    @Deprecated('Use parameter country instead') final String? cc,
     final OpenFoodFactsCountry? country,
     final List<ProductField>? fields,
     required List<Parameter> parametersList,

diff --git a/test/api_getProduct_test.dart b/test/api_getProduct_test.dart
@@ -900,7 +900,8 @@ void main() {
           notify: () => refreshCounter++,
         ),
       );
-      const String languageCode = 'en';
+      const OpenFoodFactsLanguage language = OpenFoodFactsLanguage.ENGLISH;
+      final String languageCode = language.code;
       final String importanceUrl =
           AvailablePreferenceImportances.getUrl(languageCode);
       final String attributeGroupUrl =
@@ -923,7 +924,7 @@ void main() {
       final ProductQueryConfiguration configurations =
           ProductQueryConfiguration(
         barcode,
-        lc: languageCode,
+        language: language,
         fields: [ProductField.NAME, ProductField.ATTRIBUTE_GROUPS],
       );
       final ProductResult result = await OpenFoodAPIClient.getProduct(