r18n-core 0.4.14 → 1.0.0

data/lib/r18n-core/filters.rb

@@ -41,7 +41,7 @@ module R18n
   #   end
   #
   #   i18n.filtered('_') #=> "This_content_will_be_processed_by_filter!"
-  # 
+  #
   # Use String class as type to add global filter for all translated strings:
   #
   #   R18n::Filters.add(String, :escape_html) do |content, config, params|
@@ -73,6 +73,11 @@ module R18n
   #   R18n::Filters.on(:no_space)
   #   i18n.filtered('_') #=> "This_content_will_be_processed_by_filter!"
   #   R18n::Filters.delete(:no_space)
+  #
+  # You can enabled/disabled filters only for special I18n object:
+  #
+  #   R18n::I18n.new('en', nil, :on_filters  => [:untranslated_html, :no_space],
+  #                             :off_filters => :untranslated )
   module Filters
     class << self
       # Hash of filter names to Filters.
@@ -90,33 +95,6 @@ module R18n
       # Hash of types to enabled passive and active filters.
       attr_accessor :enabled
 
-      # Process +value+ by filters in +enabled+.
-      def process(enabled, type, value, locale, path, params)
-        config = { :locale => locale, :path => path }
-
-        enabled[type].each do |filter|
-          value = filter.call(value, config, *params)
-        end
-
-        if value.is_a? String
-          value = TranslatedString.new(value, locale, path)
-          process_string(enabled, value, config, params)
-        else
-          value
-        end
-      end
-
-      # Process +value+ by global filters in +enabled+.
-      def process_string(enabled, value, config, params)
-        if config.is_a? String
-          config = { :locale => value.locale, :path => config }
-        end
-        enabled[String].each do |f|
-          value = f.call(value, config, *params)
-        end
-        value
-      end
-
       # Rebuild +active_enabled+ and +passive_enabled+ for +type+.
       def rebuild_enabled!(type)
         @passive_enabled[type] = []
@@ -138,10 +116,10 @@ module R18n
       # Add new filter for +type+ with +name+ and return filter object. You
       # can use String class as +type+ to add global filter for all translated
       # string.
-      # 
+      #
       # Filter content will be sent to +block+ as first argument, struct with
       # config as second and filters parameters will be in next arguments.
-      # 
+      #
       # Options:
       # * +position+ – change order on processing several filters for same type.
       #    Note that passive filters will be always run before active.
@@ -174,6 +152,7 @@ module R18n
           rebuild_enabled! type
         end
 
+        @new_filter_listener.call(filter) if @new_filter_listener
         filter
       end
 
@@ -206,6 +185,15 @@ module R18n
         filter.enabled = true
         filter.types.each { |type| rebuild_enabled! type }
       end
+
+      # Return filters, which be added inside +block+.
+      def listen(&block)
+        filters = []
+        @new_filter_listener = proc { |i| filters << i }
+        yield
+        @new_filter_listener = nil
+        filters
+      end
     end
 
     Filters.defined         = {}
@@ -239,7 +227,11 @@ module R18n
   Filters.add(String, :variables) do |content, config, *params|
     content = content.clone
     params.each_with_index do |param, i|
-      content.gsub! "%#{i+1}", config[:locale].localize(param)
+      param = config[:locale].localize(param)
+      if defined? ActiveSupport::SafeBuffer
+        param = ActiveSupport::SafeBuffer.new + param
+      end
+      content.gsub! "%#{i+1}", param
     end
     content
   end
@@ -248,9 +240,21 @@ module R18n
     "#{translated}[#{untranslated}]"
   end
 
+  Filters.add(Untranslated, :untranslated_bash) do |v, c, transl, untransl|
+    "#{transl}\e[0;31m[#{untransl}]\e[0m"
+  end
+  Filters.off(:untranslated_bash)
+
   Filters.add(Untranslated, :untranslated_html) do |v, c, transl, untransl|
-    Utils.escape_html(transl) <<
-      '<span style="color: red">' << Utils.escape_html(untransl) << '</span>'
+    if defined? ActiveSupport::SafeBuffer
+      transl <<
+        '<span style="color: red">['.html_safe <<
+          untransl <<
+        ']</span>'.html_safe
+    else
+      Utils.escape_html(transl) <<
+      '<span style="color: red">[' << Utils.escape_html(untransl) << ']</span>'
+    end
   end
   Filters.off(:untranslated_html)
 
@@ -275,9 +279,9 @@ module R18n
   end
   Filters.off(:global_escape_html)
 
-  Filters.add('markdown', :maruku, :passive => true) do |content, config|
-    require 'maruku'
-    ::Maruku.new(content).to_html
+  Filters.add('markdown', :kramdown, :passive => true) do |content, config|
+    require 'kramdown'
+    ::Kramdown::Document.new(content).to_html
   end
 
   Filters.add('textile', :redcloth, :passive => true) do |content, config|

data/lib/r18n-core/i18n.rb

@@ -114,11 +114,6 @@ module R18n
       locales.map! { |i| i[0] }
     end
 
-    # Return Array of locales with available translations.
-    def self.available_locales(places)
-      convert_places(places).map { |i| i.available }.flatten.uniq
-    end
-
     # Load default loader for elements in +places+ with only constructor
     # argument.
     def self.convert_places(places)
@@ -147,7 +142,7 @@ module R18n
     #
     # +Locales+ must be a locale code (RFC 3066) or array, ordered by priority.
     # +Translation_places+ must be a string with path or array.
-    def initialize(locales, translation_places = nil)
+    def initialize(locales, translation_places = nil, opts = {})
       locales = Array(locales)
 
       if not locales.empty? and Locale.exists? locales.first
@@ -172,6 +167,12 @@ module R18n
 
       @translation_places = self.class.convert_places(@original_places)
 
+      if opts[:on_filters] or opts[:off_filters]
+        @filters = CustomFilterList.new(opts[:on_filters], opts[:off_filters])
+      else
+        @filters = GlobalFilterList.instance
+      end
+
       key = translation_cache_key
       if R18n.cache.has_key? key
         @locale, @translation = *R18n.cache[key]
@@ -180,13 +181,20 @@ module R18n
       end
     end
 
+    # Return custom filters list
+    def filter_list
+      @filters
+    end
+
     # Return unique key for current locales in translation and places.
     def translation_cache_key
       @available_codes ||= @translation_places.inject([]) { |all, i|
         all + i.available }.uniq.map { |i| i.code.downcase }
       (@locales_codes & @available_codes).join(',') + '@' +
+        @filters.hash.to_s +
         R18n.default_loader.hash.to_s +
-        @translation_places.hash.to_s + R18n.extension_places.hash.to_s
+        @translation_places.hash.to_s +
+        R18n.extension_places.hash.to_s
     end
 
     # Reload translations.
@@ -218,7 +226,7 @@ module R18n
         end
       end
 
-      @translation = Translation.new @locale
+      @translation = Translation.new(@locale, '', :filters => @filters)
       @locales.each do |locale|
         loaded = false
         available_in_places.each do |place, available|
@@ -241,7 +249,7 @@ module R18n
 
     # Return Array of locales with available translations.
     def available_locales
-      @available ||= self.class.available_locales(@translation_places)
+      @available ||= R18n.available_locales(@translation_places)
     end
 
     # Convert +object+ to String, according to the rules of the current locale.

data/lib/r18n-core/locale.rb

@@ -38,7 +38,7 @@ module R18n
   #
   # Get Russian locale and print it information
   #
-  #   ru = R18n::Locale.load('ru')
+  #   ru = R18n.locale('ru')
   #   ru.title #=> "Русский"
   #   ru.code  #=> "ru"
   #   ru.ltr?  #=> true
@@ -106,7 +106,9 @@ module R18n
 
     # Locale RFC 3066 code.
     def code
-      self.class.name.split('::').last.downcase
+      name = self.class.name.split('::').last
+      lang, culture = name.match(/([A-Z][a-z]+)([A-Z]\w+)?/).captures
+      lang.downcase + (culture ? '-' + culture.upcase : '')
     end
 
     set :sublocales => %w{en},
@@ -119,6 +121,7 @@ module R18n
 
     def month_standalone; month_names; end
     def month_abbrs;      month_names; end
+    def wday_abbrs;       wday_names;  end
 
     # Is locale has left-to-right write direction.
     def ltr?; true; end

data/lib/r18n-core/translated.rb

@@ -27,8 +27,6 @@ module R18n
   # proxy-method +title+, which will use +title_ru+ for Russian users and
   # +title_en+ for English:
   #
-  #   require 'r18n-core/translated'
-  #
   #   class Product
   #     include DataMapper::Resource
   #     property :title_ru, String
@@ -61,10 +59,9 @@ module R18n
   # Proxy-method support all funtion from I18n: global and type filters,
   # pluralization, variables. It also return TranslatedString or Untranslated.
   #
-  # Note, you must set your I18n object by <tt>R18n.set</tt> and don’t forget
-  # to require <tt>'r18n-core/translated'</tt>. R18n plugins (sinatra-r18n,
-  # r18-desktop) set I18n object by <tt>R18n.set</tt> automatically, but you
-  # must call <tt>i18n</tt> helper in Sinatra before use models.
+  # By default it use <tt>R18n.get</tt> to get I18n object (so, you must set it
+  # before use model), but you can overwrite object +r18n+ method to change
+  # default logic.
   #
   # See R18n::Translated::Base for class method documentation.
   #
@@ -89,6 +86,12 @@ module R18n
       end
     end
 
+    # Access to I18n object. By default return global I18n object from
+    # <tt>R18n.get</tt>.
+    def r18n
+      R18n.get
+    end
+
     # Module with class methods, which be added after R18n::Translated include.
     module Base
       # Hash of translation method names to it type for filters.
@@ -96,7 +99,7 @@ module R18n
 
       # Add several proxy +methods+. See R18n::Translated for description.
       # It’s more compact, that +translation+.
-      # 
+      #
       #   translations :title, :keywords, [:desciption, {:type => 'markdown'}]
       def translations(*methods)
         methods.each do |method|
@@ -106,7 +109,7 @@ module R18n
 
       # Add proxy-method +name+. See R18n::Translated for description.
       # It’s more useful to set options.
-      # 
+      #
       #   translation :desciption, :type => 'markdown'
       def translation(name, options = {})
         if options[:methods]
@@ -124,7 +127,7 @@ module R18n
         class_eval <<-EOS, __FILE__, __LINE__
           def #{name}(*params)
             unlocalized = self.class.unlocalized_getters(#{name.inspect})
-            R18n.get.locales.each do |locale|
+            r18n.locales.each do |locale|
               code = locale.code
               next unless unlocalized.has_key? code
               result = send unlocalized[code]#{params}
@@ -133,19 +136,19 @@ module R18n
               path = "\#{self.class.name}##{name}"
               type = self.class.translation_types[#{name.inspect}]
               if type
-                return R18n::Filters.process(R18n::Filters.enabled,
-                         type, result, locale, path, params)
+                return r18n.filter_list.process(:all, type, result, locale,
+                                                    path, params)
               elsif result.is_a? String
                 result = TranslatedString.new(result, locale, path)
-                return R18n::Filters.process_string(R18n::Filters.enabled,
-                         result, path, params)
+                return r18n.filter_list.process_string(:all, result, path,
+                                                           params)
               else
                 return result
               end
             end
 
             R18n::Untranslated.new("\#{self.class.name}\#", '#{name}',
-                                   R18n.get.locale)
+                                   r18n.locale, r18n.filter_list)
           end
         EOS
 
@@ -153,7 +156,7 @@ module R18n
           class_eval <<-EOS, __FILE__, __LINE__
             def #{name}=(*params)
               unlocalized = self.class.unlocalized_setters(#{name.inspect})
-              R18n.get.locales.each do |locale|
+              r18n.locales.each do |locale|
                 code = locale.code
                 next unless unlocalized.has_key? code
                 return send unlocalized[code], *params

data/lib/r18n-core/translated_string.rb

@@ -44,5 +44,19 @@ module R18n
     def translated?
       true
     end
+
+    # Mark translated string as html safe, because R18n has own escape system.
+    def html_safe?
+      true
+    end
+
+    # Override to_s to make string html safe if `html_safe` method is defined.
+    def to_s
+      if respond_to? :html_safe
+        html_safe
+      else
+        self
+      end
+    end
   end
 end

data/lib/r18n-core/translation.rb

@@ -70,15 +70,15 @@ module R18n
   #   i18n.comments(0)            #=> "no comments"
   #   i18n.comments(10)           #=> "10 comments"
   class Translation
-    # Create translation hash for +path+ with messages in +data+ for +locale+.
-    #
     # This is internal a constructor. To load translation use
-    # <tt>R18n::Translation.load(locales, translations_dir)</tt>.
-    def initialize(main_locale, path = '', locale = nil, data = {})
-      @path = path
-      @data = {}
-      @locale = main_locale
-      merge! data, locale unless data.empty?
+    # <tt>R18n::I18n.new(locales, translations_dir)</tt>.
+    def initialize(locale, path = '', options = {})
+      @data    = {}
+      @locale  = locale
+      @path    = path
+      @filters = options[:filters] || GlobalFilterList.instance
+
+      merge! options[:translations], options[:locale] if options[:translations]
     end
 
     # Add another hash with +translations+ for some +locale+. Current data is
@@ -89,17 +89,17 @@ module R18n
           path = @path.empty? ? name : "#{@path}.#{name}"
           case value
           when Hash
-            value = Translation.new(@locale, path, locale, value)
+            value = Translation.new(@locale, path,
+              :locale => locale, :translations => value, :filters => @filters)
           when String
             c = { :locale => locale, :path => path }
-            v = Filters.process_string(Filters.passive_enabled, value, c, [])
+            v = @filters.process_string(:passive, value, c, [])
             value = TranslatedString.new(v, locale, path)
           when Typed
             value.locale = locale
-            value.path = path
-            unless Filters.passive_enabled[value.type].empty?
-              value = Filters.process(Filters.passive_enabled, value.type,
-                                      value.value, value.locale, value.path, {})
+            value.path   = path
+            unless @filters.passive(value.type).empty?
+              value = @filters.process_typed(:passive, value, { })
             end
           end
           @data[name] = value
@@ -111,12 +111,12 @@ module R18n
 
     # Use untranslated filter to print path.
     def to_s
-      Filters.process(Filters.enabled, Untranslated, @path, @locale, @path,
+      @filters.process(:all, Untranslated, @path, @locale, @path,
                       [@path, '', @path])
     end
 
     # Return current translation keys.
-    def _keys
+    def translation_keys
       @data.keys
     end
 
@@ -133,13 +133,12 @@ module R18n
       value = @data[name.to_s]
       case value
       when TranslatedString
-        Filters.process_string(Filters.active_enabled, value, @path, params)
+        @filters.process_string(:active, value, @path, params)
       when Typed
-        Filters.process(Filters.active_enabled, value.type, value.value,
-                        value.locale, value.path, params)
+        @filters.process_typed(:active, value, params)
       when nil
         translated = @path.empty? ? '' : "#{@path}."
-        Untranslated.new(translated, name.to_s, @locale)
+        Untranslated.new(translated, name.to_s, @locale, @filters)
       else
         value
       end

data/lib/r18n-core/untranslated.rb

@@ -46,10 +46,11 @@ module R18n
     # Path, that exists in translation.
     attr_reader :translated_path
 
-    def initialize(translated_path, untranslated_path, locale)
-      @translated_path = translated_path
+    def initialize(translated_path, untranslated_path, locale, filters)
+      @translated_path   = translated_path
       @untranslated_path = untranslated_path
-      @locale = locale
+      @locale            = locale
+      @filters           = filters
     end
 
     # Path to translation.
@@ -67,7 +68,7 @@ module R18n
 
     def [](*params)
       Untranslated.new(translated_path, "#{@untranslated_path}.#{params.first}",
-                       @locale)
+                       @locale, @filters)
     end
 
     def |(default)
@@ -75,8 +76,10 @@ module R18n
     end
 
     def to_s
-      Filters.process(Filters.enabled, Untranslated, path, @locale, path,
+      @filters.process(:all, Untranslated, path, @locale, path,
                       [@translated_path, @untranslated_path, path])
     end
+
+    alias :to_str :to_s
   end
 end

data/lib/r18n-core/utils.rb

@@ -35,7 +35,11 @@ module R18n
 
     # Escape HTML entries (<, >, &). Copy from HAML helper.
     def self.escape_html(content)
-      content.to_s.gsub(/[><&]/) { |s| HTML_ENTRIES[s] }
+      if defined? ActiveSupport::SafeBuffer
+        ActiveSupport::SafeBuffer.new + content
+      else
+        content.to_s.gsub(/[><&]/) { |s| HTML_ENTRIES[s] }
+      end
     end
 
     # Invokes +block+ once for each key and value of +hash+. Creates a new hash

data/lib/r18n-core/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module R18n
-  VERSION = '0.4.14'.freeze unless defined? R18n::VERSION
+  VERSION = '1.0.0'.freeze unless defined? R18n::VERSION
 end

data/lib/r18n-core/yaml_loader.rb

@@ -19,7 +19,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 =end
 
 require 'yaml'
-require 'syck' if '1.8.' != RUBY_VERSION[0..3]
+require 'syck' if '1.8.' != RUBY_VERSION[0..3] and RUBY_PLATFORM != 'java'
 
 module R18n
   module Loader
@@ -53,7 +53,7 @@ module R18n
       def available
         Dir.glob(File.join(@dir, '**/*.yml')).
           map { |i| File.basename(i, '.yml') }.uniq.
-          map { |i| R18n::Locale.load(i) }
+          map { |i| R18n.locale(i) }
       end
 
       # Return Hash with translations for +locale+.

data/lib/r18n-core.rb

@@ -30,40 +30,46 @@ require dir.join('unsupported_locale').to_s
 require dir.join('translated_string').to_s
 require dir.join('untranslated').to_s
 require dir.join('filters').to_s
+require dir.join('filter_list').to_s
 require dir.join('translation').to_s
 require dir.join('yaml_loader').to_s
 require dir.join('i18n').to_s
 require dir.join('helpers').to_s
 
 module R18n
+  autoload :Translated, 'r18n-core/translated'
+
   class << self
 
-    # Set I18n object globally.
-    def set(i18n = nil, dir = nil, &block)
+    # Set I18n object globally. You can miss translation +places+, it will be
+    # taken from <tt>R18n.default_places</tt>.
+    def set(i18n = nil, places = R18n.default_places, &block)
       if block_given?
         @setter = block
-        @i18n = nil
+        @i18n   = nil
       elsif i18n.is_a? I18n
         @i18n = i18n
       else
-        @i18n = I18n.new(i18n, dir)
+        @i18n = I18n.new(i18n, places)
       end
     end
 
     # Set I18n object to current thread.
     def thread_set(i18n = nil, &block)
       if block_given?
-        Thread.current[:r18n_setter] = block
-        Thread.current[:r18n_i18n] = nil
+        thread[:r18n_setter] = block
+        thread[:r18n_i18n]   = nil
       else
-        Thread.current[:r18n_i18n] = i18n
+        thread[:r18n_i18n] = i18n
       end
     end
 
     # Get I18n object for current thread.
     def get
-      (thread[:r18n_i18n] ||= ((block = thread[:r18n_setter]) && block.call)) ||
-      (@i18n ||= (@setter && @setter.call))
+      thread[:r18n_i18n] ||
+      (thread[:r18n_setter] && thread_set(thread[:r18n_setter].call)) ||
+      @i18n ||
+      (@setter && set(@setter.call))
     end
 
     # Delete I18n object from current thread and global variable.
@@ -87,6 +93,46 @@ module R18n
       get.l(*params)
     end
 
+    # Return I18n object for +locale+. Useful to temporary change locale,
+    # for example, to show text in locales list:
+    #
+    #   - R18n.available_locales.each do |locale|
+    #     - R18n.change(locale).t.language_title
+    def change(locale)
+      locale = locale.code if locale.is_a? Locale
+      exists = get ? get.locales.map { |i| i.code } : []
+      places = get ? get.translation_places : R18n.default_places
+      R18n::I18n.new([locale] + exists, places)
+    end
+
+    # Return Locale object by locale code. It’s shortcut for
+    # <tt>R18n::Locale.load(code)</tt>.
+    def locale(code)
+      R18n::Locale.load(code)
+    end
+
+    # Return Array of locales with available translations. You can miss
+    # translation +places+, it will be taken from <tt>R18n.default_places</tt>.
+    def available_locales(places = R18n.default_places)
+      R18n::I18n.convert_places(places).map { |i| i.available }.flatten.uniq
+    end
+
+    # Default places for <tt>R18n.set</tt> and <tt>R18n.available_locales</tt>.
+    #
+    # You can set block to calculate places dynamically:
+    #   R18n.default_places { settings.i18n_places }
+    attr_accessor :default_places
+
+    def default_places(&block)
+      if block_given?
+        @default_places = block
+      elsif @default_places.is_a? Proc
+        @default_places.call
+      else
+        @default_places
+      end
+    end
+
     # Default loader class, which will be used if you didn’t send loader to
     # +I18n.new+ (object with +available+ and +load+ methods).
     attr_accessor :default_loader
@@ -99,8 +145,9 @@ module R18n
     attr_accessor :cache
   end
 
-  self.default_loader = R18n::Loader::YAML
-  self.extension_places = [
-      Loader::YAML.new(Pathname(__FILE__).dirname.expand_path + '../base')]
-  self.cache = {}
+  dir = Pathname(__FILE__).dirname.expand_path
+  self.default_loader   = R18n::Loader::YAML
+  self.default_places   = nil
+  self.extension_places = [Loader::YAML.new(dir + '../base')]
+  self.cache            = {}
 end

data/locales/ca.rb

@@ -2,6 +2,7 @@
 module R18n
   class Locales::Ca < Locale
     set :title => 'Català',
+        :sublocales => %w{es en},
 
         :wday_names => %w{diumenge dilluns dimarts dimecres dijous divendres
                           dissabte},

data/locales/cs.rb

@@ -35,4 +35,3 @@ module R18n
     end
   end
 end
-

data/locales/en-au.rb

@@ -3,7 +3,6 @@ require File.join(File.dirname(__FILE__), 'en')
 module R18n::Locales
   class EnAu < En
     set :title => 'Australian English',
-        :code =>  'en-AU',
         :sublocales => %w{en}
   end
 end

data/locales/en-gb.rb

@@ -3,7 +3,6 @@ require File.join(File.dirname(__FILE__), 'en')
 module R18n::Locales
   class EnGb < En
     set :title => 'British English',
-        :code =>  'en-GB',
         :sublocales => %w{en}
   end
 end

data/locales/en-us.rb

@@ -5,7 +5,6 @@ require File.join(File.dirname(__FILE__), 'en')
 module R18n::Locales
   class EnUs < En
     set :title => 'American English',
-        :code =>  'en-US',
         :sublocales => %w{en},
 
         :time_format => ' %I:%M %p',

data/locales/en.rb

@@ -17,7 +17,7 @@ module R18n
         :year_format => '_, %Y',
 
         :number_decimal => ".",
-        :number_group =>   ","
+        :number_group   => ","
 
     def ordinalize(n)
       if (11..13).include?(n % 100)