dart_common_extensions 0.0.2

Dart extensions for common use cases.

DartExtensions

This package provides a collection of convenient extensions for Dart DateTime, List, Map, and String classes, aimed at simplifying common operations and enhancing code readability.

Features

• Date Formatting Extensions: Easily format DateTime objects using common patterns.
• DateTime Extensions: Useful methods for working with DateTime, including start/end of day calculations, business day additions, and more.
• List Extensions: Enhancements for List operations, including random element selection, shuffling, chunking, and various aggregate functions.
• Map Extensions: Utility methods for Map including value retrieval with defaults, JSON serialization, and map inversion.
• String Extensions: Encode/decode strings to/from Base64, URL encoding, and perform common format validations.

Installation

• 在你的 Flutter 或 Dart 项目的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  dart_extensions: ^latest_version

• 然后运行：

flutter pub get

• 对于纯 Dart 项目，请运行：

dart pub get

Usage Examples

String Conversion Extensions

print('12'.toInt); // Output: 12
print('12.34'.toDouble); // Output: 12.34
print('123.45'.toNum); // Output: 123.45
print('2023-01-01'.toDate); // Output: Instance of 'DateTime' for 2023-01-01
print('https://example.com'.toUri); // Output: Instance of 'Uri'
print('true'.toBool); // Output: true
print('{"key": "value"}'.toJson); // Output: {key: value}
print('1,2,3'.toIntList); // Output: [1, 2, 3]
print('1.0,2.0,3.0'.toDoubleList); // Output: [1.0, 2.0, 3.0]

print('Hello World'.base64Encoded); // Output: 'SGVsbG8gV29ybGQ='
print('SGVsbG8gV29ybGQ='.base64Decoded); // Output: 'Hello World'
print('Hello World'.urlEncoded); // Output: 'Hello%20World'
print('Hello%20World'.urlDecoded); // Output: 'Hello World'

print('   '.isNullOrWhiteSpace); // Output: true
print('1234'.isNumeric); // Output: true
print('Hello'.isEnglish); // Output: true
print('你好'.isChinese); // Output: true
print('13912345678'.isChineseMobile); // Output: true
print('[e-mail]'.isEmail); // Output: true
print('https://example.com'.isValidUrl); // Output: true
print('AFFE'.isValidHex); // Output: true


print(''.onEmpty('default')); // Output: 'default'
print('hello'.capitalize); // Output: 'Hello'
print('Hello World'.removeAllSpaces); // Output: 'HelloWorld'
print('hello'.reversed); // Output: 'olleh'
print('Hello World'.replaceFirst('World', 'There')); // Output: 'Hello There'
print('Hello World World'.replaceLast('World', 'There')); // Output: 'Hello World There'
print('Hello World'.insert(6, 'Beautiful ')); // Output: 'Hello Beautiful World'
print('abc'.repeat(3)); // Output: 'abcabcabc'

// enum TestEnum { valA, valB, valC }
print('valA'.toEnum(TestEnum.values)); // Output: TestEnum.valA
print('TestEnum.valA'.toEnum(TestEnum.values)); // Output: TestEnum.valA

Num Extensions

print(123.456.decimal); // Output: 123.456 (as a Decimal)
print(5.toList); // Output: [0, 1, 2, 3, 4]
print(1609459200000.toDateTime); // Output: 2021-01-01 00:00:00.000 (assuming milliseconds)
print(60.secondsDuration); // Output: 0:01:00.000000

print(2.isEven); // Output: true
print(3.isOdd); // Output: true
print((5.random).toString()); // Output: Random number between 0 and 5
print(12345.numberOfDigits); // Output: 5
print(5.isPrime); // Output: true
print((-5).absolute); // Output: 5
await 5.secondsDelay(); // Waits for 5 seconds

print(123456.78.toCurrency(symbol: '€')); // Outputs: €123,456.78
print(10.toBinaryString); // Outputs: 1010
print(255.toHexString); // Outputs: ff

print(1.rangeTo(5)); // Outputs: [1, 2, 3, 4, 5]
print(5.rangeTo(1)); // Outputs: [5, 4, 3, 2, 1]
print(1.sumTo(5)); // Outputs: 15 (1+2+3+4+5)
print(2.power(3)); // Outputs: 8 (2^3)

Map Extensions

var map = {'first': 1, 'second': 2};
print(map.getOrDefault('third', 0)); // Output: 0
print(map.getOrNull('third')); // Output: null
print(map.toJsonString()); // Output: '{"first": 1, "second": 2}'
print(map.toJsonStringWithIndent(4)); // Outputs a formatted JSON string with 4 spaces indentation
print(map.invert()); // Output: {1: 'first', '2': 'second'}
print(map.filterKeys((key) => key.startsWith('f'))); // Output: {'first': 1}
print(map.filterValues((value) => value > 1)); // Output: {'second': 2}

var map1 = {'first': 1, 'second': 2};
var map2 = {'second': 3, 'third': 4};
print(map1.merge(map2); // Output: {'first': 1, 'second': 3, 'third': 4}
print(map1.merge(map2, (v1, v2) => v1 + v2)); // Output: {'first': 1, 'second': 5, 'third': 4}

List Extensions

List<int> intList = [1, 2, 3, 4, 5];
List<String> stringList = ['a', 'b', 'c', 'd', 'e'];

print(intList.random); // Output: (Random element from the list)
print(stringList.safeElementAt(2)); // Output: c
print(stringList.safeElementAt(10)); // Output: null
print(intList.firstWhereOrNull((item) => item > 3)); // Output: 4
print(intList.shuffled); // Output: [2, 4, 1, 3, 5] (example shuffled list)
print(intList.chunked(2)); // Output: [[1, 2], [3, 4], [5]]
print(stringList.firstWhereOrElse((item) => item == 'b', 'No matches')); // Output: b
print(stringList.firstWhereOrElse((item) => item == 'f', 'No matches')); // Output: No matches
intList.addIfNotContains(6);
print(intList); // Output: [1, 2, 3, 4, 5, 6]
bool removed = intList.removeFirstWhere((item) => item == 2);
print(removed); // Output: true
print(intList); // Output: [1, 3, 4, 5, 6]
print([null, null].isEmptyOrNull); // Output: true
print(intList.reversedList); // Output: [6, 5, 4, 3, 1]
print(stringList.mapToList((item) => item.toUpperCase())); // Output: ['A', 'B', 'C', 'D', 'E']
print(intList.groupBy((item) => item % 2 == 0 ? 'even' : 'odd')); // Output: {'odd': [1, 3, 5], 'even': [4, 6]}
List<num> nums = [1, 2, 3, 4];
print(nums.sum); // Output: 10
print(nums.average); // Output: 2.5

DateTime Extensions

DateTime now = DateTime.now();
DateTime specificDate = DateTime(2023, 1, 1);

print(now.startOfDay); // Output: "YYYY-MM-DD 00:00:00.000"
print(now.endOfDay); // Output: "YYYY-MM-DD 23:59:59.999"
print(now.isSameDay(specificDate)); // Output: false
DateTime friday = DateTime(2023, 1, 6);
print(friday.addBusinessDays(1)); // Outputs the next Monday's date
DateTime monday = DateTime(2023, 1, 9);
print(monday.subtractBusinessDays(1)); // Outputs the previous Friday's date
DateTime saturday = DateTime(2023, 1, 7);
print(saturday.isWeekend); // Output: true

// DateTime Format Extensions Usage
// Formatting DateTime object into different patterns
print(now.format(pattern: 'MM/dd/yyyy')); // Output: e.g., "04/07/2023"
print(now.ymd); // Output: e.g., "2023-04-07"
print(now.dmy); // Output: e.g., "07-04-2023"
print(now.mdy); // Output: e.g., "04/07/2023"
print(now.iso8601); // Output: e.g., "2023-04-07T12:00:00"
print(now.fullDateTime); // Output: e.g., "2023-04-07 12:00:00"
print(now.time); // Output: e.g., "12:00:00"
print(now.zonedDateTime); // Output: e.g., "2023-04-07T12:00:00.000Z"
print(now.monthYear); // Output: e.g., "April 2023"
print(now.shortDate); // Output: based on locale, e.g., "4/7/2023"
print(now.longDate); // Output: based on locale, e.g., "April 7, 2023"

Running Tests

dart test

MIT License