utf8_translatable 0.0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,14 @@
+Quick ActiveRecord Extension.
+Adds self translating methods to translated ActiveRecord models
+(inspired by https://github.com/citizencast/acts_as_translatable)
+
+Example: 
+Given an ActiveRecord model with columns name_en and name_fr  
+Adding ensures_translated_and_utf8 to the model   
+will provide a _name method   
+that returns the correct (column) attribute value given current I18n.locale
+
+Rspec : require 'utf8_translatable/spec_support' => provides you with a
+shares example. To use it simply add it_behaves_like "utf8_translatable" to
+your ActiveRecord models tests.    
+NB: this shared example only checks if the model is_utf8_translatable? == true.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Utf8Translatable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/tasks/utf8_translatable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :utf8_translatable do
+#   # Task goes here
+# end

data/lib/utf8_translatable.rb

@@ -0,0 +1,6 @@
+module Utf8Translatable
+  require_relative './utf8_translatable/base'
+
+  # include the extension 
+  ActiveRecord::Base.send(:include, Utf8Translatable::Base)
+end

data/lib/utf8_translatable/base.rb

@@ -0,0 +1,94 @@
+require 'active_record'
+require 'active_support/all'
+
+# translates translatable columns (ex: title_en / title_fr => _title)
+# ensures db queries return utf8 safe strings (monkey patching linked to ruby encoding issues in 2010)
+module Utf8Translatable::Base
+  extend ActiveSupport::Concern
+
+  # Defines Methods to extend ActiveRecord::Base
+  module ClassMethods
+
+    # default state
+    def is_utf8_translatable?
+      false
+    end
+
+    # Defines '_#{column_name}' prefixed methods for each column of the table
+    # that returns the corresponding attribute value translated in the correct
+    # locale and utf8 safe encoded
+    # 
+    # * *Warning*
+    #   Documentation to be detailed
+    # 
+    # * *NB*:
+    #   Is defined in lib/model_helpers/ut8_translatable.rb, 
+    #   which is included in initializers/active_record_extensions.rb
+    # 
+    # * *Examples*
+    #   1. Composer has columns firstname and lastname.
+    #   Calling @composer._firstname will return the firstname ut8 encoded
+    #   2. Work has columns title_en and title_fr
+    #   Calling @work._title will return @work.title_#{I18n.locale} utf8 encoded  
+    #
+    def ensures_translated_and_utf8
+      if ActiveRecord::Base.connection.table_exists? table_name
+        columns.map{|c| {:name => c.name.to_s, :type => c.type.to_s}}.each do |col|
+          col_type, col_name = col[:type].try(:to_s), col[:name].try(:to_s)
+
+          if col_type == 'string' || col_type == 'text'
+            if is_translatable_attr?(col_type, col_name)
+              _attr = col_name.gsub("_#{I18n.default_locale}", '')
+
+              define_method _universal_method(col_name) do
+                if send("#{_attr}_#{I18n.locale}").nil? then nil else send("#{_attr}_#{I18n.locale}").force_encoding(Encoding::UTF_8) end
+              end
+
+            else
+              # ensure encoded in utf-8
+              _attr = col_name
+              _utf8_method = "_#{col_name}".to_sym
+
+              define_method _utf8_method do
+                if send(_attr).nil? then nil else send(_attr).force_encoding(Encoding::UTF_8) end
+              end
+
+            end
+          end
+        end
+      end
+
+      define_singleton_method :is_utf8_translatable? do
+        true
+      end
+
+    end
+
+    private
+    # Defines is the attribute corresponds to a translatable attributes
+    #
+    # To be a translatable attribute it must
+    # * be of type 'string' or 'text'
+    # * have a structure of type [attr_name]_[locale]
+    # * end with a locale that is in available_locales
+    # * correspond to the default locale (ensures universal method is built only once 
+    #   /+ that when it is built it has a fallback)
+    #
+    def is_translatable_attr?(col_type, col_name)
+      (col_type == 'string' || col_type == 'text') and col_name.split('_').last && I18n.available_locales.map(&:to_s).include?(col_name.split('_').last) && col_name.split('_').last.to_sym == I18n.default_locale
+    end
+
+    # Returns the universal method name for a translatable attr
+    #
+    # * *Example*
+    #   if col[:name] == 'name_en'
+    #   and is_translatable_attr?(col)
+    #   _universal_method returns
+    #   _name    
+    #
+    def _universal_method(col_name)
+      # create universal translated attr
+      "_#{col_name.gsub("_#{I18n.default_locale}", '').to_sym}"
+    end
+  end
+end

data/lib/utf8_translatable/spec_support.rb

@@ -0,0 +1,3 @@
+shared_examples "utf8_translatable" do
+  it { described_class.is_utf8_translatable?.should eql true }
+end

data/lib/utf8_translatable/version.rb

@@ -0,0 +1,3 @@
+module Utf8Translatable
+  VERSION = "0.0.0.1"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: utf8_translatable
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nico Arbogast
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Example: Given an ActiveRecord model with columns name_en and name_fr,
+  adding ensures_translated_and_utf8 to the model will provide a _name method returning
+  the correct column given current I18n.locale'
+email:
+- nicolas.arbogast@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tasks/utf8_translatable_tasks.rake
+- lib/utf8_translatable/base.rb
+- lib/utf8_translatable/spec_support.rb
+- lib/utf8_translatable/version.rb
+- lib/utf8_translatable.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/NicoArbogast/utf8_translatable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds self translating methods to translated ActiveRecord models
+test_files: []