modules/field-dependencies/field-dependencies.js - Code Metrics - Inspection of "3.0.34" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1930)

by Aristeides

created 2018-06-24 00:01 UTC

modules/field-dependencies/field-dependencies.js F

↳ Parent: Project

Complexity

Total Complexity	61
Complexity/F	4.07

Size

Lines of Code	210
Function Count	15

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes	6
Bugs	4	Features	0

Metric	Value
cc	0
nc	1
dl	0
loc	210
rs	3.52
c	6
b	4
f	0
wmc	61
mnd	3
bc	44
fnc	15
bpm	2.9333
cpm	4.0666
noi	9

5 Functions

Rating	Name	Size	Complexity
A	$(document).ready	3	1
A	kirkiDependencies.init	30	1
B	kirkiDependencies.showKirkiControl	30	7
F	kirkiDependencies.evaluate	65	28
C	kirkiDependencies.checkCondition	49	11

How to fix Complexity

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

console.log(x); //prints Hello, Stonehenge! to the console

	listenTo: {},

	init: function() {
		var self = this;
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console

		wp.customize.control.each( function( control ) {
			self.showKirkiControl( control );
		} );

		_.each( self.listenTo, function( slaves, master ) {
			_.each( slaves, function( slave ) {
				wp.customize( master, function( setting ) {
					var setupControl = function( control ) {
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console
						var setActiveState,
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console
							isDisplayed;

						isDisplayed = function() {
							return self.showKirkiControl( wp.customize.control( slave ) );
						};
						setActiveState = function() {
							control.active.set( isDisplayed() );
						};

						setActiveState();
						setting.bind( setActiveState );
						control.active.validate = isDisplayed;
					};
					wp.customize.control( slave, setupControl );
				} );
			} );
		} );
	},

	/**
	 * Should we show the control?
	 *
	 * @since 3.0.17
	 * @param {string|object} control - The control-id or the control object.
	 * @returns {bool}
	 */
	showKirkiControl: function( control ) {
		var self     = this,
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console
			show     = true,
			isOption = (
				control.params && // Check if control.params exists.
				control.params.kirkiOptionType &&  // Check if option_type exists.
				'option' === control.params.kirkiOptionType &&  // We're using options.
				control.params.kirkiOptionName && // Check if option_name exists.
				! _.isEmpty( control.params.kirkiOptionName ) // Check if option_name is not empty.
			),
			i;


		if ( _.isString( control ) ) {
			control = wp.customize.control( control );

		}

		// Exit early if control not found or if "required" argument is not defined.
		if ( 'undefined' === typeof control || ( control.params && _.isEmpty( control.params.required ) ) ) {
			return true;
		}

		// Loop control requirements.
		for ( i = 0; i < control.params.required.length; i++ ) {
			if ( ! self.checkCondition( control.params.required[ i ], control, isOption, 'AND' ) ) {
				show = false;
			}
		}
		return show;
	},

	/**
	 * Check a condition.
	 *
	 * @param {Object} requirement - The requirement, inherited from showKirkiControl.
	 * @param {Object} control - The control object.
	 * @param {bool}   isOption - Whether it's an option or not.
	 * @param {string} relation - Can be one of 'AND' or 'OR'.
	 */
	checkCondition: function( requirement, control, isOption, relation ) {
		var self          = this,
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console
			childRelation = ( 'AND' === relation ) ? 'OR' : 'AND',
			nestedItems,
			i;

		// Tweak for using active callbacks with serialized options instead of theme_mods.
		if ( isOption && requirement.setting ) {

			// Make sure we don't already have the option_name in there.
			if ( -1 === requirement.setting.indexOf( control.params.kirkiOptionName + '[' ) ) {
				requirement.setting = control.params.kirkiOptionName + '[' + requirement.setting + ']';
			}
		}

		// If an array of other requirements nested, we need to process them separately.
		if ( 'undefined' !== typeof requirement[0] && 'undefined' === typeof requirement.setting ) {
			nestedItems = [];

			// Loop sub-requirements.
			for ( i = 0; i < requirement.length; i++ ) {
				nestedItems.push( self.checkCondition( requirement[ i ], control, isOption, childRelation ) );
			}

			// OR relation. Check that true is part of the array.
			if ( 'OR' === childRelation ) {
				return ( -1 !== nestedItems.indexOf( true ) );
			}

			// AND relation. Check that false is not part of the array.
			return ( -1 === nestedItems.indexOf( false ) );
		}

		// Early exit if setting is not defined.
		if ( 'undefined' === typeof wp.customize.control( requirement.setting ) ) {
			return true;
		}

		self.listenTo[ requirement.setting ] = self.listenTo[ requirement.setting ] || [];
		if ( -1 === self.listenTo[ requirement.setting ].indexOf( control.id ) ) {
			self.listenTo[ requirement.setting ].push( control.id );
		}

		return self.evaluate(
			requirement.value,
			wp.customize.control( requirement.setting ).setting._value,
			requirement.operator
		);
	},

	/**
	 * Figure out if the 2 values have the relation we want.
	 *
	 * @since 3.0.17
	 * @param {mixed} value1 - The 1st value.
	 * @param {mixed} value2 - The 2nd value.
	 * @param {string} operator - The comparison to use.
	 * @returns {bool}
	 */
	evaluate: function( value1, value2, operator ) {
		var found = false;
if (true)
 {
    var x = "Hello, Stonehenge!";
}

console.log(x); //prints Hello, Stonehenge! to the console

		if ( '===' === operator ) {
			return value1 === value2;
		}
		if ( '==' === operator || '=' === operator || 'equals' === operator || 'equal' === operator ) {
			return value1 == value2;
		}
		if ( '!==' === operator ) {
			return value1 !== value2;
		}
		if ( '!=' === operator || 'not equal' === operator ) {
			return value1 != value2;
		}
		if ( '>=' === operator || 'greater or equal' === operator || 'equal or greater' === operator ) {
			return value2 >= value1;
		}
		if ( '<=' === operator || 'smaller or equal' === operator || 'equal or smaller' === operator ) {
			return value2 <= value1;
		}
		if ( '>' === operator || 'greater' === operator ) {
			return value2 > value1;
		}
		if ( '<' === operator || 'smaller' === operator ) {
			return value2 < value1;
		}
		if ( 'contains' === operator || 'in' === operator ) {
			if ( _.isArray( value1 ) && _.isArray( value2 ) ) {
				_.each( value2, function( value ) {
					if ( value1.includes( value ) ) {
function isBig(a) {
    if (a > 5000) {
        return "yes";
    }
}

console.log(isBig(5001)); //returns yes
console.log(isBig(42)); //returns undefined
						found = true;
						return false;
					}
                } );
				return found;
			}
			if ( _.isArray( value2 ) ) {
				_.each( value2, function( value ) {
					if ( value == value1 ) { // jshint ignore:line
						found = true;
					}
				} );
				return found;
			}
			if ( _.isObject( value2 ) ) {
				if ( ! _.isUndefined( value2[ value1 ] ) ) {
					found = true;
				}
				_.each( value2, function( subValue ) {
					if ( value1 === subValue ) {
						found = true;
					}
				} );
				return found;
			}
			if ( _.isString( value2 ) ) {
				if ( _.isString( value1 ) ) {
					return ( -1 < value1.indexOf( value2 ) && -1 < value2.indexOf( value1 ) );
				}
				return -1 < value1.indexOf( value2 );
			}
		}
		return value1 == value2;
	}
};

jQuery( document ).ready( function() {
	kirkiDependencies.init();
} );


1			var kirkiDependencies = {
			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...
2
3			listenTo: {},
4
5			init: function() {
6			var self = this;
			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...
7
8			wp.customize.control.each( function( control ) {
9			self.showKirkiControl( control );
10			} );
11
12			_.each( self.listenTo, function( slaves, master ) {
13			_.each( slaves, function( slave ) {
14			wp.customize( master, function( setting ) {
15			var setupControl = function( control ) {
			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...
16			var setActiveState,
			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...
17			isDisplayed;
18
19			isDisplayed = function() {
20			return self.showKirkiControl( wp.customize.control( slave ) );
21			};
22			setActiveState = function() {
23			control.active.set( isDisplayed() );
24			};
25
26			setActiveState();
27			setting.bind( setActiveState );
28			control.active.validate = isDisplayed;
29			};
30			wp.customize.control( slave, setupControl );
31			} );
32			} );
33			} );
34			},
35
36			/**
37			* Should we show the control?
38			*
39			* @since 3.0.17
40			* @param {string\|object} control - The control-id or the control object.
41			* @returns {bool}
42			*/
43			showKirkiControl: function( control ) {
44			var self = this,
			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...
45			show = true,
46			isOption = (
47			control.params && // Check if control.params exists.
48			control.params.kirkiOptionType && // Check if option_type exists.
49			'option' === control.params.kirkiOptionType && // We're using options.
50			control.params.kirkiOptionName && // Check if option_name exists.
51			! _.isEmpty( control.params.kirkiOptionName ) // Check if option_name is not empty.
52			),
53			i;
54
55
56			if ( _.isString( control ) ) {
57			control = wp.customize.control( control );
			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 `control`. Re-assigning to parameters often makes code less readable, consider introducing a new variable instead. Loading history...
58			}
59
60			// Exit early if control not found or if "required" argument is not defined.
61			if ( 'undefined' === typeof control \|\| ( control.params && _.isEmpty( control.params.required ) ) ) {
62			return true;
63			}
64
65			// Loop control requirements.
66			for ( i = 0; i < control.params.required.length; i++ ) {
67			if ( ! self.checkCondition( control.params.required[ i ], control, isOption, 'AND' ) ) {
68			show = false;
69			}
70			}
71			return show;
72			},
73
74			/**
75			* Check a condition.
76			*
77			* @param {Object} requirement - The requirement, inherited from showKirkiControl.
78			* @param {Object} control - The control object.
79			* @param {bool} isOption - Whether it's an option or not.
80			* @param {string} relation - Can be one of 'AND' or 'OR'.
81			*/
82			checkCondition: function( requirement, control, isOption, relation ) {
83			var self = this,
			0 ignored issues – show Coding Style introduced 2018-03-11 18:04 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...
84			childRelation = ( 'AND' === relation ) ? 'OR' : 'AND',
85			nestedItems,
86			i;
87
88			// Tweak for using active callbacks with serialized options instead of theme_mods.
89			if ( isOption && requirement.setting ) {
90
91			// Make sure we don't already have the option_name in there.
92			if ( -1 === requirement.setting.indexOf( control.params.kirkiOptionName + '[' ) ) {
93			requirement.setting = control.params.kirkiOptionName + '[' + requirement.setting + ']';
94			}
95			}
96
97			// If an array of other requirements nested, we need to process them separately.
98			if ( 'undefined' !== typeof requirement[0] && 'undefined' === typeof requirement.setting ) {
99			nestedItems = [];
100
101			// Loop sub-requirements.
102			for ( i = 0; i < requirement.length; i++ ) {
103			nestedItems.push( self.checkCondition( requirement[ i ], control, isOption, childRelation ) );
104			}
105
106			// OR relation. Check that true is part of the array.
107			if ( 'OR' === childRelation ) {
108			return ( -1 !== nestedItems.indexOf( true ) );
109			}
110
111			// AND relation. Check that false is not part of the array.
112			return ( -1 === nestedItems.indexOf( false ) );
113			}
114
115			// Early exit if setting is not defined.
116			if ( 'undefined' === typeof wp.customize.control( requirement.setting ) ) {
117			return true;
118			}
119
120			self.listenTo[ requirement.setting ] = self.listenTo[ requirement.setting ] \|\| [];
121			if ( -1 === self.listenTo[ requirement.setting ].indexOf( control.id ) ) {
122			self.listenTo[ requirement.setting ].push( control.id );
123			}
124
125			return self.evaluate(
126			requirement.value,
127			wp.customize.control( requirement.setting ).setting._value,
128			requirement.operator
129			);
130			},
131
132			/**
133			* Figure out if the 2 values have the relation we want.
134			*
135			* @since 3.0.17
136			* @param {mixed} value1 - The 1st value.
137			* @param {mixed} value2 - The 2nd value.
138			* @param {string} operator - The comparison to use.
139			* @returns {bool}
140			*/
141			evaluate: function( value1, value2, operator ) {
142			var found = false;
			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...
143
144			if ( '===' === operator ) {
145			return value1 === value2;
146			}
147			if ( '==' === operator \|\| '=' === operator \|\| 'equals' === operator \|\| 'equal' === operator ) {
148			return value1 == value2;
149			}
150			if ( '!==' === operator ) {
151			return value1 !== value2;
152			}
153			if ( '!=' === operator \|\| 'not equal' === operator ) {
154			return value1 != value2;
155			}
156			if ( '>=' === operator \|\| 'greater or equal' === operator \|\| 'equal or greater' === operator ) {
157			return value2 >= value1;
158			}
159			if ( '<=' === operator \|\| 'smaller or equal' === operator \|\| 'equal or smaller' === operator ) {
160			return value2 <= value1;
161			}
162			if ( '>' === operator \|\| 'greater' === operator ) {
163			return value2 > value1;
164			}
165			if ( '<' === operator \|\| 'smaller' === operator ) {
166			return value2 < value1;
167			}
168			if ( 'contains' === operator \|\| 'in' === operator ) {
169			if ( _.isArray( value1 ) && _.isArray( value2 ) ) {
170			_.each( value2, function( value ) {
171			if ( value1.includes( value ) ) {
			0 ignored issues – show Complexity Best Practice introduced 2018-03-11 09:25 UTC by Report Bug Copy Issue Report There is no return statement if `value1.includes(value)` is `false`. Are you sure this is correct? If so, consider adding `return;` explicitly. This check looks for functions where a `return` statement is found in some execution paths, but not in all. Consider this little piece of code function isBig(a) { if (a > 5000) { return "yes"; } } console.log(isBig(5001)); //returns yes console.log(isBig(42)); //returns undefined The function `isBig` will only return a specific value when its parameter is bigger than 5000. In any other case, it will implicitly return `undefined`. This behaviour may not be what you had intended. In any case, you can add a `return undefined` to the other execution path to make the return value explicit. Loading history...
172			found = true;
173			return false;
174			}
175			} );
176			return found;
177			}
178			if ( _.isArray( value2 ) ) {
179			_.each( value2, function( value ) {
180			if ( value == value1 ) { // jshint ignore:line
181			found = true;
182			}
183			} );
184			return found;
185			}
186			if ( _.isObject( value2 ) ) {
187			if ( ! _.isUndefined( value2[ value1 ] ) ) {
188			found = true;
189			}
190			_.each( value2, function( subValue ) {
191			if ( value1 === subValue ) {
192			found = true;
193			}
194			} );
195			return found;
196			}
197			if ( _.isString( value2 ) ) {
198			if ( _.isString( value1 ) ) {
199			return ( -1 < value1.indexOf( value2 ) && -1 < value2.indexOf( value1 ) );
200			}
201			return -1 < value1.indexOf( value2 );
202			}
203			}
204			return value1 == value2;
205			}
206			};
207
208			jQuery( document ).ready( function() {
209			kirkiDependencies.init();
210			} );
211

aristath / kirki

Pull Request — master (#1930)

modules/field-dependencies/field-dependencies.js F

Complexity

Size

Duplication

Importance

5 Functions

How to fix Complexity

Complexity

Duplication Side-by-Side

Filter issues like