null safety migration

Author: suragch

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0-nullsafety.0
+
+- Null safety pre-release
+
 ## 0.2.0
 
 - Exported more of the internal classes

README.md

@@ -7,16 +7,16 @@ Unicode conversion library in Dart for traditional Mongolian script
 A simple usage example:
 
 ```dart
-MongolCode converter = MongolCode.instance;
+final converter = MongolCode.instance;
 
 // Unicode to Menksoft code
-String unicodeInput = 'ᠮᠣᠩᠭᠣᠯ';
-String menksoftResult = converter.unicodeToMenksoft(unicodeInput);
+const unicodeInput = 'ᠮᠣᠩᠭᠣᠯ';
+final menksoftResult = converter.unicodeToMenksoft(unicodeInput);
 print(menksoftResult);
 
 // Menksoft code to Unicode
-String menksoftInput = "\uE2C1\uE27F\uE317\uE27E\uE2E8"; // bichig
-String unicodeResult = converter.menksoftToUnicode(menksoftInput);
+const menksoftInput = '\uE2C1\uE27F\uE317\uE27E\uE2E8'; // bichig
+final unicodeResult = converter.menksoftToUnicode(menksoftInput);
 print(unicodeResult);
 ```
 

example/mongol_code_example.dart

@@ -1,16 +1,15 @@
 import 'package:mongol_code/mongol_code.dart';
 
 void main() {
-
-  MongolCode converter = MongolCode.instance;
+  final converter = MongolCode.instance;
 
   // Unicode to Menksoft code
-  String unicodeInput = 'ᠮᠣᠩᠭᠣᠯ';
-  String menksoftResult = converter.unicodeToMenksoft(unicodeInput);
+  const unicodeInput = 'ᠮᠣᠩᠭᠣᠯ';
+  final menksoftResult = converter.unicodeToMenksoft(unicodeInput);
   print(menksoftResult);
 
   // Menksoft code to Unicode
-  String menksoftInput = "\uE2C1\uE27F\uE317\uE27E\uE2E8"; // bichig
-  String unicodeResult = converter.menksoftToUnicode(menksoftInput);
+  const menksoftInput = '\uE2C1\uE27F\uE317\uE27E\uE2E8'; // bichig
+  final unicodeResult = converter.menksoftToUnicode(menksoftInput);
   print(unicodeResult);
 }

lib/src/menksoft_word.dart

@@ -7,8 +7,8 @@ import 'unicode.dart';
 class MenksoftWord {
   static const int SPACE = 0x0020;
 
-  String _inputWord;
-  Location _location;
+  late String _inputWord;
+  late Location _location;
 
   MenksoftWord(String menksoftWord) {
     _inputWord = menksoftWord;
@@ -35,7 +35,7 @@ class MenksoftWord {
   String convertToUnicode() {
     final outputString = StringBuffer();
 
-    if (_inputWord == null || _inputWord.isEmpty) {
+    if (_inputWord.isEmpty) {
       return '';
     }
 

lib/src/mongol_code.dart

@@ -93,7 +93,7 @@ class MongolCode {
   }
 
   String unicodeToMenksoftSameIndex(String inputString) {
-    if (inputString == null || inputString.isEmpty) return '';
+    if (inputString.isEmpty) return '';
 
     final outputString = StringBuffer();
     final mongolWord = StringBuffer();
@@ -142,7 +142,7 @@ class MongolCode {
   }
 
   String menksoftToUnicode(String inputString) {
-    if (inputString == null || inputString.isEmpty) return '';
+    if (inputString.isEmpty) return '';
 
     final outputString = StringBuffer();
     final menksoftWord = StringBuffer();
@@ -187,11 +187,6 @@ class MongolCode {
   }
 
   static Location getLocation(String textBefore, String textAfter) {
-    // TODO should we be using this in convertWordToMenksoftCode?
-
-    textBefore ??= '';
-    textAfter ??= '';
-
     var beforeIsMongolian = false;
     var afterIsMongolian = false;
 
@@ -356,7 +351,7 @@ class MongolCode {
   // Starts at the end of the word and works up
   // if mixed genders only reports the first one from the bottom
   // returns null if word does not end in a valid Mongolian character
-  static Gender getWordGender(String word) {
+  static Gender? getWordGender(String word) {
     return MongolWord.getGender(word);
   }
 }

lib/src/mongol_word.dart

@@ -6,13 +6,13 @@ import 'shape.dart';
 import 'unicode.dart';
 
 class MongolWord {
-  Gender _gender;
-  Location _location;
-  int _length;
-  bool _isSuffix;
-  String _inputWord;
-  int _fvs;
-  Shape _glyphShapeBelow;
+  Gender? _gender;
+  late Location _location;
+  late int _length;
+  late bool _isSuffix;
+  late String _inputWord;
+  late int _fvs;
+  late Shape _glyphShapeBelow;
 
   MongolWord(String mongolWord) {
     _inputWord = mongolWord;
@@ -1915,9 +1915,9 @@ class MongolWord {
   // Starts at the end of the word and works up
   // if mixed genders only reports the first one from the bottom
   // returns null if word does not end in a valid Mongolian character
-  static Gender getGender(String word) {
+  static Gender? getGender(String word) {
     // check that word is valid mongolian
-    if (word == null || word.isEmpty) return null;
+    if (word.isEmpty) return null;
     final length = word.length;
     final lastChar = word.codeUnitAt(length - 1);
     if (!MongolCode.isMongolian(lastChar)) return null;

pubspec.yaml

@@ -1,11 +1,11 @@
 name: mongol_code
 description: Unicode conversion package for traditional Mongolian scripts
-version: 0.2.0
+version: 0.3.0-nullsafety.0
 homepage: https://github.com/suragch/mongol_code
 
 environment:
-  sdk: '>=2.7.0 <3.0.0'
+  sdk: '>=2.12.0-29.10.beta <3.0.0'
 
 dev_dependencies:
-  pedantic: ^1.8.0
-  test: ^1.6.0
+  pedantic: ^1.10.0-nullsafety.3
+  test: ^1.16.0-nullsafety.11

test/mongol_code_test.dart

@@ -29,13 +29,6 @@ void main() {
       expect(expected, result);
     });
 
-    test('nullString', () async {
-      final unicode = null;
-      final result = convertUnicodeToMenksoft(unicode);
-      final expected = '';
-      expect(expected, result);
-    });
-
     test('english character', () async {
       final unicode = 'a';
       final result = convertUnicodeToMenksoft(unicode);
@@ -5304,13 +5297,6 @@ void main() {
       expect(expected, result);
     });
 
-    test('nullString', () async {
-      final unicode = null;
-      final result = convertMenksoftToUnicode(unicode);
-      final expected = '';
-      expect(expected, result);
-    });
-
     test('englishKeyboardChars', () async {
       final unicode =
           'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@#\$%^&*()-=_+`~;:\'" ,./<>?';