Merge pull request #5 from utopia-dart/fix-tests

Fix tests

.github/workflows/test.yml → .github/workflows/mariadb_tests.yml

@@ -1,4 +1,4 @@
-name: Test
+name: MariaDB tests
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
@@ -14,7 +14,7 @@ on:
 
 defaults:
   run:
-    working-directory: utopia_database/
+    working-directory: packages/utopia_database_adapter_mariadb/
 
 jobs:
   test:

.github/workflows/publish_mariadb_adapter.yml

@@ -12,4 +12,4 @@ jobs:
     uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1
     with:
       environment: pub.dev
-      working-directory: utopia_database_adapter_mariadb/
+      working-directory: packages/utopia_database_adapter_mariadb/

.github/workflows/publish_utopia_database.yml

@@ -12,4 +12,4 @@ jobs:
     uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1
     with:
       environment: pub.dev
-      working-directory: utopia_database/
+      working-directory: packages/utopia_database/

utopia_database/README.md → README.md

@@ -1,15 +1,15 @@
 # Utopia Database
 
-Utopia Database is light and fast database library for Dart. It is designed to be simple and easy to use. It currently supports only MariaDB and MySQL databases.
+Utopia Database is light and fast database library for Dart. It is designed to be simple and easy to use. It currently supports only MariaDB database.
 
 ## Getting started
 
 Add the following to your `pubspec.yaml` file:
 
 ```yaml
 dependencies:
-  utopia_database: ^0.2.0
-  utopia_database_adapter_mariadb: ^0.2.0
+  utopia_database: <latest>
+  utopia_database_adapter_mariadb: <latest>
 ```
 
 ## Usage
@@ -62,4 +62,4 @@ void main() async {
 
 ## Contribute new adapter
 
-To add new adapter for different database, follow the steps in [add database adapter](docs/add_database_adapter.md).
+To add new adapter for different database, follow the steps in [add database adapter](/utopia_database/doc/add_database_adapter.md).

melos.yaml

@@ -1,5 +1,4 @@
 name: utopia_database_melos
 
 packages:
-  - utopia_database/
-  - utopia_database_adapter_mariadb/
+  - packages/**

packages/utopia_database/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 0.3.0
+
+- Moved MariaDB adapter tests to its own package `utopia_database_adapter_mariadb`
+- Thus removed cyclic dependency between `utopia_database` and `utopia_database_adapter_mariadb`
+
+## 0.2.0
+
+- Move MariaDB adapter to its own package `utopia_database_adapter_mariadb`
+
+
+## 0.1.1
+
+- update documentation comments
+
+## 0.1.0
+
+- Initial version

packages/utopia_database/README.md

@@ -0,0 +1,60 @@
+# Utopia Database
+
+Utopia Database is light and fast database library for Dart. It is designed to be simple and easy to use. It currently supports only MariaDB database but you can contribute to [add adapters to other databases](doc/add_database_adapter.md).
+
+## Setup
+
+Together with this package, you need to also add a database adapter package to your project. Check out [MariaDB adapter package](https://pub.dev/packages/utopia_database_adapter_mariadb).
+
+
+## Example
+
+```dart
+import 'package:utopia_database/utopia_database.dart';
+import 'package:utopia_database_adapter_mariadb/utopia_database_adapter_mariadb.dart';
+
+void main() async {
+  final mariadb = await MariaDB.init(
+      host: 'localhost', port: 3306, user: 'user', password: 'password');
+  final database = Database(mariadb);
+  print('connection initialized');
+  database.setDefaultDatabase('applications');
+  database.setNamespace('_myproject');
+  final exists = await database.exists(collection: Database.metadata);
+
+  if (!exists) {
+    await database.create();
+    print('metadata created');
+  }
+
+  final userExists = await database.exists(collection: 'users');
+
+  if (!userExists) {
+    await database.createCollection('users', [
+      Attribute(
+        id: 'name',
+        type: Database.varString,
+        isRequired: true,
+        size: 255,
+      ),
+      Attribute(
+        id: 'email',
+        type: Database.varString,
+        isRequired: true,
+        size: 255,
+      ),
+      Attribute(
+        id: 'description',
+        type: Database.varString,
+        isRequired: true,
+        size: 2550,
+      ),
+    ], []);
+    print('users collection created');
+  }
+}
+```
+
+## Contribute new adapter
+
+To add new adapter for different database, follow the steps in [add database adapter](docs/add_database_adapter.md).

utopia_database/doc/add_database_adapter.md → packages/utopia_database/doc/add_database_adapter.md

@@ -4,6 +4,8 @@ Every database adapter is a separate package. To create a adapter for new databa
 
 ## Create package
 
+Fork the repository and clone it to your local machine. Then create a new Dart package using the following command.
+
 The naming pattern for the database adapter package is `utopia_database_adapter_<database_name>`. For example, the MariaDB adapter package is `utopia_database_adapter_mariadb`.
 
 ```bash
@@ -28,5 +30,3 @@ class <DatabaseName> extends Adapter {
     // implement the abstract methods
 }
 ```
-
-> If you want the adapter to be a part of utopia-dart ecosystem, please raise a issue and share your repo URL and we will review and create a repo under utopia-dart organization.

packages/utopia_database/example/pubspec.yaml

@@ -0,0 +1,9 @@
+name: utopia_database_example
+
+environment: 
+  sdk: '>=3.0.0 <4.0.0'
+
+
+dependencies:
+  utopia_database: ^0.2.0
+  utopia_database_adapter_mariadb: ^0.2.0

utopia_database/lib/utopia_database.dart → packages/utopia_database/lib/utopia_database.dart

@@ -1,6 +1,5 @@
-/// Support for doing something awesome.
-///
-/// More dartdocs go here.
+/// Utopia Database is light and fast database library for Dart.
+/// It is designed to be simple and easy to use.
 library utopia_database;
 
 export 'src/adapter.dart';

utopia_database/pubspec.yaml → packages/utopia_database/pubspec.yaml

@@ -1,16 +1,14 @@
 name: utopia_database
 description: A light and easy to get started database library for all your Dart projects
-version: 0.2.0
-repository: https://github.com/utopia-dart/utopia_database
+version: 0.3.0
+repository: https://github.com/utopia-dart/utopia_database/tree/main/packages/utopia_database
 
 environment:
   sdk: '>=2.19.6 <4.0.0'
 
 dev_dependencies:
   lints: ^3.0.0
   test: ^1.25.2
-  utopia_database_adapter_mariadb: ">=0.2.0 <1.0.0"
-
 
 dependencies:
   collection: ^1.17.1

utopia_database_adapter_mariadb/CHANGELOG.md → packages/utopia_database_adapter_mariadb/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0
+
+- Added integration test for databsae adapter
+
 ## 0.2.0
 
 - Update dependencies

utopia_database_adapter_mariadb/README.md → packages/utopia_database_adapter_mariadb/README.md

@@ -2,15 +2,12 @@
 
 MariaDB adapter for [Utopia database](https://github.com/utopia-dart/utopia_database).
 
-## Getting started
+## Setup
+
+This package should be used along with [utopia_database](https://pub.dev/packages/utopia_database) package to connect to MariaDB database.
 
-```yaml
-dependencies:
-    utopia_database:
-    utopia_database_adapter_mariadb:
-```
 
-Then in `main.dart` you can
+## Example
 
 ```dart
 import 'package:utopia_database/utopia_database.dart';

packages/utopia_database_adapter_mariadb/pubspec.yaml

@@ -0,0 +1,15 @@
+name: utopia_database_adapter_mariadb
+description: MariaDB adapter for Utopia database library, that connects to MariaDB to provide database functionalities.
+version: 0.3.0
+repository: https://github.com/utopia-dart/utopia_database/tree/main/packages/utopia_database_adapter_mariadb
+
+environment:
+  sdk: '>=2.19.6 <4.0.0'
+
+dependencies:
+  mysql1: ^0.20.0
+  utopia_database: '>=0.2.0 <1.0.0'
+
+dev_dependencies:
+  lints: ^3.0.0
+  test: ^1.24.0

pubspec.yaml

@@ -1,4 +1,5 @@
 name: utopia_database_melos
+publish_to: none
 
 environment:
   sdk: '>=3.0.0 <4.0.0'