i18n-inflector 2.6.5 → 2.6.6

data/ChangeLog

@@ -1,3 +1,27 @@
+commit c0bcc1dd60256076d9ac79d6f57d11d6a578f3ee
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Mar 14 02:10:49 2012 +0100
+
+    Release 2.6.6
+
+commit 3d2292b4dec50c628fc2feaeba2639e21c44c5c7
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Mar 14 02:06:50 2012 +0100
+
+    Added LazyEnumerator#empty?
+
+commit f912309d9f9d0d2e41c901778f885259f907e8ef
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Mar 14 02:06:29 2012 +0100
+
+    Documentation and examples updated
+
+commit 7d5f57ec1ff967051e693b332c0e72f9bbbbea2a
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Mar 14 02:06:04 2012 +0100
+
+    Added support for integers as token names
+
 commit d08273f935a3fecc51e4ce27a3ebe01342a338f3
 Author: Paweł Wilk <siefca@gnu.org>
 Date:   Sat Mar 10 21:03:04 2012 +0100

data/README.rdoc

@@ -1,6 +1,6 @@
-= Simple Inflector for I18n
+= I18n Inflector
 
-<b>i18n-inflector version <tt>2.6.5</tt></b> (<b><tt>Healthy Beaver</tt></b>)
+<b>i18n-inflector version <tt>2.6.6</tt></b> (<b><tt>Little Kózka</tt></b>)
 
 
 * https://rubygems.org/gems/i18n-inflector
@@ -8,6 +8,56 @@
 * mailto:pw@gnu.org
 
 
+== Summary
+
+This library contains a backend module for I18n that adds some extra
+functionality to standard backend. It overwrites the translate method
+in a way that it will interpolate additional inflection tokens present
+in translations.
+
+== Synopsis
+
+  require 'i18n-inflector'
+
+  I18n.translate( 'to_be', :number  => :singular,
+                           :tense   => :past,
+                           :person  => 2        )
+  #=> You were here
+
+  I18n.translate('welcome', :gender => :female)
+  #=> Dear Lady
+
+== Why?
+
+You can use I18n Inflector to (relatively easy) create
+translations for highly inflected languages (like those
+belonging to Slavic language family). You can also use it
+in translation services that may operate on sentences
+instead of exact words.
+
+== When?
+
+It is intended to be used in a web projects or other projects where
+translations are performed by many people, yet there is a need to
+inflect sentences with some external variables. To achieve similar
+functionality lambdas can be used but including many Proc objects
+might be considered unsafe or memory consuming.
+
+See i18n-inflector-rails[https://rubygems.org/gems/i18n-inflector-rails] if
+you need Rails integration.
+
+== How?
+
+I18n Inflector lets you build you own inflection patterns
+contained in translation entries. The patterns may contain simple
+conditions and tokens, which combined with parameters
+passed to +I18n.translate+ method can produce inflected
+strings.
+
+* See {USAGE}[http://rubydoc.info/gems/i18n-inflector/file/docs/USAGE] for detailed information about the usage.
+* See {EXAMPLES}[http://rubydoc.info/gems/i18n-inflector/file/docs/EXAMPLES] for examples.
+* See {whole documentation}[http://rubydoc.info/gems/i18n-inflector/] to browse all documents.
+
 == Features
 
 * Inline inflection using patterns in translation data.
@@ -21,9 +71,8 @@
 
 == Description
 
-This library contains a backend module for I18n that adds some extra
-functionality to standard backend. It overwrites the translate method
-so that it will interpolate additional inflection tokens present in
+The I18n Inflector extends the translate method from I18n in a way that
+it will interpolate additional inflection tokens present in
 translations. These tokens may appear in *patterns* which are contained
 within <tt>@{</tt> and <tt>}</tt> symbols. Configuration is stored
 also in translation data, in a scope <tt><locale>.i18n.inflections</tt>,
@@ -38,7 +87,9 @@ It adds the +inflector+ object to the default backend so you can use many
 methods for accessing loaded inflection data at runtime, or to set up global
 switches that are controlling the engine.
 
-Example translation data:
+== Short example
+
+Example configuration which uses translation data:
 
   en:
     i18n:
@@ -51,7 +102,10 @@ Example translation data:
           male:     @m
           default:  n
         
-      
+
+Example translation data:
+
+  en:
     welcome:  "Dear @{f:Lady|m:Sir|n:You|All}!"
     
     @same_but_as_key:
@@ -61,7 +115,8 @@ Example translation data:
       @prefix:  "Dear "
       @suffix:  "!"
       @free:    "All"
-      
+    
+  
 === Note about YAML parsing
 
 The example above is not compatible with Psych parser, which is used
@@ -101,23 +156,6 @@ languages. An example pattern:
 
   welcome:  "Dear @gender+number{f+s:Lady|f+p:Ladies|m+s:Sir|m+p:Gentlemen|All}"
 
-== Why?
-
-It's intended to be used in a web projects or other projects where
-translations are performed by many people, yet there is a need to
-inflect sentences with some external variables.
-
-To achieve similar functionality lambdas can be used but including
-Proc objects in translations might be considered unsafe or memory
-consuming.
-
-If you have a troop of happy translators that shouldn't have the
-ability to execute any code yet you need some simple inflection
-then this module might help you.
-
-See i18n-inflector-rails[https://rubygems.org/gems/i18n-inflector-rails] if
-you need Rails integration.
-
 == Requirements
 
 * i18n[https://rubygems.org/gems/i18n]
@@ -125,11 +163,6 @@ you need Rails integration.
 * rubygems[http://docs.rubygems.org/]
 * bundler[http://gembundler.com/]
 
-== Important documentation and more on usage
-
-* See {file:docs/USAGE} for detailed information about the usage.
-* See {whole documentation}[http://rubydoc.info/gems/i18n-inflector/] to browse all documents.
-
 == Download
 
 ==== Source code
@@ -145,12 +178,7 @@ you need Rails integration.
 
 * <tt>gem install i18n-inflector</tt>
 
-== Synopsis
-
-  require 'i18n-inflector'
-  i18n.translate('welcome')
-
-Detailed example:
+== Detailed example
 
 <b>YAML:</b>
 

data/docs/EXAMPLES

@@ -307,5 +307,51 @@ But then you have to change the translation call too, e.g.:
 The split is necessary because we have two patterns here and no way to express them
 as one inflection key.
 
+== To be or not to be
+
+Here is the example pattern that inflects English <i>to be</i> by tense,
+person and grammatical number:
+
+  en:
+    i18n:
+        inflections:
+          @person:
+              1: first
+              2: second
+              3: third
+              i:    :@1
+              you:  :@2
+              He:   :@3
+              She:  :@3
+              it:   :@3
+          @tense:
+            past:      past
+            present:   present
+            now:       @present
+            default:   present
+          @num:
+            s: singular
+            p: plural
+            default: s
+    
+    to_be: >
+            @num+person{s+1:I|*+2:You|s+3:%{person}|p+3:They|p+1:We}
+            @num+person+tense{s+1+present:am|s+2+present:are|s+3+present:is|
+            p+*+present:are|s+1,3+past:was|p+*+past:were|s+2+past:were}
+
+And the code that prints all possible combinations:
+
+  [:i, :you, :He, :She, :It].each do |person|
+    puts  I18n.translate(:to_be, :num => :s, :person => person, :tense => :now) + "\t| " +
+          I18n.translate(:to_be, :num => :s, :person => person, :tense => :past)
+  end
+  
+  puts
+  
+  (1..3).each do |person|
+    puts  I18n.translate(:to_be, :num => :p, :person => person, :tense => :now) + " | " +
+          I18n.translate(:to_be, :num => :p, :person => person, :tense => :past)
+  end
+
 <i>to be continued…</i>
 

data/docs/HISTORY

@@ -1,3 +1,15 @@
+=== 2.6.6 / 2012-03-14
+
+* major enhancements
+
+  * Added support for integers as token names
+  * Added nice example of "to be" inflection in English
+
+* minor enhancements
+
+  * Documentation updated
+  * Added instance method empty? to LazyEnumerator
+
 === 2.6.5 / 2012-03-10
 
 * minor enhancements

data/docs/USAGE

@@ -513,7 +513,7 @@ Elements in the example above are:
 * +en+: language
 * +i18n+: configuration scope
 * +inflections+: inflections configuration scope
-* +gender+: <bb>strict kind</bb> scope
+* +gender+: <b>strict kind</b> scope
 * +f+: inflection token
 * <tt>"female"</tt>: token's description
 * +woman+: inflection alias
@@ -630,7 +630,7 @@ containing no tokens but just a free text consisting
 of single space character.
 
 == Complex patterns
-A <bb>complex pattern</bb> is a named pattern that uses more than
+A <b>complex pattern</b> is a named pattern that uses more than
 one inflection kind and sets of a respective tokens. The given identifiers
 of kinds should be separated by the plus sign and instead of single
 tokens there should be token sets (a tokens separated by the plus

data/lib/i18n-inflector/backend.rb

@@ -247,6 +247,7 @@ module I18n
       def load_inflection_tokens(locale, subtree=nil)
         inflections_tree = subtree || inflection_subtree(locale)
         return nil if (inflections_tree.nil? || inflections_tree.empty?)
+        inflections_tree = deep_symbolize(inflections_tree)
 
         idb         = I18n::Inflector::InflectionData.new(locale)
         idb_strict  = I18n::Inflector::InflectionData_Strict.new(locale)
@@ -255,6 +256,7 @@ module I18n
 
         inflections = prepare_inflections(locale, inflections_tree, idb, idb_strict)
 
+        # add inflection tokens and kinds to internal database
         inflections.each do |orig_kind, kind, strict_kind, subdb, tokens|
 
           # validate token's kind
@@ -345,6 +347,16 @@ module I18n
         end
       end
 
+      # @private
+      def deep_symbolize(obj)
+        obj.inject({}) do |result, (key, value)|
+          value = deep_symbolize(value) if value.is_a?(Hash)
+          result[(key.to_s.to_sym rescue key) || key] = value
+          result
+        end
+      end
+
+
     end # module Inflector
   end # module Backend
 end # module I18n

data/lib/i18n-inflector/config.rb

@@ -57,7 +57,8 @@ module I18n
 
         # All keys
         ALL = HSet.new Config.all_consts(self, Symbol)
-      end
+
+      end # module Keys
 
       # This module contains characters that are markers
       # giving the shape for a pattern and its elements.

data/lib/i18n-inflector/interpolate.rb

@@ -353,7 +353,7 @@ module I18n
 
             # resolve token from options and check if it's known
             unless passed_token.nil?
-              passed_token = subdb.get_true_token(passed_token.to_sym, parsed_kind)
+              passed_token = subdb.get_true_token(passed_token.to_s.to_sym, parsed_kind)
               passed_token = default_token if passed_token.nil? && unknown_defaults
             end
 

data/lib/i18n-inflector/lazy_enum.rb

@@ -128,6 +128,17 @@ module I18n
         end
       end
 
+      # Checks if a collection is empty
+      # @return [Boolean] +true+ if collection is empty, +false+ otherwise
+      def empty?
+        self.class.new do |yielder|
+          each do |k,v|
+            return false
+          end
+        end
+        true
+      end
+
     end
 
     # This class implements simple enumerators for arrays

data/lib/i18n-inflector/version.rb

@@ -14,7 +14,7 @@ module I18n
     # @private
     EMAIL       = 'pw@gnu.org'
     # @private
-    VERSION     = '2.6.5'
+    VERSION     = '2.6.6'
     # @private
     NAME        = 'i18n-inflector'
     # @private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-inflector
 version: !ruby/object:Gem::Version
-  version: 2.6.5
+  version: 2.6.6
   prerelease: 
 platform: ruby
 authors:
@@ -48,11 +48,11 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2012-03-10 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2161409560 !ruby/object:Gem::Requirement
+  requirement: &2161408440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -60,10 +60,10 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *2161409560
+  version_requirements: *2161408440
 - !ruby/object:Gem::Dependency
   name: hoe-yard
-  requirement: &2161408900 !ruby/object:Gem::Requirement
+  requirement: &2161407820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -71,10 +71,10 @@ dependencies:
         version: 0.1.2
   type: :development
   prerelease: false
-  version_requirements: *2161408900
+  version_requirements: *2161407820
 - !ruby/object:Gem::Dependency
   name: test_declarative
-  requirement: &2161408400 !ruby/object:Gem::Requirement
+  requirement: &2161407160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -82,10 +82,10 @@ dependencies:
         version: 0.0.5
   type: :development
   prerelease: false
-  version_requirements: *2161408400
+  version_requirements: *2161407160
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2161407740 !ruby/object:Gem::Requirement
+  requirement: &2161406440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -93,10 +93,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *2161407740
+  version_requirements: *2161406440
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2161407020 !ruby/object:Gem::Requirement
+  requirement: &2161405660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -104,10 +104,10 @@ dependencies:
         version: 3.8.0
   type: :development
   prerelease: false
-  version_requirements: *2161407020
+  version_requirements: *2161405660
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2161406460 !ruby/object:Gem::Requirement
+  requirement: &2161405020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -115,10 +115,10 @@ dependencies:
         version: 1.0.15
   type: :development
   prerelease: false
-  version_requirements: *2161406460
+  version_requirements: *2161405020
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
-  requirement: &2161405700 !ruby/object:Gem::Requirement
+  requirement: &2161404300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -126,10 +126,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *2161405700
+  version_requirements: *2161404300
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &2161405100 !ruby/object:Gem::Requirement
+  requirement: &2161403320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -137,7 +137,7 @@ dependencies:
         version: '2.16'
   type: :development
   prerelease: false
-  version_requirements: *2161405100
+  version_requirements: *2161403320
 description: Enhances simple I18n backend in a way that it inflects translation data
   using pattern interpolation.
 email:
@@ -202,7 +202,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4537310741031489808
+      hash: -404233212743185379
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: