Show and filter by company name (#208)
* Update company identifier handling and enhance scanning features - Updated `pubspec.lock` to version 1.2.0 and added `yaml` dependency. - Introduced `CompanyIdentifierService` for loading and querying company identifiers from a new YAML file. - Enhanced scanning functionality to support filtering by company names and IDs. - Updated UI components to display company names alongside manufacturer data in scanned items. - Improved search functionality to include company names in the filter criteria. * Address AI comments * Address AI comments * Allow searching by company id * Remove redundant loading state update in CompanyIdentifierService * Enhance company ID parsing in CompanyIdentifierService - Updated the `_parseCompanyId` method to support additional formats for company IDs, including non-prefixed strings interpreted as decimal or hexadecimal based on their content. - Improved parsing logic to first attempt hexadecimal conversion if the string contains hex characters, enhancing flexibility in input handling.
This commit is contained in:
Foti Dim
@@ -0,0 +1,278 @@
|
||||
import 'package:flutter/foundation.dart';
|
||||
import 'package:flutter/services.dart';
|
||||
import 'package:yaml/yaml.dart';
|
||||
|
||||
/// Service for loading and querying company identifiers from YAML file
|
||||
class CompanyIdentifierService {
|
||||
static CompanyIdentifierService? _instance;
|
||||
static CompanyIdentifierService get instance {
|
||||
_instance ??= CompanyIdentifierService._();
|
||||
return _instance!;
|
||||
}
|
||||
|
||||
CompanyIdentifierService._();
|
||||
|
||||
final Map<int, String> _companyIdToName = {};
|
||||
final Map<String, int> _companyNameToId = {};
|
||||
bool _isLoading = false;
|
||||
bool _isLoaded = false;
|
||||
bool _hasWarnedAboutNotLoaded = false;
|
||||
|
||||
/// Parse company ID from a value (String hex or int)
|
||||
/// Supports formats: "0x1053", "0x004C", "1053" (decimal), "4C" (hex), or integer value
|
||||
/// Non-prefixed strings are parsed as decimal if they contain only digits,
|
||||
/// or as hexadecimal if they contain hex characters (a-fA-F)
|
||||
int? _parseCompanyId(dynamic value) {
|
||||
if (value is String) {
|
||||
final trimmed = value.trim();
|
||||
if (trimmed.toLowerCase().startsWith('0x')) {
|
||||
return int.tryParse(trimmed.substring(2), radix: 16);
|
||||
} else {
|
||||
// Try parsing as hex first (if it contains letters), then decimal
|
||||
if (trimmed.contains(RegExp(r'[a-fA-F]'))) {
|
||||
return int.tryParse(trimmed, radix: 16);
|
||||
} else {
|
||||
return int.tryParse(trimmed);
|
||||
}
|
||||
}
|
||||
} else if (value is int) {
|
||||
return value;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/// Load company identifiers from YAML file
|
||||
///
|
||||
/// **Important:** This method should be called on app startup before using
|
||||
/// any query methods (e.g., [getCompanyName], [getCompanyIdFromName], etc.).
|
||||
/// If query methods are called before this method completes, they will return
|
||||
/// null/empty values and log a warning.
|
||||
Future<void> load() async {
|
||||
if (_isLoaded || _isLoading) return;
|
||||
_isLoading = true;
|
||||
|
||||
try {
|
||||
final String yamlString =
|
||||
await rootBundle.loadString('assets/company_identifiers.yaml');
|
||||
final YamlMap yaml = loadYaml(yamlString) as YamlMap;
|
||||
final YamlList? companyIdentifiers =
|
||||
yaml['company_identifiers'] as YamlList?;
|
||||
|
||||
if (companyIdentifiers == null) {
|
||||
_companyIdToName.clear();
|
||||
_companyNameToId.clear();
|
||||
_isLoaded = true;
|
||||
return;
|
||||
}
|
||||
|
||||
_companyIdToName.clear();
|
||||
_companyNameToId.clear();
|
||||
|
||||
for (var entry in companyIdentifiers) {
|
||||
if (entry is! YamlMap) continue;
|
||||
|
||||
final value = entry['value'];
|
||||
final name = entry['name'];
|
||||
|
||||
if (value == null || name == null) continue;
|
||||
|
||||
final companyId = _parseCompanyId(value);
|
||||
|
||||
if (companyId != null && name is String) {
|
||||
_companyIdToName[companyId] = name;
|
||||
// Store case-insensitive lookup for company names
|
||||
_companyNameToId[name.toLowerCase()] = companyId;
|
||||
}
|
||||
}
|
||||
|
||||
// Reset warning flag after successful load
|
||||
_hasWarnedAboutNotLoaded = false;
|
||||
_isLoaded = true;
|
||||
} on PlatformException catch (e) {
|
||||
// Handle file loading errors (e.g., file not found, permission issues)
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: Failed to load company identifiers file: ${e.message}',
|
||||
);
|
||||
_companyIdToName.clear();
|
||||
_companyNameToId.clear();
|
||||
_isLoaded = true;
|
||||
} on YamlException catch (e) {
|
||||
// Handle YAML parsing errors (e.g., invalid YAML syntax)
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: Failed to parse YAML: ${e.message}',
|
||||
);
|
||||
_companyIdToName.clear();
|
||||
_companyNameToId.clear();
|
||||
_isLoaded = true;
|
||||
} catch (e, stackTrace) {
|
||||
// Handle any other unexpected errors
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: Unexpected error loading company identifiers: $e',
|
||||
);
|
||||
debugPrint('Stack trace: $stackTrace');
|
||||
_companyIdToName.clear();
|
||||
_companyNameToId.clear();
|
||||
_isLoaded = true;
|
||||
} finally {
|
||||
_isLoading = false;
|
||||
}
|
||||
}
|
||||
|
||||
/// Get company name from company ID
|
||||
///
|
||||
/// Returns the company name for the given [companyId], or `null` if:
|
||||
/// - The company ID is not found in the loaded data
|
||||
/// - The data has not been loaded yet (see [load] method)
|
||||
///
|
||||
/// **Important:** The [load] method must be called on app startup before
|
||||
/// using this method. If called before data is loaded, this method will
|
||||
/// return `null` and log a warning (only once).
|
||||
String? getCompanyName(int companyId) {
|
||||
if (!_isLoaded) {
|
||||
if (!_hasWarnedAboutNotLoaded) {
|
||||
_hasWarnedAboutNotLoaded = true;
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: getCompanyName called before load() completed. '
|
||||
'Company names will not be available until load() is called on app startup.',
|
||||
);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
return _companyIdToName[companyId];
|
||||
}
|
||||
|
||||
/// Get company name from hex string (e.g., "0x1053" or "0x004C")
|
||||
String? getCompanyNameFromHex(String hexString) {
|
||||
final companyId = _parseCompanyId(hexString);
|
||||
if (companyId == null) return null;
|
||||
return getCompanyName(companyId);
|
||||
}
|
||||
|
||||
/// Get company ID from company name (case-insensitive)
|
||||
///
|
||||
/// Returns the company ID for the given [companyName], or `null` if:
|
||||
/// - The company name is not found in the loaded data
|
||||
/// - The data has not been loaded yet (see [load] method)
|
||||
///
|
||||
/// **Important:** The [load] method must be called on app startup before
|
||||
/// using this method. If called before data is loaded, this method will
|
||||
/// return `null` and log a warning (only once).
|
||||
int? getCompanyIdFromName(String companyName) {
|
||||
if (!_isLoaded) {
|
||||
if (!_hasWarnedAboutNotLoaded) {
|
||||
_hasWarnedAboutNotLoaded = true;
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: getCompanyIdFromName called before load() completed. '
|
||||
'Company identifiers will not be available until load() is called on app startup.',
|
||||
);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
return _companyNameToId[companyName.toLowerCase()];
|
||||
}
|
||||
|
||||
/// Get all company names (for filtering/searching)
|
||||
///
|
||||
/// Returns a list of all company names, or an empty list if:
|
||||
/// - No company identifiers are loaded
|
||||
/// - The data has not been loaded yet (see [load] method)
|
||||
///
|
||||
/// **Important:** The [load] method must be called on app startup before
|
||||
/// using this method. If called before data is loaded, this method will
|
||||
/// return an empty list and log a warning (only once).
|
||||
List<String> getAllCompanyNames() {
|
||||
if (!_isLoaded) {
|
||||
if (!_hasWarnedAboutNotLoaded) {
|
||||
_hasWarnedAboutNotLoaded = true;
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: getAllCompanyNames called before load() completed. '
|
||||
'Company names will not be available until load() is called on app startup.',
|
||||
);
|
||||
}
|
||||
return [];
|
||||
}
|
||||
return _companyIdToName.values.toList();
|
||||
}
|
||||
|
||||
/// Check if a string matches a company name (case-insensitive partial match)
|
||||
///
|
||||
/// Returns `false` if:
|
||||
/// - No match is found
|
||||
/// - The data has not been loaded yet (see [load] method)
|
||||
///
|
||||
/// **Important:** The [load] method must be called on app startup before
|
||||
/// using this method. If called before data is loaded, this method will
|
||||
/// return `false` and log a warning (only once).
|
||||
bool matchesCompanyName(String query) {
|
||||
if (!_isLoaded) {
|
||||
if (!_hasWarnedAboutNotLoaded) {
|
||||
_hasWarnedAboutNotLoaded = true;
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: matchesCompanyName called before load() completed. '
|
||||
'Company name matching will not be available until load() is called on app startup.',
|
||||
);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
final lowerQuery = query.toLowerCase();
|
||||
return _companyNameToId.keys.any((name) => name.contains(lowerQuery));
|
||||
}
|
||||
|
||||
/// Find company IDs that match a company name query (case-insensitive partial match)
|
||||
///
|
||||
/// Returns a list of matching company IDs, or an empty list if:
|
||||
/// - No matches are found
|
||||
/// - The data has not been loaded yet (see [load] method)
|
||||
///
|
||||
/// **Important:** The [load] method must be called on app startup before
|
||||
/// using this method. If called before data is loaded, this method will
|
||||
/// return an empty list and log a warning (only once).
|
||||
List<int> findCompanyIdsByName(String query) {
|
||||
if (!_isLoaded) {
|
||||
if (!_hasWarnedAboutNotLoaded) {
|
||||
_hasWarnedAboutNotLoaded = true;
|
||||
debugPrint(
|
||||
'CompanyIdentifierService: findCompanyIdsByName called before load() completed. '
|
||||
'Company identifier search will not be available until load() is called on app startup.',
|
||||
);
|
||||
}
|
||||
return [];
|
||||
}
|
||||
final lowerQuery = query.toLowerCase();
|
||||
return _companyNameToId.entries
|
||||
.where((entry) => entry.key.contains(lowerQuery))
|
||||
.map((entry) => entry.value)
|
||||
.toList();
|
||||
}
|
||||
|
||||
/// Parse a company identifier from a string (either by name or by ID)
|
||||
///
|
||||
/// This method first tries to find the company by name (case-insensitive).
|
||||
/// If not found, it attempts to parse the string as a company ID:
|
||||
/// - Supports hex format with "0x" prefix (e.g., "0x004C")
|
||||
/// - Supports hex format without prefix if it contains hex characters (e.g., "4C")
|
||||
/// - Falls back to decimal parsing if no hex characters are present (e.g., "76")
|
||||
///
|
||||
/// Returns the company ID if found/parsed successfully, null otherwise.
|
||||
int? parseCompanyIdentifier(String value) {
|
||||
final trimmed = value.trim();
|
||||
|
||||
// First, try to find by company name (case-insensitive)
|
||||
final companyId = getCompanyIdFromName(trimmed);
|
||||
if (companyId != null) {
|
||||
return companyId;
|
||||
}
|
||||
|
||||
// If not found by name, try parsing as company ID
|
||||
if (trimmed.toLowerCase().startsWith('0x')) {
|
||||
return int.tryParse(trimmed.substring(2), radix: 16);
|
||||
} else {
|
||||
// Try parsing as hex first (if it contains letters), then decimal
|
||||
if (trimmed.contains(RegExp(r'[a-fA-F]'))) {
|
||||
return int.tryParse(trimmed, radix: 16);
|
||||
} else {
|
||||
return int.tryParse(trimmed);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user