i18n_csv 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aebb9bd92b897b5fae2bf122018169da25a553e0
-  data.tar.gz: 541f64428f4b71059bfe65dbf1d4578081dcab31
+  metadata.gz: 44295b382a5ff909e6948d766834a1981c495390
+  data.tar.gz: 1d0e5f21d6fcdc5dd70ec5879adb167a1c0faf83
 SHA512:
-  metadata.gz: ec5d7f1e63390a5186f8f8e0e5cd619e272c214fc8b7b80692fee72166cd76efe631c401838770e6a83ba0fe1b7db24a39f74545c1c4252e5aca235018a7152a
-  data.tar.gz: 2d33879cd7ed204f4ab0a0d9e3f90fbe347c6663f814d0769e4a211504718b602c9e82a7deaedd780efa45a049d78da5b8583817d431e3bddc8f5c602ab4e325
+  metadata.gz: df3ecda855e8b39dd9a69b22e6dda3e6645f58fac61edf3ad84276986c253222707f710bce56576ce16ac2c7717de5bb2f2b2b0d1c56c60f2fc10ac9c48a0e9f
+  data.tar.gz: 0a1b801293dd0e5f7acb1f02841fa634d02c1ed6e26795456e8788a600ebf89bab181ce1e31c0faa8055dda47c653657d0d5b4856adf270a379302245739a1c2

data/README.md

@@ -2,6 +2,14 @@
 
 One extends standard I18n so that you could store your translations in a Comma-Separated Value files (*CSV*) in a **key-value** manner, where the **key** is a word or a phrase or even a poem if you wish. No limits here (except be aware to escape symbols so the CSV format is kept). And the **value** is the same text as the key but translated to a language, specified by a file name you are using. For example, you could write one line to a `sp.csv` file: `"hello!","hola!"` and use `t 'hello!'` with a *spanish locale* to get the `"hola!"` text.
 
+## A brief of history
+
+See, I used to be a Magento developer for some time. And I really liked their localization approach. In comparison with the Rails, I18n technique with all those horrible YAML keys, Magento internationalization style looked clearly and... well, more usable.
+
+If Magento did not find the translated key' value - it just put the key itself. And if you try to keep all your keys in English, you did not face huge trouble when you did not set the translation for some text. But with the default Rails configuration, you get the HTML saying *I could not find the translation for moo.foo.bar string!*. And that's horrible, I think.
+
+So from my point of view, this approach (*CSV one*) is more flexible and user-friendly. So even customer could customize your locales.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +26,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's say you want Ukrainian localization for your application.
+
+First you create file `config/locales/uk.csv` with the following content:
+
+    "hello","привіт"
+    "world","світ"
+    "hello, world!","хеллоу ворлд =3"
+
+Then you add the `gem 'i18n_csv'` line to your `Gemfile` and run `bundle install`.
+
+Now you are allowed to use the CSV translations in your application!
+
+Here are some examples:
+
+    irb(main):002:0> I18n.locale = :uk
+    => :uk
+    irb(main):003:0> I18n.t 'hello'
+    => "привіт"
+    irb(main):004:0> I18n.t 'hello, world!'
+    => "хеллоу ворлд =3"
+
 
 ## Contributing
 

data/i18n_csv.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["shybovycha@gmail.com"]
   spec.description   = %q{One extends standard I18n so that you could store your translations in a Comma-Separated Value files (CSV) in a key-value manner, where the key is a word or a phrase or even a poem if you wish. No limits here (except be aware to escape symbols so the CSV format is kept). And the value is the same text as the key but translated to a language, specified by a file name you are using (for example, you could write one line to a sp.csv file: `"hello!","hola!"` and use `t 'hello!'` with a spanish locale to get the "hola!" text).}
   spec.summary       = %q{Extends I18n to use Magento-style CSV translation storage.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/shybovycha/i18n_csv"
   spec.license       = "MIT"
 
   spec.rubyforge_project = "i18n_csv"

data/lib/i18n_csv/i18n_csv.rb

@@ -6,14 +6,14 @@ module I18n
       def get_translations
         tmp_translations = translations()
 
-        def moo(hash, prefix = nil)
+        def yaml_to_key_string(hash, prefix = nil)
           prefix = prefix.to_s
 
           if hash.is_a? Hash then
             hash.collect do |k, v|
               k = k.to_s
 
-              moo(v, (prefix.blank? ? k : prefix + '.' + k)).flatten(1)
+              yaml_to_key_string(v, (prefix.blank? ? k : prefix + '.' + k)).flatten(1)
             end
           elsif hash.is_a? Array
             [ prefix, [ hash.reject { |e| e.blank? } ] ]
@@ -25,7 +25,7 @@ module I18n
         reload!
 
         tmp = tmp_translations.collect do |locale, values|
-          [locale, Hash[*moo(values).flatten(1)]]
+          [locale, Hash[*yaml_to_key_string(values).flatten(1)]]
         end
 
         Hash[[*tmp]]
@@ -53,7 +53,4 @@ module I18n
       end
     end
   end
-end
-
-I18n::Backend::Simple.include(I18n::Backend::CSV18n)
-I18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.csv')]
+end

data/lib/i18n_csv/railtie.rb

@@ -1,59 +1,4 @@
-require 'csv'
-
-module I18n
-  module Backend
-    module CSV18n
-      def get_translations
-        tmp_translations = translations()
-
-        def yaml_to_key_string(hash, prefix = nil)
-          prefix = prefix.to_s
-
-          if hash.is_a? Hash then
-            hash.collect do |k, v|
-              k = k.to_s
-
-              yaml_to_key_string(v, (prefix.blank? ? k : prefix + '.' + k)).flatten(1)
-            end
-          elsif hash.is_a? Array
-            [ prefix, [ hash.reject { |e| e.blank? } ] ]
-          else
-            [ prefix, hash ]
-          end
-        end
-
-        reload!
-
-        tmp = tmp_translations.collect do |locale, values|
-          [locale, Hash[*yaml_to_key_string(values).flatten(1)]]
-        end
-
-        Hash[[*tmp]]
-      end
-
-      protected
-
-      def load_csv(filename)
-        begin
-          lines = CSV.read(filename)
-          locale = ::File.basename(filename, '.csv').to_sym
-          { locale => Hash[ lines.map { |l| l if l.size == 2 } ] }
-        rescue Exception => e
-          Rails.logger.error "I18n CSV error: #{e.message} :: #{e.backtrace}"
-          nil
-        end
-      end
-    end
-  end
-
-  class MissingTranslation
-    module Base
-      def html_message
-        key
-      end
-    end
-  end
-end
+require 'i18n_csv/i18n_csv'
 
 module I18n_CSV
   class Railtie < Rails::Railtie

data/lib/i18n_csv/version.rb

@@ -1,3 +1,3 @@
 module I18nCsv
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n_csv
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Artem Shoobovych
@@ -75,7 +75,7 @@ files:
 - lib/i18n_csv/i18n_csv.rb
 - lib/i18n_csv/railtie.rb
 - lib/i18n_csv/version.rb
-homepage: ''
+homepage: https://github.com/shybovycha/i18n_csv
 licenses:
 - MIT
 metadata: {}