fixed tests, reorganized tests, fixed docs

Author: OlehMarch

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.0.2
+
+* Updated docs due to changes in `singleOrNull` and `singleOrNullWhere` API
+* Fixed tests for `singleOrNull` and `singleOrNullWhere`
+
 ## 2.0.1
 
 * Added collection dependency

README.md

@@ -17,7 +17,7 @@ This package will help you to reduce the amount of boilerplate code by adding fo
 
 * getter `lastOrNull` and method `lastOrNullWhere` for getting last value, and if it will not be found returns `null`
 
-* getter `singleOrNull` and method `singleOrNullWhere` for getting single value, and if it will not be found returns `null`, and if there will be too many elements it'll throw the `StateError`
+* getter `singleOrNull` and method `singleOrNullWhere` for getting single value, and if it will not be found returns `null`, and if there will be too many elements it'll also return `null`
 
 * method `mapList`, which maps collection and casts it to `List`
 

lib/src/iterable.common.extension.dart

@@ -25,8 +25,7 @@ extension IterableCommonExtension<T> on Iterable<T> {
 
   /// Checks that this iterable has only one element, and returns that element.
   ///
-  /// If `this` has no element, the result is [null].
-  /// Throws a [StateError] if `this` has more than one element.
+  /// Returns [null] if there are either no elements or more than one element.
   T? get singleOrNull => this.singleWhereOrNull((_) => true);
 
   /// Returns the first element that satisfies the given predicate [test].
@@ -50,10 +49,8 @@ extension IterableCommonExtension<T> on Iterable<T> {
 
   /// Returns the single element that satisfies [test].
   ///
-  /// Checks elements to see if `test(element)` returns true.
-  /// If exactly one element satisfies [test], that element is returned.
-  /// If more than one matching element is found, throws [StateError].
-  /// If no matching element is found, returns [null].
+  /// Returns [null] if there are either no elements or more than one element
+  /// satisfying [test].
   T? singleOrNullWhere(bool test(T element)) => this.singleWhereOrNull(test);
 
   /// Maps [Iterable] and casts it to a [List].

pubspec.lock

@@ -7,21 +7,21 @@ packages:
       name: _fe_analyzer_shared
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "14.0.0"
+    version: "18.0.0"
   analyzer:
     dependency: transitive
     description:
       name: analyzer
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.41.2"
+    version: "1.2.0"
   args:
     dependency: transitive
     description:
       name: args
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.5.2"
+    version: "2.0.0"
   async:
     dependency: transitive
     description:
@@ -63,56 +63,56 @@ packages:
       name: convert
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.1"
+    version: "3.0.0"
   coverage:
     dependency: transitive
     description:
       name: coverage
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.15.2"
+    version: "1.0.2"
   crypto:
     dependency: transitive
     description:
       name: crypto
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.3"
-  glob:
+    version: "3.0.0"
+  file:
     dependency: transitive
     description:
-      name: glob
+      name: file
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
-  http:
+    version: "6.1.0"
+  glob:
     dependency: transitive
     description:
-      name: http
+      name: glob
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.12.0+2"
+    version: "2.0.0"
   http_multi_server:
     dependency: transitive
     description:
       name: http_multi_server
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.0"
+    version: "3.0.0"
   http_parser:
     dependency: transitive
     description:
       name: http_parser
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "3.1.3"
+    version: "4.0.0"
   io:
     dependency: transitive
     description:
       name: io
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.3.3"
+    version: "1.0.0"
   js:
     dependency: transitive
     description:
@@ -147,42 +147,21 @@ packages:
       name: mime
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.9.6+3"
-  node_interop:
-    dependency: transitive
-    description:
-      name: node_interop
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.0.3"
-  node_io:
-    dependency: transitive
-    description:
-      name: node_io
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.0.1+2"
+    version: "1.0.0"
   node_preamble:
     dependency: transitive
     description:
       name: node_preamble
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.4.8"
+    version: "2.0.0"
   package_config:
     dependency: transitive
     description:
       name: package_config
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.9.3"
-  package_resolver:
-    dependency: transitive
-    description:
-      name: package_resolver
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.0.10"
+    version: "2.0.0"
   path:
     dependency: transitive
     description:
@@ -210,35 +189,35 @@ packages:
       name: pub_semver
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.4.2"
+    version: "2.0.0"
   shelf:
     dependency: transitive
     description:
       name: shelf
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.7.5"
+    version: "1.1.0"
   shelf_packages_handler:
     dependency: transitive
     description:
       name: shelf_packages_handler
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.0.4"
+    version: "3.0.0"
   shelf_static:
     dependency: transitive
     description:
       name: shelf_static
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.2.8"
+    version: "1.0.0"
   shelf_web_socket:
     dependency: transitive
     description:
       name: shelf_web_socket
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.2.3"
+    version: "1.0.1"
   source_map_stack_trace:
     dependency: transitive
     description:
@@ -294,21 +273,21 @@ packages:
       name: test
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.16.5"
+    version: "1.16.8"
   test_api:
     dependency: transitive
     description:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.2.19"
+    version: "0.3.0"
   test_core:
     dependency: transitive
     description:
       name: test_core
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.3.15"
+    version: "0.3.19"
   typed_data:
     dependency: transitive
     description:
@@ -322,21 +301,21 @@ packages:
       name: vm_service
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.1"
+    version: "6.1.0+1"
   watcher:
     dependency: transitive
     description:
       name: watcher
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.9.7+12"
+    version: "1.0.0"
   web_socket_channel:
     dependency: transitive
     description:
       name: web_socket_channel
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0"
+    version: "2.0.0"
   webkit_inspection_protocol:
     dependency: transitive
     description:
@@ -350,6 +329,6 @@ packages:
       name: yaml
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.2.0"
+    version: "3.1.0"
 sdks:
   dart: ">=2.12.0 <3.0.0"

pubspec.yaml

@@ -1,6 +1,7 @@
 name: flinq
 version: 2.0.1
 homepage: https://github.com/marchdev-tk/flinq
+issue_tracker: https://github.com/marchdev-tk/flinq/issues
 description: Extended capabilities for collections. It's a bunch of shortcuts to avoid unnecesary boilerplate work with collections.
 
 environment:

test/flinq_test.dart

@@ -2,13 +2,19 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'src/iterable.comparable.test.dart';
-import 'src/iterable.common.test.dart';
-import 'src/iterable.math.test.dart';
-import 'src/iterable.set.test.dart';
+import 'package:test/test.dart';
+import 'package:flinq/flinq.dart';
 
+part 'src/iterable.comparable.test.dart';
+part 'src/iterable.common.test.dart';
+part 'src/iterable.math.test.dart';
+part 'src/iterable.set.test.dart';
+
+final Iterable<int> _emptyCollection = <int>[];
+final Iterable<int> _oneItemCollection = <int>[7];
+final Iterable<int> _manyCollection = <int>[4, 3, 6, 1, 9, 5];
 /// to run tests use `pub run test`
-void main() {
+void main() {  
   iterableCommonTests();
   iterableComparableTests();
   iterableMathTests();

test/src/iterable.common.test.dart

@@ -2,12 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:test/test.dart';
-import 'package:flinq/flinq.dart';
-
-final Iterable<int> _emptyCollection = <int>[];
-final Iterable<int> _oneItemCollection = <int>[7];
-final Iterable<int> _manyCollection = <int>[4, 3, 6, 1, 9, 5];
+part of '../flinq_test.dart';
 
 void iterableCommonTests() {
   firstOrNullTests();
@@ -65,8 +60,7 @@ void singleOrNullTests() {
   );
   test(
     'Iterable.singleOrNull on collection with many elements',
-    () => expect(
-        () => _manyCollection.singleOrNull, throwsA(TypeMatcher<StateError>())),
+    () => expect(_manyCollection.singleOrNull, null),
   );
 }
 
@@ -135,8 +129,7 @@ void singleOrNullWhereTests() {
   );
   test(
     'Iterable.singleOrNullWhere on collection with many elements, too many',
-    () => expect(() => _manyCollection.singleOrNullWhere((_) => _ > 3),
-        throwsA(TypeMatcher<StateError>())),
+    () => expect(_manyCollection.singleOrNull, null),
   );
 }
 

test/src/iterable.comparable.test.dart

@@ -2,12 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:test/test.dart';
-import 'package:flinq/flinq.dart';
-
-final Iterable<int> _emptyCollection = <int>[];
-final Iterable<int> _oneItemCollection = <int>[7];
-final Iterable<int> _manyCollection = <int>[4, 3, 6, 1, 9, 5];
+part of '../flinq_test.dart';
 
 void iterableComparableTests() {
   minTests();

test/src/iterable.math.test.dart

@@ -2,12 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:test/test.dart';
-import 'package:flinq/flinq.dart';
-
-final Iterable<int> _emptyCollection = <int>[];
-final Iterable<int> _oneItemCollection = <int>[7];
-final Iterable<int> _manyCollection = <int>[4, 3, 6, 1, 9, 5];
+part of '../flinq_test.dart';
 
 void iterableMathTests() {
   sumTests();