camelCase module

Author: ot-of-fincra

LEARN.md

@@ -23,48 +23,48 @@ If you're new to **String-Methods**, here are some steps to get you started:
 
 ## Project Documentation
 
-- [Capitalize Module](string-methods/docs/capitalize.md)
-- [CaseFolder Module](string-methods/docs/caseFolder.md)
-- [Center Module](string-methods/docs/center.md)
-- [Count Module](string-methods/docs/count.md)
-- [Encode Module](string-methods/docs/encode.md)
-- [EndsWith Module](string-methods/docs/endsWith.md)
-- [ExpandTabs Module](string-methods/docs/expandTabs.md)
-- [Find Module](string-methods/docs/find.md)
-- [Format Module](string-methods/docs/format.md)
-- [IsAlnum Module](string-methods/docs/isAlnum.md)
-- [IsAlpha Module](string-methods/docs/isAlpha.md)
-- [IsAscii Module](string-methods/docs/isAscii.md)
-- [IsDecimal Module](string-methods/docs/isDecimal.md)
-- [IsDigit Module](string-methods/docs/isDigit.md)
-- [IsIdentifier Module](string-methods/docs/isIdentifier.md)
-- [IsLower Module](string-methods/docs/isLower.md)
-- [IsNumeric Module](string-methods/docs/isNumeric.md)
-- [IsSpace Module](string-methods/docs/isSpace.md)
-- [IsTitle Module](string-methods/docs/isTitle.md)
-- [IsUpper Module](string-methods/docs/isUpper.md)
-- [Join Module](string-methods/docs/join.md)
-- [LeftJustify Module](string-methods/docs/leftJustify.md)
-- [LeftStrip Module](string-methods/docs/leftStrip.md)
-- [Lower Module](string-methods/docs/lower.md)
-- [MakeTrans Module](string-methods/docs/makeTrans.md)
-- [Partition Module](string-methods/docs/partition.md)
-- [Replace Module](string-methods/docs/replace.md)
-- [RightFind Module](string-methods/docs/rightFind.md)
-- [RightIndex Module](string-methods/docs/rightIndex.md)
-- [RightJustify Module](string-methods/docs/rightJustify.md)
-- [RightPartition Module](string-methods/docs/rightPartition.md)
-- [RightSplit Module](string-methods/docs/rightSplit.md)
-- [RightStrip Module](string-methods/docs/rightStrip.md)
-- [Split Module](string-methods/docs/split.md)
-- [SplitLines Module](string-methods/docs/splitLines.md)
-- [StartsWith Module](string-methods/docs/startsWith.md)
-- [Strip Module](string-methods/docs/strip.md)
-- [SwapCase Module](string-methods/docs/swapCase.md)
-- [Title Module](string-methods/docs/title.md)
-- [Upper Module](string-methods/docs/upper.md)
-- [ZeroFill Module](string-methods/docs/zeroFill.md)
-
+-   [Capitalize Module](string-methods/docs/capitalize.md)
+-   [CaseFolder Module](string-methods/docs/caseFolder.md)
+-   [Center Module](string-methods/docs/center.md)
+-   [Count Module](string-methods/docs/count.md)
+-   [Encode Module](string-methods/docs/encode.md)
+-   [EndsWith Module](string-methods/docs/endsWith.md)
+-   [ExpandTabs Module](string-methods/docs/expandTabs.md)
+-   [Find Module](string-methods/docs/find.md)
+-   [Format Module](string-methods/docs/format.md)
+-   [IsAlnum Module](string-methods/docs/isAlnum.md)
+-   [IsAlpha Module](string-methods/docs/isAlpha.md)
+-   [IsAscii Module](string-methods/docs/isAscii.md)
+-   [IsDecimal Module](string-methods/docs/isDecimal.md)
+-   [IsDigit Module](string-methods/docs/isDigit.md)
+-   [IsIdentifier Module](string-methods/docs/isIdentifier.md)
+-   [IsLower Module](string-methods/docs/isLower.md)
+-   [IsNumeric Module](string-methods/docs/isNumeric.md)
+-   [IsSpace Module](string-methods/docs/isSpace.md)
+-   [IsTitle Module](string-methods/docs/isTitle.md)
+-   [IsUpper Module](string-methods/docs/isUpper.md)
+-   [Join Module](string-methods/docs/join.md)
+-   [LeftJustify Module](string-methods/docs/leftJustify.md)
+-   [LeftStrip Module](string-methods/docs/leftStrip.md)
+-   [Lower Module](string-methods/docs/lower.md)
+-   [MakeTrans Module](string-methods/docs/makeTrans.md)
+-   [Partition Module](string-methods/docs/partition.md)
+-   [Replace Module](string-methods/docs/replace.md)
+-   [RightFind Module](string-methods/docs/rightFind.md)
+-   [RightIndex Module](string-methods/docs/rightIndex.md)
+-   [RightJustify Module](string-methods/docs/rightJustify.md)
+-   [RightPartition Module](string-methods/docs/rightPartition.md)
+-   [RightSplit Module](string-methods/docs/rightSplit.md)
+-   [RightStrip Module](string-methods/docs/rightStrip.md)
+-   [Split Module](string-methods/docs/split.md)
+-   [SplitLines Module](string-methods/docs/splitLines.md)
+-   [StartsWith Module](string-methods/docs/startsWith.md)
+-   [Strip Module](string-methods/docs/strip.md)
+-   [SwapCase Module](string-methods/docs/swapCase.md)
+-   [Title Module](string-methods/docs/title.md)
+-   [Upper Module](string-methods/docs/upper.md)
+-   [ZeroFill Module](string-methods/docs/zeroFill.md)
+-   [CamelCase Module](string-methods/docs/camelCase.md)
 
 ## Contributing
 
@@ -74,6 +74,6 @@ Interested in contributing to **String-Methods**? Check out the [Contribution Gu
 
 Join our community to connect with other developers, ask questions, and share your experiences:
 
-- [GitHub Discussions](../../discussions)
+-   [GitHub Discussions](../../discussions)
 
 We hope you find this learning guide helpful in your journey with **String-Methods**. If you have any questions or need assistance, feel free to reach out to our community. Happy learning and coding!

string-methods/docs/camelCase.md

@@ -0,0 +1,59 @@
+## CamelCase
+
+This module offers a method for converting strings into camelCase, where the first word is in lowercase and subsequent words are capitalized without spaces.
+
+### Installation
+
+To use this module, you should have the "node-string-methods" npm package installed. You can install it using npm or yarn:
+
+```bash
+npm install node-string-methods
+```
+
+### Usage
+
+```javascript
+const camelCase = require('node-string-methods/camelCase');
+
+// Create an instance of the camelCase class with a string as input
+const str = 'FIRST name LAST';
+const camelCaser = new camelCase(str);
+
+// Execute the capitalization operation
+const result = camelCaser.execute();
+
+console.log(result); // Output: 'firstNameLast'
+```
+
+### Constructor
+
+#### `new CamelCase(str)`
+
+-   `str` (String): The input string that you want to camelcase.
+
+Creates a new instance of the `Camelcase` class with the provided string.
+
+### Methods
+
+#### `execute()`
+
+It will convert a given string into its camelCase form
+
+-   Returns: The camelcase string.
+
+### Example
+
+```javascript
+const CamelCase = require('node-string-methods/camelCase');
+
+const str = 'first_name_last';
+const camelCase = new CamelCase(str);
+
+const result = camelCase.execute();
+
+console.log(result); // Output: 'firstNameLast'
+```
+
+### Errors
+
+-   Throws an `Error` if the input provided to the constructor is not a string.

string-methods/src/camelCase.js

@@ -0,0 +1,25 @@
+class CamelCase {
+    constructor(str) {
+        if (typeof str !== 'string') {
+            throw new Error('Input must be a string');
+        }
+        this.str = str;
+    }
+
+    execute() {
+        return this.str
+            .trim()
+            .split(/[\W_]+/)
+            .map((word, index) => {
+                if (index === 0) {
+                    return word.toLowerCase();
+                }
+                return (
+                    word.charAt(0).toUpperCase() + word.slice(1).toLowerCase()
+                );
+            })
+            .join('');
+    }
+}
+
+module.exports = CamelCase;

string-methods/tests/camelCase.test.js

@@ -0,0 +1,55 @@
+const CamelCase = require('../src/camelCase');
+
+describe('camelCase', () => {
+    it('should convert the rest of the word to lowercase', () => {
+        const camelCaseInstance = new CamelCase('WORLD');
+        expect(camelCaseInstance.execute()).toBe('world');
+    });
+
+    it('should convert "hello world" to "helloWorld"', () => {
+        const camelCaseInstance = new CamelCase('hello world');
+        expect(camelCaseInstance.execute()).toBe('helloWorld');
+    });
+
+    it('should convert "FIRST name LAST" to "firstNameLast"', () => {
+        const camelCaseInstance = new CamelCase('FIRST name LAST');
+        expect(camelCaseInstance.execute()).toBe('firstNameLast');
+    });
+
+    it('should convert "   mixed INPUT data  " to "mixedInputData"', () => {
+        const camelCaseInstance = new CamelCase('   mixed INPUT data  ');
+        expect(camelCaseInstance.execute()).toBe('mixedInputData');
+    });
+
+    it('should handle single word strings', () => {
+        const camelCaseInstance = new CamelCase('TESTING');
+        expect(camelCaseInstance.execute()).toBe('testing');
+    });
+
+    it('should handle strings with underscores', () => {
+        const camelCaseInstance = new CamelCase('first_name_last');
+        expect(camelCaseInstance.execute()).toBe('firstNameLast');
+    });
+
+    it('should handle strings with dashes', () => {
+        const camelCaseInstance = new CamelCase('first-name-last');
+        expect(camelCaseInstance.execute()).toBe('firstNameLast');
+    });
+
+    it('should handle strings with mixed special characters', () => {
+        const camelCaseInstance = new CamelCase('first_name-last');
+        expect(camelCaseInstance.execute()).toBe('firstNameLast');
+    });
+
+    it('should handle empty strings', () => {
+        const camelCaseInstance = new CamelCase('');
+        expect(camelCaseInstance.execute()).toBe('');
+    });
+
+    it('should handle non-string inputs', () => {
+        expect(() => new CamelCase(123)).toThrowError('Input must be a string');
+        expect(() => new CamelCase(null)).toThrowError(
+            'Input must be a string'
+        );
+    });
+});