docs(tutorial): improve wording and consistency

author: Pete Bacon Darwin 2013-10-03 11:58:47 +0100
committer: Pete Bacon Darwin 2013-10-03 11:58:47 +0100
commit: 0f7237d764f37ab9916fc9b8ecb7d8cd5b6adf98 (patch)
tree: 9c28d15b5790e3db4a4ccc47903909b980fa68bb /docs/content/tutorial
parent: 575f63ac508a988e0c0ecbf93f62ea6f4bab13c0 (diff)
download: angular.js-0f7237d764f37ab9916fc9b8ecb7d8cd5b6adf98.tar.bz2
8 files changed, 96 insertions, 54 deletions
diff --git a/docs/content/tutorial/step_02.ngdoc b/docs/content/tutorial/step_02.ngdoc
index f9f9b2d8..65f3ffed 100644
--- a/docs/content/tutorial/step_02.ngdoc
+++ b/docs/content/tutorial/step_02.ngdoc
@@ -33,7 +33,7 @@ The view component is constructed by Angular from this template:
 
 __`app/index.html`:__
 <pre>
-<html ng-app>
+<html ng-app="phonecatApp">
 <head>
   ...
   <script src="lib/angular/angular.js"></script>
@@ -47,6 +47,7 @@ __`app/index.html`:__
       <p>{{phone.snippet}}</p>
     </li>
   </ul>
+
 </body>
 </html>
 </pre>
@@ -60,24 +61,25 @@ We replaced the hard-coded phone list with the
 repeater tells Angular to create a `<li>` element for each phone in the list using the first `<li>`
 tag as the template.
 
-* As we've learned in step 0, the curly braces around `phone.name` and `phone.snippet` denote
+We have added a new directive, called `ng-controller`, which attaches a `PhoneListCtrl`
+__controller__ to the DOM at this point.
+
+* As we've learned in {@link step_00 step 0}, the curly braces around `phone.name` and `phone.snippet` denote
 bindings. As opposed to evaluating constants, these expressions are referring to our application
 model, which was set up in our `PhoneListCtrl` controller.
 
 <img class="diagram" src="img/tutorial/tutorial_02.png">
 
-
 ## Model and Controller
 
-The data __model__ (a simple array  of phones in object literal notation) is instantiated within
-the `PhoneListCtrl` __controller__:
+The data __model__ (a simple array  of phones in object literal notation) is now instantiated within
+the `PhoneListCtrl` __controller__. The __controller__ is simply a constructor function that takes a
+`$scope` parameter:
 
 __`app/js/controllers.js`:__
 <pre>
 
-var myApp = angular.module('myApp',[]);
- 
-myApp.controller('PhoneListCtrl', ['$scope', function($scope) {
+function PhoneListCtrl($scope) {
   $scope.phones = [
     {"name": "Nexus S",
      "snippet": "Fast just got faster with Nexus S."},
@@ -86,41 +88,47 @@ myApp.controller('PhoneListCtrl', ['$scope', function($scope) {
     {"name": "MOTOROLA XOOM™",
      "snippet": "The Next, Next Generation tablet."}
   ];
-}]);
-
-</pre>
+}
 
+var phonecatApp = angular.module('phonecatApp',[]);
+phonecatApp.controller('PhoneListCtrl', PhoneListCtrl);
 
+</pre>
 
+Here we have declared a controller called __PhoneListCtrl__ and registered it in an AngularJS
+module, `phonecatApp`. Notice that our `ng-app` directive (on the `<html>` tag) now specifies the `phonecatApp`
+module name as the module to load when bootstrapping the Angular application.
 
 Although the controller is not yet doing very much controlling, it is playing a crucial role. By
 providing context for our data model, the controller allows us to establish data-binding between
 the model and the view. We connected the dots between the presentation, data, and logic components
 as follows:
 
-* `PhoneListCtrl` — the name of our controller function (located in the JavaScript file
-`controllers.js`), matches the value of the
-{@link api/ng.directive:ngController ngController} directive located
-on the `<body>` tag.
+* The {@link api/ng.directive:ngController ngController} directive, located on the `<body>` tag,
+references the the name of our controller, `PhoneListCtrl` (located in the JavaScript file
+`controllers.js`).
 
-* The phone data is then attached to the *scope* (`$scope`) that was injected into our controller
-function. The controller scope is a prototypical descendant of the root scope that was created
-when the application bootstrapped. This controller scope is available to all bindings located within
+* The `PhoneListCtrl` controller attaches the phone data to the `$scope` that was injected into our
+controller function. This *scope* is a prototypical descendant of the *root scope* that was created
+when the application was defined. This controller scope is available to all bindings located within
 the `<body ng-controller="PhoneListCtrl">` tag.
 
-  The concept of a scope in Angular is crucial; a scope can be seen as the glue which allows the
+### Scope
+
+The concept of a scope in Angular is crucial. A scope can be seen as the glue which allows the
 template, model and controller to work together. Angular uses scopes, along with the information
 contained in the template, data model, and controller, to keep models and views separate, but in
 sync. Any changes made to the model are reflected in the view; any changes that occur in the view
 are reflected in the model.
 
-  To learn more about Angular scopes, see the {@link api/ng.$rootScope.Scope angular scope documentation}.
+To learn more about Angular scopes, see the {@link api/ng.$rootScope.Scope angular scope documentation}.
 
 
 ## Tests
 
-The "Angular way" makes it easy to test code as it is being developed. Take a look at the following
-unit test for your newly created controller:
+The "Angular way" of separating controller from the view, makes it easy to test code as it is being
+developed. If our controller is available on the global namespace then we can simply instantiate it
+with a mock `scope` object. Take a look at the following unit test for our controller:
 
 __`test/unit/controllersSpec.js`:__
 <pre>
@@ -138,11 +146,33 @@ describe('PhoneCat controllers', function() {
 });
 </pre>
 
-The test instantiates our PhoneListCtrl and verifies that its phones array property contains three
-records. This example demonstrates how easy it is to create a unit test for code in Angular. Since
-testing is such a critical part of software development, we make it easy to create tests in Angular
-so that developers are encouraged to write them.
+The test instantiates `PhoneListCtrl` and verifies that the phones array property on the scope
+contains three records. This example demonstrates how easy it is to create a unit test for code in
+Angular. Since testing is such a critical part of software development, we make it easy to create
+tests in Angular so that developers are encouraged to write them.
+
+### Testing non-Global Controllers
+In practice, you will not want to have your controller functions in the global namespace.  In this
+case Angular provides a service, `$controller`, which will retrieve your controller by name.  Here
+is the same test using `$controller`:
+
+__`test/unit/controllersSpec.js`:__
+<pre>
+describe('PhoneCat controllers', function() {
+
+  describe('PhoneListCtrl', function(){
+
+    it('should create "phones" model with 3 phones', inject(function($controller) {
+      var scope = {},
+          ctrl = $controller('PhoneListCtrl', { $scope: scope });
+
+      expect(scope.phones.length).toBe(3);
+    });
+  });
+});
+</pre>
 
+### Writing and Running Tests
 Angular developers prefer the syntax of Jasmine's Behavior-driven Development  (BDD) framework when
 writing tests. Although Angular does not require you to use Jasmine, we wrote all of the tests in
 this tutorial in Jasmine. You can learn about Jasmine on the {@link
diff --git a/docs/content/tutorial/step_04.ngdoc b/docs/content/tutorial/step_04.ngdoc
index 72ac70d5..8cf429e1 100644
--- a/docs/content/tutorial/step_04.ngdoc
+++ b/docs/content/tutorial/step_04.ngdoc
@@ -65,9 +65,7 @@ necessary!
 
 __`app/js/controllers.js`:__
 <pre>
-var myApp = angular.module('myApp',[]);
-
-myApp.controller('PhoneListCtrl', ['$scope', function($scope) {
+function PhoneListCtrl($scope) {
   $scope.phones = [
     {"name": "Nexus S",
      "snippet": "Fast just got faster with Nexus S.",
@@ -81,7 +79,11 @@ myApp.controller('PhoneListCtrl', ['$scope', function($scope) {
   ];
 
   $scope.orderProp = 'age';
-}]);
+}
+
+var phonecatApp = angular.module('phonecatApp',[]);
+phonecatApp.controller('PhoneListCtrl', PhoneListCtrl);
+
 </pre>
 
 * We modified the `phones` model - the array of phones - and added an `age` property to each phone
diff --git a/docs/content/tutorial/step_05.ngdoc b/docs/content/tutorial/step_05.ngdoc
index 62de4102..36d4748c 100644
--- a/docs/content/tutorial/step_05.ngdoc
+++ b/docs/content/tutorial/step_05.ngdoc
@@ -62,7 +62,8 @@ function PhoneListCtrl($scope, $http) {
   $scope.orderProp = 'age';
 }
 
-//PhoneListCtrl.$inject = ['$scope', '$http'];
+var phonecatApp = angular.module('phonecatApp',[]);
+phonecatApp.controller('PhoneListCtrl', PhoneListCtrl);
 </pre>
 
 `$http` makes an HTTP GET request to our web server, asking for `phone/phones.json` (the url is
@@ -106,21 +107,30 @@ constructor function, if you were to {@link http://en.wikipedia.org/wiki/Minific
 minify} the JavaScript code for `PhoneListCtrl` controller, all of its function arguments would be
 minified as well, and the dependency injector would not be able to identify services correctly.
 
-To overcome issues caused by minification, just assign an array with service identifier strings
-into the `$inject` property of the controller function, just like the last line in the snippet
-(commented out) suggests:
+There are two ways to overcome issues caused by minification.
 
+* You can create a `$inject` property on the controller function which holds an array of strings.
+  Each string in the array is the name of the service to inject for the corresponding parameter.
+  In the case of our example we would write:
+
+    function PhoneListCtrl($scope, $http) {...}
     PhoneListCtrl.$inject = ['$scope', '$http'];
+    phonecatApp.controller('PhoneListCtrl', PhoneListCtrl);
 
-There is also one more way to specify this dependency list and avoid minification issues — using the
-bracket notation which wraps the function to be injected into an array of strings (representing the
-dependency names) followed by the function to be injected:
+* Use the inline bracket notation which wraps the function to be injected into an array of strings
+  (representing the dependency names) followed by the function to be injected:
 
-    var PhoneListCtrl = ['$scope', '$http', function($scope, $http) { /* constructor body */ }];
+    function PhoneListCtrl($scope, $http) {...}
+    phonecatApp.controller('PhoneListCtrl', ['$scope', '$http', PhoneListCtrl]);
 
 Both of these methods work with any function that can be injected by Angular, so it's up to your
 project's style guide to decide which one you use.
 
+When using the second method, it is common to provide the constructor function inline as an
+anonymous function when registering the controller:
+
+    phonecatApp.controller('PhoneListCtrl', ['$scope', '$http', function($scope, $http) {...}]);
+
 
 ## Test
 
@@ -147,7 +157,7 @@ describe('PhoneCat controllers', function() {
           respond([{name: 'Nexus S'}, {name: 'Motorola DROID'}]);
 
       scope = $rootScope.$new();
-      ctrl = $controller(PhoneListCtrl, {$scope: scope});
+      ctrl = $controller('PhoneListCtrl', {$scope: scope});
     }));
 </pre>
 
@@ -167,8 +177,8 @@ isolated from the work done in other tests.
 
 * We created a new scope for our controller by calling `$rootScope.$new()`
 
-* We called the injected `$controller` function passing the `PhoneListCtrl` function and the created
-scope as parameters.
+* We called the injected `$controller` function passing the name of the`PhoneListCtrl` controller
+and the created scope as parameters.
 
 Because our code now uses the `$http` service to fetch the phone list data in our controller, before
 we create the `PhoneListCtrl` child scope, we need to tell the testing harness to expect an
diff --git a/docs/content/tutorial/step_07.ngdoc b/docs/content/tutorial/step_07.ngdoc
index 35f1f920..2dac3ff7 100644
--- a/docs/content/tutorial/step_07.ngdoc
+++ b/docs/content/tutorial/step_07.ngdoc
@@ -69,7 +69,7 @@ both module systems can live side by side and fulfil their goals.
 
 __`app/js/app.js`:__
 <pre>
-var myApp = angular.module('phonecat', []).
+var phonecatApp = angular.module('phonecatApp', []).
   config(['$routeProvider', function($routeProvider) {
   $routeProvider.
       when('/phones', {templateUrl: 'partials/phone-list.html',   controller: PhoneListCtrl}).
@@ -124,7 +124,7 @@ __`app/index.html`:__
 __`app/js/controllers.js`:__
 <pre>
 ...
-myApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', function($scope, $routeParams) {
+phonecatApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', function($scope, $routeParams) {
   $scope.phoneId = $routeParams.phoneId;
 }]);
 </pre>
diff --git a/docs/content/tutorial/step_08.ngdoc b/docs/content/tutorial/step_08.ngdoc
index 503b4347..5075be98 100644
--- a/docs/content/tutorial/step_08.ngdoc
+++ b/docs/content/tutorial/step_08.ngdoc
@@ -61,8 +61,8 @@ the same way as the phone list controller.
 
 __`app/js/controllers.js`:__
 <pre>
-var myApp = angular.module('myApp',[]);
-myApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', '$http', function($scope, $routeParams, $http) {
+var phonecatApp = angular.module('phonecatApp',[]);
+phonecatApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', '$http', function($scope, $routeParams, $http) {
   $http.get('phones/' + $routeParams.phoneId + '.json').success(function(data) {
     $scope.phone = data;
   });
@@ -132,7 +132,7 @@ __`test/unit/controllersSpec.js`:__
 
       $routeParams.phoneId = 'xyz';
       scope = $rootScope.$new();
-      ctrl = $controller(PhoneDetailCtrl, {$scope: scope});
+      ctrl = $controller('PhoneDetailCtrl', {$scope: scope});
     }));
 
 
diff --git a/docs/content/tutorial/step_09.ngdoc b/docs/content/tutorial/step_09.ngdoc
index a6c4585c..da807875 100644
--- a/docs/content/tutorial/step_09.ngdoc
+++ b/docs/content/tutorial/step_09.ngdoc
@@ -45,7 +45,7 @@ our main `phonecat` module.
 __`app/js/app.js`:__
 <pre>
 ...
-angular.module('phonecat', ['phonecatFilters']).
+angular.module('phonecatApp', ['phonecatFilters']).
 ...
 </pre>
 
diff --git a/docs/content/tutorial/step_10.ngdoc b/docs/content/tutorial/step_10.ngdoc
index b612d996..9e629861 100644
--- a/docs/content/tutorial/step_10.ngdoc
+++ b/docs/content/tutorial/step_10.ngdoc
@@ -25,8 +25,8 @@ GitHub}:
 __`app/js/controllers.js`:__
 <pre>
 ...
-var myApp = angular.module('myApp',[]);
-myApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', '$http', function($scope, $routeParams, $http) {
+var phonecatApp = angular.module('phonecatApp',[]);
+phonecatApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', '$http', function($scope, $routeParams, $http) {
   $http.get('phones/' + $routeParams.phoneId + '.json').success(function(data) {
     $scope.phone = data;
     $scope.mainImageUrl = data.images[0];
diff --git a/docs/content/tutorial/step_11.ngdoc b/docs/content/tutorial/step_11.ngdoc
index 8fdd31fb..2b3210ee 100644
--- a/docs/content/tutorial/step_11.ngdoc
+++ b/docs/content/tutorial/step_11.ngdoc
@@ -39,7 +39,7 @@ __`app/index.html`.__
 
 __`app/js/services.js`.__
 <pre>
-var myApp = angular.module('phonecatServices', ['ngResource']).
+var phonecatApp = angular.module('phonecatServices', ['ngResource']).
     factory('Phone', function($resource){
   return $resource('phones/:phoneId.json', {}, {
     query: {method:'GET', params:{phoneId:'phones'}, isArray:true}
@@ -60,11 +60,11 @@ api/ng.$http $http} service.
 __`app/js/app.js`.__
 <pre>
 ...
-angular.module('phonecat', ['phonecatFilters', 'phonecatServices']).
+angular.module('phonecatApp', ['phonecatFilters', 'phonecatServices']).
 ...
 </pre>
 
-We need to add 'phonecatServices' to 'phonecat' application's requires array.
+We need to add the 'phonecatServices' module dependency to 'phonecatApp' module's requires array.
 
 
 ## Controller
@@ -79,12 +79,12 @@ __`app/js/controllers.js`.__
 <pre>
 ...
 
-myApp.controller('PhoneListCtrl', ['$scope', 'Phone', function($scope, Phone) {
+phonecatApp.controller('PhoneListCtrl', ['$scope', 'Phone', function($scope, Phone) {
   $scope.phones = Phone.query();
   $scope.orderProp = 'age';
 }]);
 
-myApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', 'Phone', function($scope, $routeParams, Phone) {
+phonecatApp.controller('PhoneDetailCtrl', ['$scope', '$routeParams', 'Phone', function($scope, $routeParams, Phone) {
   $scope.phone = Phone.get({phoneId: $routeParams.phoneId}, function(phone) {
     $scope.mainImageUrl = phone.images[0];
   });
author	Pete Bacon Darwin	2013-10-03 11:58:47 +0100
committer	Pete Bacon Darwin	2013-10-03 11:58:47 +0100
commit	0f7237d764f37ab9916fc9b8ecb7d8cd5b6adf98 (patch)
tree	9c28d15b5790e3db4a4ccc47903909b980fa68bb /docs/content/tutorial
parent	575f63ac508a988e0c0ecbf93f62ea6f4bab13c0 (diff)
download	angular.js-0f7237d764f37ab9916fc9b8ecb7d8cd5b6adf98.tar.bz2