Merge pull request #44 from adrienv1520/develop

1.2.9

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 1.2.9 - delivery @15/02/2021
+
+- improve LibError error library
+- add tests
+- fix Readme typo
+
 ## 1.2.8 - delivery @23/10/2020
 
 - improve LibError error library

LICENSE.md

@@ -1,6 +1,6 @@
 *Bitgener* is released under the MIT license.
 
-Copyright (C) 2020 Adrien Valcke
+Copyright (C) 2021 Adrien Valcke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -33,7 +33,7 @@
 - [Contributing](#contributing)
 - [Support](#support)
 - [Security](#security)
-- [Licence](#licence)
+- [License](#license)
 
 # Presentation
 
@@ -544,5 +544,5 @@ Please see our [Support](.github/SUPPORT.md) page if you have any questions or f
 # Security
 For any security concerns or issues, please visit our [Security Policy](.github/SECURITY.md) page.
 
-# Licence
+# License
 [MIT](LICENSE.md).

lib/LibError/index.js

@@ -1,3 +1,21 @@
+/**
+ * LibError
+ *
+ * - code
+ * - message
+ * - name
+ * - stack
+ * - originStack
+ *
+ * - setCode(value)
+ * - setMessage(value)
+ * - setName(value)
+ * - setOriginStack(originError)
+ * - toString()
+ *
+ * - static get Codes()
+ * - static format(err) -> LibError
+ */
 const { str } = require('../helpers/cast');
 const { is, exists } = require('../helpers/object');
 const Codes = require('./Codes');
@@ -19,7 +37,7 @@ class LibError extends Error {
       this.setName(LibError.Codes.UNKNOWN_ERROR.name);
     }
 
-    this.setStack(originError);
+    this.setOriginStack(originError);
   }
 
   static get Codes() {
@@ -53,7 +71,7 @@ class LibError extends Error {
       }
 
       // set proper stack trace or keep original
-      error.setStack(err);
+      error.setOriginStack(err);
     } else {
       error = err;
     }
@@ -88,17 +106,16 @@ class LibError extends Error {
     return false;
   }
 
-  setStack(originError) {
+  setOriginStack(originError) {
     if (is(Error, originError) && is(String, originError.stack)) {
-      this.stack += originError.stack;
-      return true;
+      this.originStack = `\n${originError.stack}`;
+    } else if (this.originStack === undefined) {
+      this.originStack = '';
     }
-
-    return false;
   }
 
   toString() {
-    return `${this.name}: code ${this.code}\n${this.stack}`;
+    return `code ${this.code}\n${this.stack}${this.originStack}`;
   }
 }
 

lib/helpers/output.js

@@ -83,7 +83,7 @@ const generate = async function generate({ svg, settings } = {}) {
 
         svgOutput = svg;
       } catch (e) {
-        const error = new LibError(LibError.Codes.WRITABLE_INTERNAL);
+        const error = new LibError(LibError.Codes.WRITABLE_INTERNAL, e);
         error.setMessage(e.message);
 
         throw error;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitgener",
-  "version": "1.2.8",
+  "version": "1.2.9",
   "description": "A lightweight and zero-dependencies pure Node.js barcode generator",
   "author": "Adrien Valcke <[email protected]> (https://github.com/adrienv1520)",
   "main": "lib/index.js",

test/LibError/index.js

@@ -100,7 +100,7 @@ describe('#LibError', function() {
       expect(error.constructor.name).to.equals('LibError');
     });
 
-    it('should return an unknown error with the origin error\'s code/message/name as a message if not a standard error and stack including origin stack', function() {
+    it('should return an unknown error with the origin error\'s code/message/name as a message if not a standard error and having the origin error stack', function() {
       let err = new URIError('uri not available');
       let error = LibError.format(err);
 
@@ -109,7 +109,9 @@ describe('#LibError', function() {
       expect(error.message).to.equals('uri not available');
       expect(error.name).to.equals('LibError');
       expect(error.constructor.name).to.equals('LibError');
-      expect(error.stack).to.be.a('string').and.to.include(err.stack);
+      expect(error.originStack).to.be.a('string').and.to.equals(`\n${err.stack}`);
+      expect(error.toString()).to.be.a('string').and.to.include(error.stack);
+      expect(error.toString()).to.be.a('string').and.to.include(err.stack);
 
       err = new URIError();
       error = LibError.format(err);
@@ -119,7 +121,9 @@ describe('#LibError', function() {
       expect(error.message).to.equals('URIError');
       expect(error.name).to.equals('LibError');
       expect(error.constructor.name).to.equals('LibError');
-      expect(error.stack).to.be.a('string').and.to.include(err.stack);
+      expect(error.originStack).to.be.a('string').and.to.equals(`\n${err.stack}`);
+      expect(error.toString()).to.be.a('string').and.to.include(error.stack);
+      expect(error.toString()).to.be.a('string').and.to.include(err.stack);
 
       err = new Error();
       error = LibError.format(err);
@@ -129,7 +133,9 @@ describe('#LibError', function() {
       expect(error.message).to.equals('unknown error');
       expect(error.name).to.equals('LibError');
       expect(error.constructor.name).to.equals('LibError');
-      expect(error.stack).to.be.a('string').and.to.include(err.stack);
+      expect(error.originStack).to.be.a('string').and.to.equals(`\n${err.stack}`);
+      expect(error.toString()).to.be.a('string').and.to.include(error.stack);
+      expect(error.toString()).to.be.a('string').and.to.include(err.stack);
 
       err = new Error();
       err.code = 'ORIGIN_ERROR_CODE'
@@ -140,7 +146,9 @@ describe('#LibError', function() {
       expect(error.message).to.equals('ORIGIN_ERROR_CODE');
       expect(error.name).to.equals('LibError');
       expect(error.constructor.name).to.equals('LibError');
-      expect(error.stack).to.be.a('string').and.to.include(err.stack);
+      expect(error.originStack).to.be.a('string').and.to.equals(`\n${err.stack}`);
+      expect(error.toString()).to.be.a('string').and.to.include(error.stack);
+      expect(error.toString()).to.be.a('string').and.to.include(err.stack);
     });
   });
 
@@ -236,7 +244,7 @@ describe('#LibError', function() {
       expect(error.constructor.name).to.equals('LibError');
     });
 
-    it('should create a lib error with a stack trace including origin error\'s stack', function() {
+    it('should create a lib error with the origin error stack trace and to be included in toString format', function() {
       const origin = new URIError('bad uri');
       const error = new LibError({}, origin);
 
@@ -245,7 +253,9 @@ describe('#LibError', function() {
       expect(error.message).to.equals('bad uri');
       expect(error.name).to.equals('LibError');
       expect(error.constructor.name).to.equals('LibError');
-      expect(error.stack).to.be.a('string').and.to.include(origin.stack);
+      expect(error.originStack).to.be.a('string').and.to.equals(`\n${origin.stack}`);
+      expect(error.toString()).to.be.a('string').and.to.include(error.stack);
+      expect(error.toString()).to.be.a('string').and.to.include(origin.stack);
     });
   });
 });