Module: Verse

Defined in:

lib/verse.rb,
lib/verse/padder.rb,
lib/verse/padding.rb,
lib/verse/version.rb,
lib/verse/wrapping.rb,
lib/verse/alignment.rb,
lib/verse/sanitizer.rb,
lib/verse/truncation.rb

Defined Under Namespace

Modules: Sanitizer Classes: Alignment, Padder, Padding, Truncation, Wrapping

Constant Summary

SPACE =

' '.freeze

NEWLINE =

"\n".freeze

RESET =

"\e[0m".freeze

ANSI =

"\033".freeze

SPACE_RE =

%r{\s+}mo.freeze

NEWLINE_RE =

%r{\n}o.freeze

ParseError =

Class.new(ArgumentError)

VERSION =

'0.5.0'

Class Method Summary

• .align(text, width, direction, options = {}) ⇒ Object

  Align a text to a given direction with the width.

• .pad(text, padding, options = {}) ⇒ Object

  Pad a text around with a given padding.

• .truncate(text, truncate_at, options = {}) ⇒ Object

  Truncate a text at a given length.

• .wrap(text, wrap_at, options = {}) ⇒ Object

  Wrap a text into lines at wrap length.

Class Method Details

.align(text, width, direction, options = {}) ⇒ Object

Align a text to a given direction with the width

See Also:

• Verse::Alignment#align

# File 'lib/verse.rb', line 28

def self.align(text, width, direction, options = {})
  Alignment.align(text, width, direction, options)
end

.pad(text, padding, options = {}) ⇒ Object

Pad a text around with a given padding

See Also:

• Verse::Padding#pad

# File 'lib/verse.rb', line 37

def self.pad(text, padding, options = {})
  Padding.pad(text, padding, options)
end

.truncate(text, truncate_at, options = {}) ⇒ Object

Truncate a text at a given length

See Also:

• Verse::Truncation#truncate

# File 'lib/verse.rb', line 46

def self.truncate(text, truncate_at, options = {})
  Truncation.truncate(text, truncate_at, options)
end

.wrap(text, wrap_at, options = {}) ⇒ Object

Wrap a text into lines at wrap length

See Also:

• Verse::Wrapping#wrap

# File 'lib/verse.rb', line 55

def self.wrap(text, wrap_at, options = {})
  Wrapping.wrap(text, wrap_at, options)
end