iuliia 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b104da0c637eac076457e888d30e52f977f2871b80f54cd82f995237ff343338
-  data.tar.gz: edba6708b1590c7016749bd65c89f0f01d1514653c620064620fba8749061cd4
+  metadata.gz: 8da4196ca60d50693772a29a557b9489d0de255c8ca36f15feb467412c2698d3
+  data.tar.gz: 220658bc31b12b107c18072dfdddf8b0c24beefd79af1a93b3ee85fa039f33b2
 SHA512:
-  metadata.gz: b67688c64d902c5507826a3b9da892675bff114450e7cc9039248819a9d95c3904c7851d6698ec2b0e311d2e46ea6740484c163caaed2a2311e1db7138ec0800
-  data.tar.gz: b32700393e2f5c510402e9ac22e782d2bc7396e805dcad60e8fec65ac5a7fa5fb83b9364da690eccbb776d408f3e427e3002234afe73d555c4320c3d4fd98212
+  metadata.gz: 477ce87cf0bcfa3e4030d1436a47d46f2b78952406f8856110045c037732780b543c68a29d9f9b017c32605cf49be9c597007c4b3b96e7746ebec6da0bfd961c
+  data.tar.gz: b1d650e5287e9038332f5c797c9cc0b26971ff44b61947ba25a3d47067ad1abc1e9516b4f920e620e52966ae11917f05b1b398b07844f75ee630267967d80ff3

data/.github/workflows/spec.yml

@@ -17,9 +17,7 @@ on:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
       with:
@@ -31,4 +29,4 @@ jobs:
     - name: Install dependencies
       run: bundle install
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rspec

data/.rubocop.yml

@@ -6,3 +6,6 @@ AllCops:
 
 Style/Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Max: 30

data/.rubocop_todo.yml

@@ -11,10 +11,10 @@
 # Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
-    - 'iiulia-rb.gemspec'
+    - 'iiulia.gemspec'
 
 # Offense count: 1
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'iiulia-rb.gemspec'
+    - 'iiulia.gemspec'

data/CHANGELOG.md

@@ -4,9 +4,19 @@ 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).
 
+## [1.0.1] - 2020-09-25
+#### Deprecations
+Method `translit` now deprecated, use `translate` instead. Will be removed completely in the future releases.
+#### Improvements
+Now call for translate with wrong (non-existent) schema will throw more human-friendly exception.
+
 ## [1.0.0] - 2020-09-14
 This is the new initial version for gem `iuliia` after renaming it from `iuliia-rb`
 
+## [0.2.1] - 2020-09-14
+Changes:
+* Gem has been renamed to `iuliia`. This is the last version of `iuliia-rb`. Please, use `iuliia` instead.
+
 ## [0.2.0] - 2020-09-14
 Changes:
 * Moved `lib/schemas` to the git submodule `github.com/nalgeon/iuliia`

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in iiulia-rb.gemspec
+# Specify your gem's dependencies in iiulia.gemspec
 gemspec

data/README.md

@@ -6,6 +6,8 @@ Small gem to properly transliterate cyrillic to latin. Use https://github.com/na
 
 ## Installation
 
+#### Gem has been renamed to `iuliia`. This is the last version of `iuliia-rb`. Please, use `iuliia` instead.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -60,7 +62,7 @@ Iuliia::Schema.available_schemas
 Pick one and transliterate
 
 ```ruby
-Iuliia.translit('Юлия, съешь ещё этих мягких французских булок из Йошкар-Олы, да выпей алтайского чаю', schema: 'mvd_782')
+Iuliia.translate('Юлия, съешь ещё этих мягких французских булок из Йошкар-Олы, да выпей алтайского чаю', schema: 'mvd_782')
 
 "Yuliya, syesh' eshche etikh myagkikh frantsuzskikh bulok iz Yoshkar-Oly, da vypey altayskogo chayu"
 ```
@@ -73,10 +75,47 @@ Iuliia.translit('Юлия, съешь ещё этих мягких францу
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Check out repo:
+
+```
+git clone git@github.com:adnikiforov/iuliia-rb.git
+```
+
+Check out submodule with schemas:
+
+```
+git submodule update --init
+```
+
+Setup dependencies:
+
+```
+bin/setup
+```
+
+Run specs:
+
+```
+bundle exec rspec
+```
+
+Or open console to try it:
+
+```
+bin/console
+```
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+## Support
+
+<p>
+  <a href="https://evrone.com/?utm_source=github&utm_campaign=iuliia-rb">
+    <img src="https://raw.githubusercontent.com/adnikiforov/iuliia-rb/master/priv/evrone-sponsored-logo.png"
+      alt="Sponsored by Evrone" width="210">
+  </a>
+</p>
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/{iiulia-rb.gemspec → iiulia.gemspec}

@@ -24,11 +24,20 @@ Gem::Specification.new do |spec|
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|priv)/}) }
   end
+
+  gem_dir = "#{__dir__}/"
+  `git submodule --quiet foreach pwd`.split($OUTPUT_RECORD_SEPARATOR).each do |submodule_path|
+    Dir.chdir(submodule_path) do
+      submodule_relative_path = submodule_path.sub gem_dir, ''
+      `git ls-files`.split($OUTPUT_RECORD_SEPARATOR).each do |filename|
+        spec.files << "#{submodule_relative_path}/#{filename}"
+      end
+    end
+  end
+
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -37,6 +46,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
 
   spec.add_dependency 'json'
 end

data/lib/iuliia/exceptions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Iuliia
+  module Exceptions
+    class NonExistentSchemaException < StandardError
+      def initialize(msg = 'Specified schema does not exist')
+        super
+      end
+    end
+  end
+end

data/lib/iuliia/iuliia.rb

@@ -2,13 +2,17 @@
 
 module Iuliia
   class << self
-
-    # Translit cyrillic string to latin representation
+    # Translate cyrillic string to latin representation
     # @param string [String]
     # @param schema [Iuliia::Schema]
     # @return [String]
-    def translit(string, schema:)
+    def translate(string, schema:)
       Iuliia::Translit.new(string, schema).translit
     end
+
+    def translit(string, schema:)
+      warn 'translit is deprecated, use .translate instead'
+      translate(string, schema: schema)
+    end
   end
 end

data/lib/iuliia/schema.rb

@@ -3,7 +3,6 @@
 module Iuliia
   module Schema
     class << self
-
       # Fetch schema by schema name
       # @param schema_name [String]
       # @return [Iuliia::Schema]
@@ -11,26 +10,34 @@ module Iuliia
         schemas[schema_name]
       end
 
+      # @deprecated
       alias schema []
 
       # Return list of available schemas
-      # @return [Array<Iuliia::Schema]>]
+      # @return [Array]
       def available_schemas
         load_schemas.transform_values(&:description).to_a
       end
 
       private
 
+      def lib_dir
+        File.expand_path('..', __dir__)
+      end
+
       def schemas
         @schemas ||= Hash.new { |h, k| h[k] = load_schema(k) }
       end
 
       def load_schema(name)
-        JSON.parse(File.read("lib/schemas/#{name}.json"), object_class: OpenStruct, symbolize_names: true)
+        filename = "#{lib_dir}/schemas/#{name}.json"
+        raise Exceptions::NonExistentSchemaException unless File.exist?(filename)
+
+        JSON.parse(File.read(filename), object_class: OpenStruct, symbolize_names: true)
       end
 
       def load_schemas
-        Dir['lib/schemas/*.json'].map do |file|
+        Dir["#{lib_dir}/schemas/*.json"].map do |file|
           schema = load_schema(File.basename(file, '.json'))
           [schema.name, schema]
         end.to_h

data/lib/iuliia/translit.rb

@@ -3,6 +3,7 @@
 module Iuliia
   class Translit
     ENDING_LENGTH = 2
+    private_constant :ENDING_LENGTH
 
     # Initialize transliterator engine with string and schema
     # @param string [String]
@@ -10,12 +11,14 @@ module Iuliia
     # @return [Iuliia::Translit]
     def initialize(string, schema)
       @string = string
-      @schema = Iuliia::Schema.schema(schema)
+      @schema = Iuliia::Schema[schema]
     end
 
     # Translit cyrillic string to latin representation
     # @return [String]
     def translit
+      return unless schema
+
       string.split(/\b/).map { |chunk| translit_chunk(chunk) }.join
     end
 
@@ -43,23 +46,29 @@ module Iuliia
         translit_char(stem.chars, char, index)
       end
 
-      camelcase(translited_stem.join)
+      string = translited_stem.join
+      return camelcase(translited_stem.join) unless upcase?(translited_stem.join)
+
+      string
     end
 
     def translit_char(chars, char, index)
+      return char unless /[А-Яа-яёЁ]/.match?(char)
+
       translited_char = translit_prev(chars, index)
       translited_char = translit_next(chars, index) if translited_char.nil?
       translited_char = schema.mapping[char.downcase] if translited_char.nil?
 
-      upcase?(char) ? translited_char.upcase : translited_char
+      upcase?(char) ? camelcase(translited_char.upcase) : translited_char
     end
 
     def translit_prev(chars, index)
-      prev_char = if index.positive?
-                    chars[index - 1..index].join.downcase
-                  else
-                    chars[index].downcase
-                  end
+      prev_char =
+        if index.positive?
+          chars[index - 1..index].join.downcase
+        else
+          chars[index].downcase
+        end
 
       schema.prev_mapping&.dig(prev_char)
     end

data/lib/iuliia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Iuliia
-  VERSION = '1.0.0'
+  VERSION = '1.0.4'
 end

data/lib/iuliia.rb

@@ -6,3 +6,4 @@ require 'iuliia/version'
 require 'iuliia/translit'
 require 'iuliia/schema'
 require 'iuliia/iuliia'
+require 'iuliia/exceptions'

data/lib/schemas/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Anton Zhiyanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/schemas/README.md

@@ -0,0 +1,71 @@
+# `Iuliia`
+
+> Transliterate Cyrillic → Latin in every possible way
+
+Transliteration means representing Cyrillic data (mainly names and geographic locations) with Latin letters. It is used for international passports, visas, green cards, driving licenses, mail and goods delivery etc.
+
+`Iuliia` makes transliteration easy as calling `iuliia.translate()` in your favorite programming language.
+
+Why use `Iuliia`:
+
+-   20 transliteration schemas (rule sets), including all main international and Russian standards.
+-   Correctly implements not only the base mapping, but all the special rules for letter combinations and word endings (AFAIK, Iuliia is the only library which does so).
+-   Simple API and zero third-party dependencies.
+
+## Supported schemas
+
+Actual schemas:
+
+-   ALA-LC: [ala_lc.json](ala_lc.json) and [ala_lc_alt.json](ala_lc_alt.json)
+-   BGN/PCGN: [bgn_pcgn.json](bgn_pcgn.json) and [bgn_pcgn_alt.json](bgn_pcgn_alt.json)
+-   BS 2979:1958: [bs_2979.json](bs_2979.json) and [bs_2979_alt.json](bs_2979_alt.json)
+-   GOST R 52290-2004: [gost_52290.json](gost_52290.json)
+-   GOST R 7.0.34-2014: [gost_7034.json](gost_7034.json)
+-   ICAO DOC 9303: [icao_doc_9303.json](icao_doc_9303.json)
+-   ISO 9:1995 aka GOST 7.79-2000: [gost_779.json](gost_779.json) and [gost_779_alt.json](gost_779_alt.json)
+-   UNGEGN 1987 V/18: [ungegn_1987.json](ungegn_1987.json)
+-   Moscow Metro map: [mosmetro.json](mosmetro.json)
+-   Scientific: [scientific.json](scientific.json)
+-   Telegram: [telegram.json](telegram.json)
+-   Wikipedia: [wikipedia.json](wikipedia.json)
+-   Yandex.Maps: [yandex_maps.json](yandex_maps.json)
+-   Yandex.Money: [yandex_money.json](yandex_money.json)
+
+And deprecated ones:
+
+-   GOST 16876-71: [gost_16876.json](gost_16876.json) and [gost_16876_alt.json](gost_16876_alt.json)
+-   GOST R 52535.1-2006: [gost_52535.json](gost_52535.json)
+-   ISO/R 9:1954: [iso_9_1954.json](iso_9_1954.json)
+-   ISO/R 9:1968: [iso_9_1968.json](iso_9_1968.json) and [iso_9_1968_alt.json](iso_9_1968_alt.json)
+-   MVD 310-1997: [mvd_310.json](mvd_310.json) and [mvd_310_fr.json](mvd_310_fr.json)
+-   MVD 782-2000: [mvd_782.json](mvd_782.json)
+
+For schema details and other information, see <https://dangry.ru/iuliia> (in Russian).
+
+## Supported languages
+
+-   [C#](https://github.com/belianin/iuliia-cs)
+-   [Go](https://github.com/mehanizm/iuliia-go)
+-   [Java](https://github.com/massita99/iuliia-java) (Gson)
+-   [Java](https://github.com/homyakin/iuliia-java) (Jackson)
+-   [JavaScript](https://github.com/nalgeon/iuliia-js)
+-   [PHP](https://github.com/perevoshchikov/iuliia-php)
+-   **[Python](https://github.com/nalgeon/iuliia-py) ✨**
+-   [Ruby](https://github.com/adnikiforov/iuliia-rb)
+-   [Rust](https://github.com/massita99/iuliia-rust)
+-   [Swift](https://github.com/petertretyakov/Iuliia)
+
+This repo contains schema descriptions. It is not intended to be used directly. If you want to add another schema — send a PR! See [schema.jsd](schema.jsd) for JSON Schema definition and [wikipedia.json](wikipedia.json) as a reference.
+
+## Issues and limitations
+
+In general:
+
+-   Only Russian subset of Cyrillic is supported.
+-   Does not support composite Unicode characters (e.g., `Ё`, but not `Ё`).
+
+Schema-specific:
+
+-   _BS 2979:1958_. This schema defines two alternative translations for `Ы`: `Ы` → `Ȳ` (used by the Oxford University Press) and `Ы` → `UI` (used by the British Library). `iuliia` uses `Ы` → `Ȳ`.
+-   _GOST R 7.0.34-2014_. This schema defines alternatives for many letters, but does not specify when to use which. Therefore, `iuliia` uses the first of suggested translations for each such letter.
+-   _MVD-310_. This schema defines "`С` between two vowels → `SS`" rule. There is no such rule in other schemas, and MVD-310 itself is deprecated, so I decided to ignore this specific rule for the sake of code simplicity.

data/lib/schemas/ala_lc.json

@@ -0,0 +1,49 @@
+{
+    "name": "ala_lc",
+    "description": "ALA-LC transliteration schema.",
+    "url": "https://dangry.ru/iuliia/ala-lc/",
+    "mapping": {
+        "а": "a",
+        "б": "b",
+        "в": "v",
+        "г": "g",
+        "д": "d",
+        "е": "e",
+        "ё": "ё",
+        "ж": "zh",
+        "з": "z",
+        "и": "i",
+        "й": "ĭ",
+        "к": "k",
+        "л": "l",
+        "м": "m",
+        "н": "n",
+        "о": "o",
+        "п": "p",
+        "р": "r",
+        "с": "s",
+        "т": "t",
+        "у": "u",
+        "ф": "f",
+        "х": "kh",
+        "ц": "t͡s",
+        "ч": "ch",
+        "ш": "sh",
+        "щ": "shch",
+        "ъ": "ʺ",
+        "ы": "y",
+        "ь": "ʹ",
+        "э": "ė",
+        "ю": "i͡u",
+        "я": "i͡a"
+    },
+    "prev_mapping": null,
+    "next_mapping": null,
+    "ending_mapping": null,
+    "samples": [
+        [
+            "Юлия, съешь ещё этих мягких французских булок из Йошкар-Олы, да выпей алтайского чаю",
+            "I͡ulii͡a, sʺeshʹ eshchё ėtikh mi͡agkikh frant͡suzskikh bulok iz Ĭoshkar-Oly, da vypeĭ altaĭskogo chai͡u"
+        ]
+    ]
+}

data/lib/schemas/ala_lc_alt.json

@@ -0,0 +1,49 @@
+{
+    "name": "ala_lc_alt",
+    "description": "ALA-LC transliteration schema.",
+    "url": "https://dangry.ru/iuliia/ala-lc/",
+    "mapping": {
+        "а": "a",
+        "б": "b",
+        "в": "v",
+        "г": "g",
+        "д": "d",
+        "е": "e",
+        "ё": "e",
+        "ж": "zh",
+        "з": "z",
+        "и": "i",
+        "й": "i",
+        "к": "k",
+        "л": "l",
+        "м": "m",
+        "н": "n",
+        "о": "o",
+        "п": "p",
+        "р": "r",
+        "с": "s",
+        "т": "t",
+        "у": "u",
+        "ф": "f",
+        "х": "kh",
+        "ц": "ts",
+        "ч": "ch",
+        "ш": "sh",
+        "щ": "shch",
+        "ъ": "\"",
+        "ы": "y",
+        "ь": "'",
+        "э": "e",
+        "ю": "iu",
+        "я": "ia"
+    },
+    "prev_mapping": null,
+    "next_mapping": null,
+    "ending_mapping": null,
+    "samples": [
+        [
+            "Юлия, съешь ещё этих мягких французских булок из Йошкар-Олы, да выпей алтайского чаю",
+            "Iuliia, s\"esh' eshche etikh miagkikh frantsuzskikh bulok iz Ioshkar-Oly, da vypei altaiskogo chaiu"
+        ]
+    ]
+}