et2_widget_timestamper.js ➔ ... ➔ et2_button.extend._insert_text - Code Metrics - Inspection of "Fix timestamp button for CKEditor" - EGroupware/egroupware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.1 ( 7ccc73...046888 )

by Nathan

created 2017-09-28 16:42 UTC

➔ et2_button.extend._insert_text C

↳ Parent: et2_widget_timestamper.js ➔ ???

Complexity

Conditions	13
Paths	72

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	13
c	2
b	0
f	0
nc	72
nop	0
dl	0
loc	72
rs	5.5073

How to fix Long Method Complexity

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

If many parameters/temporary variables are present:
- Replace temporary variables with Query
- Introduce parameter object; often combined with preserve whole object
- If the above two are insufficient: Replace method with method object
If you have long conditionals: Decompose Conditional
Otherwise: Extract method

Complexity

Complex classes like et2_widget_timestamper.js ➔ ... ➔ et2_button.extend._insert_text often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

/**
 * EGroupware eTemplate2 - JS Timestamp button object
 *
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 * @package etemplate
 * @subpackage api
 * @link http://www.egroupware.org
 * @author Nathan Gray
 * @copyright Nathan Gray 2017
 */

/*egw:uses
	et2_button;
*/

/**
 * Class which implements the "button-timestamper" XET-Tag
 *
 * Clicking the button puts the current time and current user at the end of
 * the provided field.
 *
 * @augments et2_button
 */
var et2_timestamper = (function(){ "use strict"; return et2_button.extend([],
{
	attributes: {
		target: {
			name: "Target field",
			type: "string",
			default: et2_no_init,
			description: "Which field to place the timestamp in"
		},
		image: {
			default: "timestamp"
		},
		background_image: {
			default: true
		}
	},

	/**
	 * Constructor
	 *
	 * @memberOf et2_button
	 */
	init: function() {
		this._super.apply(this, arguments);
	},

	/**
	 * Overwritten to maintain an internal clicked attribute
	 *
	 * @param _ev
	 * @returns {Boolean}
	 */
	click: function(_ev) {
		// ignore click on readonly button
		if (this.options.readonly) return false;

		this._insert_text();

		if (!this._super.apply(this, arguments))
		{
			return false;
		}

		return true;
	},

	_insert_text: function() {
		var text = "\n";
		var now = new Date();
		text += date(egw.preference('dateformat') + ' ' + (egw.preference("timeformat") === "12" ? "h:ia" : "H:i")+' ',now);

		// Get properly formatted user name
		var user = parseInt(egw.user('account_id'));
		var accounts = egw.accounts('accounts');
		for(var j = 0; j < accounts.length; j++)
		{
			if(accounts[j].value === user)
			{
				text += accounts[j].label;
				break;
			}
		}
		text += ': ';

		var input = this._get_input(this.target);
		var scrollPos = input.scrollTop;
		var browser = ((input.selectionStart || input.selectionStart == "0") ?
			"standards" : (document.selection ? "ie" : false ) );

		var pos = 0;
		var CK = CKEDITOR && CKEDITOR.instances[input.id] || false;

		// Find cursor or selection
		if (browser == "ie")
		{
			input.focus();
			var range = document.selection.createRange();
			range.moveStart ("character", -input.value.length);
			pos = range.text.length;
		}
		else if (browser == "standards")
		{
			pos = input.selectionStart;
		};

		// If CKEDitor, update it
		if(CKEDITOR && CKEDITOR.instances[input.id])
		{
			CKEDITOR.instances[input.id].insertText(text);
			window.setTimeout(function() {
				CKEDITOR.instances[input.id].focus();
			}, 10);
		}
		else
		{
			// Insert the text
			var front = (input.value).substring(0, pos);
			var back = (input.value).substring(pos, input.value.length);
			input.value = front+text+back;

			// Clean up a little
			pos = pos + text.length;
			if (browser == "ie") {
				input.focus();
				var range = document.selection.createRange();
				range.moveStart ("character", -input.value.length);
				range.moveStart ("character", pos);
				range.moveEnd ("character", 0);
				range.select();
			}
			else if (browser == "standards") {
				input.selectionStart = pos;
				input.selectionEnd = pos;
				input.focus();
			}
			input.scrollTop = scrollPos;
		}
	},

	_get_input: function _get_input(target)
	{
		var input = null;
		var widget = null;
		if(jQuery('#'+this.target).is('input'))
		{
			input = this.target;
		}
		else if (typeof target == 'string')
		{
			var widget = this.getRoot().getWidgetById(target);
		}
		else if (target.instanceOf && target.instanceOf(et2_IInput))
		{
			widget = target;
		}
		if(widget)
		{
			input = widget.input ? widget.input : widget.getDOMNode();
		}
		if(input.context)
		{
			input = input.get(0);
		}
		return input;
	}
});}).call(this);
et2_register_widget(et2_timestamper, ["button-timestamp", "timestamper"]);

1			/**
2			* EGroupware eTemplate2 - JS Timestamp button object
3			*
4			* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
5			* @package etemplate
6			* @subpackage api
7			* @link http://www.egroupware.org
8			* @author Nathan Gray
9			* @copyright Nathan Gray 2017
10			*/
11
12			/*egw:uses
13			et2_button;
14			*/
15
16			/**
17			* Class which implements the "button-timestamper" XET-Tag
18			*
19			* Clicking the button puts the current time and current user at the end of
20			* the provided field.
21			*
22			* @augments et2_button
23			*/
24			var et2_timestamper = (function(){ "use strict"; return et2_button.extend([],
25			{
26			attributes: {
27			target: {
28			name: "Target field",
29			type: "string",
30			default: et2_no_init,
31			description: "Which field to place the timestamp in"
32			},
33			image: {
34			default: "timestamp"
35			},
36			background_image: {
37			default: true
38			}
39			},
40
41			/**
42			* Constructor
43			*
44			* @memberOf et2_button
45			*/
46			init: function() {
47			this._super.apply(this, arguments);
48			},
49
50			/**
51			* Overwritten to maintain an internal clicked attribute
52			*
53			* @param _ev
54			* @returns {Boolean}
55			*/
56			click: function(_ev) {
57			// ignore click on readonly button
58			if (this.options.readonly) return false;
59
60			this._insert_text();
61
62			if (!this._super.apply(this, arguments))
63			{
64			return false;
65			}
66
67			return true;
68			},
69
70			_insert_text: function() {
71			var text = "\n";
72			var now = new Date();
73			text += date(egw.preference('dateformat') + ' ' + (egw.preference("timeformat") === "12" ? "h:ia" : "H:i")+' ',now);
74
75			// Get properly formatted user name
76			var user = parseInt(egw.user('account_id'));
77			var accounts = egw.accounts('accounts');
78			for(var j = 0; j < accounts.length; j++)
79			{
80			if(accounts[j].value === user)
81			{
82			text += accounts[j].label;
83			break;
84			}
85			}
86			text += ': ';
87
88			var input = this._get_input(this.target);
89			var scrollPos = input.scrollTop;
90			var browser = ((input.selectionStart \|\| input.selectionStart == "0") ?
91			"standards" : (document.selection ? "ie" : false ) );
92
93			var pos = 0;
94			var CK = CKEDITOR && CKEDITOR.instances[input.id] \|\| false;
95
96			// Find cursor or selection
97			if (browser == "ie")
98			{
99			input.focus();
100			var range = document.selection.createRange();
101			range.moveStart ("character", -input.value.length);
102			pos = range.text.length;
103			}
104			else if (browser == "standards")
105			{
106			pos = input.selectionStart;
107			};
108
109			// If CKEDitor, update it
110			if(CKEDITOR && CKEDITOR.instances[input.id])
111			{
112			CKEDITOR.instances[input.id].insertText(text);
113			window.setTimeout(function() {
114			CKEDITOR.instances[input.id].focus();
115			}, 10);
116			}
117			else
118			{
119			// Insert the text
120			var front = (input.value).substring(0, pos);
121			var back = (input.value).substring(pos, input.value.length);
122			input.value = front+text+back;
123
124			// Clean up a little
125			pos = pos + text.length;
126			if (browser == "ie") {
127			input.focus();
128			var range = document.selection.createRange();
129			range.moveStart ("character", -input.value.length);
130			range.moveStart ("character", pos);
131			range.moveEnd ("character", 0);
132			range.select();
133			}
134			else if (browser == "standards") {
135			input.selectionStart = pos;
136			input.selectionEnd = pos;
137			input.focus();
138			}
139			input.scrollTop = scrollPos;
140			}
141			},
142
143			_get_input: function _get_input(target)
144			{
145			var input = null;
146			var widget = null;
147			if(jQuery('#'+this.target).is('input'))
148			{
149			input = this.target;
150			}
151			else if (typeof target == 'string')
152			{
153			var widget = this.getRoot().getWidgetById(target);
154			}
155			else if (target.instanceOf && target.instanceOf(et2_IInput))
156			{
157			widget = target;
158			}
159			if(widget)
160			{
161			input = widget.input ? widget.input : widget.getDOMNode();
162			}
163			if(input.context)
164			{
165			input = input.get(0);
166			}
167			return input;
168			}
169			});}).call(this);
170			et2_register_widget(et2_timestamper, ["button-timestamp", "timestamper"]);

EGroupware / egroupware

Push — 16.1 ( 7ccc73...046888 )

➔ et2_button.extend._insert_text C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like