controls/js/src/kirki.setting.js - Code Metrics - Inspection of "3.0.17" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1653)

by Aristeides

created 2017-12-03 16:17 UTC

controls/js/src/kirki.setting.js A

↳ Parent: Project

Complexity

Total Complexity	21
Complexity/F	4.2

Size

Lines of Code	152
Function Count	5

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	0
nc	8
dl	0
loc	152
rs	10
c	0
b	0
f	0
wmc	21
mnd	3
bc	21
fnc	5
bpm	4.2
cpm	4.2
noi	10

2 Functions

Rating	Name	Duplication	Size	Complexity
C	jQuery.extend.setting.set	0	82	10
B	jQuery.extend.setting.get	0	29	1

var kirki = kirki || {};
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console
kirki = jQuery.extend( kirki, {
	/**
	 * An object containing definitions for settings.
	 *
	 * @since 3.0.16
	 */
	setting: {

		/**
		 * Gets the value of a setting.
		 *
		 * This is a helper function that allows us to get the value of
		 * control[key1][key2] for example, when the setting used in the
		 * customizer API is "control".
		 *
		 * @since 3.0.16
		 * @param {string} setting - The setting for which we're getting the value.
		 * @returns {mixed} Depends on the value.
		 */
		get: function( setting ) {
			var parts        = setting.split( '[' ),
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console
			    foundSetting = '',
			    foundInStep  = 0,
			    currentVal   = '';

			_.each( parts, function( part, i ) {
				part = part.replace( ']', '' );


				if ( 0 === i ) {
					foundSetting = part;
				} else {
					foundSetting += '[' + part + ']';
				}

				if ( ! _.isUndefined( wp.customize.instance( foundSetting ) ) ) {
					currentVal  = wp.customize.instance( foundSetting ).get();
					foundInStep = i;
				}

				if ( foundInStep < i ) {
					if ( _.isObject( currentVal ) && ! _.isUndefined( currentVal[ part ] ) ) {
						currentVal = currentVal[ part ];
					}
				}
			});

			return currentVal;
		},

		/**
		 * Sets the value of a setting.
		 *
		 * This function is a bit complicated because there any many scenarios to consider.
		 * Example: We want to save the value for my_setting[something][3][something-else].
		 * The control's setting is my_setting[something].
		 * So we need to find that first, then figure out the remaining parts,
		 * merge the values recursively to avoid destroying my_setting[something][2]
		 * and also take into account any defined "key" arguments which take this even deeper.
		 *
		 * @since 3.0.16
		 * @param {object|string} element - The DOM element whose value has changed,
		 *                                  or an ID.
		 * @param {mixed}         value - Depends on the control-type.
		 * @param {string}        key - If we only want to save an item in an object
		 *                                  we can define the key here.
		 * @returns {null}
		 */
		set: function( element, value, key ) {
			var setting,
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console
			    parts,
			    currentNode   = '',
			    foundNode     = '',
			    subSettingObj = {},

			    currentVal,
			    subSetting,
			    subSettingParts;

			// Get the setting from the element.
			setting = element;
			if ( _.isObject( element ) ) {
				if ( jQuery( element ).attr( 'data-id' ) ) {
					setting = element.attr( 'data-id' );
				} else {
					setting = element.parents( '[data-id]' ).attr( 'data-id' );
				}
			}

			if ( 'undefined' !== typeof wp.customize.control( setting ) ) {
				wp.customize.control( setting ).setting.set( value );
				return;
			}

			parts = setting.split( '[' ),
var a,b,c;

a = 1, b = 1,  c= 3;

			// Find the setting we're using in the control using the customizer API.
			_.each( parts, function( part, i ) {
				part = part.replace( ']', '' );


				// The current part of the setting.
				currentNode = ( 0 === i ) ? part : '[' + part + ']';

				// When we find the node, get the value from it.
				// In case of an object we'll need to merge with current values.
				if ( ! _.isUndefined( wp.customize.instance( currentNode ) ) ) {
					foundNode  = currentNode;
					currentVal = wp.customize.instance( foundNode ).get();
				}
			} );

			// Get the remaining part of the setting that was unused.
			subSetting = setting.replace( foundNode, '' );

			// If subSetting is not empty, then we're dealing with an object
			// and we need to dig deeper and recursively merge the values.
			if ( '' !== subSetting ) {
				if ( ! _.isObject( currentVal ) ) {
					currentVal = {};
				}
				if ( '[' === subSetting.charAt( 0 ) ) {
					subSetting = subSetting.replace( '[', '' );
				}
				subSettingParts = subSetting.split( '[' );
				_.each( subSettingParts, function( subSettingPart, i ) {
					subSettingParts[ i ] = subSettingPart.replace( ']', '' );
				} );

				// If using a key, we need to go 1 level deeper.
				if ( key ) {
					subSettingParts.push( key );
				}

				// Converting to a JSON string and then parsing that to an object
				// may seem a bit hacky and crude but it's efficient and works.
				subSettingObj = '{"' + subSettingParts.join( '":{"' ) + '":"' + value + '"' + '}'.repeat( subSettingParts.length );
				subSettingObj = JSON.parse( subSettingObj );

				// Recursively merge with current value.
				jQuery.extend( true, currentVal, subSettingObj );

				value = currentVal;


			} else {
				if ( key ) {
					currentVal = ( ! _.isObject( currentVal ) ) ? {} : currentVal;
					currentVal[ key ] = value;
					value = currentVal;
				}
			}
			wp.customize.control( foundNode ).setting.set( value );
		}
	}
} );


1			var kirki = kirki \|\| {};
			0 ignored issues – show Coding Style introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report As per coding-style, prefer block-scoped variables using `let` or `const` which have better semantics than `var`. Since ECMAScript 6, you can create block-scoped vars or constants with the keywords `let` or `const`. These variables/constants are only valid in the code block where they have been declared. Consider the following two pieces of code: if (true) { var x = "Hello, Stonehenge!"; } console.log(x); //prints Hello, Stonehenge! to the console and if (true) { let x = "Hello, Stonehenge!"; } console.log(x); //ReferenceError: x is not defined The variable is not defined otuside of its block. This limits bleeding of variables into other contexts. To know more about this ECMA6 feature, look at the MDN pages on let and const. Loading history... Bug introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report The variable `kirki` seems to be never initialized. Loading history...
2			kirki = jQuery.extend( kirki, {
3			/**
4			* An object containing definitions for settings.
5			*
6			* @since 3.0.16
7			*/
8			setting: {
9
10			/**
11			* Gets the value of a setting.
12			*
13			* This is a helper function that allows us to get the value of
14			* control[key1][key2] for example, when the setting used in the
15			* customizer API is "control".
16			*
17			* @since 3.0.16
18			* @param {string} setting - The setting for which we're getting the value.
19			* @returns {mixed} Depends on the value.
20			*/
21			get: function( setting ) {
22			var parts = setting.split( '[' ),
			0 ignored issues – show Coding Style introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report As per coding-style, prefer block-scoped variables using `let` or `const` which have better semantics than `var`. Since ECMAScript 6, you can create block-scoped vars or constants with the keywords `let` or `const`. These variables/constants are only valid in the code block where they have been declared. Consider the following two pieces of code: if (true) { var x = "Hello, Stonehenge!"; } console.log(x); //prints Hello, Stonehenge! to the console and if (true) { let x = "Hello, Stonehenge!"; } console.log(x); //ReferenceError: x is not defined The variable is not defined otuside of its block. This limits bleeding of variables into other contexts. To know more about this ECMA6 feature, look at the MDN pages on let and const. Loading history...
23			foundSetting = '',
24			foundInStep = 0,
25			currentVal = '';
26
27			_.each( parts, function( part, i ) {
28			part = part.replace( ']', '' );
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report This re-assigns to the parameter `part`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history...
29
30			if ( 0 === i ) {
31			foundSetting = part;
32			} else {
33			foundSetting += '[' + part + ']';
34			}
35
36			if ( ! _.isUndefined( wp.customize.instance( foundSetting ) ) ) {
37			currentVal = wp.customize.instance( foundSetting ).get();
38			foundInStep = i;
39			}
40
41			if ( foundInStep < i ) {
42			if ( _.isObject( currentVal ) && ! _.isUndefined( currentVal[ part ] ) ) {
43			currentVal = currentVal[ part ];
44			}
45			}
46			});
47
48			return currentVal;
49			},
50
51			/**
52			* Sets the value of a setting.
53			*
54			* This function is a bit complicated because there any many scenarios to consider.
55			* Example: We want to save the value for my_setting[something][3][something-else].
56			* The control's setting is my_setting[something].
57			* So we need to find that first, then figure out the remaining parts,
58			* merge the values recursively to avoid destroying my_setting[something][2]
59			* and also take into account any defined "key" arguments which take this even deeper.
60			*
61			* @since 3.0.16
62			* @param {object\|string} element - The DOM element whose value has changed,
63			* or an ID.
64			* @param {mixed} value - Depends on the control-type.
65			* @param {string} key - If we only want to save an item in an object
66			* we can define the key here.
67			* @returns {null}
68			*/
69			set: function( element, value, key ) {
70			var setting,
			0 ignored issues – show Coding Style introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report As per coding-style, prefer block-scoped variables using `let` or `const` which have better semantics than `var`. Since ECMAScript 6, you can create block-scoped vars or constants with the keywords `let` or `const`. These variables/constants are only valid in the code block where they have been declared. Consider the following two pieces of code: if (true) { var x = "Hello, Stonehenge!"; } console.log(x); //prints Hello, Stonehenge! to the console and if (true) { let x = "Hello, Stonehenge!"; } console.log(x); //ReferenceError: x is not defined The variable is not defined otuside of its block. This limits bleeding of variables into other contexts. To know more about this ECMA6 feature, look at the MDN pages on let and const. Loading history...
71			parts,
72			currentNode = '',
73			foundNode = '',
74			subSettingObj = {},
			0 ignored issues – show Unused Code introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report The assignment to variable `subSettingObj` seems to be never used. Consider removing it. Loading history...
75			currentVal,
76			subSetting,
77			subSettingParts;
78
79			// Get the setting from the element.
80			setting = element;
81			if ( _.isObject( element ) ) {
82			if ( jQuery( element ).attr( 'data-id' ) ) {
83			setting = element.attr( 'data-id' );
84			} else {
85			setting = element.parents( '[data-id]' ).attr( 'data-id' );
86			}
87			}
88
89			if ( 'undefined' !== typeof wp.customize.control( setting ) ) {
90			wp.customize.control( setting ).setting.set( value );
91			return;
92			}
93
94			parts = setting.split( '[' ),
			0 ignored issues – show Comprehensibility introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report Usage of the sequence operator is discouraged, since it may lead to obfuscated code. The sequence or comma operator allows the inclusion of multiple expressions where only is permitted. The result of the sequence is the value of the last expression. This operator is most often used in `for` statements. Used in another places it can make code hard to read, especially when people do not realize it even exists as a seperate operator. This check looks for usage of the sequence operator in locations where it is not necessary and could be replaced by a series of expressions or statements. var a,b,c; a = 1, b = 1, c= 3; could just as well be written as: var a,b,c; a = 1; b = 1; c = 3; To learn more about the sequence operator, please refer to the MDN. Loading history...
95
96			// Find the setting we're using in the control using the customizer API.
97			_.each( parts, function( part, i ) {
98			part = part.replace( ']', '' );
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report This re-assigns to the parameter `part`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history...
99
100			// The current part of the setting.
101			currentNode = ( 0 === i ) ? part : '[' + part + ']';
102
103			// When we find the node, get the value from it.
104			// In case of an object we'll need to merge with current values.
105			if ( ! _.isUndefined( wp.customize.instance( currentNode ) ) ) {
106			foundNode = currentNode;
107			currentVal = wp.customize.instance( foundNode ).get();
108			}
109			} );
110
111			// Get the remaining part of the setting that was unused.
112			subSetting = setting.replace( foundNode, '' );
113
114			// If subSetting is not empty, then we're dealing with an object
115			// and we need to dig deeper and recursively merge the values.
116			if ( '' !== subSetting ) {
117			if ( ! _.isObject( currentVal ) ) {
118			currentVal = {};
119			}
120			if ( '[' === subSetting.charAt( 0 ) ) {
121			subSetting = subSetting.replace( '[', '' );
122			}
123			subSettingParts = subSetting.split( '[' );
124			_.each( subSettingParts, function( subSettingPart, i ) {
125			subSettingParts[ i ] = subSettingPart.replace( ']', '' );
126			} );
127
128			// If using a key, we need to go 1 level deeper.
129			if ( key ) {
130			subSettingParts.push( key );
131			}
132
133			// Converting to a JSON string and then parsing that to an object
134			// may seem a bit hacky and crude but it's efficient and works.
135			subSettingObj = '{"' + subSettingParts.join( '":{"' ) + '":"' + value + '"' + '}'.repeat( subSettingParts.length );
136			subSettingObj = JSON.parse( subSettingObj );
137
138			// Recursively merge with current value.
139			jQuery.extend( true, currentVal, subSettingObj );
			0 ignored issues – show Bug introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report The variable `currentVal` does not seem to be initialized in case `!_.isObject(currentVal)` on line `117` is `false`. Are you sure the function `extend` handles `undefined` variables? Loading history...
140			value = currentVal;
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-12-03 13:42 UTC by Report Bug Copy Issue Report This re-assigns to the parameter `value`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history...
141
142			} else {
143			if ( key ) {
144			currentVal = ( ! _.isObject( currentVal ) ) ? {} : currentVal;
145			currentVal[ key ] = value;
146			value = currentVal;
147			}
148			}
149			wp.customize.control( foundNode ).setting.set( value );
150			}
151			}
152			} );
153

aristath / kirki

Pull Request — master (#1653)

controls/js/src/kirki.setting.js A

Complexity

Size

Duplication

Importance

2 Functions

Duplication Side-by-Side

Filter issues like