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

Parent Namespace

SleepingKingStudios::Tools::Toolbox::Inflector

Defined In

lib/sleeping_king_studios/tools/toolbox/inflector/rules.rb

Table Of Contents

• Overview
• Constructor
• Instance Attributes
  • irregular_words
  • irregular_words_reversed
  • plural_rules
  • singular_rules
  • uncountable_words
• Instance Methods
  • define_irregular_word
  • define_plural_rule
  • define_singular_rule
  • define_uncountable_word
  • initialize
  • inspect

Overview

Rules for inflecting words.

Back To Top

Constructor

#initialize(irregular_words: nil, plural_rules: nil, singular_rules: nil, uncountable_words: nil) => Rules

Parameters

• irregular_words (Hash<String, String>) — irregular word pairs in singular => plural order, e.g. "child" => "children".
• plural_rules (Array<Array<(Regexp, String)>>) — rules for pluralizing words.
• singular_rules (Array<Array<(Regexp, String)>>) — rules for singularizing words.
• uncountable_words (Array<String>) — uncountable words e.g. "data".

Returns

• (Rules) — a new instance of Rules

Back To Top

Instance Attributes

#irregular_words => Array<Array<(String, String)>> (readonly)

Returns

• (Array<Array<(String, String)>>) — irregular word pairs in singular => plural order.

#irregular_words_reversed => Array<Array<(String, String)>> (readonly)

Returns

• (Array<Array<(String, String)>>) — irregular word pairs in plural => singular order.

#plural_rules => Array<Array<(Regexp, String)>> (readonly)

Returns

• (Array<Array<(Regexp, String)>>) — rules for pluralizing words.

#singular_rules => Array<Array<(Regexp, String)>> (readonly)

Returns

• (Array<Array<(Regexp, String)>>) — rules for singularizing words.

#uncountable_words => Array<String> (readonly)

Returns

• (Array<String>) — uncountable words.

Back To Top

Instance Methods

#define_irregular_word(singular, plural) => self

Defines an irregular word pair.

Parameters

• singular (String) — the singular form of the word.
• plural (String) — the plural form of the word.

Returns

• (self) — the rules object.

#define_plural_rule(pattern, replace) => self

Defines a pluralization rule.

Parameters

• pattern (Regexp) — the pattern to match.
• replace (String) — the string to replace.

Returns

• (self) — the rules object.

#define_singular_rule(pattern, replace) => self

Defines a singularization rule.

Parameters

• pattern (Regexp) — the pattern to match.
• replace (String) — the string to replace.

Returns

• (self) — the rules object.

#define_uncountable_word(word) => self

Defines an uncountable word.

Parameters

• word (String) — the uncountable word.

Returns

• (self) — the rules object.

#inspect => String

Returns

• (String) — a human-readable representation of the rules object.

Back To Top

---

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