cyrillic 0.2.0 → 0.3.0

data/lib/cyrillic/ua_passport.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Cyrillic
+  module UaPassport
+    k = %w[А Б В Г Ґ Д Е Ж З И І К Л М Н О П Р С Т У Ф Х Ц Ч Ш Щ а б в г ґ д е ж з и і к л м н о п р с т у ф х ц ч ш щ].freeze
+    v = %w[A B V H G D E Zh Z Y I K L M N O P R S T U F Kh Ts Ch Sh Shch a b v h g d e zh z y i k l m n o p r s t u f kh ts ch sh shch].freeze
+
+    CHARACTER_TABLE = k.zip(v).to_h.freeze
+
+    class << self
+      def transliterate(str = "")
+        return "" if str.nil? || str.empty?
+
+        str = str.to_s.gsub('Зг', 'Zgh').gsub('зг', 'zgh')
+
+        result = +""
+        str.each_char.with_index do |char, index|
+          prev_char = index.positive? ? str[index - 1] : nil
+          is_word_start = prev_char.nil? || prev_char == ' '
+
+          case char
+          when 'Є'
+            result << (is_word_start ? 'Ye' : 'Ie')
+          when 'є'
+            result << (is_word_start ? 'ye' : 'ie')
+          when 'Ї'
+            result << (is_word_start ? 'Yi' : 'I')
+          when 'ї'
+            result << (is_word_start ? 'yi' : 'i')
+          when 'Й'
+            result << (is_word_start ? 'Y' : 'I')
+          when 'й'
+            result << (is_word_start ? 'y' : 'i')
+          when 'Ю'
+            result << (is_word_start ? 'Yu' : 'Iu')
+          when 'ю'
+            result << (is_word_start ? 'yu' : 'iu')
+          when 'Я'
+            result << (is_word_start ? 'Ya' : 'Ia')
+          when 'я'
+            result << (is_word_start ? 'ya' : 'ia')
+          when 'Ь', 'ь', "'"
+            # Ignored in transliteration
+          else
+            result << (CHARACTER_TABLE[char] || char)
+          end
+        end
+        result
+      end
+    end
+  end
+end
+
+UaPassport = Cyrillic::UaPassport unless defined?(UaPassport)
+
+# https://pasport.org.ua/faq/transliteration
+# https://zakon.rada.gov.ua/laws/show/55-2010-%D0%BF/sp:dark?dark=0#Text
+
+# ТАБЛИЦЯ
+# транслітерації українського алфавіту латиницею
+
+# ------------------------------------------------------------------
+# | Український | Латиниця |  Позиція у |    Приклади написання    |
+# |   алфавіт   |          |   слові    |--------------------------|
+# |             |          |            |українською |  латиницею  |
+# |             |          |            |    мовою   |             |
+# |-------------+----------+------------+------------+-------------|
+# |      Аа     |    Aa    |            |Алушта      |Alushta      |
+# |             |          |            |Андрій      |Andrii       |
+# |-------------+----------+------------+------------+-------------|
+# |      Бб     |    Bb    |            |Борщагівка  |Borshchahivka|
+# |             |          |            |Борисенко   |Borysenko    |
+# |-------------+----------+------------+------------+-------------|
+# |      Вв     |    Vv    |            |Вінниця     |Vinnytsia    |
+# |             |          |            |Володимир   |Volodymyr    |
+# |-------------+----------+------------+------------+-------------|
+# |      Гг     |    Hh    |            |Гадяч       |Hadiach      |
+# |             |          |            |Богдан      |Bohdan       |
+# |             |          |            |Згурський   |Zghurskyi    |
+# |-------------+----------+------------+------------+-------------|
+# |      Ґґ     |    Gg    |            |Ґалаґан     |Galagan      |
+# |             |          |            |Ґорґани     |Gorgany      |
+# |-------------+----------+------------+------------+-------------|
+# |      Дд     |    Dd    |            |Донецьк     |Donetsk      |
+# |             |          |            |Дмитро      |Dmytro       |
+# |-------------+----------+------------+------------+-------------|
+# |      Ее     |    Ee    |            |Рівне       |Rivne        |
+# |             |          |            |Олег        |Oleh         |
+# |             |          |            |Есмань      |Esman        |
+# |-------------+----------+------------+------------+-------------|
+# |      Єє     |    Ye    | на початку |Єнакієве    |Yenakiieve   |
+# |             |          |    слова   |Гаєвич      |Haievych     |
+# |             |    ie    |  в інших   |Короп'є     |Koropie      |
+# |             |          |  позиціях  |            |             |
+# |-------------+----------+------------+------------+-------------|
+# |      Жж     |  Zh zh   |            |Житомир     |Zhytomyr     |
+# |             |          |            |Жанна       |Zhanna       |
+# |             |          |            |Жежелів     |Zhezheliv    |
+# |-------------+----------+------------+------------+-------------|
+# |      Зз     |    Zz    |            |Закарпаття  |Zakarpattia  |
+# |             |          |            |Казимирчук  |Kazymyrchuk  |
+# |-------------+----------+------------+------------+-------------|
+# |      Ии     |    Yy    |            |Медвин      |Medvyn       |
+# |             |          |            |Михайленко  |Mykhailenko  |
+# |-------------+----------+------------+------------+-------------|
+# |      Іі     |    Ii    |            |Іванків     |Ivankiv      |
+# |             |          |            |Іващенко    |Ivashchenko  |
+# |-------------+----------+------------+------------+-------------|
+# |      Її     |    Yi    | на початку |Їжакевич    |Yizhakevych  |
+# |             |          |    слова   |Кадиївка    |Kadyivka     |
+# |             |     i    |  в інших   |Мар'їне     |Marine       |
+# |             |          |  позиціях  |            |             |
+# |-------------+----------+------------+------------+-------------|
+# |      Йй     |    Y     | на початку |Йосипівка   |Yosypivka    |
+# |             |          |    слова   |Стрий       |Stryi        |
+# |             |    i     |  в других   |Олексій     |Oleksii      |
+# |             |          |  позиціях  |            |             |
+# |-------------+----------+------------+------------+-------------|
+# |      Кк     |    Kk    |            |Київ        |Kyiv         |
+# |             |          |            |Коваленко   |Kovalenko    |
+# |-------------+----------+------------+------------+-------------|
+# |      Лл     |    Ll    |            |Лебедин     |Lebedyn      |
+# |             |          |            |Леонід      |Leonid       |
+# |-------------+----------+------------+------------+-------------|
+# |      Мм     |    Mm    |            |Миколаїв    |Mykolaiv     |
+# |             |          |            |Маринич     |Marynych     |
+# |-------------+----------+------------+------------+-------------|
+# |      Нн     |    Nn    |            |Ніжин       |Nizhyn       |
+# |             |          |            |Наталія     |Nataliia     |
+# |-------------+----------+------------+------------+-------------|
+# |      Оо     |    Oo    |            |Одеса       |Odesa        |
+# |             |          |            |Онищенко    |Onyshchenko  |
+# |-------------+----------+------------+------------+-------------|
+# |      Пп     |    Pp    |            |Полтава     |Poltava      |
+# |             |          |            |Петро       |Petro        |
+# |-------------+----------+------------+------------+-------------|
+# |      Рр     |    Rr    |            |Решетилівка |Reshetylivka |
+# |             |          |            |Рибчинський |Rybchynskyi  |
+# |-------------+----------+------------+------------+-------------|
+# |      Сс     |    Ss    |            |Суми        |Sumy         |
+# |             |          |            |Соломія     |Solomiia     |
+# |-------------+----------+------------+------------+-------------|
+# |      Тт     |    Tt    |            |Тернопіль   |Ternopil     |
+# |             |          |            |Троць       |Trots        |
+# |-------------+----------+------------+------------+-------------|
+# |      Уу     |    Uu    |            |Ужгород     |Uzhhorod     |
+# |             |          |            |Уляна       |Uliana       |
+# |-------------+----------+------------+------------+-------------|
+# |      Фф     |    Ff    |            |Фастів      |Fastiv       |
+# |             |          |            |Філіпчук    |Filipchuk    |
+# |-------------+----------+------------+------------+-------------|
+# |      Хх     |  Kh kh   |            |Харків      |Kharkiv      |
+# |             |          |            |Христина    |Khrystyna    |
+# |-------------+----------+------------+------------+-------------|
+# |      Цц     |  Ts ts   |            |Біла Церква |Bila Tserkva |
+# |             |          |            |Стеценко    |Stetsenko    |
+# |-------------+----------+------------+------------+-------------|
+# |      Чч     |  Ch ch   |            |Чернівці    |Chernivtsi   |
+# |             |          |            |Шевченко    |Shevchenko   |
+# |-------------+----------+------------+------------+-------------|
+# |      Шш     |  Sh sh   |            |Шостка      |Shostka      |
+# |             |          |            |Кишеньки    |Kyshenky     |
+# |-------------+----------+------------+------------+-------------|
+# |      Щщ     |Shch shch |            |Щербухи     |Shcherbukhy  |
+# |             |          |            |Гоща        |Hoshcha      |
+# |             |          |            |Гаращенко   |Harashchenko |
+# |-------------+----------+------------+------------+-------------|
+# |      Юю     |    Yu    | на початку |Юрій        |Yurii        |
+# |             |          |    слова   |Корюківка   |Koriukivka   |
+# |             |    iu    |  в інших   |            |             |
+# |             |          |  позиціях  |            |             |
+# |-------------+----------+------------+------------+-------------|
+# |      Яя     |    Ya    | на початку |Яготин      |Yahotyn      |
+# |             |          |    слова   |Ярошенко    |Yaroshenko   |
+# |             |    ia    |  в інших   |Костянтин   |Kostiantyn   |
+# |             |          |  позиціях  |Знам'янка   |Znamianka    |
+# |             |          |            |Феодосія    |Feodosiia    |
+# ------------------------------------------------------------------
+#
+# _______________
+# Примітка: 1. Буквосполучення "зг" відтворюється латиницею як "zgh"
+#              (наприклад,  Згорани - Zghorany, Розгон - Rozghon) на
+#              відміну від "zh" -  відповідника  української  літери
+#              "ж".
+#           2. М'який знак і апостроф латиницею не відтворюються.
+#           3. Транслітерація  прізвищ  та  імен осіб і географічних
+#              назв здійснюється шляхом  відтворення  кожної  літери
+#              латиницею.

data/lib/cyrillic/ukrainian.rb

@@ -1,8 +1,13 @@
-module Ukrainian
+# frozen_string_literal: true
 
-  k = %w(А Б В Г Ґ Д Е Є Ж З И І Ї Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш Щ Ь Ю Я а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ь ю я)
-  v = %w(A B V H G D E Ye Zh Z Y I Yi I K L M N O P R S T U F Kh Ts Ch Sh Shch ʹ Iu Ia a b v h g d e ye zh z y i yi i k l m n o p r s t u f kh ts ch sh shch ʹ iu ia)
-
-  CHARACTER_TABLE = Hash[k.zip(v)]
+module Cyrillic
+  module Ukrainian
+    k = %w[А Б В Г Ґ Д Е Є Ж З И І Ї Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш Щ Ь Ю Я а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ь ю я].freeze
+    v = %w[A B V H G D E Ye Zh Z Y I Yi I K L M N O P R S T U F Kh Ts Ch Sh Shch ʹ Iu Ia a b v h g d e ye zh z y i yi i k l m n o p r s t u f kh ts ch sh shch ʹ iu ia].freeze
 
+    CHARACTER_TABLE = k.zip(v).to_h.freeze
+    REGEXP = Regexp.union(CHARACTER_TABLE.keys).freeze
+  end
 end
+
+Ukrainian = Cyrillic::Ukrainian unless defined?(Ukrainian)

data/lib/cyrillic/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cyrillic
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/cyrillic.rb

@@ -1,22 +1,66 @@
+# frozen_string_literal: true
+
 require "cyrillic/version"
 require "cyrillic/iso9"
 require "cyrillic/mongolian"
 require "cyrillic/ukrainian"
+require "cyrillic/ua_passport"
+require "cyrillic/de"
 
 module Cyrillic
+  k = %w[
+    А Б В Г Д Е Ё Ж З И І Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш Щ Ъ Ы Ь Ѣ Э Ю Я Ѳ Ѵ
+    а б в г д е ё ж з и і й к л м н о п р с т у ф х ц ч ш щ ъ ы ь ѣ э ю я ѳ ѵ
+  ].freeze
+  v = %w[
+    A B V G D E Ë ZH Z I Ī Ĭ K L M N O P R S T U F KH TS CH SH SHCH ʺ Y ʹ IE Ė IU IA Ḟ Ẏ
+    a b v g d e ë zh z i ī ĭ k l m n o p r s t u f kh ts ch sh shch ʺ y ʹ ie ė iu ia ḟ ẏ
+  ].freeze
 
-  k = %w(А Б В Г Д Е Ё Ж З И І Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш Щ Ъ Ы Ь Ѣ Э Ю Я Ѳ Ѵ а б в г д е ё ж з и і й к л м н о п р с т у ф х ц ч ш щ ъ ы ь ѣ э ю я ѳ ѵ)
-  v = %w(A B V G D E Ë ZH Z I Ī Ĭ K L M N O P R S T U F KH TS CH SH SHCH ʺ Y ʹ IE Ė IU IA Ḟ Ẏ a b v g d e ë zh z i ī ĭ k l m n o p r s t u f kh ts ch sh shch ʺ y ʹ ie ė iu ia ḟ ẏ)
+  CHARACTER_TABLE = k.zip(v).to_h.freeze
+  REGEXP = Regexp.union(CHARACTER_TABLE.keys).freeze
 
-  CHARACTER_TABLE = Hash[k.zip(v)]
+  SCHEMES = {
+    cyrillic: [CHARACTER_TABLE, REGEXP].freeze,
+    default: [CHARACTER_TABLE, REGEXP].freeze,
+    iso9: [Iso9::CHARACTER_TABLE, Iso9::REGEXP].freeze,
+    mongolian: [Mongolian::CHARACTER_TABLE, Mongolian::REGEXP].freeze,
+    ukrainian: [Ukrainian::CHARACTER_TABLE, Ukrainian::REGEXP].freeze,
+    ua_passport: :ua_passport,
+    de: [De::CHARACTER_TABLE, De::REGEXP].freeze
+  }.freeze
 
   class << self
+    # Transliterates Cyrillic text into Roman (Latin) script.
+    #
+    # @param string [String, #to_s] The text to transliterate.
+    # @param to [Symbol, String] The transliteration scheme (:cyrillic, :iso9, :mongolian, :ukrainian, :ua_passport, :de).
+    # @return [String] The transliterated Latin script string.
+    # @raise [ArgumentError] If the given transliteration scheme is unknown.
+    #
+    # @example Default Cyrillic transliteration
+    #   Cyrillic.transliterate("Кириллица") #=> "Kirillitsa"
+    #
+    # @example Short alias .t with ISO 9 scheme
+    #   Cyrillic.t("Кириллица", :iso9) #=> "Kirillica"
+    #
+    # @example Ukrainian Passport scheme
+    #   Cyrillic.t("Борщагівка", :ua_passport) #=> "Borshchahivka"
     def transliterate(string = "", to = :cyrillic)
-      character_table = Module.const_get(to.to_s.capitalize)::CHARACTER_TABLE
-      string.to_s.gsub(/#{Regexp.union(character_table.keys).source}/i, character_table)
+      return "" if string.nil? || string.empty?
+
+      scheme_key = to.to_s.downcase.to_sym
+      scheme = SCHEMES[scheme_key]
+      unless scheme
+        available = (SCHEMES.keys - [:default]).map(&:inspect).join(", ")
+        raise ArgumentError, "Unknown transliteration scheme: #{to.inspect}. Available schemes: #{available}"
+      end
 
+      return UaPassport.transliterate(string) if scheme_key == :ua_passport
+
+      table, regexp = scheme
+      string.to_s.gsub(regexp, table)
     end
-    alias_method :t, :transliterate
+    alias t transliterate
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cyrillic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - rovetz
@@ -10,68 +10,120 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-description: Romanization (transliteration) of Cyrillic. Converts Cyrillic text to
-  the Roman (Latin) script
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.64'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.64'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Converts Cyrillic text to the Roman (Latin) script
 email:
 - zakbox@gmail.com
-executables: []
+executables:
+- cyrillic
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - cyrillic.gemspec
+- exe/cyrillic
 - lib/cyrillic.rb
-- lib/cyrillic/ala_lc.rb
-- lib/cyrillic/bgn_pcgn.rb
-- lib/cyrillic/british_standard.rb
-- lib/cyrillic/duden.rb
-- lib/cyrillic/gost779b.rb
+- lib/cyrillic/de.rb
 - lib/cyrillic/iso9.rb
 - lib/cyrillic/mongolian.rb
-- lib/cyrillic/scientific.rb
-- lib/cyrillic/sprognaevn.rb
+- lib/cyrillic/ua_passport.rb
 - lib/cyrillic/ukrainian.rb
 - lib/cyrillic/version.rb
 homepage: https://github.com/rovetz/cyrillic
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/rovetz/cyrillic
+  changelog_uri: https://github.com/rovetz/cyrillic/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rovetz/cyrillic/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -79,14 +131,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Romanization (transliteration) of Cyrillic
 test_files: []

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in cyrillic.gemspec
-gemspec

data/Gemfile.lock

@@ -1,22 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cyrillic (0.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.26.1)
-    rake (13.3.1)
-
-PLATFORMS
-  arm64-darwin-24
-  ruby
-
-DEPENDENCIES
-  cyrillic!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.7.2

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "cyrillic"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here