et2_widget_timestamper.js ➔ ... ➔ et2_button.extend._insert_text - Code Metrics - Inspection of "Better handling of target to support custom fields..." - EGroupware/egroupware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.1 ( 1ae5a9...01af42 )

by Nathan

created 2017-11-22 17:19 UTC

➔ et2_button.extend._insert_text F

↳ Parent: et2_widget_timestamper.js ➔ ???

Complexity

Conditions	18
Paths	576

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
cc	18
c	4
b	1
f	0
nc	576
nop	0
dl	0
loc	86
rs	2.4991

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();

		return false;
	},

	_insert_text: function() {
		var text = "";
		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 widget = this._get_input(this.target);
		var input = widget.input ? widget.input : widget.getDOMNode();
		if(input.context)
		{
			input = input.get(0);
		}

		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;
			input.focus();
		}
		// If on a tab, switch to that tab so user can see it
		var tab = widget;
		while(tab._parent && tab._type != 'tabbox')
		{
			tab = tab._parent;
		}
		if (tab._type == 'tabbox') tab.activateTab(widget);
	},

	_get_input: function _get_input(target)
	{
		var input = null;
		var widget = null;

		if (typeof target == 'string')
		{
			widget = this.getRoot().getWidgetById(target);
		}
		else if (target.instanceOf && target.instanceOf(et2_IInput))
		{
			widget = target;
		}
		else if(typeof target == 'string' && target.indexOf('#') < 0 && jQuery('#'+this.target).is('input'))
		{
			input = this.target;
		}
		if(widget)
		{
			return widget;
		}
		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			return false;
63			},
64
65			_insert_text: function() {
66			var text = "";
67			var now = new Date();
68			text += date(egw.preference('dateformat') + ' ' + (egw.preference("timeformat") === "12" ? "h:ia" : "H:i")+' ',now);
69
70			// Get properly formatted user name
71			var user = parseInt(egw.user('account_id'));
72			var accounts = egw.accounts('accounts');
73			for(var j = 0; j < accounts.length; j++)
74			{
75			if(accounts[j].value === user)
76			{
77			text += accounts[j].label;
78			break;
79			}
80			}
81			text += ': ';
82
83			var widget = this._get_input(this.target);
84			var input = widget.input ? widget.input : widget.getDOMNode();
85			if(input.context)
86			{
87			input = input.get(0);
88			}
89
90			var scrollPos = input.scrollTop;
91			var browser = ((input.selectionStart \|\| input.selectionStart == "0") ?
92			"standards" : (document.selection ? "ie" : false ) );
93
94			var pos = 0;
95			var CK = CKEDITOR && CKEDITOR.instances[input.id] \|\| false;
96
97			// Find cursor or selection
98			if (browser == "ie")
99			{
100			input.focus();
101			var range = document.selection.createRange();
102			range.moveStart ("character", -input.value.length);
103			pos = range.text.length;
104			}
105			else if (browser == "standards")
106			{
107			pos = input.selectionStart;
108			};
109
110			// If CKEDitor, update it
111			if(CKEDITOR && CKEDITOR.instances[input.id])
112			{
113			CKEDITOR.instances[input.id].insertText(text);
114			window.setTimeout(function() {
115			CKEDITOR.instances[input.id].focus();
116			}, 10);
117			}
118			else
119			{
120			// Insert the text
121			var front = (input.value).substring(0, pos);
122			var back = (input.value).substring(pos, input.value.length);
123			input.value = front+text+back;
124
125			// Clean up a little
126			pos = pos + text.length;
127			if (browser == "ie") {
128			input.focus();
129			var range = document.selection.createRange();
130			range.moveStart ("character", -input.value.length);
131			range.moveStart ("character", pos);
132			range.moveEnd ("character", 0);
133			range.select();
134			}
135			else if (browser == "standards") {
136			input.selectionStart = pos;
137			input.selectionEnd = pos;
138			input.focus();
139			}
140			input.scrollTop = scrollPos;
141			input.focus();
142			}
143			// If on a tab, switch to that tab so user can see it
144			var tab = widget;
145			while(tab._parent && tab._type != 'tabbox')
146			{
147			tab = tab._parent;
148			}
149			if (tab._type == 'tabbox') tab.activateTab(widget);
150			},
151
152			_get_input: function _get_input(target)
153			{
154			var input = null;
155			var widget = null;
156
157			if (typeof target == 'string')
158			{
159			widget = this.getRoot().getWidgetById(target);
160			}
161			else if (target.instanceOf && target.instanceOf(et2_IInput))
162			{
163			widget = target;
164			}
165			else if(typeof target == 'string' && target.indexOf('#') < 0 && jQuery('#'+this.target).is('input'))
166			{
167			input = this.target;
168			}
169			if(widget)
170			{
171			return widget;
172			}
173			if(input.context)
174			{
175			input = input.get(0);
176			}
177			return input;
178			}
179			});}).call(this);
180			et2_register_widget(et2_timestamper, ["button-timestamp", "timestamper"]);

EGroupware / egroupware

Push — 16.1 ( 1ae5a9...01af42 )

➔ et2_button.extend._insert_text F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like