10724001319

Committed 05 Sep 2024 04:03PM UTC coverage: 82.62% (-0.05%) from 82.671%

Build # 10724001319

Build Type

Pull #499

github

Committed by

web-flow

Commit Message

Merge dd73b3b71 into e7cfda55c

Pull Request Pull Request #499: Refactor categorySearch.js to address SonarCloud warnings

Run Details

9983 of 13512 branches covered (73.88%)

Branch coverage included in aggregate %.

48 of 66 new or added lines in 3 files covered. (72.73%)

3 existing lines in 3 files now uncovered.

22375 of 25653 relevant lines covered (87.22%)

1628.69 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

68.47

/public/src/modules/categorySearch.js

'use strict';

console.log('OMAR_GHABAYEN - categorySearch.js - START');
module.exports = function (alerts, bootstrap, api, utils, app, $, ajaxify) {
        const categorySearch = {};

        categorySearch.init = function (el, options) {
                options = initializeOptions(options);
                const searchEl = initializeSearchElement(el);
                if (!searchEl) return;

                const toggleVisibility = shouldToggleVisibility(searchEl);
                setupEventHandlers(el, searchEl, toggleVisibility, options);
        };

        function initializeOptions(options) {
                options = options || {};
                options.privilege = options.privilege || 'topics:read';
                options.states = options.states || ['watching', 'tracking', 'notwatching', 'ignoring'];
                options.cacheList = options.hasOwnProperty('cacheList') ? options.cacheList : true;
                options.selectedCids = options.selectedCids || ajaxify.data.selectedCids || [];
                return options;
        }

        function initializeSearchElement(el) {
                return el.find('[component="category-selector-search"]');
        }

        function shouldToggleVisibility(searchEl) {
                return searchEl.parent('[component="category/dropdown"]').length > 0 ||
            searchEl.parent('[component="category-selector"]').length > 0;
        }

        function setupEventHandlers(el, searchEl, toggleVisibility, options) {
                const localCategories = initializeLocalCategories(options);

                el.on('show.bs.dropdown', () => onShowDropdown(el, searchEl, toggleVisibility, options, localCategories));
                el.on('shown.bs.dropdown', () => onShownDropdown(searchEl));
                el.on('hide.bs.dropdown', () => onHideDropdown(el, searchEl, toggleVisibility));
        }

        function initializeLocalCategories(options) {
                return Array.isArray(options.localCategories) ?
                        options.localCategories.map(c => ({ ...c })) :
                        [];
        }

        function onShowDropdown(el, searchEl, toggleVisibility, options, localCategories) {
                if (toggleVisibility) {
                        toggleSearchVisibility(el, searchEl);
                }
                setupSearch(searchEl, options, localCategories);
        }

        function toggleSearchVisibility(el, searchEl) {
                el.find('.dropdown-toggle').css({ visibility: 'hidden' });
                searchEl.removeClass('hidden').css({
                        'z-index': el.find('.dropdown-toggle').css('z-index') + 1,
                });
        }

        function setupSearch(searchEl, options, localCategories) {
                const doSearch = createSearchFunction(searchEl, options, localCategories);
                searchEl.on('click', handleSearchClick);
                searchEl.find('input').val('').on('keyup', utils.debounce(doSearch, 300));
                doSearch();
        }

        function handleSearchClick(ev) {
                ev.preventDefault();
                ev.stopPropagation();
        }

        function createSearchFunction(searchEl, options, localCategories) {
                let categoriesList = null;
                return function () {
                        const val = searchEl.find('input').val();
                        if (val.length > 1 || (!val && !categoriesList)) {
                                loadList(val, options, localCategories, (categories) => {
                                        categoriesList = options.cacheList ? (categoriesList || categories) : categories;
                                        renderList(categories, options);
                                });
                        } else if (!val && categoriesList) {
                                renderList(categoriesList, options);
                        }
                };
        }

        function onShownDropdown(searchEl) {
                if (!['xs', 'sm'].includes(utils.findBootstrapEnvironment())) {
                        searchEl.find('input').focus();
                }
        }

        function onHideDropdown(el, searchEl, toggleVisibility) {
                if (toggleVisibility) {
                        resetVisibility(el, searchEl);
                }
                searchEl.off('click');
                searchEl.find('input').off('keyup');
        }

        function resetVisibility(el, searchEl) {
                el.find('.dropdown-toggle').css({ visibility: 'inherit' });
                searchEl.addClass('hidden');
        }

        function loadList(search, options, localCategories, callback) {
                api.get('/search/categories', {
                        search: search,
                        query: utils.params(),
                        parentCid: options.parentCid || 0,
                        selectedCids: options.selectedCids,
                        privilege: options.privilege,
                        states: options.states,
                        showLinks: options.showLinks,
                }, function (err, { categories }) {
                        if (err) {
                                return alerts.error(err);
                        }
                        callback(localCategories.concat(categories));
                });
        }

        function renderList(categories, options) {
                const selectedCids = options.selectedCids.map(String);
                categories.forEach(function (c) {
                        c.selected = selectedCids.includes(String(c.cid));
                });

                app.parseAndTranslate(options.template, {
                        categoryItems: categories.slice(0, 200),
                        selectedCategory: ajaxify.data.selectedCategory,
                        allCategoriesUrl: ajaxify.data.allCategoriesUrl,
                }, function (html) {
                        updateDOM(html, categories);
                });
        }

        function updateDOM(html, categories) {
                const el = $('[component="category/list"]');
                el.html(html.find('[component="category/list"]').html());
                el.find('[component="category/no-matches"]').toggleClass('hidden', !!categories.length);
                const dropdownToggle = $('.dropdown-toggle').get(0);
                const bsDropdown = bootstrap.Dropdown.getInstance(dropdownToggle);
                if (bsDropdown) {
                        bsDropdown.update();
                }
        }
        console.log('OMAR_GHABAYEN - categorySearch.js - END');
        return categorySearch;
};

1	'use strict';
2
3	console.log('OMAR_GHABAYEN - categorySearch.js - START');	1✔
4	module.exports = function (alerts, bootstrap, api, utils, app, $, ajaxify) {	1✔
5	const categorySearch = {};	1✔
6
7	categorySearch.init = function (el, options) {	1✔
8	options = initializeOptions(options);	1✔
9	const searchEl = initializeSearchElement(el);	1✔
10	if (!searchEl) return;	1!
11
12	const toggleVisibility = shouldToggleVisibility(searchEl);	1✔
13	setupEventHandlers(el, searchEl, toggleVisibility, options);	1✔
14	};
15
16	function initializeOptions(options) {
17	options = options \|\| {};	1!
18	options.privilege = options.privilege \|\| 'topics:read';	1✔
19	options.states = options.states \|\| ['watching', 'tracking', 'notwatching', 'ignoring'];	1✔
20	options.cacheList = options.hasOwnProperty('cacheList') ? options.cacheList : true;	1!
21	options.selectedCids = options.selectedCids \|\| ajaxify.data.selectedCids \|\| [];	1!
22	return options;	1✔
23	}
24
25	function initializeSearchElement(el) {
26	return el.find('[component="category-selector-search"]');	1✔
27	}
28
29	function shouldToggleVisibility(searchEl) {
30	return searchEl.parent('[component="category/dropdown"]').length > 0 \|\|	1✔
31	searchEl.parent('[component="category-selector"]').length > 0;
32	}
33
34	function setupEventHandlers(el, searchEl, toggleVisibility, options) {
35	const localCategories = initializeLocalCategories(options);	1✔
36
37	el.on('show.bs.dropdown', () => onShowDropdown(el, searchEl, toggleVisibility, options, localCategories));	1✔
38	el.on('shown.bs.dropdown', () => onShownDropdown(searchEl));	1✔
39	el.on('hide.bs.dropdown', () => onHideDropdown(el, searchEl, toggleVisibility));	1✔
40	}
41
42	function initializeLocalCategories(options) {
43	return Array.isArray(options.localCategories) ?	1!
NEW 44	options.localCategories.map(c => ({ ...c })) :	×
45	[];
46	}
47
48	function onShowDropdown(el, searchEl, toggleVisibility, options, localCategories) {
49	if (toggleVisibility) {	1!
NEW 50	toggleSearchVisibility(el, searchEl);	×
51	}
52	setupSearch(searchEl, options, localCategories);	1✔
53	}
54
55	function toggleSearchVisibility(el, searchEl) {
NEW 56	el.find('.dropdown-toggle').css({ visibility: 'hidden' });	×
NEW 57	searchEl.removeClass('hidden').css({	×
58	'z-index': el.find('.dropdown-toggle').css('z-index') + 1,
59	});
60	}
61
62	function setupSearch(searchEl, options, localCategories) {
63	const doSearch = createSearchFunction(searchEl, options, localCategories);	1✔
64	searchEl.on('click', handleSearchClick);	1✔
65	searchEl.find('input').val('').on('keyup', utils.debounce(doSearch, 300));	1✔
66	doSearch();	1✔
67	}
68
69	function handleSearchClick(ev) {
NEW 70	ev.preventDefault();	×
NEW 71	ev.stopPropagation();	×
72	}
73
74	function createSearchFunction(searchEl, options, localCategories) {
75	let categoriesList = null;	1✔
76	return function () {	1✔
77	const val = searchEl.find('input').val();	2✔
78	if (val.length > 1 \|\| (!val && !categoriesList)) {	2!
79	loadList(val, options, localCategories, (categories) => {	2✔
80	categoriesList = options.cacheList ? (categoriesList \|\| categories) : categories;	2!
81	renderList(categories, options);	2✔
82	});
NEW 83	} else if (!val && categoriesList) {	×
NEW 84	renderList(categoriesList, options);	×
85	}
86	};
87	}
88
89	function onShownDropdown(searchEl) {
NEW 90	if (!['xs', 'sm'].includes(utils.findBootstrapEnvironment())) {	×
NEW 91	searchEl.find('input').focus();	×
92	}
93	}
94
95	function onHideDropdown(el, searchEl, toggleVisibility) {
NEW 96	if (toggleVisibility) {	×
NEW 97	resetVisibility(el, searchEl);	×
98	}
NEW 99	searchEl.off('click');	×
NEW 100	searchEl.find('input').off('keyup');	×
101	}
102
103	function resetVisibility(el, searchEl) {
NEW 104	el.find('.dropdown-toggle').css({ visibility: 'inherit' });	×
NEW 105	searchEl.addClass('hidden');	×
106	}
107
108	function loadList(search, options, localCategories, callback) {
109	api.get('/search/categories', {	2✔
110	search: search,
111	query: utils.params(),
112	parentCid: options.parentCid \|\| 0,	4✔
113	selectedCids: options.selectedCids,
114	privilege: options.privilege,
115	states: options.states,
116	showLinks: options.showLinks,
117	}, function (err, { categories }) {
118	if (err) {	2!
NEW 119	return alerts.error(err);	×
120	}
121	callback(localCategories.concat(categories));	2✔
122	});
123	}
124
125	function renderList(categories, options) {
126	const selectedCids = options.selectedCids.map(String);	2✔
127	categories.forEach(function (c) {	2✔
128	c.selected = selectedCids.includes(String(c.cid));	2✔
129	});
130
131	app.parseAndTranslate(options.template, {	2✔
132	categoryItems: categories.slice(0, 200),
133	selectedCategory: ajaxify.data.selectedCategory,
134	allCategoriesUrl: ajaxify.data.allCategoriesUrl,
135	}, function (html) {
136	updateDOM(html, categories);	2✔
137	});
138	}
139
140	function updateDOM(html, categories) {
141	const el = $('[component="category/list"]');	2✔
142	el.html(html.find('[component="category/list"]').html());	2✔
143	el.find('[component="category/no-matches"]').toggleClass('hidden', !!categories.length);	2✔
144	const dropdownToggle = $('.dropdown-toggle').get(0);	2✔
145	const bsDropdown = bootstrap.Dropdown.getInstance(dropdownToggle);	2✔
146	if (bsDropdown) {	2!
147	bsDropdown.update();	2✔
148	}
149	}
150	console.log('OMAR_GHABAYEN - categorySearch.js - END');	1✔
151	return categorySearch;	1✔
152	};

CMU-313 / NodeBB / 10724001319

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous