run dart migrate

Author: hpoul

.gitignore

@@ -1,3 +1,18 @@
+# https://gist.github.com/hpoul/b78f7a1b3cde988f3ce4d12e954367eb
+#
+# IDEA: Allow some configuration, which is shared across users.
+
+/.idea/*
+!.idea/runConfigurations
+!.idea/runConfigurations/*
+!.idea/vcs.xml
+!.idea/dictionaries
+!.idea/dictionaries/*
+!.idea/inspectionProfiles/*
+!.idea/codeStyles
+!.idea/codeStyles/*
+*.iml
+
 # Files and directories created by pub
 .dart_tool/
 .packages

.idea/vcs.xml

@@ -9,10 +9,10 @@ part 'config.g.dart';
 @JsonSerializable(anyMap: true, checked: true)
 class DatabaseConfig {
   DatabaseConfig({
-    @required this.host,
-    @required this.port,
-    @required this.databaseName,
-    @required this.username,
+    required this.host,
+    required this.port,
+    required this.databaseName,
+    required this.username,
     this.password,
   })  : assert(host != null),
         assert(port != null),
@@ -22,7 +22,7 @@ class DatabaseConfig {
   factory DatabaseConfig.fromJson(Map<String, dynamic> json) =>
       _$DatabaseConfigFromJson(json);
 
-  factory DatabaseConfig.fromEnvironment({DatabaseConfig defaults}) =>
+  factory DatabaseConfig.fromEnvironment({DatabaseConfig? defaults}) =>
       DatabaseConfig.fromJson(_jsonFromEnvironment(defaults));
 
   static final defaults = DatabaseConfig.fromJson(<String, dynamic>{});
@@ -39,12 +39,12 @@ class DatabaseConfig {
   @JsonKey(defaultValue: 'authpass')
   final String username;
   @JsonKey(defaultValue: 'blubb')
-  final String password;
+  final String? password;
 
   DatabaseConfig copyWith({
-    String host,
-    int port,
-    String databaseName,
+    String? host,
+    int? port,
+    String? databaseName,
   }) =>
       DatabaseConfig(
         host: host ?? this.host,
@@ -55,7 +55,7 @@ class DatabaseConfig {
       );
 }
 
-Map<String, dynamic> _jsonFromEnvironment(DatabaseConfig defaults) {
+Map<String, dynamic> _jsonFromEnvironment(DatabaseConfig? defaults) {
   final defaultJson = defaults?.toJson() ?? <String, dynamic>{};
   final dbConfig = Platform.environment['DBCONFIG'];
   if (dbConfig != null) {

lib/src/config.dart

@@ -17,7 +17,7 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
   final TABLES tables;
   static final columnNamePattern = RegExp(r'^[a-z_]+$');
 
-  void _assertColumnNames(Map<String, Object> values) {
+  void _assertColumnNames(Map<String, Object?> values) {
     assert((() {
       for (final key in values.keys) {
         if (!columnNamePattern.hasMatch(key)) {
@@ -49,8 +49,8 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
 
   Future<int> executeUpdate(
     String table, {
-    @required Map<String, Object> set,
-    @required Map<String, Object> where,
+    required Map<String, Object?> set,
+    required Map<String, Object> where,
     bool setContainsOptional = false,
   }) async {
     assert(set != null);
@@ -78,14 +78,14 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
 
   /// Removes entries in [values] which have a `null` value, and replaces
   /// all [Optional] values with their actual value.
-  Map<String, Object> flattenOptionals(Map<String, Object> values) {
-    Object unwrap(Object value) => value is Optional ? value.orNull : value;
+  Map<String, Object?> flattenOptionals(Map<String, Object?> values) {
+    Object? unwrap(Object? value) => value is Optional ? value.orNull : value;
     return Map.fromEntries(values.entries
         .where((element) => element.value != null)
         .map((e) => MapEntry(e.key, unwrap(e.value))));
   }
 
-  bool _assertCorrectValues(Map<String, Object> values) {
+  bool _assertCorrectValues(Map<String, Object?>? values) {
     if (values == null) {
       return true;
     }
@@ -103,9 +103,9 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
 
   Future<int> execute(
     String fmtString, {
-    Map<String, Object> values,
-    int timeoutInSeconds,
-    int expectedResultCount,
+    Map<String, Object?>? values,
+    int? timeoutInSeconds,
+    int? expectedResultCount,
   }) async {
     try {
       assert(_assertCorrectValues(values));
@@ -126,9 +126,9 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
   }
 
   Future<PostgreSQLResult> query(String fmtString,
-      {Map<String, Object> values,
-      bool allowReuse,
-      int timeoutInSeconds}) async {
+      {Map<String, Object>? values,
+      bool? allowReuse,
+      int? timeoutInSeconds}) async {
     assert(_assertCorrectValues(values));
     return _conn.query(fmtString,
         substitutionValues: values,
@@ -146,9 +146,9 @@ class CustomBind {
 abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
     TABLES extends TablesBase> {
   DatabaseAccessBase({
-    @required this.config,
-    @required this.tables,
-    @required this.migrations,
+    required this.config,
+    required this.tables,
+    required this.migrations,
   })  : assert(config != null),
         assert(tables != null),
         assert(migrations != null);
@@ -157,11 +157,11 @@ abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
   final DatabaseConfig config;
   final MigrationsProvider<TX, TABLES> migrations;
 
-  PostgreSQLConnection _conn;
+  PostgreSQLConnection? _conn;
 
   Future<PostgreSQLConnection> _connection() async {
     if (_conn != null) {
-      return _conn;
+      return _conn!;
     }
     final conn = PostgreSQLConnection(
       config.host,
@@ -185,7 +185,7 @@ abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
   }
 
   Future<void> dispose() async {
-    await _conn.close();
+    await _conn!.close();
     _conn = null;
   }
 
@@ -229,7 +229,7 @@ abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
 
     final migrationRun = clock.now().toUtc();
     await run((conn) async {
-      final migrations = this.migrations.migrations;
+      final List<Migrations<TX, TABLES>> migrations = this.migrations.migrations;
       for (final migration in migrations) {
         if (migration.id > lastMigration) {
           _logger.fine('Running migration ${migration.id} '
@@ -315,9 +315,9 @@ abstract class MigrationsProvider<TX extends DatabaseTransactionBase<TABLES>,
 class Migrations<TX extends DatabaseTransactionBase<TABLES>,
     TABLES extends TablesBase> {
   Migrations({
-    @required this.id,
+    required this.id,
     this.versionCode = 'a',
-    @required this.up,
+    required this.up,
   })  : assert(id != null),
         assert(up != null);
 

lib/src/config.g.dart

@@ -22,13 +22,13 @@ abstract class TableConstants {
 }
 
 extension FuturePostgreSQL on Future<PostgreSQLResult> {
-  Future<T> singleOrNull<T>(FutureOr<T> Function(PostgreSQLResultRow row) cb) =>
-      then((value) => value.singleOrNull(cb));
+  Future<T?> singleOrNull<T>(FutureOr<T> Function(PostgreSQLResultRow row) cb) =>
+      then((value) => value.singleOrNull(cb as T Function(PostgreSQLResultRow)));
   Future<PostgreSQLResultRow> get single => then((value) => value.single);
 }
 
 extension PostgreSQLResultExt on PostgreSQLResult {
-  T singleOrNull<T>(T Function(PostgreSQLResultRow row) cb) {
+  T? singleOrNull<T>(T Function(PostgreSQLResultRow row) cb) {
     if (isEmpty) {
       return null;
     }

lib/src/database_access.dart

@@ -35,7 +35,7 @@ class MigrationTable extends TableBase with TableConstants {
   Future<int> queryLastVersion(DatabaseTransactionBase connection) async {
     final result = await connection
         .query('SELECT MAX($_TABLE_MIGRATE_VERSION) FROM $_TABLE_MIGRATE');
-    final maxVersion = result.first[0] as int;
+    final maxVersion = result.first[0] as int?;
     _logger.finer('Migration version: $maxVersion');
     return maxVersion ?? 0;
   }
@@ -52,9 +52,9 @@ class MigrationTable extends TableBase with TableConstants {
 
 class MigrationEntity {
   MigrationEntity({
-    @required this.version,
-    @required this.versionCode,
-    @required this.appliedAt,
+    required this.version,
+    required this.versionCode,
+    required this.appliedAt,
   });
   final int version;
   final String versionCode;

lib/src/tables/base_tables.dart

@@ -4,18 +4,18 @@ description: A starting point for Dart libraries or applications.
 # homepage: https://www.example.com
 
 environment:
-  sdk: '>=2.8.1 <3.0.0'
+  sdk: '>=2.12.0 <3.0.0'
 
 dependencies:
-  quiver: ^2.1.3
-  meta: ^1.2.2
-  clock: ^1.0.1
-  logging: ^0.11.4
-  postgres: ^2.1.1
-  json_annotation: ^3.0.1
+  quiver: ^3.0.0
+  meta: ^1.3.0
+  clock: ^1.1.0
+  logging: ^1.0.0
+  postgres: ^2.3.0
+  json_annotation: ^4.0.1
 
 dev_dependencies:
-  json_serializable: ^3.3.0
-  pedantic: ^1.9.2
-  test: ^1.15.3
+  json_serializable: ^4.1.0
+  pedantic: ^1.11.0
+  test: ^1.16.8
   build_runner: ^1.10.0