v7: Migration to Isar (#78)

* Improved stability

* Minor improvements

* Added Isar

* Broken a lot of stuff

* Broken a lot of stuff

* What am I even doing?

* Wow, a little bit of progress

* More migration

* Migrated import/export functionality

* Reimplemented metadata feature
Implemented faulty migrator

* Just a whole bunch of changes

* Updated pubspec version
Removed unnecessary dependencies

* Finished migrator
Minor bug fixes

* Hey, no more errors!

* Fixed bug in `tileImage` triggered when no tiles were available
Fixed bug in root's `watchChanges` (typo)

* Built Example Applications

* Updated versioning information
Updated Windows installer
Updated CHANGELOG
Removed iOS configuration from example app

* Improved performance of bulk downloader
Improved performance of 'Oldest Tile Remover' algorithm
Added support for conflict resolution to import functionality
Added import conflict chooser to example application
Changed `reset`s functionality to better match expectations

* Built Example Applications

* Simplified `LineRegion.toDrawable`
Fixed bugs
Upgraded to FM v3.1.0
Removed unnecessary dependencies
Improved documentation

* Built Example Applications

* Added buffering to bulk downloading
Added database compact condition to global settings
Added metadata migration
Improved example application to use buffering

Improved performance
Fixed bugs
Improved documentation
Updated CHANGELOG
Updated pubspec.yaml

* Updated dependencies

* Built Example Applications

* Removed centralised registry database

* Built Example Applications

* Split into modules
Minor internal refactoring
Bug fixes
Updated README

* Updated Isar dependency

* Re-run code generator

* Added initialisation safety system
Bug fixes

* Readded previously removed functionality
Improved documentation

* Built Example Applications

* Improved example application

* Updated example application
Fixed bugs and improved stability

* Built Example Applications

* Improved migrator method

* Built Example Applications

* Improved recovery database efficiency
Improved watcher stability

* Built Example Applications

* Fixed bugs
Updated dependencies
Improved example application

* Built Example Applications

* Fixed bugs

* Built Example Applications

* Improved regions with clearer documentation and a preparatory `name` property
Improved migrator regular expressions to avoid issues with unusual inputs
Replaced `BaseRegion.toList` with `toOutline` to be more self explanatory

* Migrated to Flutter v3.7.0
Updated example app design scheme

* Built Example Applications

* Improved example application

* Updated example application dependencies

* Built Example Applications

* Changed `part of` directives to point to the library instead of the root file

* Built Example Applications

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Former-commit-id: 8e24058a0ee954613290906e62c16ad8b6c51544 [formerly 0de89d5]
Former-commit-id: bf947e4137803bd19bb7f9f19bf3938a4c8b7ead

Author: JaffaKetchup

.vscode/settings.json

@@ -1,18 +1,6 @@
 {
     "cSpell.words": [
-        "Abdelrahman",
-        "armeabi",
-        "dontkillmyapp",
-        "iscc",
-        "Mattraks",
-        "osrm",
-        "pwsh",
-        "Redmi",
-        "Redownload",
-        "Sherif",
-        "sqflite",
-        "subosito",
-        "temurin",
-        "Xiaomi"
+        "isar",
+        "lukas"
     ]
 }

.vscode/tasks.json

@@ -0,0 +1,22 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "flutter",
+            "command": "flutter",
+            "args": [
+                "pub",
+                "run",
+                "build_runner",
+                "build",
+                "--delete-conflicting-outputs"
+            ],
+            "problemMatcher": [
+                "$dart-build_runner"
+            ],
+            "group": "build",
+            "label": "Run Code Generator",
+            "detail": "flutter pub run build_runner build"
+        }
+    ]
+}

CHANGELOG.md

@@ -7,13 +7,30 @@ Many thanks to my sponsors, no matter how much or how little they donated. Spons
 * @huulbaek
 * @andrewames
 * @ozzy1873
-* Anonymous Donor (via Ko-Fi, no username provided)
-* Private Donor (via GitHub, chosen private)
-* Private Donor (via GitHub, chosen private)
+* @mohammedX6
+* @weishuhn
+* and 3 anonymous or private donors
 
 # Changelog
 
-## [6.2.0] - 2022/10/XX
+## [7.0.0] - 2023/01/XX
+
+* Migrated to Isar database
+* Major performance improvements, thanks to Isar
+* Added buffering to bulk tile downloading
+* Added method to catch tile retrieval errors
+* Removed v4 -> v5 migrator & added v6 -> v7 migrator
+* Removed some synchronous methods from structure management
+* Removed 'fmtc_advanced' import file
+
+Plus the usual:
+
+* Minor performance improvements
+* Bug fixes
+* Dependency updates
+* Documentation improvements
+
+## [6.2.0] - 2022/10/25
 
 * Performance improvements
 * Changed license to GPL v3

README.md

@@ -1,4 +1,4 @@
-# flutter_map_tile_caching
+# [flutter_map](https://pub.dev/packages/flutter_map)_tile_caching
 
 A plugin for ['flutter_map'](https://pub.dev/packages/flutter_map) providing advanced caching functionality, with ability to download map regions for offline use. Also includes useful prebuilt widgets.
 
@@ -29,14 +29,18 @@ You can read more about me and what I do on my [GitHub Sponsors](https://github.
 
 Alternatively, if you prefer not to use GitHub Sponsors, please feel free to use my [Ko-fi](https://ko-fi.com/jaffaketchup). Note that the PayPal backend will take a small percentage amount of donations made through this method.
 
-## (Commercial) Licensing
+## (Proprietary) Licensing
 
-_I am not a lawyer, and this information is to the best of my understanding._
+_I am not a lawyer, and this information is to the best of my understanding. You are urged to read the license yourself for a thorough understanding._
 
-This project is released under GPL-v3. For more information about this license, see <https://choosealicense.com/licenses/gpl-3.0/>. Essentially, whilst you can use this code within commercial projects, they must not be proprietary/closed-source.
+This project is released under GPL v3. For detailed information about this license, see <https://www.gnu.org/licenses/gpl-3.0.en.html>. [choosealicense.com](https://choosealicense.com/licenses/gpl-3.0/) summarises the license with the following paragraph:
 
-However, I am willing to sell alternative licenses on a case-by-case basis and on request: please read on for more information.
+> Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.
 
-I learnt (and am still learning) to code with free, open-source software due to my age and therefore my lack of money, and for that reason, I believe in promoting open-source wherever possible to give equal opportunities to everybody, no matter their age or financial position. I'm not sure it's fair for commercial proprietary applications to use software made by people for free out of generosity. On the other hand, I am also trying to make a small amount of money from my projects, by donations or by selling licenses. And I recognise that commercial businesses may want to use my projects.
+Essentially, whilst you can use this code within commercial projects, they must not be proprietary - they incorporate this 'licensed work' so they must be available under the same license. You must distribute your source code on request (under the same GPL v3 license) to anyone who uses your program.
 
-Therefore, if you would like a license to use this software on a closed-source application, I will be willing to sell a yearly license for a reasonable price. If this seems like what you want/need, please do not hesitate to get in touch via [[email protected]](mailto://[email protected]).
+However, I am willing to sell alternative (proprietary) licenses on a case-by-case basis and on request.
+
+I learnt (and am still learning) to code with free, open-source software due to my age and lack of money, and for that reason, I believe in promoting open-source wherever possible to give equal opportunities to everybody, no matter their age or financial position. I'm not sure it's fair for commercial proprietary applications to use software made by people for free out of generosity. On the other hand, I am also trying to make a small amount of money from my projects, by donations or by selling licenses. And I recognise that commercial businesses may want to use my projects for their own proprietary applications.
+
+Therefore, if you would like a license to use this software within a proprietary, I am willing to sell a (preferably yearly or usage based) license for a reasonable price. If this seems like what you want/need, please do not hesitate to get in touch via [[email protected]](mailto://[email protected]).

analysis_options.yaml

@@ -1,5 +1,9 @@
 include: jaffa_lints.yaml
 
+analyzer:
+  exclude:
+    - lib/src/db/defs/*.g.dart
+
 linter:
   rules:
     avoid_slow_async_io: false

dartdoc_options.yaml

@@ -0,0 +1,2 @@
+dartdoc:
+  favicon: 'example/assets/icons/ProjectIcon.png'

example/currentAppVersion.txt

@@ -1 +1 @@
-6.2.1
+7.0.0