chore(fuzzysearch): dartfmt

Signed-off-by: SphericalKat <amolele@gmail.com>
SphericalKat · Mar 27, 2021 · 00fc439 · 00fc439
1 parent 7aa2c0e
commit 00fc439
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+# Flutter/Dart/Pub related
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+build/
diff --git a/lib/fuzzy_search.dart b/lib/fuzzy_search.dart
@@ -1,5 +1,6 @@
 import 'algorithms/token_set.dart';
 import 'algorithms/token_sort.dart';
+import 'algorithms/weighted_ratio.dart';
 import 'ratios/partial_ratio.dart';
 import 'ratios/simple_ratio.dart';
 
@@ -26,3 +27,14 @@ int tokenSetRatio(String s1, String s2) {
 int tokenSetPartialRatio(String s1, String s2) {
   return TokenSet().apply(s1, s2, PartialRatio());
 }
+
+/// Calculates a weighted ratio between [s1] and [s2] using several different 
+/// fuzzy matching algorithms
+/// 
+/// Example:
+/// ```dart
+/// weightedRatio("The quick brown fox jimps ofver the small lazy dog", "the quick brown fox jumps over the small lazy dog") // 97
+/// ```
+int weightedRatio(String s1, String s2) {
+  return WeightedRatio().apply(s1.toLowerCase(), s2.toLowerCase());
+}
diff --git a/lib/main.dart b/lib/main.dart
diff --git a/pubspec.lock b/pubspec.lock
@@ -0,0 +1,5 @@
+# Generated by pub
+# See https://dart.dev/tools/pub/glossary#lockfile
+packages: {}
+sdks:
+  dart: ">=2.7.0 <3.0.0"
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,7 @@
 name: "fuzzywuzzy"
 version: "0.1.0"
 homepage: "https://github.com/sphericalkat/dart-fuzzywuzzy"
+description: An implementation of the popular fuzzywuzzy package in dart
 
 environment:
   sdk: ">=2.7.0 <3.0.0"