feat(config): add new methods and value decorator

.github/workflows/ci.yml

@@ -67,3 +67,29 @@ jobs:
 
       - name: Test code compilation
         run: sh scripts/build
+
+  cov-report:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Use Node.js 18.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 18.x
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        run: npm run test:coverage
+
+      - name: Generate Code Coverage report
+        id: code-coverage
+        uses: barecheck/code-coverage-action@v1
+        with:
+          barecheck-github-app-token: ${{ secrets.BARECHECK_GITHUB_APP_TOKEN }}
+          lcov-file: "./tests/Coverage/lcov.info"
+          send-summary-comment: true
+          show-annotations: "warning"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/config",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Cache and handle environment variables and config files of Athenna.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -81,6 +81,7 @@
     "exclude": [],
     "reporter": [
       "text-summary",
+      "lcovonly",
       "html"
     ],
     "report-dir": "./tests/Coverage",

src/Config/Config.ts

@@ -7,11 +7,20 @@
  * file that was distributed with this source code.
  */
 
-import { sep, parse } from 'node:path'
+import {
+  File,
+  Json,
+  Path,
+  ObjectBuilder,
+  Exec,
+  Module,
+  Is,
+} from '@athenna/common'
 import { loadFile, writeFile } from 'magicast'
-import { File, Json, Path, ObjectBuilder, Exec, Module } from '@athenna/common'
+import { sep, parse, extname } from 'node:path'
 import { RecursiveConfigException } from '#src/Exceptions/RecursiveConfigException'
 import { NotSupportedKeyException } from '#src/Exceptions/NotSupportedKeyException'
+import { NotValidArrayConfigException } from '#src/Exceptions/NotValidArrayConfigException'
 
 export class Config {
   /**
@@ -111,6 +120,28 @@ export class Config {
     return this
   }
 
+  /**
+   * Push a value to a configuration key that is a valid array.
+   * If configuration is not an array, an exception will be thrown.
+   */
+  public static push(key: string, value: any | any[]): typeof Config {
+    const config = this.configs.get(key, [])
+
+    if (!Is.Array(config)) {
+      throw new NotValidArrayConfigException(key)
+    }
+
+    if (Is.Array(value)) {
+      config.push(...value)
+    } else {
+      config.push(value)
+    }
+
+    this.configs.set(key, config)
+
+    return this
+  }
+
   /**
    * Delete the configuration key.
    */
@@ -168,6 +199,12 @@ export class Config {
     path = Path.config(),
     safe = false,
   ): Promise<void> {
+    if (extname(path)) {
+      safe ? this.safeLoad(path) : this.load(path)
+
+      return
+    }
+
     const files = await Module.getAllJSFilesFrom(path)
 
     this.fatherConfigPath = path

src/Decorators/Value.ts

@@ -0,0 +1,34 @@
+/**
+ * @athenna/config
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import 'reflect-metadata'
+
+import { Is } from '@athenna/common'
+import { NotFoundConfigException } from '#src/Exceptions/NotFoundConfigException'
+
+/**
+ * Set the value of some configuration in your class property.
+ */
+export function Value(key: string, defaultValue?: any): PropertyDecorator {
+  return (target: any, propKey: string | symbol) => {
+    if (Is.Defined(defaultValue) || defaultValue === null) {
+      Object.defineProperty(target, propKey, {
+        value: Config.get(key, defaultValue),
+      })
+
+      return
+    }
+
+    if (!Config.exists(key)) {
+      throw new NotFoundConfigException(key)
+    }
+
+    Object.defineProperty(target, propKey, { value: Config.get(key) })
+  }
+}

src/Exceptions/NotFoundConfigException.ts

@@ -0,0 +1,21 @@
+/**
+ * @athenna/config
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Exception } from '@athenna/common'
+
+export class NotFoundConfigException extends Exception {
+  public constructor(key: string) {
+    super({
+      status: 500,
+      code: 'E_NOT_FOUND_CONFIG',
+      message: `The configuration ${key} does not exist or the value is a hardcoded undefined.`,
+      help: `To solve this problem you can set a default value when trying to get your configuration or setting a value to your ${key} configuration.`,
+    })
+  }
+}

src/Exceptions/NotValidArrayConfigException.ts

@@ -0,0 +1,21 @@
+/**
+ * @athenna/config
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Exception } from '@athenna/common'
+
+export class NotValidArrayConfigException extends Exception {
+  public constructor(key: string) {
+    super({
+      status: 500,
+      code: 'E_NOT_VALID_CONFIG_ARRAY',
+      message: `The configuration ${key} is not a valid array, and it is not possible to push values to it.`,
+      help: `Try changing your configuration key when calling push and pushAll methods or transform the value of your configuration ${key} to an array.`,
+    })
+  }
+}

tests/Stubs/classes/AppService.ts

@@ -0,0 +1,9 @@
+import { Value } from '#src/Decorators/Value'
+
+export class AppService {
+  @Value('app')
+  public app: any
+
+  @Value('app.name')
+  public name: any
+}

tests/Stubs/classes/DoesNotThrowNotFound.ts

@@ -0,0 +1,9 @@
+import { Value } from '#src/Decorators/Value'
+
+export class DoesNotThrowNotFound {
+  @Value('app.notFound', null)
+  public defined: any
+
+  @Value('app.notFoundApp', 'Athenna')
+  public definedApp: any
+}

tests/Stubs/classes/ThrowNotFound.ts

@@ -0,0 +1,6 @@
+import { Value } from '#src/Decorators/Value'
+
+export class ThrowNotFound {
+  @Value('app.notFound')
+  public app: any
+}

tests/Stubs/config/app.ts

@@ -9,5 +9,6 @@
 
 export default {
   name: 'Athenna',
+  environments: ['default'],
   env: Env('NODE_ENV', 'test'),
 }

tests/Unit/Config/ConfigTest.ts

@@ -12,6 +12,7 @@ import { File, Folder, Path } from '@athenna/common'
 import { Test, TestContext, Cleanup, BeforeEach, AfterEach } from '@athenna/test'
 import { RecursiveConfigException } from '#src/Exceptions/RecursiveConfigException'
 import { NotSupportedKeyException } from '#src/Exceptions/NotSupportedKeyException'
+import { NotValidArrayConfigException } from '#src/Exceptions/NotValidArrayConfigException'
 
 export default class ConfigTest {
   @BeforeEach()
@@ -35,7 +36,7 @@ export default class ConfigTest {
   public async shouldBeAbleToGetAllConfigurationsValuesFromConfigClass({ assert }: TestContext) {
     const configs = Config.get()
 
-    assert.deepEqual(configs.app, { name: 'Athenna', env: 'test' })
+    assert.deepEqual(configs.app, { name: 'Athenna', env: 'test', environments: ['default'] })
     assert.deepEqual(configs.database, { username: 'Athenna', env: 'test' })
   }
 
@@ -46,6 +47,7 @@ export default class ConfigTest {
     assert.deepEqual(app, {
       name: 'Athenna',
       env: 'test',
+      environments: ['default'],
     })
   }
 
@@ -111,6 +113,7 @@ export default class ConfigTest {
         subName: 'Framework',
       },
       env: 'test',
+      environments: ['default'],
     })
 
     Config.set('app', { hello: 'world' })
@@ -138,6 +141,28 @@ export default class ConfigTest {
     Config.set('app', mainConfig)
   }
 
+  @Test()
+  public async shouldBeAbleToPushValuesToConfigurationsThatAreArrays({ assert }: TestContext) {
+    Config.push('app.environments', 'http')
+    Config.push('app.environments', ['repl', 'console'])
+
+    assert.deepEqual(Config.get('app.environments'), ['default', 'http', 'repl', 'console'])
+  }
+
+  @Test()
+  public async shouldBeAbleToPushValuesToConfigurationsThatDoesNotExist({ assert }: TestContext) {
+    Config.push('app.newArray', 'http')
+    Config.push('app.newArrayArray', ['repl', 'console'])
+
+    assert.deepEqual(Config.get('app.newArray'), ['http'])
+    assert.deepEqual(Config.get('app.newArrayArray'), ['repl', 'console'])
+  }
+
+  @Test()
+  public async shouldThrowAnExceptionIfTryingToPushValueToAConfigurationThatIsNotAnArray({ assert }: TestContext) {
+    assert.throws(() => Config.push('app.name', 'http'), NotValidArrayConfigException)
+  }
+
   @Test()
   public async shouldBeAbleToDeleteValuesFromConfigurations({ assert }: TestContext) {
     Config.delete('notFound')
@@ -163,7 +188,7 @@ export default class ConfigTest {
   }
 
   @Test()
-  public async shouldThrownAnErrorWhenLoadingAConfigurationFileThatRecursivellyLoadsOther({ assert }: TestContext) {
+  public async shouldThrownAnErrorWhenLoadingAConfigurationFileThatRecursivelyLoadsOther({ assert }: TestContext) {
     const useCase = async () => await Config.load(Path.stubs('config/recursiveOne.ts'))
 
     await assert.rejects(useCase, RecursiveConfigException)
@@ -178,7 +203,7 @@ export default class ConfigTest {
   }
 
   @Test()
-  public async shouldBeAbleToRealodConfigurationValues({ assert }: TestContext) {
+  public async shouldBeAbleToReloadConfigurationValues({ assert }: TestContext) {
     assert.equal(Config.get('app.env'), 'test')
 
     process.env.NODE_ENV = 'example'
@@ -217,14 +242,24 @@ export default class ConfigTest {
 
   @Test()
   @Cleanup(() => Config.delete('app'))
-  public async shouldBeAbleToLoadAllConfigurationPathSafelly({ assert }: TestContext) {
+  public async shouldBeAbleToLoadAllConfigurationPathSafely({ assert }: TestContext) {
     Config.set('app', {})
 
     await Config.loadAll(Path.config(), true)
 
     assert.deepEqual(Config.get('app'), {})
   }
 
+  @Test()
+  @Cleanup(() => Config.delete('app'))
+  public async shouldBeAbleToLoadASingleFileInLoadAllMethod({ assert }: TestContext) {
+    Config.set('app', {})
+
+    await Config.loadAll(Path.config('app.ts'), true)
+
+    assert.deepEqual(Config.get('app'), {})
+  }
+
   @Test()
   @Cleanup(() => (process.env.IS_TS = 'true'))
   public async shouldBeAbleToLoadAllJsFilesButNotTsFilesWhenEnvTsIsFalse({ assert }: TestContext) {
@@ -238,7 +273,7 @@ export default class ConfigTest {
   }
 
   @Test()
-  public async shouldBeAbleToLoadConfigFoldersRecursivelly({ assert }: TestContext) {
+  public async shouldBeAbleToLoadConfigFoldersRecursively({ assert }: TestContext) {
     Config.clear()
 
     await Config.loadAll(Path.stubs('recursive'), false)