expose sentry hive and updata documentation

Author: denrase

dart/lib/src/sentry_trace_origins.dart

@@ -20,7 +20,6 @@ class SentryTraceOrigins {
       'auto.db.sqflite.database_factory';
 
   static const autoDbHive = 'auto.db.hive';
-  static const autoDbHiveOpenDatabase = 'auto.db.hive.open_database';
   static const autoDbHiveBoxBase = 'auto.db.hive.box_base';
   static const autoDbHiveLazyBox = 'auto.db.hive.lazy_box';
 }

hive/README.md

@@ -6,4 +6,78 @@
 </p>
 
 Sentry integration for `hive` package
-===========
+===========
+
+| package     | build                                                                                                                                                                           | pub                                                                                                  | likes                                                                                                | popularity                                                                                                     | pub points |
+|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| ------- |
+| sentry_hive | [![build](https://github.com/getsentry/sentry-dart/workflows/sentry-hive/badge.svg?branch=main)](https://github.com/getsentry/sentry-dart/actions?query=workflow%3Asentry-hive) | [![pub package](https://img.shields.io/pub/v/sentry_hive.svg)](https://pub.dev/packages/sentry_hive) | [![likes](https://img.shields.io/pub/likes/sentry_hive)](https://pub.dev/packages/sentry_hive/score) | [![popularity](https://img.shields.io/pub/popularity/sentry_hive)](https://pub.dev/packages/sentry_hive/score) | [![pub points](https://img.shields.io/pub/points/sentry_hive)](https://pub.dev/packages/sentry_hive/score)
+
+Integration for the [`hive`](https://pub.dev/packages/hive) package.
+
+#### Usage
+
+- Sign up for a Sentry.io account and get a DSN at https://sentry.io.
+
+- Follow the installing instructions on [pub.dev](https://pub.dev/packages/sentry/install).
+
+- Initialize the Sentry SDK using the DSN issued by Sentry.io.
+
+- Call...
+
+```dart
+import 'package:sentry/sentry.dart';
+import 'package:hive/hive.dart';
+import 'package:sentry_hive/sentry_hive.dart';
+
+Future<void> main() async {
+  await SentryFlutter.init(
+    (options) {
+      options.dsn = 'https://example@sentry.io/add-your-dsn-here';
+      options.tracesSampleRate = 1.0;
+    },
+    appRunner: () => runApp(YourApp()),
+  );
+}
+
+Future<void> insertUser() async {
+  // Use [SentryHive] where you would use [Hive]
+  SentryHive
+    ..init(Directory.current.path)
+    ..registerAdapter(PersonAdapter());
+
+  var box = await SentryHive.openBox('testBox');
+
+  var person = Person(
+    name: 'Dave',
+    age: 22,
+  );
+
+  await box.put('dave', person);
+
+  print(box.get('dave')); // Dave: 22
+}
+
+@HiveType(typeId: 1)
+class Person {
+  Person({required this.name, required this.age});
+
+  @HiveField(0)
+  String name;
+
+  @HiveField(1)
+  int age;
+
+  @override
+  String toString() {
+    return '$name: $age';
+  }
+}
+```
+
+#### Resources
+
+* [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dart/)
+* [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)
+* [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)
+* [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](https://stackoverflow.com/questions/tagged/sentry)
+* [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)

hive/example/example.dart

@@ -1,16 +1,16 @@
-import 'package:hive/hive.dart';
 import 'package:sentry/sentry.dart';
+import 'package:hive/hive.dart';
 import 'package:sentry_hive/sentry_hive.dart';
 
 part 'main.g.dart';
 
 Future<void> main() async {
   // ATTENTION: Change the DSN below with your own to see the events in Sentry. Get one at sentry.io
   const dsn =
-  'https://e85b375ffb9f43cf8bdf9787768149e0@o447951.ingest.sentry.io/5428562';
+      'https://e85b375ffb9f43cf8bdf9787768149e0@o447951.ingest.sentry.io/5428562';
 
   await Sentry.init(
-        (options) {
+    (options) {
       options.dsn = dsn;
       options.tracesSampleRate = 1.0;
       options.debug = true;
@@ -20,16 +20,21 @@ Future<void> main() async {
 }
 
 Future<void> runApp() async {
-  Hive
+  // Use [SentryHive] where you would use [Hive]
+  SentryHive
     ..init(Directory.current.path)
     ..registerAdapter(PersonAdapter());
 
-  var box = await Hive.openBox('testBox');
+  var box = await SentryHive.openBox('testBox');
 
-  var sentryBox = SentryBox
+  var person = Person(
+    name: 'Dave',
+    age: 22,
+  );
 
-  var person = Person(name: 'Dave', age: 23);
+  await box.put('dave', person);
 
+  print(box.get('dave')); // Dave: 22
 }
 
 @HiveType(typeId: 1)

hive/lib/sentry_hive.dart

@@ -1,4 +1,14 @@
 library sentry_hive;
 
-export 'src/sentry_hive.dart';
-export 'src/sentry_box.dart';
+import 'package:meta/meta.dart';
+import 'package:hive/hive.dart';
+import 'src/sentry_hive_impl.dart';
+import 'src/sentry_hive_interface.dart';
+
+export 'src/sentry_hive_interface.dart';
+
+/// Use [SentryHive] constant instead of [Hive] to get automatic performance
+/// monitoring.
+@experimental
+// ignore: non_constant_identifier_names
+SentryHiveInterface SentryHive = SentryHiveImpl(Hive);

hive/lib/src/default_key_comparator.dart

@@ -17,4 +17,4 @@ int defaultKeyComparator(dynamic k1, dynamic k2) {
   } else {
     return 1;
   }
-}
+}

hive/lib/src/sentry_box.dart

@@ -4,13 +4,12 @@ import 'package:sentry/sentry.dart';
 
 import 'sentry_box_base.dart';
 
-///
-@experimental
+/// @nodoc
+@internal
 class SentryBox<E> extends SentryBoxBase<E> implements Box<E> {
-
   final Box<E> _box;
 
-  ///
+  /// @nodoc
   SentryBox(this._box, @internal Hub hub) : super(_box, hub);
 
   @override

hive/lib/src/sentry_box_base.dart

@@ -1,16 +1,15 @@
-
 import 'package:hive/hive.dart';
 import 'package:meta/meta.dart';
 import 'package:sentry/sentry.dart';
 import 'sentry_hive_impl.dart';
 
-///
+/// @nodoc
+@internal
 class SentryBoxBase<E> implements BoxBase<E> {
-
   final BoxBase<E> _boxBase;
   final Hub _hub;
 
-  ///
+  /// @nodoc
   SentryBoxBase(this._boxBase, this._hub);
 
   @override
@@ -145,7 +144,8 @@ class SentryBoxBase<E> implements BoxBase<E> {
 
   // Helper
 
-  Future<T> _asyncWrapInSpan<T>(String description, Future<T> Function() execute) async {
+  Future<T> _asyncWrapInSpan<T>(
+      String description, Future<T> Function() execute) async {
     final currentSpan = _hub.getSpan();
     final span = currentSpan?.startChild(
       SentryHiveImpl.dbOp,
@@ -172,4 +172,4 @@ class SentryBoxBase<E> implements BoxBase<E> {
       await span?.finish();
     }
   }
-}
+}