Release/2.1.0 - WIP

README.md

@@ -1,33 +1,68 @@
 # BerlinDB
 
-BerlinDB is a collection of PHP classes and functions that aims to provide an <a href="https://en.wikipedia.org/wiki/Object-relational_mapping">ORM</a>-like experience and interface to WordPress database tables.
+BerlinDB is a collection of PHP classes & methods to provide an <a href="https://en.wikipedia.org/wiki/Object-relational_mapping">ORM</a>-like interface to database tables in WordPress.
 
-This repository contains all of the code that is required to be included in your WordPress project.
+Use it to move data out of custom Post Types & Taxonomies and into custom database tables.
 
-The most common use-case for BerlinDB is a WordPress Plugin that needs to create custom database tables, but more advanced uses are possible, including managing and interfacing with the WordPress Core database tables themselves.
+Ensure perform reliably and scale effortlessly in highly available WordPress based web applications.
 
-Future repositories in this organization will contain examples, extensions, drop-ins, unit tests, and more.
+## Mission
+The primary mission of BerlinDB is to democratize data storage.
 
-----
+### Phase 1 - 2022
+Minimize the effort required to perform routine & repetitive database interactions.
 
-The name of this project comes from WordCamp Europe 2019, where it was <a href="https://jjj.blog/wceu-2019/">originally announced</a> as an unnamed library. Thank you to <a href="https://peterwilson.cc">Peter Wilson</a> for the idea to pay homage to such a wonderful audience.
+### Phase 2 - 2022
+Achieve platform agnosticism through smart abstractions and interoperability layers.
 
-----
+### Phase 3 - 2022
+Generate the custom code that is necessary from any existing database table structure.
 
-The code in this repository represents the cumulative effort of dozens of individuals across multiple projects, spanning multiple continents, native languages, and years of conceptual development:
+### Phase 4 - 2023
+Automate database table structure changes for a seamless upgrade/rollback experience.
 
+### Phase 5 - 2023
+Manage all database connections to directly support reads, writes, clones, splitting, and sharding.
+
+## Name
+
+This project is named for [WordCamp Europe 2019](https://europe.wordcamp.org/2019/) which took place in the beautiful & historic capital city of Berlin, Germany, where it was <a href="https://jjj.blog/wceu-2019/">originally exhibited & announced</a> as an unnamed utility being used by the Sandhills Development engineering team.
+
+<a href="https://peterwilson.cc">Peter Wilson</a> recommended naming it "Berlin" to commemorate everyone in attendance for its unveiling. Thanks, Peter! 🙏
+
+## Beginnings
+
+The code in this repository represents the cumulative effort of dozens of individuals across multiple projects, spanning several continents, native languages, and years of conceptual development & iteration:
+
+* BuddyPress (<a href="https://buddypress.org">inspired by</a>)
+* WordPress Multisite (<a href="https://make.wordpress.org/core/components/networks-sites/">inspired by</a>)
 * Easy Digital Downloads (<a href="https://github.com/easydigitaldownloads/easy-digital-downloads/tree/release/3.0">3.0 and higher</a>)
 * Sugar Calendar (<a href="https://github.com/sugarcalendar/sugar-event-calendar-lite">2.0 and higher</a>)
 * Restrict Content Pro (<a href="https://github.com/restrictcontentpro">3.1 and higher</a>)
-* WordPress Multisite (<a href="https://make.wordpress.org/core/components/networks-sites/">inspired by</a>)
-* BuddyPress (<a href="https://buddypress.org">inspired by</a>)
 
-These projects all require custom database tables to acheive their goals (and to meet the expecations that their users have in them) to perform and scale flawlessly in a highly available WordPress based web application.
+## Contributions
+
+Interested in contributing? See the [contributing guide](/CONTRIBUTING.md).
+
+## Support
+
+Have a question? [Open a new issue](https://github.com/berlindb/core/issues/new) and someone will try to help.
+
+## License
+
+MIT. Please enjoy this code freely & openly, [as is](/LICENSE).
+
+If you are using BerlinDB in a commercial product, please consider [becoming a sponsor](https://github.com/sponsors/jjj?frequency=recurring&sponsor=jjj).
+
+## Created By
 
-Each of these projects originally implemented their own bespoke approaches to database management, resulting in a massive amount of code duplication, rework, and eventual fragmentation of approaches and ideas.
+- [@JJJ](https://twitter.com/JJJ) - https://jjj.blog
 
-This project helps avoid those issues by (somewhat magically) limiting how much code you need to write to accomplish the same repetitive database related tasks.
+## Credits
 
-----
+This organization is currently managed by <a href="https://jjj.software">Triple J Software, Inc.</a>.
 
-This organization was created by (and is managed by) <a href="https://sandhillsdev.com">Sandhills Development, LLC</a>, where we aim to craft superior experiences through ingenuity, with <a href="https://sandhillsdev.com/commitments/">deep commitment</a> to (and appreciation for) the human element.
+Special thanks to:
+- <a href="https://sandhillsdev.com">Sandhills Development, LLC</a>
+- <a href="https://awesomemotive.com">Awesome Motive, Inc.</a>
+- All of JJJ's generous sponsors 💛

autoloader.php

@@ -1,30 +1,31 @@
 <?php
 /**
- * Autoloader.
+ * BerlinDB Autoloader.
  *
  * @package     Database
- * @copyright   Copyright (c) 2021
+ * @subpackage  Autoloader
+ * @copyright   2021-2022 - JJJ and all BerlinDB Contributors
  * @license     https://opensource.org/licenses/MIT MIT
  * @since       2.0.0
  */
 
-// Exit if accessed directly.
-defined( 'ABSPATH' ) || exit;
-
-// Register a closure to autoload BerlinDB.
+/**
+ * Register a closure to autoload BerlinDB classes.
+ */
 spl_autoload_register(
 
 	/**
-	 * Closure of the autoloader.
+	 * Closure for the autoloader.
 	 *
-	 * @param string $class_name The fully-qualified class name.
+	 * @since 2.0.0
+	 * @param string $class_name A fully-qualified class name.
 	 * @return void
 	 */
 	static function ( $class_name = '' ) {
 
 		// Project namespace & length.
-		$root_namespace = 'BerlinDB\\';
-		$project_namespace = 'BerlinDB\\Database\\';
+		$root_namespace    = 'BerlinDB\\';
+		$project_namespace = $root_namespace . 'Database\\';
 		$length            = strlen( $project_namespace );
 
 		// Bail if class is not in this namespace.
@@ -33,11 +34,12 @@ static function ( $class_name = '' ) {
 		}
 
 		// Setup file parts.
-		$format = '%1$s/src/%2$s.php';
-		$path   = __DIR__;
-		$name   = str_replace( '\\', DIRECTORY_SEPARATOR, str_replace( $root_namespace, '', $class_name ) );
+		$strip  = str_replace( $root_namespace, '', $class_name );
+		$name   = str_replace( '\\', DIRECTORY_SEPARATOR, $strip );
 
 		// Parse class and namespace to file.
+		$format = '%1$s/src/%2$s.php';
+		$path   = __DIR__;
 		$file   = sprintf( $format, $path, $name );
 
 		// Bail if file does not exist.

composer.json

@@ -3,12 +3,15 @@
   "description": "A collection of PHP classes and functions that aims to provide an ORM-like experience and interface to WordPress database tables.",
   "type": "library",
   "license": "MIT",
-  "require": {},
   "autoload": {
     "psr-4": {
       "BerlinDB\\": "src/"
     }
   },
+  "require-dev": {
+    "szepeviktor/phpstan-wordpress": "^0.7.7",
+    "phpstan/extension-installer": "^1.1"
+  },
   "config": {
     "allow-plugins": {
       "phpstan/extension-installer": true