russian 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Yaroslav Markin
+
+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.textile

@@ -0,0 +1,44 @@
+h1. Russian
+
+Russian language support for Ruby and Rails, using I18n library (also shipped in Rails 2.2+).
+
+Поддержка русского языка для Ruby и Rails при помощи библиотеки I18n (также входит в состав Rails 2.2+)
+
+h3. If you don't speak Russian
+
+This code may still be useful for you. You can learn how to create custom backends for I18n and how to 
+provide support of "standalone" (as defined in "Unicode CLDR":http://unicode.org/cldr/) month names with I18n and Rails, and also how to add dead simple pluralization rules into your translation tables.
+
+h1. Что это
+
+Russian -- это библиотека для полноценной поддержки русского языка (форматирование даты и времени, плюрализация, локализация в целом) для Ruby и Ruby on Rails.
+
+Для этого используется библиотека I18n, несколько хаков поверх нее и файлы переводов.
+
+I18n входит в состав Ruby on Rails начиная с версии 2.2, но на момент публикации нормальная поддержка русского языка отсутствовала.
+
+h1. Установка
+
+TODO: пути на GitHub, публикация на RubyForge
+
+* gem rubyforge
+* gem github
+
+h2. Ruby on Rails
+
+* gem
+* plugin github
+
+h1. Использование
+
+* Прозрачное: локаль по умолчанию, свой бекенд (недеструктивный)
+* Хелперы Russian.*
+
+h2. Ruby on Rails
+
+* Стандартный язык для I18n
+* Перегрузка хелперов
+
+h1. Автор
+
+Ярослав Маркин ("yaroslav@markin.net":mailto:yaroslav@markin.net)

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'rubygems/specification'
+require 'date'
+
+GEM = "russian"
+GEM_VERSION = "0.0.1"
+AUTHOR = "Yaroslav Markin"
+EMAIL = "yaroslav@markin.net"
+HOMEPAGE = "http://github.com/yaroslav/russian/"
+SUMMARY = "Russian language support for Ruby and Rails"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.textile", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.textile Rakefile TODO init.rb) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :default => :spec
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1,11 @@
+TODO
+====
+* docs and README (english - brief, full russian doc)
+* check Unicode CLDR to ensure all datetime formats are correct
+* refactor Advanced backend localize method (looks ugly)
+
+Questionable
+============
+* integration spec coverage for actionview locale
+* integration spec coverage for activerecord locale
+* integration spec coverage for activesupport locale

data/init.rb

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

data/lib/russian.rb

@@ -0,0 +1,91 @@
+$KCODE='u'
+
+$:.push File.join(File.dirname(__FILE__), 'russian')
+$:.push File.join(File.dirname(__FILE__), 'vendor', 'i18n', 'lib')
+
+require 'i18n' unless defined?(I18n)
+
+require 'backend/advanced'
+require 'action_view_ext/helpers/date_helper'
+require 'active_record_ext/custom_error_message'
+
+module Russian
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+  
+  # Russian locale
+  LOCALE = :'ru-RU'
+
+  class << self
+    # 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
+      locale_files.each { |file| I18n.backend.load_translations(file) }
+    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, "вещь", "вещи", "вещей")
+    def pluralize(n, *variants)
+      variants_hash = pluralization_variants_to_hash(*variants)
+      I18n.backend.send(:pluralize, LOCALE, variants_hash, n)
+    end
+    
+    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 (3 entries) to a Hash that can be used
+      # with I18n pluralization.
+      def pluralization_variants_to_hash(*variants)
+        raise ArgumentError, "Must have at least 3 variants for pluralization" if variants.size < 3
+        {
+          :one => variants[0],
+          :few => variants[1],
+          :many => variants[2],
+          :other => variants[1]
+        }
+      end
+  end
+end
+
+Russian.init_i18n

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

@@ -0,0 +1,90 @@
+# Replaces Rails select_month helper and translated_month_names 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.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.
+        #
+        # ==== 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.
+          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,33 @@
+if defined?(ActiveRecord::Errors)
+  # The following is taken from custom_error_message plugin by David Easley
+  # (http://rubyforge.org/projects/custom-err-msg/)
+  module ActiveRecord
+    class Errors
+  
+      # 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'
+      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/backend/advanced.rb

@@ -0,0 +1,104 @@
+module I18n
+  module Backend
+    # Advanced I18n backend.
+    #
+    # Extends <tt>Simple</tt> backend. Allows usage of <tt>standalone_*</tt> keys
+    # for DateTime localization and usage of user-defined <tt>Proc</tt> (lambda) pluralization
+    # methods in translation tables.
+    class Advanced < Simple
+      LOCALIZE_ABBR_MONTH_NAMES_MATCH = /(%d|%e)?(\s*)(%b)/
+      LOCALIZE_MONTH_NAMES_MATCH = /(%d|%e)?(\s*)(%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>).
+      #
+      # Note that it differs from <tt>localize</tt> in <tt>Simple</tt> backend by checking for 
+      # <tt>standalone_*</tt> month name/day name keys in translation and using them if available.
+      def localize(locale, object, format = :default)
+        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 ? $1 + $2 + translate(locale, :"date.abbr_month_names")[object.mon] : 
+              $2 + translate(locale, :"date.standalone_abbr_month_names")[object.mon]
+          end
+        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 ? $1 + $2 + translate(locale, :"date.month_names")[object.mon] : 
+              $2 + translate(locale, :"date.standalone_month_names")[object.mon]
+          end
+        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
+        # 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-US', {
+        #     :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