Merge pull request #27 from SecJS/refactor/len-move-fns-add-statics

refactor: Remove fns, update docs and add statics

Author: jlenon7

README.md

@@ -9,21 +9,15 @@ export * from './src/Classes/Parser'
 export * from './src/Classes/Numbers'
 export * from './src/Classes/Blacklist'
 
-export * from './src/Functions/sort'
 export * from './src/Functions/unset'
 export * from './src/Functions/sleep'
 export * from './src/Functions/isCpf'
 export * from './src/Functions/isCnpj'
 export * from './src/Functions/random'
-export * from './src/Functions/urlify'
 export * from './src/Functions/download'
-export * from './src/Functions/fillable'
 export * from './src/Functions/kmRadius'
 export * from './src/Functions/paginate'
 export * from './src/Functions/scheduler'
 export * from './src/Functions/getBranch'
 export * from './src/Functions/getCommitId'
 export * from './src/Functions/randomColor'
-export * from './src/Functions/observeChanges'
-export * from './src/Functions/removeDuplicated'
-export * from './src/Functions/isArrayOfObjects'

index.ts

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/utils",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "",
   "license": "MIT",
   "author": "João Lenon",

package.json

@@ -1,5 +1,5 @@
 export class Clean {
-  isEmpty(data: any | any[] | string): boolean {
+  static isEmpty(data: any | any[] | string): boolean {
     if (!data) {
       return true
     }
@@ -26,7 +26,7 @@ export class Clean {
    * @param removeEmpty Remove all empty objects/arrays from array
    * @return The array filtered without any falsy value
    */
-  cleanArray(
+  static cleanArray(
     array: any[],
     removeEmpty = false,
     cleanInsideObjects = false,
@@ -62,7 +62,7 @@ export class Clean {
    * @param removeEmpty Remove all empty objects/arrays from object
    * @return The object filtered without any falsy value
    */
-  cleanObject(
+  static cleanObject(
     object: any,
     removeEmpty = false,
     cleanInsideArrays = false,

src/Classes/Clean.ts

@@ -22,10 +22,10 @@ import {
 } from 'fs'
 
 import { Path } from './Path'
+import { Parser } from './Parser'
 import { lookup } from 'mime-types'
 import { randomBytes } from 'crypto'
 import { parse, isAbsolute } from 'path'
-import { formatBytes } from '../Functions/formatBytes'
 import { InternalServerException } from '@secjs/exceptions'
 
 export interface FileJsonContract {
@@ -161,7 +161,7 @@ export class File {
     this._createdAt = fileStat.birthtime
     this._accessedAt = fileStat.atime
     this._modifiedAt = fileStat.mtime
-    this._fileSize = formatBytes(fileStat.size, 4)
+    this._fileSize = Parser.bytesToSize(fileStat.size, 4)
 
     if (options.withContent) {
       // 200mb
@@ -195,7 +195,7 @@ export class File {
     this._accessedAt = fileStat.atime
     this._modifiedAt = fileStat.mtime
     this._createdAt = fileStat.birthtime
-    this._fileSize = formatBytes(fileStat.size, 4)
+    this._fileSize = Parser.bytesToSize(fileStat.size, 4)
 
     if (!options.withContent) return this
 

src/Classes/File.ts

@@ -21,9 +21,9 @@ import {
 
 import { File } from './File'
 import { Path } from './Path'
+import { Parser } from './Parser'
 import { randomBytes } from 'crypto'
 import { isAbsolute, join, parse, resolve } from 'path'
-import { formatBytes } from '../Functions/formatBytes'
 import { InternalServerException } from '@secjs/exceptions'
 
 export interface FolderJsonContract {
@@ -132,7 +132,7 @@ export class Folder {
     this._createdAt = fileStat.birthtime
     this._accessedAt = fileStat.atime
     this._modifiedAt = fileStat.mtime
-    this._folderSize = formatBytes(fileStat.size, 4)
+    this._folderSize = Parser.bytesToSize(fileStat.size, 4)
 
     if (options.withSub) {
       this.loadSubSync(
@@ -170,7 +170,7 @@ export class Folder {
     this._createdAt = folderStat.birthtime
     this._accessedAt = folderStat.atime
     this._modifiedAt = folderStat.mtime
-    this._folderSize = formatBytes(folderStat.size, 4)
+    this._folderSize = Parser.bytesToSize(folderStat.size, 4)
 
     if (options.withSub) {
       await this.loadSub(

src/Classes/Folder.ts

@@ -5,7 +5,7 @@ export class Json {
    * @param array The array to be validated
    * @return true or false
    */
-  isArrayOfObjects(array: any[]): boolean {
+  static isArrayOfObjects(array: any[]): boolean {
     if (!array.length) return false
 
     const results = array.map(object => typeof object === 'object')
@@ -19,7 +19,7 @@ export class Json {
    * @param object The object to be copied
    * @return A copy from object without any reference
    */
-  copy<T>(object: T): T {
+  static copy<T>(object: T): T {
     const copy: any = {}
 
     for (const i in object) {
@@ -36,7 +36,7 @@ export class Json {
    * @param text A valid string with one or more JSON's inside.
    * @returns An array of JSON's found in the string.
    */
-  getJson(text: string): string[] {
+  static getJson(text: string): string[] {
     let match: RegExpExecArray
     const matchs = []
 
@@ -55,7 +55,7 @@ export class Json {
    * @param reviver A function that transforms the results. This function is called for each member of the object.
    * If a member contains nested objects, the nested objects are transformed before the parent object is.
    */
-  parse(
+  static parse(
     text: string,
     reviver?: (this: any, key: string, value: any) => any,
   ): any {
@@ -65,4 +65,63 @@ export class Json {
       return null
     }
   }
+
+  /**
+   * Observe changes inside objects
+   *
+   * @param object - The object to be observed
+   * @param func - The function that will execute all the time the object has been modified
+   * @param args - The arguments of the function
+   * @return proxy - A Proxy instance
+   */
+  static observeChanges(object: any, func: any, ...args: any[]): any {
+    return new Proxy(object, {
+      set: (target, key, value) => {
+        func(value, ...args)
+
+        target[key] = value
+
+        return true
+      },
+    })
+  }
+
+  /**
+   * Remove all keys from data that is not inside array keys
+   *
+   * @param data The data with keys to remove
+   * @param keys Array of keys that needs to stay in data
+   * @return data only with keys
+   */
+  static fillable(data: any, keys: string[]): any {
+    return keys.reduce((previous: any, key: string) => {
+      if (data[key]) {
+        previous[key] = data[key]
+      }
+
+      return previous
+    }, {})
+  }
+
+  /**
+   * Remove all duplicated values from the array
+   *
+   * @param array - The array to be verified
+   * @return array - The array without duplicated values
+   */
+  static removeDuplicated(array: any[]): any[] {
+    return [...new Set(array)]
+  }
+
+  /**
+   * Sort an index value from the array
+   *
+   * @param array - The array with n index
+   * @return any - A random value from the array
+   */
+  static sort(array: any): any {
+    const index = Math.random() * array.length
+
+    return array[Math.floor(index)]
+  }
 }

src/Classes/Json.ts

@@ -7,7 +7,7 @@ export class Numbers {
    * @param numbers The array of numbers
    * @return The higher number from the array
    */
-  getHigher(numbers: number[]): number {
+  static getHigher(numbers: number[]): number {
     // eslint-disable-next-line prefer-spread
     return Math.max.apply(Math, numbers)
   }
@@ -18,7 +18,7 @@ export class Numbers {
    * @param numbers The array of numbers
    * @return The lower number from the array
    */
-  getLower(numbers: number[]): number {
+  static getLower(numbers: number[]): number {
     // eslint-disable-next-line prefer-spread
     return Math.min.apply(Math, numbers)
   }
@@ -29,8 +29,8 @@ export class Numbers {
    * @param string The string with numbers inside
    * @return One number only
    */
-  extractNumber(string: string): number {
-    return new Parser().stringToNumber(string.replace(/\D/g, ''))
+  static extractNumber(string: string): number {
+    return Parser.stringToNumber(string.replace(/\D/g, ''))
   }
 
   /**
@@ -39,9 +39,9 @@ export class Numbers {
    * @param string The string with numbers inside
    * @return An array of numbers
    */
-  extractNumbers(string: string): number[] {
+  static extractNumbers(string: string): number[] {
     return string.match(/[0-9]+/g).map(numberString => {
-      return new Parser().stringToNumber(numberString)
+      return Parser.stringToNumber(numberString)
     })
   }
 
@@ -51,7 +51,7 @@ export class Numbers {
    * @param args The array of numbers from all function arguments
    * @return The average of all numbers
    */
-  argsAverage(...args: number[]): number {
+  static argsAverage(...args: number[]): number {
     return args.reduce((acc: any, curr: any) => acc + curr, 0) / args.length
   }
 
@@ -61,7 +61,7 @@ export class Numbers {
    * @param array The array of numbers
    * @return The average of all numbers
    */
-  arrayAverage(array: number[]): number {
+  static arrayAverage(array: number[]): number {
     return array.reduce((acc, curr) => acc + curr, 0) / array.length
   }
 }

src/Classes/Numbers.ts

@@ -8,7 +8,7 @@ export class Parser {
    * @param separator The separator to use
    * @return The array of string
    */
-  stringToArray(string: string, separator: string): string[] {
+  static stringToArray(string: string, separator: string): string[] {
     return string.split(separator).map(index => index.trim())
   }
 
@@ -19,7 +19,7 @@ export class Parser {
    * @param isCoordinate If string is a coordinate
    * @return The string parsed to int or float
    */
-  stringToNumber(string: string, isCoordinate = false): number {
+  static stringToNumber(string: string, isCoordinate = false): number {
     if (!string.replace(/\D/g, '')) {
       throw new InternalServerException(
         'Your string is invalid, it should have at least one number.',
@@ -41,7 +41,7 @@ export class Parser {
    * @param object The object to parse
    * @return The object parsed to form data
    */
-  jsonToFormData(object: any): string {
+  static jsonToFormData(object: any): string {
     return Object.keys(object)
       .reduce((previous, current) => {
         return previous + `&${current}=${encodeURIComponent(object[current])}`
@@ -55,7 +55,7 @@ export class Parser {
    * @param formData The form data to parse
    * @return The form data parsed to object
    */
-  formDataToJson(formData: string): any {
+  static formDataToJson(formData: string): any {
     const object = {}
 
     if (formData.startsWith('?')) formData = formData.replace('?', '')
@@ -68,4 +68,35 @@ export class Parser {
 
     return object
   }
+
+  /**
+   * bytesToSize creates a string based on the bytes size
+   *
+   * @param bytes - The number of bytes
+   * @param decimals - The number of decimals to be showed
+   * @return formattedSize - Return the formatted value based on the size (100 MB, 1 GB, etc)
+   */
+  static bytesToSize(bytes: number, decimals = 2) {
+    if (bytes === 0) return '0 Bytes'
+
+    const k = 1024
+    const dm = decimals < 0 ? 0 : decimals
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
+
+    const i = Math.floor(Math.log(bytes) / Math.log(k))
+
+    return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i]
+  }
+
+  /**
+   * linkToHref parses all links inside the string to HTML link with <a href= .../>
+   *
+   * @param string - The string with links inside
+   * @return formattedString - Return the formatted string
+   */
+  static linkToHref(string: any): string {
+    const regex = /(https?:\/\/[^\s]+)/g
+
+    return string.replace(regex, '<a href="$1">$1</a>')
+  }
 }