Class: String
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/unicode_normalize.rb |
Overview
additions to class String
for Unicode normalization
Instance Method Summary
-
#unicode_normalize(form = :nfc)
Unicode Normalization.
-
#unicode_normalize!(form = :nfc)
Destructive version of #unicode_normalize, doing Unicode normalization in place.
-
#unicode_normalized?(form = :nfc) ⇒ Boolean
Checks whether
str
is in Unicode normalization formform
, which is any of the four values:nfc
,:nfd
,:nfkc
, or:nfkd
.
Instance Method Details
#unicode_normalize(form = :nfc)
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) #=> 'à' (same as "a\u0300")
"\xE0".force_encoding('ISO-8859-1').unicode_normalize(:nfd)
#=> Encoding::CompatibilityError raised
# File 'lib/unicode_normalize.rb', line 32
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)
Destructive version of #unicode_normalize, doing Unicode normalization in place.
# File 'lib/unicode_normalize.rb', line 48
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) ⇒ Boolean
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 'lib/unicode_normalize.rb', line 73
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