gettext_column_mapping 0.2.2

data/lib/gettext_column_mapping/model_attributes_finder.rb

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+module GettextColumnMapping
+  #write all found models/columns to a file where GetTexts ruby parser can find them
+  def self.store_model_attributes(options)
+    file = options[:to] || 'data/model_attributes.rb'
+    File.open(file,'w') do |f|
+      f.puts "# coding: utf-8"
+      f.puts "#DO NOT MODIFY! AUTOMATICALLY GENERATED FILE!"
+      ModelAttributesFinder.new.find(options).each do |model,column_names|
+
+        f.puts("s_('#{model.to_s_with_gettext}')") #!Keep in sync with ActiveRecord::Base.human_name
+
+        #all columns namespaced under the model
+        column_names.each do |attribute|
+          translation = model.gettext_translation_for_attribute_name(attribute)
+          f.puts("s_('#{translation}')")
+        end
+      end
+      if GettextColumnMapping.config.use_parent_level
+        # Select all classes with parent level
+        GettextColumnMapping::ParentLevel.each_config do |klass_name,columns,parent_association,parent_key,conditions|
+          model = klass_name.constantize
+          options_hash = {}
+          if parent_association
+           options_hash.merge!(:conditions => conditions, :include => parent_association)
+          end
+          model.find_each do |record|
+            columns.each do |column|
+              f.puts("s_('#{record.msgid_for_attribute(column)}')")
+            end
+          end
+        end
+        # For each selected class, batch 200 include parents with key
+        # f.puts(instance.msgid_for_attribute(column))
+      end
+
+      f.puts "#DO NOT MODIFY! AUTOMATICALLY GENERATED FILE!"
+    end
+  end
+
+  class ModelAttributesFinder
+
+    def initialize
+      return unless Object.const_defined?(:Rails)
+      # HOOK ... HOOK wow ... berk
+      # Is it safe ?
+      $rails_rake_task = false
+      # Eager load all classes !! In order to load all ActiveRecord::Base
+
+      # Rails 3.x power
+      if Rails::VERSION::MAJOR > 2
+        Rails.application.eager_load!
+      else
+        Rails::Initializer.run(:load_application_classes,Rails.configuration) do |config|
+          config.cache_classes = true
+        end
+      end
+
+    end
+    # options:
+    #   :ignore_tables => ['cars',/_settings$/,...]
+    #   :ignore_columns => ['id',/_id$/,...]
+    # current connection ---> {'cars'=>['model_name','type'],...}
+    def find(options)
+      found = Hash.new([])
+
+      GettextColumnMapping.activerecord_subclasses.each do |subclass|
+        next if  table_ignored?(subclass,options[:ignore_tables])
+        subclass.columns.each do |column|
+          unless column_ignored?(subclass,column,options[:ignore_columns])
+            found[subclass] += [column.name]
+          end
+        end
+      end
+
+      found
+    end
+
+    def table_ignored?(subclass, patterns)
+      ignored?(subclass.table_name,patterns) || subclass.untranslate_all? || !subclass.table_exists?
+    end
+
+    def column_ignored?(subclass,column,patterns)
+      ignored?(column.name,patterns) || subclass.untranslate?(column.name)
+    end
+
+    def ignored?(name,patterns)
+      return false unless patterns
+      patterns.detect{|p| (p.is_a?(Regexp) && name=~p) || (p.to_s == name.to_s)}
+    end
+  end
+end

data/lib/gettext_column_mapping/parent_level/attr_methods.rb

@@ -0,0 +1,45 @@
+module GettextColumnMapping
+  module ParentLevel
+    module AttrMethods
+
+      def self.extended(base)
+        base.class_eval do 
+          class << self
+            def inherited_with_column_mapping_parent_level(subclass)
+              self.inherited_without_column_mapping_parent_level(subclass)
+
+              parent = GettextColumnMapping::ParentLevel.parent_attributes_translation(subclass.to_s)
+              attributes = GettextColumnMapping::ParentLevel.column_attributes_translation(subclass)
+              subclass.gettext_column_mapping_accessor(attributes,parent)
+            end
+            alias_method_chain :inherited, :column_mapping_parent_level
+          end
+        end
+      end
+
+      def gettext_column_mapping_accessor(method_syms=[],parent=nil)
+        if parent
+          parent_association = parent[:association]
+          parent_key = parent[:key]
+        end
+
+        class_eval(<<-CODE,__FILE__,__LINE__)
+          def msgid_for_attribute(method)
+            parent_record = #{parent_association ? parent_association : 'nil'}
+            GettextColumnMapping::ParentLevel.prefix_method(self,method,parent_record,'#{parent_key}')
+          end
+        CODE
+
+        [method_syms].flatten.each do |method_sym|
+          class_eval(<<-STR,__FILE__,__LINE__)
+
+                    def #{method_sym}
+                      s_(msgid_for_attribute('#{method_sym}'))
+                    end
+                    STR
+        end
+      end
+
+    end
+  end
+end

data/lib/gettext_column_mapping/parent_level.rb

@@ -0,0 +1,78 @@
+require 'gettext_column_mapping/parent_level/attr_methods'
+module GettextColumnMapping
+
+  module ParentLevel
+
+    class << self
+
+      def data_prefix
+        GettextColumnMapping.config.data_prefix
+      end
+
+      def locate_parser(mod)
+        case mod
+        when Module
+          mod
+        when Symbol
+          require "gettext_column_mapping/parser/#{mod.to_s}"
+          GettextColumnMapping::Parser.const_get(mod.to_s.classify)
+        else
+          require "gettext_column_mapping/parser/yaml"
+          GettextColumnMapping::Parser::Yaml
+        end
+      end
+
+      def load_config
+        @column_attributes_translation = {}
+        @attributes_translation = {}
+        mod = GettextColumnMapping.config.parent_level_parser
+        file = GettextColumnMapping.config.parent_level_file
+        @parent_level_config = HashWithIndifferentAccess.new(locate_parser(mod).parse(file))
+      end
+
+      def prefix(klass = nil,column = nil,parent = nil,key = nil)
+        prefixes = [data_prefix]
+        prefixes << "#{klass.to_s_with_gettext}" if klass
+        prefixes  << "#{parent[key]}" if parent
+        prefixes << "#{klass.column_map_attribute(column.to_s)}" if column
+        prefixes.join("|")
+      end
+
+      def prefix_method(object,method,parent_record,parent_key)
+        [prefix(object.class,method,parent_record,parent_key), object[method] ].join("|")
+      end
+
+      def translate_key_for_column?(klass, column)
+        column_attributes_translation(klass)[column]
+      end
+
+      def each_config(&block)
+        @column_attributes_translation.each do |klass_name,columns| 
+          parent = parent_attributes_translation(klass_name)
+          if parent
+            parent_key = parent[:key]
+            parent_association = parent[:association]
+            conditions = parent[:conditions]
+          end
+          yield(klass_name,columns,parent_association, parent_key,conditions)
+        end
+
+      end
+
+      def attributes_translation(klass_name)
+        @attributes_translation[klass_name] = @parent_level_config[klass_name.underscore]
+      end
+
+      def parent_attributes_translation(klass_name)
+        attributes_translation(klass_name) && attributes_translation(klass_name)[:parent]
+      end
+
+      def column_attributes_translation(klass)
+        @column_attributes_translation[klass.name] ||= (attributes_translation(klass.name) && attributes_translation(klass.name)[:columns]) || []
+      end
+
+    end
+  end
+end
+
+::ActiveRecord::Base.extend GettextColumnMapping::ParentLevel::AttrMethods

data/lib/gettext_column_mapping/parser/yaml.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+require 'erb'
+module GettextColumnMapping
+  module Parser
+    class Yaml
+      def self.parse(path)
+        YAML.load(ERB.new(IO.read(path)).result)
+      end
+    end
+  end
+end

data/lib/gettext_column_mapping/parser.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+module GettextColumnMapping
+  module Parser
+
+    class << self
+
+      attr_reader :parser
+
+      def init(config)
+        @parser = locate_parser(config.config_parser)
+      end
+
+      def parse(file)
+        results = {}
+        h = @parser.parse(file)
+        h.each do |k,v|
+          results[k.to_s] = HashWithIndifferentAccess.new(v)
+        end if h
+        results
+      end
+
+      def locate_parser(mod)
+        case mod
+        when Module
+          mod
+        when Symbol
+          require "gettext_column_mapping/parser/#{mod.to_s}"
+          GettextColumnMapping::Parser.const_get(mod.to_s.classify)
+        else
+          require "gettext_column_mapping/parser/yaml"
+          GettextColumnMapping::Parser::Yaml
+        end
+      end
+
+    end
+
+  end
+end

data/lib/gettext_column_mapping/railtie.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+require 'rails'
+require 'gettext_column_mapping'
+require 'gettext_column_mapping/initializer'
+
+module GettextColumnMapping
+  class Railtie < Rails::Railtie
+
+    config.gettext_column_mapping = GettextColumnMapping.config
+
+    initializer "gettext_column_mapping.after_initialize" do |app|
+      GettextColumnMapping::Initializer.run(app.config.gettext_column_mapping)
+    end
+
+    rake_tasks do
+      load File.expand_path('../tasks.rb',__FILE__)
+    end
+
+  end
+end
+

data/lib/gettext_column_mapping/tasks.rb

@@ -0,0 +1,147 @@
+# coding: utf-8
+module GettextColumnMapping
+  class Tasks < Rake::TaskLib
+
+    attr_accessor  :text_domain, :lib_paths, :test_paths, :require_test_libs, :require_libs, :require_files, :options_store, :po_pattern, :mo_args, :locale_path, :options_finder
+    attr_reader :version
+
+    def initialize(version, domain = nil, &block)
+      @test_paths = []
+      @require_libs = []
+      @require_test_libs = []
+      @require_files = []
+      @options_store = {}
+      @po_pattern = nil
+      @options_finder = {}
+      @locale_path = 'locale'
+      @version = version
+      @text_domain = domain
+      yield self if block_given?
+      verify_variables
+      define
+    end
+
+    def verify_variables
+     @options_finder = {:to => File.join(locale_path, 'data.rb')}.merge(@options_finder)
+     @options_store = {:po_root => locale_path}.merge(@options_store)
+     @po_pattern ||= "locale/data.rb"
+    end
+
+    def text_domain
+      @text_domain ||= ENV['TEXTDOMAIN'] || "gettext_column_mapping"
+    end
+
+    def load_gettext
+      require 'gettext'
+      require 'gettext/utils'
+    end
+
+    def po_root
+      options_store[:po_root] || locale_path
+    end
+
+    private
+
+    def define
+      require_libs.each do |lib|
+        require lib
+      end
+
+      task :environment 
+      namespace :gettext_column_mapping do
+        desc "Redo gettext"
+        task :all => [:"gettext_column_mapping:find", :"gettext_column_mapping:updatepo", :"gettext_column_mapping:makemo" ]do
+        end
+
+        desc "Find translation in databases"
+        task :find  => [:environment] do
+          test_paths.each do |path|
+            $:.unshift(path)
+          end
+          require_test_libs.each do |lib|
+            require lib
+          end
+          require_files.each do |file_path|
+            require file_path
+          end
+
+          require 'gettext_column_mapping/model_attributes_finder'
+          GettextColumnMapping.store_model_attributes(options_finder) 
+
+        end
+
+        desc "Update po"
+        task :updatepo do
+
+          load_gettext
+
+          if GetText.respond_to? :update_pofiles_org
+            GetText.update_pofiles_org(
+              text_domain(),
+              Dir.glob(po_pattern),
+              version,
+              options_store
+            )
+          else #we are on a version < 2.0
+            puts "install new GetText with gettext:install to gain more features..."
+            #kill ar parser...
+            require 'gettext_activerecord/parser'
+            # Need to use this eval hook since we define a module in a method
+            Object.eval <<-HOOK
+            module GetText
+              module ActiveRecordParser
+                module_function
+                def init(x);end
+              end
+            end
+            HOOK
+
+            #parse files.. (models are simply parsed as ruby files)
+            GetText.update_pofiles(
+              text_domain,
+              Dir.glob(po_pattern),
+              version,
+              options_store[:po_root]
+            )
+          end
+
+
+        end
+
+        desc "Create mo-files for L10n"
+        task :makemo do
+          load_gettext
+          GetText.create_mofiles(options_store[:verbose], po_root, locale_path)
+        end
+
+        desc "add a new language"
+        task :add_language, [:language] do |_, args|
+          language = args.language || ENV["LANGUAGE"]
+
+          # Let's make some pre-verification of the environment.
+          if language.nil?
+            puts "You need to specify the language to add. Either 'LANGUAGE=eo rake test_lib:gettext:add_languange' or 'rake test_lib:gettext:add_languange[eo]'"
+            next
+          end
+          pot = File.join(po_root, "#{text_domain}.pot")
+          if !File.exists?(pot)
+            puts "You don't have a pot file yet, you probably should run 'rake gettext:find' at least once. Tried '#{pot}'."
+            next
+          end
+
+          # Create the directory for the new language.
+          dir = File.join(po_root, language)
+          puts "Creating directory #{dir}"
+          FileUtils.mkdir_p(dir)
+
+          # Create the po file for the new language.
+          new_po = File.join(po_root, language, "#{text_domain}.po")
+          puts "Initializing #{new_po} from #{pot}."
+          system "msginit --locale=#{language} --input=#{pot} --output=#{new_po}"
+
+        end
+      end
+
+    end
+  end
+end

data/lib/gettext_column_mapping.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+# Check the version of active_support to requiring all libs
+require 'active_support/version'
+if Gem::Version.new(ActiveSupport::VERSION::STRING) > Gem::Version.new("2")
+  require 'active_support/all'
+else
+  require 'active_support'
+end
+
+# We need active_record
+require 'active_record'
+
+
+require 'gettext_column_mapping/mapper'
+require 'gettext_column_mapping/initializer'
+
+module GettextColumnMapping
+  mattr_accessor :config
+  mattr_reader :mapper
+  @@mapper = GettextColumnMapping::Mapper.new
+
+  # Configuration default
+
+  self.config = ActiveSupport::OrderedOptions.new
+  self.config.config_file =  nil
+  self.config.config_parser = :yaml
+  self.config.backend = :gettext_i18n_rails
+  self.config.backend_class = nil
+  self.config.model_prefix = "Model"
+  self.config.data_prefix = "Data"
+  self.config.charset = :utf8
+
+  # Additional plugins
+  self.config.use_parent_level = false
+  self.config.parent_level_file = nil
+  self.config.parent_level_parser = :yaml
+
+  def self.charset
+    case config.charset.to_s
+    when /utf8|utf-8/i
+      'UTF-8'
+    else
+      'UTF-8'
+    end
+  end
+end

data/tasks/gettext_column_mapping.rake

@@ -0,0 +1,132 @@
+require 'activesupport'
+
+def load_gettext
+  require 'gettext'
+  require 'gettext/utils'
+  require 'gettext_column_mapping' # Include this library in order to unable column mapping and untranslating
+end
+
+@application = "aimfar"
+@version = ENV['VERSION'] || "0.0.1"
+@application_domain = "Adperf Publisher"
+
+def directory_for_lang(lang)
+  File.join('po',lang)
+end
+
+task :ensure_environment_defined do
+  @po_dir = 'po'
+  @lang =  ENV['GLANG']
+
+  if @lang.blank?
+    puts "*** The 'GLANG' environment variable must be precised. E.g. rake gettext:create_lang GLANG=es_ES ***"
+    exit
+  else
+    @lang.split('_').first
+  end
+end
+
+task :create_directory => :ensure_environment_defined do
+  dir =directory_for_lang(@lang)
+  unless File.exist?(dir)
+    puts "### Creating directory #{dir} ###"
+    FileUtils.mkdir_p(dir) 
+  else
+    puts "### Directory #{dir} already exists! Not creating. ###"
+  end
+end
+
+def out_file(f)
+  File.join(@po_dir,@lang,File.basename(f,'.pot') + '.po')
+end
+
+namespace :gettext do 
+
+  desc "Update pot/po files."
+  task :updatepo => [:environment] do
+    load_gettext
+    require 'gettext_i18n_rails/haml_parser'
+
+
+    unless ENV['NO_EXTRACT_DB']
+      Rake::Task['gettext:store_model_columns'].invoke
+    end
+    puts "### Updating po/pot files. ###"
+    FileUtils.rm_f("po/#{@application}.pot")
+
+    if GetText.respond_to? :update_pofiles_org
+      GetText.update_pofiles_org(@application, Dir.glob("{app,lib,bin,data,static_data}/**/*.{builder,rb,erb,rjs}"), "#{@application_domain} #{@version}", :msgmerge => [:no_wrap,:sort_by_file, :no_fuzzy_matching, :previous],:verbose => true)
+    else
+      puts "install new GetText with gettext:install to gain more features..."
+      #kill ar parser...
+      require 'gettext/parser/active_record'
+      module GetText
+        module ActiveRecordParser
+          module_function
+          def init(x);end
+        end
+      end
+
+      GetText.update_pofiles(@application, Dir.glob("{app,lib,bin,data,static_data}/**/*.{builder,rb,erb,rjs}"), "#{@application_domain} #{@version}")#, :msgmerge => [:no_wrap,:sort_by_file, :no_fuzzy_matching, :previous],:verbose => true)
+    end
+  end
+
+  desc "Create mo-files"
+  task :makemo => [:environment] do
+    load_gettext
+    puts "### Creating mo-files. ###"
+    GetText.create_mofiles(true, "po", "locale")
+    #    GetText.create_mofiles(true, "po", "locale")
+  end
+
+  desc "Create a language file for lang GLANG (fr_FR,en_US etc..)."  
+  task :create_lang  => :create_directory do
+
+    #  LANG=es_ES msginit -i ../site.pot -o site.po
+    pot_files = Dir.glob(File.join(@po_dir,'*.pot'))
+    if pot_files.blank?
+      puts 'Unable to find pot files' 
+      exit 1
+    end
+    pot_files.each do |f|
+      out_f = out_file(f)
+      unless File.exist?(out_f) # Prevent from erasing the old .po
+        puts "### Creating #{out_f} ! ###"  
+        exec "`msginit -i #{f} -o #{out_f} -l #{@lang} --no-wrap`" 
+      else
+        puts "### #{out_f} already present! Not created. ###"  
+      end
+    end
+
+  end
+
+  desc "Extract needed data from DB for gettext"
+  task :extract_db do
+    puts "Extracting data from databases"
+    # don't require this file since it loads all rails framework. 
+    # Also use system because exec exits as finished
+    system("ruby utils/extract_data_from_db_for_gettext.rb") 
+
+  end
+
+  # This is just an example 
+  # Please be inspired!!! :D
+
+  desc "write the data/model_attributes.rb"
+  task :store_model_columns  => [:extract_db,:environment] do # => [ :extract_db] do
+    require 'gettext_column_mapping/model_attributes_finder'
+    FastGettext.silence_errors
+    storage_file = 'data/model_attributes.rb'
+    puts "writing model translations to: #{storage_file}"
+    ignore_tables = [/^sitemap_/, /_versions$/, 'schema_migrations', 'sessions']
+
+    #    GettextColumnMapping::ModelAttributesFinder.new
+    #    puts ActiveRecord::Base.send(:subclasses).size
+    GettextColumnMapping.store_model_attributes(
+      :to => storage_file,
+      :ignore_columns => ['id', 'type', 'created_at', 'updated_at'],
+      :ignore_tables => ignore_tables
+    )
+
+  end
+end

data/test/.gitignore

@@ -0,0 +1 @@
+log/*

data/test/activerecord_test.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+require 'test_helper'
+require 'models/utilisateur'
+require 'models/rubrique'
+require 'models/categorie'
+class ActiverecordTest < ActiveSupport::TestCase
+
+  fixtures :categories,:rubriques
+
+  def test_human_attribute_name
+    GettextColumnMapping.locale = 'en'
+    assert_equal 'First name', Utilisateur.human_attribute_name('prenom')
+    assert_equal 'Last name', Utilisateur.human_attribute_name('nom')
+    assert_equal 'Gender', Utilisateur.human_attribute_name('sexe')
+    assert_equal 'Label', Rubrique.human_attribute_name('libelle')
+    assert_equal 'Label', Categorie.human_attribute_name('libelle')
+    GettextColumnMapping.locale = 'fr'
+    assert_equal 'Prénom', Utilisateur.human_attribute_name('prenom')
+    assert_equal 'Nom', Utilisateur.human_attribute_name('nom')
+    assert_equal 'Sexe', Utilisateur.human_attribute_name('sexe')
+    assert_equal 'Libellé', Rubrique.human_attribute_name('libelle')
+    assert_equal 'Libellé', Categorie.human_attribute_name('libelle')
+  end
+
+
+  def test_parent_level
+    cat = categories(:"event-wc")
+    assert_equal 'Data|Model|Category|Event|Label|World Cup', cat.msgid_for_attribute('libelle')
+    GettextColumnMapping.locale = 'en'
+    assert_equal 'World Cup', cat.libelle
+    GettextColumnMapping.locale = 'fr'
+    assert_equal 'Evènement - Coupe du monde', cat.libelle
+    # Sport Football
+    cat = categories(:"sport-foot")
+    assert_equal 'Data|Model|Category|Sport|Label|Football', cat.msgid_for_attribute('libelle')
+    GettextColumnMapping.locale = 'en'
+    assert_equal 'Football', cat.libelle
+    GettextColumnMapping.locale = 'fr'
+    assert_equal 'Sport - Football', cat.libelle
+
+  end
+
+end

data/test/config/column_mapping.yml

@@ -0,0 +1,16 @@
+utilisateur:
+  class_name: User
+  column_names:
+    sexe: Gender
+    nom: Last name
+    prenom: First name
+
+rubrique:
+  class_name: Division
+  column_names:
+    libelle: Label
+
+categorie:
+  class_name: Category
+  column_names:
+    libelle: Label

data/test/config/database.yml

@@ -0,0 +1,9 @@
+# coding: utf-8
+test:
+  database: gettext_column_mapping
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock
+  encoding: utf8