Class: SleepingKingStudios::Tools::Toolbox::Inflector

Parent Namespace

SleepingKingStudios::Tools::Toolbox

Extended Modules

Forwardable

Defined In

lib/sleeping_king_studios/tools/toolbox/inflector.rb

Table Of Contents

• Overview
  • See Also
• Defined Under Namespace
• Constructor
• Instance Attributes
  • rules
• Instance Methods
  • camelize
  • initialize
  • pluralize
  • singularize
  • underscore

Overview

Service object for transforming strings.

Internally, an instance of this class is used to StringTools to perform string transformations.

This class should define a compatible interface with ActiveSupport::Inflector, i.e. all methods defined on Toolbox::Inflector should have a corresponding method on ActiveSupport::Inflector with a superset of the parameters. (The reverse is not true).

See Also

• SleepingKingStudios::Tools::StringTools

Back To Top

Defined Under Namespace

Classes

Rules

Back To Top

Constructor

#initialize(rules: nil) => Inflector

Parameters

• rules (SleepingKingStudios::Tools::Toobox::Inflector::Rules) — an object defining the transformation rules.

Returns

• (Inflector) — a new instance of Inflector

Back To Top

Instance Attributes

#rules => SleepingKingStudios::Tools::Toobox::Inflector::Rules (readonly)

Returns

• (SleepingKingStudios::Tools::Toobox::Inflector::Rules) — an object defining the transformation rules.

Back To Top

Instance Methods

#camelize(word, uppercase_first_letter = true) => String

Converts a lowercase, underscore-separated string to CamelCase.

Parameters

• word (String) — the word to transform.
• uppercase_first_letter (Boolean) — if true, the first letter is capitalized. Defaults to true.

Returns

• (String) — the word in CamelCase.

#pluralize(word) => String

Transforms the word to a plural, lowercase form.

Parameters

• word (String) — the word to transform.

Returns

• (String) — the word in plural form.

#singularize(word) => String

Transforms the word to a singular, lowercase form.

Parameters

• word (String) — the word to transform.

Returns

• (String) — the word in singular form.

#underscore(word) => String

Transforms the word to a lowercase, underscore-separated form.

Parameters

• word (String) — the word to transform.

Returns

• (String) — the word in underscored form.

Back To Top

---

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