feat: add file system utilities for 'upgrade' process

'fs-promise.ts' is a utility file for asynchronous read/write operations
'change.ts' implements some change interfaces as specified by the upgrade design doc linked below:
https://github.com/hansl/angular-cli/blob/7ea3e78ff3d899d5277aac5dfeeece4056d0efe3/docs/design/upgrade.md

Author: ashoktamang

addon/ng2/utilities/change.ts

@@ -0,0 +1,103 @@
+'use strict';
+
+import * as Promise from 'ember-cli/lib/ext/promise';
+let fs = require('fs');
+
+const readFile =  Promise.denodeify(fs.readFile);
+const writeFile = Promise.denodeify(fs.writeFile);
+
+export interface Change {
+  /**
+   *  True on success, false otherwise.
+   */
+  apply(): Promise<void>;
+
+  // The file this change should be applied to. Some changes might not apply to
+  // a file (maybe the config).
+  path: string | null;
+
+  // The order this change should be applied. Normally the position inside the file.
+  // Changes are applied from the bottom of a file to the top.
+  order: number | null;
+
+  // The description of this change. This will be outputted in a dry or verbose run.
+  description: string;
+}
+
+
+/**
+ * Will add text to the source code.
+ */
+export class InsertChange implements Change {
+  const order: number;
+  const description: string;
+  constructor(
+    public path: string,
+    private pos: number,
+    private toAdd: string,
+    ) {
+      this.description = `Inserted ${toAdd} into position ${pos} of ${path}`;
+      this.order = pos;
+  }
+
+  /**
+   * This method does not insert spaces if there is none in the original string. 
+   * @param file (path to file)
+   * @param pos
+   * @param toAdd (text to add)
+   * @return Promise with a description on success or reject on error
+   */
+  apply(): Promise<any> {
+    return readFile(this.path, 'utf8').then(content => {
+      content = content.substring(0, this.pos) + this.toAdd + content.substring(this.pos);
+      return writeFile(this.path, content);
+    });
+  }
+}
+
+/**
+ * Will remove text from the source code.
+ */
+export class RemoveChange implements Change {
+  const order: number;
+  const description: string;
+
+  constructor(
+    public path: string,
+    private pos: number,
+    private toRemove: string) {
+      this.description = `Removed ${toRemove} into position ${pos} of ${path}`;
+      this.order = pos;
+    }
+
+  apply(): Promise<any> {
+    return readFile(this.path, 'utf8').then(content => {
+      content = content.substring(0, this.pos) + content.substring(this.pos + this.toRemove.length);
+      return writeFile(this.path, content);
+    });
+  }
+}
+
+/**
+ * Will replace text from the source code.
+ */
+export class ReplaceChange implements Change {
+  const order: number;
+  const description: string;
+
+  constructor(
+    public path: string,
+    private pos: number,
+    private oldText: string,
+    private newText: string) {
+      this.description = `Replaced ${oldText} into position ${pos} of ${path} with ${newText}`;
+      this.order = pos;
+  }
+
+  apply(): Promise<any> {
+    return readFile(this.path, 'utf8').then(content => {
+      content = content.substring(0, this.pos) + this.newText + content.substring(this.pos + this.oldText.length);
+      writeFile(this.path, content);
+    });
+  }
+}

tests/acceptance/change.spec.js

@@ -0,0 +1,135 @@
+'use strict';
+
+const expect = require('chai').expect;
+let path = require('path');
+let mockFs = require('mock-fs');
+let change = require('../../addon/ng2/utilities/change');
+let fs = require('fs');
+let Promise = require('ember-cli/lib/ext/promise');
+
+
+
+describe('Change: Testing operations', () => {
+  const readFile =  Promise.denodeify(fs.readFile);
+  let sourcePath = 'src/app/my-component';
+  
+  beforeEach(() => {
+    let mockDrive = {
+      'src/app/my-component': {
+        'add-file.txt': 'hello',
+        'remove-replace-file.txt': 'import * as foo from "./bar"',
+        'replace-file.txt': 'import { FooComponent } from "./baz"'
+      }
+    }
+    mockFs(mockDrive);
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+  });
+
+  describe('InsertChange: add string to the source code', () => {
+    
+    it('should add text to the source code', () => {
+      let sourceFile = path.join(sourcePath, 'add-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.InsertChange(sourceFile, 6, ' world!');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile, 'utf8'))
+        .then(contents => {
+          expect(contents).to.equal('hello world!');
+        })
+    })
+
+    it('should append string before any strings in the source code, and hence unexpected output', () => {
+      let sourceFile = path.join(sourcePath, 'add-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.InsertChange(sourceFile, -6, ' world!');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile))
+        .then(contents => {
+          expect(contents).to.not.equal('hello world!');
+        });
+    })
+
+    it('should add nothing in the source code if empty string is inserted', () => {
+      let sourceFile = path.join(sourcePath, 'add-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.InsertChange(sourceFile, 6, '');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile, 'utf8'))
+        .then(contents => {
+          expect(contents).to.equal('hello');
+        });
+    })
+  });
+
+  describe('RemoveChange: remove string from the source code', () => {
+    
+    it('should remove given text from the source code', () => {
+      let sourceFile = path.join(sourcePath, 'remove-replace-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.RemoveChange(sourceFile, 9, 'as foo');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile, 'utf8'))
+        .then(contents => {
+          expect(contents).to.equal('import *  from "./bar"');
+        });
+    })
+
+    it('should remove nothing in the source code if empty string is to be removed', () => {
+      let sourceFile = path.join(sourcePath, 'remove-replace-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.RemoveChange(sourceFile, 9, '');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile, 'utf8'))
+        .then(contents => {
+          expect(contents).to.equal('import * as foo from "./bar"');
+        });
+    })
+  });
+
+  describe('ReplaceChange: replace string in the source code', () => {
+
+    it('should replace a given text in the source code', () => {
+      let sourceFile = path.join(sourcePath, 'remove-replace-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.ReplaceChange(sourceFile, 7, '* as foo', '{ fooComponent }');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile, 'utf8'))
+        .then(contents => {
+          expect(contents).to.equal('import { fooComponent } from "./bar"');
+        });
+    })
+
+    it('should add string to the position of an empty string', () => {
+      let sourceFile = path.join(sourcePath, 'replace-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.ReplaceChange(sourceFile, 9, '', 'BarComponent, ');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile, 'utf8'))
+        .then(contents => {
+          expect(contents).to.equal('import { BarComponent, FooComponent } from "./baz"');
+        });
+    })
+
+    it('should removes the string in the given postion and add nothing if empty string is to be replaced', () => {
+      let sourceFile = path.join(sourcePath, 'remove-replace-file.txt');
+      expect(fs.existsSync(sourceFile)).to.equal(true);
+      let changeInstance = new change.ReplaceChange(sourceFile, 9, ' as foo', '');
+      return changeInstance
+        .apply()
+        .then(() => readFile(sourceFile, 'utf8'))
+        .then(contents => {
+          expect(contents).to.equal('import * from "./bar"');
+        });
+    })
+  });
+});