Merge pull request #16 from AthennaIO/develop

chore(npm): update dependencies

.gitignore

@@ -120,9 +120,9 @@ build
 *.js
 *.d.ts
 *.js.map
-!tests/stubs/**/*.js
-!tests/stubs/**/*.d.ts
-!tests/stubs/**/*.js.map
+!tests/fixtures/**/*.js
+!tests/fixtures/**/*.d.ts
+!tests/fixtures/**/*.js.map
 
 # IDE
 .idea

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@athenna/view",
- "version": "4.1.0",
+ "version": "4.2.0",
  "description": "The Athenna template engine. Built on top of Edge.",
  "license": "MIT",
  "author": "João Lenon <[email protected]>",
@@ -50,10 +50,10 @@
  "edge.js": "^5.5.1"
  },
  "devDependencies": {
- "@athenna/common": "^4.4.0",
- "@athenna/config": "^4.3.0",
- "@athenna/ioc": "^4.1.0",
- "@athenna/test": "^4.3.0",
+ "@athenna/common": "^4.10.1",
+ "@athenna/config": "^4.4.0",
+ "@athenna/ioc": "^4.2.0",
+ "@athenna/test": "^4.5.0",
  "@typescript-eslint/eslint-plugin": "^5.56.0",
  "@typescript-eslint/parser": "^5.56.0",
  "c8": "^7.12.0",
@@ -109,7 +109,7 @@
  },
  "prettier": {
  "singleQuote": true,
- "trailingComma": "all",
+ "trailingComma": "none",
  "arrowParens": "avoid",
  "endOfLine": "lf",
  "semi": false,
@@ -166,4 +166,4 @@
  ]
  }
  }
-}
+}

src/exceptions/AlreadyExistComponentException.ts

@@ -15,7 +15,7 @@ export class AlreadyExistComponentException extends Exception {
  status: 500,
  code: 'E_EXIST_COMPONENT',
  message: `The component ${name} already exists.`,
- help: `This exception is thrown when trying to create a component with a name that is already is use, in this case "${name}". Try to create your component with a different name or remove the other component first using the "View.removeComponent('${name}')" method. Also, "View.createTemplate('${name}', 'your-component-value')" will automatically remove the other component for you.`,
+ help: `This exception is thrown when trying to create a component with a name that is already is use, in this case "${name}". Try to create your component with a different name or remove the other component first using the "View.removeComponent('${name}')" method. Also, "View.createTemplate('${name}', 'your-component-value')" will automatically remove the other component for you.`
  })
  }
 }

src/exceptions/EmptyComponentException.ts

@@ -15,7 +15,7 @@ export class EmptyComponentException extends Exception {
  status: 500,
  code: 'E_EMPTY_COMPONENT',
  message: `The component ${name} cannot be registered with "null" or "undefined" value.`,
- help: `This exception is thrown when trying to create a component with a "null" or "undefined" value. Try to set at least an empty string when using the "View.createComponent('${name}', '')" method.`,
+ help: `This exception is thrown when trying to create a component with a "null" or "undefined" value. Try to set at least an empty string when using the "View.createComponent('${name}', '')" method.`
  })
  }
 }

src/exceptions/NotFoundTemplateException.ts

@@ -15,7 +15,7 @@ export class NotFoundTemplateException extends Exception {
  status: 500,
  code: 'E_NOT_FOUND',
  message: `The view or component ${name} cannot be found.`,
- help: `This exception is thrown when trying to render a view or a component that has not been registered. Try to create your template or your disk it using the "View.createTemplate('${name}', 'your-template-content')", or "View.createViewDisk('${name}', 'your-view-disk-path')" methods.`,
+ help: `This exception is thrown when trying to render a view or a component that has not been registered. Try to create your template or your disk using the "View.createTemplate('${name}', 'your-template-content')", or "View.createViewDisk('${name}', 'your-view-disk-path')" methods.`
  })
  }
 }

src/views/ViewImpl.ts

@@ -158,7 +158,7 @@ export class ViewImpl {
  'Path %s for view disk %s is not absolute and is going to be resolved using cwd %s.',
  path,
  name,
- Path.pwd(),
+ Path.pwd()
  )
 
  path = resolve(Path.pwd(), path)
@@ -360,7 +360,7 @@ export class ViewImpl {
  if (!this.hasTemplate(name)) {
  debug(
  'Template %s does not exist and removing operation will be skipped.',
- name,
+ name
  )
 
  return this

tests/fixtures/config/view.ts

@@ -0,0 +1,12 @@
+import { Path } from '@athenna/common'
+
+export default {
+ disks: {
+ admin: Path.fixtures('views/admin'),
+ component: Path.fixtures('views/components')
+ },
+
+ edge: {
+ cache: false
+ }
+}

tests/unit/ViewTest.ts

@@ -21,7 +21,7 @@ export default class ViewTest {
  public async beforeEach() {
  Config.clear()
  new Ioc().reconstruct()
- await Config.loadAll(Path.stubs('config'))
+ await Config.loadAll(Path.fixtures('config'))
  }
 
  @AfterEach()
@@ -31,7 +31,7 @@ export default class ViewTest {
 
  @Test()
  public async shouldBeAbleToRenderHtmlViewsWithComponentsIncluded({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  const content = await View.render('admin::listUsers', { users: JSON.stringify({ name: 'Victor Tesoura' }) })
@@ -43,7 +43,7 @@ export default class ViewTest {
 
  @Test()
  public async shouldBeAbleToRenderRawEdgeContent({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  const content = '## Hello {{ value }}'
@@ -58,7 +58,7 @@ export default class ViewTest {
 
  @Test()
  public async shouldBeAbleToAddAndRemoveGlobalPropertiesInViews({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  const content = await View.addProperty('nodeVersion', '18').renderRaw('## Node.js version: {{ nodeVersion }}')
@@ -70,18 +70,18 @@ export default class ViewTest {
 
  @Test()
  public async shouldNotThrowsErrorsWhenTryingToRemoveAGlobalPropertyThatDoesNotExists({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.doesNotThrows(() => View.removeProperty('notFound'))
  }
 
  @Test()
  public async shouldBeAbleToAddAndRemoveViewDisks({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
- View.createViewDisk('test', Path.stubs('views'))
+ View.createViewDisk('test', Path.fixtures('views'))
 
  assert.isTrue(View.hasViewDisk('test'))
 
@@ -92,7 +92,7 @@ export default class ViewTest {
 
  @Test()
  public async shouldThrowAnExceptionWhenTryingToRenderViewsThatAreNotRegistered({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.throws(() => View.renderSync('notFound'), NotFoundTemplateException)
@@ -101,12 +101,12 @@ export default class ViewTest {
 
  @Test()
  public async shouldBeAbleToUpdateAlreadyMountedViewDisks({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.isTrue(View.hasViewDisk('admin::listUsers'))
 
- View.createViewDisk('admin', Path.stubs('views/components'))
+ View.createViewDisk('admin', Path.fixtures('views/components'))
 
  assert.isFalse(View.hasViewDisk('admin::listUsers'))
  assert.isTrue(View.hasViewDisk('admin::header'))
@@ -115,15 +115,15 @@ export default class ViewTest {
 
  @Test()
  public async shouldNotThrowsAnyErrorsWhenTryingToRemoveAViewDiskThatDoesNotExists({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.doesNotThrows(() => View.removeViewDisk('notFound'))
  }
 
  @Test()
  public async shouldBeAbleToCreateAndRemoveComponents({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  View.createComponent('hello', 'Hello')
@@ -137,26 +137,26 @@ export default class ViewTest {
 
  @Test()
  public async shouldThrowAnExceptionWhenTryingToCreateAUndefinedComponent({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.throws(() => View.createComponent('testing', undefined), EmptyComponentException)
  }
 
  @Test()
  public async shouldThrowAnExceptionWhenTryingToCreateAComponentWithANameThatAlreadyExists({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.throws(
  () => View.createComponent('testing', '').createComponent('testing', ''),
- AlreadyExistComponentException,
+ AlreadyExistComponentException
  )
  }
 
  @Test()
  public async shouldBeAbleToAutomaticallyRemoveTheComponentIfNameIsAlreadyIsUse({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  View.createTemplate('hello', 'Hello')
@@ -170,23 +170,23 @@ export default class ViewTest {
 
  @Test()
  public async shouldNotThrowErrorsIfTryingToRemoveAComponentThatDoesNotExists({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.doesNotThrows(() => View.removeComponent('notFound'))
  }
 
  @Test()
  public async shouldNotThrowErrorsIfTryingToRemoveATemplateThatDoesNotExists({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  new ViewProvider().register()
 
  assert.doesNotThrows(() => View.removeTemplate('notFound'))
  }
 
  @Test()
  public async shouldNotRegisterTemplateIfViewTemplatesRegisterIsFalse({ assert }: Context) {
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  Config.set('view.templates.register', false)
 
  new ViewProvider().register()
@@ -197,7 +197,7 @@ export default class ViewTest {
  @Test()
  public async shouldBeAbleToRegisterCustomTemplate({ assert }: Context) {
  const templatePath = Path.resources('templates/command.edge')
- await Config.load(Path.stubs('config/view.ts'))
+ await Config.load(Path.fixtures('config/view.ts'))
  await new File(templatePath, Buffer.from('Hello')).load()
 
  new ViewProvider().register()