v0.2.4 (#12)

jogboms · Feb 17, 2019 · 0dcbc4f · 0dcbc4f
1 parent bab1d29
commit 0dcbc4f
Show file tree

Hide file tree

Showing 10 changed files with 315 additions and 268 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ A tidy utility to handle offline/online connectivity like a Boss. It provides su
 
 ```yaml
 dependencies:
-  flutter_offline: "^0.2.3"
+  flutter_offline: "^0.2.4"
 ```
 
 ### ⚡️ Import

diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -1,158 +1 @@
-# From: https://github.com/flutter/flutter/blob/master/analysis_options.yaml
-#
-# Specify analysis options.
-#
-# Until there are meta linter rules, each desired lint must be explicitly enabled.
-# See: https://github.com/dart-lang/linter/issues/288
-#
-# For a list of lints, see: http://dart-lang.github.io/linter/lints/
-# See the configuration guide for more
-# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer
-#
-# There are four similar analysis options files in the flutter repos:
-#   - analysis_options.yaml (this file)
-#   - packages/flutter/lib/analysis_options_user.yaml
-#   - https://github.com/flutter/plugins/blob/master/analysis_options.yaml
-#   - https://github.com/flutter/engine/blob/master/analysis_options.yaml
-#
-# This file contains the analysis options used by Flutter tools, such as IntelliJ,
-# Android Studio, and the `flutter analyze` command.
-#
-# The flutter/plugins repo contains a copy of this file, which should be kept
-# in sync with this file.
-
-analyzer:
-  strong-mode:
-    implicit-dynamic: false
-  errors:
-    # treat missing required parameters as a warning (not a hint)
-    # missing_required_param: warning
-    # treat missing returns as a warning (not a hint)
-    missing_return: warning
-    # allow having TODOs in the code
-    todo: ignore
-  exclude:
-    - "bin/cache/**"
-    # the following two are relative to the stocks example and the flutter package respectively
-    # see https://github.com/dart-lang/sdk/issues/28463
-    - "lib/i18n/stock_messages_*.dart"
-    - "lib/src/http/**"
-
-linter:
-  rules:
-    # - prefer_const_literals_to_create_immutables
-    # - avoid_classes_with_only_static_members
-    # - avoid_function_literals_in_foreach_calls
-    # these rules are documented on and in the same order as
-    # the Dart Lint rules page to make maintenance easier
-    # https://github.com/dart-lang/linter/blob/master/example/all.yaml
-    - always_declare_return_types
-    - always_put_control_body_on_new_line
-    # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219
-    - always_require_non_null_named_parameters
-    # - always_specify_types # not support by built_value
-    - annotate_overrides
-    # - avoid_annotating_with_dynamic # conflicts with always_specify_types
-    # - avoid_as # not supported by built_value
-    # - avoid_bool_literals_in_conditional_expressions # not yet tested
-    # - avoid_catches_without_on_clauses # we do this commonly
-    # - avoid_catching_errors # we do this commonly
-    # - avoid_double_and_int_checks # only useful when targeting JS runtime
-    - avoid_empty_else
-    - avoid_field_initializers_in_const_classes
-    - avoid_init_to_null
-    # - avoid_js_rounded_ints # only useful when targeting JS runtime
-    - avoid_null_checks_in_equality_operators
-    # - avoid_positional_boolean_parameters # not yet tested
-    # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
-    - avoid_relative_lib_imports
-    - avoid_renaming_method_parameters
-    - avoid_return_types_on_setters
-    # - avoid_returning_null # we do this commonly
-    # - avoid_returning_this # https://github.com/dart-lang/linter/issues/842
-    # - avoid_setters_without_getters # not yet tested
-    # - avoid_single_cascade_in_expression_statements # not yet tested
-    - avoid_slow_async_io
-    # - avoid_types_as_parameter_names # https://github.com/dart-lang/linter/pull/954/files
-    # - avoid_types_on_closure_parameters # conflicts with always_specify_types
-    # - avoid_unused_constructor_parameters # https://github.com/dart-lang/linter/pull/847
-    - await_only_futures
-    - camel_case_types
-    - cancel_subscriptions
-    # - cascade_invocations # not yet tested
-    # - close_sinks # https://github.com/flutter/flutter/issues/5789
-    # - comment_references # blocked on https://github.com/dart-lang/dartdoc/issues/1153
-    # - constant_identifier_names # https://github.com/dart-lang/linter/issues/204
-    - control_flow_in_finally
-    - directives_ordering
-    - empty_catches
-    - empty_constructor_bodies
-    - empty_statements
-    - hash_and_equals
-    - implementation_imports
-    # - invariant_booleans # https://github.com/flutter/flutter/issues/5790
-    - iterable_contains_unrelated_type
-    # - join_return_with_assignment # not yet tested
-    - library_names
-    - library_prefixes
-    - list_remove_unrelated_type
-    # - literal_only_boolean_expressions # https://github.com/flutter/flutter/issues/5791
-    - no_adjacent_strings_in_list
-    - no_duplicate_case_values
-    - non_constant_identifier_names
-    # - omit_local_variable_types # opposite of always_specify_types
-    # - one_member_abstracts # too many false positives
-    # - only_throw_errors # https://github.com/flutter/flutter/issues/5792
-    - overridden_fields
-    - package_api_docs
-    - package_names
-    - package_prefixed_library_names
-    # - parameter_assignments # we do this commonly
-    - prefer_adjacent_string_concatenation
-    - prefer_asserts_in_initializer_lists
-    - prefer_collection_literals
-    - prefer_conditional_assignment
-    # - prefer_const_constructors
-    - prefer_const_constructors_in_immutables
-    - prefer_const_declarations
-    # - prefer_constructors_over_static_methods # not yet tested
-    - prefer_contains
-    # - prefer_equal_for_default_values # not supported by built_value
-    # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
-    - prefer_final_fields
-    - prefer_final_locals
-    - prefer_foreach
-    # - prefer_function_declarations_over_variables # not yet tested
-    - prefer_initializing_formals
-    # - prefer_interpolation_to_compose_strings # not yet tested
-    # - prefer_iterable_whereType # https://github.com/dart-lang/sdk/issues/32463
-    - prefer_is_empty
-    - prefer_is_not_empty
-    # - prefer_single_quotes
-    - prefer_typing_uninitialized_variables
-    - recursive_getters
-    - slash_for_doc_comments
-    - sort_constructors_first
-    - sort_unnamed_constructors_first
-    - super_goes_last
-    - test_types_in_equals
-    - throw_in_finally
-    # - type_annotate_public_apis # subset of always_specify_types
-    - type_init_formals
-    # - unawaited_futures # https://github.com/flutter/flutter/issues/5793
-    - unnecessary_brace_in_string_interps
-    - unnecessary_getters_setters
-    # - unnecessary_lambdas # https://github.com/dart-lang/linter/issues/498
-    - unnecessary_null_aware_assignments
-    - unnecessary_null_in_if_null_operators
-    - unnecessary_overrides
-    - unnecessary_parenthesis
-    # - unnecessary_statements # not yet tested
-    # - unnecessary_this
-    - unrelated_type_equality_checks
-    - use_rethrow_when_possible
-    # - use_setters_to_change_properties # not yet tested
-    # - use_string_buffers # https://github.com/dart-lang/linter/pull/664
-    # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
-    - valid_regexps
-    # - void_checks # not yet tested
+include: package:pedantic/analysis_options.yaml
diff --git a/lib/src/main.dart b/lib/src/main.dart
@@ -9,31 +9,48 @@ const kOfflineDebounceDuration = const Duration(seconds: 3);
 typedef Widget ConnectivityBuilder(
     BuildContext context, ConnectivityResult connectivity, Widget child);
 
-abstract class ConnectivityService {
-  Stream<ConnectivityResult> get onConnectivityChanged;
-  Future<ConnectivityResult> checkConnectivity();
-}
-
 class OfflineBuilder extends StatefulWidget {
-  OfflineBuilder({
+  factory OfflineBuilder({
+    Key key,
+    @required ConnectivityBuilder connectivityBuilder,
+    Duration debounceDuration = kOfflineDebounceDuration,
+    WidgetBuilder builder,
+    Widget child,
+    WidgetBuilder errorBuilder,
+  }) {
+    return OfflineBuilder.initialize(
+      key: key,
+      connectivityBuilder: connectivityBuilder,
+      connectivityService: Connectivity(),
+      debounceDuration: debounceDuration,
+      builder: builder,
+      child: child,
+      errorBuilder: errorBuilder,
+    );
+  }
+
+  @visibleForTesting
+  OfflineBuilder.initialize({
     Key key,
     @required this.connectivityBuilder,
-    this.connectivityService,
+    @required this.connectivityService,
     this.debounceDuration = kOfflineDebounceDuration,
     this.builder,
     this.child,
     this.errorBuilder,
   })  : assert(
             connectivityBuilder != null, 'connectivityBuilder cannot be null'),
         assert(debounceDuration != null, 'debounceDuration cannot be null'),
+        assert(
+            connectivityService != null, 'connectivityService cannot be null'),
         assert(
             !(builder is WidgetBuilder && child is Widget) &&
                 !(builder == null && child == null),
             'You should specify either a builder or a child'),
         super(key: key);
 
   /// Override connectivity service used for testing
-  final ConnectivityService connectivityService;
+  final Connectivity connectivityService;
 
   /// Debounce duration from epileptic network situations
   final Duration debounceDuration;
@@ -60,24 +77,18 @@ class OfflineBuilderState extends State<OfflineBuilder> {
   @override
   void initState() {
     super.initState();
-    Stream<ConnectivityResult> stream;
-    Future<ConnectivityResult> future;
-    final transformers = StreamTransformers();
-    if (widget.connectivityService != null) {
-      stream = widget.connectivityService.onConnectivityChanged;
-      future = widget.connectivityService.checkConnectivity();
-    } else {
-      final connectivity = Connectivity();
-      stream = connectivity.onConnectivityChanged;
-      future = connectivity.checkConnectivity();
-    }
-
-    _connectivityStream = Stream.fromFuture(future)
-        .asyncExpand(
-          (ConnectivityResult data) =>
-              stream.transform(transformers.startsWith(data)),
-        )
-        .transform(transformers.debounce(widget.debounceDuration));
+
+    _connectivityStream = Stream.fromFuture(
+      widget.connectivityService.checkConnectivity(),
+    ).asyncExpand(
+      (ConnectivityResult data) {
+        return widget.connectivityService.onConnectivityChanged.transform(
+          startsWith(data),
+        );
+      },
+    ).transform(
+      debounce(widget.debounceDuration),
+    );
   }
 
   @override

diff --git a/lib/src/utils.dart b/lib/src/utils.dart
@@ -2,60 +2,57 @@ import 'dart:async';
 
 import 'package:connectivity/connectivity.dart';
 
-class StreamTransformers {
+StreamTransformer<ConnectivityResult, ConnectivityResult> debounce(
+  Duration debounceDuration,
+) {
   bool _seenFirstData = false;
   Timer _debounceTimer;
 
-  // TODO: should test this
-  StreamTransformer<ConnectivityResult, ConnectivityResult> debounce(
-    Duration debounceDuration,
-  ) {
-    return StreamTransformer<ConnectivityResult,
-        ConnectivityResult>.fromHandlers(
-      handleData:
-          (ConnectivityResult data, EventSink<ConnectivityResult> sink) {
-        if (_seenFirstData) {
-          _debounceTimer?.cancel();
-          _debounceTimer = Timer(debounceDuration, () => sink.add(data));
-        } else {
-          sink.add(data);
-          _seenFirstData = true;
-        }
-      },
-      handleDone: (EventSink<ConnectivityResult> sink) =>
-          _debounceTimer?.cancel(),
-    );
-  }
+  return StreamTransformer<ConnectivityResult, ConnectivityResult>.fromHandlers(
+    handleData: (ConnectivityResult data, EventSink<ConnectivityResult> sink) {
+      if (_seenFirstData) {
+        _debounceTimer?.cancel();
+        _debounceTimer = Timer(debounceDuration, () => sink.add(data));
+      } else {
+        sink.add(data);
+        _seenFirstData = true;
+      }
+    },
+    handleDone: (EventSink<ConnectivityResult> sink) {
+      _debounceTimer?.cancel();
+      sink.close();
+    },
+  );
+}
 
-  // TODO: should test this
-  StreamTransformer<ConnectivityResult, ConnectivityResult> startsWith(
-    ConnectivityResult data,
-  ) {
-    return new StreamTransformer<ConnectivityResult, ConnectivityResult>(
-        (Stream<ConnectivityResult> input, bool cancelOnError) {
+StreamTransformer<ConnectivityResult, ConnectivityResult> startsWith(
+  ConnectivityResult data,
+) {
+  return StreamTransformer<ConnectivityResult, ConnectivityResult>(
+    (
+      Stream<ConnectivityResult> input,
+      bool cancelOnError,
+    ) {
       StreamController<ConnectivityResult> controller;
       StreamSubscription<ConnectivityResult> subscription;
 
-      controller = new StreamController<ConnectivityResult>(
-          sync: true,
-          onListen: () {
-            try {
-              controller.add(data);
-            } catch (e, s) {
-              controller.addError(e, s);
-            }
+      controller = StreamController<ConnectivityResult>(
+        sync: true,
+        onListen: () => controller?.add(data),
+        onPause: ([Future<dynamic> resumeSignal]) =>
+            subscription.pause(resumeSignal),
+        onResume: () => subscription.resume(),
+        onCancel: () => subscription.cancel(),
+      );
 
-            subscription = input.listen(controller.add,
-                onError: controller.addError,
-                onDone: controller.close,
-                cancelOnError: cancelOnError);
-          },
-          onPause: ([Future<dynamic> resumeSignal]) =>
-              subscription.pause(resumeSignal),
-          onResume: () => subscription.resume(),
-          onCancel: () => subscription.cancel());
+      subscription = input.listen(
+        controller.add,
+        onError: controller.addError,
+        onDone: controller.close,
+        cancelOnError: cancelOnError,
+      );
 
       return controller.stream.listen(null);
-    });
-  }
+    },
+  );
 }
diff --git a/makefile b/makefile
@@ -1,2 +1,8 @@
-coverage:
-	flutter test --no-pub --coverage && genhtml -o coverage coverage/lcov.info && open coverage/index.html
+test_coverage:
+	flutter test --no-pub --coverage
+
+build_coverage:
+	make test_coverage && genhtml -o coverage coverage/lcov.info
+
+open_coverage:
+	make build_coverage && open coverage/index.html
diff --git a/pubspec.lock b/pubspec.lock
@@ -68,7 +68,7 @@ packages:
     source: hosted
     version: "1.6.2"
   pedantic:
-    dependency: transitive
+    dependency: "direct dev"
     description:
       name: pedantic
       url: "https://pub.dartlang.org"
@@ -92,7 +92,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.5.3"
+    version: "1.5.4"
   stack_trace:
     dependency: transitive
     description: