Class: SleepingKingStudios::Tools::StringTools

Parent Namespace

SleepingKingStudios::Tools

Inherited Classes

SleepingKingStudios::Tools::Base > Object

Defined In

lib/sleeping_king_studios/tools/string_tools.rb

Table Of Contents

• Overview
• Class Methods
  • instance
• Constructor
• Instance Attributes
  • inflector
• Instance Methods
  • camelize
  • chain
  • indent
  • initialize
  • map_lines
  • plural?
  • pluralize
  • singular?
  • singularize
  • string?
  • underscore

Overview

Tools for working with strings.

Back To Top

Class Methods

.instance => SleepingKingStudios::Tools::Base

Inherited From

SleepingKingStudios::Tools::Base

Returns

• (SleepingKingStudios::Tools::Base) — a memoized instance of the tools class.

Back To Top

Constructor

#initialize(inflector: nil) => StringTools

Parameters

• inflector (Object) — service object for inflecting strings. The inflector must be an object that conforms to the interface used by by SleepingKingStudios::Tools::Toolbox::Inflector, such as an instance of ActiveSupport::Inflector .

Returns

• (StringTools) — a new instance of StringTools

Back To Top

Instance Attributes

#inflector => Object (readonly)

Returns

• (Object) — service object for inflecting strings.

Back To Top

Instance Methods

#camelize(str) => String

Converts a lowercase, underscore-separated string to CamelCase.

Examples

StringTools#camelize 'valhalla'
#=> 'Valhalla'

StringTools#camelize 'muspelheimr_and_niflheimr'
#=> 'MuspelheimrAndNiflheimr'

Parameters

• str (String) — the string to convert.

Returns

• (String) — the converted string.

See Also

• SleepingKingStudios::Tools::Toolbox::Inflector#camelize

#chain(str, *commands) => String

Performs a series of operations on the string.

Use #chain to call each specified method in the chain in sequence, passing the output of each method to the next method.

Examples

# Equivalent to `StringTools.underscore(StringTools.pluralize str)`.
StringTools#chain 'ArchivedPeriodical', :underscore, :pluralize
# => 'archived_periodicals'

Parameters

• str (String) — the string to process.
• commands (Array<String, Symbol>) — the string operations to apply.

Returns

• (String) — the processed string.

#indent(str, count = 2) => String

Adds the specified number of spaces to the start of each line.

Examples

string = 'The Hobbit'
StringTools.indent(string)
#=> '  The Hobbit'

titles = [
  "The Fellowship of the Ring",
  "The Two Towers",
  "The Return of the King"
]
string = titles.join "\n"
StringTools.indent(string, 4)
#=> "    The Fellowship of the Ring\n"\
    "    The Two Towers\n"\
    "    The Return of the King"

Parameters

• str (String) — the string to indent.
• count (Integer) — the number of spaces to add. Defaults to 2.

Returns

• (String) — the indented string.

#map_lines(str) => String

Yields each line to the provided block and combines the results.

The results of each line are combined back into a new multi-line string.

Examples

string = 'The Hobbit'
StringTools.map_lines(string) { |line| "  #{line}" }
#=> '- The Hobbit'

titles = [
  "The Fellowship of the Ring",
  "The Two Towers",
  "The Return of the King"
]
string = titles.join "\n"
StringTools.map_lines(string) { |line, index| "#{index}. #{line}" }
#=> "0. The Fellowship of the Ring\n"\
    "1. The Two Towers\n"\
    "2. The Return of the King"

Parameters

• str (String) — the string to map.

Yield Parameters

• line (String) — the current line.
• index (Integer) — the index of the current line.

Yield Returns

• (String) — the modified line.

Returns

• (String) — the mapped and recombined string.

#plural?(word) => Boolean

Determines whether or not the given word is in plural form.

If calling #pluralize(word) is equal to word, the word is considered plural.

Examples

StringTools.plural? 'light'
#=> false

StringTools.plural? 'lights'
#=> true

Parameters

• word (String) — the word to check.

Returns

• (Boolean) — true if the word is in plural form, otherwise false.

See Also

• #pluralize

#pluralize(str) => String

Takes a word in singular form and returns the plural form.

This method delegates to the configured inflector, which converts the given word based on the defined rules and known irregular/uncountable words.

Examples

StringTools.pluralize 'light'
#=> 'lights'

Parameters

• str (String) — the word to pluralize.

Returns

• (String) — the pluralized word.

See Also

• SleepingKingStudios::Tools::Toolbox::Inflector#pluralize

#singular?(word) => Boolean

Determines whether or not the given word is in singular form.

If calling #singularize(word) is equal to word, the word is considered singular.

Examples

StringTools.singular? 'light'
#=> true

StringTools.singular? 'lights'
#=> false

Parameters

• word (String) — the word to check.

Returns

• (Boolean) — true if the word is in singular form, otherwise false.

See Also

• #singularize

#singularize(str) => String

Transforms the word to a singular, lowercase form.

This method delegates to the configured inflector, which converts the given word based on the defined rules and known irregular/uncountable words.

Examples

StringTools.singularize 'lights'
#=> 'light'

Parameters

• str (String) — the word to transform.

Returns

• (String) — the word in singular form. @see SleepingKingStudios::Tools::Toolbox::Inflector#singularize.

#string?(str) => Boolean

Returns true if the object is a String.

Examples

StringTools.string?(nil)
#=> false
StringTools.string?([])
#=> false
StringTools.string?('Greetings, programs!')
#=> true
StringTools.string?(:greetings_starfighter)
#=> false

Parameters

• str (Object) — the object to test.

Returns

• (Boolean) — true if the object is a String, otherwise false.

#underscore(str) => String

Converts a mixed-case string to a lowercase, underscore separated string.

Examples

StringTools#underscore 'Bifrost'
#=> 'bifrost'

StringTools#underscore 'FenrisWolf'
#=> 'fenris_wolf'

Parameters

• str (String) — the string to convert.

Returns

• (String) — the converted string.

See Also

• SleepingKingStudios::Tools::Toolbox::Inflector#underscore

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Tools