feat: add tests

- refactor to support tests
- correct bugs and clarify choices as result of test
- add new configuration options
- POST commands/resetDb` passes the request to the `resetDb` method
- when HTTP method interceptor returns null/undefined, continue with default request processing.
- reorganize files into src/app and src/in-mem
- adjust gulp tasks accordingly

closes #123. closes #128. closes #120.

Author: wardbell

.gitignore

@@ -2,12 +2,9 @@ aot
 in-memory-web-api
 node_modules
 typings
-src/*.d.ts
-src/*.js
-src/*.js.map
-src/*.metadata.json
-examples/*.d.ts
-examples/*.js
-examples/*.js.map
-examples/*.metadata.json
+npm-debug.log
+src/**/*.d.ts
+src/**/*.js
+src/**/*.js.map
+src/**/*.metadata.json
 yarn.lock

.npmignore

@@ -1,13 +1,14 @@
+.editorconfig
+.gitignore
+.npmignore
+.travis.yml
 aot
-examples
+gulpfile.js
 in-memory-web-api
+karma-test-shim.js
+karma.conf.js
+rollup.config.js
 src
-gulpfile.js
-.gitignore
-.npmignore
 tsconfig.json
 tslint.json
-.editorconfig
-rollup.config.js
-.travis.yml
 yarn.lock

CHANGELOG.md

@@ -8,6 +8,25 @@ because this is a development tool, not a production product.
 We do try to tell you about such changes in this `CHANGELOG.md`
 
 and we fix bugs as fast as we can.
+
+<a id="0.4.0"></a>
+## 0.4.0 (2017-09-04)
+See PR #130.
+* Added support for `HttpClient`
+* Added tests
+* refactor existing code to support tests
+* correct bugs and clarify choices as result of test
+* add some configuration options
+  - dataEncapsulation (issue #112, pr#123)
+  - post409
+  - put404b
+* `POST commands/resetDb` passes the request to your `resetDb` method 
+so you can optionally reset the database dynamically
+to arbitrary initial states (issue #128)
+* when HTTP method interceptor returns null/undefined, continue with service's default processing (pr #120)
+* reorganize files into src/app and src/in-mem
+* adjust gulp tasks accordingly
+
 <a id="0.3.2"></a>
 ## 0.3.2 (2017-05-02)
 * Bug fixes PRs #91, 95, 106

README.md

@@ -74,16 +74,18 @@ import { InMemoryDbService } from 'angular-in-memory-web-api';
 export class InMemHeroService implements InMemoryDbService {
   createDb() {
     let heroes = [
-      { id: '1', name: 'Windstorm' },
-      { id: '2', name: 'Bombasto' },
-      { id: '3', name: 'Magneta' },
-      { id: '4', name: 'Tornado' }
+      { id: 1, name: 'Windstorm' },
+      { id: 2, name: 'Bombasto' },
+      { id: 3, name: 'Magneta' },
+      { id: 4, name: 'Tornado' }
     ];
     return {heroes};
   }
 }
 ```
 
+>This library _currently_ assumes that every collection has a primary key called `id`.
+
 Register this module and your service implementation in `AppModule.imports`
 calling the `forRoot` static method with this service class and optional configuration object:
 ```ts
@@ -222,7 +224,15 @@ The `InMemoryDbService` method name must be the same as the HTTP method name but
 This service calls it with an `HttpMethodInterceptorArgs` object.
 For example, your HTTP GET interceptor would be called like this:
 e.g., `yourInMemDbService["get"](interceptorArgs)`.
-Your method must **return an `Observable<Response>`** which _should be "cold"_.
+
+Your method must return either:
+
+* `Observable<Response>` - your code has handled the request and the response is available from this
+observable.  It _should be "cold"_.
+
+* `null`/`undefined` - your code decided not to intervene, 
+perhaps because you wish to intercept only certain paths for the given HTTP method.
+The service continues with its default processing of the HTTP request.
 
 The `HttpMethodInterceptorArgs` (as of this writing) are:
 ```ts
@@ -233,25 +243,23 @@ passThruBackend: ConnectionBackend; // pass through backend, if it exists
 ```
 ## Examples
 
-The file `examples/hero-data.service.ts` is an example of a Hero-oriented `InMemoryDbService`,
-derived from the [HTTP Client](https://angular.io/docs/ts/latest/guide/server-communication.html) 
-sample in the Angular documentation.
+The file `src/app/hero-in-mem-data.service.ts` is an example of a Hero-oriented `InMemoryDbService`,
+such as you might see in an HTTP sample in the Angular documentation.
 
 To try it, add the following line to `AppModule.imports`
 ```ts
-InMemoryWebApiModule.forRoot(HeroDataService)
+InMemoryWebApiModule.forRoot(HeroInMemDataService)
 ```
 
-That file also has a `HeroDataOverrideService` derived class that demonstrates overriding
-the `parseUrl` method and it has a "cold" HTTP GET interceptor.
+See the `src/app/hero-in-mem-data-override.service.ts` class that demonstrates overriding
+the `parseUrl` method. It also has a "cold" HTTP GET interceptor.
 
 Add the following line to `AppModule.imports` to see this version of the data service in action:
 ```ts
-InMemoryWebApiModule.forRoot(HeroDataOverrideService)
+InMemoryWebApiModule.forRoot(HeroInMemDataOverrideService)
 ```
 
-# To Do
-* add tests (shameful omission!)
+The tests (see below) exercise these examples.
 
 # Build Instructions
 
@@ -282,7 +290,7 @@ compiling your application project.
 
 - `npm run tsc` to confirm the project compiles w/o error (sanity check)
 
- -- NO TESTS YET ... BAD --
+- `npm test`  to build and run tests (see "Testing" below)
 
 - `gulp build`
 - commit and push
@@ -297,3 +305,26 @@ compiling your application project.
 
 [travis-badge]: https://travis-ci.org/angular/in-memory-web-api.svg?branch=master
 [travis-badge-url]: https://travis-ci.org/angular/in-memory-web-api
+
+## Testing
+
+The "app" for this repo is not a real app.
+It's an Angular data service (`HeroService`) and a bunch of tests.
+
+>Note that the `tsconfig.json` produces a `commonjs` module.
+That's what _Angular specs require_.
+But when building for an app, it should be a `es2015` module,
+as is the `tsconfig-ngc.json` for AOT-ready version of this library.
+
+These tests are a work-in-progress, as tests often are.
+
+The `src/` folder is divided into 
+- `app/` - the test "app" and its tests
+- `in-mem/` - the source code for the in-memory web api library
+
+>A real app would reference the in-memory web api node module;
+these tests reference the library source files.
+
+The `karma-test-shim.js` add `in-mem` to the list of app folders that SystemJS should resolve.
+
+

gulpfile.js

@@ -8,8 +8,8 @@ var source = require('vinyl-source-stream');
 
 var path = require("path");
 
-var ngcOutput = './src/';
-var jsCopySrc = ['*.js', '*.js.map', '*.d.ts', '*.metadata.json'].map(ext => ngcOutput + ext);
+var inMemSrc = './src/in-mem/';
+var jsCopySrc = ['*.js', '*.js.map', '*.d.ts', '*.metadata.json'].map(ext => inMemSrc + ext);
 
 gulp.task('default', ['help']);
 
@@ -28,7 +28,7 @@ gulp.task('build', ['umd'], function(){
 });
 
 gulp.task('ngc', ['clean'], function(done) {
-    runNgc('./', done);
+  runNgc('src/in-mem/', done);
 });
 
 // Uses rollup-stream plugin https://www.npmjs.com/package/rollup-stream
@@ -38,9 +38,20 @@ gulp.task('umd', ['ngc'], function(done) {
     .pipe(gulp.dest('./bundles'));
 });
 
-gulp.task('clean', function(done) {
-  clean(['aot/**/*.*']);
-  clean([ngcOutput+'*.js', '*.js.map', '*.d.ts', '!gulpfile.js', '*.metadata.json', './bundles/in-memory-web-api.umd.js'], done);
+gulp.task('clean', function() {
+  return Promise.all([
+    clean(['aot/**/*.*']),
+    clean(['src/app/**.*js','src/**/*.js.map', 'src/**/*.d.ts','src/**/*.metadata.json']),
+    clean(['src/in-mem/node_modules/**/*.*','src/in-mem/**.*js','src/**/*.ngsummary.json', 'src/**/*.ngfactory.ts']),
+    clean([
+       './http-status-codes.*',
+       './in-memory-backend.service.*',
+       './in-memory-web-api.module.*',
+       './index.*',
+       './bundles/in-memory-web-api.umd.js'
+    ])
+  ])
+  .then(() => console.log('Cleaned successfully'));
 });
 
 /**
@@ -73,13 +84,12 @@ gulp.task('bump', function() {
 });
 //////////
 
-function clean(path, done) {
+function clean(path) {
     log('Cleaning: ' + $.util.colors.blue(path));
-    del(path, {dryRun:false})
+    return del(path, {dryRun:false})
     .then(function(paths) {
       console.log('Deleted files and folders:\n', paths.join('\n'));
-    })
-    .then(done,done);
+    });
 }
 
 function log(msg) {
@@ -98,7 +108,7 @@ function runNgc(directory, done) {
     //var ngcjs = path.join(process.cwd(), 'node_modules/typescript/bin/tsc');
     //ngcjs = path.join(process.cwd(), 'node_modules/.bin/ngc');
     var ngcjs = './node_modules/@angular/compiler-cli/src/main.js';
-    var childProcess = cp.spawn('node', [ngcjs, '-p', directory], { cwd: process.cwd() });
+    var childProcess = cp.spawn('node', [ngcjs, '-p', './tsconfig-ngc.json'], { cwd: process.cwd() });
     childProcess.stdout.on('data', function (data) {
         console.log(data.toString());
     });