Parent

String

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.

Constants

INTERPOLATION_PATTERN
INTERPOLATION_PATTERN_WITH_ESCAPE

Public Instance Methods

%(args) click to toggle source

% uses self (i.e. the String) as a format specification and returns the result of applying it to the given arguments. In other words it interpolates the given arguments to the string according to the formats the string defines.

There are three ways to use it:

  • Using a single argument or Array of arguments.

    This is the default behaviour of the String class. See Kernel#sprintf for more details about the format string.

    Example:

      "%d %s" % [1, "message"]
      # => "1 message"
    
  • Using a Hash as an argument and unformatted, named placeholders.

    When you pass a Hash as an argument and specify placeholders with %{foo} it will interpret the hash values as named arguments.

    Example:

      "%{firstname}, %{lastname}" % {:firstname => "Masao", :lastname => "Mutoh"}
      # => "Masao Mutoh"
    
  • Using a Hash as an argument and formatted, named placeholders.

    When you pass a Hash as an argument and specify placeholders with %d it will interpret the hash values as named arguments and format the value according to the formatting instruction appended to the closing >.

    Example:

      "%<integer>d, %<float>.1f" % { :integer => 10, :float => 43.4 }
      # => "10, 43.3"
    # File lib/i18n/core_ext/string/interpolate.rb, line 79
79:     def %(args)
80:       if args.kind_of?(Hash)
81:         dup.gsub(INTERPOLATION_PATTERN_WITH_ESCAPE) do |match|
82:           if match == '%%'
83:             '%'
84:           else
85:             key = ($1 || $2).to_sym
86:             raise KeyError unless args.has_key?(key)
87:             $3 ? sprintf("%#{$3}", args[key]) : args[key]
88:           end
89:         end
90:       elsif self =~ INTERPOLATION_PATTERN
91:         raise ArgumentError.new('one hash required')
92:       else
93:         result = gsub(/%([{<])/, '%%\1')
94:         result.send :'interpolate_without_ruby_19_syntax', args
95:       end
96:     end
interpolate_without_ruby_19_syntax(args) click to toggle source
Alias for: %

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.