iuliia 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b104da0c637eac076457e888d30e52f977f2871b80f54cd82f995237ff343338
+  data.tar.gz: edba6708b1590c7016749bd65c89f0f01d1514653c620064620fba8749061cd4
+SHA512:
+  metadata.gz: b67688c64d902c5507826a3b9da892675bff114450e7cc9039248819a9d95c3904c7851d6698ec2b0e311d2e46ea6740484c163caaed2a2311e1db7138ec0800
+  data.tar.gz: b32700393e2f5c510402e9ac22e782d2bc7396e805dcad60e8fec65ac5a7fa5fb83b9364da690eccbb776d408f3e427e3002234afe73d555c4320c3d4fd98212

data/.github/workflows/spec.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: 
+      - master
+      - release-*
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: 'true'
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/schemas"]
+	path = lib/schemas
+	url = https://github.com/nalgeon/iuliia

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 1000`
+# on 2020-09-14 09:10:34 UTC using RuboCop version 0.90.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'iiulia-rb.gemspec'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'iiulia-rb.gemspec'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 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).
+
+## [1.0.0] - 2020-09-14
+This is the new initial version for gem `iuliia` after renaming it from `iuliia-rb`
+
+## [0.2.0] - 2020-09-14
+Changes:
+* Moved `lib/schemas` to the git submodule `github.com/nalgeon/iuliia`
+* Lazy loading for schemas
+
+## [0.1.0] - 2020-04-30
+### Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrey Nikiforov
+
+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/README.md

@@ -0,0 +1,82 @@
+# Iuliia
+
+Small gem to properly transliterate cyrillic to latin. Use https://github.com/nalgeon/iuliia for transliteration schemas.
+
+![Ruby](https://github.com/adnikiforov/iuliia-rb/workflows/Ruby/badge.svg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iuliia'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iuliia
+
+## Usage
+
+Get available schemas (dynamically generated from JSON definitions in `lib/schemas`)
+```ruby
+Iuliia::Schema.available_schemas
+
+[
+    ['mvd_310', 'MVD 310-1997 transliteration schema'], 
+    ['bs_2979', 'British Standard 2979:1958 transliteration schema'], 
+    ['gost_779_alt', 'GOST 7.79-2000 (aka ISO 9:1995) transliteration schema'], 
+    ['icao_doc_9303', 'ICAO DOC 9303 transliteration schema'], 
+    ['mvd_310_fr', 'MVD 310-1997 transliteration schema'], 
+    ['mvd_782', 'MVD 782-2000 transliteration schema'], 
+    ['iso_9_1968_alt', 'ISO/R 9:1968 transliteration schema'], 
+    ['mosmetro', 'Moscow Metro map transliteration schema'], 
+    ['gost_7034', 'GOST R 7.0.34-2014 transliteration schema'], 
+    ['gost_16876_alt', 'GOST 16876-71 (aka GOST 1983) transliteration schema'], 
+    ['gost_52290', 'GOST R 52290-2004 transliteration schema'], 
+    ['ungegn_1987', 'UNGEGN 1987 V/18 transliteration schema'], 
+    ['telegram', 'Telegram transliteration schema'], 
+    ['gost_16876', 'GOST 16876-71 (aka GOST 1983) transliteration schema'], 
+    ['gost_779', 'GOST 7.79-2000 (aka ISO 9:1995) transliteration schema'], 
+    ['wikipedia', 'Wikipedia transliteration schema'], 
+    ['bgn_pcgn', 'BGN/PCGN transliteration schema'], 
+    ['iso_9_1968', 'ISO/R 9:1968 transliteration schema'], 
+    ['yandex_money', 'Yandex.Money transliteration schema'], 
+    ['ala_lc', 'ALA-LC transliteration schema.'], 
+    ['yandex_maps', 'Yandex.Maps transliteration schema'], 
+    ['gost_52535', 'GOST R 52535.1-2006 transliteration schema'], 
+    ['bgn_pcgn_alt', 'BGN/PCGN transliteration schema'], 
+    ['iso_9_1954', 'ISO/R 9:1954 transliteration schema'], 
+    ['bs_2979_alt', 'British Standard 2979:1958 transliteration schema'], 
+    ['scientific', 'Scientific transliteration schema'], 
+    ['ala_lc_alt', 'ALA-LC transliteration schema.']
+]
+```
+
+Pick one and transliterate
+
+```ruby
+Iuliia.translit('Юлия, съешь ещё этих мягких французских булок из Йошкар-Олы, да выпей алтайского чаю', schema: 'mvd_782')
+
+"Yuliya, syesh' eshche etikh myagkikh frantsuzskikh bulok iz Yoshkar-Oly, da vypey altayskogo chayu"
+```
+
+## TODO
+
+* ~~Add documentation~~
+* Maybe some more specs
+* Implement reverse translit (not available for all schemas though): https://github.com/adnikiforov/iuliia-rb/issues/3
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'iuliia'
+
+# 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

@@ -0,0 +1,8 @@
+#!/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

data/iiulia-rb.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iuliia/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'iuliia'
+  spec.version = Iuliia::VERSION
+  spec.authors = ['Andrey Nikiforov']
+  spec.email = ['a.d.nikiforov@gmail.com']
+
+  spec.summary = 'Russian transliteration using nalgeon/iuliia schemas'
+  spec.homepage = 'https://github.com/adnikiforov/iuliia-rb'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/adnikiforov/iuliia-rb'
+    spec.metadata['changelog_uri'] = 'https://github.com/adnikiforov/iuliia-rb/blob/master/CHANGELOG.md'
+  else
+    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)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_dependency 'json'
+end

data/lib/iuliia.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require 'iuliia/version'
+require 'iuliia/translit'
+require 'iuliia/schema'
+require 'iuliia/iuliia'

data/lib/iuliia/iuliia.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Iuliia
+  class << self
+
+    # Translit cyrillic string to latin representation
+    # @param string [String]
+    # @param schema [Iuliia::Schema]
+    # @return [String]
+    def translit(string, schema:)
+      Iuliia::Translit.new(string, schema).translit
+    end
+  end
+end

data/lib/iuliia/schema.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Iuliia
+  module Schema
+    class << self
+
+      # Fetch schema by schema name
+      # @param schema_name [String]
+      # @return [Iuliia::Schema]
+      def [](schema_name)
+        schemas[schema_name]
+      end
+
+      alias schema []
+
+      # Return list of available schemas
+      # @return [Array<Iuliia::Schema]>]
+      def available_schemas
+        load_schemas.transform_values(&:description).to_a
+      end
+
+      private
+
+      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)
+      end
+
+      def load_schemas
+        Dir['lib/schemas/*.json'].map do |file|
+          schema = load_schema(File.basename(file, '.json'))
+          [schema.name, schema]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/iuliia/translit.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Iuliia
+  class Translit
+    ENDING_LENGTH = 2
+
+    # Initialize transliterator engine with string and schema
+    # @param string [String]
+    # @param schema [Iuliia::Schema]
+    # @return [Iuliia::Translit]
+    def initialize(string, schema)
+      @string = string
+      @schema = Iuliia::Schema.schema(schema)
+    end
+
+    # Translit cyrillic string to latin representation
+    # @return [String]
+    def translit
+      string.split(/\b/).map { |chunk| translit_chunk(chunk) }.join
+    end
+
+    private
+
+    attr_reader :string, :schema
+
+    def translit_chunk(chunk)
+      return chunk unless /\p{l}+/.match?(chunk)
+
+      stem, ending = split_word(chunk)
+
+      return translit_stem(chunk) if ending.empty?
+
+      translited_ending = schema.ending_mapping&.dig(ending)
+      return translit_stem(chunk) if translited_ending.nil?
+
+      translited_stem = translit_stem(stem)
+
+      [translited_stem, translited_ending].join
+    end
+
+    def translit_stem(stem)
+      translited_stem = stem.chars.each_with_index.map do |char, index|
+        translit_char(stem.chars, char, index)
+      end
+
+      camelcase(translited_stem.join)
+    end
+
+    def translit_char(chars, char, index)
+      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
+    end
+
+    def translit_prev(chars, index)
+      prev_char = if index.positive?
+                    chars[index - 1..index].join.downcase
+                  else
+                    chars[index].downcase
+                  end
+
+      schema.prev_mapping&.dig(prev_char)
+    end
+
+    def translit_next(chars, index)
+      next_char = chars[index..index + 1].join.downcase
+      schema.next_mapping&.dig(next_char)
+    end
+
+    def split_word(word)
+      if word.length <= ENDING_LENGTH
+        [word, '']
+      else
+        ending = word.length > ENDING_LENGTH ? word[-ENDING_LENGTH..-1] : ''
+        stem = word[0..(word.length - ENDING_LENGTH - 1)] || word
+
+        [stem, ending]
+      end
+    end
+
+    def upcase?(char)
+      /[[:upper:]]/.match(char)
+    end
+
+    def camelcase(string)
+      return string unless upcase?(string[0])
+
+      string = string.downcase
+      string[0] = string[0].capitalize
+      string
+    end
+  end
+end

data/lib/iuliia/version.rb

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

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: iuliia
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrey Nikiforov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- a.d.nikiforov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/spec.yml"
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iiulia-rb.gemspec
+- lib/iuliia.rb
+- lib/iuliia/iuliia.rb
+- lib/iuliia/schema.rb
+- lib/iuliia/translit.rb
+- lib/iuliia/version.rb
+homepage: https://github.com/adnikiforov/iuliia-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/adnikiforov/iuliia-rb
+  source_code_uri: https://github.com/adnikiforov/iuliia-rb
+  changelog_uri: https://github.com/adnikiforov/iuliia-rb/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Russian transliteration using nalgeon/iuliia schemas
+test_files: []