Support includes on the @UseDao annotation as well

.gitattributes

@@ -0,0 +1 @@
+*.moor linguist-language=SQL

moor/lib/src/dsl/database.dart

@@ -44,10 +44,12 @@ class UseMoor {
   /// {@endtemplate}
   final Map<String, String> queries;
 
+  /// {@template moor_include_param}
   /// Defines the `.moor` files to include when building the table structure for
   /// this database.
   ///
   /// Please note that this feature is experimental at the moment.
+  /// {@endtemplate}
   @experimental
   final Set<String> include;
 
@@ -87,8 +89,14 @@ class UseDao {
   final List<Type> tables;
 
   /// {@macro moor_compile_queries_param}
-  @experimental
   final Map<String, String> queries;
 
-  const UseDao({@required this.tables, @experimental this.queries = const {}});
+  /// {@macro moor_include_param}
+  @experimental
+  final Set<String> include;
+
+  const UseDao(
+      {@required this.tables,
+      this.queries = const {},
+      @experimental this.include = const {}});
 }

moor/test/data/tables/test.moor

@@ -1,4 +1,4 @@
-CREATE TABLE state (
+CREATE TABLE states (
     id INT NOT NULL PRIMARY KEY AUTOINCREMENT,
     name TEXT NOT NULL
 );
@@ -6,5 +6,5 @@ CREATE TABLE state (
 CREATE TABLE experiments (
     id INT NOT NULL PRIMARY KEY AUTOINCREMENT,
     description TEXT NOT NULL,
-    state INT REFERENCES state(id) ON UPDATE CASCADE ON DELETE SET NULL
+    state INT REFERENCES states(id) ON UPDATE CASCADE ON DELETE SET NULL
 )

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

@@ -1187,23 +1187,23 @@ class $PureDefaultsTable extends PureDefaults
   }
 }
 
-class StateData extends DataClass implements Insertable<StateData> {
+class State extends DataClass implements Insertable<State> {
   final int id;
   final String name;
-  StateData({@required this.id, @required this.name});
-  factory StateData.fromData(Map<String, dynamic> data, GeneratedDatabase db,
+  State({@required this.id, @required this.name});
+  factory State.fromData(Map<String, dynamic> data, GeneratedDatabase db,
       {String prefix}) {
     final effectivePrefix = prefix ?? '';
     final intType = db.typeSystem.forDartType<int>();
     final stringType = db.typeSystem.forDartType<String>();
-    return StateData(
+    return State(
       id: intType.mapFromDatabaseResponse(data['${effectivePrefix}id']),
       name: stringType.mapFromDatabaseResponse(data['${effectivePrefix}name']),
     );
   }
-  factory StateData.fromJson(Map<String, dynamic> json,
+  factory State.fromJson(Map<String, dynamic> json,
       {ValueSerializer serializer = const ValueSerializer.defaults()}) {
-    return StateData(
+    return State(
       id: serializer.fromJson<int>(json['id']),
       name: serializer.fromJson<String>(json['name']),
     );
@@ -1218,20 +1218,20 @@ class StateData extends DataClass implements Insertable<StateData> {
   }
 
   @override
-  T createCompanion<T extends UpdateCompanion<StateData>>(bool nullToAbsent) {
-    return StateCompanion(
+  T createCompanion<T extends UpdateCompanion<State>>(bool nullToAbsent) {
+    return StatesCompanion(
       id: id == null && nullToAbsent ? const Value.absent() : Value(id),
       name: name == null && nullToAbsent ? const Value.absent() : Value(name),
     ) as T;
   }
 
-  StateData copyWith({int id, String name}) => StateData(
+  State copyWith({int id, String name}) => State(
         id: id ?? this.id,
         name: name ?? this.name,
       );
   @override
   String toString() {
-    return (StringBuffer('StateData(')
+    return (StringBuffer('State(')
           ..write('id: $id, ')
           ..write('name: $name')
           ..write(')'))
@@ -1243,25 +1243,24 @@ class StateData extends DataClass implements Insertable<StateData> {
   @override
   bool operator ==(other) =>
       identical(this, other) ||
-      (other is StateData && other.id == id && other.name == name);
+      (other is State && other.id == id && other.name == name);
 }
 
-class StateCompanion extends UpdateCompanion<StateData> {
+class StatesCompanion extends UpdateCompanion<State> {
   final Value<int> id;
   final Value<String> name;
-  const StateCompanion({
+  const StatesCompanion({
     this.id = const Value.absent(),
     this.name = const Value.absent(),
   });
 }
 
-class $StateTable extends Table with TableInfo<$StateTable, StateData> {
+class States extends Table with TableInfo<States, State> {
   final GeneratedDatabase _db;
   final String _alias;
-  $StateTable(this._db, [this._alias]);
+  States(this._db, [this._alias]);
   final VerificationMeta _idMeta = const VerificationMeta('id');
   GeneratedIntColumn _id;
-  @override
   GeneratedIntColumn get id => _id ??= _constructId();
   GeneratedIntColumn _constructId() {
     return GeneratedIntColumn('id', $tableName, false,
@@ -1271,7 +1270,6 @@ class $StateTable extends Table with TableInfo<$StateTable, StateData> {
 
   final VerificationMeta _nameMeta = const VerificationMeta('name');
   GeneratedTextColumn _name;
-  @override
   GeneratedTextColumn get name => _name ??= _constructName();
   GeneratedTextColumn _constructName() {
     return GeneratedTextColumn('name', $tableName, false,
@@ -1281,13 +1279,13 @@ class $StateTable extends Table with TableInfo<$StateTable, StateData> {
   @override
   List<GeneratedColumn> get $columns => [id, name];
   @override
-  $StateTable get asDslTable => this;
+  States get asDslTable => this;
   @override
-  String get $tableName => _alias ?? 'state';
+  String get $tableName => _alias ?? 'states';
   @override
-  final String actualTableName = 'state';
+  final String actualTableName = 'states';
   @override
-  VerificationContext validateIntegrity(StateCompanion d,
+  VerificationContext validateIntegrity(StatesCompanion d,
       {bool isInserting = false}) {
     final context = VerificationContext();
     if (d.id.present) {
@@ -1307,13 +1305,13 @@ class $StateTable extends Table with TableInfo<$StateTable, StateData> {
   @override
   Set<GeneratedColumn> get $primaryKey => {id};
   @override
-  StateData map(Map<String, dynamic> data, {String tablePrefix}) {
+  State map(Map<String, dynamic> data, {String tablePrefix}) {
     final effectivePrefix = tablePrefix != null ? '$tablePrefix.' : null;
-    return StateData.fromData(data, _db, prefix: effectivePrefix);
+    return State.fromData(data, _db, prefix: effectivePrefix);
   }
 
   @override
-  Map<String, Variable> entityToSql(StateCompanion d) {
+  Map<String, Variable> entityToSql(StatesCompanion d) {
     final map = <String, Variable>{};
     if (d.id.present) {
       map['id'] = Variable<int, IntType>(d.id.value);
@@ -1325,8 +1323,8 @@ class $StateTable extends Table with TableInfo<$StateTable, StateData> {
   }
 
   @override
-  $StateTable createAlias(String alias) {
-    return $StateTable(_db, alias);
+  States createAlias(String alias) {
+    return States(_db, alias);
   }
 }
 
@@ -1415,14 +1413,12 @@ class ExperimentsCompanion extends UpdateCompanion<Experiment> {
   });
 }
 
-class $ExperimentsTable extends Table
-    with TableInfo<$ExperimentsTable, Experiment> {
+class Experiments extends Table with TableInfo<Experiments, Experiment> {
   final GeneratedDatabase _db;
   final String _alias;
-  $ExperimentsTable(this._db, [this._alias]);
+  Experiments(this._db, [this._alias]);
   final VerificationMeta _idMeta = const VerificationMeta('id');
   GeneratedIntColumn _id;
-  @override
   GeneratedIntColumn get id => _id ??= _constructId();
   GeneratedIntColumn _constructId() {
     return GeneratedIntColumn('id', $tableName, false,
@@ -1433,7 +1429,6 @@ class $ExperimentsTable extends Table
   final VerificationMeta _descriptionMeta =
       const VerificationMeta('description');
   GeneratedTextColumn _description;
-  @override
   GeneratedTextColumn get description =>
       _description ??= _constructDescription();
   GeneratedTextColumn _constructDescription() {
@@ -1443,18 +1438,17 @@ class $ExperimentsTable extends Table
 
   final VerificationMeta _stateMeta = const VerificationMeta('state');
   GeneratedIntColumn _state;
-  @override
   GeneratedIntColumn get state => _state ??= _constructState();
   GeneratedIntColumn _constructState() {
     return GeneratedIntColumn('state', $tableName, true,
         $customConstraints:
-            'REFERENCES state(id) ON UPDATE CASCADE ON DELETE SET NULL');
+            'REFERENCES states(id) ON UPDATE CASCADE ON DELETE SET NULL');
   }
 
   @override
   List<GeneratedColumn> get $columns => [id, description, state];
   @override
-  $ExperimentsTable get asDslTable => this;
+  Experiments get asDslTable => this;
   @override
   String get $tableName => _alias ?? 'experiments';
   @override
@@ -1507,8 +1501,8 @@ class $ExperimentsTable extends Table
   }
 
   @override
-  $ExperimentsTable createAlias(String alias) {
-    return $ExperimentsTable(_db, alias);
+  Experiments createAlias(String alias) {
+    return Experiments(_db, alias);
   }
 }
 
@@ -1554,10 +1548,10 @@ abstract class _$TodoDb extends GeneratedDatabase {
   $PureDefaultsTable _pureDefaults;
   $PureDefaultsTable get pureDefaults =>
       _pureDefaults ??= $PureDefaultsTable(this);
-  $StateTable _state;
-  $StateTable get state => _state ??= $StateTable(this);
-  $ExperimentsTable _experiments;
-  $ExperimentsTable get experiments => _experiments ??= $ExperimentsTable(this);
+  States _states;
+  States get states => _states ??= States(this);
+  Experiments _experiments;
+  Experiments get experiments => _experiments ??= Experiments(this);
   SomeDao _someDao;
   SomeDao get someDao => _someDao ??= SomeDao(this as TodoDb);
   AllTodosWithCategoryResult _rowToAllTodosWithCategoryResult(QueryRow row) {
@@ -1697,7 +1691,7 @@ abstract class _$TodoDb extends GeneratedDatabase {
         sharedTodos,
         tableWithoutPK,
         pureDefaults,
-        state,
+        states,
         experiments
       ];
 }

moor_generator/lib/src/model/specified_table.dart

@@ -14,6 +14,10 @@ class SpecifiedTable {
   /// of this table in generated Dart code.
   final String _overriddenName;
 
+  /// Whether this table was created from an `ALTER TABLE` statement instead of
+  /// a Dart class.
+  bool get isFromSql => _overriddenName != null;
+
   String get _baseName => _overriddenName ?? fromClass.name;
 
   /// The columns declared in this table.
@@ -25,8 +29,18 @@ class SpecifiedTable {
   /// The name for the data class associated with this table
   final String dartTypeName;
 
-  String get tableFieldName => ReCase(_baseName).camelCase;
-  String get tableInfoName => tableInfoNameForTableClass(_baseName);
+  String get tableFieldName => _dbFieldName(_baseName);
+  String get tableInfoName {
+    // if this table was parsed from sql, a user might want to refer to it
+    // directly because there is no user defined parent class.
+    // So, turn CREATE TABLE users into something called "Users" instead of
+    // "$UsersTable".
+    if (_overriddenName != null) {
+      return _overriddenName;
+    }
+    return tableInfoNameForTableClass(_baseName);
+  }
+
   String get updateCompanionName => _updateCompanionName(_baseName);
 
   /// The set of primary keys, if they have been explicitly defined by
@@ -48,6 +62,8 @@ class SpecifiedTable {
       columns.map((c) => c.typeConverter).where((t) => t != null);
 }
 
+String _dbFieldName(String className) => ReCase(className).camelCase;
+
 String tableInfoNameForTableClass(String className) => '\$${className}Table';
 
 String _updateCompanionName(String className) => '${className}Companion';

moor_generator/lib/src/parser/moor/parsed_moor_file.dart

@@ -79,13 +79,13 @@ class CreateTable {
     final tableName = table.name;
     final dartTableName = ReCase(tableName).pascalCase;
 
-    // todo respect WITHOUT ROWID clause and table constraints
+    // todo include WITHOUT ROWID clause and table constraints
     return SpecifiedTable(
       fromClass: null,
       columns: foundColumns.values.toList(),
       sqlName: table.name,
       dartTypeName: dataClassNameForClassName(dartTableName),
-      overriddenName: dartTableName,
+      overriddenName: ReCase(tableName).pascalCase,
       primaryKey: primaryKey,
     );
   }

moor_generator/lib/src/parser/use_dao_parser.dart

@@ -16,7 +16,16 @@ class UseDaoParser {
         annotation.peek('tables').listValue.map((obj) => obj.toTypeValue());
     final queryStrings = annotation.peek('queries')?.mapValue ?? {};
 
+    final includes = annotation
+            .read('include')
+            .objectValue
+            .toSetValue()
+            ?.map((e) => e.toStringValue()) ??
+        {};
+
     final parsedTables = await session.parseTables(tableTypes, element);
+    parsedTables.addAll(await session.resolveIncludes(includes));
+
     final parsedQueries =
         await session.parseQueries(queryStrings, parsedTables);
 

moor_generator/lib/src/writer/table_writer.dart

@@ -174,7 +174,9 @@ class TableWriter {
       getterName: column.dartGetterName,
       returnType: column.implColumnTypeName,
       code: expressionBuffer.toString(),
-      hasOverride: true,
+      // don't override on custom tables because we only override the column
+      // when the base class is user defined
+      hasOverride: !table.isFromSql,
     );
   }