i18n-magic 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de350a396ad7f6f8eff10f7edd1b57d57989afe5
-  data.tar.gz: e3d886339500d887b33f8c9fe8895c4195c8e438
+  metadata.gz: 1ceb29c304d96f0d2c975648c3476a9be2305fce
+  data.tar.gz: e117982cdee614cf719a94f88f898fc97a0a55da
 SHA512:
-  metadata.gz: cb3aa4e5ab2058617e4a8d17acecae15ad4b3fb01d5032a161ce72e5cf04a6a40835ee55ced670528fd85c4b6b48ea790e952ec4e108da1f93c78485f63d0fd3
-  data.tar.gz: 52d85e60d58ea38dac54c1ac7d74646f47479170fca048ae0bbb03baff87ff3a22cfe3de41044aa0c6d5473fe68cca0a15a63f567480f4f983c1f587a3c72019
+  metadata.gz: 63e0859c2b34f58878a09a8e3a6726289d9b1d22d1f13539d418907cd47cb246c56ff7a68d3b18c4d7cbf6d36970708b39ddd3b3141e860cdfaacf6e3d5719fd
+  data.tar.gz: e5ab85abb44a4bc3351f16a22f7ac7c60e1b0719c8c6a5d161b6aa62a6c22b228c90a939450e36ba2c902c005d81bbfb68b18421733e1ebc461c68442991736a

data/Gemfile.lock

@@ -1,21 +1,22 @@
 PATH
   remote: .
   specs:
-    i18n-magic (1.0.0)
+    i18n-magic (1.1.0)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.5)
+    activesupport (5.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.0)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    docile (1.3.0)
     ffi (1.9.23)
     formatador (0.2.5)
     guard (2.14.2)
@@ -35,13 +36,14 @@ GEM
     guard-rubocop (1.3.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
-    i18n (0.9.5)
+    i18n (1.0.0)
       concurrent-ruby (~> 1.0)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
+    lumberjack (1.0.13)
     method_source (0.9.0)
     minitest (5.11.3)
     nenv (0.3.0)
@@ -49,7 +51,7 @@ GEM
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.12.1)
-    parser (2.5.0.4)
+    parser (2.5.0.5)
       ast (~> 2.4.0)
     powerpack (0.1.1)
     pry (0.11.3)
@@ -72,8 +74,8 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    rubocop (0.53.0)
+    rspec-support (3.7.1)
+    rubocop (0.54.0)
       parallel (~> 1.10)
       parser (>= 2.5)
       powerpack (~> 0.1)
@@ -83,6 +85,11 @@ GEM
     ruby-progressbar (1.9.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
@@ -100,6 +107,7 @@ DEPENDENCIES
   i18n-magic!
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov
 
 BUNDLED WITH
    1.16.1

data/Guardfile

@@ -69,7 +69,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   end
 end
 
-guard :rubocop do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
-end
+# guard :rubocop do
+#   watch(%r{.+\.rb$})
+#   watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+# end

data/README.md

@@ -1,6 +1,7 @@
 # I18n::Magic
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/479e81db41acc3f00d92/maintainability)](https://codeclimate.com/github/a-smadi/i18n-magic/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/479e81db41acc3f00d92/test_coverage)](https://codeclimate.com/github/a-smadi/i18n-magic/test_coverage)
 [![Build Status](https://travis-ci.org/a-smadi/i18n-magic.svg?branch=master)](https://travis-ci.org/a-smadi/i18n-magic)
 
 Easy localization management for Ruby projects that are using the i18n gem.
@@ -31,7 +32,39 @@ You can run tests using `rake` or `rake spec`
 
 ## Usage
 
-This section will be updated as features roll out.
+Currently theres only a single command available; `add` which automatically adds the translation record alphabetically ordered into the file it reckons suitable.
+
+The `add` command may be used in 2 different ways:
+
+1- Adding translations as input after running the command. (useful when adding translations with special characters)
+
+```
+i18n-magic add hello_world
+```
+and the user will be prompted to enter translations for that key after running the command.
+
+PS: The key can be in snake_case or CamelCase.
+
+```
+i18n-magic add hello_world
+```
+and
+```
+i18n-magic add HelloWorld
+```
+are both acceptable.
+
+
+2- Adding multiple translation values using a single command. (experimental feature / may be faulty for projects handling locales with somewhat similar alphabets)
+
+```
+i18n-magic add hello_world "Hello, World!" "مرحبا"
+```
+PS: precednece of values doesn't have any effect. As long as the key comes first, i18n-magic will automatically recognise the translation values locales, so
+```
+i18n-magic add hello_world "مرحبا" "Hello, World!"
+```
+is also acceptable.
 
 ## License
 

data/i18n-magic.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "simplecov"
 
   spec.add_dependency "activesupport"
 end

data/lib/i18n/magic.rb

@@ -63,7 +63,7 @@ module I18n
       end
 
       def add
-        I18n::Magic::Commands::Add.new(key: @args[1], values: @args[2..-1]).execute
+        I18n::Magic::Commands::Add.new(key: @args[1], values: @args[2..-1], locale_files_path: I18n::Magic::Helpers::Environment::LOCALE_FILES_PATH).execute
       end
 
       def server

data/lib/i18n/magic/commands/add.rb

@@ -20,12 +20,12 @@ module I18n
         private
 
         def add_values_from_input
-          I18n::Magic::Helpers::Environment.locales.each do |locale|
-            print "#{locale} for #{@options[:key]} (empty to add skip) : "
+          I18n::Magic::Helpers::Environment.locales(@options[:locale_files_path]).each do |locale|
+            print "#{locale} value for #{@options[:key]} (empty to skip) : "
             value = STDIN.gets
             record = I18n::Magic::Entity::TranslationRecord.new(@options[:key], value)
             next unless record.valid?
-            translation_file = I18n::Magic::Entity::TranslationFile.new(locale)
+            translation_file = I18n::Magic::Entity::TranslationFile.new(locale, @options[:locale_files_path])
             abort('translation file does not exist !') unless translation_file.exists?
             translation_file.add(record)
           end
@@ -36,8 +36,8 @@ module I18n
             next unless value.present?
             record = I18n::Magic::Entity::TranslationRecord.new(@options[:key], value)
             abort('invalid key,value pair !') unless record.valid?
-            locale = I18n::Magic::Helpers::StringOps.locale(value)
-            translation_file = I18n::Magic::Entity::TranslationFile.new(locale)
+            locale = I18n::Magic::Helpers::StringOps.locale(value, @options[:locale_files_path])
+            translation_file = I18n::Magic::Entity::TranslationFile.new(locale, @options[:locale_files_path])
             abort('translation file does not exist !') unless translation_file.exists?
             translation_file.add(record)
           end

data/lib/i18n/magic/entity/alphabet.rb

@@ -6,8 +6,19 @@ module I18n
       class Alphabet
         attr_reader :letters
 
-        def initialize
-          @letters = %w[]
+        EN_LETTERS = %w[a b c d e f g h i j k l m n o p q r s t u v w x y z].freeze
+        AR_LETTERS = %w[ا ب ج د ه و ز ح ط ي ك ل لا م ن س ع ف ص ق ر ش ت ث خ ذ ض ظ غ].freeze
+        RU_LETTERS = %w[а б в г д е ё ж з и й к л м н о п р с т у ф х ц ч ш щ ъ ыь э ю я і ѳ ѣ ѵ ѕ ѯ ѱ ѡ ѫ ѧ ѭ ѩ Ѩ Ѭ Ѧ Ѫ Ѡ Ѱ Ѯ Ѕ Ѵ Ѣ Ѳ І Я Ю Э Ь Ы Ъ Щ Ш Ч Ц Х Ф У П Л Й И З Ж Ё Д Г Б].freeze
+        DE_LETTERS = %w[a b c d e f g h i j k l m n o p q r s t u v w x y z ä ö ü Ä Ö Ü ß].freeze
+        FR_LETTERS = %w[a b c d e f g h i j k l m n o p q r s t u v w x y z é è ç ë ò ô ö ù à â].freeze
+        ES_LETTERS = %w[a b c d e é f g h i í j k l m n ñ o ó p q r s t u ú v w x y z].freeze
+        HE_LETTERS = %w[א בּ ב ג ד ה ו ז ח ט י כּ כ ךּ ך ל מ ם נ ן ס ע פּ פ ף צ ץ ק ר שׁ שׂ תּ ת].freeze
+        ZH_LETTERS = %w[ㄅ ㄆ ㄇ ㄈ ㄉ ㄊ ㄋ ㄌ ㄍ ㄎ ㄏ ㄐ ㄑ ㄒ ㄓ ㄔ ㄕ ㄖ ㄗ ㄘ ㄙ ㄚ ㄛ ㄜ ㄝ ㄞ ㄟ ㄠ ㄡ ㄢ ㄣ ㄤ ㄥ ㄦ ㄧ ㄨ ㄩ ㄭ].freeze
+        JA_LETTERS = %w[あ い う え お か き く け こ が ぎ ぐ げ ご さ し す せ そ ざ じ ず ぜ ぞ た ち つ て と だ ぢ づ で ど な に ぬ ね の は ひ ふ へ ほ ば び ぶ べ ぼ ぱ ぴ ぷ ぺ ぽ ま み む め も や ゆ よ ら り る れ ろ わ を ん].freeze
+        TR_LETTERS = %w[a b c ç d e f g ğ h ı i j k l m n o ö p r s ş t u ü v y z Ü Ş Ö Ğ Ç].freeze
+
+        def initialize(locale = nil)
+          @letters = eval("#{locale.upcase}_LETTERS") rescue %w[]
         end
 
         def learn(sample_text)

data/lib/i18n/magic/entity/translation_file.rb

@@ -6,9 +6,9 @@ module I18n
   module Magic
     module Entity
       class TranslationFile
-        def initialize(locale)
+        def initialize(locale, locale_files_path = I18n::Magic::Helpers::Environment::LOCALE_FILES_PATH)
           @locale   = locale
-          @filename = "config/locales/#{locale.downcase}.yml"
+          @filename = "#{locale_files_path}#{locale.downcase}.yml"
         end
 
         def exists?
@@ -40,6 +40,14 @@ module I18n
         end
 
         def compatibility_score(text)
+          locale_alphabet = I18n::Magic::Entity::Alphabet.new(@locale)
+          locale_alphabet = learned_alphabet unless locale_alphabet.letters.any?
+          locale_alphabet.belonging_score(text)
+        end
+
+        private
+
+        def learned_alphabet
           locale_alphabet = I18n::Magic::Entity::Alphabet.new
           open(@filename, 'r+') do |file|
             %w[A B C D E F G H I J K L M N O P Q R S T U V W X Y Z].each do |letter|
@@ -53,11 +61,9 @@ module I18n
               locale_alphabet.learn(sample_text)
             end
           end
-          locale_alphabet.belonging_score(text)
+          locale_alphabet
         end
 
-        private
-
         def find(keyword)
           count = 0
           File.open(@filename, 'r') do |file|

data/lib/i18n/magic/helpers/environment.rb

@@ -2,9 +2,12 @@ module I18n
   module Magic
     module Helpers
       class Environment
-        def self.locales
-          locale_files = Dir['config/locales/*.yml'].select { |f| f =~ %r/\/[a-z]{2}.yml/ }
-          locale_files.map { |f| f.remove('config/locales/').remove('.yml').upcase }
+        LOCALE_FILES_PATH = 'config/locales/'.freeze
+        LOCALE_FILES_SAMPLE_PATH = 'spec/sample/config/locales/'.freeze
+
+        def self.locales(locale_files_path = LOCALE_FILES_PATH)
+          locale_files = Dir["#{locale_files_path}*.yml"].select { |f| f =~ %r/\/[a-z]{2}.yml/ }
+          locale_files.map { |f| f.remove(locale_files_path).remove('.yml').upcase }
         end
       end
     end

data/lib/i18n/magic/helpers/string_ops.rb

@@ -8,12 +8,12 @@ module I18n
           text.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1_\2').tr('-', '_').downcase
         end
 
-        def self.locale(text)
-          locales = I18n::Magic::Helpers::Environment.locales
+        def self.locale(text, locale_files_path = I18n::Magic::Helpers::Environment::LOCALE_FILES_PATH)
+          locales = I18n::Magic::Helpers::Environment.locales(locale_files_path)
           text_locale = locales[0]
           score = 0
           locales.each do |locale|
-            locale_score = I18n::Magic::Entity::TranslationFile.new(locale).compatibility_score(text)
+            locale_score = I18n::Magic::Entity::TranslationFile.new(locale, locale_files_path).compatibility_score(text)
             if locale_score > score
               text_locale = locale
               score = locale_score
@@ -23,36 +23,7 @@ module I18n
         end
 
         def self.letters_only(text)
-          text.tr('0-9', '')
-              .tr('!', '')
-              .tr('?', '')
-              .tr('@', '')
-              .tr('#', '')
-              .tr('$', '')
-              .tr('%', '')
-              .tr('^', '')
-              .tr('&', '')
-              .tr('*', '')
-              .tr('(', '')
-              .tr(')', '')
-              .tr('[', '')
-              .tr(']', '')
-              .tr('{', '')
-              .tr('}', '')
-              .tr(':', '')
-              .tr(';', '')
-              .tr('\'', '')
-              .tr('"', '')
-              .tr('`', '')
-              .tr('\\', '')
-              .tr('/', '')
-              .tr('<', '')
-              .tr('>', '')
-              .tr('.', '')
-              .tr(',', '')
-              .tr('|', '')
-              .tr(' ', '')
-              .strip.downcase
+          text.gsub(%r/[0-9]|\^|\[|\]|\\|\||\/|[ !?.,@#$%&*(){}:'"`<>]/, '').strip.downcase
         end
       end
     end

data/lib/i18n/magic/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Magic
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-magic
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ali Smadi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement