Class: String

Class | String
In: | lib/gettext/core_ext/string.rb
Parent: | Object

Extension for String class. This feature is included in Ruby 1.9 or later but not occur TypeError.

String#% method which accept "named argument". The translator can know the meaning of the msgids using "named argument" instead of %s/%d style.

### Methods

%

### Constants

PERCENT_MATCH_RE | = | Regexp.union( /%%/, /%\{(\w+)\}/, /%<(\w+)>(.*?\d*\.?\d*[bBdiouxXeEfgGcps])/

### External Aliases

size | -> | bytesize
| For older ruby (such as ruby-1.8.5)
% | -> | _old_format_m

### Public Instance methods

%(arg)
%(hash)

Format - Uses str as a format specification, and returns the result of applying it to arg. If the format specification contains more than one substitution, then arg must be an Array containing the values to be substituted. See Kernel::sprintf for details of the format string. This is the default behavior of the String class.

- arg: an Array or other class except Hash.
- Returns: formatted String

     (e.g.) "%s, %s" % ["Masao", "Mutoh"]

Also you can use a Hash as the "named argument". This is recommanded way for Ruby-GetText because the translators can understand the meanings of the msgids easily.

- hash: {:key1 => value1, :key2 => value2, … }
- Returns: formatted String

     (e.g.)
            For strings.
            "%{firstname}, %{familyname}" % {:firstname => "Masao", :familyname => "Mutoh"}

            With field type to specify format such as d(decimal), f(float),...
            "%<age>d, %<weight>.1f" % {:age => 10, :weight => 43.4}

[Validate]