cyrillic 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b7f65d75b1416034469c7fbd59f3fd28cd48e9c5808273cec879bef04f0145
-  data.tar.gz: a0cc60903905063f13f7d4ae390ad22cd3cce194911eb05808a0f67d112eaead
+  metadata.gz: 6a5904094fb9d492197e816b4dd0270aa4245e64fe3388b5a8177bef6deb01fd
+  data.tar.gz: 2fd71ce5f7e37778beae85554c5bcfc6277b348278d931219efddbbae6175020
 SHA512:
-  metadata.gz: 4c4fc3f26c1d6d8cf58eddd82ca7e84767277e53fa06db85f757c1fa994abf35216bb19c0776807708380abf0db038ee213d2d88d6f9a146c61d3976f74e486a
-  data.tar.gz: 98581c63c2d61c5775a690ee1c278aeb180445f9f94d328efc3445ff398ff223678fcbd9de1cea9a63d51a824c4bd64b028d04da6b2997a9ac3400ec9f8e6f6b
+  metadata.gz: ea05ab8fbb717eec3902faca17b7c2783fb8e5e2dd5feab4ef003f0d979d1e91dadc001cde2fdc06d86eb8beaaf503621b61df8b23137e47b798c61cf384eba0
+  data.tar.gz: dfd8f00970bb557ed16b6d7db598365f6110ebc8815f9ab088ef164a392bc075d94c285859eb80a021d71645c27c76495454dd1f0f9f2688205f3ebc17731852

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/**/*'
+    - 'pkg/**/*'
+    - 'vendor/**/*'
+    - 'coverage/**/*'
+
+Layout/LineLength:
+  AllowedPatterns:
+    - '^\s*assert_equal'
+    - '^\s*#'
+    - '^\s*"'
+    - 'spec\.description'
+    - 'k = %w\['
+    - 'v = %w\['
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CollectionLiteralLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.0] - 2026-09-17
+
+### Added
+- CLI executable `exe/cyrillic` supporting direct arguments, files, piped STDIN, and scheme flag (`-s`).
+- Integration tests for CLI arguments, flags, files, and STDIN input.
+- GitHub Actions CI workflow for modern Ruby versions (`3.3`, `3.4`, `head`) on `main` branch.
+- Automated GitHub Actions release workflow for building and publishing gem on git tag push.
+- Dependabot configuration for automated Bundler and GitHub Actions dependency updates.
+- Precompiled and cached regular expressions for character tables for improved performance.
+- Case-insensitive scheme resolution (e.g. `:iso9`, `"ISO9"`, `:de`, `"UA_PASSPORT"`).
+- Informative `ArgumentError` when an unknown transliteration scheme is specified.
+- Standard gem metadata URIs (`source_code_uri`, `changelog_uri`, `bug_tracker_uri`, `rubygems_mfa_required`).
+- Comprehensive YARD documentation with examples for `Cyrillic.transliterate` and `Cyrillic.t`.
+- SimpleCov test coverage tracking achieving 100% line coverage.
+- Unit tests for edge cases (nil, empty strings, scheme normalization, error handling).
+
+### Changed
+- Namespaced scheme modules under `Cyrillic` (`Cyrillic::Iso9`, `Cyrillic::Mongolian`, `Cyrillic::Ukrainian`, `Cyrillic::UaPassport`, `Cyrillic::De`) with backwards-compatible top-level aliases.
+- Set minimum required Ruby version to `>= 3.3.0` in gemspec.
+- Update development dependencies (rubocop, rake, rdoc, irb, minitest, simplecov).
+- Untrack `Gemfile.lock` and add to `.gitignore` following gem development best practices.
+- Add `.gitattributes` for consistent LF line endings and diff drivers.
+- Integrate RuboCop code style checks into default `rake` task.
+- Update copyright year to 2018-2026 in `LICENSE.txt`.
+
+### Fixed
+- Eliminate mutable string literal warnings under Ruby 3.4+ in Ukrainian Passport transliteration.
+- Fix character mappings and duplicate key warnings in ISO 9 table (`ӵ` and `ҿ`).
+
+### Removed
+- Legacy `.travis.yml` configuration.
+- Empty 0-byte placeholder files from `lib/cyrillic/`.
+
+## [0.2.0] - 2025-11-09
+
+### Added
+- ISO 9 transliteration support (`:iso9`).
+- Mongolian transliteration support (`:mongolian`).
+- Ukrainian transliteration support (`:ukrainian`).
+- Ukrainian passport transliteration standard support (`:ua_passport`).
+- German transliteration standard support (`:de`).
+
+## [0.1.0] - 2018-04-05
+
+### Added
+- Initial release.
+- Core Cyrillic transliteration to Roman (Latin) script.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 rovetz
+Copyright (c) 2018-2026 rovetz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,26 +1,26 @@
-# Cyrillic -> Latin: Cyrillic.t("Кириллица") => "Kirillitsa"
+# Cyrillic
 
+[![Ruby](https://github.com/rovetz/cyrillic/actions/workflows/ruby.yml/badge.svg)](https://github.com/rovetz/cyrillic/actions/workflows/ruby.yml)
 [![Gem Version](https://badge.fury.io/rb/cyrillic.svg)](https://badge.fury.io/rb/cyrillic)
-[![Build Status](https://travis-ci.org/rovetz/cyrillic.svg?branch=main)](https://travis-ci.org/rovetz/cyrillic)
 [![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
 
-**Cyrillic** is a Ruby gem for the romanization (transliteration) of Cyrillic script into the Latin alphabet. It provides a simple and flexible way to convert Cyrillic text using various international and language-specific standards.
+**Cyrillic** is a Ruby gem for romanization (transliteration) of Cyrillic script into the Roman (Latin) alphabet. It provides a simple and flexible interface with support for international and national standards.
 
-## Features
+## Supported Schemes
 
-This gem supports multiple transliteration standards:
-
-*   `generic` (Default)
-*   `iso9`
-*   `ukrainian`
-*   `mongolian`
+*   `:cyrillic` (Default generic Cyrillic transliteration)
+*   `:iso9` (ISO 9:1995 standard)
+*   `:ukrainian` (Ukrainian national standard)
+*   `:ua_passport` (Ukrainian international passport transliteration standard)
+*   `:mongolian` (Mongolian Cyrillic MNS 5217:2012)
+*   `:de` (German Duden/phonetic transliteration)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cyrillic'
+gem "cyrillic"
 ```
 
 And then execute:
@@ -33,53 +33,73 @@ Or install it yourself as:
 
 ## Usage
 
-The gem provides a simple interface through the `Cyrillic.t` (or `Cyrillic.transliterate`) method.
-
-### Basic Usage
-
-By default, it uses a generic transliteration scheme.
-
 ```ruby
 require "cyrillic"
 
+# Default Cyrillic transliteration
+Cyrillic.transliterate("Кириллица")
+# => "KirilliTSa"
+
+# Short alias .t
 Cyrillic.t("Кириллица")
-#=> "Kirillitsa"
-```
+# => "KirilliTSa"
 
-### Specifying a Standard
+# ISO 9:1995 scheme
+Cyrillic.t("Не важно, как медленно ты продвигаешься", :iso9)
+# => "Ne važno, kak medlenno ty prodvigaešʹsâ"
 
-You can specify a transliteration standard by passing a symbol as the second argument.
+# Ukrainian scheme
+Cyrillic.t("Київ", :ukrainian)
+# => "Kyiv"
 
-#### ISO 9
+# Ukrainian passport scheme
+Cyrillic.t("Борщагівка", :ua_passport)
+# => "Borshchahivka"
 
-```ruby
-Cyrillic.transliterate("Кириллица", :iso9)
-#=> "Kirillica"
+# Mongolian scheme
+Cyrillic.t("Монгол хэл", :mongolian)
+# => "Mongol khel"
+
+# German transliteration scheme
+Cyrillic.t("Чайковский", :de)
+# => "Tschajkowskij"
 ```
 
-#### Ukrainian
+### Command Line Interface (CLI)
 
-```ruby
-Cyrillic.transliterate("Кирилиця", :ukrainian)
-#=> "Kyrylytsia"
-```
+You can also use `cyrillic` directly from your terminal:
 
-#### Mongolian
+```bash
+# Direct argument
+$ cyrillic "Кириллица"
+KirilliTSa
 
-```ruby
-Cyrillic.t("Монгол хэл", :mongolian)
-#=> "Mongol khel"
-```
+# Piped input (STDIN)
+$ echo "Кириллица" | cyrillic
+KirilliTSa
 
-## Development
+# File input
+$ cyrillic text.txt
 
-After checking out the repo, run `bin/setup` to install development dependencies.
+# Specify transliteration scheme
+$ cyrillic -s iso9 "Транслитерация"
+Transliteraciâ
 
-To run the test suite, use the `rake` command:
+$ cyrillic -s ukrainian "Київ"
+Kyiv
+
+$ cyrillic -s ua_passport "Борщагівка"
+Borshchahivka
+
+$ cyrillic -s de "Весна"
+Wesna
+```
+
+## Development
 
-    $ rake
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run tests and code style checks (RuboCop). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-You can also run `bin/console` for an interactive prompt that will allow you to experiment with the gem.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
@@ -91,4 +111,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Cyrillic project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rovetz/cyrillic/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Cyrillic project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rovetz/cyrillic/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[test rubocop]

data/cyrillic.gemspec

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require "cyrillic/version"
 
 Gem::Specification.new do |spec|
@@ -10,17 +12,30 @@ Gem::Specification.new do |spec|
   spec.email         = ["zakbox@gmail.com"]
 
   spec.summary       = "Romanization (transliteration) of Cyrillic"
-  spec.description   = "Romanization (transliteration) of Cyrillic. Converts Cyrillic text to the Roman (Latin) script"
+  spec.description   = "Converts Cyrillic text to the Roman (Latin) script"
   spec.homepage      = "https://github.com/rovetz/cyrillic"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  spec.metadata["source_code_uri"] = "https://github.com/rovetz/cyrillic"
+  spec.metadata["changelog_uri"] = "https://github.com/rovetz/cyrillic/blob/main/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/rovetz/cyrillic/issues"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").select { |f| File.file?(f) }.reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github Gemfile])
+    end
   end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ["cyrillic"]
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "irb"
+  spec.add_development_dependency "minitest", ">= 5.25"
+  spec.add_development_dependency "rake", ">= 13.2"
+  spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "rubocop", ">= 1.64"
+  spec.add_development_dependency "simplecov", ">= 0.22"
 end

data/exe/cyrillic

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "cyrillic"
+
+scheme = nil
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: cyrillic [options] [text | file...]"
+  opts.separator ""
+  opts.separator "Transliterate Cyrillic script to Roman (Latin) script."
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator "  cyrillic 'Кириллица'"
+  opts.separator "  echo 'Кириллица' | cyrillic"
+  opts.separator "  cyrillic text.txt"
+  opts.separator "  cyrillic -s iso9 'Транслитерация'"
+  opts.separator "  cyrillic -s ukrainian 'Київ'"
+  opts.separator "  cyrillic -s ua_passport 'Борщагівка'"
+  opts.separator "  cyrillic -s mongolian 'Монгол'"
+  opts.separator "  cyrillic -s de 'Весна'"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-s", "--scheme SCHEME", %w[default cyrillic iso9 mongolian ukrainian ua_passport de],
+          "Transliteration scheme (default, cyrillic, iso9, mongolian, ukrainian, ua_passport, de)") do |s|
+    scheme = s == "default" ? nil : s.to_sym
+  end
+
+  opts.on("-v", "--version", "Show version") do
+    puts "cyrillic #{Cyrillic::VERSION}"
+    exit
+  end
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+
+transliterate = lambda do |text|
+  Cyrillic.transliterate(text, scheme || :cyrillic)
+end
+
+if ARGV.empty?
+  if $stdin.tty?
+    puts parser
+    exit 1
+  else
+    $stdin.each_line do |line|
+      puts transliterate.call(line.chomp)
+    end
+  end
+else
+  ARGV.each do |arg|
+    if File.file?(arg)
+      File.foreach(arg) do |line|
+        puts transliterate.call(line.chomp)
+      end
+    else
+      puts transliterate.call(arg)
+    end
+  end
+end

data/lib/cyrillic/de.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cyrillic
+  module De
+    k = %w[А Б В Г Д Е Ё Ж З И Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш Щ Ъ Ы Ь Э Ю Я а б в г д е ё ж з и й к л м н о п р с т у ф х ц ч ш щ ъ ы ь э ю я].freeze
+    v = %w[A B W G D E Jo Sch S I J K L M N O P R S T U F Ch Z Tsch Sch Schtsch "" Y "" E Ju Ja a b w g d e jo sch s i j k l m n o p r s t u f ch z tsch sch schtsch "" y "" e ju ja].freeze
+
+    CHARACTER_TABLE = k.zip(v).to_h.freeze
+    REGEXP = Regexp.union(CHARACTER_TABLE.keys).freeze
+  end
+end
+
+De = Cyrillic::De unless defined?(De)