test/type_matcher_test.dart

// Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
// 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:matcher/matcher.dart';
import 'package:test/test.dart' show test, group;

import 'test_utils.dart';

void main() {
  _test('Map', isMap, {});
  _test('List', isList, []);
  _test('ArgumentError', isArgumentError, ArgumentError());
  _test('CastError', isCastError, CastError());
  _test('Exception', isException, const FormatException());
  _test('FormatException', isFormatException, const FormatException());
  _test('StateError', isStateError, StateError('oops'));
  _test('RangeError', isRangeError, RangeError('oops'));
  _test('UnimplementedError', isUnimplementedError, UnimplementedError('oops'));
  _test('UnsupportedError', isUnsupportedError, UnsupportedError('oops'));
  _test('ConcurrentModificationError', isConcurrentModificationError,
      ConcurrentModificationError());
  _test('CyclicInitializationError', isCyclicInitializationError,
      CyclicInitializationError());
  _test('NoSuchMethodError', isNoSuchMethodError, null);
  _test('NullThrownError', isNullThrownError, NullThrownError());

  group('custom `TypeMatcher`', () {
    // ignore: deprecated_member_use_from_same_package
    _test('String', const isInstanceOf<String>(), 'hello');
    _test('String', const _StringMatcher(), 'hello');
    _test('String', const TypeMatcher<String>(), 'hello');
    _test('String', isA<String>(), 'hello');
  });
}

// TODO: drop `name` and use a type argument – once Dart2 semantics are enabled
void _test(String name, Matcher typeMatcher, Object matchingType) {
  group('for `$name`', () {
    if (matchingType != null) {
      test('succeeds', () {
        shouldPass(matchingType, typeMatcher);
      });
    }

    test('fails', () {
      shouldFail(const TestType(), typeMatcher,
          "Expected: <Instance of '$name'> Actual: <Instance of 'TestType'>");
    });
  });
}

// Validate that existing implementations continue to work.
class _StringMatcher extends TypeMatcher {
  const _StringMatcher() : super(
            // ignore: deprecated_member_use_from_same_package
            'String');

  @override
  bool matches(item, Map matchState) => item is String;
}

class TestType {
  const TestType();
}