Skip to content

Commit 07a04d0

Browse files
jvandemojvandemo
committed
refactor(all): refactor all code to match the AngularJS styleguide
1 parent 2bb3c47 commit 07a04d0

12 files changed

+308
-222
lines changed

‎Gruntfile.js

+1-3
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ module.exports = function (grunt) {
1212
},
1313
library: {
1414
src: [
15-
'src/growlNotifications/growlNotifications.prefix',
1615
'src/growlNotifications/growlNotifications.js',
1716
'src/growlNotifications/directives/**/*.js',
18-
'src/growlNotifications/services/**/*.js',
19-
'src/growlNotifications/growlNotifications.suffix'
17+
'src/growlNotifications/services/**/*.js'
2018
],
2119
dest: 'dist/angular-growl-notifications.js'
2220
}

‎bower.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "angular-growl-notifications",
3-
"version": "2.0.1",
3+
"version": "2.1.0",
44
"main": [
55
"dist/angular-growl-notifications.js"
66
],

‎dist/angular-growl-notifications.js

+149-107
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1-
(function(window, document) {
2-
// Create all modules and define dependencies to make sure they exist
3-
// and are loaded in the correct order to satisfy dependency injection
4-
// before all nested files are concatenated by Grunt
5-
6-
// Config
7-
angular.module('growlNotifications.config', [])
8-
.value('growlNotifications.config', {
9-
debug: true
10-
});
11-
12-
// Modules
13-
angular.module('growlNotifications.directives', []);
14-
angular.module('growlNotifications.filters', []);
15-
angular.module('growlNotifications.services', []);
16-
angular.module('growlNotifications',
17-
[
18-
'growlNotifications.config',
19-
'growlNotifications.directives',
20-
'growlNotifications.filters',
21-
'growlNotifications.services'
22-
]);
23-
angular.module('growlNotifications.directives')
24-
.directive('growlNotification', ['growlNotifications', '$animate', '$timeout', function (growlNotifications, $animate, $timeout) {
1+
(function(){
2+
3+
// Config
4+
angular.module('growlNotifications.config', [])
5+
.value('growlNotifications.config', {
6+
debug: true
7+
});
8+
9+
// Modules
10+
angular.module('growlNotifications.directives', []);
11+
angular.module('growlNotifications.filters', []);
12+
angular.module('growlNotifications.services', []);
13+
angular.module('growlNotifications',
14+
[
15+
'growlNotifications.config',
16+
'growlNotifications.directives',
17+
'growlNotifications.filters',
18+
'growlNotifications.services'
19+
]);
20+
21+
})();(function () {
22+
23+
function growlNotificationDirective(growlNotifications, $animate, $timeout){
2524

2625
var defaults = {
2726
ttl: growlNotifications.options.ttl || 5000
@@ -42,33 +41,8 @@ angular.module('growlNotifications.directives')
4241

4342
/**
4443
* Controller
45-
*
46-
* @param $scope
47-
* @param $element
48-
* @param $attrs
4944
*/
50-
controller: ['$scope', '$element', function($scope, $element){
51-
52-
/**
53-
* Placeholder for timer promise
54-
*/
55-
this.timer = null;
56-
57-
/**
58-
* Helper method to close notification manually
59-
*/
60-
this.remove = function(){
61-
62-
// Remove the element
63-
$animate.leave($element);
64-
65-
// Cancel scheduled automatic removal if there is one
66-
if (this.timer && this.timer.cancel) {
67-
this.timer.cancel();
68-
}
69-
};
70-
71-
}],
45+
controller: growlNotificationController,
7246

7347
/**
7448
* Make the controller available in the directive scope
@@ -88,7 +62,7 @@ angular.module('growlNotifications.directives')
8862
// Assemble options
8963
var options = angular.extend({}, defaults, scope.$eval(iAttrs.growlNotificationOptions));
9064

91-
if(iAttrs.ttl){
65+
if (iAttrs.ttl) {
9266
options.ttl = scope.$eval(iAttrs.ttl);
9367
}
9468

@@ -103,8 +77,56 @@ angular.module('growlNotifications.directives')
10377
}
10478
};
10579

106-
}]);angular.module('growlNotifications.directives')
107-
.directive('growlNotifications', ['growlNotifications', function (growlNotifications) {
80+
}
81+
82+
// Inject dependencies
83+
growlNotificationDirective.$inject = ['growlNotifications', '$animate', '$timeout'];
84+
85+
/**
86+
* Directive controller
87+
*
88+
* @param $scope
89+
* @param $element
90+
*/
91+
function growlNotificationController($scope, $element) {
92+
93+
/**
94+
* Placeholder for timer promise
95+
*/
96+
this.timer = null;
97+
98+
/**
99+
* Helper method to close notification manually
100+
*/
101+
this.remove = function () {
102+
103+
// Remove the element
104+
$animate.leave($element);
105+
106+
// Cancel scheduled automatic removal if there is one
107+
if (this.timer && this.timer.cancel) {
108+
this.timer.cancel();
109+
}
110+
};
111+
112+
}
113+
114+
// Inject dependencies
115+
growlNotificationController.$inject = ['$scope', '$element'];
116+
117+
// Export
118+
angular
119+
.module('growlNotifications.directives')
120+
.directive('growlNotification', growlNotificationDirective);
121+
122+
})();(function () {
123+
124+
/**
125+
* Create directive definition object
126+
*
127+
* @param growlNotifications
128+
*/
129+
function growlNotificationsDirective(growlNotifications) {
108130

109131
return {
110132

@@ -126,57 +148,77 @@ angular.module('growlNotifications.directives')
126148
}
127149
};
128150

129-
}]);angular.module('growlNotifications.services')
130-
.provider('growlNotifications', [function () {
131-
132-
// Default options
133-
var options = {
134-
ttl: 5000
135-
};
136-
137-
/**
138-
* Provider method to change default options
139-
*
140-
* @param newOptions
141-
*/
142-
this.setOptions = function (newOptions) {
143-
angular.extend(options, newOptions);
144-
return this;
145-
};
146-
147-
/**
148-
* Provider convenience method to get or set default ttl
149-
*
150-
* @param ttl
151-
* @returns {*}
152-
*/
153-
this.ttl = function(ttl){
154-
if(angular.isDefined(ttl)){
155-
options.ttl = ttl;
156-
return this;
157-
}
158-
return options.ttl;
159-
};
160-
161-
/**
162-
* Factory method
163-
*
164-
* @param $timeout
165-
* @param $rootScope
166-
* @returns {GrowlNotifications}
167-
*/
168-
this.$get = function () {
169-
170-
function GrowlNotifications() {
171-
172-
this.options = options;
173-
this.element = null;
174-
175-
}
176-
177-
return new GrowlNotifications();
178-
179-
};
180-
181-
}]);
182-
})(window, document);
151+
}
152+
153+
// Inject dependencies
154+
growlNotificationsDirective.$inject = ['growlNotifications'];
155+
156+
// Export
157+
angular
158+
.module('growlNotifications.directives')
159+
.directive('growlNotifications', growlNotificationsDirective);
160+
161+
})();(function () {
162+
163+
/**
164+
* Growl notifications provider
165+
*/
166+
function growlNotificationsProvider(){
167+
168+
// Default options
169+
var options = {
170+
ttl: 5000
171+
};
172+
173+
/**
174+
* Provider method to change default options
175+
*
176+
* @param newOptions
177+
*/
178+
this.setOptions = function (newOptions) {
179+
angular.extend(options, newOptions);
180+
return this;
181+
};
182+
183+
/**
184+
* Provider convenience method to get or set default ttl
185+
*
186+
* @param ttl
187+
* @returns {*}
188+
*/
189+
this.ttl = function (ttl) {
190+
if (angular.isDefined(ttl)) {
191+
options.ttl = ttl;
192+
return this;
193+
}
194+
return options.ttl;
195+
};
196+
197+
/**
198+
* Factory method
199+
*
200+
* @param $timeout
201+
* @param $rootScope
202+
* @returns {GrowlNotifications}
203+
*/
204+
this.$get = function () {
205+
206+
function GrowlNotifications() {
207+
208+
this.options = options;
209+
this.element = null;
210+
211+
}
212+
213+
return new GrowlNotifications();
214+
215+
};
216+
217+
}
218+
219+
// Export
220+
angular
221+
.module('growlNotifications.services')
222+
.provider('growlNotifications', growlNotificationsProvider);
223+
224+
})();

‎dist/angular-growl-notifications.min.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "growl-notifications",
3-
"version": "2.0.1",
3+
"version": "2.1.0",
44
"keywords": [
55
"angular",
66
"angularjs",

‎readme.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,13 @@ MIT
109109

110110
## Change log
111111

112+
### v2.1.0
113+
114+
- Update code to follow the [AngularJS styleguide](https://github.com/toddmotto/angularjs-styleguide) principles
115+
112116
### v2.0.1
113117

114-
- Fixed issue with minification of controller in `growlNotification` directive (see [this issue](https://github.com/jvandemo/angular-growl-notifications/issues/3)).
118+
- Fix issue with minification of controller in `growlNotification` directive (see [this issue](https://github.com/jvandemo/angular-growl-notifications/issues/3)).
115119

116120
### v2.0.0
117121

0 commit comments

Comments
 (0)