Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pchemguy/contacteditor
Demo VBA application/template illustrating MVP design pattern backed by persistent storage
https://github.com/pchemguy/contacteditor
adodb database excel mvp oop persistence persistent-data sqlite vba vba-excel
Last synced: 6 days ago
JSON representation
Demo VBA application/template illustrating MVP design pattern backed by persistent storage
- Host: GitHub
- URL: https://github.com/pchemguy/contacteditor
- Owner: pchemguy
- Created: 2021-02-20T20:27:04.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-06T19:48:00.000Z (about 3 years ago)
- Last Synced: 2024-12-04T12:41:28.851Z (about 1 month ago)
- Topics: adodb, database, excel, mvp, oop, persistence, persistent-data, sqlite, vba, vba-excel
- Language: VBA
- Homepage:
- Size: 85.6 MB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Overview
"Contact Editor" demos the Model-View-Presenter (MVP) pattern backed by persistent storage (MVP-DB) in VBA. I developed this mock data manager as a VBA OOP course project and an MVP-DB template/prototype for my VBA experiments.
Figure 1. Data management workflows.
The typical data management constituents are shown in [Fig. 1](#FigDataManagementWorkflows). Usually, the user sends a query to the database, receives a response table, browses record data via a user form, and, possibly, updates the database. From the user perspective, the data management process involves three key players: the user, persistent storage, and GUI acting as an intermediary between the first two. Functionally, the actual intermediary is the data manager application responsible for presenting the GUI, maintaining a local data container, and transferring the data (user ⇔ GUI ⇔ data container ⇔ persistent storage), as shown in [Fig. 2](#FigDataManagerApp). The left part of the figure marked with green arrows ("user ⇔ GUI" and "GUI ⇔ data container" interactions) can be implemented via the MVP pattern, and the remaining "data container ⇔ persistent storage" interaction can be handled via a "storage" library.
Figure 2. Data manager application.
### Development environment and repo structure
Primarily, I use Excel 2002 for development and also run tests on Excel 2016. Contact Editor demo is a VBA app and is part of an Excel Workbook [Contact Editor.xls][Contact Editor] available from the root of this repo. Additionally, all code modules and user forms are available from the [Project][Project] folder (which acts as a container and corresponds to the VBA project root within the .xls file). [Rubber Duck VBA][Rubber Duck VBA] add-in greatly facilitated the development process, and the project structure is exported/imported using the [RDVBA Project Utils][RDVBA Project Utils] VBA module. The repo includes a sample SQLite database used by one test module. This database is accessed via the "ADODB" backend and relies on the [SQLite ODBC driver][SQLite ODBC Orig]. While the tests should pass when the provided driver distribution is used, I compiled the driver myself, as briefly discussed [here][SQLite ODBC], to use an up-to-date SQLite library with all extensions enabled.
### Running the demo with different backends
*ContactEditorRunner.RunContactEditor* is the main entry for the demo.
*ContactEditorPresenter.InitializeModel* performs basic backend configuration.
The *DataTableBackEnd* variable found in the entry point sub determines the type of the main storage backend. It can take one of the following values:
- "Worksheet" for an Excel Worksheet (demo database [file][ContactEditor.xsv]),
- "CSV" for a text delimited file (demo database [file][Contact Editor]), and
- "ADODB" for a relational database (demo SQLite database [file][ContactEditor.db]).
While the "ADODB" backend can connect to both "CSV" and "Worksheet" databases, the dedicated backends should be more efficient.
### Documentation and further information
For documentation and technical details see project [website][ContactEditor Pages].
### Acknowledgments
A special thanks goes to Mathieu Guindon, a co-founder of the [Rubber Duck VBA][Rubber Duck VBA] project and his [RDVBA blog][RDVBA blog]. RDVBA [blog post][RDVBA No Worksheet] describing a possible approach to abstracting a Worksheet-based persistent storage and a [demo file][RDVBA No Worksheet Demo] helped me jump-start with storage integration. I also followed the [blog post][RDVBA UserForm1.Show] regarding the best practices for UserForm handling and the [SO answer][RDVBA Modeless Form] (and the last comment to that answer) regarding the modeless user forms.
[Rubber Duck VBA]: https://rubberduckvba.com
[RDVBA blog]: https://rubberduckvba.wordpress.com
[RDVBA No Worksheet]: https://rubberduckvba.wordpress.com/2017/12/08/there-is-no-worksheet
[RDVBA No Worksheet Demo]: https://rubberduckvba.wordpress.com/2017/12/08/there-is-no-worksheet/#div-comment-286
[RDVBA UserForm1.Show]: https://rubberduckvba.wordpress.com/2017/10/25/userform1-show
[RDVBA Modeless Form]: https://stackoverflow.com/questions/47357708/vba-destroy-a-modeless-userform-instance-properly#answer-47358692
[RDVBA Project Utils]: https://github.com/pchemguy/RDVBA-Project-Utils
[Overview]: https://github.com/pchemguy/ContactEditor/blob/develop/Assets/Diagrams/Overview.jpg?raw=true
[Project]: https://github.com/pchemguy/ContactEditor/tree/master/Project
[Contact Editor]: https://github.com/pchemguy/ContactEditor/blob/master/ContactEditor.xls
[ContactEditor.db]: https://github.com/pchemguy/ContactEditor/blob/master/ContactEditor.db
[ContactEditor.xsv]: https://github.com/pchemguy/ContactEditor/blob/master/ContactEditor.xsv
[ContactEditor Pages]: https://pchemguy.github.io/ContactEditor
[SQLite ODBC Orig]: http://www.ch-werner.de/sqliteodbc/
[SQLite ODBC]: https://pchemguy.github.io/SQLite-ICU-MinGW/
