Merge pull request #24 from SecJS/feat/len-add-path

feat: Add Path class helper

Author: jlenon7

README.md

@@ -40,6 +40,33 @@ npm install @secjs/utils
 
 ## Classes Usage
 
+### Path
+
+> Use Path to get the absolute path from project folders.
+
+```ts
+import { Path } from '@secjs/utils'
+
+// pwd method will depend if you NODE_ENV environment variable is set.
+// if you are using ci, testing or ts-development, pwd will return like this:
+Path.pwd() // '/home/your/computer/path/your-project-name'
+
+// if your NODE_ENV is not set, or you are using a diffrent value from ci, testing or ts-development,
+// your pwd will return like this:
+Path.pwd() // '/home/your/computer/path/your-project-name/dist'
+
+// you can change your buildFolder name using forBuildFolder method
+Path.forBuild('build').pwd()
+// '/home/your/computer/path/your-project-name/build'
+
+Path.pwd('/src/') // '/home/your/computer/path/your-project-name/src'
+
+Path.public() // '/home/your/computer/path/your-project-name/public'
+Path.assets() // '/home/your/computer/path/your-project-name/public/assets'
+```
+
+---
+
 ### Json
 
 > Use Json to parse json without errors, deep copy and more.

index.ts

@@ -1,4 +1,5 @@
 export * from './src/Classes/Json'
+export * from './src/Classes/Path'
 export * from './src/Classes/Token'
 export * from './src/Classes/Clean'
 export * from './src/Classes/Route'

package-lock.json

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

package.json

@@ -0,0 +1,130 @@
+/*
+ * @secjs/utils
+ *
+ * (c) João Lenon <lenon@secjs.com.br>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export class Path {
+  private static _tempBuild = null
+  private static _forceBuild = false
+  private static _defaultBuild = 'dist'
+  private static _verifyNodeEnv = true
+
+  static forBuild(name: string) {
+    this._tempBuild = name
+
+    return this
+  }
+
+  static switchEnvVerify() {
+    this._verifyNodeEnv = !this._verifyNodeEnv
+
+    return this
+  }
+
+  static changeBuild(name: string) {
+    this._defaultBuild = name
+
+    return this
+  }
+
+  static forceBuild() {
+    this._forceBuild = true
+
+    return this
+  }
+
+  static nodeCwdPath() {
+    let cwdNodePath = process.cwd()
+
+    if (this._tempBuild) {
+      cwdNodePath += this.adjustSlashes(this._tempBuild)
+
+      this._tempBuild = null
+
+      return cwdNodePath
+    }
+
+    if (this._forceBuild) {
+      cwdNodePath += this.adjustSlashes(this._defaultBuild)
+
+      this._forceBuild = false
+    }
+
+    if (!this._forceBuild && this._verifyNodeEnv) {
+      if (['ci', 'testing', 'ts-development'].includes(process.env.NODE_ENV)) {
+        cwdNodePath += this.adjustSlashes(this._defaultBuild)
+      }
+    }
+
+    return this.adjustSlashes(cwdNodePath)
+  }
+
+  static pwd(subPath = '/') {
+    return `${this.nodeCwdPath()}${this.adjustSlashes(subPath)}`
+  }
+
+  static app(subPath = '/') {
+    return this.pwd('app' + this.adjustSlashes(subPath))
+  }
+
+  static logs(subPath = '/') {
+    return this.storage('logs' + this.adjustSlashes(subPath))
+  }
+
+  static start(subPath = '/') {
+    return this.pwd('start' + this.adjustSlashes(subPath))
+  }
+
+  static views(subPath = '/') {
+    return this.resources('views' + this.adjustSlashes(subPath))
+  }
+
+  static config(subPath = '/') {
+    return this.pwd('config' + this.adjustSlashes(subPath))
+  }
+
+  static tests(subPath = '/') {
+    return this.pwd('tests' + this.adjustSlashes(subPath))
+  }
+
+  static public(subPath = '/') {
+    return this.pwd('public' + this.adjustSlashes(subPath))
+  }
+
+  static assets(subPath = '/') {
+    return this.public('assets' + this.adjustSlashes(subPath))
+  }
+
+  static storage(subPath = '/') {
+    return this.pwd('storage' + this.adjustSlashes(subPath))
+  }
+
+  static database(subPath = '/') {
+    return this.pwd('database' + this.adjustSlashes(subPath))
+  }
+
+  static locales(subPath = '/') {
+    return this.resources('locales' + this.adjustSlashes(subPath))
+  }
+
+  static resources(subPath = '/') {
+    return this.pwd('resources' + this.adjustSlashes(subPath))
+  }
+
+  static providers(subPath = '/') {
+    return this.pwd('providers' + this.adjustSlashes(subPath))
+  }
+
+  private static adjustSlashes(path: string) {
+    let subPathArray = path.split('/')
+
+    subPathArray = subPathArray.filter(p => p !== '')
+    subPathArray.unshift('')
+
+    return subPathArray.join('/')
+  }
+}

src/Classes/Path.ts

@@ -0,0 +1,30 @@
+import { Path as PathInstance } from '../Classes/Path'
+
+export {}
+
+declare global {
+  class Path {
+    static nodeCwdPath(): string
+    static forceBuild(): typeof Path
+    static pwd(subPath?: string): string
+    static app(subPath?: string): string
+    static switchEnvVerify(): typeof Path
+    static logs(subPath?: string): string
+    static start(subPath?: string): string
+    static views(subPath?: string): string
+    static tests(subPath?: string): string
+    static config(subPath?: string): string
+    static public(subPath?: string): string
+    static assets(subPath?: string): string
+    static storage(subPath?: string): string
+    static locales(subPath?: string): string
+    static database(subPath?: string): string
+    static resources(subPath?: string): string
+    static providers(subPath?: string): string
+    static forBuild(name: string): typeof Path
+    static changeBuild(name: string): typeof Path
+  }
+}
+
+const _global = global as any
+_global.Path = PathInstance

src/utils/global.ts

@@ -0,0 +1,56 @@
+import { Path } from '../../src/Classes/Path'
+
+describe('\n Path Class', () => {
+  it('should get application pwd path', () => {
+    const myMainPath = process.cwd()
+    const mySrcPath = myMainPath + '/src'
+    const mySrcAppPath = myMainPath + '/src/app'
+
+    expect(Path.pwd()).toBe(myMainPath)
+    expect(Path.pwd('/src')).toBe(mySrcPath)
+    expect(Path.pwd('/src/')).toBe(mySrcPath)
+    expect(Path.pwd('///src///')).toBe(mySrcPath)
+    expect(Path.pwd('///src///app///')).toBe(mySrcAppPath)
+  })
+
+  it('should get application storage path', () => {
+    const myStoragePath = process.cwd() + '/storage'
+    const myStorageLogsPath = myStoragePath + '/logs'
+
+    expect(Path.storage()).toBe(myStoragePath)
+    expect(Path.storage('logs')).toBe(myStorageLogsPath)
+    expect(Path.storage('///logs///')).toBe(myStorageLogsPath)
+  })
+
+  it('should get application views path', () => {
+    const myViewsPath = process.cwd() + '/resources/views'
+    const myViewsMailPath = myViewsPath + '/Mail'
+
+    expect(Path.views()).toBe(myViewsPath)
+    expect(Path.views('Mail')).toBe(myViewsMailPath)
+    expect(Path.views('///Mail///')).toBe(myViewsMailPath)
+  })
+
+  it('should get node cwd path based on ts build folder validations', () => {
+    const myMainPath = process.cwd()
+    const myMainDistPath = process.cwd() + '/dist'
+
+    expect(Path.forceBuild().nodeCwdPath()).toBe(myMainDistPath)
+    expect(Path.forBuild('build').nodeCwdPath()).toBe(myMainPath + '/build')
+    expect(Path.forceBuild().nodeCwdPath()).toBe(myMainDistPath)
+    expect(Path.forceBuild().changeBuild('/test').nodeCwdPath()).toBe(
+      myMainPath + '/test',
+    )
+
+    Path.changeBuild('/dist')
+
+    process.env.NODE_ENV = 'testing'
+    expect(Path.nodeCwdPath()).toBe(myMainDistPath)
+
+    process.env.NODE_ENV = 'ts-development'
+    expect(Path.nodeCwdPath()).toBe(myMainDistPath)
+
+    process.env.NODE_ENV = 'production'
+    expect(Path.nodeCwdPath()).toBe(myMainPath)
+  })
+})