iuliia 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b104da0c637eac076457e888d30e52f977f2871b80f54cd82f995237ff343338
-  data.tar.gz: edba6708b1590c7016749bd65c89f0f01d1514653c620064620fba8749061cd4
+  metadata.gz: 687b0bb708b6eb6c64d055562c7e6be0b61a901c466b1bced4d7e0b4201cff1f
+  data.tar.gz: 9d45eb3171cbb1e21f43bc56dd6aa286f3425d884088a5f41ec51debaaa38e1e
 SHA512:
-  metadata.gz: b67688c64d902c5507826a3b9da892675bff114450e7cc9039248819a9d95c3904c7851d6698ec2b0e311d2e46ea6740484c163caaed2a2311e1db7138ec0800
-  data.tar.gz: b32700393e2f5c510402e9ac22e782d2bc7396e805dcad60e8fec65ac5a7fa5fb83b9364da690eccbb776d408f3e427e3002234afe73d555c4320c3d4fd98212
+  metadata.gz: d35bd6868e309f3887fc61d1e8c4944523dd0f5560dfe0763c56171045ff99c8f93c57ce3142c4d769aa0fa6cd52b71c244f02c26579b66a7389c2621d3324cf
+  data.tar.gz: f167b6d8d86029dd462724d75483ba6d281e1e478491fb20dbd1e0e2eccc6690db33cc4658b996a57e0bdda9d33da4939cc368c477221338448580c94e24ddf4

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_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}

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   # 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
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

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/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,10 +10,11 @@ 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
@@ -26,7 +26,10 @@ module Iuliia
       end
 
       def load_schema(name)
-        JSON.parse(File.read("lib/schemas/#{name}.json"), object_class: OpenStruct, symbolize_names: true)
+        filename = "lib/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

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
 

data/lib/iuliia/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iuliia
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrey Nikiforov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,8 +101,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- iiulia-rb.gemspec
+- iiulia.gemspec
 - lib/iuliia.rb
+- lib/iuliia/exceptions.rb
 - lib/iuliia/iuliia.rb
 - lib/iuliia/schema.rb
 - lib/iuliia/translit.rb