objectbox · Buggaboo · Oct 23, 2019 · Oct 23, 2019 · Oct 23, 2019 · Oct 24, 2019
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,28 @@
+0.4.0 (2019-10-31)
+------------------
+* Flutter Android support
+* Queries for all currently supported types  
+    (thanks [Jasm Sison](https://github.com/Buggaboo) for [#27](https://github.com/objectbox/objectbox-dart/pull/27) and [#46](https://github.com/objectbox/objectbox-dart/pull/46)]
+* More Box functions (count, isEmpty, contains, remove and their bulk variants)
+    (thanks [liquidiert](https://github.com/liquidiert) for [#42](https://github.com/objectbox/objectbox-dart/pull/42) and [#45](https://github.com/objectbox/objectbox-dart/pull/45)]
+* Explicit write transactions
+    (thanks [liquidiert](https://github.com/liquidiert) for [#50](https://github.com/objectbox/objectbox-dart/pull/50)]    
+* Resolved linter issues
+    (thanks [Gregory Sech](https://github.com/GregorySech) for [#31](https://github.com/objectbox/objectbox-dart/pull/31)]
+* Updated to objectbox-c 0.7.2
+* First release on pub.dev
+
 0.3.0 (2019-10-15)
 ------------------
 * ID/UID generation and model persistence (objectbox-model.json)
 * CI tests using GitHub Actions
 * Code cleanup, refactoring and formatting 
-    (thanks [Buggaboo](https://github.com/Buggaboo) for [#20](https://github.com/objectbox/objectbox-dart/pull/20) & [#21](https://github.com/objectbox/objectbox-dart/pull/21)]
+    (thanks [Jasm Sison](https://github.com/Buggaboo) for [#20](https://github.com/objectbox/objectbox-dart/pull/20) & [#21](https://github.com/objectbox/objectbox-dart/pull/21)]
 
 0.2.0 (2019-09-11)
-------------------
+------------------Buggaboo
 * UTF-8 support for Store and Box 
-    (thanks to [Buggaboo](https://github.com/Buggaboo) for [#14](https://github.com/objectbox/objectbox-dart/pull/14)!)
+    (thanks to [Jasm Sison](https://github.com/Buggaboo) for [#14](https://github.com/objectbox/objectbox-dart/pull/14)!)
 * Bulk put and get functions (getMany, getAll, putMany)
 * Updated to objectbox-c 0.7
 * Basic Store options

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+Contributing
+------------------
+This project is completely managed on GitHub using its [issue tracker](https://github.com/objectbox/objectbox-dart/issues) and [project boards](https://github.com/objectbox/objectbox-dart/projects).
+
+Anyone can contribute, be it by coding, improving docs or just proposing a new feature. 
+Look for tasks having a [**"help wanted"**](https://github.com/objectbox/objectbox-dart/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag. 
+When picking up an existing issue, please let us know in the issue comment. 
+Don't hesitate to reach out for guidance or to discuss a solution proposal!
+
+### Code contributions
+When creating a Pull Request for code changes, please check that you cover the following:
+* Include tests for the changes you introduce. See the [test folder](test) for examples.
+* Formatted the code using `dartfmt -l 120`. You can configure your IDE to do this automatically, 
+  e.g. VS Code needs the project-specific settings `"editor.defaultFormatter": "Dart-Code.dart-code"` and `"dart.lineLength": 120`.
+
+### Project workflow
+Issues on the [project board](https://github.com/objectbox/objectbox-dart/projects/3) are referred to as "cards" which move from left to right:
+
+* New cards start in the "To Do" column.
+  Within the column, cards are ordered: more important tasks should be above less important ones.  
+* Once somebody starts on a task, the according card is moved to "In progress".
+  Also, please assign yourself to the issue.
+* Once a task is considered complete (e.g. PR is made), put it in the "Review" column.
+* Once another person had a look and is happy, the task is finally moved to "Done" and its closed.
+
+### Basic technical approach
+ObjectBox offers a [C API](https://github.com/objectbox/objectbox-c) which can be called by [Dart FFI](https://dart.dev/server/c-interop).
+The C API is is also used by the ObjectBox language bindings for [Go](https://github.com/objectbox/objectbox-go), [Swift](https://github.com/objectbox/objectbox-swift), and [Python](https://github.com/objectbox/objectbox-python).
+These language bindings currently serve as an example for this Dart implementation.
+Internally, ObjectBox uses [FlatBuffers](https://google.github.io/flatbuffers/) to store objects.
diff --git a/README.md b/README.md
@@ -2,68 +2,50 @@ ObjectBox for Dart/Flutter
 ==========================
 ObjectBox for Dart is a standalone database storing Dart objects locally, with strong ACID semantics.
 
-Help wanted
------------
-ObjectBox for Dart is still in a prototype stage supporting only the most basic database tasks, like putting and getting objects.
-However, the ObjectBox core supports many more features, e.g. queries, indexing, async operations, transaction control.
-To bring all these features to Dart, we're asking the community to help out. PRs are more than welcome!
-The ObjectBox team will try its best to guide you and answer questions. 
-
-Contributing
-------------------
-This project is completely managed here on GitHub using its [issue tracker](https://github.com/objectbox/objectbox-dart/issues) and [project boards](https://github.com/objectbox/objectbox-dart/projects).
-
-To prepare an upcoming version, we create a (Kanban like) board for it.
-Once it is decided which features and fixes go into the version, the according issues are added to the board.
-Issues on the board are referred to as "cards" which move from left to right:
-
-* New cards start in the "To Do" column.
-  Within the column, cards are ordered: more important tasks should be above less important ones.  
-* Once somebody starts on a task, the according card is moved to "In progress".
-  Also, please assign yourself to the issue.
-* Once a task is considered complete (e.g. PR is made), put it in the "Review" column.
-* Once another person had a look and is happy, the task is finally moved to "Done"
-
-Anyone can contribute, be it by coding, improving docs or just proposing a new feature. 
-Look for tasks having a **"help wanted"** tag.
-
-#### Feedback
-Also, please let us know your feedback by opening an issue:
-for example, if you experience errors or if you have ideas for how to improve the API.
-Thanks!
+Installation
+------------
+Add the following dependencies to your `pubspec.yaml`:
+```yaml
+dependencies:
+  objectbox: ^0.4.0
+
+dev_dependencies:
+  build_runner: ^1.0.0
+  objectbox_generator: ^0.4.0
+```
 
-#### Code style
-Please make sure that all code submitted via Pull Request is formatted using `dartfmt -l 120`. 
-You can configure your IDE to do this automatically, e.g. VS Code needs the project-specific settings 
-`"editor.defaultFormatter": "Dart-Code.dart-code"` and `"dart.lineLength": 120`.
+Proceed based on whether you're developing a Flutter app or a standalone dart program:
+1. **Flutter** only steps:
+    * Install the packages `flutter pub get`
+    * Add `objectbox-android` dependency to your `android/app/build.gradle` 
+        ```
+        dependencies {
+            implementation "io.objectbox:objectbox-android:2.4.1"
+            ...
+       ```
+    * iOS coming soon
+1. **Dart standalone programs**:
+    * Install the packages `pub get`
+    * Install [objectbox-c](https://github.com/objectbox/objectbox-c) system-wide:
+       * macOS/Linux: execute the following command (answer Y when it asks about installing to /usr/lib) 
+            ```shell script
+            bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-c/master/download.sh) 0.7.2
+            ```
+       * macOS: if dart later complains that it cannot find the `libobjectbox.dylib` you probably have to unsign the 
+         `dart` binary (source: [dart issue](https://github.com/dart-lang/sdk/issues/38314#issuecomment-534102841)):
+            ```shell script
+            sudo xcode --remove-signature $(which dart)
+            ```
+       * Windows: use "Git Bash" or similar to execute the following command 
+            ```shell script
+            bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-c/master/download.sh) 0.7.2
+            ```
+            Then copy the downloaded `lib/objectbox.dll` to `C:\Windows\System32\` (requires admin privileges).
+
+ObjectBox generates code binding code for classes you want stored based using build_runner.
+After you've defined your persisted entities (see below), run `pub run build_runner build` or `flutter pub run build_runner build`.
 
 Getting started
----------------
-To try out the demo code in this repository, follow these steps:
-
-1. Install [objectbox-c](https://github.com/objectbox/objectbox-c) system-wide:
-   * macOS/Linux: `bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-c/master/download.sh) 0.7` (answer Y when it asks about installing to /usr/lib).
-   * Windows: 
-        * use "Git Bash" or similar to execute `bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-c/master/download.sh) 0.7`
-        * copy the downloaded `lib/objectbox.dll` to `C:\Windows\System32\` (requires admin privileges)
-2. Back in this repository, run `pub get`.
-3. Execute `pub run build_runner build`. This regenerates the ObjectBox model to make it usable in Dart 
-   (i.e. the file `test/test.g.dart`) and is necessary each time you add or change a class annotated with `@Entity(...)`.
-4. Finally run `pub run test` to run the unit tests.
-
-Mac OS signed dart binary issue
--------------------------------
-
-If dart complains that it cannot find the `libobjectbox.dylib`, after you've installed by following step 1,
-then you probably have to unsign the dart binary:
-
-```bash
-sudo xcode --remove-signature `which dart`
-``` 
-
-source: [dart issue](https://github.com/dart-lang/sdk/issues/38314#issuecomment-534102841)
-
-Dart integration
 ----------------
 In general, Dart class annotations are used to mark classes as ObjectBox entities and provide meta information.
 Note that right now, only a limited set of types is supported; this will be expanded upon in the near future.
@@ -110,8 +92,7 @@ print("refetched note: ${box.get(note.id)}");
 store.close();
 ```
 
-Query and QueryBuilder
-----------------------
+### Query and QueryBuilder
 
 Basic querying can be done with e.g.:
 
@@ -124,7 +105,7 @@ box.put(Note.construct("Hello world!"));
 
 final queryNullText = box.query(Note_.text.isNull()).build();
 
-assert (queryNullText.count() == 3);
+assert(queryNullText.count() == 3);
 
 queryNullText.close(); // We have to manually close queries and query builders.
 ```
@@ -136,16 +117,15 @@ respectively `==`, `>`, `<`, `&`, `|`.
 ```dart
 // final box ...
 
-box.query(text.equal("meh").or(text.equal("bleh")).or(text.contains("Hello"))).build();
+box.query(value.greaterThan(10).or(date.IsNull())).build();
 
 // equivalent to
 
-final overloaded = ((text == "meh") | (text == "bleh")) | text.contains("Hello");
+final overloaded = (value > 10) | date.IsNull();
 box.query(overloaded as Condition).build(); // the cast is necessary due to the type analyzer
 ```
 
-Ordering
---------
+### Ordering
 
 The results from a query can be ordered using the `order` method, e.g.
 
@@ -161,20 +141,21 @@ final qt = box.query(Entity_.text.notNull())
   .build();
 ```
 
-Basic technical approach
-------------------------
-ObjectBox offers a [C API](https://github.com/objectbox/objectbox-c) which can be called by [Dart FFI](https://dart.dev/server/c-interop).
-The C API is is also used by the ObjectBox language bindings for [Go](https://github.com/objectbox/objectbox-go), [Swift](https://github.com/objectbox/objectbox-swift), and [Python](https://github.com/objectbox/objectbox-python).
-These language bindings currently serve as an example for this Dart implementation.
+Help wanted
+-----------
+ObjectBox for Dart is still in an early stage with limited feature set (compared to other languages).
+To bring all these features to Dart, we're asking the community to help out. PRs are more than welcome!
+The ObjectBox team will try its best to guide you and answer questions. 
 
-Internally, ObjectBox uses [FlatBuffers](https://google.github.io/flatbuffers/) to store objects.
-There are two basic ways to make the conversion: generated binding code, or implicit FlatBuffers conversion.
-The latter is used at the moment (helped us to get started quickly).
-A future version will exchange that with code generation.  
+### Feedback
+Also, please let us know your feedback by opening an issue:
+for example, if you experience errors or if you have ideas for how to improve the API.
+Thanks!
 
-Changelog
+See also
 ---------
-[CHANGELOG.md](CHANGELOG.md)
+* [Changelog](CHANGELOG.md)
+* [Contribution guidelines](CONTRIBUTING.md)
 
 License
 -------

diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -2,4 +2,10 @@ include: package:pedantic/analysis_options.yaml
 
 linter:
   rules:
-    unrelated_type_equality_checks: false  # query condition operator overrides
+    # additional rules used by pub.dev
+    - non_constant_identifier_names
+
+analyzer:
+  exclude:
+    - example/**
+    - generator/**   # needs to be checked separately because its a separate package
diff --git a/docs/code-generation.md → doc/code-generation.md b/docs/code-generation.md → doc/code-generation.md
@@ -2,11 +2,11 @@
 
 To make it possible to read and write ObjectBox entity instances as easily as possible, wrapper code needs to be generated. Such code is only generated for Dart classes which have been annotated to indicate that they represent an ObjectBox entity (i.e. using [`@Entity`](/lib/src/annotations.dart#L1)). For a Dart source file called `myentity.dart`, which contains an entity definition, a file called `myentity.g.dart` is generated in the same directory by invoking the command `pub run build_runner build`.
 
-Unfortunately, only few documentation exists on how to generate code using Dart's `build`, `source_gen` and `build_runner`, so the approach taken here by `objectbox_model_generator` is documented in the following.
+Unfortunately, only few documentation exists on how to generate code using Dart's `build`, `source_gen` and `build_runner`, so the approach taken here by `objectbox_generator` is documented in the following.
 
 ## Basics
 
-In order to set up code generation, a new package needs to be created exclusively for this task. Here, it it called `objectbox_model_generator`. This package needs to contain a file called [`build.yaml`](/generator/build.yaml) as well as an entry point for the builder, [`builder.dart`](/generator/lib/builder.dart), and a generator specifically for one annotation class, [`generator.dart`](/generator/lib/src/generator.dart). The latter needs to contain a class which extends `GeneratorForAnnotation<obx.Entity>` and overrides `Future<String> generateForAnnotatedElement(Element elementBare, ConstantReader annotation, BuildStep buildStep)`, which returns a string containing the generated code for a single annotation instance.
+In order to set up code generation, a new package needs to be created exclusively for this task. Here, it it called `objectbox_generator`. This package needs to contain a file called [`build.yaml`](/generator/build.yaml) as well as an entry point for the builder, [`objectbox_generator.dart`](/generator/lib/objectbox_generator.dart), and a generator specifically for one annotation class, [`generator.dart`](/generator/lib/src/generator.dart). The latter needs to contain a class which extends `GeneratorForAnnotation<obx.Entity>` and overrides `Future<String> generateForAnnotatedElement(Element elementBare, ConstantReader annotation, BuildStep buildStep)`, which returns a string containing the generated code for a single annotation instance.
 
 It is then possible to traverse through the annotated class in `generateForAnnotatedElement` and e.g. determine all class member fields and their types. Additionally, such member fields can be annotated themselves, but because here, only the `@Entity` annotation is explicitly handled using a separate generator class, member annotations can be read and processed in line.
 
@@ -20,7 +20,7 @@ Eventually, `mergeEntity` either throws an error in case the model cannot be mer
 
 ## Testing
 
-For accomplishing actually automated testing capabilities for `objectbox_model_generator`, various wrapper classes are needed, as the `build` package is only designed to generate output _files_; yet, during testing, it is necessary to dump generated code to string variables, so they can be compared easily by Dart's `test` framework.
+For accomplishing actually automated testing capabilities for `objectbox_generator`, various wrapper classes are needed, as the `build` package is only designed to generate output _files_; yet, during testing, it is necessary to dump generated code to string variables, so they can be compared easily by Dart's `test` framework.
 
 The entry function for generator testing is the main function of [`generator_test.dart`](/generator/test/generator_test.dart). It makes sure that any existing file called `objectbox-model.json` is removed before every test, because we want a fresh start each time.
 

diff --git a/docs/modelinfo.md → doc/modelinfo.md b/docs/modelinfo.md → doc/modelinfo.md
@@ -14,4 +14,4 @@ Nonetheless, the concrete implementation in this repository is documented in the
 - [`ModelEntity`](/lib/src/modelinfo/modelentity.dart) describes an entity of a model and consists of instances of `ModelProperty` as well as an id, name and last property id
 - [`ModelInfo`](/lib/src/modelinfo/modelinfo.dart) logically contains an entire ObjectBox model file like [this one](/objectbox-model.json) and thus consists of an array of `ModelEntity` as well as various meta information for ObjectBox and model version information
 
-Such model meta information is only actually needed when generating `objectbox-model.json`, i.e. when `objectbox_model_generator` is invoked. This is the case in [`generator.dart`](/generator/lib/src/generator.dart#L24). In [generated code](/generator/lib/src/code_chunks.dart#L12), the JSON file is loaded in the same way, but only the `ModelEntity` instances are kept.
+Such model meta information is only actually needed when generating `objectbox-model.json`, i.e. when `objectbox_generator` is invoked. This is the case in [`generator.dart`](/generator/lib/src/generator.dart#L24). In [generated code](/generator/lib/src/code_chunks.dart#L12), the JSON file is loaded in the same way, but only the `ModelEntity` instances are kept.
diff --git a/example/README.md b/example/README.md
@@ -1,4 +1,4 @@
 ObjectBox Examples
 ==========================
 
-* [Flutter desktop app](flutter/objectbox_demo_desktop) - requires (pre-release) Flutter 1.10 (Dart 2.6) 
+* [Flutter android app](flutter/objectbox_demo) - requires Flutter 1.9 
diff --git a/example/flutter/objectbox_demo/.gitignore b/example/flutter/objectbox_demo/.gitignore
@@ -0,0 +1,38 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Exceptions to above rules.
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
+
+objectbox
diff --git a/example/flutter/objectbox_demo/.metadata b/example/flutter/objectbox_demo/.metadata
@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: a4d5266b769e92286a48f6b6714e538f2c4578dc
+  channel: master
+
+project_type: app
diff --git a/example/flutter/objectbox_demo/README.md b/example/flutter/objectbox_demo/README.md
@@ -0,0 +1,5 @@
+# objectbox_demo
+
+## Getting Started
+
+This project contains the Flutter version of the main example from the [objectbox-examples](https://github.com/objectbox/objectbox-examples) repository.
diff --git a/example/flutter/objectbox_demo/android/.gitignore b/example/flutter/objectbox_demo/android/.gitignore
@@ -0,0 +1,7 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java