From a671d2f0050e14013e737841cec4dc347c6f3cd6 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 15:53:16 +0300 Subject: [PATCH 01/10] update to the latest angular --- karma.conf.js | 1 - lib/components/ApiInfo/api-info.spec.ts | 29 ++----- lib/components/ApiLogo/api-logo.spec.ts | 22 ++---- .../JsonSchema/json-schema-lazy.spec.ts | 34 ++++----- lib/components/JsonSchema/json-schema.spec.ts | 27 +++---- lib/components/Method/method.spec.ts | 22 ++---- .../MethodsList/methods-list.spec.ts | 20 ++--- lib/components/Redoc/redoc.spec.ts | 76 +++++++------------ lib/components/SideMenu/side-menu.spec.ts | 22 ++---- lib/components/base.ts | 4 +- lib/services/menu.service.spec.ts | 42 +++------- lib/services/options.service.spec.ts | 4 - .../schema-normalizer.service.spec.ts | 5 -- .../StickySidebar/sticky-sidebar.spec.ts | 24 ++---- .../StickySidebar/sticky-sidebar.ts | 2 +- lib/shared/components/Tabs/tabs.spec.ts | 21 ++--- lib/shared/components/Zippy/zippy.spec.ts | 20 ++--- package.json | 30 +++----- system.config.js | 54 +++++-------- tests/setup.ts | 9 ++- 20 files changed, 151 insertions(+), 317 deletions(-) diff --git a/karma.conf.js b/karma.conf.js index 9966e216..e7c94a7a 100644 --- a/karma.conf.js +++ b/karma.conf.js @@ -39,7 +39,6 @@ module.exports = function (config) { //load angular dependencies and browser polyfills files: [ 'node_modules/zone.js/dist/zone.js', - 'node_modules/zone.js/dist/fake-async-test.js', 'node_modules/zone.js/dist/async-test.js', 'node_modules/zone.js/dist/jasmine-patch.js', 'node_modules/zone.js/dist/long-stack-trace-zone.js', diff --git a/lib/components/ApiInfo/api-info.spec.ts b/lib/components/ApiInfo/api-info.spec.ts index 5d0f26b4..d85efd66 100644 --- a/lib/components/ApiInfo/api-info.spec.ts +++ b/lib/components/ApiInfo/api-info.spec.ts @@ -1,47 +1,32 @@ 'use strict'; import { getChildDebugElement } from '../../../tests/helpers'; -import { Component, provide } from '@angular/core'; +import { Component } from '@angular/core'; import { inject, async, - expect, - beforeEach, - beforeEachProviders, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; - import { ApiInfo } from './api-info'; import { SpecManager } from '../../utils/SpecManager'; -import { OptionsService } from '../../services/index'; describe('Redoc components', () => { describe('ApiInfo Component', () => { let builder; let component; let fixture; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: new SpecManager()}), - provide(OptionsService, {useClass: OptionsService}) - ]); beforeEach(async(inject([TestComponentBuilder, SpecManager], (tcb, specMgr) => { builder = tcb; return specMgr.load('/tests/schemas/api-info-test.json'); }))); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(_fixture => { - fixture = _fixture; - component = getChildDebugElement(fixture.debugElement, 'api-info').componentInstance; - fixture.detectChanges(); - done(); - }, err => { - done.fail(err); - }); + beforeEach(() => { + fixture = builder.createSync(TestAppComponent); + component = getChildDebugElement(fixture.debugElement, 'api-info').componentInstance; + fixture.detectChanges(); }); @@ -54,7 +39,7 @@ describe('Redoc components', () => { it('should render api name and version', () => { let nativeElement = getChildDebugElement(fixture.debugElement, 'api-info').nativeElement; let headerElement = nativeElement.querySelector('h1'); - expect(headerElement).toHaveText('Swagger Petstore (1.0.0)'); + expect(headerElement.innerText).toContain('Swagger Petstore (1.0.0)'); }); }); }); diff --git a/lib/components/ApiLogo/api-logo.spec.ts b/lib/components/ApiLogo/api-logo.spec.ts index e9a6fbf3..79484ff0 100644 --- a/lib/components/ApiLogo/api-logo.spec.ts +++ b/lib/components/ApiLogo/api-logo.spec.ts @@ -1,18 +1,14 @@ 'use strict'; import { getChildDebugElement } from '../../../tests/helpers'; -import {Component, provide} from '@angular/core'; +import { Component } from '@angular/core'; import { inject, async, - beforeEach, - beforeEachProviders, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; - import { ApiLogo } from './api-logo'; import { SpecManager } from '../../utils/SpecManager'; @@ -25,21 +21,15 @@ describe('Redoc components', () => { let specMgr; let schemaUrl = '/tests/schemas/api-info-test.json'; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: new SpecManager()}) - ]); beforeEach(async(inject([TestComponentBuilder, SpecManager], (tcb, _specMgr) => { builder = tcb; specMgr = _specMgr; return specMgr.load(schemaUrl); }))); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(_fixture => { - fixture = _fixture; - component = getChildDebugElement(fixture.debugElement, 'api-logo').componentInstance; - fixture.detectChanges(); - done(); - }, err => done.fail(err)); + beforeEach(() => { + fixture = builder.createSync(TestAppComponent); + component = getChildDebugElement(fixture.debugElement, 'api-logo').componentInstance; + fixture.detectChanges(); }); diff --git a/lib/components/JsonSchema/json-schema-lazy.spec.ts b/lib/components/JsonSchema/json-schema-lazy.spec.ts index d1026189..d5977d50 100644 --- a/lib/components/JsonSchema/json-schema-lazy.spec.ts +++ b/lib/components/JsonSchema/json-schema-lazy.spec.ts @@ -1,41 +1,33 @@ 'use strict'; import { getChildDebugElement } from '../../../tests/helpers'; -import { Component, provide } from '@angular/core'; +import { Component } from '@angular/core'; import { inject, - beforeEach, - beforeEachProviders, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; - - import { JsonSchemaLazy } from './json-schema-lazy'; -import { SpecManager } from '../../utils/SpecManager'; describe('Redoc components', () => { describe('JsonSchemaLazy Component', () => { let builder; let component; - let specMgr = new SpecManager(); let fixture; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: specMgr}) - ]); - beforeEach(inject([TestComponentBuilder], (tcb, dcl) => { + + beforeEach(inject([TestComponentBuilder], (tcb) => { builder = tcb; })); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(_fixture => { - fixture = _fixture; - let debugEl = getChildDebugElement(fixture.debugElement, 'json-schema-lazy'); - component = debugEl.componentInstance; - spyOn(component, '_loadAfterSelf').and.callThrough(); - done(); - }, err => done.fail(err)); + beforeEach(() => { + fixture = builder.createSync(TestAppComponent); + let debugEl = getChildDebugElement(fixture.debugElement, 'json-schema-lazy'); + component = debugEl.componentInstance; + spyOn(component, '_loadAfterSelf').and.stub(); + }); + + afterEach(() => { + component._loadAfterSelf.and.callThrough(); }); it('should init component', () => { diff --git a/lib/components/JsonSchema/json-schema.spec.ts b/lib/components/JsonSchema/json-schema.spec.ts index 166658b9..962116f2 100644 --- a/lib/components/JsonSchema/json-schema.spec.ts +++ b/lib/components/JsonSchema/json-schema.spec.ts @@ -1,13 +1,10 @@ 'use strict'; -import { Component, provide } from '@angular/core'; +import { Component } from '@angular/core'; import { inject, - beforeEach, - beforeEachProviders, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; import { getChildDebugElement } from '../../../tests/helpers'; @@ -19,21 +16,17 @@ describe('Redoc components', () => { describe('JsonSchema Component', () => { let builder; let component; - let specMgr = new SpecManager(); let fixture; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: specMgr}) - ]); - beforeEach(inject([TestComponentBuilder], (tcb) => { + let specMgr; + + beforeEach(inject([TestComponentBuilder, SpecManager], (tcb, _spec) => { builder = tcb; + specMgr = _spec; })); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(_fixture => { - fixture = _fixture; - let debugEl = getChildDebugElement(fixture.debugElement, 'json-schema'); - component = debugEl.componentInstance; - done(); - }, err => done.fail(err)); + beforeEach(() => { + fixture = builder.createSync(TestAppComponent); + let debugEl = getChildDebugElement(fixture.debugElement, 'json-schema'); + component = debugEl.componentInstance; }); it('should init component', () => { diff --git a/lib/components/Method/method.spec.ts b/lib/components/Method/method.spec.ts index 699ed0da..21cdc51a 100644 --- a/lib/components/Method/method.spec.ts +++ b/lib/components/Method/method.spec.ts @@ -1,14 +1,11 @@ 'use strict'; -import { Component, provide } from '@angular/core'; +import { Component } from '@angular/core'; import { inject, async, - beforeEach, - beforeEachProviders, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; import { getChildDebugElement } from '../../../tests/helpers'; @@ -19,19 +16,16 @@ describe('Redoc components', () => { describe('Method Component', () => { let builder; let component; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: new SpecManager()}) - ]); + beforeEach(async(inject([TestComponentBuilder, SpecManager], (tcb, specMgr) => { builder = tcb; return specMgr.load('/tests/schemas/extended-petstore.yml'); }))); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(fixture => { - component = getChildDebugElement(fixture.debugElement, 'method').componentInstance; - fixture.detectChanges(); - done(); - }, err => done.fail(err)); + + beforeEach(() => { + let fixture = builder.createSync(TestAppComponent); + component = getChildDebugElement(fixture.debugElement, 'method').componentInstance; + fixture.detectChanges(); }); diff --git a/lib/components/MethodsList/methods-list.spec.ts b/lib/components/MethodsList/methods-list.spec.ts index 9918761a..75394166 100644 --- a/lib/components/MethodsList/methods-list.spec.ts +++ b/lib/components/MethodsList/methods-list.spec.ts @@ -4,11 +4,8 @@ import { Component, provide } from '@angular/core'; import { inject, async, - beforeEach, - beforeEachProviders, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; import { getChildDebugElement } from '../../../tests/helpers'; @@ -21,20 +18,15 @@ describe('Redoc components', () => { let builder; let component; let fixture; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: new SpecManager()}) - ]); + beforeEach(async(inject([TestComponentBuilder, SpecManager], (tcb, specMgr) => { builder = tcb; return specMgr.load('/tests/schemas/methods-list-component.json'); }))); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(_fixture => { - fixture = _fixture; - component = getChildDebugElement(fixture.debugElement, 'methods-list').componentInstance; - fixture.detectChanges(); - done(); - }, err => done.fail(err) ); + beforeEach(() => { + fixture = builder.createSync(TestAppComponent); + component = getChildDebugElement(fixture.debugElement, 'methods-list').componentInstance; + fixture.detectChanges(); }); diff --git a/lib/components/Redoc/redoc.spec.ts b/lib/components/Redoc/redoc.spec.ts index 4ae11b74..073810e8 100644 --- a/lib/components/Redoc/redoc.spec.ts +++ b/lib/components/Redoc/redoc.spec.ts @@ -1,15 +1,12 @@ 'use strict'; import { getChildDebugElement } from '../../../tests/helpers'; -import { Component, provide, ComponentRef } from '@angular/core'; +import { Component, ComponentRef } from '@angular/core'; import { BrowserDomAdapter } from '@angular/platform-browser/src/browser/browser_adapter'; import { inject, - async, - beforeEach, - beforeEachProviders, - it + async } from '@angular/core/testing'; import { TestComponentBuilder } from '@angular/compiler/testing'; @@ -24,40 +21,27 @@ describe('Redoc components', () => { describe('Redoc Component', () => { let builder; let specMgr; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: new SpecManager()}), - ]); + beforeEach(async(inject([TestComponentBuilder, SpecManager, OptionsService], (tcb, _specMgr, _optsMgr) => { optsMgr = _optsMgr; builder = tcb; specMgr = _specMgr; + return specMgr.load('/tests/schemas/extended-petstore.yml'); }))); - beforeEach((done) => { - return specMgr.load('/tests/schemas/extended-petstore.yml') - .then(() => done()) - .catch(err => done.fail(err)); + + it('should init component', () => { + let fixture = builder.createSync(TestAppComponent); + let component = getChildDebugElement(fixture.debugElement, 'redoc').componentInstance; + expect(component).not.toBeNull(); + fixture.destroy(); }); - - it('should init component', (done) => { - builder.createAsync(TestAppComponent).then(fixture => { - let component = getChildDebugElement(fixture.debugElement, 'redoc').componentInstance; - expect(component).not.toBeNull(); - fixture.destroy(); - done(); - }, err => done.fail(err)); - }); - - it('should init components tree without errors', (done) => { - builder.createAsync(TestAppComponent).then(fixture => { - (() => fixture.detectChanges()).should.not.throw(); - fixture.destroy(); - done(); - }, err => { - return done.fail(err); - }); + it('should init components tree without errors', () => { + let fixture = builder.createSync(TestAppComponent); + (() => fixture.detectChanges()).should.not.throw(); + fixture.destroy(); }); }); @@ -103,29 +87,25 @@ describe('Redoc components', () => { let builder; let fixture; let element; + let dom; let destroySpy; - let dom = new BrowserDomAdapter(); - beforeEachProviders(() => [ - provide(SpecManager, {useValue: new SpecManager()}), - provide(BrowserDomAdapter, {useValue: new BrowserDomAdapter()}), - provide(OptionsService, {useValue: optsMgr}) - ]); - beforeEach(async(inject([TestComponentBuilder, SpecManager], (tcb, specMgr) => { + + beforeEach(async(inject([TestComponentBuilder, SpecManager, OptionsService, BrowserDomAdapter], + (tcb, specMgr, opts, _dom) => { builder = tcb; + optsMgr = opts; + dom = _dom; return specMgr.load('/tests/schemas/methods-list-component.json'); }))); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(_fixture => { - fixture = _fixture; - element = getChildDebugElement(fixture.debugElement, 'methods-list').nativeElement; - destroySpy = jasmine.createSpy('spy'); - Redoc.appRef = >{ - destroy: destroySpy - }; - fixture.detectChanges(); - done(); - }, err => { throw err; }); + beforeEach(() => { + fixture = builder.createSync(TestAppComponent); + element = getChildDebugElement(fixture.debugElement, 'methods-list').nativeElement; + destroySpy = jasmine.createSpy('spy'); + Redoc.appRef = >{ + destroy: destroySpy + }; + fixture.detectChanges(); }); afterEach(()=> { diff --git a/lib/components/SideMenu/side-menu.spec.ts b/lib/components/SideMenu/side-menu.spec.ts index c2f0d999..fce798f3 100644 --- a/lib/components/SideMenu/side-menu.spec.ts +++ b/lib/components/SideMenu/side-menu.spec.ts @@ -6,10 +6,7 @@ import { OptionsService } from '../../services/index'; import { inject, - async, - beforeEach, - beforeEachProviders, - it + async } from '@angular/core/testing'; import { TestComponentBuilder } from '@angular/compiler/testing'; @@ -25,9 +22,7 @@ describe('Redoc components', () => { let builder; let component; let fixture; - beforeEachProviders(() => [ - provide(SpecManager, {useValue: new SpecManager()}) - ]); + beforeEach(async(inject([TestComponentBuilder, SpecManager, OptionsService], (tcb, specMgr, opts) => { builder = tcb; @@ -39,15 +34,10 @@ describe('Redoc components', () => { return specMgr.load('/tests/schemas/extended-petstore.yml'); }))); - beforeEach((done) => { - builder.createAsync(TestAppComponent).then(_fixture => { - fixture = _fixture; - component = getChildDebugElement(fixture.debugElement, 'side-menu').componentInstance; - fixture.detectChanges(); - done(); - }, err => { - throw err; - }); + beforeEach(() => { + fixture = builder.createSync(TestAppComponent); + component = getChildDebugElement(fixture.debugElement, 'side-menu').componentInstance; + fixture.detectChanges(); }); afterEach(() => { diff --git a/lib/components/base.ts b/lib/components/base.ts index eadcca3a..8e847fd9 100644 --- a/lib/components/base.ts +++ b/lib/components/base.ts @@ -60,9 +60,7 @@ export function RedocComponent(options) { inputs: inputs, outputs: options.outputs, providers: options.providers, - changeDetection: options.detect ? - (options.onPushOnly ? ChangeDetectionStrategy.OnPush : ChangeDetectionStrategy.Default) : - ChangeDetectionStrategy.Detached, + changeDetection: options.onPushOnly ? ChangeDetectionStrategy.OnPush : ChangeDetectionStrategy.Default, animations: options.animations, templateUrl: options.templateUrl, template: options.template, diff --git a/lib/services/menu.service.spec.ts b/lib/services/menu.service.spec.ts index b273fad1..df8697de 100644 --- a/lib/services/menu.service.spec.ts +++ b/lib/services/menu.service.spec.ts @@ -1,17 +1,11 @@ 'use strict'; -import { provide, Component } from '@angular/core'; -import { BrowserDomAdapter } from '@angular/platform-browser/src/browser/browser_adapter'; +import { Component } from '@angular/core'; import { inject, - beforeEach, - describe, - beforeEachProviders, - it, - async + async, + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; - import { MenuService } from './menu.service'; import { Hash } from './hash.service'; import { ScrollService } from './scroll.service'; @@ -21,37 +15,21 @@ import { SpecManager } from '../utils/SpecManager';; describe('Menu service', () => { let menu, hashService, scroll; let builder; - let specMgr = new SpecManager(); + let specMgr; - beforeEachProviders(() => [ - provide(BrowserDomAdapter, {useClass: BrowserDomAdapter}), - provide(Hash, {useClass: Hash}), - provide(ScrollService, {useClass: ScrollService}), - provide(SpecManager, {useValue: new SpecManager()}) - ]); - - beforeEach(async(inject([Hash, ScrollService, TestComponentBuilder, SpecManager], - (_hash, _scroll, tcb, _specMgr) => { + beforeEach(async(inject([TestComponentBuilder, SpecManager, Hash, ScrollService], + (tcb, _specMgr, _hash, _scroll, _menu) => { hashService = _hash; scroll = _scroll; builder = tcb; specMgr = _specMgr; + return specMgr.load('/tests/schemas/extended-petstore.yml'); }))); - beforeEach(done => { - specMgr.load('/tests/schemas/extended-petstore.yml').then(r => { - done(); - }).catch(e => { - done.fail(e); - }); - }); - - beforeEach(done => { + beforeEach(() => { menu = new MenuService(hashService, scroll, specMgr); - builder.createAsync(TestAppComponent).then(fixture => { - fixture.detectChanges(); - done(); - }).catch(err => done.fail(err) ); + let fixture = builder.createSync(TestAppComponent); + fixture.detectChanges(); }); it('should run hashScroll when hash changed', (done) => { diff --git a/lib/services/options.service.spec.ts b/lib/services/options.service.spec.ts index da53645a..d5354aee 100644 --- a/lib/services/options.service.spec.ts +++ b/lib/services/options.service.spec.ts @@ -1,10 +1,6 @@ 'use strict'; import { BrowserDomAdapter } from '@angular/platform-browser/src/browser/browser_adapter'; -import { - it -} from '@angular/core/testing'; - import { OptionsService } from './options.service'; describe('Options Service', () => { diff --git a/lib/services/schema-normalizer.service.spec.ts b/lib/services/schema-normalizer.service.spec.ts index 7ca23d47..64d11026 100644 --- a/lib/services/schema-normalizer.service.spec.ts +++ b/lib/services/schema-normalizer.service.spec.ts @@ -1,10 +1,5 @@ 'use strict'; import { SchemaNormalizer } from './schema-normalizer.service'; -import { - describe, - it -} from '@angular/core/testing'; - import { SpecManager } from '../utils/SpecManager';; describe('Spec Helper', () => { diff --git a/lib/shared/components/StickySidebar/sticky-sidebar.spec.ts b/lib/shared/components/StickySidebar/sticky-sidebar.spec.ts index a35fdea5..d84d4231 100644 --- a/lib/shared/components/StickySidebar/sticky-sidebar.spec.ts +++ b/lib/shared/components/StickySidebar/sticky-sidebar.spec.ts @@ -1,18 +1,12 @@ 'use strict'; import { getChildDebugElementByType } from '../../../../tests/helpers'; -import { Component, provide } from '@angular/core'; -import { BrowserDomAdapter } from '@angular/platform-browser/src/browser/browser_adapter'; - +import { Component } from '@angular/core'; import { inject, - beforeEach, - beforeEachProviders, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; - import { StickySidebar } from '../index'; describe('Common components', () => { @@ -21,20 +15,12 @@ describe('Common components', () => { let component; let fixture; - beforeEachProviders(() => [ - provide(BrowserDomAdapter, {useValue: new BrowserDomAdapter()}) - ]); beforeEach(inject([TestComponentBuilder], (tcb) => { builder = tcb; + fixture = builder.createSync(TestApp); + let debugEl = getChildDebugElementByType(fixture.debugElement, StickySidebar); + component = debugEl.injector.get(StickySidebar); })); - beforeEach((done) => { - builder.createAsync(TestApp).then(_fixture => { - fixture = _fixture; - let debugEl = getChildDebugElementByType(fixture.debugElement, StickySidebar); - component = debugEl.injector.get(StickySidebar); - done(); - }, err => done.fail(err)); - }); it('should init component', () => { diff --git a/lib/shared/components/StickySidebar/sticky-sidebar.ts b/lib/shared/components/StickySidebar/sticky-sidebar.ts index 7f9c7a9c..e3d2af06 100644 --- a/lib/shared/components/StickySidebar/sticky-sidebar.ts +++ b/lib/shared/components/StickySidebar/sticky-sidebar.ts @@ -1,7 +1,7 @@ 'use strict'; import { Directive, ElementRef, Input, OnInit, OnDestroy } from '@angular/core'; -import {BrowserDomAdapter} from '@angular/platform-browser/src/browser/browser_adapter'; +import { BrowserDomAdapter } from '@angular/platform-browser/src/browser/browser_adapter'; @Directive({ selector: '[sticky-sidebar]' diff --git a/lib/shared/components/Tabs/tabs.spec.ts b/lib/shared/components/Tabs/tabs.spec.ts index 05a1f196..c48e0f61 100644 --- a/lib/shared/components/Tabs/tabs.spec.ts +++ b/lib/shared/components/Tabs/tabs.spec.ts @@ -5,12 +5,9 @@ import { Component } from '@angular/core'; import { inject, - beforeEach, - it + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; - import {Tabs, Tab} from '../index'; describe('Common components', () => { @@ -24,18 +21,12 @@ describe('Common components', () => { beforeEach(inject([TestComponentBuilder], (tcb) => { builder = tcb; + fixture = builder.createSync(TestApp); + hostComponent = fixture.debugElement.componentInstance; + debugEl = getChildDebugElement(fixture.debugElement, 'tabs'); + childDebugEls = getChildDebugElementAll(debugEl, 'tab'); + component = debugEl.componentInstance; })); - beforeEach((done) => { - builder.createAsync(TestApp).then(_fixture => { - fixture = _fixture; - hostComponent = fixture.debugElement.componentInstance; - debugEl = getChildDebugElement(fixture.debugElement, 'tabs'); - childDebugEls = getChildDebugElementAll(debugEl, 'tab'); - component = debugEl.componentInstance; - done(); - }, err => done.fail(err)); - }); - it('should init component', () => { expect(component).not.toBeNull(); diff --git a/lib/shared/components/Zippy/zippy.spec.ts b/lib/shared/components/Zippy/zippy.spec.ts index 7be746b1..01310c2f 100644 --- a/lib/shared/components/Zippy/zippy.spec.ts +++ b/lib/shared/components/Zippy/zippy.spec.ts @@ -5,12 +5,10 @@ import { getChildDebugElement, mouseclick } from '../../../../tests/helpers'; import { Component } from '@angular/core'; import { inject, - beforeEach, - it, - expect + expect, + TestComponentBuilder } from '@angular/core/testing'; -import { TestComponentBuilder } from '@angular/compiler/testing'; import { Zippy } from '../index'; describe('Common components', () => { @@ -22,17 +20,11 @@ describe('Common components', () => { beforeEach(inject([TestComponentBuilder], (tcb) => { builder = tcb; + fixture = builder.createSync(TestApp); + let debugEl = getChildDebugElement(fixture.debugElement, 'zippy'); + component = debugEl.componentInstance; + nativeElement = debugEl.nativeElement; })); - beforeEach((done) => { - builder.createAsync(TestApp).then(_fixture => { - fixture = _fixture; - let debugEl = getChildDebugElement(fixture.debugElement, 'zippy'); - component = debugEl.componentInstance; - nativeElement = debugEl.nativeElement; - done(); - }, err => done.fail(err)); - }); - it('should init component', () => { expect(component).not.toBeNull(); diff --git a/package.json b/package.json index bc0195e8..22a19ed8 100644 --- a/package.json +++ b/package.json @@ -32,17 +32,11 @@ "jspm": { "configFile": "system.config.js", "dependencies": { - "@angular/common": "npm:@angular/common@^2.0.0-rc.2", - "@angular/common@2.0.0-rc.3": "npm:@angular/common@2.0.0-rc.3", - "@angular/compiler": "npm:@angular/compiler@^2.0.0-rc.2", - "@angular/compiler@2.0.0-rc.3": "npm:@angular/compiler@2.0.0-rc.3", - "@angular/core": "npm:@angular/core@^2.0.0-rc.2", - "@angular/core@2.0.0-rc.3": "npm:@angular/core@2.0.0-rc.3", - "@angular/platform-browser": "npm:@angular/platform-browser@^2.0.0-rc.2", - "@angular/platform-browser-dynamic": "npm:@angular/platform-browser-dynamic@^2.0.0-rc.2", - "@angular/platform-browser-dynamic@2.0.0-rc.3": "npm:@angular/platform-browser-dynamic@2.0.0-rc.3", - "@angular/platform-browser@2.0.0-rc.3": "npm:@angular/platform-browser@2.0.0-rc.3", - "@angular/platform-server@2.0.0-rc.3": "npm:@angular/platform-server@2.0.0-rc.3", + "@angular/common@2.0.0-rc.4": "npm:@angular/common@2.0.0-rc.4", + "@angular/compiler@2.0.0-rc.4": "npm:@angular/compiler@2.0.0-rc.4", + "@angular/core@2.0.0-rc.4": "npm:@angular/core@2.0.0-rc.4", + "@angular/platform-browser-dynamic@2.0.0-rc.4": "npm:@angular/platform-browser-dynamic@2.0.0-rc.4", + "@angular/platform-browser@2.0.0-rc.4": "npm:@angular/platform-browser@2.0.0-rc.4", "dropkickjs": "npm:dropkickjs@^2.1.8", "es6-shim": "github:es-shims/es6-shim@^0.33.6", "hint.css": "npm:hint.css@^2.2.1", @@ -82,12 +76,12 @@ } }, "devDependencies": { - "@angular/common": "^2.0.0-rc.3", - "@angular/compiler": "^2.0.0-rc.3", - "@angular/core": "^2.0.0-rc.2", - "@angular/platform-browser": "^2.0.0-rc.3", - "@angular/platform-browser-dynamic": "^2.0.0-rc.3", - "@angular/platform-server": "^2.0.0-rc.3", + "@angular/common": "^2.0.0-rc.4", + "@angular/compiler": "^2.0.0-rc.4", + "@angular/core": "^2.0.0-rc.4", + "@angular/platform-browser": "^2.0.0-rc.4", + "@angular/platform-browser-dynamic": "^2.0.0-rc.4", + "@angular/platform-server": "^2.0.0-rc.4", "babel-polyfill": "^6.3.14", "branch-release": "^1.0.3", "browser-sync": "^2.10.1", @@ -139,7 +133,7 @@ "should": "^9.0.2", "sinon": "^1.17.2", "systemjs-builder": "^0.15.16", - "tslint": "^3.11.0", + "tslint": "^3.13.0", "tslint-stylish": "^2.1.0-beta", "typescript": "^1.8.10", "vinyl-paths": "^2.0.0", diff --git a/system.config.js b/system.config.js index 671df661..c91cace9 100644 --- a/system.config.js +++ b/system.config.js @@ -16,17 +16,11 @@ System.config({ }, map: { - "@angular/common": "npm:@angular/common@2.0.0-rc.3", - "@angular/common@2.0.0-rc.3": "npm:@angular/common@2.0.0-rc.3", - "@angular/compiler": "npm:@angular/compiler@2.0.0-rc.3", - "@angular/compiler@2.0.0-rc.3": "npm:@angular/compiler@2.0.0-rc.3", - "@angular/core": "npm:@angular/core@2.0.0-rc.3", - "@angular/core@2.0.0-rc.3": "npm:@angular/core@2.0.0-rc.3", - "@angular/platform-browser": "npm:@angular/platform-browser@2.0.0-rc.3", - "@angular/platform-browser-dynamic": "npm:@angular/platform-browser-dynamic@2.0.0-rc.3", - "@angular/platform-browser-dynamic@2.0.0-rc.3": "npm:@angular/platform-browser-dynamic@2.0.0-rc.3", - "@angular/platform-browser@2.0.0-rc.3": "npm:@angular/platform-browser@2.0.0-rc.3", - "@angular/platform-server@2.0.0-rc.3": "npm:@angular/platform-server@2.0.0-rc.3", + "@angular/common": "npm:@angular/common@2.0.0-rc.4", + "@angular/compiler": "npm:@angular/compiler@2.0.0-rc.4", + "@angular/core": "npm:@angular/core@2.0.0-rc.4", + "@angular/platform-browser-dynamic": "npm:@angular/platform-browser-dynamic@2.0.0-rc.4", + "@angular/platform-browser": "npm:@angular/platform-browser@2.0.0-rc.4", "babel": "npm:babel-core@5.8.34", "babel-runtime": "npm:babel-runtime@5.8.34", "clean-css": "npm:clean-css@3.4.17", @@ -122,39 +116,32 @@ System.config({ "github:jspm/nodelibs-zlib@0.1.0": { "browserify-zlib": "npm:browserify-zlib@0.1.4" }, - "npm:@angular/common@2.0.0-rc.3": { - "@angular/core": "npm:@angular/core@2.0.0-rc.3", + "npm:@angular/common@2.0.0-rc.4": { + "@angular/core": "npm:@angular/core@2.0.0-rc.4", "process": "github:jspm/nodelibs-process@0.1.2" }, - "npm:@angular/compiler@2.0.0-rc.3": { - "@angular/core": "npm:@angular/core@2.0.0-rc.3", + "npm:@angular/compiler@2.0.0-rc.4": { + "@angular/core": "npm:@angular/core@2.0.0-rc.4", "process": "github:jspm/nodelibs-process@0.1.2" }, - "npm:@angular/core@2.0.0-rc.3": { + "npm:@angular/core@2.0.0-rc.4": { "process": "github:jspm/nodelibs-process@0.1.2", "rxjs": "npm:rxjs@5.0.0-beta.6", "zone.js": "npm:zone.js@0.6.12" }, - "npm:@angular/platform-browser-dynamic@2.0.0-rc.3": { - "@angular/common": "npm:@angular/common@2.0.0-rc.3", - "@angular/compiler": "npm:@angular/compiler@2.0.0-rc.3", - "@angular/core": "npm:@angular/core@2.0.0-rc.3", - "@angular/platform-browser": "npm:@angular/platform-browser@2.0.0-rc.3", + "npm:@angular/platform-browser-dynamic@2.0.0-rc.4": { + "@angular/common": "npm:@angular/common@2.0.0-rc.4", + "@angular/compiler": "npm:@angular/compiler@2.0.0-rc.4", + "@angular/core": "npm:@angular/core@2.0.0-rc.4", + "@angular/platform-browser": "npm:@angular/platform-browser@2.0.0-rc.4", "process": "github:jspm/nodelibs-process@0.1.2" }, - "npm:@angular/platform-browser@2.0.0-rc.3": { - "@angular/common": "npm:@angular/common@2.0.0-rc.3", - "@angular/compiler": "npm:@angular/compiler@2.0.0-rc.3", - "@angular/core": "npm:@angular/core@2.0.0-rc.3", + "npm:@angular/platform-browser@2.0.0-rc.4": { + "@angular/common": "npm:@angular/common@2.0.0-rc.4", + "@angular/compiler": "npm:@angular/compiler@2.0.0-rc.4", + "@angular/core": "npm:@angular/core@2.0.0-rc.4", "process": "github:jspm/nodelibs-process@0.1.2" }, - "npm:@angular/platform-server@2.0.0-rc.3": { - "@angular/common": "npm:@angular/common@2.0.0-rc.3", - "@angular/compiler": "npm:@angular/compiler@2.0.0-rc.3", - "@angular/core": "npm:@angular/core@2.0.0-rc.3", - "@angular/platform-browser": "npm:@angular/platform-browser@2.0.0-rc.3", - "parse5": "npm:parse5@1.3.2" - }, "npm:amdefine@1.0.0": { "fs": "github:jspm/nodelibs-fs@0.1.2", "module": "github:jspm/nodelibs-module@0.1.0", @@ -686,9 +673,6 @@ System.config({ "pbkdf2": "npm:pbkdf2@3.0.4", "systemjs-json": "github:systemjs/plugin-json@0.1.2" }, - "npm:parse5@1.3.2": { - "process": "github:jspm/nodelibs-process@0.1.2" - }, "npm:path-browserify@0.0.0": { "process": "github:jspm/nodelibs-process@0.1.2" }, diff --git a/tests/setup.ts b/tests/setup.ts index ec80345a..82a0493e 100644 --- a/tests/setup.ts +++ b/tests/setup.ts @@ -2,7 +2,8 @@ import {setBaseTestProviders} from '@angular/core/testing'; import { BrowserDomAdapter } from '@angular/platform-browser/src/browser/browser_adapter'; -import { OptionsService, RedocEventsService} from '../lib/services/index'; +import { OptionsService, RedocEventsService, Hash, ScrollService, MenuService } from '../lib/services/index'; +import { SpecManager } from '../lib/utils/SpecManager'; import { provide } from '@angular/core'; import { @@ -15,6 +16,10 @@ setBaseTestProviders( TEST_BROWSER_DYNAMIC_PLATFORM_PROVIDERS, provide(BrowserDomAdapter, {useClass: BrowserDomAdapter}), provide(OptionsService, {useClass: OptionsService}), - provide(RedocEventsService, {useClass: RedocEventsService}) + provide(RedocEventsService, {useClass: RedocEventsService}), + provide(SpecManager, {useClass: SpecManager}), + provide(Hash, {useClass: Hash}), + provide(ScrollService, {useClass: ScrollService}), + provide(MenuService, {useClass: MenuService}) ], [TEST_BROWSER_DYNAMIC_APPLICATION_PROVIDERS]); From 81d06316ed2801de07ce68eed3f5b2cd35403302 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 16:30:35 +0300 Subject: [PATCH 02/10] Add trackBy to tags --- lib/components/MethodsList/methods-list.html | 2 +- lib/components/MethodsList/methods-list.spec.ts | 2 +- lib/components/MethodsList/methods-list.ts | 4 ++++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/components/MethodsList/methods-list.html b/lib/components/MethodsList/methods-list.html index 6d867af0..c9c873cf 100644 --- a/lib/components/MethodsList/methods-list.html +++ b/lib/components/MethodsList/methods-list.html @@ -1,5 +1,5 @@
-
+

{{tag.name}}

diff --git a/lib/components/MethodsList/methods-list.spec.ts b/lib/components/MethodsList/methods-list.spec.ts index 75394166..b8e6be02 100644 --- a/lib/components/MethodsList/methods-list.spec.ts +++ b/lib/components/MethodsList/methods-list.spec.ts @@ -1,6 +1,6 @@ 'use strict'; -import { Component, provide } from '@angular/core'; +import { Component } from '@angular/core'; import { inject, async, diff --git a/lib/components/MethodsList/methods-list.ts b/lib/components/MethodsList/methods-list.ts index a919cdfe..0e9e11d4 100644 --- a/lib/components/MethodsList/methods-list.ts +++ b/lib/components/MethodsList/methods-list.ts @@ -46,4 +46,8 @@ export class MethodsList extends BaseComponent { trackByPointer(idx, el) { return el.pointer; } + + trackByTagName(idx, el) { + return el.name; + } } From 4a475677f79b5a00996bdd882ef97223aac1d864 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 16:30:45 +0300 Subject: [PATCH 03/10] Clean up tests --- lib/components/Redoc/redoc.spec.ts | 4 ++-- lib/components/Redoc/redoc.ts | 5 ++--- lib/components/SideMenu/side-menu.spec.ts | 2 +- lib/services/schema-normalizer.service.spec.ts | 9 +++++++++ tests/schemas/base-component-dereference.json | 2 -- 5 files changed, 14 insertions(+), 8 deletions(-) diff --git a/lib/components/Redoc/redoc.spec.ts b/lib/components/Redoc/redoc.spec.ts index 073810e8..9fc6ae14 100644 --- a/lib/components/Redoc/redoc.spec.ts +++ b/lib/components/Redoc/redoc.spec.ts @@ -58,7 +58,7 @@ describe('Redoc components', () => { }); it('should return promise', () => { - let res = Redoc.init(); + let res = Redoc.init().catch(() => {/**/}); res.should.be.instanceof(Promise); }); @@ -66,7 +66,7 @@ describe('Redoc components', () => { spyOn(Redoc, 'hideLoadingAnimation').and.callThrough(); spyOn(Redoc, 'displayError').and.callThrough(); let res = Redoc.init(); - return res.then(() => { + return res.catch(() => { expect(Redoc.hideLoadingAnimation).toHaveBeenCalled(); expect(Redoc.displayError).toHaveBeenCalled(); }); diff --git a/lib/components/Redoc/redoc.ts b/lib/components/Redoc/redoc.ts index e523a4d3..6a6de353 100644 --- a/lib/components/Redoc/redoc.ts +++ b/lib/components/Redoc/redoc.ts @@ -79,10 +79,10 @@ export class Redoc extends BaseComponent implements AfterViewInit { Redoc.hideLoadingAnimation(); Redoc.appRef = appRef; console.log('ReDoc bootstrapped!'); - }, err => { - console.log(err); + }).catch(err => { Redoc.hideLoadingAnimation(); Redoc.displayError(err); + throw err; }); } @@ -97,7 +97,6 @@ export class Redoc extends BaseComponent implements AfterViewInit { } static displayError(err) { - console.log(err); let redocEl = dom.query('redoc'); if (!redocEl) return; let heading = 'Oops... ReDoc failed to render this spec'; diff --git a/lib/components/SideMenu/side-menu.spec.ts b/lib/components/SideMenu/side-menu.spec.ts index fce798f3..f4d139d6 100644 --- a/lib/components/SideMenu/side-menu.spec.ts +++ b/lib/components/SideMenu/side-menu.spec.ts @@ -1,7 +1,7 @@ 'use strict'; import { getChildDebugElement } from '../../../tests/helpers'; -import { Component, provide } from '@angular/core'; +import { Component } from '@angular/core'; import { OptionsService } from '../../services/index'; import { diff --git a/lib/services/schema-normalizer.service.spec.ts b/lib/services/schema-normalizer.service.spec.ts index 64d11026..cab630df 100644 --- a/lib/services/schema-normalizer.service.spec.ts +++ b/lib/services/schema-normalizer.service.spec.ts @@ -111,9 +111,18 @@ describe('Spec Helper', () => { let resolved; beforeAll(() => { let pointer = '/paths/test5/get/parameters/0'; + spyOn(console, 'warn').and.stub(); resolved = normalizer.normalize(specMgr.byPointer(pointer), pointer); }); + afterAll(() => { + (console.warn).and.callThrough(); + }); + + it('should print warning to console', () => { + expect(console.warn).toHaveBeenCalled(); + }); + it('should skip other fields', () => { expect(resolved.$ref).toBeUndefined(); expect(resolved.title).toBeDefined(); diff --git a/tests/schemas/base-component-dereference.json b/tests/schemas/base-component-dereference.json index df5dcebc..21e9bf41 100644 --- a/tests/schemas/base-component-dereference.json +++ b/tests/schemas/base-component-dereference.json @@ -110,8 +110,6 @@ "parameters": [ { "$ref": "#/definitions/CircularTransitive", - "title": "test", - "description": "test" } ] } From b22b8d2122dd42bcf81f8363f961aa185686c735 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 17:24:59 +0300 Subject: [PATCH 04/10] Refactor menu generation + handle methods without tags --- lib/components/Method/method.html | 2 +- lib/components/Method/method.ts | 2 + lib/components/MethodsList/methods-list.html | 2 +- lib/components/MethodsList/methods-list.ts | 22 +++----- lib/components/SideMenu/side-menu.html | 3 +- lib/components/SideMenu/side-menu.scss | 4 ++ lib/services/menu.service.ts | 5 +- lib/services/schema-helper.service.ts | 54 ++++++++++++++++++++ lib/utils/SpecManager.ts | 47 ----------------- 9 files changed, 74 insertions(+), 67 deletions(-) diff --git a/lib/components/Method/method.html b/lib/components/Method/method.html index adbf9284..333ceaa3 100644 --- a/lib/components/Method/method.html +++ b/lib/components/Method/method.html @@ -1,7 +1,7 @@

- {{data.methodInfo.summary}} + {{data.summary}}

{{tag}} diff --git a/lib/components/Method/method.ts b/lib/components/Method/method.ts index 23d54b14..781b2afe 100644 --- a/lib/components/Method/method.ts +++ b/lib/components/Method/method.ts @@ -8,6 +8,7 @@ import { ResponsesList } from '../ResponsesList/responses-list'; import { ResponsesSamples } from '../ResponsesSamples/responses-samples'; import { SchemaSample } from '../SchemaSample/schema-sample'; import { RequestSamples } from '../RequestSamples/request-samples'; +import { SchemaHelper } from '../../services/schema-helper.service'; @RedocComponent({ selector: 'method', @@ -31,6 +32,7 @@ export class Method extends BaseComponent { this.data.methodInfo = this.componentSchema; this.data.methodInfo.tags = this.filterMainTags(this.data.methodInfo.tags); this.data.bodyParam = this.findBodyParam(); + this.data.summary = SchemaHelper.methodSummary(this.componentSchema); if (this.componentSchema.operationId) { this.data.methodAnchor = 'operation/' + encodeURIComponent(this.componentSchema.operationId); } else { diff --git a/lib/components/MethodsList/methods-list.html b/lib/components/MethodsList/methods-list.html index c9c873cf..6f42f8b6 100644 --- a/lib/components/MethodsList/methods-list.html +++ b/lib/components/MethodsList/methods-list.html @@ -1,6 +1,6 @@
-
+

{{tag.name}}

diff --git a/lib/components/MethodsList/methods-list.ts b/lib/components/MethodsList/methods-list.ts index 0e9e11d4..0add692f 100644 --- a/lib/components/MethodsList/methods-list.ts +++ b/lib/components/MethodsList/methods-list.ts @@ -4,6 +4,7 @@ import { forwardRef } from '@angular/core'; import { RedocComponent, BaseComponent, SpecManager } from '../base'; import { Method } from '../Method/method'; import { EncodeURIComponentPipe } from '../../utils/pipes'; +import { SchemaHelper } from '../../services/index'; @RedocComponent({ selector: 'methods-list', @@ -24,21 +25,14 @@ export class MethodsList extends BaseComponent { // follow SwaggerUI behavior for cases when one method has more than one tag: // duplicate methods - let menuStructure = this.specMgr.buildMenuTree(); - let tags = Array.from(menuStructure.entries()) - .map((entry) => { - let [tag, {description, methods}] = entry; - // inject tag name into method info - methods = methods || []; - methods.forEach(method => { - method.tag = tag; - }); - return { - name: tag, - description: description, - methods: methods - }; + let tags = SchemaHelper.buildMenuTree(this.specMgr.schema); + tags.forEach(tagInfo => { + // inject tag name into method info + tagInfo.methods = tagInfo.methods || []; + tagInfo.methods.forEach(method => { + method.tag = name; }); + }); this.data.tags = tags; // TODO: check $ref field } diff --git a/lib/components/SideMenu/side-menu.html b/lib/components/SideMenu/side-menu.html index c0929bf8..8b7ee961 100644 --- a/lib/components/SideMenu/side-menu.html +++ b/lib/components/SideMenu/side-menu.html @@ -9,7 +9,8 @@
API reference
- +
  • ({name: el[0], description: el[1].description, methods: el[1].methods}) - ); + this.categories = SchemaHelper.buildMenuTree(specMgr.schema); scrollService.scroll.subscribe((evt) => { this.scrollUpdate(evt.isScrolledDown); diff --git a/lib/services/schema-helper.service.ts b/lib/services/schema-helper.service.ts index 24cb3afd..2fef12fe 100644 --- a/lib/services/schema-helper.service.ts +++ b/lib/services/schema-helper.service.ts @@ -1,6 +1,7 @@ 'use strict'; import { JsonPointer } from '../utils/JsonPointer'; import { SpecManager } from '../utils/SpecManager'; +import {methods as swaggerMethods} from '../utils/swagger-defs'; interface PropertyPreprocessOptions { childFor: string; @@ -218,4 +219,57 @@ export class SchemaHelper { } return res; } + + static methodSummary(method) { + return method.summary || method.operationId || method.description.substring(0, 50); + } + + static buildMenuTree(schema) { + let tag2MethodMapping = {}; + + let definedTags = schema.tags || []; + // add tags into map to preserve order + for (let tag of definedTags) { + tag2MethodMapping[tag.name] = { + 'description': tag.description, + 'x-traitTag': tag['x-traitTag'], + 'methods': [] + }; + } + + let paths = schema.paths; + for (let path of Object.keys(paths)) { + let methods = Object.keys(paths[path]).filter((k) => swaggerMethods.has(k)); + for (let method of methods) { + let methodInfo = paths[path][method]; + let tags = methodInfo.tags; + + //TODO: mb need to do something cleverer + if (!tags || !tags.length) { + tags = ['']; + } + let methodPointer = JsonPointer.compile(['paths', path, method]); + let methodSummary = SchemaHelper.methodSummary(methodInfo); + for (let tag of tags) { + let tagDetails = tag2MethodMapping[tag]; + if (!tagDetails) { + tagDetails = { + name: tag, + empty: !tag + }; + tag2MethodMapping[tag] = tagDetails; + } + if (tagDetails['x-traitTag']) continue; + if (!tagDetails.methods) tagDetails.methods = []; + tagDetails.methods.push({ + pointer: methodPointer, + summary: methodSummary, + operationId: methodInfo.operationId, + tag: tag + }); + } + } + } + return Object.keys(tag2MethodMapping).map(tag => tag2MethodMapping[tag]); + } } diff --git a/lib/utils/SpecManager.ts b/lib/utils/SpecManager.ts index ba9ceb25..1f7e0017 100644 --- a/lib/utils/SpecManager.ts +++ b/lib/utils/SpecManager.ts @@ -2,7 +2,6 @@ import JsonSchemaRefParser from 'json-schema-ref-parser'; import JsonPointer from './JsonPointer'; -import {methods as swaggerMethods} from './swagger-defs'; export class SpecManager { public _schema:any = {}; @@ -114,52 +113,6 @@ export class SpecManager { return tagsMap; } - /* returns ES6 Map */ - buildMenuTree():Map { - let tag2MethodMapping = new Map(); - - let definedTags = this._schema.tags || []; - // add tags into map to preserve order - for (let tag of definedTags) { - tag2MethodMapping.set(tag.name, { - 'description': tag.description, - 'x-traitTag': tag['x-traitTag'], - 'methods': [] - }); - } - - let paths = this._schema.paths; - for (let path of Object.keys(paths)) { - let methods = Object.keys(paths[path]).filter((k) => swaggerMethods.has(k)); - for (let method of methods) { - let methodInfo = paths[path][method]; - let tags = methodInfo.tags; - - //TODO: mb need to do something cleverer - if (!tags || !tags.length) { - tags = ['[Other]']; - } - let methodPointer = JsonPointer.compile(['paths', path, method]); - let methodSummary = methodInfo.summary || methodInfo.operationId; - for (let tag of tags) { - let tagDetails = tag2MethodMapping.get(tag); - if (!tagDetails) { - tagDetails = {}; - tag2MethodMapping.set(tag, tagDetails); - } - if (tagDetails['x-traitTag']) continue; - if (!tagDetails.methods) tagDetails.methods = []; - tagDetails.methods.push({ - pointer: methodPointer, - summary: methodSummary, - operationId: methodInfo.operationId - }); - } - } - } - return tag2MethodMapping; - } - findDerivedDefinitions(defPointer) { let definition = this.byPointer(defPointer); if (!definition) throw new Error(`Can't load schema at ${defPointer}`); From 2d54a67c2cacd96c66fe423a114f7c74834b2b58 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 17:25:42 +0300 Subject: [PATCH 05/10] Make baseUrl darker --- lib/components/Method/method.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/components/Method/method.scss b/lib/components/Method/method.scss index 1ddca717..75163437 100644 --- a/lib/components/Method/method.scss +++ b/lib/components/Method/method.scss @@ -38,7 +38,7 @@ responses-list, params-list { } .api-url { - color: rgba(#ffffff, .8); + color: rgba(#ffffff, .6); margin-left: 10px; margin-top: 2px; position: relative; From 6a8f1e6e211dd3c8111674d3f18f1d170f134b00 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 18:09:42 +0300 Subject: [PATCH 06/10] prepend v to api version --- lib/components/ApiInfo/api-info.spec.ts | 2 +- lib/components/ApiInfo/api-info.ts | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/components/ApiInfo/api-info.spec.ts b/lib/components/ApiInfo/api-info.spec.ts index d85efd66..acaebf1c 100644 --- a/lib/components/ApiInfo/api-info.spec.ts +++ b/lib/components/ApiInfo/api-info.spec.ts @@ -39,7 +39,7 @@ describe('Redoc components', () => { it('should render api name and version', () => { let nativeElement = getChildDebugElement(fixture.debugElement, 'api-info').nativeElement; let headerElement = nativeElement.querySelector('h1'); - expect(headerElement.innerText).toContain('Swagger Petstore (1.0.0)'); + expect(headerElement.innerText).toContain('Swagger Petstore (v1.0.0)'); }); }); }); diff --git a/lib/components/ApiInfo/api-info.ts b/lib/components/ApiInfo/api-info.ts index 2a8c20bf..db5db8a0 100644 --- a/lib/components/ApiInfo/api-info.ts +++ b/lib/components/ApiInfo/api-info.ts @@ -18,5 +18,8 @@ export class ApiInfo extends BaseComponent { prepareModel() { this.data = this.componentSchema.info; this.specUrl = this.optionsService.options.specUrl; + if (parseInt(this.data.version.substring(0, 1)) !== NaN) { + this.data.version = 'v' + this.data.version; + } } } From f0fe212c24592abc44b137ee4ce6fafe6226914b Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 18:10:01 +0300 Subject: [PATCH 07/10] Update file produces/consumes look --- .../JsonSchema/json-schema-common.scss | 5 +++ lib/components/JsonSchema/json-schema.html | 10 ++++-- lib/components/JsonSchema/json-schema.scss | 33 +++++-------------- 3 files changed, 21 insertions(+), 27 deletions(-) diff --git a/lib/components/JsonSchema/json-schema-common.scss b/lib/components/JsonSchema/json-schema-common.scss index e2458f58..cef10416 100644 --- a/lib/components/JsonSchema/json-schema-common.scss +++ b/lib/components/JsonSchema/json-schema-common.scss @@ -87,6 +87,11 @@ $sub-schema-offset: ($bullet-size/2) + $bullet-margin; display: inline-block; } +.param-type-file { + font-weight: bold; + text-transform: capitalize; +} + /* tree */ // Bullet diff --git a/lib/components/JsonSchema/json-schema.html b/lib/components/JsonSchema/json-schema.html index 1d075bca..53ffa1f9 100644 --- a/lib/components/JsonSchema/json-schema.html +++ b/lib/components/JsonSchema/json-schema.html @@ -1,10 +1,14 @@ - file + file
    - Produces: {{ schema._produces | json }} +
      +
    • {{type}}
      • +
    - Consumes: {{ schema._consumes | json }} +
      +
    • {{type}}
      • +
    diff --git a/lib/components/JsonSchema/json-schema.scss b/lib/components/JsonSchema/json-schema.scss index 0828feeb..d0eaae55 100644 --- a/lib/components/JsonSchema/json-schema.scss +++ b/lib/components/JsonSchema/json-schema.scss @@ -180,31 +180,16 @@ $array-marker-line-height: 1.5; } } -ul { - text-align: left; +ul, li { margin: 0; - padding: 0; - display: block; } -li { - margin: 0.5em 0.3em 0.2em 0; - font-family: $headers-font, $headers-font-family; - font-size: .929em; - line-height: .929em; - border: 0; - color: white; - padding: 2px 8px 4px 8px; - border-radius: $border-radius; - background-color: rgba($black, 0.3); - display: inline-block; - cursor: pointer; - - &:last-of-type { - margin-right: 0; - } - - &.active { - background-color: $primary-color; - } +ul { + list-style: none; + padding-left: 1em; +} + +li:before { + content: "- "; + font-weight: bold; } From 060119673f5fe09eeb3a0edd8d128d92a27b3b5c Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 18:10:13 +0300 Subject: [PATCH 08/10] Fix menutree building --- lib/services/schema-helper.service.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/services/schema-helper.service.ts b/lib/services/schema-helper.service.ts index 2fef12fe..c0445652 100644 --- a/lib/services/schema-helper.service.ts +++ b/lib/services/schema-helper.service.ts @@ -232,6 +232,7 @@ export class SchemaHelper { for (let tag of definedTags) { tag2MethodMapping[tag.name] = { 'description': tag.description, + 'name': tag.name, 'x-traitTag': tag['x-traitTag'], 'methods': [] }; @@ -244,7 +245,6 @@ export class SchemaHelper { let methodInfo = paths[path][method]; let tags = methodInfo.tags; - //TODO: mb need to do something cleverer if (!tags || !tags.length) { tags = ['']; } @@ -252,10 +252,10 @@ export class SchemaHelper { let methodSummary = SchemaHelper.methodSummary(methodInfo); for (let tag of tags) { let tagDetails = tag2MethodMapping[tag]; - if (!tagDetails) { + if (!tag2MethodMapping[tag]) { tagDetails = { name: tag, - empty: !tag + empty: tag === '' }; tag2MethodMapping[tag] = tagDetails; } From ac6c203f24edf833e202847264762f12ba98b37b Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 18:33:42 +0300 Subject: [PATCH 09/10] fix tests --- lib/components/MethodsList/methods-list.ts | 2 +- lib/components/Redoc/redoc.spec.ts | 2 +- lib/services/schema-helper.serivce.spec.ts | 84 ++++++++++++++++++++++ tests/unit/SpecManager.spec.ts | 79 -------------------- 4 files changed, 86 insertions(+), 81 deletions(-) create mode 100644 lib/services/schema-helper.serivce.spec.ts diff --git a/lib/components/MethodsList/methods-list.ts b/lib/components/MethodsList/methods-list.ts index 0add692f..d3dd6527 100644 --- a/lib/components/MethodsList/methods-list.ts +++ b/lib/components/MethodsList/methods-list.ts @@ -30,7 +30,7 @@ export class MethodsList extends BaseComponent { // inject tag name into method info tagInfo.methods = tagInfo.methods || []; tagInfo.methods.forEach(method => { - method.tag = name; + method.tag = tagInfo.name; }); }); this.data.tags = tags; diff --git a/lib/components/Redoc/redoc.spec.ts b/lib/components/Redoc/redoc.spec.ts index 9fc6ae14..0d278a70 100644 --- a/lib/components/Redoc/redoc.spec.ts +++ b/lib/components/Redoc/redoc.spec.ts @@ -95,7 +95,7 @@ describe('Redoc components', () => { builder = tcb; optsMgr = opts; dom = _dom; - return specMgr.load('/tests/schemas/methods-list-component.json'); + return specMgr.load('/tests/schemas/extended-petstore.yml'); }))); beforeEach(() => { diff --git a/lib/services/schema-helper.serivce.spec.ts b/lib/services/schema-helper.serivce.spec.ts new file mode 100644 index 00000000..2b1052c3 --- /dev/null +++ b/lib/services/schema-helper.serivce.spec.ts @@ -0,0 +1,84 @@ +'use strict'; +import { SchemaHelper } from './schema-helper.service'; +import { SpecManager } from '../utils/SpecManager'; + +describe('Spec Helper', () => { + describe('buildMenuTree method', () => { + let suitSchema = { + tags: [ + {name: 'tag1', description: 'info1', 'x-traitTag': true}, + {name: 'tag2', description: 'info2'} + ], + paths: { + test: { + put: { + tags: ['tag1', 'tag3'], + summary: 'test put' + }, + get: { + tags: ['tag1', 'tag2'], + summary: 'test get' + }, + // no tags + post: { + summary: 'test post' + } + } + } + }; + + let menuTree; + let specMgr; + + beforeAll(() => { + specMgr = new SpecManager(); + specMgr._schema = suitSchema; + menuTree = SchemaHelper.buildMenuTree(suitSchema); + }); + + it('should return instance of Array', () => { + menuTree.should.be.instanceof(Array); + }); + + it('should return Array with correct number of items', () => { + //2 - defined tags, 1 - tag3 and 1 [other] tag for no-tags method + menuTree.length.should.be.equal(2 + 1 + 1); + }); + + it('should append not defined tags to the end of list', () => { + let info = menuTree[2]; + info.name.should.be.equal('tag3'); + info.methods.length.should.be.equal(1); + info.methods[0].summary.should.be.equal('test put'); + }); + + it('should append methods without tags to [other] tag', () => { + let info = menuTree[3]; + info.name.should.be.equal(''); + info.methods.length.should.be.equal(1); + info.methods[0].summary.should.be.equal('test post'); + }); + + it('should map x-traitTag to empty methods list', () => { + let info = menuTree[0]; + info['x-traitTag'].should.be.true(); + info.methods.should.be.empty(); + }); + + it('methods for tag should contain valid pointer and summary', () => { + for (let entr of menuTree) { + let info = entr; + info.should.be.an.Object(); + info.methods.should.be.an.Array(); + for (let methodInfo of info.methods) { + methodInfo.should.have.properties(['pointer', 'summary']); + let methSchema = specMgr.byPointer(methodInfo.pointer); + expect(methSchema).not.toBeNull(); + if (methSchema.summary) { + methSchema.summary.should.be.equal(methodInfo.summary); + } + } + } + }); + }); +}); diff --git a/tests/unit/SpecManager.spec.ts b/tests/unit/SpecManager.spec.ts index 510c4032..b1a37a2d 100644 --- a/tests/unit/SpecManager.spec.ts +++ b/tests/unit/SpecManager.spec.ts @@ -93,85 +93,6 @@ describe('Utils', () => { }); }); - describe('buildMenuTree method', () => { - let suitSchema = { - tags: [ - {name: 'tag1', description: 'info1', 'x-traitTag': true}, - {name: 'tag2', description: 'info2'} - ], - paths: { - test: { - put: { - tags: ['tag1', 'tag3'], - summary: 'test put' - }, - get: { - tags: ['tag1', 'tag2'], - summary: 'test get' - }, - // no tags - post: { - summary: 'test post' - } - } - } - }; - - let menuTree; - let entries; - - beforeAll(() => { - specMgr._schema = suitSchema; - menuTree = specMgr.buildMenuTree(); - entries = Array.from(menuTree.entries()); - }); - - it('should return instance of Map', () => { - menuTree.should.be.instanceof(Map); - }); - - it('should return Map with correct number of entries', () => { - //2 - defined tags, 1 - tag3 and 1 [other] tag for no-tags method - entries.length.should.be.equal(2 + 1 + 1); - }); - - it('should append not defined tags to the end of list', () => { - let [tag, info] = entries[2]; - tag.should.be.equal('tag3'); - info.methods.length.should.be.equal(1); - info.methods[0].summary.should.be.equal('test put'); - }); - - it('should append methods without tags to [other] tag', () => { - let [tag, info] = entries[3]; - tag.should.be.equal('[Other]'); - info.methods.length.should.be.equal(1); - info.methods[0].summary.should.be.equal('test post'); - }); - - it('should map x-traitTag to empty methods list', () => { - let [, info] = entries[0]; - info['x-traitTag'].should.be.true(); - info.methods.should.be.empty(); - }); - - it('methods for tag should contain valid pointer and summary', () => { - for (let entr of entries) { - let [, info] = entr; - info.should.be.an.Object(); - info.methods.should.be.an.Array(); - for (let methodInfo of info.methods) { - methodInfo.should.have.properties(['pointer', 'summary']); - let methSchema = specMgr.byPointer(methodInfo.pointer); - expect(methSchema).not.toBeNull(); - if (methSchema.summary) { - methSchema.summary.should.be.equal(methodInfo.summary); - } - } - } - }); - }); - describe('getMethodParams method', () => { beforeAll((done) => { specMgr.load('/tests/schemas/schema-mgr-methodparams.json').then(() => { From a2beb2432dc62f48b23a6f1c7487d0b3a31b3b19 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Fri, 1 Jul 2016 18:33:54 +0300 Subject: [PATCH 10/10] v0.15.2 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 22a19ed8..08929a05 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "redoc", "description": "Swagger-generated API Reference Documentation", - "version": "0.15.1", + "version": "0.15.2", "repository": { "type": "git", "url": "git://github.com/Rebilly/ReDoc"