exvo_globalize 0.2.0 → 0.2.1

data/README.md

@@ -49,6 +49,23 @@ I18n::Backend::GlobalizeStore.authenticator = proc {
 `authenticate_user!` and `require_admin!` are just exemplary authorization actions.
 
 
+
+## Getting back your database stored translations
+
+If you wish to extract your database stored translations to a separate YAML/Ruby file, there are two rake task to help you with that:
+
+```bash
+$ bundle exec rake globalize:translations:dump:yaml
+```
+
+and
+
+```bash
+$ bundle exec rake globalize:translations:dump:ruby
+```
+
+
+
 ## Globalize integration
 
 In order to fully integrate this gem with Globalize, after installing it you need to register your application (http://globalize.exvo.com/) and order some translations (Globalize should automatically detect the gem installation and should let you choose the JSON translations option).

data/exvo_globalize.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'rails', ['>= 3.0.0']
   s.add_dependency 'i18n', ['~> 0.5.0']
   s.add_dependency 'haml', ['>= 3.0.0']
+  s.add_dependency 'awesome_print', ['>= 0.3.2']
+  s.add_dependency 'ya2yaml', ['>= 0.30']
   s.add_dependency 'httparty', ['>= 0.6.1']
   s.add_development_dependency 'guard', ['>= 0.5.0']
   s.add_development_dependency 'guard-rspec', ['>= 0.4.0']

data/lib/exvo_globalize/backend/chain.rb

@@ -30,6 +30,18 @@ module I18n
             return backend.send(:store_flatten_translation, *args) if backend.respond_to?(:store_flatten_translation)
           end
         end
+
+        # convinience methods to quickly access a chosen backend
+
+        # I18n.backend.simple
+        def simple
+          backends.detect { |backend| backend.is_a?(I18n::Backend::Simple) }
+        end
+
+        # I18n.backend.globalize_store
+        def globalize_store
+          backends.detect { |backend| backend.is_a?(I18n::Backend::GlobalizeStore) }
+        end
       end
 
       include Implementation

data/lib/exvo_globalize/backend/flatten.rb

@@ -0,0 +1,24 @@
+module I18n
+  module Backend
+    module Flatten
+
+      # Nest keys for flatten (dotted) hashes
+      #   IN:  { "hello.world" => "hello world" }
+      #   OUT: { :hello => { :world => "hello world" } }
+      def nest_translations(hash)
+        hash.map do |main_key, main_value|
+          main_key.to_s.split(".").reverse.inject(main_value) do |value, key|
+            if value.is_a?(Hash)
+              { key.to_s => nest_translations(value) }
+            else
+              { key.to_s => value }
+            end
+          end
+        end.inject(&:deep_merge)
+      end
+
+    end
+
+    include Flatten
+  end
+end

data/lib/exvo_globalize/version.rb

@@ -1,3 +1,3 @@
 module ExvoGlobalize
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/exvo_globalize.rb

@@ -1,11 +1,14 @@
 require "exvo_globalize/version"
 require "exvo_globalize/backend/chain"
 require "exvo_globalize/backend/fallback"
+require 'exvo_globalize/backend/flatten'
 require "exvo_globalize/backend/globalize_store"
 require "exvo_globalize/backend/simple"
 require 'exvo_globalize/globalize_app'
 require 'haml'
 require 'httparty'
+require 'awesome_print'
+require 'ya2yaml'
 
 # Make it a Rails engine
 module ExvoGlobalize

data/lib/tasks/dump.rake

@@ -0,0 +1,17 @@
+namespace :"globalize:translations:dump" do
+  desc "Dump GlobalizeStore I18n translations as YAML"
+  task :yaml => :environment do
+    puts "Dumping translations as YAML..."
+    backend = I18n.backend.globalize_store
+    translations = backend.available_translations
+    puts backend.nest_translations(translations).ya2yaml
+  end
+
+  desc "Dump GlobalizeStore I18n translations as Ruby Hash"
+  task :ruby => :environment do
+    puts "Dumping translations as Ruby Hash..."
+    backend = I18n.backend.globalize_store
+    translations = backend.available_translations
+    ap backend.nest_translations(translations), { :plain => true, :indent => 2, :sorted_hash_keys => true }
+  end
+end

data/spec/exvo_globalize/fallback_spec.rb

@@ -17,8 +17,7 @@ describe ExvoGlobalize do
     end
 
     it "uses translation from the Simple backend if it is not found in the GlobalizeTranslation backend" do
-      simple_backend = I18n.backend.backends.detect { |backend| backend.is_a?(I18n::Backend::Simple) }
-      simple_backend.translate(I18n.default_locale, :name).should eql(I18n.translate(:name))
+      I18n.backend.simple.translate(I18n.default_locale, :name).should eql(I18n.translate(:name))
     end
 
     after { I18n.locale = I18n.default_locale }

data/spec/exvo_globalize/flatten_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe ExvoGlobalize do
+
+  let(:backend) { I18n.backend.globalize_store }
+
+  it "should not change a normal hash" do
+    hash = { 'hello' => "Hello", 'world' => "World" }
+    backend.nest_translations(hash).should eq(hash)
+  end
+
+  it "should not change a nested hash" do
+    nested_hash = { 'en' => { 'hello' => "Hello World!", 'world' => "World!" } }
+    backend.nest_translations(nested_hash).should eq(nested_hash)
+  end
+
+  it "should nest a simple flatten hash" do
+    hash = { "hello.world" => "Hello World!" }
+    nested_hash = { 'hello' => { 'world' => "Hello World!" } }
+    backend.nest_translations(hash).should eq(nested_hash)
+  end
+
+  it "should nest a complicated flatten hash with symbol key" do
+    hash = {
+      :en => {
+        "hello.world" => "Hello World!",
+        "hello.earth" => "Hello Earth!"
+      }
+    }
+
+    nested_hash = {
+      'en' => {
+        'hello' => {
+          'world' => "Hello World!",
+          'earth' => "Hello Earth!"
+        }
+      }
+    }
+
+    backend.nest_translations(hash).should eq(nested_hash)
+  end
+
+end

data/spec/exvo_globalize/globalize_store_spec.rb

@@ -48,8 +48,7 @@ describe ExvoGlobalize do
   end
 
   it "lists available_translations from the Simple backend (YAML files)" do
-    simple_backend = I18n.backend.backends.detect { |backend| backend.is_a?(I18n::Backend::Simple) }
-    simple_backend.available_translations[:en][:title].should eq('YAML Title')
+    I18n.backend.simple.available_translations[:en][:title].should eq('YAML Title')
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exvo_globalize
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Pawe\xC5\x82 Go\xC5\x9Bcicki"
@@ -67,9 +67,40 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: awesome_print
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ya2yaml
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 30
+        version: "0.30"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -81,11 +112,11 @@ dependencies:
         - 1
         version: 0.6.1
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: guard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -97,11 +128,11 @@ dependencies:
         - 0
         version: 0.5.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: guard-rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -113,11 +144,11 @@ dependencies:
         - 0
         version: 0.4.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: sqlite3
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -128,11 +159,11 @@ dependencies:
         - 3
         version: "1.3"
   type: :development
-  version_requirements: *id007
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -143,11 +174,11 @@ dependencies:
         - 6
         version: "2.6"
   type: :development
-  version_requirements: *id008
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: rspec-rails
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -158,11 +189,11 @@ dependencies:
         - 6
         version: "2.6"
   type: :development
-  version_requirements: *id009
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
   name: factory_girl_rails
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -174,11 +205,11 @@ dependencies:
         - 0
         version: 1.1.0
   type: :development
-  version_requirements: *id010
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: shoulda-matchers
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -192,11 +223,11 @@ dependencies:
         - 3
         version: 1.0.0.beta3
   type: :development
-  version_requirements: *id011
+  version_requirements: *id013
 - !ruby/object:Gem::Dependency 
   name: capybara
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -208,11 +239,11 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id012
+  version_requirements: *id014
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -224,7 +255,7 @@ dependencies:
         - 1
         version: 1.5.1
   type: :development
-  version_requirements: *id013
+  version_requirements: *id015
 description: It exposes `/globalize/translations.json` with JSON of all translations in the app
 email: 
 - pawel.goscicki@gmail.com
@@ -252,6 +283,7 @@ files:
 - lib/exvo_globalize.rb
 - lib/exvo_globalize/backend/chain.rb
 - lib/exvo_globalize/backend/fallback.rb
+- lib/exvo_globalize/backend/flatten.rb
 - lib/exvo_globalize/backend/globalize_store.rb
 - lib/exvo_globalize/backend/simple.rb
 - lib/exvo_globalize/engine.rb
@@ -259,10 +291,12 @@ files:
 - lib/exvo_globalize/version.rb
 - lib/generators/exvo_globalize/exvo_globalize_generator.rb
 - lib/generators/exvo_globalize/templates/migration.rb
+- lib/tasks/dump.rake
 - spec/app.rb
 - spec/controllers/globalize_translations_controller_spec.rb
 - spec/exvo_globalize/caching_spec.rb
 - spec/exvo_globalize/fallback_spec.rb
+- spec/exvo_globalize/flatten_spec.rb
 - spec/exvo_globalize/globalize_store_spec.rb
 - spec/exvo_globalize/pluralizations_spec.rb
 - spec/factories.rb