symphony/assets/js/src/symphony.notify.js - Code Metrics - Inspection of "Docs review" - symphonycms/symphony-2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2835)

unknown

created 2018-05-09 20:36 UTC

symphony/assets/js/src/symphony.notify.js A

↳ Parent: Project

Complexity

Total Complexity	34
Complexity/F	2.13

Size

Lines of Code	270
Function Count	16

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	0
c	0
b	0
f	0
nc	96
dl	0
loc	270
rs	9.2
wmc	34
mnd	3
bc	34
fnc	16
bpm	2.125
cpm	2.125
noi	3

1 Function

Rating	Name	Duplication	Size	Complexity
B	$.fn.symphonyNotify	0	250	1

/**
 * @package assets
 */

(function($, Symphony) {
	'use strict';

	/**
	 * Notify combines multiple system messages to an interface that focusses
	 * on a single message at a time and offers a navigation to move between message.
	 *
	 * @name $.symphonyNotify
	 * @class
	 *
	 * @param {Object} options An object specifying containing the attributes specified below
	 * @param {String} [options.items='p.notice'] Selector to find messages
	 * @param {String} [options.storage='symphony.notify.root'] Namespace used for local storage
	 *
	 * @example

			$('#messages').symphonyNotify();
	 */
	$.fn.symphonyNotify = function(options) {
		var objects = this,
			settings = {
				items: 'p.notice',
				storage: 'symphony.notify.' + Symphony.Context.get('root').replace('http://', '')
			};

		$.extend(settings, options);

	/*-----------------------------------------------------------------------*/

		Symphony.Language.add({
			'Ignore?': false,
			'next': false,
			'at': false
		});

	/*-------------------------------------------------------------------------
		Events
	-------------------------------------------------------------------------*/

		// Attach message
		objects.on('attach.notify', function attachMessage(event, message, type) {
			var object = $(this),
				notifier = object.find('div.notifier'),
				items = notifier.find(settings.items),
				item, storage;

			notifier.trigger('attachstart.notify');

			// Create item
			item = $('<p />', {
				'class': type
			}).html(message.replace(Symphony.Language.get('at') + ' ', '')).addClass('notice active').symphonyTimeAgo();

			// Add ignore link to notices)
			if(!item.is('.error') && !item.is('.success') && !item.is('.protected')) {
				item.html(item.html() + ' <a class="ignore">' + Symphony.Language.get('Ignore?') + '</a>');
			}

			// Add navigator
			$('<nav />', {
				text: Symphony.Language.get('next')
			}).hide().appendTo(item);

			// Load exclusion rules
			if(Symphony.Support.localStorage === true) {
				storage = (window.localStorage[settings.storage]) ? $.parseJSON(window.localStorage[settings.storage]) : [];
			}

			// Dimmed success transition
			if (!!type && !!~type.indexOf('success')) {
				setTimeout(function () {
					item.addClass('dimmed');
				}, 10000);
			}

			// Prepend item
			if($.inArray(item.text(), storage) == -1) {

				items.removeClass('active');
				item.addClass('active').prependTo(notifier);
				notifier.scrollTop(0);

				notifier.trigger('attachstop.notify', [item]);
			}
			else {
				notifier.trigger('attachcancel.notify', [item]);
			}
		});

		// Detach message
		objects.on('detach.notify', settings.items, function detachMessage() {
			var item = $(this),
				notifier = item.parents('div.notifier');

			notifier.trigger('detachstart.notify', [item]);

			// Prepare item removal
			notifier.one('movestop.notify', function() {
				var notifier = $(this),
					offset = notifier.scrollTop();

				// Adjust offset
				if(offset > 0) {
					notifier.scrollTop(offset - item.outerHeight());
				}

				// Remove item
				item.remove();

				notifier.trigger('detachstop.notify', [item]);
			});

			// Fade item
			item.animate({
				opacity: 0
			}, 'normal', function removeItem() {

				// No other items
				if(item.siblings().length == 0) {

					notifier.trigger('resize.notify', [$('<div />')]);
				}

				// More item
				else {
					notifier.trigger('move.notify');
				}

				// Remove item
				item.remove();
				notifier.trigger('detachstop.notify', [item]);
			});
		});

		// Resize notifier
		objects.on('resize.notify attachstop.notify', 'div.notifier', function resizeNotifer(event, item) {
			var notifier = $(this);

			// Adjust height
			if(!notifier.hasClass('constructing')) {
				var active = item || notifier.find('.active:not(:animated)');

				notifier.show().animate({
					height: active.innerHeight() || 0
				}, 100);
			}
		});

		// Count messages
		objects.on('attachstop.notify detachstop.notify', 'div.notifier', function toggleNavigator() {
			var notifier = $(this),
				items = notifier.find(settings.items);

			// Hide navigator
			if(items.length == 1) {

				items.find('nav').hide();
			}

			// Show navigator
			else {
				items.find('nav').show();
			}
		});

		// Next message
		objects.on('click', 'nav', function switchMessage() {
			var notifier = $(this).closest('div.notifier');

			// Move messages
			notifier.trigger('move.notify');
		});

		// Move messages
		objects.on('move.notify', 'div.notifier', function moveMessage() {
			var notifier = $(this),
				current = notifier.find('.active'),
				next = current.next(settings.items),
				from = current.outerHeight(),
				offset;

			notifier.trigger('movestart.notify');

			// Deactivate current message
			current.removeClass('active');

			// Activate next message and get offset
			if(next.length > 0) {
				next.addClass('active');
				offset = notifier.scrollTop() + from;
			}
			else {
				next = notifier.find(settings.items).first().addClass('active');
				offset = 0;
			}

			// If next's height is not the same, resize first
			if(next.outerHeight() !== from) {
				notifier.trigger('resize.notify');
			}

			// Move to next message
			notifier.animate({
				scrollTop: offset
			}, 'fast', function stopMovingMessage() {
				notifier.trigger('movestop.notify');
			});
		});

		// Ignore message
		objects.on('click', 'a.ignore', function ignoreMessage() {
			var ignore = $(this),
				item = ignore.parents(settings.items),
				text = item.text(),
				storage;

			// Store exclusion rule
			if(Symphony.Support.localStorage === true) {
				// Put in a try/catch incase we exceed storage space
				try {
					storage = (window.localStorage[settings.storage]) ? $.parseJSON(window.localStorage[settings.storage]) : [];
					storage.push(text);
					window.localStorage[settings.storage] = JSON.stringify(storage);
				}
				catch(e) {
					window.onerror(e.message);
				}
			}

			// Remove item
			item.trigger('detach.notify');
		});

	/*-------------------------------------------------------------------------
		Initialisation
	-------------------------------------------------------------------------*/

		// Build interface
		objects.each(function initNotify() {
			var object = $(this),
				notifier = $('<div class="notifier" />').hide().prependTo(object),
				items = $(object.find(settings.items).get().reverse());

			// Construct notifier
			notifier.addClass('constructing');
			notifier.height(items.last().innerHeight());
			items.each(function buildMessages() {
				var item = $(this).remove(),
					message = item.html(),
					type = item.attr('class');

				object.trigger('attach.notify', [message, type]);
			});

			// Resize notifier
			if(notifier.find(settings.items).length > 0) {
				notifier.removeClass('constructing').trigger('resize.notify');
			}

			notifier.removeClass('constructing');

			// Update relative times in system messages
			setInterval(function updateRelativeTimes() {
				$('header p.notice').symphonyTimeAgo();
			}, 60000);
		});

	/*-----------------------------------------------------------------------*/

		return objects;
	};

})(window.jQuery, window.Symphony);


1			/**
2			* @package assets
3			*/
4
5			(function($, Symphony) {
6			'use strict';
7
8			/**
9			* Notify combines multiple system messages to an interface that focusses
10			* on a single message at a time and offers a navigation to move between message.
11			*
12			* @name $.symphonyNotify
13			* @class
14			*
15			* @param {Object} options An object specifying containing the attributes specified below
16			* @param {String} [options.items='p.notice'] Selector to find messages
17			* @param {String} [options.storage='symphony.notify.root'] Namespace used for local storage
18			*
19			* @example
20
21			$('#messages').symphonyNotify();
22			*/
23			$.fn.symphonyNotify = function(options) {
24			var objects = this,
25			settings = {
26			items: 'p.notice',
27			storage: 'symphony.notify.' + Symphony.Context.get('root').replace('http://', '')
28			};
29
30			$.extend(settings, options);
31
32			/-----------------------------------------------------------------------/
33
34			Symphony.Language.add({
35			'Ignore?': false,
36			'next': false,
37			'at': false
38			});
39
40			/*-------------------------------------------------------------------------
41			Events
42			-------------------------------------------------------------------------*/
43
44			// Attach message
45			objects.on('attach.notify', function attachMessage(event, message, type) {
46			var object = $(this),
47			notifier = object.find('div.notifier'),
48			items = notifier.find(settings.items),
49			item, storage;
50
51			notifier.trigger('attachstart.notify');
52
53			// Create item
54			item = $('<p />', {
55			'class': type
56			}).html(message.replace(Symphony.Language.get('at') + ' ', '')).addClass('notice active').symphonyTimeAgo();
57
58			// Add ignore link to notices)
59			if(!item.is('.error') && !item.is('.success') && !item.is('.protected')) {
60			item.html(item.html() + ' <a class="ignore">' + Symphony.Language.get('Ignore?') + '</a>');
61			}
62
63			// Add navigator
64			$('<nav />', {
65			text: Symphony.Language.get('next')
66			}).hide().appendTo(item);
67
68			// Load exclusion rules
69			if(Symphony.Support.localStorage === true) {
70			storage = (window.localStorage[settings.storage]) ? $.parseJSON(window.localStorage[settings.storage]) : [];
71			}
72
73			// Dimmed success transition
74			if (!!type && !!~type.indexOf('success')) {
75			setTimeout(function () {
76			item.addClass('dimmed');
77			}, 10000);
78			}
79
80			// Prepend item
81			if($.inArray(item.text(), storage) == -1) {
			0 ignored issues – show Bug introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report The variable `storage` does not seem to be initialized in case `Symphony.Support.localStorage === true` on line `69` is `false`. Are you sure the function `inArray` handles `undefined` variables? Loading history...
82			items.removeClass('active');
83			item.addClass('active').prependTo(notifier);
84			notifier.scrollTop(0);
85
86			notifier.trigger('attachstop.notify', [item]);
87			}
88			else {
89			notifier.trigger('attachcancel.notify', [item]);
90			}
91			});
92
93			// Detach message
94			objects.on('detach.notify', settings.items, function detachMessage() {
95			var item = $(this),
96			notifier = item.parents('div.notifier');
97
98			notifier.trigger('detachstart.notify', [item]);
99
100			// Prepare item removal
101			notifier.one('movestop.notify', function() {
102			var notifier = $(this),
103			offset = notifier.scrollTop();
104
105			// Adjust offset
106			if(offset > 0) {
107			notifier.scrollTop(offset - item.outerHeight());
108			}
109
110			// Remove item
111			item.remove();
112
113			notifier.trigger('detachstop.notify', [item]);
114			});
115
116			// Fade item
117			item.animate({
118			opacity: 0
119			}, 'normal', function removeItem() {
120
121			// No other items
122			if(item.siblings().length == 0) {
			0 ignored issues – show Best Practice introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report Comparing `item.siblings().length` to `0` using the `==` operator is not safe. Consider using `===` instead. Loading history...
123			notifier.trigger('resize.notify', [$('<div />')]);
124			}
125
126			// More item
127			else {
128			notifier.trigger('move.notify');
129			}
130
131			// Remove item
132			item.remove();
133			notifier.trigger('detachstop.notify', [item]);
134			});
135			});
136
137			// Resize notifier
138			objects.on('resize.notify attachstop.notify', 'div.notifier', function resizeNotifer(event, item) {
139			var notifier = $(this);
140
141			// Adjust height
142			if(!notifier.hasClass('constructing')) {
143			var active = item \|\| notifier.find('.active:not(:animated)');
144
145			notifier.show().animate({
146			height: active.innerHeight() \|\| 0
147			}, 100);
148			}
149			});
150
151			// Count messages
152			objects.on('attachstop.notify detachstop.notify', 'div.notifier', function toggleNavigator() {
153			var notifier = $(this),
154			items = notifier.find(settings.items);
155
156			// Hide navigator
157			if(items.length == 1) {
			0 ignored issues – show Best Practice introduced 2018-04-27 20:50 UTC by Report Bug Copy Issue Report Comparing `items.length` to `1` using the `==` operator is not safe. Consider using `===` instead. Loading history...
158			items.find('nav').hide();
159			}
160
161			// Show navigator
162			else {
163			items.find('nav').show();
164			}
165			});
166
167			// Next message
168			objects.on('click', 'nav', function switchMessage() {
169			var notifier = $(this).closest('div.notifier');
170
171			// Move messages
172			notifier.trigger('move.notify');
173			});
174
175			// Move messages
176			objects.on('move.notify', 'div.notifier', function moveMessage() {
177			var notifier = $(this),
178			current = notifier.find('.active'),
179			next = current.next(settings.items),
180			from = current.outerHeight(),
181			offset;
182
183			notifier.trigger('movestart.notify');
184
185			// Deactivate current message
186			current.removeClass('active');
187
188			// Activate next message and get offset
189			if(next.length > 0) {
190			next.addClass('active');
191			offset = notifier.scrollTop() + from;
192			}
193			else {
194			next = notifier.find(settings.items).first().addClass('active');
195			offset = 0;
196			}
197
198			// If next's height is not the same, resize first
199			if(next.outerHeight() !== from) {
200			notifier.trigger('resize.notify');
201			}
202
203			// Move to next message
204			notifier.animate({
205			scrollTop: offset
206			}, 'fast', function stopMovingMessage() {
207			notifier.trigger('movestop.notify');
208			});
209			});
210
211			// Ignore message
212			objects.on('click', 'a.ignore', function ignoreMessage() {
213			var ignore = $(this),
214			item = ignore.parents(settings.items),
215			text = item.text(),
216			storage;
217
218			// Store exclusion rule
219			if(Symphony.Support.localStorage === true) {
220			// Put in a try/catch incase we exceed storage space
221			try {
222			storage = (window.localStorage[settings.storage]) ? $.parseJSON(window.localStorage[settings.storage]) : [];
223			storage.push(text);
224			window.localStorage[settings.storage] = JSON.stringify(storage);
225			}
226			catch(e) {
227			window.onerror(e.message);
228			}
229			}
230
231			// Remove item
232			item.trigger('detach.notify');
233			});
234
235			/*-------------------------------------------------------------------------
236			Initialisation
237			-------------------------------------------------------------------------*/
238
239			// Build interface
240			objects.each(function initNotify() {
241			var object = $(this),
242			notifier = $('<div class="notifier" />').hide().prependTo(object),
243			items = $(object.find(settings.items).get().reverse());
244
245			// Construct notifier
246			notifier.addClass('constructing');
247			notifier.height(items.last().innerHeight());
248			items.each(function buildMessages() {
249			var item = $(this).remove(),
250			message = item.html(),
251			type = item.attr('class');
252
253			object.trigger('attach.notify', [message, type]);
254			});
255
256			// Resize notifier
257			if(notifier.find(settings.items).length > 0) {
258			notifier.removeClass('constructing').trigger('resize.notify');
259			}
260
261			notifier.removeClass('constructing');
262
263			// Update relative times in system messages
264			setInterval(function updateRelativeTimes() {
265			$('header p.notice').symphonyTimeAgo();
266			}, 60000);
267			});
268
269			/-----------------------------------------------------------------------/
270
271			return objects;
272			};
273
274			})(window.jQuery, window.Symphony);
275

symphonycms / symphony-2

GitHub Access Token became invalid

Pull Request — master (#2835)

symphony/assets/js/src/symphony.notify.js A

Complexity

Size

Duplication

Importance

1 Function

Duplication Side-by-Side

Filter issues like