globalize3_translator 0.0.2

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'activerecord', '>= 3.0.0.rc', :require => 'active_record'
+gem 'globalize3', '>= 0.0.7'
+gem 'sishen-rtranslate', '>= 1.3'
+
+group :test do
+  gem 'ruby-debug'
+  gem 'sqlite3-ruby'
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    globalize3 (0.0.7)
+      activerecord (>= 3.0.0.rc)
+    i18n (0.4.1)
+    json (1.4.6)
+    linecache (0.43)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    sishen-rtranslate (1.4)
+      activesupport (>= 2.2.0)
+      json (>= 1.1.3)
+    sqlite3-ruby (1.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0.0.rc)
+  globalize3 (>= 0.0.7)
+  ruby-debug
+  sishen-rtranslate (>= 1.3)
+  sqlite3-ruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Laurynas Butkus
+
+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,80 @@
+= Globalize3 Translator
+
+* Automatically adds missing model translations
+* Uses Google Translate by default (you can use your own backend)
+* Marks auto translated data
+
+== Installation
+
+To install Globalize3 Translator use:
+
+  gem install globalize3_translator
+
+== Configuration
+
+If you wish to override default configuration create 
+config/initializers/globalize3.rb
+
+  Globalize::Translator.configure do |config|
+    # automatically translate only to specified locales 
+    config.locales = [ :lt, :de ]
+  
+    # use cust translator backend
+    config.backend = MyTranslatorBackend 
+  end
+
+== Identifying auto translated data with auto_translated?
+
+Example:
+
+  post = Post.new :title => "Dog"
+  post.save!
+  post.reload
+
+  # should be "false" for current locale
+  post.title.auto_translated?
+
+  I18n.locale = :lt
+
+  # should be "true" for other locale
+  post.title.auto_translated? 
+
+
+== Writing custom backend
+
+Example:
+
+  class MyTranslatorBackend < Globalize::Translator::Backends::Abstract
+
+    def translate(value, from_locale, to_locale)
+      # should return translated value
+      "test #{value}"          
+    end
+            
+  end
+
+
+== Migrations
+
+Globalize3 Translator uses extra boolean fields in translations table
+to track automatic translations (with suffix '_auto_translated').
+
+Globalize3 standard method "create_translation_table!" 
+automatically adds <name>_auto_translated fields so you don't have to
+worry about that for new tables.
+
+If you want to add auto translated fields to existing translations
+table, you should do it manually in migration.
+
+Example:
+
+  add_column :post_translations, :title_auto_translated, :boolean
+
+
+== Patches, fixes
+
+Please send all patches or fixes as github pull requests. 
+Preferably with tests.
+
+
+Copyright (c) 2010 Laurynas Butkus, released under the MIT license

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'lib/globalize/translator/version'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the globalize3_translator plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the globalize3_translator plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Globalize3Translator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Build gem'
+task :build do
+  system "gem build globalize3_translator.gemspec"
+end
+ 
+desc 'Release gem'
+task :release => :build do
+  system "gem push globalize3_translator-#{Globalize::Translator::VERSION}.gem"
+end

data/lib/globalize/patches/active_record/adapter.rb

@@ -0,0 +1,12 @@
+require 'globalize/active_record/adapter'
+
+Globalize::ActiveRecord::Adapter.class_eval do
+
+  def save_translations_with_auto!
+    record.globalize_translator.translate
+    save_translations_without_auto!
+  end  
+  
+  alias_method_chain :save_translations!, :auto
+  
+end

data/lib/globalize/patches/active_record/class_methods.rb

@@ -0,0 +1,11 @@
+require 'globalize/active_record/class_methods'
+
+Globalize::ActiveRecord::ClassMethods.class_eval do
+  def translation_class_with_auto
+    klass = translation_class_without_auto
+    klass.handle_auto_translated_attributes(translated_attribute_names)    
+    klass
+  end
+  
+  alias_method_chain :translation_class, :auto
+end

data/lib/globalize/patches/active_record/instance_methods.rb

@@ -0,0 +1,9 @@
+require 'globalize/active_record/instance_methods'
+
+Globalize::ActiveRecord::InstanceMethods.class_eval do
+
+  def globalize_translator
+    @globalize_translator||= Globalize::Translator::Adapter.new(self)
+  end
+
+end

data/lib/globalize/patches/active_record/migration.rb

@@ -0,0 +1,17 @@
+require 'globalize/active_record/migration'
+
+Globalize::ActiveRecord::Migration::Migrator.class_eval do
+
+  def create_translation_table_with_auto
+    create_translation_table_without_auto
+    
+    # add auto translation indicators
+    fields.each do |name, type|
+      field_name = "#{name}_auto_translated"
+      connection.add_column translations_table_name, field_name, :boolean  
+    end    
+  end
+
+  alias_method_chain :create_translation_table, :auto
+
+end

data/lib/globalize/patches/active_record/translation.rb

@@ -0,0 +1,48 @@
+require 'globalize/active_record/translation'
+
+Globalize::ActiveRecord::Translation.class_eval do
+
+  class << self
+    cattr_accessor :auto_attributes
+    
+    def handle_auto_translated_attributes(attribute_names)
+      self.auto_attributes = attribute_names
+      self.auto_attributes.each { |attr_name| self.auto_translated_attr_accessor(attr_name) }
+    end
+    
+    def auto_translated_attr_accessor(name)
+      define_method(name) do |*args|
+        read_auto_translated_attribute(name)
+      end
+    end
+  end
+  
+  def read_auto_translated_attribute(name)
+    val = read_attribute(name)
+    
+    if val && val.auto_translated.nil?
+      val.auto_translated = read_attribute(auto_marker_name(name))
+    end
+    
+    val
+  end
+  
+  def write_attribute(attr_name, value)
+    if self.class.auto_attributes.include?(attr_name.to_sym)
+      marker_name = auto_marker_name(attr_name)
+      
+      if value
+        self[marker_name] = value.auto_translated?
+      else
+        self[marker_name] = nil
+      end
+    end
+    
+    super
+  end
+  
+  def auto_marker_name(field_name)
+    "#{field_name}_auto_translated"
+  end
+  
+end

data/lib/globalize/patches/core_ext/string.rb

@@ -0,0 +1,7 @@
+class String
+  attr_accessor :auto_translated
+  
+  def auto_translated?
+    auto_translated ? true : false
+  end
+end

data/lib/globalize/translator.rb

@@ -0,0 +1,38 @@
+require 'globalize/patches/core_ext/string'
+require 'globalize/patches/active_record/migration'
+require 'globalize/patches/active_record/class_methods'
+require 'globalize/patches/active_record/instance_methods'
+require 'globalize/patches/active_record/adapter'
+require 'globalize/patches/active_record/translation'
+require 'globalize/translator/version'
+require 'globalize/translator/configuration'
+require 'globalize/translator/backends/abstract'
+require 'globalize/translator/backends/rtranslate'
+
+module Globalize
+  module Translator
+    autoload :Adapter,         'globalize/translator/adapter'
+    
+    class << self
+      attr_accessor :backend
+      
+      def configure
+        yield(config)
+      end
+      
+      def config
+        @config||= Configuration.new        
+      end
+      
+      def backend
+        @backend||= config.backend.new
+      end
+      
+      def translatable_locales
+        config.locales || I18n.available_locales
+      end
+      
+    end
+    
+  end
+end

data/lib/globalize/translator/adapter.rb

@@ -0,0 +1,58 @@
+module Globalize
+  module Translator
+    class Adapter
+      attr_reader :record
+
+      delegate :globalize,              :to => :record
+      delegate :stash,                  :to => :globalize
+      delegate :backend,                :to => :translator
+      delegate :translatable_locales,   :to => :translator
+            
+      def initialize(record)
+        @record     = record
+      end
+      
+      def translate
+        attrs = stash.values.collect(&:keys).sum.uniq
+        attrs.each { |name| translate_attribute(name) }        
+      end
+      
+      def translate_attribute(name)
+        from_locale = get_source_locale(name)
+        from_value  = stash.read(from_locale, name)
+        
+        translatable_locales.each do |locale|
+          next unless translate?(locale, name)
+          
+          value = backend.translate(from_value, from_locale, locale)
+          
+          unless value.nil?
+            stash.write(locale, name, value)
+            value.auto_translated = true
+          end
+        end   
+      end
+      
+      protected
+
+      def manual_in_stash?(locale, name)
+        value = stash.read(locale, name)
+        !value.nil? && !value.auto_translated?
+      end
+
+      def translate?(locale, name)
+        !manual_in_stash?(locale, name)
+      end
+      
+      def get_source_locale(name)
+        locales = stash.keys.select { |locale| manual_in_stash?(locale, name) }
+        locales.include?(I18n.default_locale) ? I18n.default_locale : locales.first
+      end
+      
+      def translator
+        Translator
+      end
+      
+    end
+  end
+end

data/lib/globalize/translator/backends/abstract.rb

@@ -0,0 +1,16 @@
+module Globalize
+  module Translator
+    module Backends
+      
+      class Abstract
+        
+        def translate(value, from_locale, to_locale)
+          # override in derived class
+          raise "must override in derived class"
+        end
+
+      end
+      
+    end
+  end
+end

data/lib/globalize/translator/backends/rtranslate.rb

@@ -0,0 +1,17 @@
+require 'rtranslate'
+
+module Globalize
+  module Translator
+    module Backends
+      
+      class RTranslate < Abstract
+
+        def translate(value, from_locale, to_locale)
+          Translate.t(value, from_locale.to_s, to_locale.to_s)
+        end
+                
+      end
+      
+    end
+  end
+end

data/lib/globalize/translator/configuration.rb

@@ -0,0 +1,17 @@
+module Globalize
+  module Translator
+    class Configuration
+    
+      attr_accessor :backend
+      attr_accessor :locales
+      
+      def initialize
+        
+        # default configuration
+        self.backend = Backends::RTranslate
+        
+      end
+      
+    end
+  end
+end

data/lib/globalize/translator/version.rb

@@ -0,0 +1,5 @@
+module Globalize
+  module Translator
+    VERSION = '0.0.2'    
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: globalize3_translator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Laurynas Butkus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-10 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7712042
+        segments: 
+        - 3
+        - 0
+        - 0
+        - rc
+        version: 3.0.0.rc
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: globalize3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 0
+        - 7
+        version: 0.0.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sishen-rtranslate
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Globalize3 auto-translator using Google Translate (or any other backend).
+email: laurynas.butkus@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/globalize/patches/core_ext/string.rb
+- lib/globalize/patches/active_record/adapter.rb
+- lib/globalize/patches/active_record/migration.rb
+- lib/globalize/patches/active_record/class_methods.rb
+- lib/globalize/patches/active_record/instance_methods.rb
+- lib/globalize/patches/active_record/translation.rb
+- lib/globalize/translator.rb
+- lib/globalize/translator/adapter.rb
+- lib/globalize/translator/version.rb
+- lib/globalize/translator/configuration.rb
+- lib/globalize/translator/backends/rtranslate.rb
+- lib/globalize/translator/backends/abstract.rb
+- README.rdoc
+- Rakefile
+- MIT-LICENSE
+- Gemfile.lock
+- Gemfile
+has_rdoc: true
+homepage: http://github.com/laurynas/globalize3_translator
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Globalize3 auto-translator using Google Translate (or any other backend)
+test_files: []
+