synergy_russian 0.2.8

data/TODO

@@ -0,0 +1,10 @@
+TODO
+====
+* RDoc
+* check Unicode CLDR to ensure all datetime formats are correct
+* refactor Advanced backend localize method (looks ugly)
+* refactor DateTimeSelector#translated_month_names
+
+Questionable
+============
+* integration specs for rails hacks

data/init.rb

@@ -0,0 +1,3 @@
+# Rails plugin init
+require 'russian'
+

data/lib/russian.rb

@@ -0,0 +1,118 @@
+# -*- encoding: utf-8 -*- 
+
+if RUBY_VERSION < "1.9"
+  $KCODE = 'u'
+end
+
+$:.push File.join(File.dirname(__FILE__), 'russian')
+require 'transliteration'
+
+# I18n require
+unless defined?(I18n)
+  $:.push File.join(File.dirname(__FILE__), 'vendor', 'i18n', 'lib')
+  require 'i18n'
+end
+# Advanced backend
+require 'backend/advanced'
+
+# Rails hacks
+require 'active_record_ext/custom_error_message' if defined?(ActiveRecord)
+if defined?(ActionView::Helpers)
+  require 'action_view_ext/helpers/date_helper' 
+end
+require 'active_support_ext/parameterize' if defined?(ActiveSupport::Inflector)
+
+module Russian
+  extend self
+  
+  module VERSION
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 7
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+  
+  # Russian locale
+  LOCALE = :'ru'
+
+  # Russian locale
+  def locale
+    LOCALE
+  end
+  
+  # Returns custom backend class for usage with Russian library
+  # 
+  # See I18n::Backend
+  def i18n_backend_class
+    I18n::Backend::Advanced
+  end
+  
+  # Init Russian i18n: set custom backend, set default locale to Russian locale, load all translations
+  # shipped with library.
+  def init_i18n
+    I18n.backend = Russian.i18n_backend_class.new
+    I18n.default_locale = LOCALE
+    I18n.load_path.unshift(*locale_files)
+  end
+
+  # See I18n::translate
+  def translate(key, options = {})
+    I18n.translate(key, options.merge({ :locale => LOCALE }))
+  end        
+  alias :t :translate
+  
+  # See I18n::localize
+  def localize(object, options = {})
+    I18n.localize(object, options.merge({ :locale => LOCALE }))
+  end
+  alias :l :localize
+  
+  # strftime() proxy with Russian localization
+  def strftime(object, format = :default)
+    localize(object, { :format => format })
+  end
+  
+  # Simple pluralization proxy
+  #
+  # Usage: 
+  #   Russian.pluralize(1, "вещь", "вещи", "вещей")
+  #   Russian.pluralize(3.14, "вещь", "вещи", "вещей", "вещи")
+  def pluralize(n, *variants)
+    raise ArgumentError, "Must have a Numeric as a first parameter" unless n.is_a?(Numeric)
+    raise ArgumentError, "Must have at least 3 variants for pluralization" if variants.size < 3
+    raise ArgumentError, "Must have at least 4 variants for pluralization" if (variants.size < 4 && n != n.round)
+    variants_hash = pluralization_variants_to_hash(*variants)
+    I18n.backend.send(:pluralize, LOCALE, variants_hash, n)
+  end
+  alias :p :pluralize
+
+  # Transliteration for russian language
+  #
+  # Usage:
+  #  Russian.translit("рубин")
+  #  Russian.transliterate("рубин")
+  def transliterate(str)
+    Russian::Transliteration.transliterate(str)
+  end
+  alias :translit :transliterate
+  
+  protected
+    # Returns all locale files shipped with library
+    def locale_files
+      Dir[File.join(File.dirname(__FILE__), "russian", "locale", "**/*")]
+    end
+    
+    # Converts an array of pluralization variants to a Hash that can be used
+    # with I18n pluralization.
+    def pluralization_variants_to_hash(*variants)
+      {
+        :one => variants[0],
+        :few => variants[1],
+        :many => variants[2],
+        :other => variants[3]
+      }
+    end
+end
+
+Russian.init_i18n

data/lib/russian/action_view_ext/helpers/date_helper.rb

@@ -0,0 +1,112 @@
+# -*- encoding: utf-8 -*- 
+
+# Заменяет хелпер Rails <tt>select_month</tt> и метод <tt>translated_month_names</tt> 
+# для поддержки функционала "отдельностоящих имен месяцев".
+#
+# Теперь можно использовать и полные, и сокращенные название месяцев в двух вариантах -- контекстном
+# (по умолчанию) и отдельностоящем (если в текущем языке есть соответствующие переводы).
+# Теперь хелперы поддерживают ключ <tt>:use_standalone_month_names</tt>, хелпер <tt>select_month</tt> 
+# устанавливает его по умолчанию.
+# Отдельностоящие имена месяцев также используютс когда указан ключ <tt>:discard_day</tt>.
+#
+#
+# Replaces Rails <tt>select_month</tt> helper and <tt>translated_month_names</tt> private method to provide
+# "standalone month names" feature. 
+#
+# It is now possible to use both abbreviated and full month names in two variants (if current locale provides them).
+# All date helpers support <tt>:use_standalone_month_names</tt> key now, <tt>select_month</tt> helper sets 
+# it to true by default.
+# Standalone month names are also used when <tt>:discard_day</tt> key is provided.
+if defined?(ActionView::Helpers::DateTimeSelector) && ActionView::Helpers::DateTimeSelector.private_instance_methods.map(&:to_sym).include?(:translated_month_names)
+  module ActionView
+    module Helpers
+      module DateHelper
+        # Returns a select tag with options for each of the months January through December with the current month
+        # selected. The month names are presented as keys (what's shown to the user) and the month numbers (1-12) are
+        # used as values (what's submitted to the server). It's also possible to use month numbers for the presentation
+        # instead of names -- set the <tt>:use_month_numbers</tt> key in +options+ to true for this to happen. If you
+        # want both numbers and names, set the <tt>:add_month_numbers</tt> key in +options+ to true. If you would prefer
+        # to show month names as abbreviations, set the <tt>:use_short_month</tt> key in +options+ to true. If you want
+        # to use your own month names, set the <tt>:use_month_names</tt> key in +options+ to an array of 12 month names. 
+        # You can also choose if you want to use i18n standalone month names or default month names -- you can
+        # force standalone month names usage by using <tt>:use_standalone_month_names</tt> key.
+        # Override the field name using the <tt>:field_name</tt> option, 'month' by default.
+        #
+        #
+        # Также поддерживается ключ <tt>:use_standalone_month_names</tt> для явного указания о необходимости
+        # использования отдельностоящих имен месяцев, если текущий язык их поддерживает.
+        #
+        #
+        # ==== Examples
+        #   # Generates a select field for months that defaults to the current month that
+        #   # will use keys like "January", "March".
+        #   select_month(Date.today)
+        #
+        #   # Generates a select field for months that defaults to the current month that
+        #   # is named "start" rather than "month"
+        #   select_month(Date.today, :field_name => 'start')
+        #
+        #   # Generates a select field for months that defaults to the current month that
+        #   # will use keys like "1", "3".
+        #   select_month(Date.today, :use_month_numbers => true)
+        #
+        #   # Generates a select field for months that defaults to the current month that
+        #   # will use keys like "1 - January", "3 - March".
+        #   select_month(Date.today, :add_month_numbers => true)
+        #
+        #   # Generates a select field for months that defaults to the current month that
+        #   # will use keys like "Jan", "Mar".
+        #   select_month(Date.today, :use_short_month => true)
+        #
+        #   # Generates a select field for months that defaults to the current month that
+        #   # will use keys like "Januar", "Marts."
+        #   select_month(Date.today, :use_month_names => %w(Januar Februar Marts ...))
+        #
+        def select_month(date, options = {}, html_options = {})
+          DateTimeSelector.new(date, options.merge(:use_standalone_month_names => true), html_options).select_month
+        end
+      end
+      
+      class DateTimeSelector #:nodoc:
+        private
+          # Returns translated month names
+          #  => [nil, "January", "February", "March",
+          #           "April", "May", "June", "July",
+          #           "August", "September", "October",
+          #           "November", "December"]
+          #
+          # If :use_short_month option is set
+          #  => [nil, "Jan", "Feb", "Mar", "Apr", "May", "Jun",
+          #           "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
+          #
+          # Also looks up if <tt>:discard_day</tt> or <tt>:use_standalone_month_names</tt> option is set
+          # and uses i18n standalone month names if so.
+          #
+          #
+          # Также в зависимости от использования ключей <tt>:discard_day</tt> или <tt>:use_standalone_month_names</tt>
+          # убеждается, есть ли соотвествующие переводы в текущем языке и использует "отдельностоящие" названия
+          # месяцев по необходимости
+          def translated_month_names
+            begin
+              if @options[:use_short_month]
+                if (@options[:discard_day] || @options[:use_standalone_month_names]) && I18n.translate(:'date.standalone_abbr_month_names')
+                  key = :'date.standalone_abbr_month_names'
+                else
+                  key = :'date.abbr_month_names'
+                end
+              else
+                if (@options[:discard_day] || @options[:use_standalone_month_names]) && I18n.translate(:'date.standalone_month_names')
+                  key = :'date.standalone_month_names'
+                else
+                  key = :'date.month_names'
+                end
+              end
+              
+              I18n.translate(key, :locale => @options[:locale])
+            end
+          end
+          
+      end
+    end
+  end
+end # if defined?

data/lib/russian/active_record_ext/custom_error_message.rb

@@ -0,0 +1,163 @@
+# -*- encoding: utf-8 -*- 
+
+if defined?(ActiveRecord::Error) # Rails 2.3.4+
+  module ActiveRecord
+    class Error
+      protected
+        if instance_methods.map(&:to_sym).include?(:default_options) # Rails 2.3.5+
+          # Redefine the ActiveRecord::Error::generate_full_message method:
+          #  Returns all the full error messages in an array. 'Base' messages are handled as usual.
+          #  Non-base messages are prefixed with the attribute name as usual UNLESS they begin with '^'
+          #  in which case the attribute name is omitted.
+          #  E.g. validates_acceptance_of :accepted_terms, :message => '^Please accept the terms of service'
+          #
+          #
+          # Переопределяет метод ActiveRecord::Error::generate_full_message. Сообщения об ошибках для атрибутов
+          # теперь не имеют префикса с названием атрибута если в сообщении об ошибке первым символом указан "^".
+          #
+          # Так, например,
+          # 
+          #   validates_acceptance_of :accepted_terms, :message => 'нужно принять соглашение'
+          # 
+          # даст сообщение
+          # 
+          #   Accepted terms нужно принять соглашение
+          # 
+          # однако,
+          # 
+          #   validates_acceptance_of :accepted_terms, :message => '^Нужно принять соглашение'
+          # 
+          # даст сообщение
+          # 
+          #   Нужно принять соглашение
+          def generate_full_message(options = {})
+            keys = [
+              :"full_messages.#{@message}",
+              :'full_messages.format',
+              '%{attribute} %{message}'
+            ]
+
+            if self.message.is_a?(String) && self.message =~ /^\^/
+              ActiveSupport::Deprecation.warn("Using '^' hack for ActiveRecord error messages has been deprecated. Please use errors.full_messages.format I18n key for formatting")
+
+              options[:full_message] = self.message[1..-1]
+
+              keys = [
+                :"full_messages.#{@message}",
+                '%{full_message}'
+              ]
+            else
+              keys = [
+                :"full_messages.#{@message}",
+                :'full_messages.format',
+                '%{attribute} %{message}'
+              ]
+            end
+
+            options.merge!(:default => keys, :message => self.message)
+
+            I18n.translate(keys.shift, options)
+          end
+        else # Rails 2.3.4
+          # Redefine the ActiveRecord::Error::generate_full_message method:
+          #  Returns all the full error messages in an array. 'Base' messages are handled as usual.
+          #  Non-base messages are prefixed with the attribute name as usual UNLESS they begin with '^'
+          #  in which case the attribute name is omitted.
+          #  E.g. validates_acceptance_of :accepted_terms, :message => '^Please accept the terms of service'
+          #
+          #
+          # Переопределяет метод ActiveRecord::Error::generate_full_message. Сообщения об ошибках для атрибутов
+          # теперь не имеют префикса с названием атрибута если в сообщении об ошибке первым символом указан "^".
+          #
+          # Так, например,
+          # 
+          #   validates_acceptance_of :accepted_terms, :message => 'нужно принять соглашение'
+          # 
+          # даст сообщение
+          # 
+          #   Accepted terms нужно принять соглашение
+          # 
+          # однако,
+          # 
+          #   validates_acceptance_of :accepted_terms, :message => '^Нужно принять соглашение'
+          # 
+          # даст сообщение
+          # 
+          #   Нужно принять соглашение
+          def generate_full_message(message, options = {})
+            options.reverse_merge! :message => self.message,
+                                   :model => @base.class.human_name,
+                                   :attribute => @base.class.human_attribute_name(attribute.to_s),
+                                   :value => value
+          
+            key = :"full_messages.#{@message}"
+            defaults = [:'full_messages.format', '%{attribute} %{message}']
+          
+            if options[:message].is_a?(String) && options[:message] =~ /^\^/
+              ActiveSupport::Deprecation.warn("Using '^' hack for ActiveRecord error messages has been deprecated. Please use errors.full_messages.format I18n key for formatting")
+
+              options[:full_message] = options[:message][1..-1]
+              defaults = [:"full_messages.#{@message}.format", '%{full_message}']
+            end
+            
+            I18n.t(key, options.merge(:default => defaults, :scope => [:activerecord, :errors]))
+          end
+        end
+    end
+  end
+
+else # Rails 2.3.3-
+  module ActiveRecord
+    class Errors
+      # DEPRECATED as of Rails 2.3.4
+      #
+      # The following is taken from custom_error_message plugin by David Easley
+      # (http://rubyforge.org/projects/custom-err-msg/)
+      #
+      # Redefine the ActiveRecord::Errors::full_messages method:
+      #  Returns all the full error messages in an array. 'Base' messages are handled as usual.
+      #  Non-base messages are prefixed with the attribute name as usual UNLESS they begin with '^'
+      #  in which case the attribute name is omitted.
+      #  E.g. validates_acceptance_of :accepted_terms, :message => '^Please accept the terms of service'
+      #
+      #
+      # Переопределяет метод ActiveRecord::Errors::full_messages. Сообщения об ошибках для атрибутов
+      # теперь не имеют префикса с названием атрибута если в сообщении об ошибке первым символом указан "^".
+      #
+      # Так, например,
+      # 
+      #   validates_acceptance_of :accepted_terms, :message => 'нужно принять соглашение'
+      # 
+      # даст сообщение
+      # 
+      #   Accepted terms нужно принять соглашение
+      # 
+      # однако,
+      # 
+      #   validates_acceptance_of :accepted_terms, :message => '^Нужно принять соглашение'
+      # 
+      # даст сообщение
+      # 
+      #   Нужно принять соглашение
+      def full_messages
+        full_messages = []
+
+        @errors.each_key do |attr|
+          @errors[attr].each do |msg|
+            next if msg.nil?
+
+            if attr == "base"
+              full_messages << msg
+            elsif msg =~ /^\^/
+              full_messages << msg[1..-1]
+            else
+              full_messages << @base.class.human_attribute_name(attr) + " " + msg
+            end
+          end
+        end
+
+        return full_messages
+      end
+    end
+  end
+end

data/lib/russian/active_support_ext/parameterize.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*- 
+
+module ActiveSupport
+  module Inflector
+    # Replaces special characters in a string so that it may be used as part of a 'pretty' URL.
+    # Transliterates all russian characters in string first, then passes it to ActiveSupport Inflector.
+    #
+    # Заменяет все спецсимволы в строке так, что результат может использоваться как часть "красивого" URL.
+    # От стандартного ActiveSupport Inflector отличается тем, что сначала производится транслитерация
+    # букв русского алфавита.
+    #
+    # ==== Examples
+    #
+    # class Person
+    #   def to_param
+    #     "#{id}-#{name.parameterize}"
+    #   end
+    # end
+    #
+    # @person = Person.find(1)
+    # # => #<Person id: 1, name: "Дональд Кнут">
+    #
+    # <%= link_to(@person.name, person_path %>
+    # # => <a href="/person/1-donald-knut">Дональд Кнут</a>
+    def parameterize_with_russian(string, sep = '-')
+      parameterize_without_russian(Russian::transliterate(string), sep)
+    end
+    alias_method :parameterize_without_russian, :parameterize
+    alias_method :parameterize, :parameterize_with_russian
+  end
+end

data/lib/russian/backend/advanced.rb

@@ -0,0 +1,134 @@
+# -*- encoding: utf-8 -*- 
+
+module I18n
+  module Backend
+    # "Продвинутый" бекэнд для I18n.
+    # 
+    # Наследует Simple бекэнд и полностью с ним совместим. Добаляет поддержку 
+    # для отдельностоящих/контекстных названий дней недели и месяцев.
+    # Также позволяет каждому языку использовать собственные правила плюрализации,
+    # объявленные как Proc (<tt>lambda</tt>).
+    # 
+    #
+    # Advanced I18n backend.
+    #
+    # Extends Simple backend. Allows usage of "standalone" keys
+    # for DateTime localization and usage of user-defined Proc (lambda) pluralization
+    # methods in translation tables.
+    class Advanced < Simple
+      LOCALIZE_ABBR_MONTH_NAMES_MATCH = /(%d|%e)(.*)(%b)/
+      LOCALIZE_MONTH_NAMES_MATCH = /(%d|%e)(.*)(%B)/
+      LOCALIZE_STANDALONE_ABBR_DAY_NAMES_MATCH = /^%a/
+      LOCALIZE_STANDALONE_DAY_NAMES_MATCH = /^%A/
+      
+      # Acts the same as +strftime+, but returns a localized version of the 
+      # formatted date string. Takes a key from the date/time formats 
+      # translations as a format argument (<em>e.g.</em>, <tt>:short</tt> in <tt>:'date.formats'</tt>).
+      #
+      #
+      # Метод отличается от <tt>localize</tt> в Simple бекэнде поддержкой 
+      # отдельностоящих/контекстных названий дней недели и месяцев.
+      #
+      #
+      # Note that it differs from <tt>localize</tt> in Simple< backend by checking for 
+      # "standalone" month name/day name keys in translation and using them if available.
+      #
+      # <tt>options</tt> parameter added for i18n-0.3 compliance.
+      def localize(locale, object, format = :default, options = nil)
+        raise ArgumentError, "Object must be a Date, DateTime or Time object. #{object.inspect} given." unless object.respond_to?(:strftime)
+        
+        type = object.respond_to?(:sec) ? 'time' : 'date'
+        # TODO only translate these if format is a String?
+        formats = translate(locale, :"#{type}.formats")
+        format = formats[format.to_sym] if formats && formats[format.to_sym]
+        # TODO raise exception unless format found?
+        format = format.to_s.dup
+
+        # TODO only translate these if the format string is actually present
+        # TODO check which format strings are present, then bulk translate then, then replace them
+
+        if lookup(locale, :"date.standalone_abbr_day_names")
+          format.gsub!(LOCALIZE_STANDALONE_ABBR_DAY_NAMES_MATCH, 
+            translate(locale, :"date.standalone_abbr_day_names")[object.wday])
+        end
+        format.gsub!(/%a/, translate(locale, :"date.abbr_day_names")[object.wday])
+        
+        if lookup(locale, :"date.standalone_day_names")
+          format.gsub!(LOCALIZE_STANDALONE_DAY_NAMES_MATCH, 
+            translate(locale, :"date.standalone_day_names")[object.wday])
+        end
+        format.gsub!(/%A/, translate(locale, :"date.day_names")[object.wday])
+
+        if lookup(locale, :"date.standalone_abbr_month_names")
+          format.gsub!(LOCALIZE_ABBR_MONTH_NAMES_MATCH) do
+            $1 + $2 + translate(locale, :"date.abbr_month_names")[object.mon]
+          end
+          format.gsub!(/%b/, translate(locale, :"date.standalone_abbr_month_names")[object.mon])
+        else
+          format.gsub!(/%b/, translate(locale, :"date.abbr_month_names")[object.mon])
+        end
+
+        if lookup(locale, :"date.standalone_month_names")
+          format.gsub!(LOCALIZE_MONTH_NAMES_MATCH) do
+            $1 + $2 + translate(locale, :"date.month_names")[object.mon]
+          end
+          format.gsub!(/%B/, translate(locale, :"date.standalone_month_names")[object.mon])
+        else
+          format.gsub!(/%B/, translate(locale, :"date.month_names")[object.mon])
+        end
+
+        format.gsub!(/%p/, translate(locale, :"time.#{object.hour < 12 ? :am : :pm}")) if object.respond_to? :hour
+        object.strftime(format)
+      end
+      
+      protected
+        # Использует правила плюрализации из таблицы переводов для языка (если присутствуют),
+        # иначе использует правило плюрализации по умолчанию (английский язык).
+        # 
+        # Пример задания правила в таблице переводов:
+        #
+        #   store_translations :'en', {
+        #     :pluralize => lambda { |n| n == 1 ? :one : :other }
+        #   }
+        # 
+        # Правило должно возвращать один из символов для таблицы переводов:
+        #   :zero, :one, :two, :few, :many, :other
+        #
+        #
+        # Picks a pluralization rule specified in translation tables for a language or
+        # uses default pluralization rules.
+        #
+        # This is how pluralization rules are defined in translation tables, English
+        # language for example:
+        #
+        #   store_translations :'en', {
+        #     :pluralize => lambda { |n| n == 1 ? :one : :other }
+        #   }
+        #
+        # Rule must return a symbol to use with pluralization, it must be one of:
+        #   :zero, :one, :two, :few, :many, :other
+        def pluralize(locale, entry, count)
+          return entry unless entry.is_a?(Hash) and count
+
+          key = :zero if count == 0 && entry.has_key?(:zero)
+          locale_pluralize = lookup(locale, :pluralize)
+          if locale_pluralize && locale_pluralize.respond_to?(:call)
+            key ||= locale_pluralize.call(count)
+          else
+            key ||= default_pluralizer(count)
+          end
+          raise InvalidPluralizationData.new(entry, count) unless entry.has_key?(key)
+
+          entry[key]
+        end
+        
+        # Default pluralizer, used if pluralization rule is not defined in translations.
+        #
+        # Uses English pluralization rules -- it will pick the first translation if count is not equal to 1
+        # and the second translation if it is equal to 1.
+        def default_pluralizer(count)
+          count == 1 ? :one : :other
+        end
+    end
+  end
+end