r18n-core 0.4 → 0.4.1

data/ChangeLog

@@ -1,3 +1,8 @@
+== 0.4.1 (Lazy Boole)
+* Add passive filters.
+* Receive filter position as option Hash.
+* Fix base translations (by Pavel Kunc).
+
 == 0.4 (D-Day)
 * Rails I18n compatibility.
 * Rewrite a lot of core code to fast and cleanup version.
@@ -46,7 +51,7 @@
 * Ruby 1.9 compatibility.
 * Add German locale (by Benjamin Meichsner).
 
-== 0.2 (Freedom of language)
+== 0.2 (Freedom of Language)
 * Locale class can be extended for special language (for example, Indian locale
   may has another digits grouping).
 * Load translations from several dirs.

data/README.rdoc

@@ -220,12 +220,13 @@ See <tt>base/</tt> in dir in gem.
 === Filters
 
 You can also add you own filter for translations: escape HTML entries, convert
-from Markdown syntax, etc.
+from Markdown syntax, etc. Filters can be passive to process translation only on
+loading.
 
   R18n::Filters.add('custom_type', :filter_name) do |content, config, replace|
     content.gsub(' ', replace)
   end
-  R18n::Filters.add('custom_type') do |content, config, replace|
+  R18n::Filters.add('custom_type', :passive => true) do |content, config|
     content + '!'
   end
   

data/base/cs.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Uložit
 cancel: Zrušit
-yes: Ano
-no: Ne
+'yes': Ano
+'no': Ne
 exit: Konec
 delete: Smazat
 

data/base/de.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Speichern
 cancel: Abbrechen
-yes: Ja
-no: Nein
+'yes': Ja
+'no': Nein
 exit: Ausgang
 delete: Löschen
 
@@ -28,4 +28,4 @@ human_time:
   yesterday: gestern
   days_ago: !!pl
     1: %1 Tag vor
-    n: %1 Tagen vor
+    n: %1 Tagen vor

data/base/en.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Save
 cancel: Cancel
-yes: Yes
-no: No
+'yes': 'Yes'
+'no': 'No'
 exit: Exit
 delete: Delete
 

data/base/eo.yml

@@ -1,8 +1,8 @@
 ok: Ek
 save: Savi
 cancel: Nuligi
-yes: Jes
-no: Ne
+'yes': Jes
+'no': Ne
 exit: Eliro
 delete: Forviŝi
 

data/base/es.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Guardar
 cancel: Cancelar
-yes: Sí
-no: No
+'yes': Sí
+'no': 'No'
 exit: Salir
 delete: Suprimir
 

data/base/fr.yml

@@ -1,8 +1,8 @@
 ok: O.K.
 save: Enregistrer
 cancel: Annuler
-yes: Oui
-no: Non
+'yes': Oui
+'no': Non
 exit: Sortie
 delete: Supprimer
 

data/base/it.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Salva
 cancel: Annulla
-yes: Sì
-no: No
+'yes': Sì
+'no': 'No'
 exit: Esci
 delete: Cancella
  

data/base/kk.yml

@@ -1,7 +1,7 @@
 ok: OK
 save: Сақтау
 cancel: Болдырмау
-yes: Иә
-no: Жоқ
+'yes': Иә
+'no': Жоқ
 exit: Шығу
 delete: Алыстату

data/base/pl.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Zapisz
 cancel: Anuluj
-yes: Tak
-no: Nie
+'yes': Tak
+'no': Nie
 exit: Wyjście
 delete: Usuń
 

data/base/pt_br.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Salvar
 cancel: Cancelar 
-yes: Sim 
-no: Não
+'yes': Sim
+'no': Não
 exit: Sair
 delete: Apagar
 

data/base/ru.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: Сохранить
 cancel: Отмена
-yes: Да
-no: Нет
+'yes': Да
+'no': Нет
 exit: Выход
 delete: Удалить
 

data/base/zh.yml

@@ -1,8 +1,8 @@
 ok: OK
 save: 保存
 cancel: 取消
-yes: 是
-no: 否
+'yes': 是
+'no': 否
 exit: 退出
 delete: 删除
 

data/lib/r18n-core/filters.rb

@@ -30,12 +30,13 @@ module R18n
   #     This content will be processed by filter
   # 
   # Filter function will be receive filtered content as first argument, struct
-  # with filter config as second and filter parameters as next arguments.
+  # with filter config as second and filter parameters as next arguments. You
+  # can set passive filter, which will process translation only on loading.
   # 
   #   R18n::Filters.add('custom_type', :no_space) do |content, config, replace|
   #     content.gsub(' ', replace)
   #   end
-  #   R18n::Filters.add('custom_type') do |content, config, replace|
+  #   R18n::Filters.add('custom_type', :passive => true) do |content, config|
   #     content + '!'
   #   end
   #   
@@ -48,7 +49,7 @@ module R18n
   #   end
   #
   # Filter config contain two parameters: translation locale and path. But it is
-  # OpenStruct and you can add you own parameter to cross-filter communications:
+  # Hash and you can add you own parameter to cross-filter communications:
   # 
   #   R18n::Filters.add(String, :hide_truth) do |content, config|
   #     return content if config[:censorship_check]
@@ -73,67 +74,82 @@ module R18n
   #   i18n.filtered('_') #=> "This_content_will_be_processed_by_filter!"
   #   R18n::Filters.delete(:no_space)
   module Filters
-    Filter = Struct.new(:name, :type, :block, :enabled) do
-      def call(*params)
-        block.call(*params)
-      end
-      
-      def enabled?
-        enabled
-      end
-    end
-    
     class << self
       # Hash of filter names to Filters.
-      def defined
-        @defined ||= {}
-      end
-      
-      # Hash of types to enabled Filters.
-      def enabled
-        @enabled ||= Hash.new([])
-      end
+      attr_accessor :defined
       
       # Hash of types to all Filters.
-      def by_type
-        @by_type ||= Hash.new([])
-      end
+      attr_accessor :by_type
+      
+      # Hash of types to enabled active filters.
+      attr_accessor :active_enabled
       
-      # Process +value+ by global filters and filters for special +type+.
-      def process(type, value, locale, path, params)
+      # Hash of types to enabled passive filters.
+      attr_accessor :passive_enabled
+      
+      # 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 }
         
-        Filters.enabled[type].each { |f| value = f.call(value, config, *params)}
+        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(value, config, params)
+          process_string(enabled, value, config, params)
         else
           value
         end
       end
       
-      # Process +value+ by global filters.
-      def process_string(value, config, params)
+      # 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
-        Filters.enabled[String].each do |f|
+        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] = []
+        @active_enabled[type] = []
+        @enabled[type] = []
+        
+        @by_type[type].each do |filter|
+          if filter.enabled?
+            @enabled[type] << filter
+            if filter.passive?
+              @passive_enabled[type] << filter
+            else
+              @active_enabled[type] << filter
+            end
+          end
+        end
+      end
+      
       # 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.
       # 
-      # Several filters for same type will be call consecutively, but you can
-      # set +position+ in call list.
-      # 
       # Filter content will be sent to +block+ as first argument, struct with
       # config as second and filters parameters will be in next arguments.
-      def add(type, name = nil, position = nil, &block)
+      # 
+      # Options:
+      # * +position+ – change order on processing several filters for same type.
+      #    Note that passive filters will be always run before active.
+      # * +passive+ – if +true+, filter will process only on translation
+      #   loading. Note that you must add all passive before load translation.
+      def add(type, name = nil, options = {}, &block)
+        options, name = name, nil if name.is_a? Hash
+        
         unless name
           @last_auto_name ||= 0
           begin
@@ -144,52 +160,61 @@ module R18n
           delete(name)
         end
         
-        filter = Filter.new(name, type, block, true)
-        defined[name] = filter
+        @by_type[type] = [] unless @by_type.has_key? type
         
-        unless enabled.has_key? type
-          enabled[type] = []
-          by_type[type] = []
-        end
-        if position
-          enabled[type].insert(position, filter)
-          by_type[type].insert(position, filter)
+        filter = Filter.new(name, type, block, true, options[:passive])
+        @defined[name] = filter
+        
+        if options.has_key? :position
+          @by_type[type].insert(options[:position], filter)
         else
-          enabled[type] << filter
-          by_type[type] << defined[name]
+          @by_type[type] << filter
         end
+        rebuild_enabled! type
         
         filter
       end
       
       # Delete +filter+ by name or Filter object.
       def delete(filter)
-        filter = defined[filter] unless filter.is_a? Filter
+        filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
         
-        defined.delete(filter.name)
-        by_type[filter.type].delete(filter)
-        enabled[filter.type].delete(filter)
+        @defined.delete(filter.name)
+        @by_type[filter.type].delete(filter)
+        rebuild_enabled! filter.type
       end
       
       # Disable +filter+ by name or Filter object.
       def off(filter)
-        filter = defined[filter] unless filter.is_a? Filter
+        filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
         
         filter.enabled = false
-        enabled[filter.type].delete(filter)
+        rebuild_enabled! filter.type
       end
       
       # Turn on disabled +filter+ by name or Filter object.
       def on(filter)
-        filter = defined[filter] unless filter.is_a? Filter
+        filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
         
         filter.enabled = true
-        enabled[filter.type] = by_type[filter.type].reject { |i| !i.enabled? }
+        rebuild_enabled! filter.type
       end
     end
+    
+    Filters.defined = {}
+    Filters.by_type = Hash.new([])
+    Filters.active_enabled = Hash.new([])
+    Filters.passive_enabled = Hash.new([])
+    Filters.enabled = Hash.new([])
+  
+    Filter = Struct.new(:name, :type, :block, :enabled, :passive) do
+      def call(*params); block.call(*params); end
+      def enabled?; enabled; end
+      def passive?; passive; end
+    end
   end
   
   Filters.add('proc', :procedure) do |content, config, *params|
@@ -218,31 +243,31 @@ module R18n
     "#{translated}[#{untranslated}]"
   end
   
-  Filters.add('escape', :escape_html) do |content, config|
+  Filters.add('escape', :escape_html, :passive => true) do |content, config|
     config[:dont_escape_html] = true
     Utils.escape_html(content)
   end
   
-  Filters.add('html', :dont_escape_html) do |content, config|
+  Filters.add('html', :dont_escape_html, :passive => true) do |content, config|
     config[:dont_escape_html] = true
     content
   end
   
-  Filters.add(String, :global_escape_html) do |content, config|
+  Filters.add(String, :global_escape_html, :passive => true) do |html, config|
     if config[:dont_escape_html]
-      content
+      html
     else
-      Utils.escape_html(content)
+      Utils.escape_html(html)
     end
   end
   Filters.off(:global_escape_html)
   
-  Filters.add('markdown', :maruku) do |content, config|
+  Filters.add('markdown', :maruku, :passive => true) do |content, config|
     require 'maruku'
     ::Maruku.new(content).to_html
   end
   
-  Filters.add('textile', :redcloth) do |content, config|
+  Filters.add('textile', :redcloth, :passive => true) do |content, config|
     require 'redcloth'
     ::RedCloth.new(content).to_html
   end

data/lib/r18n-core/translated.rb

@@ -133,10 +133,12 @@ module R18n
               path = "\#{self.class.name}##{name}"
               type = self.class.translation_types[#{name.inspect}]
               if type
-                return R18n::Filters.process(type, result, locale, path, params)
+                return R18n::Filters.process(R18n::Filters.enabled,
+                         type, result, locale, path, params)
               else
                 result = TranslatedString.new(result, locale, path)
-                return R18n::Filters.process_string(result, path, params)
+                return R18n::Filters.process_string(R18n::Filters.enabled,
+                         result, path, params)
               end
             end
             

data/lib/r18n-core/translation.rb

@@ -91,12 +91,15 @@ module R18n
           when Hash
             value = Translation.new(@locale, path, locale, value)
           when String
-            value = TranslatedString.new(value, locale, path)
-          when YAML::PrivateType
-            value = Typed.new(value.type_id, value.value, locale, path)
+            v = TranslatedString.new(value, locale, path)
+            value = Filters.process_string(Filters.passive_enabled, v, 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, {})
+            end
           end
           @data[name] = value
         elsif @data[name].is_a? Translation
@@ -107,7 +110,8 @@ module R18n
     
     # Use untranslated filter to print path.
     def to_s
-      Filters.process(Untranslated, @path, @locale, @path, [@path, '', @path])
+      Filters.process(Filters.enabled, Untranslated, @path, @locale, @path,
+                      [@path, '', @path])
     end
     
     # Return +default+.
@@ -133,10 +137,10 @@ module R18n
       value = @data[name.to_s]
       case value
       when TranslatedString
-        Filters.process_string(value, @path, params)
+        Filters.process_string(Filters.active_enabled, value, @path, params)
       when Typed
-        Filters.process(value.type, value.value, value.locale, value.path,
-                        params)
+        Filters.process(Filters.active_enabled, value.type, value.value,
+                        value.locale, value.path, params)
       when nil
         translated = @path.empty? ? '' : "#{@path}."
         Untranslated.new(translated, name.to_s, @locale)

data/lib/r18n-core/untranslated.rb

@@ -75,7 +75,7 @@ module R18n
     end
     
     def to_s
-      Filters.process(Untranslated, path, @locale, path,
+      Filters.process(Filters.enabled, Untranslated, path, @locale, path,
                       [@translated_path, @untranslated_path, path])
     end
   end

data/lib/r18n-core/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module R18n
-  VERSION = '0.4' unless defined? R18n::VERSION
+  VERSION = '0.4.1' unless defined? R18n::VERSION
 end

data/lib/r18n-core/yaml_loader.rb

@@ -50,7 +50,8 @@ module R18n
       
       # Return Hash with translations for +locale+.
       def load(locale)
-        ::YAML::load(IO.read(File.join(@dir, "#{locale.code.downcase}.yml")))
+        file = File.join(@dir, "#{locale.code.downcase}.yml")
+        transform(::YAML::load(IO.read(file)))
       end
       
       # YAML loader with same +dir+ will be have same +hash+.
@@ -62,6 +63,18 @@ module R18n
       def ==(loader)
         self.class == loader.class and self.dir == loader.dir
       end
+      
+      # Wrap YAML private types to Typed.
+      def transform(hash)
+        Hash[hash.map { |key, value|
+          if value.is_a? ::YAML::PrivateType
+            value = Typed.new(value.type_id, value.value)
+          elsif value.is_a? Hash
+            value = transform(value)
+          end
+          [key, value]
+        }]
+      end
     end
   end
 end

data/spec/filters_spec.rb

@@ -6,6 +6,7 @@ describe R18n::Filters do
     @system  = R18n::Filters.defined.values
     @enabled = R18n::Filters.defined.values.reject { |i| !i.enabled? }
     @i18n = R18n::I18n.new('en', DIR)
+    @i18n.reload!
   end
   
   after do
@@ -31,10 +32,24 @@ describe R18n::Filters do
     @i18n.my_tree_filter.should == {'name' => 'value'}
   end
   
+  it "should use passive filters" do
+    filter = mock()
+    filter.should_receive(:process).twice.and_return(1)
+    
+    R18n::Filters.add('my', :passive, :passive => true) { filter.process }
+    
+    @i18n.my_filter.should.should == 'value'
+    @i18n.reload!
+    
+    @i18n.my_tree_filter.should == 1
+    @i18n.my_filter.should == 1
+    @i18n.my_filter.should == 1
+  end
+  
   it "should use cascade filters" do
-    filter = R18n::Filters.add('my', :one)      { |i, config| i + '1' }
-    filter = R18n::Filters.add('my', :two)      { |i, config| i + '2' }
-    filter = R18n::Filters.add('my', :three, 0) { |i, config| i + '3' }
+    filter = R18n::Filters.add('my', :one) { |i, config| i + '1' }
+    filter = R18n::Filters.add('my', :two) { |i, config| i + '2' }
+    filter = R18n::Filters.add('my', :three, :position => 0) { |i, c| i + '3' }
     @i18n.my_filter.should == 'value312'
   end
   
@@ -42,7 +57,7 @@ describe R18n::Filters do
     R18n::Filters.instance_variable_set(:@last_auto_name, 0)
     
     R18n::Filters.add('some').name.should == 1
-    R18n::Filters.add('some').name.should == 2
+    R18n::Filters.add('some', :position => 0).name.should == 2
     
     R18n::Filters.add('some', 3)
     R18n::Filters.add('some').name.should == 4
@@ -101,7 +116,7 @@ describe R18n::Filters do
     R18n::Filters.add('my') { |content, config| config[:new_secret] ? 2 : 1 }
     @i18n.my_filter.should == 1
     
-    R18n::Filters.add('my', nil, 0) do |content, config|
+    R18n::Filters.add('my', :second, :position => 0) do |content, config|
       config[:new_secret] = true
       content
     end
@@ -175,13 +190,16 @@ describe R18n::Filters do
     @i18n.greater.should == '1 < 2 is true'
     
     R18n::Filters.on(:global_escape_html)
+    @i18n.reload!
     @i18n.greater.should == '1 &lt; 2 is true'
     @i18n.html.should == '&lt;script&gt;true &amp;&amp; false&lt;/script&gt;'
   end
   
   it "should have filter to disable global HTML escape" do
     @i18n.no_escape.should == '<b>Warning</b>'
+    
     R18n::Filters.on(:global_escape_html)
+    @i18n.reload!
     @i18n.no_escape.should == '<b>Warning</b>'
   end
   

data/spec/translations/general/en.yml

@@ -25,8 +25,6 @@ my_filter:  !!my value
 my_tree_filter: !!my
     name: value
 
-unknown_filter: !!unknown value
-
 html: !!escape
   <script>true && false</script>
 greater: 1 < 2 is true

data/spec/translations/general/ru.yml

@@ -3,3 +3,5 @@ one: Один
 in:
   another:
     level: Иерархический
+
+typed: !!my value

data/spec/yaml_loader_spec.rb

@@ -23,7 +23,8 @@ describe R18n::Loader::YAML do
   
   it "should load translation" do
     @loader.load(R18n::Locale.load('ru')).should == {
-      'one' => 'Один', 'in' => {'another' => {'level' => 'Иерархический'}} }
+      'one' => 'Один', 'in' => {'another' => {'level' => 'Иерархический'}},
+      'typed' => R18n::Typed.new('my', 'value') }
   end
   
   it "should return hash by dir" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: r18n-core
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: 0.4.1
 platform: ruby
 authors: 
 - Andrey "A.I." Sitnik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-03 00:00:00 +03:00
+date: 2010-01-11 00:00:00 +03:00
 default_executable: 
 dependencies: []