method

truncate_bytes

v7.1.3.4 - Show latest stable - 0 notes - Class: String

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0 (0)
6.1.3.1 (0)
6.1.7.7 (0)
7.0.0 (0)
7.1.3.2 (38)
7.1.3.4 (0)
What's this?

truncate_bytes(truncate_to, omission: "â¦") public

Truncates text to at most truncate_to bytes in length without breaking string encoding by splitting multibyte characters or breaking grapheme clusters (“perceptual characters”) by truncating at combining characters.

>> "ðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðª".size
=> 20
>> "ðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðª".bytesize
=> 80
>> "ðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðªðª".truncate_bytes(20)
=> "ðªðªðªðªâ¦"

The truncated text ends with the :omission string, defaulting to “â¦”, for a total length not exceeding truncate_to.

Raises ArgumentError when the bytesize of :omission exceeds truncate_to.

Show source

# File activesupport/lib/active_support/core_ext/string/filters.rb, line 101
  def truncate_bytes(truncate_to, omission: "â¦")
    omission ||= ""

    case
    when bytesize <= truncate_to
      dup
    when omission.bytesize > truncate_to
      raise ArgumentError, "Omission #{omission.inspect} is #{omission.bytesize}, larger than the truncation length of #{truncate_to} bytes"
    when omission.bytesize == truncate_to
      omission.dup
    else
      self.class.new.tap do |cut|
        cut_at = truncate_to - omission.bytesize

        each_grapheme_cluster do |grapheme|
          if cut.bytesize + grapheme.bytesize <= cut_at
            cut << grapheme
          else
            break
          end
        end

        cut << omission
      end
    end
  end

truncate_bytes

Related methods