i18n_attributes 0.1.4 → 0.1.6

data/.gitignore

@@ -2,3 +2,9 @@
 .bundle
 Gemfile.lock
 pkg/*
+
+
+spec/rails3_0_app/db/*.sqlite3
+spec/rails3_0_app/log/*
+spec/rails3_0_app/tmp/*
+

data/CHANGELOG

@@ -1,3 +1,11 @@
+== 0.1.6
+
+* revise_model support mongoid orm
+
+* add translator interface
+
+* add generator_helper spec
+
 == 0.1.4
 
 * drop enums support

data/README.markdown

@@ -34,6 +34,8 @@ Run:
 
 ##Usage Example
 
+###Basic Usage
+
 When your generate post model, then hook invoke, create `config/locales/model_zh-CN/post.yml` file
 
     > rails g model post title:string
@@ -53,6 +55,48 @@ If your models has been created, you want generate model attributes i18n locale
         create  config/locales/model_en/post.yml
         create  config/locales/model_zh-CN/post.yml
 
+###Translate attribute
+
+If you want translate attribute or model name
+
+First, edit `config/initializers/i18n_attributes.rb` file, like this
+
+    if Rails.env.development?
+      I18nAttributes.configure do |config|
+        config.locales = [:en, :"zh-CN"]
+        config.translator = {
+          ##if use this, you mast install youdao_fanyi, see https://github.com/vkill/youdao_fanyi
+          :"zh-CN" => Proc.new{|str| YoudaoFanyi.t(str).first}
+        }
+      end
+    end
+
+Then, install `youdao_fanyi`, see https://github.com/vkill/youdao_fanyi. you also use `to _lang` and more.
+
+Last, run `rails g i18n_attributes:revise_model`, results like this
+
+    > rails g i18n_attributes:revise_model
+      create  config/locales/model_en/user.yml
+      INFO  translated attribute/model_name id
+      INFO  translated attribute/model_name username
+      INFO  translated attribute/model_name created_at
+      INFO  translated attribute/model_name updated_at
+      INFO  translated attribute/model_name User
+      create  config/locales/model_zh-CN/user.yml
+
+    > cat config/locales/model_zh-CN/user.yml
+      ---
+      zh-CN:
+        activerecord:
+          models:
+            user: 用户
+          attributes:
+            user:
+              id: id
+              username: 用户名
+              created_at: created_at
+              updated_at: updated_at
+
 
 ##Copyright
 

data/i18n_attributes.gemspec

@@ -22,7 +22,16 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rspec-rails"
+
+  #use in spec/rails3_0_app
+  s.add_development_dependency "rails", "~> 3.0"
+  s.add_development_dependency "sqlite3-ruby"
+  s.add_development_dependency "youdao_fanyi"
+
   s.add_dependency "rails", "~> 3.0"
+  s.add_dependency "activesupport", "~> 3.0"
   s.add_dependency "vkill_gems_methods", "~> 0.1.0"
 end
 

data/lib/generators/i18n_attributes/install/install_generator.rb

@@ -1,17 +1,10 @@
+#encoding: utf-8
+
 class I18nAttributes::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
   def create_initializer_file
-    initializer 'i18n_attributes.rb' do
-      %Q/
-if Rails.env.development?
-  I18nAttributes.configure do |config|
-    #more > I18n.available_locales
-    config.locales = [:en, :"zh-CN"]
-  end
-end
-/
-    end
+    template "i18n_attributes.rb", 'config/initializers/i18n_attributes.rb'
   end
 
   def modify_application_config

data/lib/generators/i18n_attributes/install/templates/i18n_attributes.rb

@@ -0,0 +1,17 @@
+#encoding: utf-8
+
+if Rails.env.development?
+  I18nAttributes.configure do |config|
+    # more see https://github.com/svenfuchs/rails-i18n
+    config.locales = [:en, :"zh-CN"]
+
+    config.translator = {
+      ##if use this, you mast install youdao_fanyi, see https://github.com/vkill/youdao_fanyi
+      #:"zh-CN" => Proc.new{|str| YoudaoFanyi.t(str).first}
+
+      ##if use this, you mast install and config to_lang, see https://github.com/jimmycuadra/to_lang
+      #:"es" => Proc.new{|str| str.translate('es', :from => 'en') }
+    }
+  end
+end
+

data/lib/generators/i18n_attributes/model/model_generator.rb

@@ -1,22 +1,30 @@
+#encoding: utf-8
+
 class I18nAttributes::ModelGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('../templates', __FILE__)
 
   class_option :orm, :required => true
   argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
 
-  include I18nAttributes::GeneratorHelpers
+  include ::VkillGemsMethods::Rails::Generators::Base
 
-  SUPPORTED_ORMS = %w(active_record active_model mongoid)
+  include ::I18nAttributes::GeneratorHelpers
 
-  def create_model_i18n_file
+  SUPPORTED_ORMS = %w(active_model active_record mongoid)
 
-    orm = options.orm.to_s
+  def create_model_i18n_file
 
-    say_error "#{orm} [not found]" unless SUPPORTED_ORMS.include? orm
+    say_error "#{orm} [not found]" unless SUPPORTED_ORMS.include? options.orm.to_s
 
     I18nAttributes::Configuration.locales.each do |locale|
       create_file "config/locales/model_#{ locale }/#{ file_name }.yml",
-                  generate_yaml_file_data(locale, singular_name, human_name, attributes_hash, orm)
+              generate_yaml_file_data(
+                :locale => locale,
+                :singular_name => singular_name,
+                :human_name => human_name,
+                :attributes => attributes_hash(),
+                :model_i18n_scope => model_i18n_scope()
+              ){|word| say_info "translated attribute/model_name #{word}"}.yaml_file_data
     end
 
   end
@@ -25,5 +33,16 @@ class I18nAttributes::ModelGenerator < Rails::Generators::NamedBase
     def attributes_hash
       Hash[ attributes.map {|attribute| [attribute.name, attribute.type] } ]
     end
+
+    def model_i18n_scope
+      case options.orm.to_s
+      when "active_model"
+        :activemodel
+      when "active_record"
+        :activerecord
+      when "mongoid"
+        :mongoid
+      end
+    end
 end
 

data/lib/generators/i18n_attributes/revise_model/revise_model_generator.rb

@@ -1,3 +1,5 @@
+#encoding: utf-8
+
 class I18nAttributes::ReviseModelGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
@@ -6,21 +8,24 @@ class I18nAttributes::ReviseModelGenerator < Rails::Generators::Base
   include ::VkillGemsMethods::Rails::Generators::Base
   ::ActiveRecord::Base.send :include, ::VkillGemsMethods::ActiveRecord::Base
 
-  include I18nAttributes::GeneratorHelpers
+  include ::I18nAttributes::GeneratorHelpers
 
-  SUPPORTED_ORMS = %w(active_record)
+  SUPPORTED_ORMS = %w(active_model active_record mongoid)
 
   def create_model_i18n_file
 
-    orm = options.orm.to_s
-
-    say_error "#{orm} [not found]" unless SUPPORTED_ORMS.include? orm
+    say_error "#{orm} [not found]" unless SUPPORTED_ORMS.include? options.orm.to_s
 
     ::ActiveRecord::Base.models do |model, columns|
       ::I18nAttributes::Configuration.locales.each do |locale|
         create_file "config/locales/model_#{ locale }/#{ model.name.underscore }.yml",
-                generate_yaml_file_data(locale, model.model_name.underscore, model.model_name, columns,
-                                           orm, model.i18n_scope)
+                generate_yaml_file_data(
+                  :locale => locale,
+                  :singular_name => model.model_name.underscore,
+                  :human_name => model.model_name,
+                  :attributes => columns,
+                  :model_i18n_scope => model.i18n_scope
+                ){|word| say_info "translated attribute/model_name #{word}"}.yaml_file_data
       end
     end
 

data/lib/i18n_attributes.rb

@@ -1,5 +1,9 @@
+#encoding: utf-8
+$KCODE = 'u' unless RUBY_VERSION >= "1.9"
+
 require "i18n_attributes/version"
 
+require "yaml"
 require "vkill_gems_methods"
 
 require "i18n_attributes/configuration"

data/lib/i18n_attributes/configuration.rb

@@ -1,8 +1,26 @@
+#encoding: utf-8
+=begin
+  I18nAttributes.configure do |config|
+    # more see https://github.com/svenfuchs/rails-i18n
+    config.locales = [:en, :"zh-CN"]
+
+    config.translator = {
+      #you mast install youdao_fanyi, see https://github.com/vkill/youdao_fanyi
+      :"zh-CN" => Proc.new{|str| YoudaoFanyi.t(str).first}
+
+      ##you mast install and config to_lang, see https://github.com/jimmycuadra/to_lang
+      #:"es" => Proc.new{|str| str.translate('es', :from => 'en') }
+    }
+  end
+=end
+
 module I18nAttributes
   Configuration = Struct.new(
-    :locales
+    :locales,
+    :translator
   ).new(
-    [:en]
+    [:en],
+    {}
   )
 end
 

data/lib/i18n_attributes/generator_helpers.rb

@@ -1,30 +1,84 @@
-require "yaml"
+#encoding: utf-8
 
 module I18nAttributes
   module GeneratorHelpers
 
-    def generate_yaml_file_data(locale, singular_name, human_name, attributes, orm="active_record", model_i18n_scope="activerecord")
-      YAML.dump_stream(
-        {
-          locale.to_s => {
-            model_i18n_scope.to_s => {
-              "models" => {
-                singular_name => human_name.to_s
-              },
-              "attributes" => {
-                singular_name => columns_hash(attributes)
+    def generate_yaml_file_data(*options, &block)
+      YamlFileData.new(*options, &block)
+    end
+
+    class YamlFileData
+
+      attr_reader :locale, :singular_name, :human_name, :attributes, :model_i18n_scope,
+                  :locale_translator, :columns_hash, :yaml_file_data
+
+      def initialize(*options, &block)
+        options = options.extract_options!
+        return self if test = options.delete(:test) || false
+        locale = options.delete(:locale) || raise("locale is required.")
+        singular_name = options.delete(:singular_name) || raise("singular_name is required.")
+        human_name = options.delete(:human_name) || raise("human_name is required.")
+        attributes = options.delete(:attributes) || raise("attributes is required.")
+        model_i18n_scope = options.delete(:model_i18n_scope) || raise("model_i18n_scope is required.")
+        @locale = locale.to_s
+        @singular_name = singular_name.to_s
+        @human_name = human_name.to_s
+        @attributes = attributes.to_hash
+        @model_i18n_scope = model_i18n_scope.to_s
+
+
+        set_locale_translator(&block)
+        set_columns_hash(&block)
+        generate(&block)
+        @yaml_file_data
+      end
+
+      def generate(&block)
+        @yaml_file_data =
+          YAML.dump_stream(
+            {
+              locale => {
+                model_i18n_scope => {
+                  "models" => {
+                    singular_name => @locale_translator ? translate(human_name, &block) : human_name
+                  },
+                  "attributes" => {
+                    singular_name => @columns_hash
+                  }
+                }
               }
             }
-          }
-        }
-      )
-    end
+          )
+      end
+
+      def set_columns_hash(&block)
+        @columns_hash =
+          Hash[ @attributes.keys.map {|k|
+                  [
+                    k.to_s,
+                    @locale_translator ? translate(k, &block) : k.to_s.humanize
+                  ]
+                }
+              ]
+      end
 
-    private
-      def columns_hash(attributes)
-        Hash[ attributes.keys.map {|k| [k.to_s, k.to_s.humanize]} ]
+      def set_locale_translator(&block)
+        translator = I18nAttributes::Configuration.translator
+        locale_translator = translator[@locale.to_sym] || translator[@locale.to_sym]
+        @locale_translator =
+          if !locale_translator.blank? and locale_translator.class == Proc
+            locale_translator
+          else
+             nil
+          end
       end
 
+      def translate(word, &block)
+        yield word.to_s if block
+        @locale_translator.call(word.to_s)
+      end
+    end
+
   end
 end
 

data/lib/i18n_attributes/railtie.rb

@@ -1,3 +1,5 @@
+#encoding: utf-8
+
 module SeedUpgrade
   class Railtie < ::Rails::Railtie
     generators do

data/lib/i18n_attributes/version.rb

@@ -1,4 +1,6 @@
+#encoding: utf-8
+
 module I18nAttributes
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end
 

data/spec/i18n_attributes/generator_helpers_spec.rb

@@ -0,0 +1,103 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe I18nAttributes::GeneratorHelpers::YamlFileData do
+
+  def reset_subject(*options, &block)
+    options = options.extract_options!
+    locale = options.delete(:locale) || :en
+    singular_name = options.delete(:singular_name) || :user
+    human_name = options.delete(:human_name) || :User
+    attributes = options.delete(:attributes) || {"username"=>:string}
+    model_i18n_scope = options.delete(:model_i18n_scope) || :activerecord
+    I18nAttributes::GeneratorHelpers::YamlFileData.new(
+      :locale => locale.to_s, :singular_name => singular_name.to_s, :human_name => human_name.to_s,
+      :attributes => attributes.to_hash, :model_i18n_scope => model_i18n_scope.to_s , &block)
+  end
+
+  it "instance var should set" do
+    subject = reset_subject()
+    subject.locale.should == 'en'
+    subject.singular_name.should == "user"
+    subject.human_name.should == "User"
+    subject.attributes.should == {"username"=>:string}
+    subject.model_i18n_scope.should == "activerecord"
+  end
+
+  context "test set_locale_translator" do
+    it "when translator don't defined, locale_translator is nil" do
+      I18nAttributes::Configuration.translator = {}
+      subject = reset_subject(:locale => :en)
+      subject.locale_translator.should be_nil
+    end
+    it "when translator defined, but locale is don't match reset_subject method defined locale, locale_translator is nil" do
+      I18nAttributes::Configuration.translator = {:"zh-CN" => Proc.new{|str| str.to_s}}
+      subject = reset_subject(:locale => :en)
+      subject.locale_translator.should be_nil
+    end
+    it "when translator defined, but is not Proc, locale_translator is nil" do
+      I18nAttributes::Configuration.translator = {:en => "test"}
+      subject = reset_subject(:locale => :en)
+      subject.locale_translator.should be_nil
+    end
+    it "when translator defined, and is a Proc, and locale match, locale_translator is Proc object" do
+      I18nAttributes::Configuration.translator = {:"zh-CN" => Proc.new{|str| str.to_s}}
+      subject = reset_subject(:locale => :"zh-CN")
+      subject.locale_translator.should be_kind_of(Proc)
+    end
+  end
+
+  context "test set_columns_hash" do
+    it "if not locale_translator, columns_hash.v should eq columns_hash.k.humanize" do
+      I18nAttributes::Configuration.translator = {}
+      subject = reset_subject(:attributes => {"username"=>:string})
+      subject.columns_hash['username'].should == "username".humanize
+    end
+
+    it "if locale_translator, columns_hash.v should eq locale_translator.call(columns_hash.k)" do
+      I18nAttributes::Configuration.translator = {:"zh-CN" => Proc.new{|str| str.to_s.humanize}}
+      subject = reset_subject(:locale => :"zh-CN", :attributes => {"username"=>:string})
+      subject.columns_hash['username'].should == Proc.new{|str| str.to_s.humanize}.call('username')
+    end
+  end
+
+  context "test generate" do
+    it "yaml_file_data is a String, is YAML.dump_stream" do
+      subject = reset_subject()
+      subject.yaml_file_data.should be_kind_of(String)
+    end
+    it "YAML.load_stream yaml_file_data" do
+      subject = reset_subject()
+      data = YAML.load_stream(subject.yaml_file_data).first
+      data['en']['activerecord']['attributes']['user']['username'].should == "Username"
+    end
+  end
+
+  it "test block" do
+    I18nAttributes::Configuration.translator = {:"zh-CN" => Proc.new{|str| str.to_s.humanize}}
+    block_results = []
+    reset_subject(:locale => :"zh-CN", :attributes => {"username"=>:string},
+                  :human_name => :User) {|word| block_results << word}
+    block_results.should include('username')
+    block_results.should include('User')
+  end
+end
+
+describe I18nAttributes::GeneratorHelpers do
+  before {
+    class TestGeneratorHelpers
+      include I18nAttributes::GeneratorHelpers
+    end
+  }
+
+  it "should has generate_yaml_file_data" do
+    TestGeneratorHelpers.new.should respond_to(:generate_yaml_file_data)
+  end
+
+  it "generate_yaml_file_data return a instance of YamlFileData" do
+    TestGeneratorHelpers.new.generate_yaml_file_data(:test => true).should be_instance_of(
+                                                I18nAttributes::GeneratorHelpers::YamlFileData)
+  end
+
+end
+