📝 Added Lots of Comment, ♻️ Refractored Lots of Code

Author: skj-skj

lib/constants.dart

@@ -1,5 +1,13 @@
+// 🐦 Flutter imports:
 import 'package:flutter/material.dart';
 
+/// 🔠🗨️, already in 🗄️ db text
+String kAlreadyInDB = "already in the database";
+
+///🔠, 📱 App Title
+String kAppTitle = "PDF Indexing";
+
+/// ➕ Create Table Query
 String kCreateTableQuery = '''
     CREATE TABLE $kPdfTableName (
 	    filename TEXT PRIMARY KEY,
@@ -10,12 +18,42 @@ String kCreateTableQuery = '''
       folder TEXT
     )
     ''';
+
+/// 🔠, 🗄️ Database is Empty Message
 String kDatabaseEmptyText = "Database is Empty, Click on + to import PDF files";
+
+/// 🔠, 🗄️ Database file Name
 String kDBFileName = "data.db";
+
+/// 🔠, 🌐 URL of 'no_file_found.png'
 String kFileNotFoundImage = "assets/images/no_file_found.png";
-String kGivePermissionText = "Give Permission To Access Files";
+
+/// 🔠, 🙏 Give Permission Text
+String kGivePermissionText = "Click Here to Give Permission";
+
+/// 🔠🗨️, 🙏 Give Permission Text for 🔘 FAB
+String kGivePermissionTextFAB = "Please Give Permission";
+
+/// 🔠, ❔ Hint Text for Tags TextField in
+String kHintText = "Ex: LED Bulb,Panel,Round";
+
+/// 🔠🗨️, Imported Successfully Text
+String kImportedSuccessfully = "Imported Successfully";
+
+/// 🔠🗨️, Importing File Message shown in SnackBar
+String kImportingFilesMessage = "Importing Files, Please Wait";
+
+/// 💄 TextStyle for [Item]
 TextStyle kItemWidgetTextStyle = TextStyle(fontSize: 12);
+
+/// 🔠, [path] Asending for SQLite
 String kPathAsc = "path ASC";
+
+/// 🔠, [path] Desending for SQLite
 String kPathDesc = "path DESC";
+
+/// 🔠, 'pdf_files' 📁 Directory name
 String kPdfFilesPath = "pdf_files";
+
+/// 🔠, 🗄️ Database Table name
 String kPdfTableName = "pdf_table";

lib/functions/db_helper.dart

@@ -1,12 +1,18 @@
+// 📦 Package imports:
 import 'package:path/path.dart';
+import 'package:sqflite/sqflite.dart';
+
+// 🌎 Project imports:
 import 'package:pdf_indexing/constants.dart';
 import 'package:pdf_indexing/functions/utils.dart' as Utils;
-import 'package:pdf_indexing/pdfModel.dart';
-import 'package:sqflite/sqflite.dart';
+import 'package:pdf_indexing/model/pdfModel.dart';
 
+/// 🗄️🛠️ Database Helper Class
 class DBHelper {
+  /// 🗄️ [Database?] 🗿 🕵️ variable
   static Database? _db;
 
+  /// 🗞️ getter for [_db], which initiate Database if null
   Future<Database?> get db async {
     if (_db != null) {
       return _db;
@@ -16,20 +22,25 @@ class DBHelper {
     }
   }
 
+  /// 🗑️ Delete Row by [filename] from 🗄️ Database
   void deleteFromFilename(String filename) async {
     Database? dbClient = await db;
     int rowsDeleted = await dbClient!
         .delete(kPdfTableName, where: "filename = ?", whereArgs: [filename]);
     print("$rowsDeleted Rows Deleted");
   }
 
+  /// 🗑️ Delete Row by [path] from 🗄️ Database
   void deleteFromPath(String path) async {
     Database? dbClient = await db;
     int rowsDeleted = await dbClient!
         .delete(kPdfTableName, where: "path = ?", whereArgs: [path]);
     print("$rowsDeleted Rows Deleted");
   }
 
+  /// ⏩🔠 Return String, containing [folder] data
+  ///
+  /// Where path = [path]
   Future<String> getFolder({required String path}) async {
     Database? dbClient = await db;
     List<Map> results = await dbClient!
@@ -41,6 +52,10 @@ class DBHelper {
     }
   }
 
+  /// ⏩#️⃣ Return String, containing [hash] String
+  ///
+  /// Where hash = [hash]
+  /// if hash doesn't exist return empty String ''
   Future<String> getSHA1HashDB({required String hash}) async {
     Database? dbClient = await db;
     List<Map> results = await dbClient!
@@ -53,6 +68,9 @@ class DBHelper {
     }
   }
 
+  /// ⏩🏷️ Return String, containing [tags] data
+  ///
+  /// Where path = [path]
   Future<String> getTags({required String path}) async {
     Database? dbClient = await db;
     List<Map> results = await dbClient!
@@ -64,22 +82,29 @@ class DBHelper {
     }
   }
 
-  //Select query for all file paths
+  /// ⏩🗄️ Return Database
+  ///
+  /// It open Database in 📁 Directory and Create Table in 🗄️ Database on first run
   Future<Database> initDB() async {
     String storagePath = await Utils.getStoragePath();
     Database db = await openDatabase(join(storagePath, kDBFileName),
         version: 1, onCreate: _onCreate);
     return db;
   }
 
-  //Select query for file paths with where condition - seaching in the text column
+  /// ⏩[🗺️] Return [Map,]
+  ///
+  /// Return [path] from all Rows
   Future<List<Map>> queryForAllfilePaths() async {
     Database? dbClient = await db;
     return await dbClient!
         .query(kPdfTableName, columns: ['path'], orderBy: kPathAsc);
   }
 
-  // Select query for getting sha1 hash entry of the file
+  /// ⏩[🗺️] Return [Map,]
+  ///
+  /// Return [path] from Rows
+  /// Where pdfText,filename,tags contains [text]
   Future<List<Map>> queryForFilePathsWithCondition(String text) async {
     Database? dbClient = await db;
     return await dbClient!.query(
@@ -90,22 +115,26 @@ class DBHelper {
     );
   }
 
+  /// 📥 Save [folder] data in the 🗄️ Database
   void saveFolder({required String path, required String folder}) async {
     Database? dbClient = await db;
     dbClient!
         .update(kPdfTableName, {'folder': '$folder'}, where: "path = '$path'");
   }
 
+  /// 📥 Save [pdfModel] data in the 🗄️ Database
   void savePdf(PDFModel pdfModel) async {
     Database? dbClient = await db;
     dbClient!.insert(kPdfTableName, pdfModel.toMap());
   }
 
+  /// 📥 Save [tags] data in the 🗄️ Database
   void saveTags({required String path, required String tags}) async {
     Database? dbClient = await db;
     dbClient!.update(kPdfTableName, {'tags': '$tags'}, where: "path = '$path'");
   }
 
+  /// ➕ Create 🗄️ Database Table if not Created
   void _onCreate(Database db, int version) async {
     await db.execute(kCreateTableQuery);
   }

lib/functions/initialize_db.dart

@@ -1,9 +1,15 @@
+// 🐦 Flutter imports:
 import 'package:flutter/material.dart';
-import 'package:pdf_indexing/functions/db_helper.dart';
-import 'package:pdf_indexing/pdfItemModel.dart';
+
+// 📦 Package imports:
 import 'package:provider/provider.dart';
 
+// 🌎 Project imports:
+import 'package:pdf_indexing/functions/db_helper.dart';
+import 'package:pdf_indexing/model/pdfItemModel.dart';
+
 //not in use currrently
+/// To Initialise pdf Items in Provider
 void initialPDFItem({required BuildContext context}) async {
   List<Map> dbResultItems = [];
   try {

lib/functions/pdfUtils.dart

@@ -1,62 +1,76 @@
+// 🎯 Dart imports:
 import 'dart:io';
 
+// 📦 Package imports:
 import 'package:file_picker/file_picker.dart';
 import 'package:path/path.dart';
+import 'package:pdf_text/pdf_text.dart';
+
+// 🌎 Project imports:
 import 'package:pdf_indexing/constants.dart';
 import 'package:pdf_indexing/functions/utils.dart' as Utils;
-import 'package:pdf_indexing/pdfModel.dart';
-import 'package:pdf_text/pdf_text.dart';
+import 'package:pdf_indexing/model/pdfModel.dart';
 
+/// ⏩🧰 Return PDFModel
+///
+/// ⚙️ Generate PDFModel of [pdfFile]
 Future<PDFModel> getPdfModelOfFile(
     File pdfFile, List<String> filenamesInDir) async {
   String storagePath = await Utils.getStoragePath();
   List<String> filename = Utils.getFileNameAndExtentionFromPath(pdfFile.path);
   String filenameToUse = '';
 
-  //Generate filename if same filename already exists
+  /// ⚙️ Generate New filename [filenameToUse]
+  /// if, old filename [filename[0]] already exist in 📁 Directory
   int count = 0;
   String tempFileName = '${filename[0]}.${filename[1]}';
   while (true) {
     if (!filenamesInDir.contains(tempFileName)) {
       filenameToUse = tempFileName;
-      print("File New Name 2: $filename");
-
       break;
     } else {
-      print("File Name Exists: $filename");
       count++;
       tempFileName = '${filename[0]}-$count.${filename[1]}';
-      print("File New Name: $tempFileName");
     }
   }
-  print("File New Name 3: $filename");
 
+  /// 📥 Save [pdfFile] in App Directory
   File pdfSavedFile =
       await pdfFile.copy(join(storagePath, kPdfFilesPath, filenameToUse));
 
-  // Extracting Text from pdf
+  /// 📤 Extracting Text from [pdfSavedFile], at page 1
   PDFDoc doc = await PDFDoc.fromFile(pdfSavedFile);
   PDFPage page = doc.pageAt(1);
   String pageText = await page.text;
 
-  // Generating SHA1 Hash
+  /// ⚙️ Generating [SHA1] #️⃣ of [pdfSavedFile]
   String hash = await Utils.getSHA1Hash(pdfSavedFile);
 
+  /// ⚙️🧰 Creating pdfModel
   PDFModel pdfModel = PDFModel(
       path: pdfSavedFile.path,
       pdfText: pageText,
       tags: '',
       hash: hash,
       folder: '');
+
   return pdfModel;
 }
 
+/// ⏩[📄]?
+///
+/// Return [File,]?
+/// 🗃️ Pick PDF file from [FilePicker]
+/// Can pick multiple File
 Future<List<File>?> pickPDFFiles() async {
   FilePickerResult? result = await FilePicker.platform.pickFiles(
     type: FileType.custom,
     allowedExtensions: ['pdf'],
     allowMultiple: true,
   );
+
+  /// 🗺️ Results
+  /// path -> File(path)
   if (result != null) {
     return result.paths.map((path) => File(path!)).toList();
   } else {