Rename PendingInterceptorService to PendingRequestsInterceptor && _isSpinnerVisible$ to _isVisible$

Author: mpalourdio

CHANGELOG.md

@@ -1,9 +1,11 @@
 # Changelog
 
 ## v5.0.0
-Prior to this release, `NgHttpLoaderComponent#isSpinnerVisible` was a boolean. Because of unexpected behaviors when a component with `ChangeDetectionStrategy.OnPush` performed HTTP requests, it is now an `Observable<boolean>`.  
+- Prior to this release, `NgHttpLoaderComponent#isSpinnerVisible` was a boolean. Because of unexpected behaviors when a component with `ChangeDetectionStrategy.OnPush` performed HTTP requests, it is now an `Observable<boolean>` and has been renamed to `NgHttpLoaderComponent#isVisible$`.  
 The associated template now uses an `async pipe` in order to perform the show/hide logic.
 
+- `PendingInterceptorService` has been renamed to `PendingRequestsInterceptor`.
+
 ## v4.0.0
 - `HttpClientModule` has been removed from imports.  
 This caused some issues when external modules were imported in an application, and those modules registered their own HTTP interceptors. See [this issue](https://github.com/angular/angular/issues/20575) for reference.

src/lib/components/ng-http-loader.component.html

@@ -1,4 +1,4 @@
-<div id="spinner" *ngIf="isSpinnerVisible$ | async">
+<div id="spinner" *ngIf="isVisible$ | async">
 
     <ng-container *ngComponentOutlet="entryComponent"></ng-container>
 

src/lib/components/ng-http-loader.component.ts

@@ -10,7 +10,7 @@
 import { Component, Input, OnDestroy, OnInit } from '@angular/core';
 import { BehaviorSubject, merge, Observable, Subscription, timer } from 'rxjs';
 import { debounce, distinctUntilChanged, partition, switchMap, tap } from 'rxjs/operators';
-import { PendingInterceptorService } from '../services/pending-interceptor.service';
+import { PendingRequestsInterceptor } from '../services/pending-requests-interceptor.service';
 import { SpinnerVisibilityService } from '../services/spinner-visibility.service';
 import { Spinkit } from '../spinkits';
 
@@ -21,7 +21,7 @@ import { Spinkit } from '../spinkits';
 })
 export class NgHttpLoaderComponent implements OnDestroy, OnInit {
     public spinkit = Spinkit;
-    private _isSpinnerVisible$ = new BehaviorSubject<boolean>(false);
+    private _isVisible$ = new BehaviorSubject<boolean>(false);
     private subscriptions: Subscription;
     private visibleUntil = Date.now();
 
@@ -44,23 +44,23 @@ export class NgHttpLoaderComponent implements OnDestroy, OnInit {
     @Input()
     public entryComponent: any = null;
 
-    constructor(private pendingInterceptorService: PendingInterceptorService, private spinnerVisibilityService: SpinnerVisibilityService) {
-        const [showSpinner$, hideSpinner$] = partition((h: boolean) => h)(this.pendingInterceptorService.pendingRequestsStatus$);
+    constructor(private pendingRequestsInterceptor: PendingRequestsInterceptor, private spinnerVisibility: SpinnerVisibilityService) {
+        const [showSpinner$, hideSpinner$] = partition((h: boolean) => h)(this.pendingRequestsInterceptor.pendingRequestsStatus$);
 
         this.subscriptions = merge(
-            this.pendingInterceptorService.pendingRequestsStatus$.pipe(
+            this.pendingRequestsInterceptor.pendingRequestsStatus$.pipe(
                 switchMap(() => showSpinner$.pipe(debounce(() => timer(this.debounceDelay))))
             ),
             showSpinner$.pipe(
                 switchMap(() => hideSpinner$.pipe(debounce(() => this.getVisibilityTimer$())))
             ),
-            this.spinnerVisibilityService.visibility$,
+            this.spinnerVisibility.visibility$,
         )
             .pipe(
                 distinctUntilChanged(),
-                tap(h => this.updateVisibilityExpiration(h))
+                tap(h => this.updateExpirationDelay(h))
             )
-            .subscribe(h => this._isSpinnerVisible$.next(h));
+            .subscribe(h => this._isVisible$.next(h));
     }
 
     ngOnInit(): void {
@@ -72,8 +72,8 @@ export class NgHttpLoaderComponent implements OnDestroy, OnInit {
         this.subscriptions.unsubscribe();
     }
 
-    get isSpinnerVisible$(): Observable<boolean> {
-        return this._isSpinnerVisible$.asObservable();
+    get isVisible$(): Observable<boolean> {
+        return this._isVisible$.asObservable();
     }
 
     private nullifySpinnerIfEntryComponentIsDefined(): void {
@@ -95,7 +95,7 @@ export class NgHttpLoaderComponent implements OnDestroy, OnInit {
 
         if (!!this.filteredUrlPatterns.length) {
             this.filteredUrlPatterns.forEach(e =>
-                this.pendingInterceptorService.filteredUrlPatterns.push(new RegExp(e))
+                this.pendingRequestsInterceptor.filteredUrlPatterns.push(new RegExp(e))
             );
         }
     }
@@ -104,17 +104,17 @@ export class NgHttpLoaderComponent implements OnDestroy, OnInit {
         if (!(this.filteredMethods instanceof Array)) {
             throw new TypeError('`filteredMethods` must be an array.');
         }
-        this.pendingInterceptorService.filteredMethods = this.filteredMethods;
+        this.pendingRequestsInterceptor.filteredMethods = this.filteredMethods;
     }
 
     private initFilteredHeaders(): void {
         if (!(this.filteredHeaders instanceof Array)) {
             throw new TypeError('`filteredHeaders` must be an array.');
         }
-        this.pendingInterceptorService.filteredHeaders = this.filteredHeaders;
+        this.pendingRequestsInterceptor.filteredHeaders = this.filteredHeaders;
     }
 
-    private updateVisibilityExpiration(showSpinner: boolean): void {
+    private updateExpirationDelay(showSpinner: boolean): void {
         if (showSpinner) {
             this.visibleUntil = Date.now() + this.minDuration;
         }

src/lib/ng-http-loader.module.ts

@@ -10,7 +10,7 @@
 import { CommonModule } from '@angular/common';
 import { ModuleWithProviders, NgModule } from '@angular/core';
 import { NgHttpLoaderComponent } from './components/ng-http-loader.component';
-import { PendingInterceptorServiceProvider } from './services/pending-interceptor.service';
+import { PendingRequestsInterceptorProvider } from './services/pending-requests-interceptor.service';
 import { SPINKIT_COMPONENTS } from './spinkits';
 
 @NgModule({
@@ -31,7 +31,7 @@ export class NgHttpLoaderModule {
         return {
             ngModule: NgHttpLoaderModule,
             providers: [
-                PendingInterceptorServiceProvider,
+                PendingRequestsInterceptorProvider,
             ],
         };
     }

…/services/pending-interceptor.service.ts …/pending-requests-interceptor.service.tssrc/lib/services/pending-interceptor.service.ts renamed to src/lib/services/pending-requests-interceptor.service.ts src/lib/services/pending-interceptor.service.ts renamed to src/lib/services/pending-requests-interceptor.service.ts

@@ -22,7 +22,7 @@ import { catchError, finalize, map } from 'rxjs/operators';
 @Injectable({
     providedIn: 'root'
 })
-export class PendingInterceptorService implements HttpInterceptor {
+export class PendingRequestsInterceptor implements HttpInterceptor {
     private _pendingRequests = 0;
     private _pendingRequestsStatus$ = new ReplaySubject<boolean>(1);
     private _filteredUrlPatterns: RegExp[] = [];
@@ -110,8 +110,8 @@ export class PendingInterceptorService implements HttpInterceptor {
     }
 }
 
-export const PendingInterceptorServiceProvider: ExistingProvider[] = [{
+export const PendingRequestsInterceptorProvider: ExistingProvider[] = [{
     provide: HTTP_INTERCEPTORS,
-    useExisting: PendingInterceptorService,
+    useExisting: PendingRequestsInterceptor,
     multi: true
 }];

src/lib/services/spinner-visibility.service.ts

@@ -9,28 +9,28 @@
 
 import { Injectable } from '@angular/core';
 import { Observable, ReplaySubject } from 'rxjs';
-import { PendingInterceptorService } from './pending-interceptor.service';
+import { PendingRequestsInterceptor } from './pending-requests-interceptor.service';
 
 @Injectable({
     providedIn: 'root'
 })
 export class SpinnerVisibilityService {
     private _visibility$ = new ReplaySubject<boolean>(1);
 
-    constructor(private pendingInterceptorService: PendingInterceptorService) {
+    constructor(private pendingRequestsInterceptor: PendingRequestsInterceptor) {
     }
 
     get visibility$(): Observable<boolean> {
         return this._visibility$.asObservable();
     }
 
     public show(): void {
-        this.pendingInterceptorService.forceByPass = true;
+        this.pendingRequestsInterceptor.forceByPass = true;
         this._visibility$.next(true);
     }
 
     public hide(): void {
         this._visibility$.next(false);
-        this.pendingInterceptorService.forceByPass = false;
+        this.pendingRequestsInterceptor.forceByPass = false;
     }
 }

src/public_api.ts

@@ -13,7 +13,7 @@ export * from './lib/components/sk-wave/sk-wave.component';
 export * from './lib/components/ng-http-loader.component';
 export * from './lib/components/abstract.loader.component';
 
-export * from './lib/services/pending-interceptor.service';
+export * from './lib/services/pending-requests-interceptor.service';
 export * from './lib/services/spinner-visibility.service';
 
 export * from './lib/ng-http-loader.module';

src/test/components/ng-http-loader.component.outlet.spec.ts

@@ -14,7 +14,7 @@ import { BrowserDynamicTestingModule } from '@angular/platform-browser-dynamic/t
 import { BehaviorSubject } from 'rxjs';
 import { NgHttpLoaderComponent } from '../../lib/components/ng-http-loader.component';
 import { SkThreeBounceComponent } from '../../lib/components/sk-three-bounce/sk-three-bounce.component';
-import { PendingInterceptorServiceProvider } from '../../lib/services/pending-interceptor.service';
+import { PendingRequestsInterceptorProvider } from '../../lib/services/pending-requests-interceptor.service';
 import { SPINKIT_COMPONENTS } from '../../lib/spinkits';
 
 describe('NgHttpLoaderComponentOutlet', () => {
@@ -25,7 +25,7 @@ describe('NgHttpLoaderComponentOutlet', () => {
         TestBed.configureTestingModule({
             declarations: [NgHttpLoaderComponent, ...SPINKIT_COMPONENTS],
             imports: [HttpClientTestingModule],
-            providers: [PendingInterceptorServiceProvider]
+            providers: [PendingRequestsInterceptorProvider]
         })
             .overrideModule(BrowserDynamicTestingModule, {
                 set: { entryComponents: [SkThreeBounceComponent] }
@@ -39,7 +39,7 @@ describe('NgHttpLoaderComponentOutlet', () => {
     });
 
     it('should be possible to specify an entryComponent', () => {
-        spyOnProperty(component, 'isSpinnerVisible$')
+        spyOnProperty(component, 'isVisible$')
             .and.returnValue(new BehaviorSubject(true).asObservable());
 
         component.entryComponent = SkThreeBounceComponent;
@@ -54,7 +54,7 @@ describe('NgHttpLoaderComponentOutlet', () => {
     });
 
     it('should force [spinner] to null if [entryComponent] is defined', () => {
-        spyOnProperty(component, 'isSpinnerVisible$')
+        spyOnProperty(component, 'isVisible$')
             .and.returnValue(new BehaviorSubject(true).asObservable());
 
         component.spinner = 'whatever';