class ActiveSupport::Multibyte::Chars

Parent:: Объект
Included modules:

Active Support Multibyte Chars

Chars позволяет работать с кодировкой UTF-8 в классе Ruby String прозрачно, без глубокого знания кодировок. Объект Chars принимает строку при инициализации и делегирует методы класса String безопасным образом, учитывая кодировку. Все стандартные методы класса String также реализованы на этом прокси.

Методы класса String делегируются объекту Chars и могут быть вызваны через метод mb_chars. Методы, которые обычно возвращают объект String, теперь возвращают объект Chars, что позволяет цепочку вызовов методов.

'The Perfect String  '.mb_chars.downcase.strip
# => #<ActiveSupport::Multibyte::Chars:0x007fdc434ccc10 @wrapped_string="the perfect string">

Объекты Chars идеально совместимы с объектами String, если не выполняются явные проверки класса. Если некоторые методы явно проверяют класс, вызовите to_s перед передачей объектов chars.

bad.explicit_checking_method 'T'.mb_chars.downcase.to_s

По умолчанию реализация Chars предполагает, что кодировка строки UTF-8. Если вам нужно обработать другие кодировки, вы можете написать свой обработчик многобайтовых строк и настроить его через ActiveSupport::Multibyte.proxy_class.

class CharsForUTF32
  def size
    @wrapped_string.size / 4
  end

  def self.accepts?(string)
    string.length % 4 == 0
  end
end

ActiveSupport::Multibyte.proxy_class = CharsForUTF32

Атрибуты

to_s[R]

to_str[R]

wrapped_string[R]

Публичные методы класса

new(string) Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 56
def initialize(string)
  @wrapped_string = string
  @wrapped_string.force_encoding(Encoding::UTF_8) unless @wrapped_string.frozen?
end

Создает новый экземпляр Chars, обернув строку.

Публичные методы экземпляра

compose() Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 140
def compose
  chars(Unicode.compose(@wrapped_string.codepoints.to_a).pack("U*"))
end

Выполняет композицию для всех символов.

'é'.length                       # => 1
'é'.mb_chars.compose.to_s.length # => 1

decompose() Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 132
def decompose
  chars(Unicode.decompose(:canonical, @wrapped_string.codepoints.to_a).pack("U*"))
end

Выполняет каноническое разложение для всех символов.

'é'.length                         # => 1
'é'.mb_chars.decompose.to_s.length # => 2

grapheme_length() Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 148
def grapheme_length
  @wrapped_string.grapheme_clusters.length
end

Возвращает количество графемных кластеров в строке.

'क्षि'.mb_chars.length   # => 4
'क्षि'.mb_chars.grapheme_length # => 2

limit(limit) Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 115
def limit(limit)
  chars(@wrapped_string.truncate_bytes(limit, omission: nil))
end

Ограничивает размер строки по количеству байт без разрыва символов. Используется, когда хранилище строки ограничено по какой-либо причине.

'こんにちは'.mb_chars.limit(7).to_s # => "こん"

method_missing(method, *args, &block) Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 62
def method_missing(method, *args, &block)
  result = @wrapped_string.__send__(method, *args, &block)
  if method.end_with?("!")
    self if result
  else
    result.kind_of?(String) ? chars(result) : result
  end
end

Перенаправляет все неопределенные методы на обернутую строку.

respond_to_missing?(method, include_private) Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 74
def respond_to_missing?(method, include_private)
  @wrapped_string.respond_to?(method, include_private)
end

Возвращает true, если объект отвечает на данный метод. Приватные методы включаются в поиск только если необязательный второй параметр равен true.

reverse() Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 106
def reverse
  chars(@wrapped_string.grapheme_clusters.reverse.join)
end

Инвертирует все символы в строке.

'Café'.mb_chars.reverse.to_s # => 'éfaC'

slice!(*args) Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 96
def slice!(*args)
  string_sliced = @wrapped_string.slice!(*args)
  if string_sliced
    chars(string_sliced)
  end
end

Действует как String#slice!, но возвращает экземпляр Chars, или nil если строка не была изменена. Строка не изменится, если заданный диапазон находится за пределами границ.

string = 'Welcome'
string.mb_chars.slice!(3)    # => #<ActiveSupport::Multibyte::Chars:0x000000038109b8 @wrapped_string="c">
string # => 'Welome'
string.mb_chars.slice!(0..3) # => #<ActiveSupport::Multibyte::Chars:0x00000002eb80a0 @wrapped_string="Welo">
string # => 'me'

split(*args) Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 83
def split(*args)
  @wrapped_string.split(*args).map { |i| self.class.new(i) }
end

Действует аналогично String#split, за исключением того, что элементы в результирующем списке являются экземплярами Chars, а не String. Это упрощает цепочку вызовов методов.

'Café périferôl'.mb_chars.split(/é/).map { |part| part.upcase.to_s } # => ["CAF", " P", "RIFERÔL"]

tidy_bytes(force = false) Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 157
def tidy_bytes(force = false)
  chars(Unicode.tidy_bytes(@wrapped_string, force))
end

Заменяет все символы ISO-8859-1 или CP1252 на их UTF-8 эквиваленты, получая валидную UTF-8 строку.

Передача true принудительно приведет к приведению всех байтов к стандартному виду, предполагая, что кодировка строки полностью CP1252 или ISO-8859-1.

titlecase()

Псевдоним для: titleize

titleize() Показать исходный код

# File activesupport/lib/active_support/multibyte/chars.rb, line 123
def titleize
  chars(downcase.to_s.gsub(/\b('?\S)/u) { $1.upcase })
end

Преобразует первую букву каждого слова в заглавную, если это возможно.

"ÉL QUE SE ENTERÓ".mb_chars.titleize.to_s    # => "Él Que Se Enteró"
"日本語".mb_chars.titleize.to_s               # => "日本語"

Также алиас: titlecase