diff --git a/.idea/libraries/Dart_Packages.xml b/.idea/libraries/Dart_Packages.xml
index 19eb213e..f8f342d4 100644
--- a/.idea/libraries/Dart_Packages.xml
+++ b/.idea/libraries/Dart_Packages.xml
@@ -80,7 +80,7 @@
-
+
@@ -667,7 +667,7 @@
-
+
diff --git a/.idea/modules.xml b/.idea/modules.xml
index 323748ab..acd15773 100644
--- a/.idea/modules.xml
+++ b/.idea/modules.xml
@@ -2,6 +2,7 @@
+
diff --git a/README.md b/README.md
deleted file mode 120000
index f00e0b69..00000000
--- a/README.md
+++ /dev/null
@@ -1 +0,0 @@
-sally/README.md
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..ef1e5e76
--- /dev/null
+++ b/README.md
@@ -0,0 +1,259 @@
+# Sally
+[](https://travis-ci.com/simolus3/sally)
+
+Sally is an easy to use and safe way to persist data for Flutter apps. It features
+a fluent Dart DSL to describe tables and will generate matching database code that
+can be used to easily read and store your app's data. It also features a reactive
+API that will deliver auto-updating streams for your queries.
+
+- [Sally](#sally)
+ * [Getting started](#getting-started)
+ + [Adding the dependency](#adding-the-dependency)
+ + [Declaring tables](#declaring-tables)
+ + [Generating the code](#generating-the-code)
+ * [Writing queries](#writing-queries)
+ + [Select statements](#select-statements)
+ - [Where](#where)
+ - [Limit](#limit)
+ + [Updates and deletes](#updates-and-deletes)
+ + [Inserts](#inserts)
+ * [Migrations](#migrations)
+ * [TODO-List and current limitations](#todo-list-and-current-limitations)
+ + [Limitions (at the moment)](#limitions--at-the-moment-)
+ + [Planned for the future](#planned-for-the-future)
+ + [Interesting stuff that would be nice to have](#interesting-stuff-that-would-be-nice-to-have)
+
+## Getting started
+### Adding the dependency
+First, let's add sally to your project's `pubspec.yaml`:
+TODO: Finish this part of the readme when sally is out on pub.
+```yaml
+dependencies:
+ sally:
+ git:
+ url:
+ path: sally/
+
+dev_dependencies:
+ sally_generator:
+ git:
+ url:
+ path: sally_generator/
+ build_runner:
+```
+We're going to use the `sally_flutter` library to specify tables and access the database. The
+`sally_generator` library will take care of generating the necessary code so the
+library knows how your table structure looks like.
+
+### Declaring tables
+You can use the DSL included with this library to specify your libraries with simple
+dart code:
+```dart
+import 'package:sally_flutter/sally_flutter.dart';
+
+// assuming that your file is called filename.dart. This will give an error at first,
+// but it's needed for sally to know about the generated code
+part 'filename.g.dart';
+
+// this will generate a table called "todos" for us. The rows of that table will
+// be represented by a class called "Todo".
+class Todos extends Table {
+ IntColumn get id => integer().autoIncrement()();
+ TextColumn get title => text().withLength(min: 6, max: 10)();
+ TextColumn get content => text().named('body')();
+ IntColumn get category => integer().nullable()();
+}
+
+// This will make sally generate a class called "Category" to represent a row in this table.
+// By default, "Categorie" would have been used because it only strips away the trailing "s"
+// in the table name.
+@DataClassName("Category")
+class Categories extends Table {
+
+ IntColumn get id => integer().autoIncrement()();
+ TextColumn get description => text()();
+}
+
+// this annotation tells sally to prepare a database class that uses both of the
+// tables we just defined. We'll see how to use that database class in a moment.
+@UseSally(tables: [Todos, Categories])
+class MyDatabase {
+
+}
+```
+
+__⚠️ Warning:__ Even though it might look like it, the content of a `Table` class does not support full Dart code. It can only
+be used to declare the table name, it's primary keys and columns. The code inside of a table class will never be
+executed. Instead, the generator will take a look at your table classes to figure out how their structure looks like.
+This won't work if the body of your tables is not constant. This should not be problem, but please be aware of this as you can't put logic inside these classes.
+
+### Generating the code
+Sally integrates with the dart `build` system, so you can generate all the code needed with
+`flutter packages pub run build_runner build`. If you want to continously rebuild the code
+whever you change your code, run `flutter packages pub run build_runner watch` instead.
+After running either command once, sally generator will have created a class for your
+database and data classes for your entities. To use it, change the `MyDatabase` class as
+follows:
+```dart
+@UseSally(tables: [Todos, Categories])
+class MyDatabase extends _$MyDatabase {
+ // we tell the database where to store the data with this constructor
+ MyDatabase() : super(FlutterQueryExecutor.inDatabaseFolder(path: 'db.sqlite'));
+
+ // you should bump this number whenever you change or add a table definition. Migrations
+ // are covered later in this readme.
+ @override
+ int get schemaVersion => 1;
+}
+```
+You can ignore the `schemaVersion` at the moment, the important part is that you can
+now run your queries with fluent Dart code:
+## Writing queries
+```dart
+class MyDatabase extends _$MyDatabase {
+ // .. the versionCode getter still needs to be here
+
+ // loads all todo entries
+ Future> get allTodoEntries => select(todos).get();
+
+ // watches all todo entries in a given category. The stream will automatically
+ // emit new items whenever the underlying data changes.
+ Stream> watchEntriesInCategory(Category c) {
+ return (select(todos)..where((t) => t.category.equals(c.id))).watch();
+ }
+}
+```
+### Select statements
+You can create `select` statements by starting them with `select(tableName)`, where the
+table name
+is a field generated for you by sally. Each table used in a database will have a matching field
+to run queries against. A query can be run once with `get()` or be turned into an auto-updating
+stream using `watch()`.
+#### Where
+You can apply filters to a query by calling `where()`. The where method takes a function that
+should map the given table to an `Expression` of boolean. A common way to create such expression
+is by using `equals` on expressions. Integer columns can also be compared with `isBiggerThan`
+and `isSmallerThan`. You can compose expressions using `and(a, b), or(a, b)` and `not(a)`.
+#### Limit
+You can limit the amount of results returned by calling `limit` on queries. The method accepts
+the amount of rows to return and an optional offset.
+### Updates and deletes
+You can use the generated `row` class to update individual fields of any row:
+```dart
+Future moveImportantTasksIntoCategory(Category target) {
+ return (update(todos)
+ ..where((t) => t.title.like('%Important%'))
+ ).write(TodoEntry(
+ category: target.id
+ ),
+ );
+}
+
+Future feelingLazy() {
+ // delete 10 todo entries just cause
+ return (delete(todos)..limit(10)).go();
+}
+```
+__⚠️ Caution:__ If you don't explicitly add a `where` or `limit` clause on updates or deletes,
+the statement will affect all rows in the table!
+
+### Inserts
+You can very easily insert any valid object into tables:
+```dart
+// returns the generated id
+Future addTodoEntry(Todo entry) {
+ return into(todos).insert(entry);
+}
+```
+All row classes generated will have a constructor that can be used to create objects:
+```dart
+addTodoEntry(
+ Todo(
+ title: 'Important task',
+ content: 'Refactor persistence code',
+ ),
+);
+```
+If a column is nullable or has a default value (this includes auto-increments), the field
+can be omitted. All other fields must be set and non-null. The `insert` method will throw
+otherwise.
+
+## Migrations
+Sally provides a migration API that can be used to gradually apply schema changes after bumping
+the `schemaVersion` getter inside the `Database` class. To use it, override the `migration`
+getter. Here's an example: Let's say you wanted to add a due date to your todo entries:
+```dart
+class Todos extends Table {
+ IntColumn get id => integer().autoIncrement()();
+ TextColumn get title => text().withLength(min: 6, max: 10)();
+ TextColumn get content => text().named('body')();
+ IntColumn get category => integer().nullable()();
+ DateTimeColumn get dueDate => dateTime().nullable()(); // we just added this column
+}
+```
+We can now change the `database` class like this:
+```dart
+ @override
+ int get schemaVersion => 1; // bump because the tables have changed
+
+ @override
+ MigrationStrategy get migration => MigrationStrategy(
+ onCreate: (Migrator m) {
+ return m.createAllTables();
+ },
+ onUpgrade: (Migrator m, int from, int to) async {
+ if (from == 1) {
+ // we added the dueDate propery in the change from version 1
+ await m.addColumn(todos, todos.dueDate);
+ }
+ }
+ );
+
+ // rest of class can stay the same
+```
+You can also add individual tables or drop them.
+
+## TODO-List and current limitations
+### Limitions (at the moment)
+- No joins
+- No `group by` or window functions
+- Custom primary key support is very limited
+- No `ORDER BY`
+
+### Planned for the future
+These aren't sorted by priority. If you have more ideas or want some features happening soon,
+let us know by creating an issue!
+
+- Refactor comparison API
+ 1. Instead of defining them in `IntColumn`, move `isBiggerThan` and `isSmallerThan` into
+ a new class (comparable expression?)
+ 2. Support for non-strict comparisons (<=, >=)
+ 3. Support `ORDER BY` clauses.
+- Specify primary keys
+- Simple `COUNT(*)` operations (group operations will be much more complicated)
+- Support default values and expressions
+- Allow using DAOs or some other mechanism instead of having to put everything in the main
+database class.
+- Support more Datatypes: We should at least support `Uint8List` out of the box,
+supporting floating / fixed point numbers as well would be awesome
+- Nullable / non-nullable datatypes
+ - DSL API ✔️
+ - Support in generator ✔️
+ - Use in queries (`IS NOT NULL`) ✔️
+ - Setting fields to null during updates
+- Support Dart VM apps
+- References
+ - DSL API
+ - Support in generator
+ - Validation
+- Table joins
+- Bulk inserts
+- Transactions
+### Interesting stuff that would be nice to have
+Implementing this will very likely result in backwards-incompatible changes.
+
+- Find a way to hide implementation details from users while still making them
+ accessible for the generated code
+- `GROUP BY` grouping functions
+- Support for different database engines
+ - Support webapps via `AlaSQL` or a different engine
\ No newline at end of file
diff --git a/sally/README.md b/sally/README.md
index 6934caad..2c678885 100644
--- a/sally/README.md
+++ b/sally/README.md
@@ -1,128 +1,6 @@
# Sally
-[](https://travis-ci.com/simolus3/sally)
-Sally is an easy to use and safe way to persist data for Flutter apps. It features
-a fluent Dart DSL to describe tables and will generate matching database code that
-can be used to easily read and store your app's data.
+This library defines the APIs for the sally persistence library. When using the library,
+you'll probably want to use the sally_flutter implementation directly.
-__Note:__ This library is in development and not yet available for general use on `pub`.
-
-## Using this library
-#### Adding the dependency
-First, let's add sally to your prooject's `pubspec.yaml`:
-```yaml
-dependencies:
- sally:
- git:
- url:
- path: sally/
-
-dev_dependencies:
- sally_generator:
- git:
- url:
- path: sally_generator/
- build_runner:
-```
-We're going to use the `sally` library to specify tables and write data. The
-`sally_generator` library will take care of generating the necessary code so the
-library knows how your table structure looks like.
-
-#### Declaring tables
-You can use the DSL included with this library to specify your libraries with simple
-dart code:
-```dart
-import 'package:sally/sally.dart';
-
-// assuming that your file is called filename.dart. This will give an error at first,
-// but it's needed for sally to know about the generated code
-part 'filename.g.dart';
-
-class Todos extends Table {
- IntColumn get id => integer().autoIncrement()();
- TextColumn get name => text().withLength(min: 6, max: 10)();
- TextColumn get content => text().named('body')();
- IntColumn get category => integer()();
-}
-
-class Categories extends Table {
- @override
- String get tableName => 'todo_categories';
-
- IntColumn get id => integer().autoIncrement()();
- TextColumn get description => text()();
-}
-
-@UseSally(tables: [Todos, Categories])
-class MyDatabase {
-
-}
-```
-
-__⚠️ Warning:__ Even though it might look like it, the content of a `Table` class does not support full Dart code. It can only
-be used to declare the table name, it's primary keys and columns. The code inside of a table class will never be
-executed. Instead, the generator will take a look at your table classes to figure out how their structure looks like.
-This won't work if the body of your tables is not constant. This should not be problem, but please be aware of this.
-
-#### Generating the code
-Sally integrates with the dart `build` system, so you can generate all the code needed with
-`flutter packages pub run build_runner build`. If you want to continously rebuild the code
-whever you change your code, run `flutter packages pub run build_runner watch` instead.
-After running either command once, sally generator will have created a class for your
-database and data classes for your entities. To use it, change the `MyDatabase` class as
-follows:
-```dart
-@UseSally(tables: [Todos, Categories])
-class MyDatabase extends _$MyDatabase {
- @override
- int get schemaVersion => 1;
- @override
- MigrationStrategy get migration => MigrationStrategy();
-}
-```
-You can ignore these two getters there at the moment, the important part is that you can
-now run your queries with fluent Dart code:
-```dart
-class MyDatabase extends _$MyDatabase {
- // .. the getters that have been defined above still need to be here
-
- Future> get allTodoEntries => select(todos).get();
-
- Future deleteCategory(Category toDelete) async {
- await (delete(todos)..where((entry) => entry.category.equalsVal(category.id))).go();
- await (delete(categories)..where((cat) => cat.id.equalsVal(toDelete.id))).go();
- }
-}
-```
-
-## TODO-List
-If you have suggestions for new features or any other questions, feel free to
-create an issue.
-
-##### Before this library can be released
-- Stabilize all end-user APIs and document them extensively
-- More unit tests
-##### Definitely planned for the future
-- Specify primary keys
-- Simple `COUNT(*)` operations (group operations will be much more complicated)
-- Support default values and expressions
-- Allow using DAOs instead of having to put everything in the main database
-class.
-- Support more Datatypes: We should at least support `DateTime` and `Uint8List`,
-supporting floating / fixed point numbers as well would be awesome
-- Nullable / non-nullable datatypes
- - DSL API
- - Support in generator
- - Use in queries (`IS NOT NULL`)
- - Setting fields to null during updates
-- Verify constraints (text length, nullability, etc.) before inserting or
- deleting data.
-- Support Dart VM apps
-- References
-- Table joins
-##### Interesting stuff that would be nice to have
-- Find a way to hide implementation details from users while still making them
- accessible for the generated code
-- `GROUP BY` grouping functions
-- Support for different database engines
- - Support webapps via `AlaSQL` or a different engine
\ No newline at end of file
+Please see the homepage of [sally](https://github.com/simolus3/sally) for details.
\ No newline at end of file
diff --git a/sally/lib/src/dsl/columns.dart b/sally/lib/src/dsl/columns.dart
index c05da66d..cfd39f35 100644
--- a/sally/lib/src/dsl/columns.dart
+++ b/sally/lib/src/dsl/columns.dart
@@ -3,47 +3,76 @@
import 'package:sally/src/runtime/expressions/expression.dart';
import 'package:sally/src/runtime/sql_types.dart';
-abstract class Column> extends Expression {
- Expression equalsExp(Expression compare);
- Expression equals(T compare);
-}
+abstract class Column> extends Expression {}
abstract class IntColumn extends Column {
- Expression isBiggerThan(int i);
- Expression isSmallerThan(int i);
+ /// Whether this column is strictly bigger than [i].
+ Expression isBiggerThan(int i);
+
+ /// Whether this column is strictly smaller than [i].
+ Expression isSmallerThan(int i);
}
+/// A column that stores boolean values. Booleans will be stored as an integer
+/// that can either be 0 (false) or 1 (true).
abstract class BoolColumn extends Column {}
+/// A column that stores text.
abstract class TextColumn extends Column {
- Expression like(String regex);
+ /// Whether this column matches the given pattern. For details on what patters
+ /// are valid and how they are interpreted, check out
+ /// [this tutorial](http://www.sqlitetutorial.net/sqlite-like/).
+ Expression like(String regex);
}
/// A column that stores a [DateTime]. Times will be stored as unix timestamp
/// and will thus have a second accuracy.
abstract class DateTimeColumn extends Column {}
+/// A column builder is used to specify which columns should appear in a table.
+/// All of the methods defined in this class and its subclasses are not meant to
+/// be called at runtime. Instead, sally_generator will take a look at your
+/// source code (specifically, it will analyze which of the methods you use) to
+/// figure out the column structure of a table.
class ColumnBuilder {
/// By default, the field name will be used as the column name, e.g.
- /// `IntColumn get id = integer()` will have "id" as its associated name. To change
- /// this, use `IntColumn get id = integer((c) => c.named('user_id'))`.
+ /// `IntColumn get id = integer()` will have "id" as its associated name.
+ /// Columns made up of multiple words are expected to be in camelCase and will
+ /// be converted to snake_case (e.g. a getter called accountCreationDate will
+ /// result in an SQL column called account_creation_date).
+ /// To change this default behavior, use something like
+ /// `IntColumn get id = integer((c) => c.named('user_id'))`.
Builder named(String name) => null;
+
+ /// Marks this column as being part of a primary key. This is not yet
+ /// supported by sally.
Builder primaryKey() => null;
/// Marks this column as nullable. Nullable columns should not appear in a
- /// primary key.
+ /// primary key. Columns are non-null by default.
Builder nullable() => null;
+ /// Turns this column builder into a column. This method won't actually be
+ /// called in your code. Instead, sally_generator will take a look at your
+ /// source code to figure out your table structure.
ResultColumn call() => null;
}
class IntColumnBuilder extends ColumnBuilder {
+ /// Enables auto-increment for this column, which will also make this column
+ /// the primary key of the table.
IntColumnBuilder autoIncrement() => this;
}
class BoolColumnBuilder extends ColumnBuilder {}
class TextColumnBuilder extends ColumnBuilder {
+ /// Puts a constraint on the minimum and maximum length of text that can be
+ /// stored in this column (will be validated whenever this column is updated
+ /// or a value is inserted). If [min] is not null and one tries to write a
+ /// string so that [String.length] is smaller than [min], the query will throw
+ /// an exception when executed and no data will be written. The same applies
+ /// for [max].
TextColumnBuilder withLength({int min, int max}) => this;
}
diff --git a/sally/lib/src/dsl/database.dart b/sally/lib/src/dsl/database.dart
index 9f6d397c..60186af9 100644
--- a/sally/lib/src/dsl/database.dart
+++ b/sally/lib/src/dsl/database.dart
@@ -1,5 +1,10 @@
+/// Use this class as an annotation to inform sally_generator that a database
+/// class should be generated using the specified [UseSally.tables].
class UseSally {
+ /// The tables to include in the database
final List tables;
+ /// Use this class as an annotation to inform sally_generator that a database
+ /// class should be generated using the specified [UseSally.tables].
const UseSally({this.tables});
}
diff --git a/sally/lib/src/dsl/table.dart b/sally/lib/src/dsl/table.dart
index efcab071..d5bf579a 100644
--- a/sally/lib/src/dsl/table.dart
+++ b/sally/lib/src/dsl/table.dart
@@ -1,22 +1,58 @@
import 'package:meta/meta.dart';
import 'package:sally/sally.dart';
+/// Subclasses represent a table in a database generated by sally.
abstract class Table {
const Table();
+ /// The sql table name to be used. By default, sally will use the snake_case
+ /// representation of your class name as the sql table name. For instance, a
+ /// [Table] class named `LocalSettings` will be called `local_settings` by
+ /// default.
+ /// You can change that behavior by overriding this method to use a custom
+ /// name. Please note that you must directly return a string literal by using
+ /// a getter. For instance `@override String get tableName => 'my_table';` is
+ /// valid, whereas `@override final String tableName = 'my_table';` or
+ /// `@override String get tableName => createMyTableName();` is not.
@visibleForOverriding
String get tableName => null;
+ /// In the future, you can override this to specify a custom primary key. This
+ /// is not supported by sally at the moment.
@visibleForOverriding
// todo allow custom primary key
PrimaryKey get primaryKey => null;
+ /// Use this as the body of a getter to declare a column that holds integers.
+ /// Example (inside the body of a table class):
+ /// ```
+ /// IntColumn get id => integer().autoIncrement()();
+ /// ```
@protected
IntColumnBuilder integer() => null;
+
+ /// Use this as the body of a getter to declare a column that holds strings.
+ /// Example (inside the body of a table class):
+ /// ```
+ /// TextColumn get name => text()();
+ /// ```
@protected
TextColumnBuilder text() => null;
+
+ /// Use this as the body of a getter to declare a column that holds bools.
+ /// Example (inside the body of a table class):
+ /// ```
+ /// BoolColumn get isAwesome => boolean()();
+ /// ```
@protected
BoolColumnBuilder boolean() => null;
+
+ /// Use this as the body of a getter to declare a column that holds date and
+ /// time.
+ /// Example (inside the body of a table class):
+ /// ```
+ /// DateTimeColumn get accountCreatedAt => dateTime()();
+ /// ```
@protected
DateTimeColumnBuilder dateTime() => null;
}
diff --git a/sally/lib/src/runtime/components/where.dart b/sally/lib/src/runtime/components/where.dart
index 8e9e892b..8c12951f 100644
--- a/sally/lib/src/runtime/components/where.dart
+++ b/sally/lib/src/runtime/components/where.dart
@@ -3,7 +3,7 @@ import 'package:sally/src/runtime/expressions/expression.dart';
import 'package:sally/src/runtime/sql_types.dart';
class Where extends Component {
- final Expression predicate;
+ final Expression predicate;
Where(this.predicate);
diff --git a/sally/lib/src/runtime/executor/executor.dart b/sally/lib/src/runtime/executor/executor.dart
index c98be1cd..b4a53198 100644
--- a/sally/lib/src/runtime/executor/executor.dart
+++ b/sally/lib/src/runtime/executor/executor.dart
@@ -18,7 +18,7 @@ abstract class GeneratedDatabase {
int get schemaVersion;
MigrationStrategy get migration => MigrationStrategy();
-
+
List get allTables;
GeneratedDatabase(this.typeSystem, this.executor, {this.streamQueries}) {
diff --git a/sally/lib/src/runtime/expressions/bools.dart b/sally/lib/src/runtime/expressions/bools.dart
index 89e63926..9b52332e 100644
--- a/sally/lib/src/runtime/expressions/bools.dart
+++ b/sally/lib/src/runtime/expressions/bools.dart
@@ -2,17 +2,20 @@ import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/expressions/expression.dart';
import 'package:sally/src/runtime/sql_types.dart';
-Expression and(Expression a, Expression b) =>
+Expression and(
+ Expression a, Expression b) =>
AndExpression(a, b);
-Expression or(Expression a, Expression b) =>
+Expression or(
+ Expression a, Expression b) =>
OrExpression(a, b);
-Expression not(Expression a) => NotExpression(a);
+Expression not(Expression a) =>
+ NotExpression(a);
-class AndExpression extends Expression with InfixOperator {
+class AndExpression extends InfixOperator {
@override
- Expression left, right;
+ Expression left, right;
@override
final String operator = 'AND';
@@ -20,9 +23,9 @@ class AndExpression extends Expression with InfixOperator {
AndExpression(this.left, this.right);
}
-class OrExpression extends Expression with InfixOperator {
+class OrExpression extends InfixOperator {
@override
- Expression left, right;
+ Expression left, right;
@override
final String operator = 'OR';
@@ -30,8 +33,8 @@ class OrExpression extends Expression with InfixOperator {
OrExpression(this.left, this.right);
}
-class NotExpression extends Expression {
- Expression inner;
+class NotExpression extends Expression {
+ Expression inner;
NotExpression(this.inner);
diff --git a/sally/lib/src/runtime/expressions/datetimes.dart b/sally/lib/src/runtime/expressions/datetimes.dart
index b1ed21ba..67f268c8 100644
--- a/sally/lib/src/runtime/expressions/datetimes.dart
+++ b/sally/lib/src/runtime/expressions/datetimes.dart
@@ -2,24 +2,24 @@ import 'package:sally/sally.dart';
import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/expressions/expression.dart';
-Expression year(Expression date) =>
+Expression year(Expression date) =>
_StrftimeSingleFieldExpression('%Y', date);
-Expression month(Expression date) =>
+Expression month(Expression date) =>
_StrftimeSingleFieldExpression('%m', date);
-Expression day(Expression date) =>
+Expression day(Expression date) =>
_StrftimeSingleFieldExpression('%d', date);
-Expression hour(Expression date) =>
+Expression hour(Expression date) =>
_StrftimeSingleFieldExpression('%H', date);
-Expression minute(Expression date) =>
+Expression minute(Expression date) =>
_StrftimeSingleFieldExpression('%M', date);
-Expression second(Expression date) =>
+Expression second(Expression date) =>
_StrftimeSingleFieldExpression('%S', date);
/// Expression that extracts components out of a date time by using the builtin
/// sqlite function "strftime" and casting the result to an integer.
-class _StrftimeSingleFieldExpression extends Expression {
+class _StrftimeSingleFieldExpression extends Expression {
final String format;
- final Expression date;
+ final Expression date;
_StrftimeSingleFieldExpression(this.format, this.date);
diff --git a/sally/lib/src/runtime/expressions/expression.dart b/sally/lib/src/runtime/expressions/expression.dart
index a62d1169..6afbd466 100644
--- a/sally/lib/src/runtime/expressions/expression.dart
+++ b/sally/lib/src/runtime/expressions/expression.dart
@@ -1,15 +1,27 @@
import 'package:meta/meta.dart';
+import 'package:sally/sally.dart';
import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/sql_types.dart';
/// Any sql expression that evaluates to some generic value. This does not
/// include queries (which might evaluate to multiple values) but individual
/// columns, functions and operators.
-abstract class Expression implements Component {}
+abstract class Expression> implements Component {
+ /// Whether this expression is equal to the given expression.
+ Expression equalsExp(Expression compare) =>
+ Comparison.equal(this, compare);
+
+ /// Whether this column is equal to the given value, which must have a fitting
+ /// type. The [compare] value will be written
+ /// as a variable using prepared statements, so there is no risk of
+ /// an SQL-injection.
+ Expression equals(D compare) =>
+ Comparison.equal(this, Variable(compare));
+}
/// An expression that looks like "$a operator $b$, where $a and $b itself
/// are expressions and the operator is any string.
-abstract class InfixOperator implements Expression {
+abstract class InfixOperator> with Expression {
Expression get left;
Expression get right;
String get operator;
@@ -41,7 +53,7 @@ abstract class InfixOperator implements Expression {
enum ComparisonOperator { less, lessOrEqual, equal, moreOrEqual, more }
-class Comparison extends InfixOperator {
+class Comparison extends InfixOperator {
static const Map operatorNames = {
ComparisonOperator.less: '<',
ComparisonOperator.lessOrEqual: '<=',
diff --git a/sally/lib/src/runtime/expressions/in.dart b/sally/lib/src/runtime/expressions/in.dart
index 7a7b9a23..b1e2d42f 100644
--- a/sally/lib/src/runtime/expressions/in.dart
+++ b/sally/lib/src/runtime/expressions/in.dart
@@ -3,18 +3,19 @@ import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/expressions/expression.dart';
import 'package:sally/src/runtime/sql_types.dart';
-Expression isIn, T>(
- Expression expression, Iterable values, {bool not = false}) {
+Expression isIn, T>(
+ Expression expression, Iterable values,
+ {bool not = false}) {
return _InExpression(expression, values, not);
}
-Expression isNotIn, T>(
- Expression expression, Iterable values) =>
+Expression isNotIn, T>(
+ Expression expression, Iterable values) =>
isIn(expression, values, not: true);
-class _InExpression, T> extends Expression {
-
- final Expression _expression;
+class _InExpression, T>
+ extends Expression {
+ final Expression _expression;
final Iterable _values;
final bool _not;
@@ -46,5 +47,4 @@ class _InExpression, T> extends Expression {
context.buffer.write(')');
}
-
-}
\ No newline at end of file
+}
diff --git a/sally/lib/src/runtime/expressions/null_check.dart b/sally/lib/src/runtime/expressions/null_check.dart
index ca00d858..47f75c0b 100644
--- a/sally/lib/src/runtime/expressions/null_check.dart
+++ b/sally/lib/src/runtime/expressions/null_check.dart
@@ -2,11 +2,11 @@ import 'package:sally/sally.dart';
import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/expressions/expression.dart';
-Expression isNull(Expression inner) => _NullCheck(inner, true);
-Expression isNotNull(Expression inner) => _NullCheck(inner, false);
-
-class _NullCheck extends Expression {
+Expression isNull(Expression inner) => _NullCheck(inner, true);
+Expression isNotNull(Expression inner) =>
+ _NullCheck(inner, false);
+class _NullCheck extends Expression {
final Expression _inner;
final bool _isNull;
@@ -22,5 +22,4 @@ class _NullCheck extends Expression {
}
context.buffer.write('NULL');
}
-
-}
\ No newline at end of file
+}
diff --git a/sally/lib/src/runtime/expressions/text.dart b/sally/lib/src/runtime/expressions/text.dart
index 96043288..6f1fd561 100644
--- a/sally/lib/src/runtime/expressions/text.dart
+++ b/sally/lib/src/runtime/expressions/text.dart
@@ -2,9 +2,9 @@ import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/expressions/expression.dart';
import 'package:sally/src/runtime/sql_types.dart';
-class LikeOperator extends Expression {
- final Expression target;
- final Expression regex;
+class LikeOperator extends Expression {
+ final Expression target;
+ final Expression regex;
LikeOperator(this.target, this.regex);
diff --git a/sally/lib/src/runtime/expressions/user_api.dart b/sally/lib/src/runtime/expressions/user_api.dart
index 571287a3..dbc388e0 100644
--- a/sally/lib/src/runtime/expressions/user_api.dart
+++ b/sally/lib/src/runtime/expressions/user_api.dart
@@ -2,4 +2,4 @@ export 'bools.dart' show and, or, not;
export 'datetimes.dart';
export 'in.dart';
export 'null_check.dart';
-export 'variables.dart';
\ No newline at end of file
+export 'variables.dart';
diff --git a/sally/lib/src/runtime/expressions/variables.dart b/sally/lib/src/runtime/expressions/variables.dart
index 90990491..3ad21ae2 100644
--- a/sally/lib/src/runtime/expressions/variables.dart
+++ b/sally/lib/src/runtime/expressions/variables.dart
@@ -2,7 +2,7 @@ import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/expressions/expression.dart';
import 'package:sally/src/runtime/sql_types.dart';
-class Variable> extends Expression {
+class Variable> extends Expression {
final T value;
Variable(this.value);
@@ -14,7 +14,7 @@ class Variable> extends Expression {
}
}
-class Constant> extends Expression {
+class Constant> extends Expression {
final T value;
Constant(this.value);
diff --git a/sally/lib/src/runtime/statements/delete.dart b/sally/lib/src/runtime/statements/delete.dart
index 239dcd77..2a1e778c 100644
--- a/sally/lib/src/runtime/statements/delete.dart
+++ b/sally/lib/src/runtime/statements/delete.dart
@@ -18,7 +18,7 @@ class DeleteStatement extends Query {
final rows = ctx.database.executor.doWhenOpened((e) async {
final rows =
- await ctx.database.executor.runDelete(ctx.sql, ctx.boundVariables);
+ await ctx.database.executor.runDelete(ctx.sql, ctx.boundVariables);
if (rows > 0) {
database.markTableUpdated(table.$tableName);
diff --git a/sally/lib/src/runtime/statements/query.dart b/sally/lib/src/runtime/statements/query.dart
index 48dfaadc..767725a7 100644
--- a/sally/lib/src/runtime/statements/query.dart
+++ b/sally/lib/src/runtime/statements/query.dart
@@ -24,7 +24,7 @@ abstract class Query {
void writeStartPart(GenerationContext ctx);
- void where(Expression filter(Table tbl)) {
+ void where(Expression filter(Table tbl)) {
final predicate = filter(table.asDslTable);
if (whereExpr == null) {
diff --git a/sally/lib/src/runtime/structure/columns.dart b/sally/lib/src/runtime/structure/columns.dart
index 5f05d0a2..976f819e 100644
--- a/sally/lib/src/runtime/structure/columns.dart
+++ b/sally/lib/src/runtime/structure/columns.dart
@@ -26,18 +26,11 @@ abstract class GeneratedColumn> extends Column {
@visibleForOverriding
String get typeName;
- @override
- Expression equalsExp(Expression compare) =>
- Comparison.equal(this, compare);
-
@override
void writeInto(GenerationContext context) {
context.buffer.write($name);
}
- @override
- Expression equals(T compare) => equalsExp(Variable(compare));
-
/// Checks whether the given value fits into this column. The default
/// implementation checks whether the value is not null, as null values are
/// only allowed for updates or if the column is nullable.
@@ -60,7 +53,7 @@ class GeneratedTextColumn extends GeneratedColumn
: super(name, nullable);
@override
- Expression like(String regex) =>
+ Expression like(String regex) =>
LikeOperator(this, Variable(regex));
@override
@@ -110,7 +103,6 @@ class GeneratedIntColumn extends GeneratedColumn
{this.hasAutoIncrement = false})
: super(name, nullable);
-
@override
void writeColumnDefinition(StringBuffer into) {
if (hasAutoIncrement) {
@@ -121,11 +113,11 @@ class GeneratedIntColumn extends GeneratedColumn
}
@override
- Expression isBiggerThan(int i) =>
+ Expression isBiggerThan(int i) =>
Comparison(this, ComparisonOperator.more, Variable(i));
@override
- Expression isSmallerThan(int i) =>
+ Expression isSmallerThan(int i) =>
Comparison(this, ComparisonOperator.less, Variable(i));
@override
diff --git a/sally/pubspec.yaml b/sally/pubspec.yaml
index cf5799f5..0c8e1426 100644
--- a/sally/pubspec.yaml
+++ b/sally/pubspec.yaml
@@ -1,8 +1,11 @@
name: sally
-description: A starting point for Dart libraries or applications.
-# version: 1.0.0
-# homepage: https://www.example.com
-# author: Simon Binder
+description: Sally is a safe and reactive persistence library for Dart applications
+version: 1.0.0
+homepage: https://github.com/simolus3/sally
+authors:
+ - Flutter Community
+ - Simon Binder
+maintainer: Simon Binder (@simolus3)
environment:
sdk: '>=2.0.0 <3.0.0'
diff --git a/sally/test/expressions/datetime_expression_test.dart b/sally/test/expressions/datetime_expression_test.dart
index 4b3324a1..66093dfe 100644
--- a/sally/test/expressions/datetime_expression_test.dart
+++ b/sally/test/expressions/datetime_expression_test.dart
@@ -3,7 +3,8 @@ import 'package:sally/src/runtime/components/component.dart';
import 'package:sally/src/runtime/expressions/expression.dart';
import 'package:test_api/test_api.dart';
-typedef Expression _Extractor(Expression d);
+typedef Expression _Extractor(
+ Expression d);
/// Tests the top level [year], [month], ..., [second] methods
void main() {
diff --git a/sally/test/expressions/in_expression_test.dart b/sally/test/expressions/in_expression_test.dart
index ddbfb785..7c7858c1 100644
--- a/sally/test/expressions/in_expression_test.dart
+++ b/sally/test/expressions/in_expression_test.dart
@@ -15,4 +15,4 @@ void main() {
expect(context.sql, 'name IN (?, ?)');
expect(context.boundVariables, ['Max', 'Tobias']);
});
-}
\ No newline at end of file
+}
diff --git a/sally/test/expressions/is_null_test.dart b/sally/test/expressions/is_null_test.dart
index 27b85458..37f39ed0 100644
--- a/sally/test/expressions/is_null_test.dart
+++ b/sally/test/expressions/is_null_test.dart
@@ -24,4 +24,4 @@ void main() {
expect(context.sql, 'name IS NOT NULL');
});
-}
\ No newline at end of file
+}
diff --git a/sally_flutter/README.md b/sally_flutter/README.md
index f0961db2..ef1e5e76 100644
--- a/sally_flutter/README.md
+++ b/sally_flutter/README.md
@@ -1,14 +1,259 @@
-# sally_flutter
+# Sally
+[](https://travis-ci.com/simolus3/sally)
-Flutter implementation for the sally database
+Sally is an easy to use and safe way to persist data for Flutter apps. It features
+a fluent Dart DSL to describe tables and will generate matching database code that
+can be used to easily read and store your app's data. It also features a reactive
+API that will deliver auto-updating streams for your queries.
-## Getting Started
+- [Sally](#sally)
+ * [Getting started](#getting-started)
+ + [Adding the dependency](#adding-the-dependency)
+ + [Declaring tables](#declaring-tables)
+ + [Generating the code](#generating-the-code)
+ * [Writing queries](#writing-queries)
+ + [Select statements](#select-statements)
+ - [Where](#where)
+ - [Limit](#limit)
+ + [Updates and deletes](#updates-and-deletes)
+ + [Inserts](#inserts)
+ * [Migrations](#migrations)
+ * [TODO-List and current limitations](#todo-list-and-current-limitations)
+ + [Limitions (at the moment)](#limitions--at-the-moment-)
+ + [Planned for the future](#planned-for-the-future)
+ + [Interesting stuff that would be nice to have](#interesting-stuff-that-would-be-nice-to-have)
-This project is a starting point for a Dart
-[package](https://flutter.io/developing-packages/),
-a library module containing code that can be shared easily across
-multiple Flutter or Dart projects.
+## Getting started
+### Adding the dependency
+First, let's add sally to your project's `pubspec.yaml`:
+TODO: Finish this part of the readme when sally is out on pub.
+```yaml
+dependencies:
+ sally:
+ git:
+ url:
+ path: sally/
-For help getting started with Flutter, view our
-[online documentation](https://flutter.io/docs), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+dev_dependencies:
+ sally_generator:
+ git:
+ url:
+ path: sally_generator/
+ build_runner:
+```
+We're going to use the `sally_flutter` library to specify tables and access the database. The
+`sally_generator` library will take care of generating the necessary code so the
+library knows how your table structure looks like.
+
+### Declaring tables
+You can use the DSL included with this library to specify your libraries with simple
+dart code:
+```dart
+import 'package:sally_flutter/sally_flutter.dart';
+
+// assuming that your file is called filename.dart. This will give an error at first,
+// but it's needed for sally to know about the generated code
+part 'filename.g.dart';
+
+// this will generate a table called "todos" for us. The rows of that table will
+// be represented by a class called "Todo".
+class Todos extends Table {
+ IntColumn get id => integer().autoIncrement()();
+ TextColumn get title => text().withLength(min: 6, max: 10)();
+ TextColumn get content => text().named('body')();
+ IntColumn get category => integer().nullable()();
+}
+
+// This will make sally generate a class called "Category" to represent a row in this table.
+// By default, "Categorie" would have been used because it only strips away the trailing "s"
+// in the table name.
+@DataClassName("Category")
+class Categories extends Table {
+
+ IntColumn get id => integer().autoIncrement()();
+ TextColumn get description => text()();
+}
+
+// this annotation tells sally to prepare a database class that uses both of the
+// tables we just defined. We'll see how to use that database class in a moment.
+@UseSally(tables: [Todos, Categories])
+class MyDatabase {
+
+}
+```
+
+__⚠️ Warning:__ Even though it might look like it, the content of a `Table` class does not support full Dart code. It can only
+be used to declare the table name, it's primary keys and columns. The code inside of a table class will never be
+executed. Instead, the generator will take a look at your table classes to figure out how their structure looks like.
+This won't work if the body of your tables is not constant. This should not be problem, but please be aware of this as you can't put logic inside these classes.
+
+### Generating the code
+Sally integrates with the dart `build` system, so you can generate all the code needed with
+`flutter packages pub run build_runner build`. If you want to continously rebuild the code
+whever you change your code, run `flutter packages pub run build_runner watch` instead.
+After running either command once, sally generator will have created a class for your
+database and data classes for your entities. To use it, change the `MyDatabase` class as
+follows:
+```dart
+@UseSally(tables: [Todos, Categories])
+class MyDatabase extends _$MyDatabase {
+ // we tell the database where to store the data with this constructor
+ MyDatabase() : super(FlutterQueryExecutor.inDatabaseFolder(path: 'db.sqlite'));
+
+ // you should bump this number whenever you change or add a table definition. Migrations
+ // are covered later in this readme.
+ @override
+ int get schemaVersion => 1;
+}
+```
+You can ignore the `schemaVersion` at the moment, the important part is that you can
+now run your queries with fluent Dart code:
+## Writing queries
+```dart
+class MyDatabase extends _$MyDatabase {
+ // .. the versionCode getter still needs to be here
+
+ // loads all todo entries
+ Future> get allTodoEntries => select(todos).get();
+
+ // watches all todo entries in a given category. The stream will automatically
+ // emit new items whenever the underlying data changes.
+ Stream> watchEntriesInCategory(Category c) {
+ return (select(todos)..where((t) => t.category.equals(c.id))).watch();
+ }
+}
+```
+### Select statements
+You can create `select` statements by starting them with `select(tableName)`, where the
+table name
+is a field generated for you by sally. Each table used in a database will have a matching field
+to run queries against. A query can be run once with `get()` or be turned into an auto-updating
+stream using `watch()`.
+#### Where
+You can apply filters to a query by calling `where()`. The where method takes a function that
+should map the given table to an `Expression` of boolean. A common way to create such expression
+is by using `equals` on expressions. Integer columns can also be compared with `isBiggerThan`
+and `isSmallerThan`. You can compose expressions using `and(a, b), or(a, b)` and `not(a)`.
+#### Limit
+You can limit the amount of results returned by calling `limit` on queries. The method accepts
+the amount of rows to return and an optional offset.
+### Updates and deletes
+You can use the generated `row` class to update individual fields of any row:
+```dart
+Future moveImportantTasksIntoCategory(Category target) {
+ return (update(todos)
+ ..where((t) => t.title.like('%Important%'))
+ ).write(TodoEntry(
+ category: target.id
+ ),
+ );
+}
+
+Future feelingLazy() {
+ // delete 10 todo entries just cause
+ return (delete(todos)..limit(10)).go();
+}
+```
+__⚠️ Caution:__ If you don't explicitly add a `where` or `limit` clause on updates or deletes,
+the statement will affect all rows in the table!
+
+### Inserts
+You can very easily insert any valid object into tables:
+```dart
+// returns the generated id
+Future addTodoEntry(Todo entry) {
+ return into(todos).insert(entry);
+}
+```
+All row classes generated will have a constructor that can be used to create objects:
+```dart
+addTodoEntry(
+ Todo(
+ title: 'Important task',
+ content: 'Refactor persistence code',
+ ),
+);
+```
+If a column is nullable or has a default value (this includes auto-increments), the field
+can be omitted. All other fields must be set and non-null. The `insert` method will throw
+otherwise.
+
+## Migrations
+Sally provides a migration API that can be used to gradually apply schema changes after bumping
+the `schemaVersion` getter inside the `Database` class. To use it, override the `migration`
+getter. Here's an example: Let's say you wanted to add a due date to your todo entries:
+```dart
+class Todos extends Table {
+ IntColumn get id => integer().autoIncrement()();
+ TextColumn get title => text().withLength(min: 6, max: 10)();
+ TextColumn get content => text().named('body')();
+ IntColumn get category => integer().nullable()();
+ DateTimeColumn get dueDate => dateTime().nullable()(); // we just added this column
+}
+```
+We can now change the `database` class like this:
+```dart
+ @override
+ int get schemaVersion => 1; // bump because the tables have changed
+
+ @override
+ MigrationStrategy get migration => MigrationStrategy(
+ onCreate: (Migrator m) {
+ return m.createAllTables();
+ },
+ onUpgrade: (Migrator m, int from, int to) async {
+ if (from == 1) {
+ // we added the dueDate propery in the change from version 1
+ await m.addColumn(todos, todos.dueDate);
+ }
+ }
+ );
+
+ // rest of class can stay the same
+```
+You can also add individual tables or drop them.
+
+## TODO-List and current limitations
+### Limitions (at the moment)
+- No joins
+- No `group by` or window functions
+- Custom primary key support is very limited
+- No `ORDER BY`
+
+### Planned for the future
+These aren't sorted by priority. If you have more ideas or want some features happening soon,
+let us know by creating an issue!
+
+- Refactor comparison API
+ 1. Instead of defining them in `IntColumn`, move `isBiggerThan` and `isSmallerThan` into
+ a new class (comparable expression?)
+ 2. Support for non-strict comparisons (<=, >=)
+ 3. Support `ORDER BY` clauses.
+- Specify primary keys
+- Simple `COUNT(*)` operations (group operations will be much more complicated)
+- Support default values and expressions
+- Allow using DAOs or some other mechanism instead of having to put everything in the main
+database class.
+- Support more Datatypes: We should at least support `Uint8List` out of the box,
+supporting floating / fixed point numbers as well would be awesome
+- Nullable / non-nullable datatypes
+ - DSL API ✔️
+ - Support in generator ✔️
+ - Use in queries (`IS NOT NULL`) ✔️
+ - Setting fields to null during updates
+- Support Dart VM apps
+- References
+ - DSL API
+ - Support in generator
+ - Validation
+- Table joins
+- Bulk inserts
+- Transactions
+### Interesting stuff that would be nice to have
+Implementing this will very likely result in backwards-incompatible changes.
+
+- Find a way to hide implementation details from users while still making them
+ accessible for the generated code
+- `GROUP BY` grouping functions
+- Support for different database engines
+ - Support webapps via `AlaSQL` or a different engine
\ No newline at end of file
diff --git a/sally_flutter/example/lib/bloc.dart b/sally_flutter/example/lib/bloc.dart
index a5309f8e..98b5093d 100644
--- a/sally_flutter/example/lib/bloc.dart
+++ b/sally_flutter/example/lib/bloc.dart
@@ -6,6 +6,12 @@ class TodoBloc {
Stream> get todosForHomepage => _db.todosWithoutCategories;
+ void createTodoEntry(String text) {
+ _db.addTodoEntry(TodoEntry(
+ content: text,
+ ));
+ }
+
void dispose() {
}
diff --git a/sally_flutter/example/lib/database.dart b/sally_flutter/example/lib/database.dart
index 01decad1..aef17e24 100644
--- a/sally_flutter/example/lib/database.dart
+++ b/sally_flutter/example/lib/database.dart
@@ -31,6 +31,18 @@ class Database extends _$Database {
@override
int get schemaVersion => 1;
+ @override
+ MigrationStrategy get migration => MigrationStrategy(
+ onCreate: (Migrator m) {
+ return m.createAllTables();
+ },
+ onUpgrade: (Migrator m, int from, int to) async {
+ if (from == 1) {
+ await m.addColumn(todos, todos.targetDate);
+ }
+ }
+ );
+
Stream> get definedCategories => select(categories).watch();
Stream> todosInCategories(List categories) {
@@ -39,6 +51,22 @@ class Database extends _$Database {
return (select(todos)..where((t) => isIn(t.category, ids))).watch();
}
+ Future deleteOldEntries() {
+ return (delete(todos)..where((t) => year(t.targetDate).equals(2017))).go();
+ }
+
+ Stream> watchEntriesInCategory(Category c) {
+ return (select(todos)..where((t) => t.category.equals(c.id))).watch();
+ }
+
Stream> get todosWithoutCategories =>
(select(todos)..where((t) => isNull(t.category))).watch();
+
+ Future test() {
+ (delete(todos)..limit(10)).go();
+ }
+
+ Future addTodoEntry(TodoEntry entry) {
+ return into(todos).insert(entry);
+ }
}
diff --git a/sally_flutter/example/lib/widgets/homescreen.dart b/sally_flutter/example/lib/widgets/homescreen.dart
index 00b176e0..7915a622 100644
--- a/sally_flutter/example/lib/widgets/homescreen.dart
+++ b/sally_flutter/example/lib/widgets/homescreen.dart
@@ -11,37 +11,32 @@ class HomeScreen extends StatelessWidget {
return Scaffold(
drawer: Text('Hi'),
- body: Column(
- children: [
- Expanded(
- flex: 9,
- child: CustomScrollView(
- slivers: [
- SliverAppBar(
- title: Text('TODO List'),
- ),
- StreamBuilder>(
- stream: bloc.todosForHomepage,
- builder: (ctx, snapshot) {
- final data = snapshot.hasData ? snapshot.data : [];
-
- return SliverList(
- delegate: SliverChildBuilderDelegate(
- (ctx, index) => Text(data[index].content),
- childCount: data.length,
- ),
- );
- },
- ),
- ],
- ),
+ body: CustomScrollView(
+ slivers: [
+ SliverAppBar(
+ title: Text('TODO List'),
),
- Expanded(
- flex: 9,
- child: Container(),
+ StreamBuilder>(
+ stream: bloc.todosForHomepage,
+ builder: (ctx, snapshot) {
+ final data = snapshot.hasData ? snapshot.data : [];
+
+ return SliverList(
+ delegate: SliverChildBuilderDelegate(
+ (ctx, index) => Text(data[index].content),
+ childCount: data.length,
+ ),
+ );
+ },
),
],
),
+ bottomSheet: Material(
+ elevation: 12.0,
+ child: TextField(
+ onSubmitted: bloc.createTodoEntry,
+ ),
+ ),
);
}
}
diff --git a/sally_flutter/pubspec.lock b/sally_flutter/pubspec.lock
index ea1fe0b1..477427c8 100644
--- a/sally_flutter/pubspec.lock
+++ b/sally_flutter/pubspec.lock
@@ -73,7 +73,7 @@ packages:
path: "../sally"
relative: true
source: path
- version: "0.0.0"
+ version: "1.0.0"
sky_engine:
dependency: transitive
description: flutter
diff --git a/sally_flutter/pubspec.yaml b/sally_flutter/pubspec.yaml
index 0091b92b..771c21df 100644
--- a/sally_flutter/pubspec.yaml
+++ b/sally_flutter/pubspec.yaml
@@ -1,8 +1,10 @@
name: sally_flutter
-description: Flutter implementation for the sally database
-version: 0.0.1
-author:
-homepage:
+description: Flutter implementation of sally, a safe and reactive persistence library for Dart applications
+version: 1.0.0
+authors:
+ - Flutter Community
+ - Simon Binder
+maintainer: Simon Binder (@simolus3)
environment:
sdk: ">=2.0.0-dev.68.0 <3.0.0"
diff --git a/sally_generator/README.md b/sally_generator/README.md
index 1cea57ea..6b1a3684 100644
--- a/sally_generator/README.md
+++ b/sally_generator/README.md
@@ -1,22 +1,7 @@
-A library for Dart developers.
+# Sally Generator
-Created from templates made available by Stagehand under a BSD-style
-[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE).
+This library contains the generator that turns your `Table` classes from sally
+into database code. When using the sally, you'll probably want to use the
+sally_flutter implementation directly.
-## Usage
-
-A simple usage example:
-
-```dart
-import 'package:sally_generator/sally_generator.dart';
-
-main() {
- var awesome = new Awesome();
-}
-```
-
-## Features and bugs
-
-Please file feature requests and bugs at the [issue tracker][tracker].
-
-[tracker]: http://example.com/issues/replaceme
+Please see the homepage of [sally](https://github.com/simolus3/sally) for details.
\ No newline at end of file
diff --git a/sally_generator/pubspec.yaml b/sally_generator/pubspec.yaml
index b3872cfb..5ec65b30 100644
--- a/sally_generator/pubspec.yaml
+++ b/sally_generator/pubspec.yaml
@@ -1,8 +1,11 @@
name: sally_generator
-description: A starting point for Dart libraries or applications.
-# version: 1.0.0
-# homepage: https://www.example.com
-# author: Simon Binder
+description: Sally generator generated database code from your table classes
+version: 1.0.0
+homepage: https://github.com/simolus3/sally
+authors:
+ - Flutter Community
+ - Simon Binder
+maintainer: Simon Binder (@simolus3)
environment:
sdk: '>=2.0.0 <3.0.0'
diff --git a/tool/license.sh b/tool/license.sh
index 2cae0b20..2fc4f5c6 100755
--- a/tool/license.sh
+++ b/tool/license.sh
@@ -1,11 +1,9 @@
#!/bin/bash
-rm -f example/LICENSE
rm -f sally/LICENSE
rm -f sally_flutter/LICENSE
rm -f sally_generator/LICENSE
-cp LICENSE example/LICENSE
cp LICENSE sally/LICENSE
cp LICENSE sally_flutter/LICENSE
cp LICENSE sally_generator/LICENSE
diff --git a/tool/readme_copier.sh b/tool/readme_copier.sh
new file mode 100755
index 00000000..600c3576
--- /dev/null
+++ b/tool/readme_copier.sh
@@ -0,0 +1,2 @@
+rm README.md
+cp sally_flutter/README.md README.md