0.4.0 (#11)

Author: simc

.travis.yml

@@ -1,24 +1,43 @@
 language: dart
 os:
-  - linux
-sudo: false
-dart:
-  - stable
-script:
-  - cd hive_generator
-  - pub get
-  - pub run test
+  - osx
+addons:
+  chrome: stable
+  firefox: latest
+jobs:
+  include:
+    - name: hive
+      script:
+        - cd hive
+        - pub get
+        - pub run test
 
-  - cd ../hive
-  - pub get
-  - pub run test -p "vm,chrome"
-  
-  - dartfmt -n --set-exit-if-changed ./lib ./test ./example || travis_terminate 1
+    - name: hive chrome
+      script:
+        - cd hive
+        - pub get
+        - pub run test -p "chrome"
+
+    - name: hive firefox
+      script:
+        - cd hive
+        - pub get
+        - pub run test -p "firefox"
+        
+    - name: hive_generator
+      script:
+        - cd hive_generator
+        - pub get
+        - pub run test
+      
+    - name: format
+      script:
+        - dartfmt -n --set-exit-if-changed ./lib ./test ./example || travis_terminate 1
+      
 
-  - pub global activate test_coverage
-  - test_coverage --exclude "**_js_test.dart"
-after_success:
-  - bash <(curl -s https://codecov.io/bash)
-cache:
-  directories:
-    - $HOME/.pub-cache
+    - stage: coverage
+      script:
+        - pub global activate test_coverage
+        - test_coverage --exclude "**_js_test.dart"
+      after_success:
+        - bash <(curl -s https://codecov.io/bash)

hive/CHANGELOG.md

@@ -1,10 +1,20 @@
 ## 0.4.0
-- Added BigInt support
+- Added `BigInt` support
 - Added `compactionStrategy` parameter
-- Added crash recovery
+- Added automatic crash recovery
+- Added `add()` and `addAll()` for auto increment keys
+- Added `getAt()`, `putAt()` and `deleteAt()` for working with indices
+- Support for int (32 bit unsigned) keys
+- Non-lazy boxes now notify their listeners immediately about changes
 - Bugfixes
-- More samples
 - More tests
+- **Breaking:** Open boxes with `openBox()`
+- **Breaking:** Writing `null` is no longer equivalent to deleting a key
+- **Breaking:** Temporarily removed support for transactions. New API design needed. Will be coming back in a future version.
+- **Breaking:** Binary format changed
+- **Breaking:** API changes
+
+*Note: This is probably the last version that breaks binary format. From version 1.0.0 onwards, there will be no breaking changes at all.*
 
 ## 0.3.0+1
 - Bugfix: `Hive['yourBox']` didn't work with uppercase box names

hive/README.md

@@ -40,14 +40,14 @@ In the browser you don't have to call `init()`.
 All of your data is stored in boxes.
 
 ```dart
-var box = await Hive.box('testBox');
+var box = await Hive.openBox('testBox');
 ```
 
 Just provide an `encryptionKey` to encrypt a box:
 
 ```dart
 var key = Hive.generateSecureKey();
-var box = await Hive.box('secureBox', encryptionKey: key);
+var box = await Hive.openBox('secureBox', encryptionKey: key);
 ```
 
 ### Read & Write
@@ -57,9 +57,9 @@ Hive supports all primitive types, `List`, `Map`, `DateTime` and `Uint8List`. An
 ```dart
 var dog = Dog(name: 'Nero', age: 4);
 
-await box.put('myDog', dog);
+box.put('myDog', dog);
 
-Dog myDog = await box.get('myDog');
+Dog myDog = box.get('myDog');
 ```
 
 ## Hive ❤️ Flutter
@@ -70,23 +70,23 @@ Hive was written with Flutter in mind. It is a perfect fit if you need a lightwe
 class SettingsPage extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
-    var box = Hive['settings'];
+    var box = Hive.box('settings');
 
     return Column(
       children: <Widget>[
         SwitchListTile(
-          value: box['darkMode'],
+          value: box.get('darkMode'),
           title: Text("Dark Mode"),
-          onChanged: (value) async {
-            await box.put('darkMode', !box['darkMode']);
+          onChanged: (value) {
+            box.put('darkMode', value);
             setState(() {});
           },
         ),
         SwitchListTile(
-          value: box['pushMessages'],
+          value: box.get('pushMessages'),
           title: Text('Send push messages'),
-          onChanged: (value) async {
-            await box.put('pushMessages', !box['pushMessages']);
+          onChanged: (value) {
+            box.put('pushMessages', value);
             setState(() {});
           },
         ),

hive/analysis_options.yaml

@@ -9,6 +9,7 @@ analyzer:
     include_file_not_found: ignore
 linter:
   rules:
+    - always_declare_return_types
     - annotate_overrides
     - avoid_empty_else
     - avoid_function_literals_in_foreach_calls

hive/example/main.dart

@@ -5,7 +5,7 @@ import 'package:hive/hive.dart';
 void main() async {
   Hive.init(Directory.current.path);
 
-  var box = await Hive.box('demoBox');
+  var box = await Hive.openBox('demoBox');
 
   await box.put('name', 'David');
   await box.put('age', 27);

hive/lib/hive.dart

@@ -15,6 +15,7 @@ part 'src/binary/binary_writer.dart';
 part 'src/registry/type_registry.dart';
 part 'src/registry/type_adapter.dart';
 part 'src/box/box.dart';
+part 'src/box/lazy_box.dart';
 part 'src/hive_error.dart';
 part 'src/hive.dart';
 

hive/lib/src/backend/storage_backend.dart

@@ -1,24 +1,29 @@
-import 'package:hive/src/box/box_impl.dart';
 import 'package:hive/src/binary/frame.dart';
+import 'package:hive/src/box/keystore.dart';
+
+export 'package:hive/src/backend/storage_backend_stub.dart'
+    if (dart.library.io) 'package:hive/src/backend/storage_backend_vm.dart'
+    if (dart.library.html) 'package:hive/src/backend/storage_backend_js.dart';
 
 abstract class StorageBackend {
   String get path;
 
-  Future<int> initialize(Map<String, BoxEntry> entries, bool lazy);
+  Future<int> initialize(
+      Map<dynamic, BoxEntry> entries, bool lazy, bool crashRecovery);
 
-  Future<dynamic> readValue(String key, int offset, int length);
+  Future<dynamic> readValue(dynamic key, int offset, int length);
 
-  Future<Map<String, dynamic>> readAll(Iterable<String> keys);
+  Future<Map<dynamic, dynamic>> readAll();
 
-  Future<BoxEntry> writeFrame(Frame frame, bool lazy);
+  Future<void> writeFrame(Frame frame, BoxEntry entry);
 
-  Future<List<BoxEntry>> writeFrames(List<Frame> frames, bool lazy);
+  Future<void> writeFrames(List<Frame> frames, Iterable<BoxEntry> entries);
 
-  Future<Map<String, BoxEntry>> compact(Map<String, BoxEntry> entries);
+  Future<Map<dynamic, BoxEntry>> compact(Map<dynamic, BoxEntry> entries);
 
-  Future clear();
+  Future<void> clear();
 
-  Future close();
+  Future<void> close();
 
-  Future deleteFromDisk();
+  Future<void> deleteFromDisk();
 }

hive/lib/src/backend/storage_backend_js.dart

@@ -6,13 +6,17 @@ import 'dart:typed_data';
 import 'package:hive/hive.dart';
 import 'package:hive/src/backend/storage_backend.dart';
 import 'package:hive/src/binary/frame.dart';
-import 'package:hive/src/box/box_options.dart';
+import 'package:hive/src/box/box_base.dart';
 import 'package:hive/src/box/box_impl.dart';
+import 'package:hive/src/box/box_options.dart';
+import 'package:hive/src/box/keystore.dart';
+import 'package:hive/src/box/lazy_box_impl.dart';
 import 'package:hive/src/crypto_helper.dart';
 import 'package:hive/src/hive_impl.dart';
 import 'package:meta/meta.dart';
 
-Future<BoxImpl> openBox(HiveImpl hive, String name, BoxOptions options) async {
+Future<Box> openBoxInternal(
+    HiveImpl hive, String name, bool lazy, BoxOptions options) async {
   var db = await window.indexedDB.open(name, version: 1, onUpgradeNeeded: (e) {
     var db = e.target.result as Database;
     if (!db.objectStoreNames.contains('box')) {
@@ -26,7 +30,12 @@ Future<BoxImpl> openBox(HiveImpl hive, String name, BoxOptions options) async {
   }
 
   var backend = StorageBackendJs(db, crypto);
-  var box = BoxImpl(hive, name, options, backend);
+  BoxBase box;
+  if (lazy) {
+    box = LazyBoxImpl(hive, name, options, backend);
+  } else {
+    box = BoxImpl(hive, name, options, backend);
+  }
   backend._registry = box;
 
   await box.initialize();
@@ -47,7 +56,8 @@ class StorageBackendJs extends StorageBackend {
 
   @visibleForTesting
   dynamic encodeValue(dynamic value) {
-    var noEncodingNeeded = value is num ||
+    var noEncodingNeeded = value == null ||
+        value is num ||
         value is bool ||
         value is String ||
         (value is List<num> && value is! Uint8List) ||
@@ -105,7 +115,8 @@ class StorageBackendJs extends StorageBackend {
   }
 
   @override
-  Future<int> initialize(Map<String, BoxEntry> entries, bool lazy) async {
+  Future<int> initialize(
+      Map<dynamic, BoxEntry> entries, bool lazy, bool crashRecovery) async {
     var keys = await getKeys();
     if (!lazy) {
       var values = await getValues();
@@ -114,54 +125,50 @@ class StorageBackendJs extends StorageBackend {
       }
     } else {
       for (var i = 0; i < keys.length; i++) {
-        entries[keys[i]] = const BoxEntry(null, null, null);
+        entries[keys[i]] = BoxEntry(null);
       }
     }
 
     return 0;
   }
 
   @override
-  Future<dynamic> readValue(String key, int offset, int length) async {
+  Future<dynamic> readValue(dynamic key, int offset, int length) async {
     var value = await getStore(false).getObject(key);
     return decodeValue(value);
   }
 
   @override
-  Future<Map<String, dynamic>> readAll(Iterable<String> keys) async {
-    return Map<String, dynamic>.fromIterables(keys, await getValues());
+  Future<Map<dynamic, dynamic>> readAll() async {
+    var keys = await getKeys();
+    var values = await getValues();
+    return Map<dynamic, dynamic>.fromIterables(keys, values);
   }
 
   @override
-  Future<BoxEntry> writeFrame(Frame frame, bool lazy) async {
+  Future<void> writeFrame(Frame frame, BoxEntry entry) async {
     if (frame.deleted) {
       await getStore(true).delete(frame.key);
-      return null;
     } else {
       await getStore(true).put(encodeValue(frame.value), frame.key);
-      return BoxEntry(!lazy ? frame.value : null, null, null);
     }
   }
 
   @override
-  Future<List<BoxEntry>> writeFrames(List<Frame> frames, bool lazy) async {
+  Future<void> writeFrames(
+      List<Frame> frames, Iterable<BoxEntry> entries) async {
     var store = getStore(true);
-    var entries = List<BoxEntry>(frames.length);
-    var i = 0;
     for (var frame in frames) {
       if (frame.deleted) {
         await store.delete(frame.key);
-        entries[i++] = null;
       } else {
         await store.put(encodeValue(frame.value), frame.key);
-        entries[i++] = BoxEntry(!lazy ? frame.value : null, null, null);
       }
     }
-    return entries;
   }
 
   @override
-  Future<Map<String, BoxEntry>> compact(Map<String, BoxEntry> entries) {
+  Future<Map<dynamic, BoxEntry>> compact(Map<dynamic, BoxEntry> entries) {
     return Future.value(entries);
   }
 

hive/lib/src/backend/storage_backend_stub.dart

@@ -1,6 +1,7 @@
-import 'package:hive/src/box/box_impl.dart';
+import 'package:hive/hive.dart';
 import 'package:hive/src/box/box_options.dart';
 import 'package:hive/src/hive_impl.dart';
 
-Future<BoxImpl> openBox(HiveImpl hive, String name, BoxOptions options) =>
+Future<Box> openBoxInternal(
+        HiveImpl hive, String name, bool lazy, BoxOptions options) =>
     throw UnsupportedError('Cannot create a box without dart:html or dart:io.');