mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
f0cfa00a34
This implementation change was originally proposed as part of Typed Forms, and will have major consequences for that project as described in the design doc. Submitting it separately will greatly simplify the risk of landing Typed Forms. This change should have no visible impact on normal users of FormControl. See the Typed Forms design doc here: https://docs.google.com/document/d/1cWuBE-oo5WLtwkLFxbNTiaVQGNk8ipgbekZcKBeyxxo. PR Close #44316 PR Close #44806
75 lines
2.7 KiB
JavaScript
75 lines
2.7 KiB
JavaScript
const testPackage = require('../../helpers/test-package');
|
|
const processorFactory = require('./mergeOverriddenImplementation');
|
|
const Dgeni = require('dgeni');
|
|
const mockLogFactory = require('dgeni/lib/mocks/log');
|
|
const createDocMessageFactory = require('dgeni-packages/base/services/createDocMessage');
|
|
|
|
describe('mergeOverriddenImplementation processor', () => {
|
|
|
|
let getDocFromAlias, log, createDocMessage, processor;
|
|
|
|
beforeEach(() => {
|
|
getDocFromAlias = jasmine.createSpy('getDocFromAlias');
|
|
log = mockLogFactory(false);
|
|
createDocMessage = createDocMessageFactory();
|
|
processor = processorFactory(getDocFromAlias, log, createDocMessage);
|
|
});
|
|
|
|
it('should be available on the injector', () => {
|
|
const dgeni = new Dgeni([testPackage('angular-api-package')]);
|
|
const injector = dgeni.configureInjector();
|
|
const processor = injector.get('mergeOverriddenImplementation');
|
|
expect(processor.$process).toBeDefined();
|
|
});
|
|
|
|
it('should run before the correct processor', () => {
|
|
expect(processor.$runBefore).toEqual(['filterPrivateDocs']);
|
|
});
|
|
|
|
it('should run after the correct processor', () => {
|
|
expect(processor.$runAfter).toEqual(['tags-extracted', 'ids-computed']);
|
|
});
|
|
|
|
it('should ignore docs that do not have a `@overriddenImplementation` tag', () => {
|
|
const docs = [{}];
|
|
getDocFromAlias.and.returnValue([{ prop1: 'prop-1', prop2: 'prop-2', prop3: 'prop-3' }]);
|
|
processor.$process(docs);
|
|
expect(docs).toEqual([{}]);
|
|
});
|
|
|
|
it('should replace properties with those from the implementation and constructor docs', () => {
|
|
const exportedNameDoc = {
|
|
overriddenImplementation: 'FooCtor', // This processor should apply
|
|
exportedProp: true, // Documentation on the exported interface will remain
|
|
};
|
|
const docs = [exportedNameDoc];
|
|
|
|
const fakeGetDocs = (docName) => {
|
|
switch(docName) {
|
|
case 'Foo': return [exportedNameDoc];
|
|
case 'FooCtor': return [{ctorProp: true, members: [{name: 'new'}]}];
|
|
}
|
|
};
|
|
|
|
getDocFromAlias.and.callFake(fakeGetDocs);
|
|
processor.$process(docs);
|
|
|
|
expect(docs).toEqual([{
|
|
overriddenImplementation: 'FooCtor',
|
|
// Original documentation property
|
|
exportedProp: true,
|
|
// Constructor signature property
|
|
constructorDoc: {name: 'new'},
|
|
// The exported symbol should be explicitly marked non-internal
|
|
internal: false,
|
|
privateExport: false,
|
|
}]);
|
|
});
|
|
|
|
it('should have default properties to keep', () => {
|
|
expect(processor.propertiesToKeep).toEqual([
|
|
'name', 'id', 'aliases', 'fileInfo', 'startingLine', 'endingLine',
|
|
'path', 'originalModule', 'outputPath', 'privateExport', 'moduleDoc'
|
|
]);
|
|
});
|
|
});
|