Merge pull request #44 from ngarbezza/develop

[release] v4.2.0

.github/workflows/npmpublish.yml

@@ -0,0 +1,44 @@
+name: Node.js Package
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://npm.pkg.github.com/
+          scope: '@ngarbezza'
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GPR_TOKEN}}

CHANGELOG.md

@@ -6,8 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+Everything is released. Yay! :tada:
+
+## [4.2.0] - 2019-10-09
+
 ### Added
 * [Allow to pass a regex to the raises() matcher](https://github.com/ngarbezza/testy/issues/39)
+* [New matcher: doesNotInclude()](https://github.com/ngarbezza/testy/issues/38)
 
 ### Fixed
 * [Poor error message when custom equality method is not found](https://github.com/ngarbezza/testy/issues/35): Thank you, [@TomerPacific](https://github.com/@TomerPacific)!
@@ -93,6 +98,7 @@ readable and extensible. It also includes a huge internal refactor to make the t
 - Fix passed count at test runner level (no reported issue)
 
 [Unreleased]: https://github.com/ngarbezza/testy/compare/v4.1.1...HEAD
+[4.2.0]: https://github.com/ngarbezza/testy/compare/v4.1.1...v4.2.0
 [4.1.1]: https://github.com/ngarbezza/testy/compare/v4.0.1...v4.1.1
 [4.0.1]: https://github.com/ngarbezza/testy/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/ngarbezza/testy/compare/v3.1.1...v4.0.0

CONTRIBUTING.md

@@ -2,6 +2,13 @@
 
 Issues and Pull Requests are welcome. Please follow the issue templates that are already configured. Have in mind the "Why" section (simplicity, OO code with good practices).
 
+* Base branch: `develop`. Please open PRs against `develop`.
+* Not mandatory, but nice to have, use [Gitmoji](https://gitmoji.carloscuesta.me) for tagging the type of commits you're adding.
+
 If you add a new feature, please add:
 * an example for it on the `tests/examples` folder
 * unit tests for it on the `tests/core` folder
+* an entry in the README explaining how to use it
+
+If you fix a bug, please add:
+* unit tests for it on the `tests/core` folder

README.md

@@ -67,6 +67,7 @@ In this case, make sure suites don't have the `run()` at the end, otherwise they
   * `assert.that(() => { ... }).doesNotRaiseAnyErrors()`
 * Array inclusion:
   * `assert.that(collection).includes(object)`
+  * `assert.that(collection).doesNotInclude(object)`
   * `assert.that(collection).includesExactly(...objects)`
 * Emptiness
   * `assert.that(arrayOrString).isEmpty()`

lib/asserter.js

@@ -88,6 +88,12 @@ class Assertion extends TestResultReporter {
     this._reportAssertionResult(resultIsSuccessful, failureMessage);
   }
 
+  doesNotInclude(object) {
+    const resultIsSuccessful = !this._actual.includes(object);
+    const failureMessage = `${this.translated('not_include')} ${object}`;
+    this._reportAssertionResult(resultIsSuccessful, failureMessage);
+  }
+
   includesExactly(...objects) {
     const resultIsSuccessful = this._checkCollectionsHaveSameElements(this._actual, objects);
     const failureMessage = `${this.translated('include_exactly')} ${this._prettyPrint(objects)}`;

lib/translations.js

@@ -28,6 +28,7 @@ const TRANSLATIONS = {
     be_true: 'be true',
     be_false: 'be false',
     include: 'include',
+    not_include: 'not include',
     include_exactly: 'include exactly',
     be_empty: 'be empty',
     be_not_empty: 'be not empty',
@@ -63,6 +64,7 @@ const TRANSLATIONS = {
     be_true: 'sea true',
     be_false: 'sea false',
     include: 'incluya a',
+    not_include: 'no incluya a',
     include_exactly: 'incluya exactamente a',
     be_empty: 'sea vacío',
     be_not_empty: 'no sea vacío',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pmoo/testy",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "A very simple testing library, for educational purposes",
   "homepage": "https://ngarbezza.github.io/testy/",
   "repository": {
@@ -19,9 +19,11 @@
     "lib": "./lib"
   },
   "keywords": [
+    "unit-test",
     "testing",
     "tdd",
     "simple",
+    "learning",
     "teaching",
     "oop"
   ],

tests/core/asserter_test.js

@@ -141,6 +141,20 @@ suite('assertions behavior', () => {
     expectFailDueTo("Expected [] to include hey");
   });
 
+  // Collection assertions - doesNotInclude()
+
+  test('doesNotInclude fails if the object is in the array', () => {
+    asserter.that(['hey']).doesNotInclude('hey');
+
+    expectFailDueTo("Expected [ 'hey' ] to not include hey");
+  });
+
+  test('doesNotInclude passes if the object is not an array', () => {
+    asserter.that([]).doesNotInclude('hey');
+
+    expectSuccess();
+  });
+
   // Collection assertions - includesExactly()
 
   test('includesExactly passes with a single object included', () => {

tests/examples/basic_assertions_test.js

@@ -27,6 +27,8 @@ suite('testing testy - basic assertions', () => {
 
   test('inclusion in collection', () => assert.that([1, 2, 3]).includes(2));
 
+  test('not inclusion in collection', () => assert.that([1, 2, 3]).doesNotInclude(4));
+
   test('inclusion of all elements in collection', () => {
     assert.that([1, 2, 3]).includesExactly(2, 3, 1);
   });