From 842f3cdaa75ee5f452a53d831e1af6a4a5cd558c Mon Sep 17 00:00:00 2001 From: Jeff Cross Date: Thu, 28 Jan 2016 22:18:28 -0800 Subject: [PATCH] fix(providers): remove DEFAULT_ DEFAULT_FIREBASE_REF and DEFAULT_FIREBASE BREAKING CHANGE: The tokens to inject the root firebase url and reference have changed from DEFAULT_FIREBASE -> FirebaseUrl DEFAULT_FIREBASE_REF -> FirebaseRef Closes #25 --- README.md | 16 ++++++++-------- src/angularfire.spec.ts | 10 +++++----- src/angularfire.ts | 8 ++++---- src/providers/firebase_list.spec.ts | 6 +++--- src/providers/firebase_list.ts | 4 ++-- test/e2e/firebase_list/firebase_list_example.ts | 4 ++-- 6 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index e9b1291ae..a0e74efad 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ import {FIREBASE_PROVIDERS} from 'angularfire2'; bootstrap(App, FIREBASE_PROVIDERS); ``` -### DEFAULT_FIREBASE_REF +### FirebaseRef Injectable symbol to create a Firebase reference based on -the url provided by `DEFAULT_FIREBASE`. +the url provided by `FirebaseUrl`. Type: `Firebase` @@ -33,16 +33,16 @@ Usage: ``` import {Inject} from 'angular2/core'; -import {DEFAULT_FIREBASE_REF} from 'angularfire2'; +import {FirebaseRef} from 'angularfire2'; ... class MyComponent { - constructor(@Inject(DEFAULT_FIREBASE_REF) ref:Firebase) { + constructor(@Inject(FirebaseRef) ref:Firebase) { ref.on('value', this.doSomething); } } ``` -### DEFAULT_FIREBASE +### FirebaseUrl URL for the app's default Firebase database. @@ -53,11 +53,11 @@ Usage: ``` import {App} from './app'; import {bootstrap, provide} from 'angular2/core'; -import {DEFAULT_FIREBASE, FIREBASE_PROVIDERS} from 'angularfire2'; +import {FirebaseUrl, FIREBASE_PROVIDERS} from 'angularfire2'; bootstrap(App, [ FIREBASE_PROVIDERS, - provide(DEFAULT_FIREBASE, { + provide(FirebaseUrl, { useValue: 'https://my.firebaseio.com' }) ]); @@ -81,7 +81,7 @@ import {FirebaseList} from 'angularfire2'; providers: [ FirebaseList({ token: Question, // Token used to inject in the constructor - path: '/questions', // Will append to the DEFAULT_FIREBASE if relative + path: '/questions', // Will append to the FirebaseUrl if relative }), // Passing just a string will make that the path AND the token used with @Inject FirebaseList('/topics') diff --git a/src/angularfire.spec.ts b/src/angularfire.spec.ts index 5617c47d6..df6c28efa 100644 --- a/src/angularfire.spec.ts +++ b/src/angularfire.spec.ts @@ -1,17 +1,17 @@ import {describe,it,beforeEach} from 'angular2/testing'; import {Injector, provide} from 'angular2/core'; -import {FIREBASE_PROVIDERS, DEFAULT_FIREBASE, DEFAULT_FIREBASE_REF} from './angularfire'; +import {FIREBASE_PROVIDERS, FirebaseUrl, FirebaseRef} from './angularfire'; describe('angularfire', () => { - describe('DEFAULT_FIREBASE_REF', () => { - it('should provide a FirebaseRef for the DEFAULT_FIREBASE_REF binding', () => { + describe('FIREBASE_REF', () => { + it('should provide a FirebaseRef for the FIREBASE_REF binding', () => { var injector = Injector.resolveAndCreate([ - provide(DEFAULT_FIREBASE, { + provide(FirebaseUrl, { useValue: 'https://ng2-forum-demo.firebaseio.com' }), FIREBASE_PROVIDERS ]); - expect(typeof injector.get(DEFAULT_FIREBASE_REF).on).toBe('function'); + expect(typeof injector.get(FirebaseRef).on).toBe('function'); }) }); }); diff --git a/src/angularfire.ts b/src/angularfire.ts index d54916060..b3747fff2 100644 --- a/src/angularfire.ts +++ b/src/angularfire.ts @@ -1,13 +1,13 @@ import {OpaqueToken, provide} from 'angular2/core'; import * as Firebase from 'firebase'; -export const DEFAULT_FIREBASE = new OpaqueToken('DEFAULT_FIREBASE'); -export const DEFAULT_FIREBASE_REF = new OpaqueToken('DEFAULT_FIREBASE_REF') +export const FirebaseUrl = new OpaqueToken('FirebaseUrl'); +export const FirebaseRef = new OpaqueToken('FirebaseRef'); export const FIREBASE_PROVIDERS:any[] = [ - provide(DEFAULT_FIREBASE_REF, { + provide(FirebaseRef, { useFactory: (url:string) => new Firebase(url), - deps: [DEFAULT_FIREBASE]}) + deps: [FirebaseUrl]}) ]; export {FirebaseList, FirebaseListConfig} from './providers/firebase_list'; diff --git a/src/providers/firebase_list.spec.ts b/src/providers/firebase_list.spec.ts index f42e65f8f..51074d3e4 100644 --- a/src/providers/firebase_list.spec.ts +++ b/src/providers/firebase_list.spec.ts @@ -5,7 +5,7 @@ import {beforeEach, fit, inject, it, describe, expect, TestComponentBuilder} fro import * as Firebase from 'firebase'; import {FirebaseList, FirebaseListFactory, onChildAdded, onChildMoved} from './firebase_list'; -import {DEFAULT_FIREBASE, FirebaseObservable} from '../angularfire'; +import {FirebaseUrl, FirebaseObservable} from '../angularfire'; enableProdMode(); @@ -40,7 +40,7 @@ const sharedTemplate = ` token: Todo, path: '/todos' }), - provide(DEFAULT_FIREBASE, { + provide(FirebaseUrl, { useValue: rootFirebase }) ] @@ -59,7 +59,7 @@ class MyComponent { providers: [ FirebaseList('/posts'), FirebaseList('/todos'), - provide(DEFAULT_FIREBASE, { + provide(FirebaseUrl, { useValue: rootFirebase }) ] diff --git a/src/providers/firebase_list.ts b/src/providers/firebase_list.ts index e4079546b..5bbb0a896 100644 --- a/src/providers/firebase_list.ts +++ b/src/providers/firebase_list.ts @@ -1,5 +1,5 @@ import {Provider} from 'angular2/core'; -import {DEFAULT_FIREBASE} from '../angularfire'; +import {FirebaseUrl} from '../angularfire'; import {Observer} from 'rxjs/Observer'; import {FirebaseObservable} from '../utils/firebase_observable'; import {absolutePathResolver} from '../utils/absolute_path_resolver'; @@ -13,7 +13,7 @@ export function FirebaseList (config?:FirebaseListConfig|string):Provider { var normalConfig = normalizeConfig(config); return new Provider(normalConfig.token, { useFactory: (defaultFirebase:string) => FirebaseListFactory(absolutePathResolver(defaultFirebase, normalConfig.path)), - deps: [DEFAULT_FIREBASE] + deps: [FirebaseUrl] }) } diff --git a/test/e2e/firebase_list/firebase_list_example.ts b/test/e2e/firebase_list/firebase_list_example.ts index efb62f5c9..10b4bce65 100644 --- a/test/e2e/firebase_list/firebase_list_example.ts +++ b/test/e2e/firebase_list/firebase_list_example.ts @@ -1,6 +1,6 @@ import {Component, Inject, provide} from 'angular2/core'; import {bootstrap} from 'angular2/platform/browser'; -import {DEFAULT_FIREBASE, FirebaseList, FirebaseObservable} from 'angularfire2'; +import {FIREBASE_URL, FirebaseList, FirebaseObservable} from 'angularfire2'; // var Firebase = require('firebase'); import Firebase from 'firebase'; const rootFirebase = 'https://answers-mobile.firebaseio.com/'; @@ -27,6 +27,6 @@ class App { } bootstrap(App, [ - provide(DEFAULT_FIREBASE, { + provide(FIREBASE_URL, { useValue: rootFirebase })]);