Merge pull request #364 from firebase/release_0.8

Release 0.8

Author: katowulf

.gitignore

@@ -1,3 +1,4 @@
 bower_components/
 node_modules/
+tests/coverage/
 .idea

.travis.yml

@@ -1,15 +1,14 @@
 language: node_js
 node_js:
 - '0.10'
-branches:
-  only:
-  - master
 addons:
   sauce_connect: true
 before_install:
 - export DISPLAY=:99.0
 - sh -e /etc/init.d/xvfb start
 install:
+- git clone git://github.com/n1k0/casperjs.git ~/casperjs
+- export PATH=$PATH:~/casperjs/bin
 - npm install -g grunt-cli
 - npm install -g bower
 - npm install

CHANGELOG.md

@@ -0,0 +1,8 @@
+v0.8.0
+-------------
+Release Date: 2014-07-29
+
+  * NOTE: this release introduces several breaking changes as we works towards a stable 1.0.0 release.
+  * Moved many roles of $firebase into $FirebaseObject. $firebase is now just an Angular array wrapper around the base Firebase API.
+  * Introduced $FirebaseArray to provide better array support.
+  * Added support for extending the base $FirebaseObject and $FirebaseArray factories.

Gruntfile.js

@@ -3,6 +3,26 @@ module.exports = function(grunt) {
   'use strict';
 
   grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+    meta: {
+      banner: '/*!\n * <%= pkg.title || pkg.name %> <%= pkg.version %> <%= grunt.template.today("yyyy-mm-dd") %>\n' +
+        '<%= pkg.homepage ? " * " + pkg.homepage + "\\n" : "" %>' +
+        ' * Copyright (c) <%= grunt.template.today("yyyy") %> Firebase, Inc.\n' +
+        ' * MIT LICENSE: http://firebase.mit-license.org/\n */\n\n'
+    },
+
+    // merge files from src/ into angularfire.js
+    concat: {
+      app: {
+        options: { banner: '<%= meta.banner %>' },
+        src: [
+          'src/module.js',
+          'src/**/*.js'
+        ],
+        dest: 'dist/angularfire.js'
+      }
+    },
+
     // Run shell commands
     shell: {
       options: {
@@ -31,41 +51,46 @@ module.exports = function(grunt) {
 
     // Minify JavaScript
     uglify : {
+      options: {
+        preserveComments: 'some'
+      },
       app : {
         files : {
-          'angularfire.min.js' : ['angularfire.js']
+          'dist/angularfire.min.js' : ['dist/angularfire.js']
         }
       }
     },
 
     // Lint JavaScript
     jshint : {
       options : {
-        jshintrc: '.jshintrc'
+        jshintrc: '.jshintrc',
+        ignores: ['src/polyfills.js'],
       },
-      all : ['angularfire.js']
+      all : ['src/**/*.js']
     },
 
     // Auto-run tasks on file changes
     watch : {
       scripts : {
-        files : 'angularfire.js',
-        tasks : ['build', 'test:unit', 'notify:watch'],
+        files : ['src/**/*.js', 'tests/unit/**/*.spec.js', 'tests/lib/**/*.js', 'tests/mocks/**/*.js'],
+        tasks : ['test:unit', 'notify:watch'],
         options : {
-          interrupt : true
+          interrupt : true,
+          atBegin: true
         }
       }
     },
 
     // Unit tests
     karma: {
       options: {
-        configFile: 'tests/automatic_karma.conf.js',
+        configFile: 'tests/automatic_karma.conf.js'
       },
-      singlerun: {
-        autowatch: false,
-        singleRun: true
+      manual: {
+        configFile: 'tests/manual_karma.conf.js',
       },
+      singlerun: {},
       watch: {
          autowatch: true,
          singleRun: false,
@@ -113,6 +138,11 @@ module.exports = function(grunt) {
   grunt.registerTask('test', ['test:unit', 'test:e2e']);
   grunt.registerTask('test:unit', ['karma:singlerun']);
   grunt.registerTask('test:e2e', ['connect:testserver', 'protractor:singlerun']);
+  grunt.registerTask('test:manual', ['karma:manual']);
+
+  // Travis CI testing
+  //grunt.registerTask('test:travis', ['build', 'test:unit', 'connect:testserver', 'protractor:saucelabs']);
+  grunt.registerTask('test:travis', ['build', 'test:unit']);
 
   // Sauce tasks
   grunt.registerTask('sauce:unit', ['karma:saucelabs']);
@@ -123,7 +153,7 @@ module.exports = function(grunt) {
   grunt.registerTask('test:watch:unit', ['karma:watch']);
 
   // Build tasks
-  grunt.registerTask('build', ['jshint', 'uglify']);
+  grunt.registerTask('build', ['concat', 'jshint', 'uglify']);
 
   // Default task
   grunt.registerTask('default', ['build', 'test']);

README.md

@@ -1,69 +1,73 @@
-AngularFire
-===========
-AngularFire is an officially supported [AngularJS](http://angularjs.org/) binding
-for [Firebase](http://www.firebase.com/?utm_medium=web&utm_source=angularFire).
-Firebase is a full backend so you don't need servers to build your Angular app!
 
-*Please visit the
-[Firebase + Angular Quickstart guide](https://www.firebase.com/quickstart/angularjs.html)
-for more information*.
+# AngularFire
 
-We also have a [tutorial](https://www.firebase.com/tutorial/#tutorial/angular/0),
-[documentation](https://www.firebase.com/docs/angular/index.html) and an
-[API reference](https://www.firebase.com/docs/angular/reference.html).
+[![Build Status](https://travis-ci.org/firebase/angularfire.svg)](https://travis-ci.org/firebase/angularfire)
+[![Version](https://badge.fury.io/gh/firebase%2Fangularfire.svg)](http://badge.fury.io/gh/firebase%2Fangularfire)
 
-Join our [Firebase + Angular Google Group](https://groups.google.com/forum/#!forum/firebase-angular) to ask questions, provide feedback, and share apps you've built with Firebase and Angular.
+AngularFire is the officially supported [AngularJS](http://angularjs.org/) binding
+for [Firebase](http://www.firebase.com/?utm_medium=web&utm_source=angularfire).
+Firebase is a full backend so you don't need servers to build your Angular app. AngularFire provides you with the `$firebase` service which allows you to easily keep your `$scope` variables in sync with your Firebase backend.
 
-Development
------------
-[![Build Status](https://travis-ci.org/firebase/angularFire.png)](https://travis-ci.org/firebase/angularFire)
-[![Bower version](https://badge.fury.io/bo/angularfire.png)](http://badge.fury.io/bo/angularfire)
-[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)
+## Downloading AngularFire
 
-If you'd like to hack on AngularFire itself, you'll need
-[node.js](http://nodejs.org/download/) and [Bower](http://bower.io).
+In order to use AngularFire in your project, you need to include the following files in your HTML:
 
-You can also start hacking on AngularFire in a matter of seconds on
-[Nitrous.IO](https://www.nitrous.io/?utm_source=github.com&utm_campaign=angularFire&utm_medium=hackonnitrous)
+```html
+<!-- AngularJS -->
+<script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.3.0-beta.17/angular.min.js"></script>
+
+<!-- Firebase -->
+<script src="https://cdn.firebase.com/js/client/1.0.18/firebase.js"></script>
+
+<!-- AngularFire -->
+<script src="https://cdn.firebase.com/libs/angularfire/0.8.0/angularfire.min.js"></script>
+```
 
-[![Hack firebase/angularFire on
-Nitrous.IO](https://d3o0mnbgv6k92a.cloudfront.net/assets/hack-l-v1-3cc067e71372f6045e1949af9d96095b.png)](https://www.nitrous.io/hack_button?source=embed&runtime=nodejs&repo=firebase%2FangularFire&file_to_open=README.md)
+Use the URL above to download both the minified and non-minified versions of AngularFire from the Firebase CDN. You can also download them from the root of this GitHub repository. [Firebase](https://www.firebase.com/docs/web-quickstart.html?utm_medium=web&utm_source=angularfire) and [AngularJS](http://angularjs.org/) can be downloaded directly from their respective websites.
 
-To get your dev environment set up, run the following commands:
+You can also install AngularFire via Bower and the dependencies will be downloaded automatically:
 
 ```bash
-git clone https://github.com/firebase/angularfire.git  # clones this repository
-npm install    # installs node dependencies
-bower install  # installs JavaScript dependencies
-grunt install  # installs selenium server for e2e tests
+$ bower install angularfire --save
 ```
 
-Use grunt to build and test the code:
+Once you've included AngularFire and its dependencies into your project, you will have access to the `$firebase` service.
 
-```bash
-# Validates source with jshint, minifies source, and then runs unit and e2e tests
-grunt
+You can also start hacking on AngularFire in a matter of seconds on
+[Nitrous.IO](https://www.nitrous.io/?utm_source=github.com&utm_campaign=angularfire&utm_medium=hackonnitrous):
 
-# Watches for changes and runs only unit tests after each change
-grunt watch
+[![Hack firebase/angularfire on
+Nitrous.IO](https://d3o0mnbgv6k92a.cloudfront.net/assets/hack-l-v1-3cc067e71372f6045e1949af9d96095b.png)](https://www.nitrous.io/hack_button?source=embed&runtime=nodejs&repo=firebase%2Fangularfire&file_to_open=README.md)
 
-# Runs all tests
-grunt test
+## Getting Started with Firebase
 
-# Minifies source
-grunt build
-```
+AngularFire requires Firebase in order to sync data. You can [sign up here](https://www.firebase.com/docs/web-quickstart.html?utm_medium=web&utm_source=angularfire) for a free account.
 
-In addition to the automated test suite, there is an additional manual test suite that ensures that the
-$firebaseSimpleLogin service is working properly with auth providers. These tests are run using karma with the following command:
+## Documentation
+
+The Firebase docs have a [quickstart](https://www.firebase.com/docs/web/bindings/angular/quickstart.html), [guide](https://www.firebase.com/docs/web/bindings/angular/guide.html), and [full API reference](https://www.firebase.com/docs/web/bindings/angular/api.html) for AngularFire.
+
+We also have a [tutorial](https://www.firebase.com/tutorial/#tutorial/angular/0) to help you get started with AngularFire.
+
+Join our [Firebase + Angular Google Group](https://groups.google.com/forum/#!forum/firebase-angular) to ask questions, provide feedback, and share apps you've built with Firebase and Angular.
+
+## Contributing
+
+If you'd like to contribute to AngularFire, you'll need to run the following commands to get your environment set up:
 
 ```bash
-karma start tests/manual_karma.conf.js
+$ git clone https://github.com/firebase/angularfire.git
+$ cd angularfire        # go to the angularfire directory
+$ npm install -g grunt  # globally install grunt task runner
+$ npm install -g bower  # globally install Bower package manager
+$ npm install           # install local npm build / test dependencies
+$ bower install         # install local JavaScript dependencies
+$ grunt install         # install Selenium server for end-to-end tests
+$ grunt watch           # watch for source file changes
 ```
 
-Note that you must click "Close this window", login to Twitter, etc. when
-prompted in order for these tests to complete successfully.
+`grunt watch` will watch for changes in the `/src/` directory and lint, concatenate, and minify the source files when a change occurs. The output files - `angularfire.js` and `angularfire.min.js` - are written to the `/dist/` directory. `grunt watch` will also re-run the unit tests every time you update any source files.
+
+You can run the entire test suite via the command line using `grunt test`. To only run the unit tests, run `grunt test:unit`. To only run the end-to-end [Protractor](https://github.com/angular/protractor/) tests, run `grunt test:e2e`.
 
-License
--------
-[MIT](http://firebase.mit-license.org).
+In addition to the automated test suite, there is an additional manual test suite that ensures that the `$firebaseSimpleLogin` service is working properly with the authentication providers. These tests can be run with `grunt test:manual`. Note that you must click "Close this window", login to Twitter, etc. when prompted in order for these tests to complete successfully.