feat: add CalendarModule.forRoot so providers dont need to be specified

Author: Matt Lewis

demo/demo.module.ts

@@ -1,16 +1,15 @@
 import { NgModule } from '@angular/core';
 import { BrowserModule } from '@angular/platform-browser';
 // import should be from `angular2-calendar` in your app
-import { CalendarModule, CalendarEventTitle, CalendarDateFormatter } from './../src';
+import { CalendarModule } from './../src';
 import { DemoComponent } from './demo.component';
 
 @NgModule({
   declarations: [DemoComponent],
-  imports: [BrowserModule, CalendarModule],
-  bootstrap: [DemoComponent],
-  providers: [
-    CalendarEventTitle,
-    CalendarDateFormatter
-  ]
+  imports: [
+    BrowserModule,
+    CalendarModule.forRoot()
+  ],
+  bootstrap: [DemoComponent]
 })
 export class DemoModule {}

src/calendar.module.ts

@@ -1,4 +1,4 @@
-import { NgModule } from '@angular/core';
+import { NgModule, ModuleWithProviders } from '@angular/core';
 import { CommonModule } from '@angular/common';
 import { CalendarDayViewComponent } from './components/day/calendarDayView.component';
 import { CalendarWeekViewComponent } from './components/week/calendarWeekView.component';
@@ -15,6 +15,8 @@ import { CalendarDayViewEventComponent } from './components/day/calendarDayViewE
 import { CalendarTooltipWindowComponent, CalendarTooltipDirective } from './directives/calendarTooltip.directive';
 import { CalendarDate } from './pipes/calendarDate.pipe';
 import { CalendarEventTitle as CalendarEventTitlePipe } from './pipes/calendarEventTitle.pipe';
+import { CalendarEventTitle as CalendarEventTitleProvider } from './providers/calendarEventTitle.provider';
+import { CalendarDateFormatter } from './providers/calendarDateFormatter.provider';
 
 @NgModule({
   declarations: [
@@ -39,4 +41,16 @@ import { CalendarEventTitle as CalendarEventTitlePipe } from './pipes/calendarEv
   exports: [CalendarDayViewComponent, CalendarWeekViewComponent, CalendarMonthViewComponent, CalendarDate],
   entryComponents: [CalendarTooltipWindowComponent]
 })
-export class CalendarModule {}
+export class CalendarModule {
+
+  static forRoot(): ModuleWithProviders {
+    return {
+      ngModule: CalendarModule,
+      providers: [
+        CalendarEventTitleProvider,
+        CalendarDateFormatter
+      ]
+    };
+  }
+
+}

test/calendarModule.spec.ts

@@ -0,0 +1,22 @@
+import {
+  inject,
+  TestBed
+} from '@angular/core/testing';
+import { expect } from 'chai';
+import {
+  CalendarModule,
+  CalendarDateFormatter
+} from './../src';
+
+describe('calendar module', () => {
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({imports: [CalendarModule.forRoot()]});
+  });
+
+  it('should not require providers to be specified when using CalendarModule.forRoot()',
+    inject([CalendarDateFormatter], (dateFormatter) => {
+    expect(dateFormatter instanceof CalendarDateFormatter).to.be.true;
+  }));
+
+});