i18n-inflector 2.2.0 → 2.3.0

data/lib/i18n-inflector/api.rb

@@ -191,7 +191,7 @@ module I18n
       #   @note If +kind+ begins with the +@+ symbol then the variant of this method
       #     operating on strict kinds will be called ({I18n::Inflector::API_Strict#inflected_locales})
       def inflected_locales(kind=nil)
-        if kind.to_s[0..0] == Markers::PATTERN
+        if kind.to_s[0..0] == Markers::STRICT_KIND
           strict.inflected_locales(kind.to_s[1..-1])
         else
           (super + strict.inflected_locales(kind)).uniq
@@ -216,7 +216,7 @@ module I18n
       #   @param [Symbol] locale the locale identifier
       #   @return [Boolean] +true+ if the given +kind+ exists, +false+ otherwise
       def has_kind?(kind, locale=nil)
-        if kind.to_s[0..0] == Markers::PATTERN
+        if kind.to_s[0..0] == Markers::STRICT_KIND
           return strict.has_kind?(kind.to_s[1..-1], locale)
         end
         super
@@ -242,7 +242,7 @@ module I18n
       #     there is no default token
       def default_token(kind, locale=nil)
         return nil if (kind.nil? || kind.to_s.empty?)
-        if kind.to_s[0..0] == Markers::PATTERN
+        if kind.to_s[0..0] == Markers::STRICT_KIND
           return strict.default_token(kind.to_s[1..-1], locale)
         end
         super
@@ -285,7 +285,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           reutrn false if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.has_alias?(token, kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -331,7 +331,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return false if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.has_true_token?(token, kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -377,7 +377,7 @@ module I18n
          unless kind.nil?
            kind = kind.to_s
            return false if kind.empty?
-           if kind[0..0] == Markers::PATTERN
+           if kind[0..0] == Markers::STRICT_KIND
              return strict.has_token?(token, kind[1..-1], locale)
            end
            kind = kind.to_sym
@@ -427,7 +427,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return nil if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.true_token(token, kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -472,7 +472,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return nil if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.kind(token, kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -514,7 +514,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return {} if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.tokens(kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -555,7 +555,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return {} if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.tokens_raw(kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -593,7 +593,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return {} if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.tokens_true(kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -627,7 +627,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return nil if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.aliases(kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -679,7 +679,7 @@ module I18n
         unless kind.nil?
           kind = kind.to_s
           return nil if kind.empty?
-          if kind[0..0] == Markers::PATTERN
+          if kind[0..0] == Markers::STRICT_KIND
             return strict.token_description(token, kind[1..-1], locale)
           end
           kind = kind.to_sym
@@ -735,7 +735,7 @@ module I18n
       def tkl_args(args)
         token, kind, locale = case args.count
         when 1 then [args[0], nil, nil]
-        when 2 then args[1].to_s[0..0] == Markers::PATTERN ? [args[0], args[1], nil] : [args[0], nil, args[1]]
+        when 2 then args[1].to_s[0..0] == Markers::STRICT_KIND ? [args[0], args[1], nil] : [args[0], nil, args[1]]
         when 3 then args
         else raise I18n::ArgumentError.new("wrong number of arguments: #{args.count} for (1..3)")
         end

data/lib/i18n-inflector/backend.rb

@@ -74,7 +74,7 @@ module I18n
         translated_string = super
 
         # generate a pattern from key-based inflection object
-        if (translated_string.is_a?(Hash) && key.to_s[0..0] == InflectorCfg::Markers::PATTERN)
+        if (translated_string.is_a?(Hash) && key.to_s[0..0] == InflectorCfg::Markers::STRICT_KIND)
           translated_string = @inflector.key_to_pattern(translated_string)
         end
 
@@ -344,7 +344,7 @@ module I18n
           subdb       = idb
           strict_kind = nil
           orig_kind   = kind
-          if kind.to_s[0..0] == InflectorCfg::Markers::PATTERN
+          if kind.to_s[0..0] == InflectorCfg::Markers::STRICT_KIND
             kind        = kind.to_s[1..-1]
             next if kind.empty?
             kind        = kind.to_sym

data/lib/i18n-inflector/config.rb

@@ -63,10 +63,12 @@ module I18n
       # giving the shape for a pattern and its elements.
       module Markers
 
-        # A character that is used to mark pattern
-        # and a strict kind.
+        # A character that is used to mark pattern.
         PATTERN       = '@'
 
+        # A character that is used to mark a strict kind.
+        STRICT_KIND   = '@'
+
         # A character that is used to open a pattern.
         PATTERN_BEGIN = '{'
 
@@ -109,18 +111,22 @@ module I18n
           # A character used to mark patterns as complex
           # and to separate token groups assigned to different
           # strict kinds.
-          AND     = '+'
+          AND       = '+'
 
           # A character that is used to separate tokens
           # or token groups within a pattern. 
-          OR      = '|'
+          OR        = '|'
 
           # A character used to assign value to a token
           # or a group of tokens.
-          ASSIGN  = ':'
+          ASSIGN    = ':'
+
+          # A character used to create a virtual token
+          # that always matches.
+          WILDCARD  = '*'
 
           # All token groups operators.
-          ALL     = Config.all_consts(self)
+          ALL       = Config.all_consts(self)
 
         end # module Tokens
 
@@ -129,13 +135,13 @@ module I18n
         module Token
 
           # A character used to separate multiple tokens.
-          OR      = ','
+          OR        = ','
 
           # A character used to mark tokens as negative.
-          NOT     = '!'
+          NOT       = '!'
 
           # All token operators.
-          ALL     = Config.all_consts(self)
+          ALL       = Config.all_consts(self)
 
         end # module Token
 
@@ -164,7 +170,7 @@ module I18n
           OPTION    = DB
 
           # Reserved characters in token identifiers placed in patterns.
-          PATTERN   = OPTION
+          PATTERN   = OPTION - [Operators::Tokens::WILDCARD]
 
           # This module contains constants defining
           # regular expressions for reserved characters
@@ -276,7 +282,7 @@ module I18n
     # @private
     PATTERN_MARKER  = Config::Markers::PATTERN
     # @private
-    NAMED_MARKER    = Config::Markers::PATTERN
+    NAMED_MARKER    = Config::Markers::STRICT_KIND
     # @private
     ALIAS_MARKER    = Config::Markers::ALIAS
     # @private

data/lib/i18n-inflector/errors.rb

@@ -75,7 +75,7 @@ module I18n
     def message
       kind = @kind.to_s
       unless kind.empty?
-        if kind[0..0] == I18n::Inflector::Config::Markers::PATTERN
+        if kind[0..0] == I18n::Inflector::Config::Markers::STRICT_KIND
           kindmsg = ":#{kind} (or :#{kind[1..-1]})"
         else
           kindmsg = kind.to_sym.inspect
@@ -164,7 +164,7 @@ module I18n
   end
 
   # This is raised when a complex inflection pattern is malformed
-  # and cannot be reduced to regular patterns.
+  # and cannot be reduced to set of regular patterns.
   class ComplexPatternMalformed < InflectionPatternException
 
     def initialize(locale, pattern, token, complex_kind)

data/lib/i18n-inflector/inflector.rb

@@ -22,6 +22,17 @@ module I18n
     end
   end
 
+  # @version 2.3
+  # @api public
+  # 
+  # This module contains inflection classes and modules for enabling
+  # the inflection support in I18n translations.
+  # It is used by the module called {I18n::Backend::Inflector}
+  # that overwrites the translate method from the Simple backend
+  # so it will interpolate additional inflection data present
+  # in translations.
+  # 
+  # @see file:USAGE
   module Inflector
 
   end # module Inflector

data/lib/i18n-inflector/interpolate.rb

@@ -87,6 +87,7 @@ module I18n
           found           = nil
           default_value   = nil
           tb_raised       = nil
+          wildcard_value  = nil
 
           # leave escaped pattern as-is
           unless pattern_fix.empty?
@@ -114,15 +115,15 @@ module I18n
             default_token   = nil
             subdb           = idb
           else
-            sym_parsed_kind = (Markers::PATTERN + strict_kind).to_sym
+            sym_parsed_kind = (Markers::STRICT_KIND + strict_kind).to_sym
 
             if strict_kind.include?(Operators::Tokens::AND)
 
               # Complex markers processing
               begin
                 result = interpolate_complex(strict_kind,
-                                                pattern_content,
-                                                locale, options)
+                                             pattern_content,
+                                             locale, options)
               rescue I18n::InflectionPatternException => e
                 e.pattern = ext_pattern
                 raise
@@ -175,6 +176,18 @@ module I18n
               next
             end
 
+            # unroll wildcard token
+            if ext_token == Operators::Tokens::WILDCARD
+
+              if parsed_kind.nil?
+                # wildcard for a regular kind that we do not know yet
+                wildcard_value = ext_value
+              else
+                # wildcard for a known strict or regular kind
+                ext_token = subdb.get_true_tokens(parsed_kind).keys.join(Operators::Token::OR)
+              end
+            end
+
             # split tokens from group if comma is present and put into fast list
             ext_token.split(Operators::Token::OR).each do |t|
               # token name corrupted
@@ -233,7 +246,7 @@ module I18n
                 tokens[t]     = true
                 default_value = ext_value if t == default_token
               end
-            end
+            end # token group processing
 
             # self-explanatory
             if (tokens.empty? && negatives.empty?)
@@ -252,7 +265,14 @@ module I18n
 
             # get passed token from options or from a default token
             if passed_kinds.has_key?(expected_kind)
-              passed_token      = passed_kinds[expected_kind]
+              passed_token = passed_kinds[expected_kind]
+              if passed_token.is_a?(Method)
+                passed_token = passed_token.call { next expected_kind, locale }
+                passed_kinds[expected_kind] = passed_token # cache the result
+              elsif passed_token.is_a?(Proc)
+                passed_token = passed_token.call(expected_kind, locale)
+                passed_kinds[expected_kind] = passed_token # cache the result
+              end
               orig_passed_token = passed_token
               # validate passed token's name
               if Reserved::Tokens.invalid?(passed_token, :OPTION)
@@ -278,6 +298,14 @@ module I18n
               passed_token = default_token if passed_token.nil? && unknown_defaults
             end
 
+            # handle memorized wildcard waiting for a kind
+            if !wildcard_value.nil? && !parsed_kind.nil?
+              found  = passed_token
+              result = wildcard_value
+              wildcard_value = nil
+              break
+            end
+
             # throw the value if the given option matches one of the tokens from group
             # or negatively matches one of the negated tokens
             case negatives.count
@@ -295,6 +323,33 @@ module I18n
 
           # RESULTS PROCESSING
 
+          # handle memorized wildcard token
+          # when there was no way to deduce a token or a kind
+          # it's just for regular kinds
+          unless (wildcard_value.nil? || passed_kinds.nil?)
+            parsed_kind = nil
+            found       = nil
+            passed_kinds.each do |k, ot|
+              t = subdb.get_true_token(ot, k)
+              if Reserved::Tokens.invalid?(t, :OPTION)
+                raise I18n::InvalidInflectionOption.new(locale, ext_pattern, ot) if raises
+                next
+              end
+              unless t.nil?
+                found = t
+                parsed_kind = k
+                break
+              end
+            end
+            unless (parsed_kind.nil? || found.nil?)
+              result = wildcard_value
+              wildcard_value = nil
+            else
+              found = nil
+              parsed_kind = nil
+            end
+          end
+
           # if there was no hit for that option
           if result.nil?
             raise tb_raised unless tb_raised.nil?
@@ -307,10 +362,22 @@ module I18n
             # the pattern with a value picked for the default
             # token for that kind if a default token was present
             # in a pattern
-            result = (excluded_defaults &&
-                      !parsed_kind.nil? &&
-                      subdb.has_token?(passed_kinds[parsed_kind], parsed_kind)) ?
-                        default_value : nil
+            if (excluded_defaults && !parsed_kind.nil?)
+              expected_kind = sym_parsed_kind
+              expected_kind = parsed_kind unless passed_kinds.has_key?(expected_kind)
+              t = passed_kinds[expected_kind]
+              if t.is_a?(Method)
+                t = t.call { next expected_kind, locale }
+                passed_kinds[expected_kind] = t # cache the result
+              elsif t.is_a?(Proc)
+                t = t.call(expected_kind, locale)
+                passed_kinds[expected_kind] = t # cache the result
+              end
+              if Reserved::Tokens.invalid?(t, :OPTION)
+                raise I18n::InvalidInflectionOption.new(locale, ext_pattern, t) if raises
+              end
+              result = subdb.has_token?(t, parsed_kind) ? default_value : nil
+            end
 
           # interpolate loud tokens
           elsif result == Markers::LOUD_VALUE
@@ -364,7 +431,7 @@ module I18n
                 r = interpolate_core(Markers::PATTERN + kinds.next.to_s + Markers::PATTERN_BEGIN + token.to_s +
                                      Operators::Tokens::ASSIGN + value.to_s + Operators::Tokens::OR +
                                      Markers::PATTERN + Markers::PATTERN_END, locale, options)
-                break if r == Markers::PATTERN
+                break if r == Markers::PATTERN # using this marker only as a helper to indicate empty result!
               else
                 r = interpolate_core(Markers::PATTERN + kinds.next.to_s + Markers::PATTERN_BEGIN + token.to_s +
                                      Operators::Tokens::ASSIGN + value.to_s + Markers::PATTERN_END, locale, options)