Initial support for sql expressions in companions

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
 

moor/example/example.g.dart

@@ -90,6 +90,16 @@ class CategoriesCompanion extends UpdateCompanion<Category> {
     this.id = const Value.absent(),
     this.description = const Value.absent(),
   });
+  static Insertable<Category> custom({
+    Expression<int> id,
+    Expression<String> description,
+  }) {
+    return RawValuesInsertable({
+      if (id != null) 'id': id,
+      if (description != null) 'description': description,
+    });
+  }
+
   CategoriesCompanion copyWith({Value<int> id, Value<String> description}) {
     return CategoriesCompanion(
       id: id ?? this.id,
@@ -294,6 +304,20 @@ class RecipesCompanion extends UpdateCompanion<Recipe> {
     this.category = const Value.absent(),
   })  : title = Value(title),
         instructions = Value(instructions);
+  static Insertable<Recipe> custom({
+    Expression<int> id,
+    Expression<String> title,
+    Expression<String> instructions,
+    Expression<int> 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<int> id,
       Value<String> title,
@@ -523,6 +547,18 @@ class IngredientsCompanion extends UpdateCompanion<Ingredient> {
     @required int caloriesPer100g,
   })  : name = Value(name),
         caloriesPer100g = Value(caloriesPer100g);
+  static Insertable<Ingredient> custom({
+    Expression<int> id,
+    Expression<String> name,
+    Expression<int> caloriesPer100g,
+  }) {
+    return RawValuesInsertable({
+      if (id != null) 'id': id,
+      if (name != null) 'name': name,
+      if (caloriesPer100g != null) 'calories': caloriesPer100g,
+    });
+  }
+
   IngredientsCompanion copyWith(
       {Value<int> id, Value<String> name, Value<int> caloriesPer100g}) {
     return IngredientsCompanion(
@@ -741,6 +777,18 @@ class IngredientInRecipesCompanion extends UpdateCompanion<IngredientInRecipe> {
   })  : recipe = Value(recipe),
         ingredient = Value(ingredient),
         amountInGrams = Value(amountInGrams);
+  static Insertable<IngredientInRecipe> custom({
+    Expression<int> recipe,
+    Expression<int> ingredient,
+    Expression<int> amountInGrams,
+  }) {
+    return RawValuesInsertable({
+      if (recipe != null) 'recipe': recipe,
+      if (ingredient != null) 'ingredient': ingredient,
+      if (amountInGrams != null) 'amount': amountInGrams,
+    });
+  }
+
   IngredientInRecipesCompanion copyWith(
       {Value<int> recipe, Value<int> ingredient, Value<int> amountInGrams}) {
     return IngredientInRecipesCompanion(

moor/lib/src/runtime/data_class.dart

@@ -61,6 +61,28 @@ abstract class UpdateCompanion<D extends DataClass> implements Insertable<D> {
   const UpdateCompanion();
 }
 
+/// An [Insertable] implementation based on raw column expressions.
+///
+/// Mostly used in generated code.
+class RawValuesInsertable<D extends DataClass> implements Insertable<D> {
+  /// 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<String, Expression> data;
+
+  /// Creates a [RawValuesInsertable] based on the [data] to insert or update.
+  const RawValuesInsertable(this.data);
+
+  @override
+  Map<String, Expression> 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.

moor/lib/src/runtime/query_builder/expressions/variables.dart

@@ -65,6 +65,9 @@ class Variable<T> extends Expression<T> {
       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<T> extends Expression<T> {
         // ignore: test_types_in_equals
         (other as Constant<T>).value == value;
   }
+
+  @override
+  String toString() => 'Constant($value)';
 }

moor/test/data/tables/custom_tables.g.dart

@@ -107,6 +107,18 @@ class ConfigCompanion extends UpdateCompanion<Config> {
     this.configValue = const Value.absent(),
     this.syncState = const Value.absent(),
   }) : configKey = Value(configKey);
+  static Insertable<Config> custom({
+    Expression<String> configKey,
+    Expression<String> configValue,
+    Expression<int> syncState,
+  }) {
+    return RawValuesInsertable({
+      if (configKey != null) 'config_key': configKey,
+      if (configValue != null) 'config_value': configValue,
+      if (syncState != null) 'sync_state': syncState,
+    });
+  }
+
   ConfigCompanion copyWith(
       {Value<String> configKey,
       Value<String> configValue,
@@ -292,6 +304,16 @@ class WithDefaultsCompanion extends UpdateCompanion<WithDefault> {
     this.a = const Value.absent(),
     this.b = const Value.absent(),
   });
+  static Insertable<WithDefault> custom({
+    Expression<String> a,
+    Expression<int> b,
+  }) {
+    return RawValuesInsertable({
+      if (a != null) 'a': a,
+      if (b != null) 'b': b,
+    });
+  }
+
   WithDefaultsCompanion copyWith({Value<String> a, Value<int> b}) {
     return WithDefaultsCompanion(
       a: a ?? this.a,
@@ -437,6 +459,14 @@ class NoIdsCompanion extends UpdateCompanion<NoId> {
   NoIdsCompanion.insert({
     @required Uint8List payload,
   }) : payload = Value(payload);
+  static Insertable<NoId> custom({
+    Expression<Uint8List> payload,
+  }) {
+    return RawValuesInsertable({
+      if (payload != null) 'payload': payload,
+    });
+  }
+
   NoIdsCompanion copyWith({Value<Uint8List> payload}) {
     return NoIdsCompanion(
       payload: payload ?? this.payload,
@@ -603,6 +633,18 @@ class WithConstraintsCompanion extends UpdateCompanion<WithConstraint> {
     @required int b,
     this.c = const Value.absent(),
   }) : b = Value(b);
+  static Insertable<WithConstraint> custom({
+    Expression<String> a,
+    Expression<int> b,
+    Expression<double> c,
+  }) {
+    return RawValuesInsertable({
+      if (a != null) 'a': a,
+      if (b != null) 'b': b,
+      if (c != null) 'c': c,
+    });
+  }
+
   WithConstraintsCompanion copyWith(
       {Value<String> a, Value<int> b, Value<double> c}) {
     return WithConstraintsCompanion(
@@ -819,6 +861,20 @@ class MytableCompanion extends UpdateCompanion<MytableData> {
     this.somebool = const Value.absent(),
     this.somedate = const Value.absent(),
   });
+  static Insertable<MytableData> custom({
+    Expression<int> someid,
+    Expression<String> sometext,
+    Expression<bool> somebool,
+    Expression<DateTime> 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<int> someid,
       Value<String> sometext,
@@ -1034,6 +1090,18 @@ class EmailCompanion extends UpdateCompanion<EMail> {
   })  : sender = Value(sender),
         title = Value(title),
         body = Value(body);
+  static Insertable<EMail> custom({
+    Expression<String> sender,
+    Expression<String> title,
+    Expression<String> body,
+  }) {
+    return RawValuesInsertable({
+      if (sender != null) 'sender': sender,
+      if (title != null) 'title': title,
+      if (body != null) 'body': body,
+    });
+  }
+
   EmailCompanion copyWith(
       {Value<String> sender, Value<String> title, Value<String> body}) {
     return EmailCompanion(

moor/test/data/tables/todos.g.dart

@@ -149,6 +149,22 @@ class TodosTableCompanion extends UpdateCompanion<TodoEntry> {
     this.targetDate = const Value.absent(),
     this.category = const Value.absent(),
   }) : content = Value(content);
+  static Insertable<TodoEntry> custom({
+    Expression<int> id,
+    Expression<String> title,
+    Expression<String> content,
+    Expression<DateTime> targetDate,
+    Expression<int> 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<int> id,
       Value<String> title,
@@ -383,6 +399,16 @@ class CategoriesCompanion extends UpdateCompanion<Category> {
     this.id = const Value.absent(),
     @required String description,
   }) : description = Value(description);
+  static Insertable<Category> custom({
+    Expression<int> id,
+    Expression<String> description,
+  }) {
+    return RawValuesInsertable({
+      if (id != null) 'id': id,
+      if (description != null) 'desc': description,
+    });
+  }
+
   CategoriesCompanion copyWith({Value<int> id, Value<String> description}) {
     return CategoriesCompanion(
       id: id ?? this.id,
@@ -610,6 +636,22 @@ class UsersCompanion extends UpdateCompanion<User> {
     this.creationTime = const Value.absent(),
   })  : name = Value(name),
         profilePicture = Value(profilePicture);
+  static Insertable<User> custom({
+    Expression<int> id,
+    Expression<String> name,
+    Expression<bool> isAwesome,
+    Expression<Uint8List> profilePicture,
+    Expression<DateTime> 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<int> id,
       Value<String> name,
@@ -843,6 +885,16 @@ class SharedTodosCompanion extends UpdateCompanion<SharedTodo> {
     @required int user,
   })  : todo = Value(todo),
         user = Value(user);
+  static Insertable<SharedTodo> custom({
+    Expression<int> todo,
+    Expression<int> user,
+  }) {
+    return RawValuesInsertable({
+      if (todo != null) 'todo': todo,
+      if (user != null) 'user': user,
+    });
+  }
+
   SharedTodosCompanion copyWith({Value<int> todo, Value<int> user}) {
     return SharedTodosCompanion(
       todo: todo ?? this.todo,
@@ -1043,6 +1095,18 @@ class TableWithoutPKCompanion extends UpdateCompanion<TableWithoutPKData> {
     this.custom = const Value.absent(),
   })  : notReallyAnId = Value(notReallyAnId),
         someFloat = Value(someFloat);
+  static Insertable<TableWithoutPKData> createCustom({
+    Expression<int> notReallyAnId,
+    Expression<double> someFloat,
+    Expression<String> 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<int> notReallyAnId,
       Value<double> someFloat,
@@ -1242,6 +1306,16 @@ class PureDefaultsCompanion extends UpdateCompanion<PureDefault> {
     this.id = const Value.absent(),
     this.txt = const Value.absent(),
   });
+  static Insertable<PureDefault> custom({
+    Expression<int> id,
+    Expression<String> txt,
+  }) {
+    return RawValuesInsertable({
+      if (id != null) 'id': id,
+      if (txt != null) 'insert': txt,
+    });
+  }
+
   PureDefaultsCompanion copyWith({Value<int> id, Value<String> txt}) {
     return PureDefaultsCompanion(
       id: id ?? this.id,

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'],
+      ),
+    );
+  });
 }

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))