update examples to null-safety and accept --sync argument in install.sh

Author: Ivan Dlugos

install.sh

@@ -10,11 +10,12 @@ set -eu
 #   * have a look at the changed files to see if some call sites need to be updated
 cLibVersion=0.13.0
 os=$(uname)
+cLibArgs="$*"
 
 # if there's no tty this is probably part of a docker build - therefore we install the c-api explicitly
-cLibArgs=
-if [[ "$os" != MINGW* ]] && [[ "$os" != CYGWIN* ]]; then
+if [[ "$os" != MINGW* ]] && [[ "$os" != CYGWIN* ]] && [[ "$cLibArgs" != *"--install"* ]]; then
   tty -s || cLibArgs="${cLibArgs} --install"
 fi
 
+
 bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-c/main/download.sh) ${cLibArgs} ${cLibVersion}

objectbox/README.md

@@ -24,19 +24,19 @@ class Person {
 
   String firstName;
   String lastName;
+
+  Person({this.id = 0, required this.firstName, required this.lastName});
 }
 
 // Note: in Flutter you also need to specify a directory, see examples.
 final store = Store(getObjectBoxModel());
 final box = store.box<Person>();
 
-var person = Person()
-  ..firstName = "Joe"
-  ..lastName = "Green";
+var person = Person(firstName: 'Joe', lastName: 'Green');
 
 final id = box.put(person);  // Create
 
-person = box.get(id);        // Read
+person = box.get(id)!;        // Read
 
 person.lastName = "Black";
 box.put(person);             // Update
@@ -87,6 +87,12 @@ dev_dependencies:
   ```shell script
   bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-dart/main/install.sh)
   ```
+  
+  To install ObjectBox Sync variant of the native library, pass `--sync` argument to the script:
+  
+  ```shell script
+  bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-dart/main/install.sh) --sync
+  ```
 
 * macOS: dart might later complain that it cannot find the `libobjectbox.dylib`. You probably have to unsign the `dart`
   binary - see [this dart issue](https://github.com/dart-lang/sdk/issues/38314#issuecomment-534102841) for details.

objectbox/example/README.md

@@ -17,22 +17,22 @@ import 'package:objectbox/objectbox.dart';
 
 @Entity()
 class Note {
-    // Each "Entity" needs a unique integer ID property.
-    // Add `@Id()` annotation if its name isn't "id" (case insensitive).
-    int id;
+  // Each "Entity" needs a unique integer ID property.
+  // Add `@Id()` annotation if its name isn't "id" (case insensitive).
+  int id = 0;
 
-    String text;
+  String? text;
 
-    DateTime date;
+  DateTime date;
 
-    @Transient() // Make this field ignored, not stored in the database.
-    int notPersisted;
+  @Transient() // Make this field ignored, not stored in the database.
+  int? notPersisted;
 
-    // An empty default constructor is needed but you can use optional args.
-    Note({this.text});
+  // An empty default constructor is needed but you can use optional args.
+  Note({this.text, DateTime? date}) : date = date ?? DateTime.now();
 
-    // Note: just for logs in the examples below(), not needed by ObjectBox.
-    toString() => 'Note{id: $id, text: $text}';
+  // Note: just for logs in the examples below(), not needed by ObjectBox.
+  toString() => 'Note{id: $id, text: $text}';
 }
 ```
 
@@ -121,7 +121,7 @@ final box = store.box<Note>();
 final note = Note(text: 'Hello'); // note: note.id is null
 final id = box.put(note);         // note: sets note.id and also returns it
 print('new note got id=${id}, which is the same as note.id=${note.id}');
-print('refetched note: ${box.get(id)}');
+print('re-read note: ${box.get(id)}');
 ```
 
 Queries
@@ -175,7 +175,7 @@ Use "Property Queries" If you're interested only in a single property from an En
 You can access a list of property values across matching objects, or an aggregation.
 
 ```dart
-final query = box.query(Note_.date > 0).build()
+final query = box.query(Note_.date > 0).build();
 
 // Use distinct or caseSensitive to refine results.
 final textQuery = query.stringProperty(Note_.text)
@@ -213,9 +213,8 @@ final sub1 = queryStream.listen((query) {
 
 sub1.cancel();
 
-final stream = query.findStream(limit:5);
-final sub2 = stream.listen((list) {
-  // ...
+final sub2 = queryStream.listen((query) {
+  print(query.find());
 });
 
 // clean up
@@ -245,21 +244,21 @@ Have a look at the following example how a shop database could look like.
 ```dart
 @Entity()
 class Customer {
-  int id;
-  String name;
+  int id = 0;
+  String? name;
 }
 
 @Entity()
 class Order {
-  int id;
+  int id = 0;
 
   final customer = ToOne<Customer>();
   final items = ToMany<Item>();
 }
 
 @Entity()
 class Item {
-  int id;
+  int id = 0;
 }
 ```
 
@@ -291,24 +290,24 @@ Example: Two `Order` objects point to the same `Customer` using a `ToOne`. The b
 ```dart
 @Entity()
 class Customer {
-  int id;
-  String name;
+  int id = 0;
+  String? name;
   
   @Backlink()
   final orders = ToMany<Order>();
 }
 
 @Entity()
 class Order {
-  int id;
+  int id = 0;
 
   final customer = ToOne<Customer>();
   final items = ToMany<Item>();
 }
 
 @Entity()
 class Item {
-  int id;
+  int id = 0;
 }
 ```
 
@@ -324,21 +323,21 @@ such a backlink to `Item`, so that we can access all `Order`s where this `Item`
 ```dart
 @Entity()
 class Customer {
-  int id;
-  String name;
+  int id = 0;
+  String? name;
 }
 
 @Entity()
 class Order {
-  int id;
+  int id = 0;
 
   final customer = ToOne<Customer>();
   final items = ToMany<Item>();
 }
 
 @Entity()
 class Item {
-  int id;
+  int id = 0;
   
   @Backlink()
   final orders = ToMany<Order>();

objectbox/test/box_test.dart

@@ -39,7 +39,7 @@ void main() {
 
   test('.put() returns a valid id', () {
     final object = TestEntity(tString: 'Hello');
-    expect(object.id ?? 0, isZero);
+    expect(object.id, isZero);
     int putId = box.put(object);
     expect(putId, greaterThan(0));
     expect(object.id, equals(putId)); // ID on the object is updated
@@ -458,7 +458,7 @@ void main() {
   test('assignable IDs', () {
     // TestEntity.id IS NOT assignable so this must fail
     expect(
-        () => box.put(TestEntity(id: 1)),
+        () => box.put(TestEntity()..id = 1),
         throwsA(predicate((ObjectBoxException e) => e
             .toString()
             .contains('ID is higher or equal to internal ID sequence'))));

objectbox/test/entity.dart

@@ -13,7 +13,7 @@ class TestingUnknownAnnotation {
 @Sync()
 class TestEntity {
   @TestingUnknownAnnotation()
-  int? id;
+  int id = 0;
 
   // implicitly determined types
   String? tString;
@@ -67,8 +67,7 @@ class TestEntity {
   Uint8List? tUint8List;
 
   TestEntity(
-      {this.id,
-      this.tString,
+      {this.tString,
       this.tLong,
       this.tDouble,
       this.tBool,
@@ -101,7 +100,7 @@ class TestEntity {
     tUint8List = Uint8List.fromList([7, 8, 9]);
   }
 
-  TestEntity.ignoredExcept(this.tInt) {
+  TestEntity.ignoredExcept(this.tInt) : tString = '' {
     omit = -1;
     disregard = 1;
   }
@@ -136,7 +135,7 @@ class TestEntity {
     this.uShort,
     this.uByte,
     this.uChar,
-  });
+  }): tString = '';
 
   @Property(type: PropertyType.byte)
   @Index()
@@ -168,7 +167,7 @@ class TestEntity {
     this.iShort,
     this.iByte,
     this.iChar,
-  });
+  }): tString = '';
 
   final relA = ToOne<RelatedEntityA>();
   final relB = ToOne<RelatedEntityB>();