i18n-one_sky 0.0.2 → 0.0.3

data/CHANGELOG

@@ -3,3 +3,5 @@
 == 0.0.1 (03 Jan 2010)
 * Initial release.
 
+== 0.0.3 (12 Sep 2011)
+* allows using Active Record as I18n backend. Instead of downloading as files, translated text are stored into Active Record database.

data/CREDITS

@@ -4,3 +4,7 @@ Junjun Olympia (@beljun), http://rubyredtomatoes.com
 
 * Initial code.
 
+
+Eddie Lau (@tatonlto), http://github.com/3dd13
+
+* use Active Record to store translated phrases

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    i18n-one_sky (0.0.1)
+    i18n-one_sky (0.0.3)
       i18n (~> 0.5.0)
+      i18n-active_record (~> 0.0.2)
       one_sky (~> 0.0.2)
       thor (~> 0.14.4)
 
@@ -11,12 +12,14 @@ GEM
   specs:
     diff-lcs (1.1.2)
     i18n (0.5.0)
+    i18n-active_record (0.0.2)
+      i18n (>= 0.5.0)
     json (1.4.6)
     mime-types (1.16)
     one_sky (0.0.2)
       json (~> 1.4.6)
       rest-client (~> 1.6.1)
-    rest-client (1.6.1)
+    rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.2.0)
       rspec-core (~> 2.2)
@@ -33,8 +36,5 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0.0)
-  i18n (~> 0.5.0)
   i18n-one_sky!
-  one_sky (~> 0.0.2)
   rspec (~> 2.2.0)
-  thor (~> 0.14.4)

data/README.rdoc

@@ -4,6 +4,9 @@ OneSky[link:http://www.oneskyapp.com] is a new service that lets developers reac
 
 This gem integrates OneSky and I18n. At its most basic, it allows you to take the phrases defined under I18n's default locale and upload them to OneSky[link:http://www.oneskyapp.com] for translation by the community. Afterwards, you can download available translations and save them as Simple backend YAML files.
 
+added Database backend storage support since version 0.0.3
+
+
 = Using inside a Rails project
 
 In your Rails root, edit your Gemfile to include this gem:
@@ -43,6 +46,27 @@ Install it like any regular gem:
 
 And see I18n::OneSky::SimpleClient for the methods available in Ruby.
 
+= Using Database as translation storage, YAML as fallback (since version 0.0.3, Rails only)
+
+assuming that you have either run one_sky:init or configured "ONESKY_API_KEY", "ONESKY_API_SECRET" and "ONESKY_PROJECT" environment variables. The following command generates rails initializers and run db migration:
+
+  rails generate one_sky:init_active_record_backend
+
+use the upload_phrases rake command to upload your default locale to one sky server: 
+
+  rake one_sky:upload_phrases
+
+Then, instead of running one_sky:download_translations, run the following command to download and store the translations into translations database table:
+
+  rake one_sky:update_active_record_translations
+
+= Using i18n-one_sky gem in Heroku
+
+Because Heroku is read-only file system, you have to use database storage as storage backend. Either configure the "ONESKY_API_KEY", "ONESKY_API_SECRET" and "ONESKY_PROJECT" environment variables manually or use the OneSky Heroku addon.
+
+Read "Using Database as translation storage" sections for details to upload and download phrases.
+
+
 = History
 
 See CHANGELOG[link:CHANGELOG.html]

data/i18n-one_sky.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "i18n", "~> 0.5.0"
   s.add_dependency "one_sky", "~> 0.0.2"
+  s.add_dependency 'i18n-active_record', "~> 0.0.2"
   s.add_dependency "thor", "~> 0.14.4"
 
   s.add_development_dependency "rspec", "~> 2.2.0"

data/lib/generators/one_sky/init_active_record_backend/init_active_record_backend_generator.rb

@@ -0,0 +1,37 @@
+require 'i18n-one_sky'
+
+module OneSky
+  module Generators
+    class InitActiveRecordBackendGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      desc "This generator generates Rails files(initializer and database migration) to use Onesky service"
+      
+      source_root File.expand_path("../templates", __FILE__)
+      
+      def install_onesky_active_record
+        generate_initializers
+        generate_db_migration
+      end
+      
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+      protected
+
+      def generate_initializers
+        copy_file "onesky.rb", "config/initializers/onesky.rb"
+      end
+      
+      def generate_db_migration
+        migration_template 'migration.rb', 'db/migrate/create_translations_table.rb'        
+        rake("db:migrate")
+      end
+    end
+  end
+end

data/lib/generators/one_sky/init_active_record_backend/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateTranslationsTable < ActiveRecord::Migration
+  def self.up
+    create_table :translations do |t|
+      t.string  :locale
+      t.string  :key
+      t.text    :value
+      t.text    :interpolations
+      t.boolean :is_proc, :default => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :translations
+  end
+end

data/lib/generators/one_sky/init_active_record_backend/templates/onesky.rb

@@ -0,0 +1,4 @@
+YAML_BACKEND = I18n.backend
+ACTIVE_RECORD_BACKEND = I18n::OneSky::Translator::Backend.new
+
+I18n.backend = I18n::Backend::Chain.new(ACTIVE_RECORD_BACKEND, YAML_BACKEND)

data/lib/i18n-one_sky/rails/tasks/i18n-one_sky.rake

@@ -8,10 +8,17 @@ namespace :one_sky do
     puts "Phrases uploaded to OneSky. Please ask your translators to... well... get translating."
   end
 
-  desc "Download available translations from OneSky."
+  desc "Download available translations from OneSky and store as yml files."
   task :download_translations do
     client = I18n::OneSky::SimpleClient.new
     client.download_translations
     puts "Translations downloaded and saved to config/locales/*_one_sky.yml files."
   end
+  
+  desc "Download available translations from OneSky and stores into Active Record database"
+  task :update_activerecord_translations do
+    client = I18n::OneSky::SimpleClient.new
+    client.download_translations(nil, true, true)
+    puts "Translations downloaded and saved to database."
+  end
 end

data/lib/i18n-one_sky/simple_client.rb

@@ -30,15 +30,17 @@ module I18n
       # This will load the phrases defined for I18n's default locale.
       # If not a Rails project, manually supply the path where the I18n yml or rb files for located.
       def load_phrases(path=nil)
+        backend = I18n.backend.is_a?(I18n::Backend::Chain) ? I18n.backend.backends.last : I18n.backend
+        
         if defined? Rails
-          I18n.backend.load_translations
+          backend.load_translations
         else
           raise ArgumentError, "Please supply the path where locales are located." unless path
           path = path.chop if path =~ /\/$/
-          I18n.backend.load_translations(*Dir.glob("#{path}/**/*.{yml,rb}"))
+          backend.load_translations(*Dir.glob("#{path}/**/*.{yml,rb}"))
         end
-
-        @phrases_nested = I18n.backend.instance_variable_get("@translations")[I18n.default_locale]
+        
+        @phrases_nested = backend.instance_variable_get("@translations")[I18n.default_locale]
 
         # Flatten the nested hash.
         flat_keys = flatten_translations(I18n.default_locale, @phrases_nested, true, false)
@@ -65,13 +67,13 @@ module I18n
 
       # When your translators are done, call this method to download all available translations and save them as Simple backend *.yml files.
       # Outside of Rails, manually supply the path where downloaded files should be saved.
-      def download_translations(path=nil, download_base_locale=false)
-        if defined? Rails
+      def download_translations(path=nil, download_base_locale=false, use_active_record=false)
+        if defined?(Rails)
           path ||= [Rails.root.to_s, "config", "locales"].join("/")
         else
           raise ArgumentError, "Please supply the path where locales are to be downloaded." unless path
           path = path.chop if path =~ /\/$/
-        end if
+        end
 
         output = @project.output
 
@@ -85,39 +87,63 @@ module I18n
           end 
         end
 
-        # Delete all existing one_sky translation files before downloading a new set.
-        File.delete(*Dir.glob("#{path}/*_one_sky.yml"))
+        if use_active_record
+          @translations.map { |k,v| save_locale(k, v) unless (k.to_s == @one_sky_locale and !download_base_locale)}
+        else 
+          # Delete all existing one_sky translation files before downloading a new set.
+          File.delete(*Dir.glob("#{path}/*_one_sky.yml"))
         
-        # Process each locale and save to file
-        @translations.map { |k,v| save_locale(k, v, "#{path}/#{k}_one_sky.yml") unless (k.to_s == @one_sky_locale and !download_base_locale)}
+          # Process each locale and save to file
+          @translations.map { |k,v| save_locale(k, v, :filename => "#{path}/#{k}_one_sky.yml") unless (k.to_s == @one_sky_locale and !download_base_locale)}
+        end
       end
 
       protected
 
-      def save_locale(lang_code, phrases, filename)
+      def save_locale(lang_code, phrases, options={})
+        nested = to_nested_nodes(phrases)
+
+        lang = @one_sky_languages.find { |e| e["locale"] == lang_code }
+
+        if options[:filename]
+          filename = options[:filename]
+          File.open(filename, 'w') do |f| 
+            f.puts "# PLEASE DO NOT EDIT THIS FILE."
+            f.puts "# This was downloaded from OneSky. Log in to your OneSky account to manage translations on their website."
+            f.puts "# Language code: #{lang['locale']}"
+            f.puts "# Language name: #{lang['local_name']}"
+            f.puts "# Language English name: #{lang['eng_name']}"
+            f.print(nested.to_yaml)
+          end 
+          filename
+        else
+          
+          lang = @one_sky_languages.find { |e| e["locale"] == lang_code }
+          
+          nested.each do |k, values|            
+            values.each do |value|
+              I18n.backend.store_translations(k, value[0] => value[1])
+            end
+          end
+        end
+      end
+      
+      def to_nested_nodes(phrases)
         nested = Hash.new{ |h,k| h[k] = Hash.new(&h.default_proc) }
-        phrases.map do |k,v|
+        phrases.each do |k,v|
           node = nested
           parts = k.split('.')
           parts.each_with_index { |segment,i| node[segment]; i == parts.size - 1 ? node[segment] = v : node = node[segment] }
         end
-
-        lang = @one_sky_languages.find { |e| e["locale"] == lang_code }
-
-        File.open(filename, 'w') do |f| 
-          f.puts "# PLEASE DO NOT EDIT THIS FILE."
-          f.puts "# This was downloaded from OneSky. Log in to your OneSky account to manage translations on their website."
-          f.puts "# Language code: #{lang['locale']}"
-          f.puts "# Language name: #{lang['local_name']}"
-          f.puts "# Language English name: #{lang['eng_name']}"
-          f.print(nested.to_yaml)
-        end 
-        filename
+        
+        nested
       end
 
       def default_options
-        if defined? Rails
-          YAML.load_file([Rails.root.to_s, 'config', 'one_sky.yml'].join('/')).symbolize_keys
+        config_file = [Rails.root.to_s, 'config', 'one_sky.yml'].join('/')
+        
+        if defined?(Rails) && File.exists?(config_file)
+          YAML.load_file(config_file).symbolize_keys
         else
           {:api_key => ENV["ONESKY_API_KEY"], :api_secret => ENV["ONESKY_API_SECRET"], :project => ENV["ONESKY_PROJECT"]}
         end

data/lib/i18n-one_sky/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Onesky
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/i18n-one_sky.rb

@@ -1,10 +1,19 @@
 require 'i18n'
 require 'one_sky'
 require 'i18n-one_sky/rails/railtie.rb' if defined? Rails
+require 'i18n/backend/active_record' if defined? ActiveRecord
 
 module I18n
   module OneSky
     autoload :SimpleClient, 'i18n-one_sky/simple_client'
     class DefaultLocaleMismatchError < StandardError; end
+
+    if defined?(ActiveRecord)
+      module Translator
+        class Backend < I18n::Backend::ActiveRecord
+          include I18n::Backend::Memoize
+        end
+      end
+    end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: i18n-one_sky
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Junjun Olympia
@@ -14,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 +08:00
-default_executable: 
+date: 2011-09-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: i18n
@@ -25,6 +25,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 0
         - 5
@@ -40,6 +41,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 0
         - 0
@@ -48,50 +50,69 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: thor
+  name: i18n-active_record
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 0
+        - 2
+        version: 0.0.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
         segments: 
         - 0
         - 14
         - 4
         version: 0.14.4
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         - 2
         - 0
         version: 2.2.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: A set of I18n extensions that use OneSky. At its most basic, this allows you to easily submit translation requests to the OneSky service and download available translations as Simple backend YAML files.
 email: 
 - romeo.olympia@gmail.com
@@ -112,6 +133,9 @@ files:
 - Rakefile
 - i18n-one_sky.gemspec
 - lib/generators/one_sky/init/init_generator.rb
+- lib/generators/one_sky/init_active_record_backend/init_active_record_backend_generator.rb
+- lib/generators/one_sky/init_active_record_backend/templates/migration.rb
+- lib/generators/one_sky/init_active_record_backend/templates/onesky.rb
 - lib/i18n-one_sky.rb
 - lib/i18n-one_sky/rails/railtie.rb
 - lib/i18n-one_sky/rails/tasks/i18n-one_sky.rake
@@ -120,7 +144,6 @@ files:
 - spec/data/en.yml
 - spec/helpers.rb
 - spec/simple_client_spec.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/i18n-one_sky
 licenses: []
 
@@ -134,6 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -142,13 +166,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: i18n-one_sky
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: I18n extensions using OneSky -- the community-powered translation service.