Changelog #

[Unreleased]

[0.5.0+1] - 2019-05-03

Changed #

• Marked as deprecated. Replaced by f_orm_m8_sqlite
• See f_orm_m8_sqlite for new updated framework

[0.5.0] - 2019-05-03

Changed #

• Switched from flutter_orm_m8 to the de facto successor f_orm_m8
• Aligned generators with f_orm_m8 v0.8.0
• Softdeletable meta determines the generation of a DateTime dateDelete field
• The tests were refactored with caliber files

Added #

• A custom header with timestamp on the generated files
• Test coverage reporting to the CI pipeline
• The example project integration tests were wired the CI pipeline

[0.4.0] - 2019-05-01

Changed #

• Aligned generators with flutter-orm-m8 v0.7.1
• Example project: HealthEntry model received a composite unique constraint

Added #

• Generator support for CompositeConstraint.unique
• Generator support for CompositeConstraint.primaryKey
• Tests for CompositeConstraint generation
• Flutter Driver tests on example project for all UI use cases

[0.3.0+1] - 2019-04-25

Fixed #

• Documentation

[0.3.0] - 2019-04-23

Changed #

• Aligned generators with flutter-orm-m8 v0.6.0
• Default constructor on proxy entities has named parameters
• All db helpers get*all methods return a list of proxy entities
• The generator handles DbAccountEntity isCurrent field
• The pluralize for model switched from "${modelName}s" to "${modelName}Proxies"
• Example project was extended with implementations for:
  • DbEntity
  • DbAccountEntity
  • DbAccountRelatedEntity

Fixed #

• Wrong attribute emission on accountId, for account related entities

[0.2.3+1] - 2019-04-15

Fixed #

• Fix typo in save and update methods for trackable entities

Changed #

• The showcase in the example project. All models are closer to a real life application

[0.2.3] - 2019-04-14

Fixed #

• The generated entity database helper does not contain the meta columns
• Fixed test in the example project

Changed #

• The showcase in the example project

[0.2.2] - 2019-04-12

Added #

• Bidirectional mapping for Model DateTime to Database Integer
• Complete implementation for trackable, update and create, fields
• Boolean extremeDevelopmentMode field to DatabaseHelper to control regeneration of database in dev mode

[0.2.1] - 2019-04-09

Changed #

• Emitting only public fields

Fixed #

• Missing metadataLevel on DataColumn annotated model fields, generates wrong emition

[0.2.0] - 2019-04-07

Added #

• A full implementation in the example project for a dbEntity CRUD

Fixed #

• Returning all rows on softDeletable entities

[0.1.1] - 2019-04-06

Changed #

• FileStamp for database file

Fixed #

• Fixing format and analyzer issues recommended after publish
• Fixing readme formatting issues

[0.1.0] - 2019-04-05

Added #

• Chaining database adapter builder with annotation helpers builder
• Tests
• A proxy default constructor with mandatory parameters
• A database adapter

Changed #

• Generated files extension

[0.0.7] - 2019-04-03

Added #

• Working generator, ready to be published
• Soft delete annotation implemented
• Track create annotation implemented
• Track update annotation implemented

[0.0.6] - 2019-04-02

Added #

• Proxy writer

[0.0.5] - 2019-04-01

Added #

• A simple fields enumeration with model type
• A basic type mapper for Sqlite types
• Expanding metadata in column definition
• Extracting the primary key name

[0.0.4] - 2019-03-22

Added #

• An entity factory for account related, account and independent entities

Changed #

• The build output is routed to cache

[0.0.3] - 2019-03-14

Added #

• A weak try to expand some information
• Tests

[0.0.2] - 2019-03-14

Fixed #

• Fixing analyzer issues

[0.0.1] - 2019-03-03

Added #

• Basic generator

example/README.md

Example - Gymspector application #

A full, flutter working example is maintained on https://github.com/matei-tm/flutter-sqlite-m8-generator/tree/master/example.
The example presents different approaches to solve CRUD functionality for models that adhere to f_orm_m8 annotation framework.

HealthEntry - A DbAccountRelatedEntity implementation #

To demonstrate how to use a model that is dependent to UserAccount, we use a HealthEntry model that implements DbAccountRelatedEntity. The model detain a composite unique constraint based on accountId and description.

The model #

The model file models/health_entry.dart has the following content:

import 'package:f_orm_m8/f_orm_m8.dart';

@DataTable(
    "health_entry", TableMetadata.trackCreate | TableMetadata.trackUpdate)
class HealthEntry implements DbAccountRelatedEntity {
  @DataColumn("id",
      metadataLevel: ColumnMetadata.primaryKey |
          ColumnMetadata.unique |
          ColumnMetadata.autoIncrement)
  int id;

  @DataColumn("diagnosys_date")
  DateTime diagnosysDate;

  @override
  @DataColumn("account_id",
      metadataLevel: ColumnMetadata.notNull,
      compositeConstraints: [
        CompositeConstraint(
            name: "uq_account_entry",
            constraintType: CompositeConstraintType.unique),
        CompositeConstraint(
            name: "ix_account_entry",
            constraintType: CompositeConstraintType.indexed)
      ])
  int accountId;

  @DataColumn("description",
      metadataLevel: ColumnMetadata.notNull,
      compositeConstraints: [
        CompositeConstraint(
            name: "uq_account_entry",
            constraintType: CompositeConstraintType.unique)
      ])
  String description;

  @DataColumn("my_future_column7",
      metadataLevel: ColumnMetadata.ignore | ColumnMetadata.unique)
  int futureData;
}

The generated code #

From the model, the builder creates models/health_entry.g.m8.dart file with content

// GENERATED CODE - DO NOT MODIFY BY HAND

// **************************************************************************
// Generator: OrmM8GeneratorForAnnotation
// **************************************************************************

import 'package:sqflite/sqflite.dart';
import 'dart:async';
import 'package:sqlite_m8_demo/models/health_entry.dart';

class HealthEntryProxy extends HealthEntry {
  DateTime dateCreate;
  DateTime dateUpdate;

  HealthEntryProxy({accountId, description}) {
    this.accountId = accountId;
    this.description = description;
  }

  Map<String, dynamic> toMap() {
    var map = Map<String, dynamic>();
    map['id'] = id;
    map['diagnosys_date'] = diagnosysDate.millisecondsSinceEpoch;
    map['account_id'] = accountId;
    map['description'] = description;
    map['date_create'] = dateCreate.millisecondsSinceEpoch;
    map['date_update'] = dateUpdate.millisecondsSinceEpoch;

    return map;
  }

  HealthEntryProxy.fromMap(Map<String, dynamic> map) {
    this.id = map['id'];
    this.diagnosysDate =
        DateTime.fromMillisecondsSinceEpoch(map['diagnosys_date']);
    this.accountId = map['account_id'];
    this.description = map['description'];
    this.dateCreate = DateTime.fromMillisecondsSinceEpoch(map['date_create']);
    this.dateUpdate = DateTime.fromMillisecondsSinceEpoch(map['date_update']);
  }
}

mixin HealthEntryDatabaseHelper {
  Future<Database> db;
  final theHealthEntryColumns = [
    "id",
    "diagnosys_date",
    "account_id",
    "description",
    "date_create",
    "date_update"
  ];

  final String _theHealthEntryTableHandler = 'health_entry';
  Future createHealthEntryTable(Database db) async {
    await db.execute('''CREATE TABLE $_theHealthEntryTableHandler (
    id INTEGER  PRIMARY KEY AUTOINCREMENT UNIQUE,
    diagnosys_date INTEGER ,
    account_id INTEGER  NOT NULL,
    description TEXT  NOT NULL,
    date_create INTEGER,
    date_update INTEGER    ,
    UNIQUE(account_id, description)
)''');
  }

  Future<int> saveHealthEntry(HealthEntryProxy instanceHealthEntry) async {
    var dbClient = await db;

    instanceHealthEntry.dateCreate = DateTime.now();
    instanceHealthEntry.dateUpdate = DateTime.now();

    var result = await dbClient.insert(
        _theHealthEntryTableHandler, instanceHealthEntry.toMap());
    return result;
  }

  Future<List<HealthEntry>> getHealthEntryProxiesAll() async {
    var dbClient = await db;
    var result = await dbClient.query(_theHealthEntryTableHandler,
        columns: theHealthEntryColumns, where: '1');

    return result.map((e) => HealthEntryProxy.fromMap(e)).toList();
  }

  Future<int> getHealthEntryProxiesCount() async {
    var dbClient = await db;
    return Sqflite.firstIntValue(await dbClient.rawQuery(
        'SELECT COUNT(*) FROM $_theHealthEntryTableHandler  WHERE 1'));
  }

  Future<HealthEntry> getHealthEntry(int id) async {
    var dbClient = await db;
    List<Map> result = await dbClient.query(_theHealthEntryTableHandler,
        columns: theHealthEntryColumns, where: '1 AND id = ?', whereArgs: [id]);

    if (result.length > 0) {
      return HealthEntryProxy.fromMap(result.first);
    }

    return null;
  }

  Future<int> deleteHealthEntry(int id) async {
    var dbClient = await db;
    return await dbClient
        .delete(_theHealthEntryTableHandler, where: 'id = ?', whereArgs: [id]);
  }

  Future<bool> deleteHealthEntryProxiesAll() async {
    var dbClient = await db;
    await dbClient.delete(_theHealthEntryTableHandler);
    return true;
  }

  Future<int> updateHealthEntry(HealthEntryProxy instanceHealthEntry) async {
    var dbClient = await db;

    instanceHealthEntry.dateUpdate = DateTime.now();

    return await dbClient.update(
        _theHealthEntryTableHandler, instanceHealthEntry.toMap(),
        where: "id = ?", whereArgs: [instanceHealthEntry.id]);
  }

  Future<List<HealthEntry>> getHealthEntryProxiesByAccountId(
      int accountId) async {
    var dbClient = await db;
    var result = await dbClient.query(_theHealthEntryTableHandler,
        columns: theHealthEntryColumns,
        where: 'account_id = ? AND 1',
        whereArgs: [accountId]);

    return result.map((e) => HealthEntryProxy.fromMap(e)).toList();
  }
}

GymLocation - A DbEntity implementation #