feat: add Turkish (TR) locale support

Author: cemdrman

src/main/java/com/devskiller/jfairy/LocaleSpecificProvidersFactory.java

@@ -17,6 +17,7 @@
 import com.devskiller.jfairy.producer.company.locale.pl.PlVATIdentificationNumberProvider;
 import com.devskiller.jfairy.producer.company.locale.sk.SkVATIdentificationNumberProvider;
 import com.devskiller.jfairy.producer.company.locale.sv.SvVATIdentificationNumberProvider;
+import com.devskiller.jfairy.producer.company.locale.tr.TrVATIdentificationNumberProvider;
 import com.devskiller.jfairy.producer.company.locale.zh.ZhVATIdentificationNumberProvider;
 import com.devskiller.jfairy.producer.person.NationalIdentificationNumberFactory;
 import com.devskiller.jfairy.producer.person.locale.NoNationalIdentificationNumberFactory;
@@ -50,6 +51,9 @@
 import com.devskiller.jfairy.producer.person.locale.sv.SvNationalIdentificationNumberFactory;
 import com.devskiller.jfairy.producer.person.locale.sv.SvNationalIdentityCardNumberProvider;
 import com.devskiller.jfairy.producer.person.locale.sv.SvPassportNumberProvider;
+import com.devskiller.jfairy.producer.person.locale.tr.TrAddressProvider;
+import com.devskiller.jfairy.producer.person.locale.tr.TrNationalIdentityCardNumberProvider;
+import com.devskiller.jfairy.producer.person.locale.tr.TrPassportNumberProvider;
 import com.devskiller.jfairy.producer.person.locale.zh.ZhAddressProvider;
 import com.devskiller.jfairy.producer.person.locale.zh.ZhNationalIdentityCardNumberProvider;
 import com.devskiller.jfairy.producer.person.locale.zh.ZhPassportNumberProvider;
@@ -89,6 +93,7 @@ static LocaleSpecificProviders createProvidersForLocale(Locale locale,
 			case DE -> createDeProviders(dataMaster, baseProducer);
 			case KA -> createKaProviders(dataMaster, baseProducer);
 			case BR -> createBrProviders(dataMaster, baseProducer);
+			case TR -> createTrProviders(dataMaster, baseProducer);
 		};
 	}
 
@@ -232,4 +237,15 @@ private static LocaleSpecificProviders createBrProviders(DataMaster dataMaster,
 				new BrPassportNumberProvider()
 		);
 	}
+
+	private static LocaleSpecificProviders createTrProviders(DataMaster dataMaster,
+	                                                         BaseProducer baseProducer) {
+		return new LocaleSpecificProviders(
+				new NoNationalIdentificationNumberFactory(),
+				new TrNationalIdentityCardNumberProvider(baseProducer),
+				new TrVATIdentificationNumberProvider(baseProducer),
+				new TrAddressProvider(dataMaster, baseProducer),
+				new TrPassportNumberProvider(baseProducer)
+		);
+	}
 }

src/main/java/com/devskiller/jfairy/producer/company/locale/tr/TrVATIdentificationNumberProvider.java

@@ -0,0 +1,47 @@
+package com.devskiller.jfairy.producer.company.locale.tr;
+
+import com.devskiller.jfairy.producer.BaseProducer;
+import com.devskiller.jfairy.producer.VATIdentificationNumberProvider;
+
+/**
+ * Turkish VKN (Vergi Kimlik Numarası) generator.
+ * 10 digits.
+ * Last digit is a check digit.
+ */
+public class TrVATIdentificationNumberProvider implements VATIdentificationNumberProvider {
+
+	private final BaseProducer baseProducer;
+
+	public TrVATIdentificationNumberProvider(BaseProducer baseProducer) {
+		this.baseProducer = baseProducer;
+	}
+
+	@Override
+	public String get() {
+		int[] digits = new int[10];
+
+		for (int i = 0; i < 9; i++) {
+			digits[i] = baseProducer.randomBetween(0, 9);
+		}
+
+		int sum = 0;
+		for (int i = 0; i < 9; i++) {
+			int p = (digits[i] + 10 - (i + 1)) % 10;
+			if (p == 9) {
+				sum += 9;
+			} else {
+				int q = (int) (p * Math.pow(2, 9 - i)) % 9;
+				sum += q;
+			}
+		}
+
+		int c1 = (10 - (sum % 10)) % 10;
+		digits[9] = c1;
+
+		StringBuilder sb = new StringBuilder();
+		for (int digit : digits) {
+			sb.append(digit);
+		}
+		return sb.toString();
+	}
+}

src/main/java/com/devskiller/jfairy/producer/person/Country.java

@@ -21,7 +21,8 @@ public enum Country {
 	Sweden("SE", LanguageCode.SV),
 	China("CN", LanguageCode.ZH),
 	Brazil("BR", LanguageCode.BR),
-	Slovakia("SK", LanguageCode.SK);
+	Slovakia("SK", LanguageCode.SK),
+	Turkey("TR", LanguageCode.TR);
 
 	//	ISO 3166 code
 	private final String code;

src/main/java/com/devskiller/jfairy/producer/person/locale/tr/TrAddress.java

@@ -0,0 +1,20 @@
+package com.devskiller.jfairy.producer.person.locale.tr;
+
+import com.devskiller.jfairy.producer.person.locale.ContinentalAddress;
+
+public class TrAddress extends ContinentalAddress {
+
+	public TrAddress(String streetNumber, String street, String apartmentNumber, String postalCode, String city) {
+		super(street, streetNumber, apartmentNumber, postalCode, city);
+	}
+
+	@Override
+	protected String getStreetNumberSeparator() {
+		return " No: ";
+	}
+
+	@Override
+	protected String getApartmentMark() {
+		return " Daire: ";
+	}
+}

src/main/java/com/devskiller/jfairy/producer/person/locale/tr/TrAddressProvider.java

@@ -0,0 +1,18 @@
+package com.devskiller.jfairy.producer.person.locale.tr;
+
+import com.devskiller.jfairy.data.DataMaster;
+import com.devskiller.jfairy.producer.BaseProducer;
+import com.devskiller.jfairy.producer.person.AbstractAddressProvider;
+
+public class TrAddressProvider extends AbstractAddressProvider {
+
+	public TrAddressProvider(DataMaster dataMaster, BaseProducer baseProducer) {
+		super(dataMaster, baseProducer);
+	}
+
+	@Override
+	public TrAddress get() {
+		return new TrAddress(getStreetNumber(), getStreet(), getApartmentNumber(),
+				getPostalCode(), getCity());
+	}
+}

src/main/java/com/devskiller/jfairy/producer/person/locale/tr/TrNationalIdentityCardNumberProvider.java

@@ -0,0 +1,51 @@
+package com.devskiller.jfairy.producer.person.locale.tr;
+
+import com.devskiller.jfairy.producer.BaseProducer;
+import com.devskiller.jfairy.producer.person.NationalIdentityCardNumberProvider;
+
+/**
+ * Turkish T.C. Kimlik No generator.
+ * 11 digits.
+ * 1st digit cannot be 0.
+ * 10th digit = ((sum(1,3,5,7,9) * 7) - sum(2,4,6,8)) % 10.
+ * 11th digit = (sum(1..10)) % 10.
+ */
+public class TrNationalIdentityCardNumberProvider implements NationalIdentityCardNumberProvider {
+
+	private final BaseProducer baseProducer;
+
+	public TrNationalIdentityCardNumberProvider(BaseProducer baseProducer) {
+		this.baseProducer = baseProducer;
+	}
+
+	@Override
+	public String get() {
+		int[] digits = new int[11];
+
+		digits[0] = baseProducer.randomBetween(1, 9);
+		for (int i = 1; i < 9; i++) {
+			digits[i] = baseProducer.randomBetween(0, 9);
+		}
+
+		int oddSum = digits[0] + digits[2] + digits[4] + digits[6] + digits[8];
+		int evenSum = digits[1] + digits[3] + digits[5] + digits[7];
+
+		int d10 = ((oddSum * 7) - evenSum) % 10;
+		if (d10 < 0) {
+			d10 += 10;
+		}
+		digits[9] = d10;
+
+		int totalSum = 0;
+		for (int i = 0; i < 10; i++) {
+			totalSum += digits[i];
+		}
+		digits[10] = totalSum % 10;
+
+		StringBuilder sb = new StringBuilder();
+		for (int digit : digits) {
+			sb.append(digit);
+		}
+		return sb.toString();
+	}
+}

src/main/java/com/devskiller/jfairy/producer/person/locale/tr/TrPassportNumberProvider.java

@@ -0,0 +1,18 @@
+package com.devskiller.jfairy.producer.person.locale.tr;
+
+import com.devskiller.jfairy.producer.BaseProducer;
+import com.devskiller.jfairy.producer.person.PassportNumberProvider;
+
+public class TrPassportNumberProvider implements PassportNumberProvider {
+
+	private final BaseProducer baseProducer;
+
+	public TrPassportNumberProvider(BaseProducer baseProducer) {
+		this.baseProducer = baseProducer;
+	}
+
+	@Override
+	public String get() {
+		return "U" + String.format("%08d", baseProducer.randomBetween(1, 99999999));
+	}
+}

src/main/java/com/devskiller/jfairy/producer/util/LanguageCode.java

@@ -20,5 +20,6 @@ public enum LanguageCode {
 	SV,
 	ZH,
 	BR,
-	SK
+	SK,
+	TR
 }

src/main/resources/jfairy_tr.yml

@@ -0,0 +1,28 @@
+alphabet: abcçdefgğhıijklmnoöprsştuüvyz
+domains: [ com.tr, org.tr, net.tr, edu.tr, gov.tr, k12.tr, av.tr, dr.tr, bel.tr, tsk.tr ]
+firstNames: {
+    male: [ Ahmet, Mehmet, Mustafa, Ali, Hüseyin, Hasan, İbrahim, İsmail, Osman, Murat, Ömer, Ramazan, Halil, Süleyman, Abdullah, Mahmut, Recep, Salih, Fatih, Kadir, Emre, Gökhan, Hakan, Serkan, Metin, Burak, Volkan, Bülent, Kenan, Selçuk, Yavuz, Sinan, Can, Kerem, Deniz, Onur, Umut, Eren, Arda, Mert, Yiğit, Berk, Tolga, Kaan, Doruk, Batuhan, Görkem, Furkan, Enes, Yunus, Bilal ],
+    female: [ Fatma, Ayşe, Emine, Hatice, Zeynep, Özlem, Elif, Meryem, Gamze, Şerife, Hanife, Sultan, Zehra, Havva, Hayriye, Cemile, Güllü, Leyla, Saliha, Melek, Arzu, Yasemin, Esra, Dilek, Pınar, Tuğba, Seda, Ebru, Gizem, Büşra, Kübra, Feyza, Beyza, İrem, Merve, Nursel, Selin, Pelin, Damla, Yağmur, Ece, Duru, Defne, Azra, Derin, Bade, Nehir, Eylül, Melis ],
+}
+lastNames: {
+    male: [ Yılmaz, Kaya, Demir, Çelik, Şahin, Yıldız, Yıldırım, Öztürk, Aydın, Özdemir, Arslan, Doğan, Kılıç, Aslan, Çetin, Kara, Koç, Kurt, Özkan, Şimşek, Polat, Özcan, Korkmaz, Çakır, Erdoğan, Yavuz, Can, Aksoy, Köse, Güler, Aktaş, Avcı, Akın, Özer, Ünal, Kaplan, Bulut, Yiğit, Sarı, Taş, Kaymak, Önal, Güneş, Ay, Karaman, Çavuş, Yalçın, Uzun, Karakaş, Tekin ],
+    female: [ Yılmaz, Kaya, Demir, Çelik, Şahin, Yıldız, Yıldırım, Öztürk, Aydın, Özdemir, Arslan, Doğan, Kılıç, Aslan, Çetin, Kara, Koç, Kurt, Özkan, Şimşek, Polat, Özcan, Korkmaz, Çakır, Erdoğan, Yavuz, Can, Aksoy, Köse, Güler, Aktaş, Avcı, Akın, Özer, Ünal, Kaplan, Bulut, Yiğit, Sarı, Taş, Kaymak, Önal, Güneş, Ay, Karaman, Çavuş, Yalçın, Uzun, Karakaş, Tekin ]
+}
+personalEmails: [ gmail.com, hotmail.com, yahoo.com, outlook.com, icloud.com ]
+companyNames: [ Holding, Şirket, Ticaret, Sanayi, Limited, Anonim, Bilişim, Otomotiv, Gıda, İnşaat, Tekstil, Lojistik, Turizm, Enerji, Medya, Sağlık, Eğitim, Banka, Sigorta, Mağaza, Market, Restoran, Kafe ]
+companySuffixes: [ 'A.Ş.', 'Ltd. Şti.', 'Hizmetleri', 'Grubu', 'Dış Ticaret' ]
+companyEmails: [ info, destek, satis, hello, merhaba ]
+
+text: Bu bir deneme metnidir. Türkçe dil desteği için oluşturulmuştur. Bu sistem sayesinde rastgele Türkçe veriler üretebilirsiniz. Adresler, isimler, telefon numaraları ve daha fazlası artık jfairy ile mümkün. Teknolojinin getirdiği bu kolaylıklar sayesinde test süreçleriniz daha hızlı ve verimli hale gelecek.
+
+telephone_number_formats: [ '+90 5## ### ## ##' ]
+
+postal_code: [ '#####' ]
+
+city: [ İstanbul, Ankara, İzmir, Bursa, Antalya, Adana, Konya, Gaziantep, Şanlıurfa, Mersin, Kocaeli, Diyarbakır, Hatay, Manisa, Kayseri, Samsun, Balıkesir, Kahramanmaraş, Van, Aydın ]
+
+street: [ İstiklal Caddesi, Bağdat Caddesi, Cumhuriyet Caddesi, Atatürk Bulvarı, Vatan Caddesi, Ordu Caddesi, Halaskargazi Caddesi, Abdi İpekçi Caddesi, Nispetiye Caddesi, Barbaros Bulvarı, Turgut Özal Bulvarı, Mevlana Caddesi, Fevzi Çakmak Caddesi, Ziya Gökalp Caddesi, Mithatpaşa Caddesi, Tunalı Hilmi Caddesi, Bahçelievler 7. Cadde, Kenan Evren Bulvarı, Gazipaşa Bulvarı, Talatpaşa Bulvarı ]
+
+country: [ 'Türkiye' ]
+
+language: 'TR'

src/test/groovy/com/devskiller/jfairy/producer/company/locale/tr/TrVATIdentificationNumberProviderSpec.groovy

@@ -0,0 +1,33 @@
+package com.devskiller.jfairy.producer.company.locale.tr
+
+import com.devskiller.jfairy.producer.BaseProducer
+import com.devskiller.jfairy.producer.RandomGenerator
+import spock.lang.Specification
+
+class TrVATIdentificationNumberProviderSpec extends Specification {
+
+	def "should generate valid VKN"() {
+		given:
+		BaseProducer baseProducer = new BaseProducer(new RandomGenerator())
+		TrVATIdentificationNumberProvider provider = new TrVATIdentificationNumberProvider(baseProducer)
+
+		expect:
+		(1..100).each {
+			String vkn = provider.get()
+			assert vkn.length() == 10
+			int[] digits = vkn.chars().collect { Character.getNumericValue((char) it) }
+			int sum = 0
+			for (int i = 0; i < 9; i++) {
+				int p = (digits[i] + 10 - (i + 1)) % 10
+				if (p == 9) {
+					sum += 9
+				} else {
+					int q = (int) (p * Math.pow(2, 9 - i)) % 9
+					sum += q
+				}
+			}
+			int c1 = (10 - (sum % 10)) % 10
+			assert digits[9] == c1
+		}
+	}
+}