README

Laravel package for fuzzy matching (string similarity) using Levenshtein, SimilarText, and Jaro-Winkler algorithms.

Objetivo

Este paquete proporciona algoritmos de coincidencia aproximada de strings (fuzzy matching) para detectar nombres similares y evitar duplicados en entidades como consignatarios y otras entidades en sistemas de control de contenedores marítimos.

Características

Algoritmos implementados:
- Levenshtein (distancia de edición) - Prioridad Alta
- SimilarText (porcentaje de similitud) - Prioridad Media
- Jaro-Winkler (para nombres con transposiciones) - Prioridad Baja
Facade conveniente para uso simple
Configuración flexible para ajustar algoritmos y umbrales
Sin dependencias externas (usa funciones nativas de PHP donde sea posible)
Compatible con Laravel 12+ y Laravel 13+
PHP 8.2+ (Laravel 12) o PHP 8.3+ (Laravel 13)

Instalación

composer require laymont/laravel-fuzzy-match

Configuración

Publica la configuración:

php artisan vendor:publish --provider="Laymont\FuzzyMatch\FuzzyMatchServiceProvider"

Esto creará config/fuzzy-match.php con las siguientes opciones:

return [
    // Algoritmo por defecto: 'levenshtein', 'similar_text', 'jaro_winkler'
    'default_algorithm' => env('FUZZY_MATCH_DEFAULT_ALGORITHM', 'levenshtein'),

    // Umbral para determinar similitud
    // - Para Levenshtein: distancia máxima (menor es mejor)
    // - Para algoritmos de similitud: puntuación mínima (mayor es mejor)
    'threshold' => env('FUZZY_MATCH_THRESHOLD', 3),

    // Si el matching debe ser case sensitive
    'case_sensitive' => env('FUZZY_MATCH_CASE_SENSITIVE', false),

    // Algoritmos habilitados
    'algorithms' => [
        'levenshtein' => true,
        'similar_text' => true,
        'jaro_winkler' => false,
    ],
];

Uso

Facade

use Laymont\FuzzyMatch\Facades\FuzzyMatch;

// Buscar nombres similares
$similar = FuzzyMatch::findSimilar('MAERSK LINE', [
    'algorithm' => 'levenshtein',
    'threshold' => 3,
    'case_sensitive' => false,
]);

// Resultado esperado:
// [
//     ['id' => 0, 'name' => 'MAERSK LINE', 'distance' => 0],
//     ['id' => 1, 'name' => 'MAERSK LINES', 'distance' => 1],
// ]

// Calcular distancia específica
$distance = FuzzyMatch::calculateDistance('MAERSK LINE', 'MAERSK LINES', 'levenshtein');
// Resultado: 1

Service

use Laymont\FuzzyMatch\Services\FuzzyMatchService;

$service = new FuzzyMatchService();
$results = $service->findSimilar('MAERSK LINE', [
    'algorithm' => 'levenshtein',
    'threshold' => 3,
]);

Uso en Form Request (Ayaguna)

use Laymont\FuzzyMatch\Facades\FuzzyMatch;
use Illuminate\Validation\Rule;

public function rules()
{
    $name = $this->input('name');

    $similar = FuzzyMatch::findSimilar($name, [
        'threshold' => 3,
    ]);

    return [
        'name' => [
            'required',
            'string',
            Rule::unique('consignees')->ignore($this->id),
            function ($attribute, $value, $fail) use ($similar) {
                if (!empty($similar)) {
                    $fail("Existe un consignatario similar: {$similar[0]['name']}");
                }
            },
        ],
    ];
}

Algoritmos

Levenshtein (Prioridad Alta)

Descripción: Distancia de edición entre dos strings
PHP nativo: levenshtein()
Mide: Inserciones, eliminaciones, sustituciones
Uso: Detección de errores tipográficos leves

SimilarText (Prioridad Media)

Descripción: Porcentaje de similitud
PHP nativo: similar_text()
Ventaja: Más rápido pero menos preciso
Uso: Detección rápida de similitudes

Jaro-Winkler (Prioridad Baja)

Descripción: Para nombres con transposiciones
Implementación: Manual (no nativo en PHP)
Ventaja: Más preciso para nombres
Uso: Detección de nombres con letras intercambiadas

Compatibilidad

PHP: ^8.2
Laravel: ^12.0|^13.0

Nota: Laravel 12 requiere PHP 8.2+, mientras que Laravel 13 requiere PHP 8.3+.

Testing

El paquete incluye tests unitarios para cada algoritmo y el servicio principal.

./vendor/bin/pest

Contribución

Haz un fork del repositorio.
Crea una rama: git checkout -b feature/nueva-funcionalidad.
Realiza cambios y hace commit: git commit -m "Agregando...".
Sube: git push origin feature/nueva-funcionalidad.
Abre un Pull Request.

Donaciones

Si encuentras útil este paquete y deseas apoyar su desarrollo y mantenimiento, puedes considerar hacer una donación.

Zinli

ID de usuario: 3-002-58546608-36
Recargar: https://recargas.zinli.com/4nVRQUniFdK8DBfPzzfyzR

Visa Prepagada Zinli

Número: 4850460061276928

Binance Pay

Binance Pay ID: 206414132

¡Gracias por tu apoyo!

Licencia

MIT.

laymont / laravel-fuzzy-match

Maintainers

Package info

Statistics

Security