gettext_column_mapping 0.2.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+*~
+test/locale/
+coverage
+rdoc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Ramihajamalala hery <hery at rails-royce.org>]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,102 @@
+= gettext_column_mapping
+
+If you use mutoh/gettext or grosser/fast_gettext to localize your active_record models, this library is for you.
+This gem only works for now with mysql
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Requirements
+Gem requirements :
+* mutoh/gettext_activerecord >= 2.1.0 or grosser/fast_gettext or your own gettext implementation
+* activerecord >= 2.3.0
+* mysql >= 2.7
+
+== Features/Problems
+
+This library is extracted from another application with its requirements.  So it may not fit your project
+It must be refactored and improved.
+
+* Better API methods naming ?
+* Add more atomic tests
+* Must accept different output than UTF-8
+
+== Example
+
+    gem install gettext_column_mapping
+    gem install fast_gettext gettext_i18n_rails
+
+
+Rails 2.3.x Usage
+
+    # config/environment.rb
+
+    config.gem 'gettext_column_mapping'
+
+    # config/initializers/gettext.rb
+
+    GettextColumnMapping::Initializer.run do |config|
+      config.config_file = File.expand_path('../../column_mapping.yml', __FILE__)
+    end
+
+Rails 3 Usage
+
+    # Gemfile
+    gem 'gettext_column_mapping', :source => 'git://github.com/hallelujah/gettext_column_mapping.git', :require => 'gettext_column_mapping/railtie'
+
+    # config/application.rb
+
+    config.gettext_column_mapping.config_file = File.expand_path('../column_mapping.yml',__FILE__)
+
+All Rails
+
+    # config/initializers/gettext.rb
+
+    # Configure FastGettext
+    FastGettext.add_text_domain 'app_domain', :path => File.join(RAILS_ROOT,'locale')
+    FastGettext.default_available_locales = ['en','fr','es'] #all you want to allow
+    FastGettext.default_text_domain = 'app_domain'
+
+    # config/column_mapping.yml
+
+    my_namespace/foo:
+      class_name: OtherFoo
+      column_names:
+        my_label: Label
+      
+
+See a working {gettext_column_mapping rails examples}[http://github.com/hallelujah/gettext_column_mapping_rails_example.git]
+
+Rails is not mandatory, you can use it in your other project taht satisfies all requirements above !!
+
+Just use  the GettextColumnMapping::Initializer.run method
+
+
+== Rake task
+
+You can add in your Rakefile to have gettext_column_mapping:.* tasks 
+
+    GettextColumnMapping::Tasks.new("version","text_domain") do |t|
+      t.options_store = {
+        :po_root => "./po",
+        :msgmerge => [:verbose, :no_fuzzy_matching]
+      }
+      t.locale_path = './locale'
+      t.options_finder = {:to => "./static/data.rb", :ignore_tables => "schema_migrations"}
+    end
+
+
+== Maintainer
+Ramihajamalala Hery <hery at rails-royce.org>
+
+== Copyright
+
+Copyright (c) 2010 Ramihajamalala Hery < hery at rails-royce.org >, released under the MIT license

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gettext_column_mapping"
+    gem.summary = %Q{Translate your database columns with gettext}
+    gem.description = %Q{Translate your database columns with gettext}
+    gem.email = "hery@rails-royce.org"
+    gem.homepage = "http://github.com/hallelujah/gettext_column_mapping"
+    gem.authors = ["hallelujah"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gettext_column_mapping #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load my tasks
+$:.unshift(File.expand_path('../lib',__FILE__))
+require 'gettext_column_mapping/tasks.rb'
+GettextColumnMapping::Tasks.new("version 0.0.1") do |t|
+  test_root = File.expand_path('../test',__FILE__)
+  t.test_paths <<  test_root
+  t.require_test_libs = ['fast_gettext_helper','gettext_column_mapping/model_attributes_finder']
+  t.require_files = Dir["#{test_root}/models/**/*.rb"].map{|filename| 'models/' + File.basename(filename,'.rb')}
+  t.options_store = { :po_root => "#{test_root}/po" , :msgmerge=>['--sort-output'] }
+  t.options_finder = {:to => File.join(test_root,'static','data.rb')}
+  t.po_pattern = "#{test_root}/{models,static}/**/*.{rb,erb,rjs,rxml}"
+  t.locale_path = "#{test_root}/locale"
+  t.mo_args = [true,"#{test_root}/po","#{test_root}/locale"]
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/examples/config/column_mapping.yml

@@ -0,0 +1,9 @@
+# Columns and table mapping 
+# It is only used with gettext and gettext_activerecord.
+# It only maps the human_attribute_name, class_name of your ActiveRecord::Base classes.
+#
+#Example
+#client:
+#  class_name: customer
+#  column_names:
+#    code_client: customer_code

data/examples/config/gettext_db_extract.yml

@@ -0,0 +1,8 @@
+#ciblage_attribut:
+#  parent:
+#    klass: ciblage_famille
+#    key:  label
+#  columns:
+#    label
+#  conditions: "(ciblage_familles.variable NOT LIKE 'REGION_%' AND ciblage_familles.variable NOT LIKE '%_CLUSTER%' AND ciblage_familles.variable NOT LIKE 'CITY_%' AND ciblage_familles.variable not like '%PROVIDER' AND ciblage_familles.variable NOT LIKE '%_DEPARTEMENT%')"
+#

data/gettext_column_mapping.gemspec

@@ -0,0 +1,104 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gettext_column_mapping}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["hallelujah"]
+  s.date = %q{2010-07-06}
+  s.description = %q{Translate your database columns with gettext}
+  s.email = %q{hery@rails-royce.org}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/config/column_mapping.yml",
+     "examples/config/gettext_db_extract.yml",
+     "gettext_column_mapping.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/gettext_column_mapping.rb",
+     "lib/gettext_column_mapping/backends/base.rb",
+     "lib/gettext_column_mapping/backends/gettext_activerecord.rb",
+     "lib/gettext_column_mapping/backends/gettext_i18n_rails.rb",
+     "lib/gettext_column_mapping/initializer.rb",
+     "lib/gettext_column_mapping/mapper.rb",
+     "lib/gettext_column_mapping/model_attributes_finder.rb",
+     "lib/gettext_column_mapping/parent_level.rb",
+     "lib/gettext_column_mapping/parent_level/attr_methods.rb",
+     "lib/gettext_column_mapping/parser.rb",
+     "lib/gettext_column_mapping/parser/yaml.rb",
+     "lib/gettext_column_mapping/railtie.rb",
+     "lib/gettext_column_mapping/tasks.rb",
+     "tasks/gettext_column_mapping.rake",
+     "test/.gitignore",
+     "test/activerecord_test.rb",
+     "test/config/column_mapping.yml",
+     "test/config/database.yml",
+     "test/config/parent_level_column_mapping.yml",
+     "test/db/fixtures/categories.yml",
+     "test/db/fixtures/rubriques.yml",
+     "test/db/migrate/001_create_utilisateurs.rb",
+     "test/db/migrate/002_create_rubriques.rb",
+     "test/db/migrate/003_create_categories.rb",
+     "test/extend_lib_path.rb",
+     "test/fast_gettext_helper.rb",
+     "test/gettext_column_mapping_test.rb",
+     "test/gettext_helper.rb",
+     "test/helper.rb",
+     "test/log/.gitkeep",
+     "test/mapper_test.rb",
+     "test/models/categorie.rb",
+     "test/models/rubrique.rb",
+     "test/models/utilisateur.rb",
+     "test/po/fr/gettext_column_mapping.po",
+     "test/po/gettext_column_mapping.pot",
+     "test/static/data.rb",
+     "test/static/pluralization.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/hallelujah/gettext_column_mapping}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Translate your database columns with gettext}
+  s.test_files = [
+    "test/helper.rb",
+     "test/static/data.rb",
+     "test/static/pluralization.rb",
+     "test/activerecord_test.rb",
+     "test/mapper_test.rb",
+     "test/fast_gettext_helper.rb",
+     "test/gettext_column_mapping_test.rb",
+     "test/extend_lib_path.rb",
+     "test/gettext_helper.rb",
+     "test/db/migrate/001_create_utilisateurs.rb",
+     "test/db/migrate/003_create_categories.rb",
+     "test/db/migrate/002_create_rubriques.rb",
+     "test/models/categorie.rb",
+     "test/models/rubrique.rb",
+     "test/models/utilisateur.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+# Include hook code here
+# HOOK inspired by gettext_i18n_rails
+begin
+  require 'config/initializers/session_store'
+rescue LoadError
+  # weird bug, when run with rake rails reports error that session
+  # store is not configured, this fixes it somewhat...
+end
+require 'gettext_column_mapping'

data/install.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+# Install hook code here
+%{column_mapping.yml gettext_db_extract.yml}.each do |file|
+  unless File.exist?(File.join(RAILS_ROOT,'examples/config',file))
+    File.copy(File.join(File.dirname(__FILE__),'examples/config',file),File.join(Rails.root,'config'))
+  end
+end

data/lib/gettext_column_mapping/backends/base.rb

@@ -0,0 +1,78 @@
+# coding: utf-8
+module GettextColumnMapping
+
+  mattr_accessor :activerecord_subclasses
+  self.activerecord_subclasses = []
+
+  module Backends
+    module Base
+
+      def self.included(base)
+        base.class_eval do
+          class << self
+
+            def inherited_with_translation(subclass)
+              inherited_without_translation(subclass)
+#             subclass.attr_accessor_with_column_translation(subclass.translation_column_attributes,subclass.translation_parent_attributes)
+              GettextColumnMapping.activerecord_subclasses << subclass
+            end
+            alias_method_chain :inherited, :translation
+
+            def untranslate_all? #_with_untranslatable_columns?
+              ! translate_class_name?
+            end
+
+            # Checks if the column has to be translated
+            def untranslate?(columnname)
+              ! translate_key?(columnname)
+            end
+
+            def to_mapping
+              Gettext.mapper.class_mapping(self)
+            rescue
+              name.underscore
+            end
+
+            def gettext_translation_for_attribute_name(attribute_key_name)
+              GettextColumnMapping.mapper.column_translation_for_attribute(self,attribute_key_name.to_s)
+            end
+
+            def translate_key?(attr_name)
+              GettextColumnMapping.mapper.translate_key?(self,attr_name)
+            end
+
+            def translate_class_name?
+              GettextColumnMapping.mapper.translate_class_name?(self)
+            end
+
+            def column_map_attribute(key)
+              GettextColumnMapping.mapper.map_attribute(self,key)
+            end
+
+            unless method_defined?(:to_s_with_gettext)
+              def to_s_with_gettext
+                to_s
+              end
+            end
+
+            def to_s_with_gettext_with_translation
+              GettextColumnMapping.mapper.to_s_with_gettext(self)
+            end
+            alias_method_chain :to_s_with_gettext, :translation
+
+            def human_name_without_translation
+              to_s_with_gettext
+            end
+
+            def human_name
+              s_(human_name_without_translation)
+            end
+
+
+          end # singleton proxy
+        end # class_eval
+      end # included definition
+
+    end
+  end
+end

data/lib/gettext_column_mapping/backends/gettext_activerecord.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+require 'gettext_activerecord'
+Object.send :include, GetText
+GetText.output_charset = GettextColumnMapping.charset
+module GettextColumnMapping
+
+  class << self
+    delegate :locale, :locale=, :to => GetText
+  end
+
+  module Backends
+    module GettextActiverecord
+
+      def self.included(base)
+        base.class_eval do
+          class << self
+
+            def human_attribute_name_with_translation(attribute_key_name)
+              GetText.s_(gettext_translation_for_attribute_name(attribute_key_name))
+            end
+            alias_method_chain :human_attribute_name, :translation
+
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/gettext_column_mapping/backends/gettext_i18n_rails.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+# Weird Hack on ActionController constant error
+module ActionController
+end
+require 'gettext_i18n_rails'
+
+module GettextColumnMapping
+
+  class << self
+    delegate :locale, :locale=, :to => FastGettext
+  end
+
+  module Backends
+    module GettextI18nRails
+
+      def self.included(base)
+        base.class_eval do 
+          class << self
+
+            def human_attribute_name_without_translation(attr)
+              human_attribute_name(attr)
+            end
+
+            def human_attribute_name_without_gettext_activerecord(attr)
+              human_attribute_name_without_translation(attr)
+            end
+
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/gettext_column_mapping/initializer.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+require 'yaml'
+require 'gettext_column_mapping/parser'
+module GettextColumnMapping
+
+  class Initializer
+
+    class BackendNotLoadedError < LoadError; end
+    class ConfigFileNotFoundError < Errno::ENOENT; end
+
+    cattr_accessor :config
+
+    def self.run(config = nil,&block)
+      self.config = (config || GettextColumnMapping.config)
+      yield(self.config) if block_given?
+      Parser.init(self.config) 
+      load_config_file
+      require_backend
+      require_backend_base
+      extend_active_record
+    end
+
+    private
+
+    class << self
+
+      def require_backend_base
+        require 'gettext_column_mapping/backends/base'
+      end
+
+      def require_backend
+
+        case config.backend
+        when Symbol
+          require(lib = "gettext_column_mapping/backends/#{config.backend}")
+          config.backend_class = lib.camelize
+        when String
+          require config.backend
+          # config.backend_ext must be set !!
+          raise  BackendNotLoadedError, "GettextColumnMapping.config.backend_class must be set if you use your own backend" unless config.bakend_class
+        else
+          raise BackendNotLoadedError, "You must supply a valid backend :gettext_i18n_rails | :gettext_active_record | 'my_librairie/my_backend', please refer to documentation."
+        end
+
+      end
+
+      def extend_active_record
+        ActiveRecord::Base.send(:include,GettextColumnMapping::Backends::Base)
+        ActiveRecord::Base.send(:include, config.backend_class.constantize)
+        if config.use_parent_level
+          require 'gettext_column_mapping/parent_level'
+          GettextColumnMapping::ParentLevel.load_config
+        end
+      end
+
+      def load_config_file
+        raise ConfigFileNotFoundError, "#{config.config_file.inspect}. Please set up config.config_file" unless config.config_file && File.exist?(config.config_file)
+        GettextColumnMapping.mapper.mappings = Parser.parse(config.config_file)
+      end
+
+    end
+
+  end
+end

data/lib/gettext_column_mapping/mapper.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+module GettextColumnMapping
+
+  class Mapper
+    attr_accessor :mappings
+    delegate :[], :has_key?, :to => :mappings, :allow_nil => true
+
+
+    def class_mapping(obj)
+      self[obj.name.underscore][:class_name] || obj.name.underscore
+    end
+
+    def translate_class_name?(obj)
+      begin
+        ! self[obj.name.underscore][:class_name].blank?
+      rescue 
+        false
+      end
+    end
+
+    def map_attribute(obj,key)
+      self[obj.name.underscore][:column_names][key]
+    end
+
+    def translate_key?(obj,key)
+      begin
+        self.has_key?(obj.name.underscore) && ! self[obj.name.underscore][:column_names][key].blank?
+      rescue
+        false
+      end
+    end
+
+    def column_translation_for_attribute(obj,key)
+      if translate_key?(obj,key)
+        "#{obj.to_s_with_gettext}|#{map_attribute(obj,key)}"
+      else
+        "#{obj.to_s_with_gettext}|#{key.to_s.humanize}"
+      end
+    end
+
+    def to_s_with_gettext(obj)
+      array = [GettextColumnMapping.config.model_prefix]
+      if  translate_class_name?(obj)
+        array += self[obj.name.underscore][:class_name].to_s.split('|').collect(&:humanize).collect{|s| s.split(/\s+/).collect(&:humanize).join(' ')}
+      else
+        array += [obj.to_s_with_gettext_without_translation]
+      end
+      array.join('|')
+    end
+
+  end
+
+end