display_test.dart

import 'package:jiffy/src/display.dart';
import 'package:jiffy/src/enums/startOfWeek.dart';
import 'package:jiffy/src/enums/units.dart';
import 'package:jiffy/src/getter.dart';
import 'package:jiffy/src/locale/enLocale.dart';
import 'package:jiffy/src/manipulator.dart';
import 'package:jiffy/src/utils/exception.dart';
import 'package:test/test.dart';

void main() {
  final getter = Getter();
  final manipulator = Manipulator(getter);

  final underTest = Display(getter, manipulator);

  test('Should successfully format datetime is iso when pattern not provided',
      () {
    // Setup
    final dateTime = DateTime(1997, 9, 23, 12, 11, 22, 123, 456);

    final expectedFormat = '1997-09-23T12:11:22.123456';

    // Execute
    final actualFormat = underTest.formatToISO8601(dateTime);

    // Verify
    expect(actualFormat, expectedFormat);
  });

  group('Test format with pattern', () {
    for (var testData in formatWithPatternDateTimeTestData()) {
      test('Should successfully format datetime when pattern is provided', () {
        // Setup
        final locale = EnLocale(StartOfWeek.MONDAY);

        // Execute
        final actualFormat =
            underTest.format(testData['dateTime'], testData['pattern'], locale);

        // Verify
        expect(actualFormat, testData['expectedFormat']);
      });
    }

    for (var testData in formatWithEscapedPatternDateTimeTestData()) {
      test('Should successfully format datetime with escaped pattern', () {
        // Setup
        final locale = EnLocale(StartOfWeek.MONDAY);

        // Execute
        final actualFormat =
            underTest.format(testData['dateTime'], testData['pattern'], locale);

        // Verify
        expect(actualFormat, testData['expectedFormat']);
      });
    }

    for (var testData in formatWithOrdinalPatternDateTimeTestData()) {
      test('Should successfully format datetime with ordinal pattern', () {
        // Setup
        final locale = EnLocale(StartOfWeek.MONDAY);

        // Execute
        final actualFormat =
            underTest.format(testData['dateTime'], testData['pattern'], locale);

        // Verify
        expect(actualFormat, testData['expectedFormat']);
      });
    }

    test('Should throw JiffyException if provided pattern in blank', () {
      // Setup
      final dateTime = DateTime(1997, 9, 23, 12, 11, 22, 123, 456);
      final pattern = '';
      final locale = EnLocale(StartOfWeek.MONDAY);

      final expectedExceptionMessage = 'The provided pattern for datetime '
          '`$dateTime` cannot be blank';

      // Execute and Verify
      expect(
          () => underTest.format(dateTime, pattern, locale),
          throwsA(isA<JiffyException>().having((e) => e.message, 'message',
              contains(expectedExceptionMessage))));
    });

    test('Should throw JiffyException if provided pattern is invalid', () {
      // Setup
      final dateTime = DateTime(1997, 9, 23, 12, 11, 22, 123, 456);
      final pattern = 'invalid-pattern';
      final locale = EnLocale(StartOfWeek.MONDAY);

      final expectedExceptionMessage =
          'The pattern `$pattern` might be invalid';

      // Execute and Verify
      expect(
          () => underTest.format(dateTime, pattern, locale),
          throwsA(isA<JiffyException>().having((e) => e.message, 'message',
              contains(expectedExceptionMessage))));
    });
  });

  group('Test diff', () {
    for (var testData in diffDateTimeTestData()) {
      test('Should successfully get difference between two datetime', () {
        // Setup
        final asFloat = true;

        // Execute
        final actualDifference = underTest.diff(testData['firstDateTime'],
            testData['secondDateTime'], testData['unit'], asFloat);

        // Verify
        expect(actualDifference, testData['expectedDifference']);
      });
    }

    test('Should successfully get difference when float is disabled', () {
      // Setup
      final firstDateTime = DateTime(2022, 12, 5);
      final secondDateTime = DateTime(2022, 12, 8);
      final unit = Units.WEEK;
      final asFloat = false;

      final expectedDifference = -0.42857142857142855;

      // Execute
      final actualDifference =
          underTest.diff(firstDateTime, secondDateTime, unit, asFloat);

      // Verify
      expect(actualDifference, expectedDifference);
    });
  });
}

List<Map<String, dynamic>> formatWithPatternDateTimeTestData() {
  return [
    {
      'dateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 456),
      'pattern': 'yyyy MMM dd hh:mm:ss',
      'expectedFormat': '1997 Sep 23 12:11:22'
    },
    {
      'dateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 456),
      'pattern': 'yyyy MMM, dd hh:mm a',
      'expectedFormat': '1997 Sep, 23 12:11 PM'
    },
    {
      'dateTime': DateTime(1997, 9, 23, 11, 11, 22, 123, 456),
      'pattern': 'yyyy MMM dd hh:mm a',
      'expectedFormat': '1997 Sep 23 11:11 AM'
    },
    {
      'dateTime': DateTime(1997, 9, 23, 11, 11, 22, 123, 456),
      'pattern': 'do MMMM',
      'expectedFormat': '23rd September'
    },
    {
      'dateTime': DateTime(1997, 9, 23, 11, 11, 22, 123, 456),
      'pattern': 'EEEE',
      'expectedFormat': 'Tuesday'
    }
  ];
}

List<Map<String, dynamic>> formatWithEscapedPatternDateTimeTestData() {
  return [
    {
      'dateTime': DateTime(1969, 7, 20, 20, 18, 04),
      'pattern': '[The moon landing was on] do MMMM, yyyy',
      'expectedFormat': 'The moon landing was on 20th July, 1969'
    },
    {
      'dateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 456),
      'pattern': '[Today\'s date is] do [in the month of] MMMM',
      'expectedFormat': 'Today\'s date is 23rd in the month of September'
    },
    {
      'dateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 456),
      'pattern': '[It\'s] hh [o\'clock]',
      'expectedFormat': 'It\'s 12 o\'clock'
    },
    {
      'dateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 456),
      'pattern': "[It's] hh [o'clock]",
      'expectedFormat': "It's 12 o'clock"
    }
  ];
}

List<Map<String, dynamic>> formatWithOrdinalPatternDateTimeTestData() {
  return [
    {
      'dateTime': DateTime(2022, 1, 1),
      'pattern': 'do',
      'expectedFormat': '1st'
    },
    {
      'dateTime': DateTime(2022, 1, 12),
      'pattern': 'do',
      'expectedFormat': '12th'
    },
    {
      'dateTime': DateTime(2022, 1, 21),
      'pattern': 'do',
      'expectedFormat': '21st'
    },
    {
      'dateTime': DateTime(2022, 1, 2),
      'pattern': 'do',
      'expectedFormat': '2nd'
    },
    {
      'dateTime': DateTime(2022, 1, 3),
      'pattern': 'do',
      'expectedFormat': '3rd'
    },
    {
      'dateTime': DateTime(2022, 1, 4),
      'pattern': 'do',
      'expectedFormat': '4th'
    },
    {
      'dateTime': DateTime(2022, 1, 11),
      'pattern': 'do',
      'expectedFormat': '11th'
    }
  ];
}

List<Map<String, dynamic>> diffDateTimeTestData() {
  return [
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 10),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 24),
      'unit': Units.MICROSECOND,
      'expectedDifference': -14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 24),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 10),
      'unit': Units.MICROSECOND,
      'expectedDifference': 14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 2),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 22, 123, 2),
      'unit': Units.MICROSECOND,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 22, 10),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 22, 24),
      'unit': Units.MILLISECOND,
      'expectedDifference': -14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 22, 24),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 22, 10),
      'unit': Units.MILLISECOND,
      'expectedDifference': 14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 22, 2),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 22, 2),
      'unit': Units.MILLISECOND,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 10),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 24),
      'unit': Units.SECOND,
      'expectedDifference': -14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 24),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 10),
      'unit': Units.SECOND,
      'expectedDifference': 14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 11, 2),
      'secondDateTime': DateTime(1997, 9, 23, 12, 11, 2),
      'unit': Units.SECOND,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 10),
      'secondDateTime': DateTime(1997, 9, 23, 12, 24),
      'unit': Units.MINUTE,
      'expectedDifference': -14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 24),
      'secondDateTime': DateTime(1997, 9, 23, 12, 10),
      'unit': Units.MINUTE,
      'expectedDifference': 14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 12, 2),
      'secondDateTime': DateTime(1997, 9, 23, 12, 2),
      'unit': Units.MINUTE,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 10),
      'secondDateTime': DateTime(1997, 9, 23, 24),
      'unit': Units.HOUR,
      'expectedDifference': -14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 24),
      'secondDateTime': DateTime(1997, 9, 23, 10),
      'unit': Units.HOUR,
      'expectedDifference': 14
    },
    {
      'firstDateTime': DateTime(1997, 9, 23, 2),
      'secondDateTime': DateTime(1997, 9, 23, 2),
      'unit': Units.HOUR,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(1997, 9, 10),
      'secondDateTime': DateTime(1997, 9, 24),
      'unit': Units.DAY,
      'expectedDifference': -14
    },
    {
      'firstDateTime': DateTime(1997, 9, 24),
      'secondDateTime': DateTime(1997, 9, 10),
      'unit': Units.DAY,
      'expectedDifference': 14
    },
    {
      'firstDateTime': DateTime(1997, 9, 2),
      'secondDateTime': DateTime(1997, 9, 2),
      'unit': Units.DAY,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(2022, 12, 5),
      'secondDateTime': DateTime(2022, 12, 20),
      'unit': Units.WEEK,
      'expectedDifference': -2
    },
    {
      'firstDateTime': DateTime(2022, 12, 22),
      'secondDateTime': DateTime(2022, 12, 6),
      'unit': Units.WEEK,
      'expectedDifference': 2
    },
    {
      'firstDateTime': DateTime(2022, 12, 5),
      'secondDateTime': DateTime(2022, 12, 8),
      'unit': Units.WEEK,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(2022, 5),
      'secondDateTime': DateTime(2022, 7),
      'unit': Units.MONTH,
      'expectedDifference': -2
    },
    {
      'firstDateTime': DateTime(2022, 7),
      'secondDateTime': DateTime(2022, 5),
      'unit': Units.MONTH,
      'expectedDifference': 2
    },
    {
      'firstDateTime': DateTime(2022, 5),
      'secondDateTime': DateTime(2022, 5),
      'unit': Units.MONTH,
      'expectedDifference': 0
    },
    {
      'firstDateTime': DateTime(2016, 2, 29),
      'secondDateTime': DateTime(2016, 1, 30),
      'unit': Units.MONTH,
      'expectedDifference': 1
    },
    {
      'firstDateTime': DateTime(2016, 2, 29),
      'secondDateTime': DateTime(2016, 1, 31),
      'unit': Units.MONTH,
      'expectedDifference': 1
    },
    {
      'firstDateTime': DateTime(1997),
      'secondDateTime': DateTime(1999),
      'unit': Units.YEAR,
      'expectedDifference': -2
    },
    {
      'firstDateTime': DateTime(1999),
      'secondDateTime': DateTime(1997),
      'unit': Units.YEAR,
      'expectedDifference': 2
    },
    {
      'firstDateTime': DateTime(1997),
      'secondDateTime': DateTime(1997),
      'unit': Units.YEAR,
      'expectedDifference': 0
    },
  ];
}