Class: ConvenientService::Utils::String::Truncate Private

Inherits:
Support::Command show all
Defined in:
lib/convenient_service/utils/string/truncate.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Examples:

ConvenientService::Utils::String.truncate("hello", -1)                 # => ""
ConvenientService::Utils::String.truncate("hello", 0)                  # => ""
ConvenientService::Utils::String.truncate("hello", 1)                  # => "."
ConvenientService::Utils::String.truncate("hello", 2)                  # => ".."
ConvenientService::Utils::String.truncate("hello", 3)                  # => "..."
ConvenientService::Utils::String.truncate("hello", 4)                  # => "h..."
ConvenientService::Utils::String.truncate("hello", 4, omission: "--")  # => "he--"
ConvenientService::Utils::String.truncate("hello", 5)                  # => "hello"
ConvenientService::Utils::String.truncate("hello", 6)                  # => "hello"
ConvenientService::Utils::String.truncate("hello", 7)                  # => "hello"

Since:

  • 1.0.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Support::Command

[], call

Constructor Details

#initialize(string, truncate_at, omission: "...") ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • string (#to_s)
  • truncate_at (Integer)
  • omission (String) (defaults to: "...")

Since:

  • 1.0.0



53
54
55
56
57
 
# File 'lib/convenient_service/utils/string/truncate.rb', line 53

def initialize(string, truncate_at, omission: "...")
  @string = string.to_s
  @truncate_at = truncate_at
  @omission = omission
end

Instance Attribute Details

#omission ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 1.0.0



45
46
47
 
# File 'lib/convenient_service/utils/string/truncate.rb', line 45

def omission
  @omission
end

#string ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 1.0.0



33
34
35
 
# File 'lib/convenient_service/utils/string/truncate.rb', line 33

def string
  @string
end

#truncate_at ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 1.0.0



39
40
41
 
# File 'lib/convenient_service/utils/string/truncate.rb', line 39

def truncate_at
  @truncate_at
end

Instance Method Details

#call ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

Since:

  • 1.0.0



62
63
64
65
66
67
68
69
70
 
# File 'lib/convenient_service/utils/string/truncate.rb', line 62

def call
  return "" if truncate_at <= 0

  return string if truncate_at >= string.length

  return omission[...truncate_at] if truncate_at <= omission.length

  "#{string[...truncate_at - omission.length]}#{omission}"
end