Class: String (Ruby 2.3.7)
Description: Class : String - Ruby 2.3.7

- Home
- Core 2.3.7
- Std-lib 2.3.7
- Downloads

Support for the Ruby 2.3 series has ended. See here for reference.

### Home Classes Methods

### In Files

- unicode_normalize.rb

### Parent

Object

### Methods

- #unicode_normalize
- #unicode_normalize!
- #unicode_normalized?

### Class/Module Index

Quicksearch

- String
- UnicodeNormalize

No matching classes.

# String

additions to class String for Unicode normalization

### Public Instance Methods

unicode_normalize(form=:nfc) click to toggle source

### Unicode Normalization¶ ↑

Returns a normalized form of `str`, using Unicode normalizations NFC, NFD, NFKC, or NFKD. The normalization form used is determined by `form`, which is any of the four values :nfc, :nfd, :nfkc, or :nfkd. The default is :nfc.

If the string is not in a Unicode Encoding, then an Exception is raised. In this context, 'Unicode Encoding' means any of UTF-8, UTF-16BE/LE, and UTF-32BE/LE, as well as GB18030, UCS_2BE, and UCS_4BE. Anything else than UTF-8 is implemented by converting to UTF-8, which makes it slower than UTF-8.

Examples

    "a\u0300".unicode_normalize        #=> 'à' (same as "\u00E0")
    "a\u0300".unicode_normalize(:nfc)  #=> 'à' (same as "\u00E0")
    "\u00E0".unicode_normalize(:nfd)   #=> 'à' (same as "a\u0300")
    "\xE0".force_encoding('ISO-8859-1').unicode_normalize(:nfd)
                                       #=> Encoding::CompatibilityError raised

                   # File unicode_normalize.rb, line 30
    def unicode_normalize(form = :nfc)
      require 'unicode_normalize/normalize.rb' unless defined? UnicodeNormalize
      ## The following line can be uncommented to avoid repeated checking for
      ## UnicodeNormalize. However, tests didn't show any noticeable speedup
      ## when doing this. This comment also applies to the commented out lines
      ## in String#unicode_normalize! and String#unicode_normalized?.
      # String.send(:define_method, :unicode_normalize, ->(form = :nfc) { UnicodeNormalize.normalize(self, form) } )
      UnicodeNormalize.normalize(self, form)
    end

unicode_normalize!(form=:nfc) click to toggle source

Destructive version of #unicode_normalize, doing Unicode normalization in place.

                   # File unicode_normalize.rb, line 46
    def unicode_normalize!(form = :nfc)
      require 'unicode_normalize/normalize.rb' unless defined? UnicodeNormalize
      # String.send(:define_method, :unicode_normalize!, ->(form = :nfc) { replace(unicode_normalize(form)) } )
      replace(unicode_normalize(form))
    end

unicode_normalized?(form=:nfc) click to toggle source

Checks whether `str` is in Unicode normalization form `form`, which is any of the four values :nfc, :nfd, :nfkc, or :nfkd. The default is :nfc.

If the string is not in a Unicode Encoding, then an Exception is raised. For details, see #unicode_normalize.

Examples

    "a\u0300".unicode_normalized?        #=> false
    "a\u0300".unicode_normalized?(:nfd)  #=> true
    "\u00E0".unicode_normalized?         #=> true
    "\u00E0".unicode_normalized?(:nfd)   #=> false
    "\xE0".force_encoding('ISO-8859-1').unicode_normalized?
                                         #=> Encoding::CompatibilityError raised

                   # File unicode_normalize.rb, line 71
    def unicode_normalized?(form = :nfc)
      require 'unicode_normalize/normalize.rb' unless defined? UnicodeNormalize
      # String.send(:define_method, :unicode_normalized?, ->(form = :nfc) { UnicodeNormalize.normalized?(self, form) } )
      UnicodeNormalize.normalized?(self, form)
    end