allegroflare / allegro_flare

Application toolkit for Allegro 5
https://clubcatt.com/allegroflare
MIT License
35 stars 6 forks source link

Remove all allegro_flare (not AllegroFlare) namespaced objects #183

Closed MarkOates closed 2 years ago

MarkOates commented 2 years ago

Premise

Legacy AllegroFlare is listed under the allegro_flare/ namespace. It is still used across a few projects, but for public use it should be scheduled for immediate depreciation. All users of AllegroFlare should be using AllegroFlare components. Missing AllegroFlare components that exist in allegro_flare should be added, upgraded from allegro_flare, introduced, or backlogged.

A bit of History

_A bit of history: Initially, AllegroFlare was created so that each component written in the namespace had a minimum standard of quality and design consistency (one component per file, no globals, no singletons, etc). A lot of allegro_flare:: components are a bit sloppy, had incomplete test coverage, are redundant to Allegro5 features, and are not feature-complete. Some allegro_flare:: features are dependent on the GUI framework, which is not really used._

Action items would be:

After Completing the Above, Action items would be:

Each ported component should have a corresponding test file (with minimum "can_be_created_wihtout_blowing_up" passing test). Missing coverage can be added as DISABLED test with TODOs and/or added as an issue in GitHub.

MarkOates commented 2 years ago

Note that a google sheet has been created that lists all the components and their current porting status.

AllegroFlare -  allegro_flare components - Google Sheets 2022-05-19 20-07-03

MarkOates commented 2 years ago

This is finished. There are a few classes that do require some more work just in terms of overall development, but it's not a major issue at this stage, I believe. Everything's been ported.

A large number of files were added to the legacy/ folder, in the examples/ directory and tests/ directory.

Otherwise, all the known dependent projects have been updated, some hard-copies of files were created from allegro_flare/ sources that had previously been symlinks in those projects, but there were very few to be honest, so it looks like the port was relatively clean. :)