translation_panel 0.2.2 → 0.2.3

data/README.textile

@@ -0,0 +1,44 @@
+h1. TranslationPanel
+
+h3. Using with Redis:
+
+# Run redis-server
+
+# Set up redis connection settings and register RedisTranslator::Backend as
+i18n backend in initializers:
+
+    I18n.backend = TranslationPanel::RedisBackend.new(Redis.new)
+    # or in chain with another backend
+
+# Create predicate method +translation_panel?+ in ApplicationController,
+define in it, when panel can be shown and when translates can be saved. By
+default always.
+
+    def translation_panel?
+      params[:translator].present?
+    end
+
+h3. Dependencies
+
+TranslationPanel uses assets, scss, coffeescript, as all its work in Rails 3.1.
+
+If you want to use panel with Rails 3.0, you need to use sprockets gem. Also you 
+need at least i18n-0.6.0 for proper work with i18n keys
+
+h3. Pluralization
+
+Redis backen� support pluralization.
+
+1. You need to use Simple backend with included I18n::Pluralization in chain:
+
+    I18n::Backend::Simple.include I18n::Backend::Pluralization
+    redis_backend = TranslationPanel::RedisBackend.new(Redis.new)
+    I18n.backend = I18n::Backend::Chain.new(redis_backend, I18n::Backend::Simple.new)
+
+2. You need to add in +config/locales/*.yml+ files rules for pluralization:
+
+    i18n:
+      plural:
+        keys:
+          - one
+          - other

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/lib/translation_panel/redis_backend.rb

@@ -1,5 +1,7 @@
 module TranslationPanel
   class RedisBackend < I18n::Backend::KeyValue
+    include I18n::Backend::Pluralization
+
     def initialize(store)
       @subtrees = false
       @store = store
@@ -13,7 +15,7 @@ module TranslationPanel
         TranslationPanel.push key if TranslationPanel.show?
         ActiveSupport::JSON.decode(value) if value
       else  # look in namespace
-        store_count_keys(locale, key) if count
+        pluralization_result = count ? get_count_keys(locale, key) : {}
         full_keys = @store.keys "#{locale}.#{key}.*"
         if full_keys.empty?
           TranslationPanel.push key if TranslationPanel.show?
@@ -26,11 +28,14 @@ module TranslationPanel
             value = ActiveSupport::JSON.decode(value) if value
             result.merge full_key.partition("#{locale}.#{key}.")[2] => value
           end
-          expand_keys(flatten_result).deep_symbolize_keys
+          expand_keys(pluralization_result.merge(flatten_result)).deep_symbolize_keys
         end
       end
     end
 
+    # Transforms flatten hash into nested hash
+    #   expand_keys "some.one" => "a", "some.another" => "b"
+    #   # => "some" => {"one" => "a", "another" => "b"}
     def expand_keys(flatten_hash)
       expanded_hash = {}
       flatten_hash.each do |key, value|
@@ -44,22 +49,27 @@ module TranslationPanel
       expanded_hash
     end
 
-    def store_count_keys(locale, key)
-      if TranslationPanel.show?
-        I18n.t!('i18n.plural.keys', :locale => locale).each do |k|
-          unless translate_present?(locale, "#{key}.#{k}")
-            I18n.backend.store_translations locale, {"#{key}.#{k}" => ""}, :escape => false
-          end
+    # Creates empty translations for absented pluralization keys.
+    # Returns hash with plural keys and their values (even from another backend)
+    def get_count_keys(locale, key)
+      I18n.t!('i18n.plural.keys', :locale => locale).inject({}) do |result, plural_key|
+        full_key = "#{key}.#{plural_key}"
+        value = get_translate(locale, full_key)
+        unless value
+          I18n.backend.store_translations locale, {full_key => ""}, :escape => false
+          value = ""
         end
+        result.merge plural_key.to_s => value
       end
     rescue
-      nil
+      {}
     end
 
-    def translate_present?(locale, key)
+    # returns translation key if any, otherwise nil
+    def get_translate(locale, key)
       I18n.t!(key, :locale => locale)
     rescue
-      false
+      nil
     end
   end
 end

data/spec/app/config/initializers/i18n.rb

@@ -3,6 +3,7 @@ require 'translation_panel'
 
 MultiJson.engine = :yajl
 
-redis = Redis.new(YAML::load_file(File.join(Rails.root, '/config/redis.yml'))[Rails.env].symbolize_keys)
-
-I18n.backend = TranslationPanel::RedisBackend.new(redis)
+I18n::Backend::Simple.include I18n::Backend::Pluralization
+r_conf = YAML::load_file(File.join(Rails.root, '/config/redis.yml'))[Rails.env].symbolize_keys
+Redis_backend = TranslationPanel::RedisBackend.new Redis.new(r_conf)
+I18n.backend = I18n::Backend::Chain.new Redis_backend, I18n::Backend::Simple.new

data/spec/app/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  some:
+    test:
+      one: One test
+      other: %{count} tests

data/spec/app/config/locales/plural.rb

@@ -0,0 +1,17 @@
+{
+  :en => {
+    :i18n => {
+      :plural => {
+        :keys => [:one, :other],
+        :rule => lambda { |n| n == 1 ? :one : :other } } } },
+  :ru => {
+    :i18n => {
+      :plural => {
+        :keys => [:one, :few, :other],
+        :rule => lambda { |n|
+          (n % 10) == 1 && (n % 100) !=11 ?
+            :one :
+            [2, 3, 4].include?(n % 10) && ![12, 13, 14].include?(n % 100) ?
+              :few :
+              :other } } } }
+}

data/spec/app/config/locales/ru.yml

@@ -0,0 +1,8 @@
+ru:
+  some:
+    test:
+      one: %{count} тест
+      few: %{count} теста
+      other: %{count} тестов
+    missing:
+      one: %{count} пропажа

data/spec/lib/redis_backend_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 describe TranslationPanel::RedisBackend do
   before :all do
-    I18n.backend.store.flushdb
+    Redis_backend.store.flushdb
   end
 
   it "stores data, represented by pair key-value" do
@@ -54,11 +54,33 @@ describe TranslationPanel::RedisBackend do
   it "pluralizes translations" do
     I18n.backend.store_translations "ru", :bug => {:one => "1 bug", :other => "%{count} bugs"}
     I18n.translate(:bug, :count => 1).should == "1 bug"
-    I18n.translate(:bug, :count => 2).should == "2 bugs"
+    I18n.translate(:bug, :count => 5).should == "5 bugs"
   end
 
   it 'deletes existing translation with nil value' do
     I18n.backend.store_translations "ru", "simple.key" => nil
-    I18n.backend.store["simple.key"].should be_nil
+    Redis_backend.store["simple.key"].should be_nil
+  end
+
+  describe "#pluralisation" do
+    it "translates from simple, if no keys in redis" do
+      I18n.translate("some.test", :count => 21).should == "21 тест"
+      I18n.translate("some.test", :count => 23).should == "23 теста"
+      I18n.translate("some.test", :count => 11).should == "11 тестов"
+    end
+
+    it "translates from redis, but absented keys takes from simple" do
+      I18n.backend.store_translations "ru", {"some.test.few" => "%{count} испытания"}, :escape => false
+      I18n.translate("some.test", :count => 21).should == "21 тест"
+      I18n.translate("some.test", :count => 23).should == "23 испытания"
+      I18n.translate("some.test", :count => 11).should == "11 тестов"
+    end
+
+    it "creates empty keys in redis if no such keys in both backends" do
+      I18n.backend.store_translations "ru", {"some.missing.few" => "%{count} пропажи"}, :escape => false
+      I18n.translate("some.missing", :count => 21).should == "21 пропажа"
+      I18n.translate("some.missing", :count => 23).should == "23 пропажи"
+      I18n.translate("some.missing", :count => 11).should == ""
+    end
   end
 end

data/spec/translation_panel_spec.rb

@@ -10,7 +10,7 @@ describe HomeController, :type => :controller do
   render_views
   describe "index" do
     before :all do
-      I18n.backend.store.flushdb
+      Redis_backend.store.flushdb
     end
 
     describe "normal processing" do
@@ -54,7 +54,7 @@ describe HomeController, :type => :controller do
   describe "without_head" do
     render_views
     before :all do
-      I18n.backend.store.flushdb
+      Redis_backend.store.flushdb
     end
 
     it "is successfull" do

data/translation_panel.gemspec

@@ -5,15 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{translation_panel}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mik-die"]
-  s.date = %q{2011-08-09}
+  s.date = %q{2011-08-13}
   s.description = %q{I18n backend, based on redis, with frontend panel for translations}
   s.email = %q{MikDiet@gmail.com}
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.textile"
   ]
   s.files = [
     ".rspec",
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "MIT-LICENSE",
-    "README.rdoc",
+    "README.textile",
     "Rakefile",
     "VERSION",
     "app/assets/javascripts/translation_panel.js.coffee",
@@ -48,6 +48,9 @@ Gem::Specification.new do |s|
     "spec/app/config/initializers/i18n.rb",
     "spec/app/config/initializers/secret_token.rb",
     "spec/app/config/initializers/session_store.rb",
+    "spec/app/config/locales/en.yml",
+    "spec/app/config/locales/plural.rb",
+    "spec/app/config/locales/ru.yml",
     "spec/app/config/redis.yml",
     "spec/app/config/redis/test.conf",
     "spec/app/config/routes.rb",

metadata

@@ -2,7 +2,7 @@
 name: translation_panel
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Mik-die
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-09 00:00:00 +08:00
+date: 2011-08-13 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,14 +86,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.textile
 files: 
 - .rspec
 - .rvmrc
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - app/assets/javascripts/translation_panel.js.coffee
@@ -120,6 +120,9 @@ files:
 - spec/app/config/initializers/i18n.rb
 - spec/app/config/initializers/secret_token.rb
 - spec/app/config/initializers/session_store.rb
+- spec/app/config/locales/en.yml
+- spec/app/config/locales/plural.rb
+- spec/app/config/locales/ru.yml
 - spec/app/config/redis.yml
 - spec/app/config/redis/test.conf
 - spec/app/config/routes.rb
@@ -143,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -923747487
+      hash: -593371821
       segments: 
       - 0
       version: "0"

data/README.rdoc

@@ -1,25 +0,0 @@
-= TranslationPanel
-
-= Using with Redis:
-
-# Run redis-server
-
-# Set up redis connection settings and register RedisTranslator::Backend as
-i18n backend in initializers:
-
-    I18n.backend = RedisTranslator::Backend.new(Redis.new)
-    # or in chain with another backend
-
-# Create predicate method +translation_panel?+ in ApplicationController,
-define in it, when panel can be shown and when translates can be saved. By
-default always.
-
-    def translation_panel?
-      params[:translator].present?
-    end
-
-= Dependencies
-
-TranslationPanel uses asset pipeline, so it works nice with Rails 3.1.
-
-If you want to use panel with Rails 3.0, you need to use sprockets gem.