From 84bac1bf1da65eecc6226a835e1272cc89925a09 Mon Sep 17 00:00:00 2001 From: Simon Binder Date: Fri, 17 Apr 2020 20:48:22 +0200 Subject: [PATCH] Initial support for sql expressions in companions --- moor/CHANGELOG.md | 1 + moor/example/example.g.dart | 48 ++++++++++++ moor/lib/src/runtime/data_class.dart | 22 ++++++ .../query_builder/expressions/variables.dart | 6 ++ moor/test/data/tables/custom_tables.g.dart | 68 +++++++++++++++++ moor/test/data/tables/todos.g.dart | 74 +++++++++++++++++++ moor/test/insert_test.dart | 16 ++++ .../tables/update_companion_writer.dart | 35 +++++++++ 8 files changed, 270 insertions(+) diff --git a/moor/CHANGELOG.md b/moor/CHANGELOG.md index 1bb88706..e0473afd 100644 --- a/moor/CHANGELOG.md +++ b/moor/CHANGELOG.md @@ -30,6 +30,7 @@ - New feature: Nested results for compiled queries ([#288](https://github.com/simolus3/moor/issues/288)) See the [documentation](https://moor.simonbinder.eu/docs/using-sql/moor_files/#nested-results) for details on how and when to use this feature. +- New feature: Use sql expressions for inserts with `Companion.custom`. ## 2.4.1 diff --git a/moor/example/example.g.dart b/moor/example/example.g.dart index 52e9da46..130ed70a 100644 --- a/moor/example/example.g.dart +++ b/moor/example/example.g.dart @@ -90,6 +90,16 @@ class CategoriesCompanion extends UpdateCompanion { this.id = const Value.absent(), this.description = const Value.absent(), }); + static Insertable custom({ + Expression id, + Expression description, + }) { + return RawValuesInsertable({ + if (id != null) 'id': id, + if (description != null) 'description': description, + }); + } + CategoriesCompanion copyWith({Value id, Value description}) { return CategoriesCompanion( id: id ?? this.id, @@ -294,6 +304,20 @@ class RecipesCompanion extends UpdateCompanion { this.category = const Value.absent(), }) : title = Value(title), instructions = Value(instructions); + static Insertable custom({ + Expression id, + Expression title, + Expression instructions, + Expression category, + }) { + return RawValuesInsertable({ + if (id != null) 'id': id, + if (title != null) 'title': title, + if (instructions != null) 'instructions': instructions, + if (category != null) 'category': category, + }); + } + RecipesCompanion copyWith( {Value id, Value title, @@ -523,6 +547,18 @@ class IngredientsCompanion extends UpdateCompanion { @required int caloriesPer100g, }) : name = Value(name), caloriesPer100g = Value(caloriesPer100g); + static Insertable custom({ + Expression id, + Expression name, + Expression caloriesPer100g, + }) { + return RawValuesInsertable({ + if (id != null) 'id': id, + if (name != null) 'name': name, + if (caloriesPer100g != null) 'calories': caloriesPer100g, + }); + } + IngredientsCompanion copyWith( {Value id, Value name, Value caloriesPer100g}) { return IngredientsCompanion( @@ -741,6 +777,18 @@ class IngredientInRecipesCompanion extends UpdateCompanion { }) : recipe = Value(recipe), ingredient = Value(ingredient), amountInGrams = Value(amountInGrams); + static Insertable custom({ + Expression recipe, + Expression ingredient, + Expression amountInGrams, + }) { + return RawValuesInsertable({ + if (recipe != null) 'recipe': recipe, + if (ingredient != null) 'ingredient': ingredient, + if (amountInGrams != null) 'amount': amountInGrams, + }); + } + IngredientInRecipesCompanion copyWith( {Value recipe, Value ingredient, Value amountInGrams}) { return IngredientInRecipesCompanion( diff --git a/moor/lib/src/runtime/data_class.dart b/moor/lib/src/runtime/data_class.dart index 73e2563c..7a12f9e5 100644 --- a/moor/lib/src/runtime/data_class.dart +++ b/moor/lib/src/runtime/data_class.dart @@ -61,6 +61,28 @@ abstract class UpdateCompanion implements Insertable { const UpdateCompanion(); } +/// An [Insertable] implementation based on raw column expressions. +/// +/// Mostly used in generated code. +class RawValuesInsertable implements Insertable { + /// A map from column names to a value that should be inserted or updated. + /// + /// See also: + /// - [toColumns], which returns [data] in a [RawValuesInsertable] + final Map data; + + /// Creates a [RawValuesInsertable] based on the [data] to insert or update. + const RawValuesInsertable(this.data); + + @override + Map toColumns(bool nullToAbsent) => data; + + @override + String toString() { + return 'RawValuesInsertable($data)'; + } +} + /// A wrapper around arbitrary data [T] to indicate presence or absence /// explicitly. We can use [Value]s in companions to distinguish between null /// and absent values. diff --git a/moor/lib/src/runtime/query_builder/expressions/variables.dart b/moor/lib/src/runtime/query_builder/expressions/variables.dart index 58f36384..8e1b8aec 100644 --- a/moor/lib/src/runtime/query_builder/expressions/variables.dart +++ b/moor/lib/src/runtime/query_builder/expressions/variables.dart @@ -65,6 +65,9 @@ class Variable extends Expression { context.buffer.write('NULL'); } } + + @override + String toString() => 'Variable($value)'; } /// An expression that represents the value of a dart object encoded to sql @@ -98,4 +101,7 @@ class Constant extends Expression { // ignore: test_types_in_equals (other as Constant).value == value; } + + @override + String toString() => 'Constant($value)'; } diff --git a/moor/test/data/tables/custom_tables.g.dart b/moor/test/data/tables/custom_tables.g.dart index e8befedb..c7b67c01 100644 --- a/moor/test/data/tables/custom_tables.g.dart +++ b/moor/test/data/tables/custom_tables.g.dart @@ -107,6 +107,18 @@ class ConfigCompanion extends UpdateCompanion { this.configValue = const Value.absent(), this.syncState = const Value.absent(), }) : configKey = Value(configKey); + static Insertable custom({ + Expression configKey, + Expression configValue, + Expression syncState, + }) { + return RawValuesInsertable({ + if (configKey != null) 'config_key': configKey, + if (configValue != null) 'config_value': configValue, + if (syncState != null) 'sync_state': syncState, + }); + } + ConfigCompanion copyWith( {Value configKey, Value configValue, @@ -292,6 +304,16 @@ class WithDefaultsCompanion extends UpdateCompanion { this.a = const Value.absent(), this.b = const Value.absent(), }); + static Insertable custom({ + Expression a, + Expression b, + }) { + return RawValuesInsertable({ + if (a != null) 'a': a, + if (b != null) 'b': b, + }); + } + WithDefaultsCompanion copyWith({Value a, Value b}) { return WithDefaultsCompanion( a: a ?? this.a, @@ -437,6 +459,14 @@ class NoIdsCompanion extends UpdateCompanion { NoIdsCompanion.insert({ @required Uint8List payload, }) : payload = Value(payload); + static Insertable custom({ + Expression payload, + }) { + return RawValuesInsertable({ + if (payload != null) 'payload': payload, + }); + } + NoIdsCompanion copyWith({Value payload}) { return NoIdsCompanion( payload: payload ?? this.payload, @@ -603,6 +633,18 @@ class WithConstraintsCompanion extends UpdateCompanion { @required int b, this.c = const Value.absent(), }) : b = Value(b); + static Insertable custom({ + Expression a, + Expression b, + Expression c, + }) { + return RawValuesInsertable({ + if (a != null) 'a': a, + if (b != null) 'b': b, + if (c != null) 'c': c, + }); + } + WithConstraintsCompanion copyWith( {Value a, Value b, Value c}) { return WithConstraintsCompanion( @@ -819,6 +861,20 @@ class MytableCompanion extends UpdateCompanion { this.somebool = const Value.absent(), this.somedate = const Value.absent(), }); + static Insertable custom({ + Expression someid, + Expression sometext, + Expression somebool, + Expression somedate, + }) { + return RawValuesInsertable({ + if (someid != null) 'someid': someid, + if (sometext != null) 'sometext': sometext, + if (somebool != null) 'somebool': somebool, + if (somedate != null) 'somedate': somedate, + }); + } + MytableCompanion copyWith( {Value someid, Value sometext, @@ -1034,6 +1090,18 @@ class EmailCompanion extends UpdateCompanion { }) : sender = Value(sender), title = Value(title), body = Value(body); + static Insertable custom({ + Expression sender, + Expression title, + Expression body, + }) { + return RawValuesInsertable({ + if (sender != null) 'sender': sender, + if (title != null) 'title': title, + if (body != null) 'body': body, + }); + } + EmailCompanion copyWith( {Value sender, Value title, Value body}) { return EmailCompanion( diff --git a/moor/test/data/tables/todos.g.dart b/moor/test/data/tables/todos.g.dart index 1b3ec632..6bf80c5a 100644 --- a/moor/test/data/tables/todos.g.dart +++ b/moor/test/data/tables/todos.g.dart @@ -149,6 +149,22 @@ class TodosTableCompanion extends UpdateCompanion { this.targetDate = const Value.absent(), this.category = const Value.absent(), }) : content = Value(content); + static Insertable custom({ + Expression id, + Expression title, + Expression content, + Expression targetDate, + Expression category, + }) { + return RawValuesInsertable({ + if (id != null) 'id': id, + if (title != null) 'title': title, + if (content != null) 'content': content, + if (targetDate != null) 'target_date': targetDate, + if (category != null) 'category': category, + }); + } + TodosTableCompanion copyWith( {Value id, Value title, @@ -383,6 +399,16 @@ class CategoriesCompanion extends UpdateCompanion { this.id = const Value.absent(), @required String description, }) : description = Value(description); + static Insertable custom({ + Expression id, + Expression description, + }) { + return RawValuesInsertable({ + if (id != null) 'id': id, + if (description != null) 'desc': description, + }); + } + CategoriesCompanion copyWith({Value id, Value description}) { return CategoriesCompanion( id: id ?? this.id, @@ -610,6 +636,22 @@ class UsersCompanion extends UpdateCompanion { this.creationTime = const Value.absent(), }) : name = Value(name), profilePicture = Value(profilePicture); + static Insertable custom({ + Expression id, + Expression name, + Expression isAwesome, + Expression profilePicture, + Expression creationTime, + }) { + return RawValuesInsertable({ + if (id != null) 'id': id, + if (name != null) 'name': name, + if (isAwesome != null) 'is_awesome': isAwesome, + if (profilePicture != null) 'profile_picture': profilePicture, + if (creationTime != null) 'creation_time': creationTime, + }); + } + UsersCompanion copyWith( {Value id, Value name, @@ -843,6 +885,16 @@ class SharedTodosCompanion extends UpdateCompanion { @required int user, }) : todo = Value(todo), user = Value(user); + static Insertable custom({ + Expression todo, + Expression user, + }) { + return RawValuesInsertable({ + if (todo != null) 'todo': todo, + if (user != null) 'user': user, + }); + } + SharedTodosCompanion copyWith({Value todo, Value user}) { return SharedTodosCompanion( todo: todo ?? this.todo, @@ -1043,6 +1095,18 @@ class TableWithoutPKCompanion extends UpdateCompanion { this.custom = const Value.absent(), }) : notReallyAnId = Value(notReallyAnId), someFloat = Value(someFloat); + static Insertable createCustom({ + Expression notReallyAnId, + Expression someFloat, + Expression custom, + }) { + return RawValuesInsertable({ + if (notReallyAnId != null) 'not_really_an_id': notReallyAnId, + if (someFloat != null) 'some_float': someFloat, + if (custom != null) 'custom': custom, + }); + } + TableWithoutPKCompanion copyWith( {Value notReallyAnId, Value someFloat, @@ -1242,6 +1306,16 @@ class PureDefaultsCompanion extends UpdateCompanion { this.id = const Value.absent(), this.txt = const Value.absent(), }); + static Insertable custom({ + Expression id, + Expression txt, + }) { + return RawValuesInsertable({ + if (id != null) 'id': id, + if (txt != null) 'insert': txt, + }); + } + PureDefaultsCompanion copyWith({Value id, Value txt}) { return PureDefaultsCompanion( id: id ?? this.id, diff --git a/moor/test/insert_test.dart b/moor/test/insert_test.dart index 87ffea47..651a2e14 100644 --- a/moor/test/insert_test.dart +++ b/moor/test/insert_test.dart @@ -129,4 +129,20 @@ void main() { verify(executor .runInsert('INSERT INTO pure_defaults (`insert`) VALUES (?)', ['foo'])); }); + + test('can insert custom companions', () async { + await db.into(db.users).insert(UsersCompanion.custom( + isAwesome: const Constant(true), + name: const Variable('User name'), + profilePicture: const CustomExpression('_custom_'), + creationTime: currentDateAndTime)); + + verify( + executor.runInsert( + 'INSERT INTO users (name, is_awesome, profile_picture, creation_time) ' + "VALUES (?, 1, _custom_, strftime('%s', CURRENT_TIMESTAMP))", + ['User name'], + ), + ); + }); } diff --git a/moor_generator/lib/src/writer/tables/update_companion_writer.dart b/moor_generator/lib/src/writer/tables/update_companion_writer.dart index 08e67354..ff881c96 100644 --- a/moor_generator/lib/src/writer/tables/update_companion_writer.dart +++ b/moor_generator/lib/src/writer/tables/update_companion_writer.dart @@ -16,8 +16,11 @@ class UpdateCompanionWriter { _buffer.write('class ${table.getNameForCompanionClass(scope.options)} ' 'extends UpdateCompanion<${table.dartTypeName}> {\n'); _writeFields(); + _writeConstructor(); _writeInsertConstructor(); + _writeCustomConstructor(); + _writeCopyWith(); _writeToColumnsOverride(); @@ -87,6 +90,38 @@ class UpdateCompanionWriter { _buffer.write(';\n'); } + void _writeCustomConstructor() { + // Prefer a .custom constructor, unless there already is a field called + // "custom", in which case we'll use createCustom + final constructorName = table.columns + .map((e) => e.dartGetterName) + .any((name) => name == 'custom') + ? 'createCustom' + : 'custom'; + + _buffer + ..write('static Insertable<${table.dartTypeName}> $constructorName') + ..write('({'); + + for (final column in table.columns) { + _buffer + ..write('Expression<${column.variableTypeName}> ') + ..write(column.dartGetterName) + ..write(',\n'); + } + + _buffer..write('}) {\n')..write('return RawValuesInsertable({'); + + for (final column in table.columns) { + _buffer + ..write('if (${column.dartGetterName} != null)') + ..write(asDartLiteral(column.name.name)) + ..write(': ${column.dartGetterName},'); + } + + _buffer.write('});\n}'); + } + void _writeCopyWith() { _buffer ..write(table.getNameForCompanionClass(scope.options))