shevchenko 2.1.2 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/.eslintrc.json +53 -0
  2. package/.prettierrc.json +5 -0
  3. package/dist/cjs/shevchenko.js +1307 -122
  4. package/dist/cjs/shevchenko.js.map +1 -1
  5. package/dist/es/shevchenko.js +1310 -128
  6. package/dist/es/shevchenko.js.map +1 -1
  7. package/dist/types/anthroponym-inflection/anthroponym-inflector.d.ts.map +1 -1
  8. package/dist/types/anthroponym-inflection/command-runner-factory.d.ts +1 -1
  9. package/dist/types/anthroponym-inflection/command-runner-factory.d.ts.map +1 -1
  10. package/dist/types/anthroponym-inflection/first-name-inflector.d.ts +1 -1
  11. package/dist/types/anthroponym-inflection/first-name-inflector.d.ts.map +1 -1
  12. package/dist/types/anthroponym-inflection/last-name-inflector.d.ts +1 -1
  13. package/dist/types/anthroponym-inflection/last-name-inflector.d.ts.map +1 -1
  14. package/dist/types/anthroponym-inflection/middle-name-inflector.d.ts +1 -1
  15. package/dist/types/anthroponym-inflection/middle-name-inflector.d.ts.map +1 -1
  16. package/dist/types/anthroponym-inflection/name-inflector.d.ts.map +1 -1
  17. package/dist/types/anthroponym-inflection/replace-command-runner.d.ts +1 -1
  18. package/dist/types/anthroponym-inflection/replace-command-runner.d.ts.map +1 -1
  19. package/dist/types/anthroponym-inflection/rule-inflector.d.ts.map +1 -1
  20. package/dist/types/bootstrap.d.ts.map +1 -1
  21. package/dist/types/core/validator.d.ts.map +1 -1
  22. package/dist/types/gender-detection/detect-gender.d.ts +11 -0
  23. package/dist/types/gender-detection/detect-gender.d.ts.map +1 -0
  24. package/dist/types/gender-detection/index.d.ts +2 -0
  25. package/dist/types/gender-detection/index.d.ts.map +1 -0
  26. package/dist/types/part-of-speech-recognition/neural-network.d.ts +1 -1
  27. package/dist/types/part-of-speech-recognition/neural-network.d.ts.map +1 -1
  28. package/dist/types/part-of-speech-recognition/part-of-speech-decoder.d.ts.map +1 -1
  29. package/dist/types/part-of-speech-recognition/part-of-speech-recognition-rule.d.ts +1 -1
  30. package/dist/types/part-of-speech-recognition/part-of-speech-recognition-rule.d.ts.map +1 -1
  31. package/dist/types/part-of-speech-recognition/part-of-speech-recognizer.d.ts +1 -1
  32. package/dist/types/part-of-speech-recognition/part-of-speech-recognizer.d.ts.map +1 -1
  33. package/dist/types/shevchenko.d.ts +3 -2
  34. package/dist/types/shevchenko.d.ts.map +1 -1
  35. package/dist/types/utils/string.utils.d.ts.map +1 -1
  36. package/dist/umd/shevchenko.min.js +4 -4
  37. package/dist/umd/shevchenko.min.js.map +1 -1
  38. package/nuxt/components/declension-demo.vue +7 -1
  39. package/nuxt/components/declension-form.vue +77 -10
  40. package/nuxt/components/declension-results.vue +26 -7
  41. package/nuxt/components/how-it-works.vue +10 -10
  42. package/nuxt/composables/declension.ts +47 -4
  43. package/nuxt/data/female-first-names.json +556 -0
  44. package/nuxt/data/male-first-names.json +603 -0
  45. package/nuxt/locales/en-US.json +6 -3
  46. package/nuxt/locales/uk-UA.json +8 -5
  47. package/nuxt/package-lock.json +7 -7
  48. package/nuxt/package.json +2 -2
  49. package/package.json +13 -10
  50. package/src/anthroponym-inflection/anthroponym-inflector.ts +20 -5
  51. package/src/anthroponym-inflection/command-runner-factory.ts +2 -2
  52. package/src/anthroponym-inflection/first-name-inflector.ts +5 -5
  53. package/src/anthroponym-inflection/inflector.types.ts +19 -19
  54. package/src/anthroponym-inflection/last-name-inflector.ts +10 -6
  55. package/src/anthroponym-inflection/middle-name-inflector.ts +5 -5
  56. package/src/anthroponym-inflection/name-inflector.ts +9 -3
  57. package/src/anthroponym-inflection/replace-command-runner.ts +1 -1
  58. package/src/anthroponym-inflection/rule-inflector.ts +2 -2
  59. package/src/bootstrap.ts +10 -10
  60. package/src/core/validator.ts +12 -5
  61. package/src/gender-detection/detect-gender.ts +43 -0
  62. package/src/gender-detection/given-names-genders.json +1144 -0
  63. package/src/gender-detection/index.ts +1 -0
  64. package/src/part-of-speech-recognition/neural-network.ts +10 -5
  65. package/src/part-of-speech-recognition/part-of-speech-decoder.ts +1 -1
  66. package/src/part-of-speech-recognition/part-of-speech-recognition-rule.ts +6 -2
  67. package/src/part-of-speech-recognition/part-of-speech-recognizer.ts +2 -2
  68. package/src/part-of-speech-recognition/word-encoder.ts +2 -2
  69. package/src/resources/inflector/rules.json +27 -26
  70. package/src/shevchenko.ts +4 -3
  71. package/src/utils/string.utils.ts +3 -3
  72. package/test/anthroponym-inflection.js +58 -0
  73. package/test/gender-detection.js +29 -0
  74. package/test/input-validation.js +353 -0
  75. package/test/main.test.js +18 -0
  76. package/test/samples.json +7282 -0
  77. package/tsconfig.types.json +9 -0
@@ -4,7 +4,7 @@
4
4
  <div class="col-12 col-lg-9">
5
5
  <h2 class="mb-0">
6
6
  {{ $t('demo') }}
7
- <small class="d-block h6 text-muted mt-2 mb-0">
7
+ <small class="d-block h6 text-muted mt-2 mb-0 sentence-capitalize">
8
8
  {{ $t('demo.message') }}
9
9
  </small>
10
10
  </h2>
@@ -30,3 +30,9 @@
30
30
  </div>
31
31
  </section>
32
32
  </template>
33
+
34
+ <style lang="scss" scoped>
35
+ .sentence-capitalize:first-letter {
36
+ text-transform: capitalize;
37
+ }
38
+ </style>
@@ -1,7 +1,12 @@
1
1
  <script setup lang="ts">
2
+ import { useToggle } from '@vueuse/core';
2
3
  import { Anthroponym, Gender } from 'shevchenko';
3
- import { toRefs, PropType } from 'vue';
4
- import { shevchenkoAnthroponym, useDeclension } from '~/composables/declension';
4
+ import { onMounted, PropType, toRefs } from 'vue';
5
+ import {
6
+ shevchenkoAnthroponym,
7
+ useDeclension,
8
+ isShevchenkoAnthroponym,
9
+ } from '~/composables/declension';
5
10
 
6
11
  const props = defineProps({
7
12
  initialAnthroponym: { type: Object as PropType<Anthroponym>, default: () => ({}) },
@@ -11,10 +16,52 @@ const { initialAnthroponym } = toRefs(props);
11
16
 
12
17
  const emit = defineEmits(['declension']);
13
18
 
14
- const { anthroponym, inflect } = useDeclension(initialAnthroponym.value);
19
+ const { anthroponym, detectGender, inflect } = useDeclension(initialAnthroponym.value);
20
+ const [isGenderError, showGenderError] = useToggle(false);
21
+
22
+ const AutoGender = undefined;
23
+ const genderOptions = [AutoGender, ...Object.values(Gender)];
24
+
25
+ interface FormData {
26
+ gender: Gender | typeof AutoGender;
27
+ firstName?: string;
28
+ lastName?: string;
29
+ middleName?: string;
30
+ }
31
+
32
+ const formData: FormData = {
33
+ gender: AutoGender,
34
+ firstName: '',
35
+ lastName: '',
36
+ middleName: '',
37
+ };
38
+
39
+ function setFormData(data: FormData): void {
40
+ formData.gender = data.gender;
41
+ formData.firstName = data.firstName;
42
+ formData.lastName = data.lastName;
43
+ formData.middleName = data.middleName;
44
+ }
45
+
46
+ onMounted(() => {
47
+ if (!isShevchenkoAnthroponym(initialAnthroponym.value)) {
48
+ setFormData(initialAnthroponym.value);
49
+ }
50
+ });
15
51
 
16
52
  function onInflect(): void {
17
- inflect();
53
+ let { gender, firstName, lastName, middleName } = formData;
54
+
55
+ if (gender == null) {
56
+ gender = detectGender({ firstName, lastName, middleName }) ?? AutoGender;
57
+ if (gender == null) {
58
+ showGenderError(true);
59
+ return;
60
+ }
61
+ }
62
+
63
+ showGenderError(false);
64
+ inflect({ gender, firstName, lastName, middleName });
18
65
  emit('declension', anthroponym);
19
66
  }
20
67
  </script>
@@ -28,10 +75,30 @@ function onInflect(): void {
28
75
  </div>
29
76
 
30
77
  <div class="form-group">
31
- <label class="radio-inline mr-2" v-for="gender in Gender" :key="gender">
32
- <input v-model="anthroponym.gender" type="radio" name="gender" :value="gender" />
33
- {{ $t(`gender.${gender}`) }}
78
+ <label
79
+ class="radio-inline mr-2"
80
+ v-for="genderOption in genderOptions"
81
+ :key="genderOption"
82
+ :title="$t('gender.message.autoDetection')"
83
+ >
84
+ <input v-model="formData.gender" type="radio" name="gender" :value="genderOption" />
85
+ {{ $t(`gender.${genderOption}`) }}
86
+ <span v-if="genderOption === AutoGender">
87
+ ({{ $t(`gender.${anthroponym.gender}`) }})
88
+ </span>
34
89
  </label>
90
+
91
+ <small
92
+ v-if="isGenderError"
93
+ v-show="formData.gender === AutoGender"
94
+ class="form-text text-danger"
95
+ >
96
+ {{ $t('gender.message.detectionFailed') }}
97
+ </small>
98
+
99
+ <small v-else class="form-text text-muted">
100
+ {{ $t('gender.message.autoDetection') }}
101
+ </small>
35
102
  </div>
36
103
 
37
104
  <div class="form-group">
@@ -39,7 +106,7 @@ function onInflect(): void {
39
106
  {{ $t('anthroponym.lastName') }}
40
107
  </label>
41
108
  <input
42
- v-model.trim="anthroponym.lastName"
109
+ v-model.trim="formData.lastName"
43
110
  type="text"
44
111
  class="form-control"
45
112
  name="last-name"
@@ -53,7 +120,7 @@ function onInflect(): void {
53
120
  {{ $t('anthroponym.firstName') }}
54
121
  </label>
55
122
  <input
56
- v-model.trim="anthroponym.firstName"
123
+ v-model.trim="formData.firstName"
57
124
  type="text"
58
125
  class="form-control"
59
126
  name="first-name"
@@ -67,7 +134,7 @@ function onInflect(): void {
67
134
  {{ $t('anthroponym.middleName') }}
68
135
  </label>
69
136
  <input
70
- v-model.trim="anthroponym.middleName"
137
+ v-model.trim="formData.middleName"
71
138
  type="text"
72
139
  class="form-control"
73
140
  name="middle-name"
@@ -1,7 +1,26 @@
1
1
  <script setup lang="ts">
2
2
  import { useDeclension } from '~/composables/declension';
3
+ import { Anthroponym } from 'shevchenko';
3
4
 
4
5
  const { declensionResults } = useDeclension();
6
+
7
+ function convertAnthroponymToString(anthroponym: Anthroponym): string {
8
+ let output: string[] = [];
9
+
10
+ if (anthroponym.lastName) {
11
+ output.push(anthroponym.lastName);
12
+ }
13
+
14
+ if (anthroponym.firstName) {
15
+ output.push(anthroponym.firstName);
16
+ }
17
+
18
+ if (anthroponym.middleName) {
19
+ output.push(anthroponym.middleName);
20
+ }
21
+
22
+ return output.join(' ');
23
+ }
5
24
  </script>
6
25
 
7
26
  <template>
@@ -30,7 +49,7 @@ const { declensionResults } = useDeclension();
30
49
  <td>
31
50
  <CopyButton
32
51
  :button-id="'copy-nominative-case-button'"
33
- :source="`${declensionResults.nominativeCase.lastName} ${declensionResults.nominativeCase.firstName} ${declensionResults.nominativeCase.middleName}`"
52
+ :source="convertAnthroponymToString(declensionResults.nominativeCase)"
34
53
  />
35
54
  </td>
36
55
  </tr>
@@ -43,7 +62,7 @@ const { declensionResults } = useDeclension();
43
62
  <td>
44
63
  <CopyButton
45
64
  :button-id="'copy-genitive-case-button'"
46
- :source="`${declensionResults.genitiveCase.lastName} ${declensionResults.genitiveCase.firstName} ${declensionResults.genitiveCase.middleName}`"
65
+ :source="convertAnthroponymToString(declensionResults.genitiveCase)"
47
66
  />
48
67
  </td>
49
68
  </tr>
@@ -56,7 +75,7 @@ const { declensionResults } = useDeclension();
56
75
  <td>
57
76
  <CopyButton
58
77
  :button-id="'copy-dative-case-button'"
59
- :source="`${declensionResults.dativeCase.lastName} ${declensionResults.dativeCase.firstName} ${declensionResults.dativeCase.middleName}`"
78
+ :source="convertAnthroponymToString(declensionResults.dativeCase)"
60
79
  />
61
80
  </td>
62
81
  </tr>
@@ -69,7 +88,7 @@ const { declensionResults } = useDeclension();
69
88
  <td>
70
89
  <CopyButton
71
90
  :button-id="'copy-accusative-case-button'"
72
- :source="`${declensionResults.accusativeCase.lastName} ${declensionResults.accusativeCase.firstName} ${declensionResults.accusativeCase.middleName}`"
91
+ :source="convertAnthroponymToString(declensionResults.accusativeCase)"
73
92
  />
74
93
  </td>
75
94
  </tr>
@@ -82,7 +101,7 @@ const { declensionResults } = useDeclension();
82
101
  <td>
83
102
  <CopyButton
84
103
  :button-id="'copy-ablative-case-button'"
85
- :source="`${declensionResults.ablativeCase.lastName} ${declensionResults.ablativeCase.firstName} ${declensionResults.ablativeCase.middleName}`"
104
+ :source="convertAnthroponymToString(declensionResults.ablativeCase)"
86
105
  />
87
106
  </td>
88
107
  </tr>
@@ -95,7 +114,7 @@ const { declensionResults } = useDeclension();
95
114
  <td>
96
115
  <CopyButton
97
116
  :button-id="'copy-locative-case-button'"
98
- :source="`${declensionResults.locativeCase.lastName} ${declensionResults.locativeCase.firstName} ${declensionResults.locativeCase.middleName}`"
117
+ :source="convertAnthroponymToString(declensionResults.locativeCase)"
99
118
  />
100
119
  </td>
101
120
  </tr>
@@ -108,7 +127,7 @@ const { declensionResults } = useDeclension();
108
127
  <td>
109
128
  <CopyButton
110
129
  :button-id="'copy-vocative-case-button'"
111
- :source="`${declensionResults.vocativeCase.lastName} ${declensionResults.vocativeCase.firstName} ${declensionResults.vocativeCase.middleName}`"
130
+ :source="convertAnthroponymToString(declensionResults.vocativeCase)"
112
131
  />
113
132
  </td>
114
133
  </tr>
@@ -12,7 +12,7 @@
12
12
  <p>
13
13
  Бібліотека використовує більше вісімдесяти правил для відмінювання прізвищ, імен та по
14
14
  батькові. Правила фільтруються за родом, закінченням, частиною мови, сферою застосування
15
- та сортуються за пріорітетом.
15
+ та сортуються за пріоритетом.
16
16
  </p>
17
17
 
18
18
  <p>
@@ -20,29 +20,29 @@
20
20
  закінченнями на -ой, -ій, -ий, -их для визначення частини мови слова використовуються
21
21
  нейронні мережі, навчені на більш як сорока тисячах прізвищах. Тому прізвища
22
22
  іменникового та прикметникового походжень відмінюються як іменники та прикметники
23
- відповідно, наприклад, Диня (називний) -&gt; Дині (родовий), Синя (називний) -&gt;
24
- Синьої (родовий), Рий (називний) -&gt; Рия (родовий), Бурий (називний) -&gt; Бурого
23
+ відповідно, наприклад, Диня (називний) &rarr; Дині (родовий), Синя (називний) &rarr;
24
+ Синьої (родовий), Рий (називний) &rarr; Рия (родовий), Бурий (називний) &rarr; Бурого
25
25
  (родовий).
26
26
  </p>
27
27
 
28
28
  <p>
29
- При відмінюванні відбуваються зміни голосних та приголосних звуків згідно правил
30
- української мови, наприклад, Сивокінь (називний) -&gt; Сивоконя (родовий), Гичка
31
- (називний) -&gt; Гичці (давальний), але Чміль (називний) -&gt; Чміля (родовий).
29
+ При відмінюванні відбуваються зміни голосних та приголосних звуків згідно з правилами
30
+ української мови, наприклад, Сивокінь (називний) &rarr; Сивоконя (родовий), Гичка
31
+ (називний) &rarr; Гичці (давальний), але Чміль (називний) &rarr; Чміля (родовий).
32
32
  </p>
33
33
 
34
34
  <p>
35
35
  Складені прізвища, утворені поєднанням двох самостійних прізвищ відмінюються за
36
36
  правилами відмінювання кожної складової частини, наприклад, Нечуй-Левицький (називний) -
37
- Нечуя-Левицького (родовий), але Драй-Хмара (називний) - Драй-Хмари (родовий), бо перша
37
+ Нечуя-Левицького (родовий), але Драй-Хмара (називний) — Драй-Хмари (родовий), бо перша
38
38
  коротка частина складеного прізвища є односкладовою та сприймається не як самостійне
39
39
  прізвище, а як приставка до другого компонента.
40
40
  </p>
41
41
 
42
42
  <p>
43
- Складені імена, утворені поєднанням двох самостійних імен відмінюються за правилами
44
- відмінювання кожної складової частини, наприклад, Анна-Марія (називний) - Анни-Марії
45
- (родовий).
43
+ Складені імена, утворені поєднанням двох самостійних імен відмінюються згідно з
44
+ правилами відмінювання кожної складової частини, наприклад, Анна-Марія (називний) -
45
+ Анни-Марії (родовий).
46
46
  </p>
47
47
  </div>
48
48
  </div>
@@ -11,6 +11,10 @@ import {
11
11
  inLocative,
12
12
  inVocative,
13
13
  } from 'shevchenko';
14
+ import maleFirstNames from '~/data/male-first-names.json';
15
+ import femaleFirstNames from '~/data/female-first-names.json';
16
+
17
+ export type GenderlessAnthroponym = Omit<Anthroponym, 'gender'>;
14
18
 
15
19
  export const shevchenkoAnthroponym: Anthroponym = {
16
20
  gender: Gender.Male,
@@ -38,8 +42,17 @@ export function isDefinedAnthroponym(
38
42
  ): anthroponym is Anthroponym {
39
43
  return Boolean(
40
44
  anthroponym.gender &&
41
- Object.values(Gender).includes(anthroponym.gender) &&
42
- (anthroponym.firstName || anthroponym.middleName || anthroponym.lastName),
45
+ Object.values(Gender).includes(anthroponym.gender) &&
46
+ (anthroponym.firstName || anthroponym.middleName || anthroponym.lastName),
47
+ );
48
+ }
49
+
50
+ export function isShevchenkoAnthroponym(anthroponym: Partial<Anthroponym>): boolean {
51
+ return (
52
+ anthroponym.gender === shevchenkoAnthroponym.gender &&
53
+ anthroponym.lastName === shevchenkoAnthroponym.lastName &&
54
+ anthroponym.firstName === shevchenkoAnthroponym.firstName &&
55
+ anthroponym.middleName === shevchenkoAnthroponym.middleName
43
56
  );
44
57
  }
45
58
 
@@ -67,7 +80,15 @@ export const useDeclension = createSharedComposable((predefinedAnthroponym: Anth
67
80
  vocativeCase: inVocative(initialAnthroponym),
68
81
  });
69
82
 
70
- function inflect(): void {
83
+ function setAnthroponym(source: Anthroponym): void {
84
+ anthroponym.gender = source.gender;
85
+ anthroponym.lastName = source.lastName;
86
+ anthroponym.firstName = source.firstName;
87
+ anthroponym.middleName = source.middleName;
88
+ }
89
+
90
+ function inflect(source: Anthroponym): void {
91
+ setAnthroponym(source);
71
92
  declensionResults.nominativeCase = inNominative(anthroponym);
72
93
  declensionResults.genitiveCase = inGenitive(anthroponym);
73
94
  declensionResults.dativeCase = inDative(anthroponym);
@@ -77,5 +98,27 @@ export const useDeclension = createSharedComposable((predefinedAnthroponym: Anth
77
98
  declensionResults.vocativeCase = inVocative(anthroponym);
78
99
  }
79
100
 
80
- return { anthroponym, declensionResults, inflect };
101
+ function detectGender(anthroponym: GenderlessAnthroponym): Gender | null {
102
+ if (anthroponym.middleName) {
103
+ const middleName = anthroponym.middleName.replace(/[`"]/g, "'").toLocaleLowerCase();
104
+ if (/(и|і)ч$/.test(middleName)) {
105
+ return Gender.Male;
106
+ } else if (/на$/.test(middleName)) {
107
+ return Gender.Female;
108
+ }
109
+ }
110
+
111
+ if (anthroponym.firstName) {
112
+ const firstName = anthroponym.firstName.replace(/[`"]/g, "'").toLocaleLowerCase();
113
+ if (maleFirstNames.includes(firstName)) {
114
+ return Gender.Male;
115
+ } else if (femaleFirstNames.includes(firstName)) {
116
+ return Gender.Female;
117
+ }
118
+ }
119
+
120
+ return null;
121
+ }
122
+
123
+ return { anthroponym, declensionResults, inflect, detectGender };
81
124
  });