iuliia-rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 876f5a93f34261da9f5f94131bafdc301976e627d9f2016671a512b2ddd4c872
-  data.tar.gz: fbec866a5c2a808ebcaa04c3d0e9ad2449e676c8e071e4fcdb9960aec35f7219
+  metadata.gz: cf7054429bbf45777a898982dbbf5efa5a1690d3656b5486d04adb80a27a6a77
+  data.tar.gz: ce0d3f3f87719303dfcfbdf3599feb89991f8d9eac115be2575d73f8ee1fe2e1
 SHA512:
-  metadata.gz: fc513edc37525c16bbfa7c5873f8c4b6d4680e0f94393feecb58467ea0bbc818b865d03a13526fff6180a03060c1dcdcca25a7198681b7939a1ac7f22f2f0678
-  data.tar.gz: bf8b4ccbd91d0c8204e64f05365e7c7bd40a8f24d44dcf78f81be6669acc97d3fb58deed9ce6eb2a181eb36833e958477cddb16e37c23c828002f4c057f23dae
+  metadata.gz: 3b0934133b04fbe07076949c02d89475e69faee3b009de8a597feb62af38dbb769e991356047ab618b1759737e663d876126ad07e695e320a671f0cd3612a222
+  data.tar.gz: 6832a81554d55ee79415a0780485b3a7cb0f52de638f7086e45e454187cddc6dd33f9ac51a88d7210ef7255d4fce336663fa2ddd981afeea6ad9360eb92dec17

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/.gitmodules

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

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/CHANGELOG.md

@@ -4,5 +4,10 @@ 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).
 
+## [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/README.md

@@ -2,6 +2,8 @@
 
 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:
@@ -65,9 +67,9 @@ Iuliia.translit('Юлия, съешь ещё этих мягких францу
 
 ## TODO
 
-* Add documentation
+* ~~Add documentation~~
 * Maybe some more specs
-* Implement reverse translit (not available for all schemas though)
+* Implement reverse translit (not available for all schemas though): https://github.com/adnikiforov/iuliia-rb/issues/3
 
 ## Development
 
@@ -77,4 +79,4 @@ 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).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/iiulia-rb.gemspec

@@ -17,11 +17,9 @@ Gem::Specification.new do |spec|
   # 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['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-
-    # spec.metadata['homepage_uri'] = spec.homepage
-    # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
-    # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+    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
@@ -38,6 +36,7 @@ Gem::Specification.new do |spec|
   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/iuliia.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 module Iuliia
-  module_function
+  class << self
 
-  def translit(string, schema:)
-    Iuliia::Translit.new(string, schema).translit
+    # 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

@@ -2,52 +2,39 @@
 
 module Iuliia
   module Schema
-    extend self
-
-    SCHEMA = Struct.new(
-      :description,
-      :url,
-      :mapping,
-      :prev_mapping,
-      :next_mapping,
-      :ending_mapping
-    )
-
-    def schema(schema_name)
-      schemas[schema_name]
-    end
+    class << self
 
-    def available_schemas
-      schemas.map do |schema_name, schema|
-        [schema_name, schema.description]
+      # Fetch schema by schema name
+      # @param schema_name [String]
+      # @return [Iuliia::Schema]
+      def [](schema_name)
+        schemas[schema_name]
       end
-    end
 
-    private
+      alias schema []
 
-    def schemas
-      @schemas ||= load_schemas
-    end
+      # Return list of available schemas
+      # @return [Array<Iuliia::Schema]>]
+      def available_schemas
+        load_schemas.transform_values(&:description).to_a
+      end
 
-    def load_schemas
-      Dir['lib/schemas/*.json'].map do |schema_file|
-        file = File.read(schema_file)
-        parse_and_create_schema(file)
-      end.reduce({}, :update)
-    end
+      private
 
-    def parse_and_create_schema(file)
-      parsed_data = JSON.parse(file)
-      schema = SCHEMA.new(
-        parsed_data['description'],
-        parsed_data['url'],
-        parsed_data['mapping'],
-        parsed_data['prev_mapping'],
-        parsed_data['next_mapping'],
-        parsed_data['ending_mapping']
-      )
-
-      { parsed_data['name'] => schema }
+      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

@@ -4,11 +4,17 @@ 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

data/lib/iuliia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Iuliia
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iuliia-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Nikiforov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !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
@@ -66,24 +80,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - a.d.nikiforov@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/spec.yml"
 - ".gitignore"
-- ".idea/iiulia-rb.iml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/workspace.xml"
+- ".gitmodules"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -95,40 +107,14 @@ files:
 - lib/iuliia/schema.rb
 - lib/iuliia/translit.rb
 - lib/iuliia/version.rb
-- lib/schemas/LICENSE
-- lib/schemas/README.md
-- lib/schemas/ala_lc.json
-- lib/schemas/ala_lc_alt.json
-- lib/schemas/bgn_pcgn.json
-- lib/schemas/bgn_pcgn_alt.json
-- lib/schemas/bs_2979.json
-- lib/schemas/bs_2979_alt.json
-- lib/schemas/gost_16876.json
-- lib/schemas/gost_16876_alt.json
-- lib/schemas/gost_52290.json
-- lib/schemas/gost_52535.json
-- lib/schemas/gost_7034.json
-- lib/schemas/gost_779.json
-- lib/schemas/gost_779_alt.json
-- lib/schemas/icao_doc_9303.json
-- lib/schemas/iso_9_1954.json
-- lib/schemas/iso_9_1968.json
-- lib/schemas/iso_9_1968_alt.json
-- lib/schemas/mosmetro.json
-- lib/schemas/mvd_310.json
-- lib/schemas/mvd_310_fr.json
-- lib/schemas/mvd_782.json
-- lib/schemas/scientific.json
-- lib/schemas/telegram.json
-- lib/schemas/ungegn_1987.json
-- lib/schemas/wikipedia.json
-- lib/schemas/yandex_maps.json
-- lib/schemas/yandex_money.json
 homepage: https://github.com/adnikiforov/iuliia-rb
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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
@@ -143,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Russian transliteration using nalgeon/iuliia schemas
 test_files: []

data/.idea/iiulia-rb.iml

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="RUBY_MODULE" version="4">
-  <component name="ModuleRunConfigurationManager">
-    <shared />
-  </component>
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="jdk" jdkName="RVM: ruby-2.6.6" jdkType="RUBY_SDK" />
-    <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.17.3, RVM: ruby-2.6.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.3, RVM: ruby-2.6.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="json (v2.3.0, RVM: ruby-2.6.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, RVM: ruby-2.6.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.9.1, RVM: ruby-2.6.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.9.1, RVM: ruby-2.6.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.9.1, RVM: ruby-2.6.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.9.2, RVM: ruby-2.6.6) [gem]" level="application" />
-  </component>
-</module>

data/.idea/misc.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JavaScriptSettings">
-    <option name="languageLevel" value="ES6" />
-  </component>
-  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-2.4.5 [global]" project-jdk-type="RUBY_SDK" />
-</project>

data/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/iiulia-rb.iml" filepath="$PROJECT_DIR$/.idea/iiulia-rb.iml" />
-    </modules>
-  </component>
-</project>

data/.idea/workspace.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectId" id="1bEGnmEDYzBnl6qIoQ8XtjqEJc9" />
-</project>