Adds strings algorythms, such as anagrams, capitalizer, palindrome… (#5)

abranhe · web-flow · commit 0ec3582739f9 · 2019-10-01T18:12:10.000-04:00
Adds strings algorythms, such as anagrams, capitalizer, palindrome, reverse, vowels
diff --git a/docs/readme.md b/docs/readme.md
@@ -45,7 +45,7 @@ npm install allalgorithms
 ```js
 const allalgorithms = require('allalgorithms');
 
-arr = [77, 2, 10, -2, 1, 7]
+const arr = [77, 2, 10, -2, 1, 7];
 
 console.log(allalgorithms.sorting.bubbleSort(arr));
 // -> [-2, 1, 2, 7, 10, 77]
@@ -57,6 +57,13 @@ console.log(allalgorithms.sorting.bubbleSort(arr));
   - [Bubble Sort](https://js.allalgorithms.com/sorting/bubble-sort)
   - [Merge Sort](https://js.allalgorithms.com/sorting/merge-sort)
 
+-  **Strings**
+  - [Reverse](https://js.allalgorithms.com/strings/reverse)
+  - [Capitalize](https://js.allalgorithms.com/strings/capitalize)
+  - [Palindrome](https://js.allalgorithms.com/strings/palindrome)
+  - [Vowels](https://js.allalgorithms.com/strings/vowels)
+  - [Anagrams](https://js.allalgorithms.com/strings/anagrams)
+ 
 # Related
 
 - [allalgorithms-python](https://github.com/abranhe/allalgorithms-python): All ▲lgorithms Python library
diff --git a/docs/sorting/bogo-sort.md b/docs/sorting/bogo-sort.md
@@ -13,7 +13,7 @@ npm install allalgorithms
 ```js
 const allalgorithms = require('allalgorithms');
 
-arr = [77, 2, 10, -2, 1, 7]
+const arr = [77, 2, 10, -2, 1, 7];
 
 console.log(allalgorithms.sorting.bogoSort(arr))
 // -> [-2, 1, 2, 7, 10, 77]
diff --git a/docs/sorting/bubble-sort.md b/docs/sorting/bubble-sort.md
@@ -13,7 +13,7 @@ npm install allalgorithms
 ```js
 const allalgorithms = require('allalgorithms');
 
-arr = [77, 2, 10, -2, 1, 7]
+const arr = [77, 2, 10, -2, 1, 7];
 
 console.log(allalgorithms.sorting.bubbleSort(arr));
 // -> [-2, 1, 2, 7, 10, 77]
diff --git a/docs/sorting/merge-sort.md b/docs/sorting/merge-sort.md
@@ -13,7 +13,7 @@ npm install allalgorithms
 ```js
 const allalgorithms = require('allalgorithms');
 
-arr = [77, 2, 10, -2, 1, 7]
+const arr = [77, 2, 10, -2, 1, 7];
 
 console.log(allalgorithms.sorting.mergeSort(arr))
 // -> [-2, 1, 2, 7, 10, 77]
diff --git a/docs/strings/anagrams.md b/docs/strings/anagrams.md
@@ -0,0 +1,32 @@
+# Anagrams
+
+An anagram is a word or phrase formed by rearranging the letters of a different word or phrase, typically using all the original letters exactly once.[1] For example, the word anagram can be rearranged into nag a ram, or the word binary into brainy or the word adobe into abode.
+
+## Install
+
+```
+npm install allalgorithms
+```
+
+## Usage
+
+```js
+const allalgorithms = require('allalgorithms');
+
+const strA = 'RAIL? SAFETY';
+const strB = 'fairy tales';
+
+console.log(allalgorithms.strings.anagrams(strA, strB));
+// -> true
+```
+
+## API
+
+### anagrams(strA, strB)
+
+> Returns true if strings are anagrams
+
+##### Params:
+
+- `strA`: First string
+- `strB`: Second string
diff --git a/docs/strings/capitalize.md b/docs/strings/capitalize.md
@@ -0,0 +1,30 @@
+# Capitalize
+
+Method converts the first character of a string to capital (uppercase) letter. If the string has its first character as capital, then it returns the original string
+
+## Install
+
+```
+npm install allalgorithms
+```
+
+## Usage
+
+```js
+const allalgorithms = require('allalgorithms');
+
+const str = 'framework for managing your configuration';
+
+console.log(allalgorithms.strings.capitalize(str));
+// -> Framework For Managing Your Configuration
+```
+
+## API
+
+### capitalize(str)
+
+> Returns capitalized string
+
+##### Params:
+
+- `str`: Non-capitalized string
diff --git a/docs/strings/palindrome.md b/docs/strings/palindrome.md
@@ -0,0 +1,30 @@
+# Palindrome
+
+A palindrome is a word which reads the same backward as forward, such as 'madam' or 'racecar'
+
+## Install
+
+```
+npm install allalgorithms
+```
+
+## Usage
+
+```js
+const allalgorithms = require('allalgorithms');
+
+const str = 'racecar';
+
+console.log(allalgorithms.strings.palindrome(str));
+// -> true
+```
+
+## API
+
+### palindrome(str)
+
+> Returns true if string is palindrome
+
+##### Params:
+
+- `str`: String
diff --git a/docs/strings/reverse.md b/docs/strings/reverse.md
@@ -0,0 +1,30 @@
+# Reverse
+
+Simply string reverse method, that's all :)
+
+## Install
+
+```
+npm install allalgorithms
+```
+
+## Usage
+
+```js
+const allalgorithms = require('allalgorithms');
+
+const str = 'orange';
+
+console.log(allalgorithms.strings.reverse(str));
+// -> egnaro
+```
+
+## API
+
+### reverse(str)
+
+> Returns reversed string
+
+##### Params:
+
+- `str`: String
diff --git a/docs/strings/vowels.md b/docs/strings/vowels.md
@@ -0,0 +1,30 @@
+# Vowels
+
+Method calculate vowels in word, phrase. Vowels are the characters 'a', 'e', 'i', 'o', and 'u'
+
+## Install
+
+```
+npm install allalgorithms
+```
+
+## Usage
+
+```js
+const allalgorithms = require('allalgorithms');
+
+const str = 'How do you do?';
+
+console.log(allalgorithms.strings.vowels(str));
+// -> 5
+```
+
+## API
+
+### vowels(str)
+
+> Returns count of vowels inside string
+
+##### Params:
+
+- `str`: String
diff --git a/index.js b/index.js
@@ -1,3 +1,4 @@
 module.exports = {
-  sorting: require('./src/sorting'),
+	sorting: require('./src/sorting'),
+	strings: require('./src/strings')
 };
diff --git a/src/strings.js b/src/strings.js
@@ -0,0 +1,7 @@
+module.exports = {
+	capitalize: require('./strings/capitalize'),
+	reverse: require('./strings/reverse'),
+	anagrams: require('./strings/anagrams'),
+	palindrome: require('./strings/palindrome'),
+	vowels: require('./strings/vowels')
+};
diff --git a/src/strings/anagrams.js b/src/strings/anagrams.js
@@ -0,0 +1,23 @@
+'use strict';
+
+/*
+ * Check if 2 strings are anagrams
+ *
+ * @param stringA
+ * @param stringB
+ * @returns {boolean}
+ */
+function anagrams(stringA, stringB) {
+	return cleanString(stringA) === cleanString(stringB);
+}
+
+/*
+ * HELPER function
+ * @param str
+ * @returns {string}
+ */
+function cleanString(str) {
+	return str.replace(/[^\w]/g, '').toLowerCase().split('').sort().join('');
+}
+
+module.exports = anagrams;
diff --git a/src/strings/capitalize.js b/src/strings/capitalize.js
@@ -0,0 +1,19 @@
+'use strict';
+
+/*
+ * Capitalize first letters in string
+ *
+ * @param str
+ * @returns {string}
+ */
+function capitalize(str) {
+	const words = [];
+
+	for (const word of str.split(' ')) {
+		words.push(word[0].toUpperCase() + word.slice(1));
+	}
+
+	return words.join(' ');
+}
+
+module.exports = capitalize;
diff --git a/src/strings/palindrome.js b/src/strings/palindrome.js
@@ -0,0 +1,15 @@
+'use strict';
+
+/*
+ * Returns true if string is palindrome
+ *
+ * @param str
+ * @returns {boolean}
+ */
+function palindrome(str) {
+	return str.split('').every((c, i) => {
+		return c === str[str.length - 1 - i];
+	});
+}
+
+module.exports = palindrome;
diff --git a/src/strings/reverse.js b/src/strings/reverse.js
@@ -0,0 +1,13 @@
+'use strict';
+
+/*
+ * Reverse string
+ *
+ * @param str
+ * @returns {string}
+ */
+function reverse(str) {
+	return str.split('').reverse().join('');
+}
+
+module.exports = reverse;
diff --git a/src/strings/vowels.js b/src/strings/vowels.js
@@ -0,0 +1,16 @@
+'use strict';
+
+/*
+ *  Check how much vowels are in string
+ * @param str
+ * @returns {number}
+ */
+function vowels(str) {
+	const checker = ['a', 'e', 'i', 'o', 'u'];
+
+	return str.toLowerCase().split('').reduce((acc, c) => {
+		return checker.includes(c) ? acc + 1 : acc;
+	}, 0);
+}
+
+module.exports = vowels;
diff --git a/src/test/strings.test.js b/src/test/strings.test.js
@@ -0,0 +1,47 @@
+import test from 'ava';
+
+const strings = require('../strings');
+
+const capitalizeStr = 'framework for managing your configuration';
+const expectedCapitalizedStr = 'Framework For Managing Your Configuration';
+
+test('Testing Capitalize String', t => {
+	t.deepEqual(expectedCapitalizedStr, strings.capitalize(capitalizeStr));
+});
+
+const reverseStr = 'orange';
+const reverseStrExp = 'egnaro';
+
+test('Testing string "orange" to reverse', t => {
+	t.deepEqual(reverseStrExp, strings.reverse(reverseStr));
+});
+
+const strA = 'RAIL? SAFETY';
+const strB = 'fairy tales';
+const strC = 'Rafl fairt';
+
+test('Testing Strings (A & B) Are Anagrams', t => {
+	t.truthy(strings.anagrams(strA, strB));
+});
+
+test('Testing Strings (A & C) Ar\'nt Anagrams', t => {
+	t.falsy(strings.anagrams(strA, strC));
+});
+
+const palindromeStr = 'abccba';
+const palindromeStrN = 'lfreroug';
+
+test('Testing That String "abccba" is palindrome', t => {
+	t.truthy(strings.palindrome(palindromeStr));
+});
+
+test('Testing That String "lfreroug" is not palindrome', t => {
+	t.falsy(strings.palindrome(palindromeStrN));
+});
+
+const vowelsTestStr = 'How do you do?';
+const vowelsExpect = 5;
+
+test('Testing how much vowels in string "How do you do?"', t => {
+	t.is(vowelsExpect, strings.vowels(vowelsTestStr));
+});
