Merge pull request #30 from benjGam/develop

Release 2.4.0

Author: benjGam

CHANGELOG.md

@@ -1,7 +1,15 @@
+# Version 2.4.0
+
+- `Added`:
+  - `WordEnding` class has been implemented to replace `IWordEnding` interface.
+  - `getPluralOf(str: string): string`, `getSingularOf(str: string): string` methods has been implemented to get respectively `plural` & `singular` form of a given one.
+- `Removed` [BREAKING CHANGES]:
+  - `IWordEnding` interface has been removed.
+
 # Version 2.3.1
 
 - `Fixes`:
-  - Export for cases component are now availables.
+  - Exports for cases component are now availables.
 
 # Version 2.3.0
 
@@ -49,7 +57,7 @@
 - Added:
   - Unit testing is now part of this project.
   - TSDoc has been adopted and is now part of this project.
-  - Code quality components is now part of this project (ESLint & Prettier)
+  - Code quality components are now part of this project (ESLint & Prettier)
 - Performance:
   - Code has been reworked to improve performance (**A performance measurer should be implemented in next realases**)
 
@@ -75,4 +83,4 @@
   - `isPlural();` - [FIX] Bring a fix to case where provided words ended with `ss`, there's no confusion, method now manage those cases.
   - `isSingular();`, `pluralize();`, `singularize();` - moved from `StringUtils` to `StringUtilsWord` class.
   - `formatWord();` - has been reworked and now use `StringUtils.replaceAt();` method to optimize process.
-  - `normalizeSpacesBetweenWords();` - to be be rework in next release.
+  - `normalizeSpacesBetweenWords();` - to be rework in next release.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "string-utils-ts",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "Provide some useful functions for strings",
   "main": "./lib",
   "scripts": {

src/case/camel-case.ts

@@ -1,6 +1,6 @@
 import Case from './Case';
 import StringUtilsCase from './utils';
-import StringUtilsWord from '../word';
+import StringUtilsWord from '../word/utils';
 import { StringUtils } from '../main';
 
 export default class CamelCase extends Case {

src/case/pascal-case.ts

@@ -1,5 +1,5 @@
 import Case from './Case';
-import StringUtilsWord from '../word';
+import StringUtilsWord from '../word/utils';
 import { StringUtils } from '../main';
 
 export default class PascalCase extends Case {

src/case/snake-case.ts

@@ -1,6 +1,6 @@
 import Case from './Case';
 import StringUtilsCase from './utils';
-import StringUtilsWord from '../word';
+import StringUtilsWord from '../word/utils';
 
 export default class SnakeCase extends Case {
   protected _matcher = /(\w+)_(\w+)/;

src/index.ts

@@ -1,2 +1,3 @@
 export * from './main';
-export * from './word';
+export * from './word/';
+export * from './case';

src/main.ts

@@ -1,4 +1,4 @@
-import StringUtilsWord from './word';
+import StringUtilsWord from './word/utils';
 
 export class StringUtils {
   /**

src/word/index.ts

@@ -0,0 +1,2 @@
+export * from './word-ending';
+export * from './utils';

src/word.ts renamed to src/word/utils.ts

@@ -1,42 +1,15 @@
-import { StringUtils } from './main';
-
-/**
- * This interface provide a structure to register word endings forms
- *
- * @interface IWordEnding
- * @field {string} pluralForm is used to store a plural form of ending
- * @field {string} singularForm is used to store the singular form of the plural form ending
- *
- * @example
- * pluralForm: 'ies'
- * singularForm: 'y'
- */
-export interface IWordEnding {
-  pluralForm: string;
-  singularForm: string;
-}
+import { StringUtils } from '../main';
+import { WordEnding } from './word-ending';
 
 /**
  * This object is used to list plural and singular forms
  * of words.
  */
-const wordEndings: IWordEnding[] = [
-  {
-    pluralForm: 'sses',
-    singularForm: 'ss',
-  },
-  {
-    pluralForm: 'ies',
-    singularForm: 'y',
-  },
-  {
-    pluralForm: 'es',
-    singularForm: 'e',
-  },
-  {
-    pluralForm: 's',
-    singularForm: '',
-  },
+const wordEndings: WordEnding[] = [
+  new WordEnding('sses', 'ss'),
+  new WordEnding('ies', 'y'),
+  new WordEnding('es', 'e'),
+  new WordEnding('s', ''),
 ];
 
 /**
@@ -79,13 +52,47 @@ export default class StringUtilsWord {
    * If you just want to do some word operation, prefer
    * @method getWordEnding
    */
-  public static getCorrespondingEnding(word: string): IWordEnding {
+  public static getCorrespondingEnding(word: string): WordEnding {
     return wordEndings.find(
       (ending) =>
         word.endsWith(ending.pluralForm) || word.endsWith(ending.singularForm),
     );
   }
 
+  /**
+   * Returns the plural form of a singular one.
+   *
+   * @param {string} str - Should be a singular form
+   *
+   * @example
+   * str: 'y'
+   * returns: 'ies'
+   *
+   * @example
+   * str: 'ss'
+   * returns: 'sses'
+   */
+  public static getPluralOf(str: string): string {
+    return this.getCorrespondingEnding(str).pluralForm;
+  }
+
+  /**
+   * Returns the singular form of a plural one.
+   *
+   * @param {string} str - Should be a plural form
+   *
+   * @example
+   * str: 'ies'
+   * returns: 'y'
+   *
+   * @example
+   * str: 'sses'
+   * returns: 'ss'
+   */
+  public static getSingularOf(str: string): string {
+    return this.getCorrespondingEnding(str).singularForm;
+  }
+
   /**
    * Check the ending form of a word and return a boolean
    *

src/word/word-ending.ts

@@ -0,0 +1,23 @@
+export class WordEnding {
+  private _pluralForm: string;
+  private _singularForm: string;
+
+  constructor(pluralForm: string, singularForm: string) {
+    this._pluralForm = pluralForm;
+    this._singularForm = singularForm;
+  }
+
+  /**
+   * Returns the plural of stored singular form
+   */
+  public get pluralForm(): string {
+    return this._pluralForm;
+  }
+
+  /**
+   * Returns the singular of stored plural form
+   */
+  public get singularForm(): string {
+    return this._singularForm;
+  }
+}