globalize 3.0.0

data/lib/globalize/active_record/translation.rb

@@ -0,0 +1,46 @@
+module Globalize
+  module ActiveRecord
+    class Translation < ::ActiveRecord::Base
+
+      attr_accessible :locale
+      validates :locale, :presence => true
+
+      class << self
+        # Sometimes ActiveRecord queries .table_exists? before the table name
+        # has even been set which results in catastrophic failure.
+        def table_exists?
+          table_name.present? && super
+        end
+
+        def with_locales(*locales)
+          # Avoid using "IN" with SQL queries when only using one locale.
+          locales = locales.flatten.map(&:to_s)
+          locales = locales.first if locales.one?
+          where :locale => locales
+        end
+        alias with_locale with_locales
+
+        def translated_locales
+          select('DISTINCT locale').order(:locale).map(&:locale)
+        end
+      end
+
+      def locale
+        _locale = read_attribute :locale
+        _locale.present? ? _locale.to_sym : _locale
+      end
+
+      def locale=(locale)
+        write_attribute :locale, locale.to_s
+      end
+    end
+  end
+end
+
+# Setting this will force polymorphic associations to subclassed objects
+# to use their table_name rather than the parent object's table name,
+# which will allow you to get their models back in a more appropriate
+# format.
+#
+# See http://www.ruby-forum.com/topic/159894 for details.
+Globalize::ActiveRecord::Translation.abstract_class = true

data/lib/globalize/interpolation.rb

@@ -0,0 +1,28 @@
+module Globalize
+  module Interpolation
+    def interpolate(name, model, args)
+      translation = model.read_attribute(name, {:locale => locale_from(args)})
+      try_interpolation translation, interpolation_args_from(args)
+    end
+
+    private
+
+    def interpolation_args_from(args)
+      args.detect {|a| a.is_a? Hash }
+    end
+
+    def locale_from(args)
+      args.detect {|a| !a.is_a? Hash }
+    end
+
+    def try_interpolation(translation,args)
+      if args
+        I18n.interpolate(translation,args)
+      else
+        translation
+      end
+    end
+
+    extend self
+  end
+end

data/lib/globalize/version.rb

@@ -0,0 +1,3 @@
+module Globalize
+  Version = '3.0.0'
+end

data/lib/globalize/versioning.rb

@@ -0,0 +1,5 @@
+module Globalize
+  module Versioning
+    autoload :PaperTrail, 'globalize/versioning/paper_trail'
+  end
+end

data/lib/globalize/versioning/paper_trail.rb

@@ -0,0 +1,41 @@
+require 'paper_trail'
+
+module Globalize
+  module Versioning
+    module PaperTrail
+      # At present this isn't used but we may use something similar in paper trail
+      # shortly, so leaving it around to reference easily.
+      #def versioned_columns
+        #super + self.class.translated_attribute_names
+      #end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  class << self
+    def has_paper_trail_with_globalize(*args)
+      has_paper_trail_without_globalize(*args)
+      include Globalize::Versioning::PaperTrail
+    end
+    alias_method_chain :has_paper_trail, :globalize
+  end
+end
+
+Version.class_eval do
+
+  before_save do |version|
+    version.locale = Globalize.locale.to_s
+  end
+
+  def self.locale_conditions_to_sql
+    "locale = '#{Globalize.locale.to_s}'"
+  end
+
+  scope :for_this_locale, lambda{ { :conditions => locale_conditions_to_sql } }
+
+  def sibling_versions_with_locales
+    sibling_versions_without_locales.for_this_locale
+  end
+  alias_method_chain :sibling_versions, :locales
+end

data/lib/i18n/missing_translations_log_handler.rb

@@ -0,0 +1,41 @@
+# A simple exception handler that behaves like the default exception handler
+# but additionally logs missing translations to a given log.
+#
+# Useful for identifying missing translations during testing.
+#
+# E.g.
+#
+#   require 'globalize/i18n/missing_translations_log_handler'
+#   I18n.missing_translations_logger = RAILS_DEFAULT_LOGGER
+#   I18n.exception_handler = :missing_translations_log_handler
+#
+# To set up a different log file:
+#
+#   logger = Logger.new("#{RAILS_ROOT}/log/missing_translations.log")
+#   I18n.missing_translations_logger = logger
+
+module I18n
+  @@missing_translations_logger = nil
+
+  class << self
+    def missing_translations_logger
+      @@missing_translations_logger ||= begin
+        require 'logger' unless defined?(Logger)
+        Logger.new(STDOUT)
+      end
+    end
+
+    def missing_translations_logger=(logger)
+      @@missing_translations_logger = logger
+    end
+
+    def missing_translations_log_handler(exception, locale, key, options)
+      if MissingTranslationData === exception
+        missing_translations_logger.warn(exception.message)
+        return exception.message
+      else
+        raise exception
+      end
+    end
+  end
+end

data/lib/i18n/missing_translations_raise_handler.rb

@@ -0,0 +1,25 @@
+# A simple exception handler that behaves like the default exception handler
+# but also raises on missing translations.
+#
+# Useful for identifying missing translations during testing.
+#
+# E.g.
+#
+#   require 'globalize/i18n/missing_translations_raise_handler'
+#   I18n.exception_handler = :missing_translations_raise_handler
+module I18n
+  class << self
+    def missing_translations_raise_handler(exception, locale, key, options)
+      raise exception
+    end
+  end
+end
+
+I18n.exception_handler = :missing_translations_raise_handler
+
+ActionView::Helpers::TranslationHelper.module_eval do
+  def translate(key, options = {})
+    I18n.translate(key, options)
+  end
+  alias :t :translate
+end

data/lib/patches/active_record/query_method.rb

@@ -0,0 +1,35 @@
+require 'active_record/attribute_methods/query'
+
+module ActiveRecord
+  module AttributeMethods
+    module Query
+      def query_attribute(attr_name)
+        unless value = read_attribute(attr_name)
+          false
+        else
+          column = self.class.columns_hash[attr_name]
+          if column.nil?
+            
+            # TODO submit a rails patch
+
+            # not sure what active_record tests say but i guess this should mean:
+            # call to_i and check zero? if the value is a Numeric or starts with
+            # a digit, so it can meaningfully be typecasted by to_i
+
+            # if Numeric === value || value !~ /[^0-9]/
+            if Numeric === value || value.to_s =~ /^[0-9]/
+              !value.to_i.zero?
+            else
+              return false if ActiveRecord::ConnectionAdapters::Column::FALSE_VALUES.include?(value)
+              !value.blank?
+            end
+          elsif column.number?
+            !value.zero?
+          else
+            !value.blank?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/patches/active_record/relation.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  class Relation
+    if ::ActiveRecord::VERSION::STRING >= "3.2.1"
+      def where_values_hash
+        _translations_table_name = klass.respond_to?(:translations_table_name) ? klass.translations_table_name : nil
+
+        equalities = with_default_scope.where_values.grep(Arel::Nodes::Equality).find_all { |node|
+          [table_name, _translations_table_name].compact.include? node.left.relation.name
+        }
+
+        Hash[equalities.map { |where| [where.left.name, where.right] }].with_indifferent_access
+      end
+    end
+  end
+end

data/lib/patches/active_record/uniqueness_validator.rb

@@ -0,0 +1,55 @@
+require 'active_record/validations/uniqueness.rb'
+
+ActiveRecord::Validations::UniquenessValidator.class_eval do
+  def validate_each_with_translations(record, attribute, value)
+    klass = record.class
+    if klass.translates? && klass.translated?(attribute)
+      if methods.include?(:build_relation) || respond_to?(:build_relation)
+        finder_class = klass.translation_class
+        table = finder_class.arel_table
+
+        relation = build_relation(finder_class, table, attribute, value).and(table[:locale].eq(Globalize.locale))
+        relation = relation.and(table[klass.reflect_on_association(:translations).foreign_key].not_eq(record.send(:id))) if record.persisted?
+
+  #      TODO: add scope with translated attributes
+        if options[:scope]
+          ActiveRecord::Base.logger.warn("WARNING: Globalize does not currently support `scope` option on uniqueness validation for translated attributes.")
+        end
+
+        if finder_class.unscoped.where(relation).exists?
+          record.errors.add(attribute, :taken, options.except(:case_sensitive, :scope).merge(:value => value))
+        end
+      else
+        finder_class = klass.translation_class
+        table = finder_class.unscoped
+
+        table_name   = finder_class.quoted_table_name
+
+        if value && klass.serialized_attributes.key?(attribute.to_s)
+          value = YAML.dump value
+        end
+
+        sql, params  = mount_sql_and_params(finder_class, table_name, attribute, value)
+
+        relation = table.where(sql, *params).where(:locale => Globalize.locale)
+
+        Array.wrap(options[:scope]).each do |scope_item|
+          scope_value = record.send(scope_item)
+          relation = relation.where(scope_item => scope_value)
+        end
+
+        if record.persisted?
+          fk = klass.reflect_on_association(:translations).options[:foreign_key]
+          relation = relation.where(finder_class.arel_table[fk].not_eq(record.send(:id)))
+        end
+
+        if relation.exists?
+          record.errors.add(attribute, :taken, options.except(:case_sensitive, :scope).merge(:value => value))
+        end
+      end
+    else
+      validate_each_without_translations(record, attribute, value)
+    end
+  end
+  alias_method_chain :validate_each, :translations
+end

data/lib/patches/active_record/xml_attribute_serializer.rb

@@ -0,0 +1,13 @@
+require 'active_record/serializers/xml_serializer'
+
+ActiveRecord::XmlSerializer::Attribute.class_eval do
+  def compute_type_with_translations
+    klass = @serializable.class
+    if klass.translates? && klass.translated_attribute_names.include?(name.to_sym)
+      :string
+    else
+      compute_type_without_translations
+    end
+  end
+  alias_method_chain :compute_type, :translations
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: globalize
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Sven Fuchs
+- Joshua Harvey
+- Clemens Kofler
+- John-Paul Bader
+- Tomasz Stachewicz
+- Philip Arndt
+- Chris Salzberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pathname_local
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_declarative
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails I18n de-facto standard library for ActiveRecord model/data translation.
+email: nobody@globalize-rails.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/globalize/active_record/act_macro.rb
+- lib/globalize/active_record/adapter.rb
+- lib/globalize/active_record/attributes.rb
+- lib/globalize/active_record/class_methods.rb
+- lib/globalize/active_record/exceptions.rb
+- lib/globalize/active_record/instance_methods.rb
+- lib/globalize/active_record/migration.rb
+- lib/globalize/active_record/translation.rb
+- lib/globalize/active_record.rb
+- lib/globalize/interpolation.rb
+- lib/globalize/version.rb
+- lib/globalize/versioning/paper_trail.rb
+- lib/globalize/versioning.rb
+- lib/globalize.rb
+- lib/i18n/missing_translations_log_handler.rb
+- lib/i18n/missing_translations_raise_handler.rb
+- lib/patches/active_record/query_method.rb
+- lib/patches/active_record/relation.rb
+- lib/patches/active_record/uniqueness_validator.rb
+- lib/patches/active_record/xml_attribute_serializer.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+homepage: https://github.com/globalize/globalize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.0
+signing_key: 
+specification_version: 4
+summary: Rails I18n de-facto standard library for ActiveRecord model/data translation
+test_files: []
+has_rdoc: