Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move (most) javascript out of jelly files #76

Merged
merged 1 commit into from
Jul 4, 2023
Merged

Move (most) javascript out of jelly files #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 1 addition & 64 deletions src/main/resources/org/biouno/unochoice/CascadeChoiceParameter/index.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,70 +18,7 @@
if (window.makeStaplerProxy) {
window.makeStaplerProxy = window.__old__makeStaplerProxy;
}
// find the cascade parameter element
var parentDiv = jQuery('#${h.escape(paramName)}');
var parameterHtmlElement = parentDiv.find('DIV');
if (!parameterHtmlElement || parameterHtmlElement.length == 0) {
console.log('Could not find element by name, perhaps it is a DIV?');
parameterHtmlElement = parentDiv.find('*[name="value"]');
}
if (parameterHtmlElement && parameterHtmlElement.get(0)) {
var cascadeParameter = new UnoChoice.CascadeParameter('${h.escape(it.getName())}', parameterHtmlElement.get(0), '${h.escape(it.getRandomName())}', cascadeChoiceParameter);
UnoChoice.cascadeParameters.push(cascadeParameter);
// filter
<j:if test="${it.filterable}">
var filterHtmlElement = parentDiv.find('.uno_choice_filter');
if (filterHtmlElement &amp;&amp; filterHtmlElement.get(0)) {
var filterElement = new UnoChoice.FilterElement(parameterHtmlElement.get(0), filterHtmlElement.get(0), ${it.getFilterLength()});
cascadeParameter.setFilterElement(filterElement);
} else {
console.log('Filter error: Missing filter element!');
}
</j:if>

for (var i = 0; i &lt; referencedParameters.length ; ++i) {
var parameterElement = null;
// FIXME: review the block below
var divs = jQuery('div[name="parameter"]');
for (var j = 0; j &lt; divs.length ; j++) {
var div = divs[j];
var hiddenNames = jQuery(div).find('input[name="name"]');
if (hiddenNames[0].value == referencedParameters[i]) {
var children = div.children;
for (var k = 0; k &lt; children.length; ++k) {
var child = children[k];
if (child.getAttribute('name') == 'value') {
parameterElement = child;
break;
} else if (child.tagName == 'DIV' || child.tagName == 'SPAN') {
var subValues = jQuery(child).find('input[name="value"]');
if (subValues &amp;&amp; subValues.get(0)) {
parameterElement = child;
break;
} else {
parameterElement = child;
break;
}
} else if (child.getAttribute('type') == 'file') {
parameterElement = child;
break;
} else if (child.tagName === 'INPUT' &amp;&amp; !['', 'name'].includes(child.name)) {
parameterElement = child;
break;
}
}
}
}

new UnoChoice.ReferencedParameter(referencedParameters[i], parameterElement, cascadeParameter);
}

// call update methods in Java passing the HTML values
console.log('Updating cascade of parameter [${h.escape(it.getName())}] ...');
cascadeParameter.update();
} else {
console.log('Parameter error: Missing parameter [${h.escape(paramName)}] HTML element!');
}
UnoChoice.renderCascadeChoiceParameter('#${h.escape(paramName)}', ${it.filterable}, '${h.escape(it.getName())}', '${h.escape(it.getRandomName())}', ${it.getFilterLength()}, '${h.escape(paramName)}', referencedParameters, cascadeChoiceParameter);

</script>
</j:jelly>
18 changes: 1 addition & 17 deletions src/main/resources/org/biouno/unochoice/ChoiceParameter/index.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,7 @@
<st:include page="/org/biouno/unochoice/common/choiceParameterCommon.jelly"/>
<script type="text/javascript">
<j:if test="${it.filterable}">
var parentDiv = jQuery('#${paramName}');
var parameterHtmlElement = parentDiv.find('DIV');
if (!parameterHtmlElement || parameterHtmlElement.length == 0) {
console.log('Could not find element by name, perhaps it is a DIV?');
parameterHtmlElement = parentDiv.find('*[name="value"]');
}
if (parameterHtmlElement &amp;&amp; parameterHtmlElement.get(0)) {
var filterHtmlElement = parentDiv.find('.uno_choice_filter');
if (filterHtmlElement &amp;&amp; filterHtmlElement.get(0)) {
filterElement = new UnoChoice.FilterElement(parameterHtmlElement.get(0), filterHtmlElement.get(0), ${it.getFilterLength()});
parameterHtmlElement.filterElement = filterElement; // TBD: not very elegant
} else {
console.log('Filter error: Missing filter element!');
}
} else {
console.log('Filter error: Missing parameter element!');
}
UnoChoice.renderChoiceParameter('${paramName}', ${it.getFilterLength()});
</j:if>
</script>
</j:jelly>
81 changes: 1 addition & 80 deletions src/main/resources/org/biouno/unochoice/DynamicReferenceParameter/index.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,85 +68,6 @@
if (window.makeStaplerProxy) {
window.makeStaplerProxy = window.__old__makeStaplerProxy;
}
// find the cascade parameter element
var parentDiv = jQuery('#${paramName}');
// if the parameter class has been set to hidden, then we hide it now
if (parentDiv.get(0).getAttribute('class') === 'hidden_uno_choice_parameter') {
var parentTbody = jQuery(parentDiv.get(0)).parents('tbody');
// FIXME: temporary fix to support both TABLE and DIV in the Jenkins UI
// remove after most users have migrated to newer versions with DIVs
if (!parentTbody || parentTbody.length === 0) {
parentTbody = jQuery(parentDiv.get(0)).parents('div > div.tr');
}
if (parentTbody &amp;&amp; parentTbody.length > 0) {
jQuery(parentTbody.get(0)).attr('style', 'visibility:hidden;position:absolute;');
}
}
var parameterHtmlElement = null;
for(var i = 0; i &lt; parentDiv.children().length; i++) {
var child = parentDiv.children()[i];
if (child.getAttribute('name') === 'value' || child.id.indexOf('ecp_') &gt; -1) {
parameterHtmlElement = jQuery(child);
break;
}
if (child.id.indexOf('inputElement_') &gt; -1) {
parameterHtmlElement = jQuery(child);
break;
}
if (child.id.indexOf('formattedHtml_') &gt; -1) {
parameterHtmlElement = jQuery(child);
break;
}
if (child.id.indexOf('imageGallery_') &gt; -1) {
parameterHtmlElement = jQuery(child);
break;
}
}
if (parameterHtmlElement &amp;&amp; parameterHtmlElement.get(0)) {
var dynamicParameter = new UnoChoice.DynamicReferenceParameter('${h.escape(it.getName())}', parameterHtmlElement.get(0), dynamicReferenceParameter);
UnoChoice.cascadeParameters.push(dynamicParameter); // TODO review whether it is right or not to add a dynamic parameter here
for (var i = 0; i &lt; referencedParameters.length ; ++i) {
var parameterElement = null;
// FIXME: review the block below
var divs = jQuery('div[name="parameter"]');
for (var j = 0; j &lt; divs.length ; j++) {
var div = divs[j];
var hiddenNames = jQuery(div).find('input[name="name"]');
if (hiddenNames[0].value === referencedParameters[i]) {
var children = div.children;
for (var k = 0; k &lt; children.length; ++k) {
var child = children[k];
if (child.getAttribute('name') === 'value') {
parameterElement = child;
break;
} else if (child.tagName === 'DIV' || child.tagName === 'SPAN') {
var subValues = jQuery(child).find('input[name="value"]');
if (subValues &amp;&amp; subValues.get(0)) {
parameterElement = child;
break;
} else {
parameterElement = child;
break;
}
} else if (child.getAttribute('type') === 'file') {
parameterElement = child;
break;
} else if (child.tagName === 'INPUT' &amp;&amp; !['', 'name'].includes(child.name)) {
parameterElement = child;
break;
}
}
}
}

new UnoChoice.ReferencedParameter(referencedParameters[i], parameterElement, dynamicParameter);
}

// call update methods in Java passing the HTML values
console.log('Updating cascade of parameter [${h.escape(it.getName())}] ...');
dynamicParameter.update();
} else {
console.log('Parameter error: Missing parameter [${h.escape(paramName)}] HTML element!');
}
UnoChoice.renderDynamicRenderParameter('#${paramName}', '${h.escape(it.getName())}', '${h.escape(paramName)}', referencedParameters, dynamicReferenceParameter);
</script>
</j:jelly>
174 changes: 173 additions & 1 deletion src/main/resources/org/biouno/unochoice/stapler/unochoice/UnoChoice.es6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ var UnoChoice = UnoChoice || ($ => {
$(".behavior-loading").show();
// start updating in separate async function so browser will be able to repaint and show 'loading' animation , see JENKINS-34487
setTimeout(() => {
_self.cascadeParameter.update();
_self.cascadeParameter.update(false);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other changes were easier to review. This one is the only one I didn't understand straight away. Could you explain why the false added here?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about that. The default value was undefined which was interpreted as false. This makes it explicit.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to apologize! I suspected you would have a reason for doing that. Thanks for the explanation. LGTM! 💥

$(".behavior-loading").hide();
}, 0);
}
Expand Down Expand Up @@ -818,6 +818,175 @@ var UnoChoice = UnoChoice || ($ => {
return proxy;
}

function renderChoiceParameter(paramName, filterLength) {
let parentDiv = $(`#${paramName}`);
let parameterHtmlElement = parentDiv.find('DIV');
if (!parameterHtmlElement || parameterHtmlElement.length === 0) {
console.log('Could not find element by name, perhaps it is a DIV?');
parameterHtmlElement = parentDiv.find('*[name="value"]');
}
if (parameterHtmlElement && parameterHtmlElement.get(0)) {
let filterHtmlElement = parentDiv.find('.uno_choice_filter');
if (filterHtmlElement && filterHtmlElement.get(0)) {
parameterHtmlElement.filterElement = new UnoChoice.FilterElement(parameterHtmlElement.get(0), filterHtmlElement.get(0), filterLength); // TBD: not very elegant
} else {
console.log('Filter error: Missing filter element!');
}
} else {
console.log('Filter error: Missing parameter element!');
}
}

function renderCascadeChoiceParameter(parentDivRef, filterable, name, randomName, filterLength, paramName, referencedParameters, cascadeChoiceParameter) {
// find the cascade parameter element
let parentDiv = jQuery(parentDivRef);
let parameterHtmlElement = parentDiv.find('DIV');
if (!parameterHtmlElement || parameterHtmlElement.length === 0) {
console.log('Could not find element by name, perhaps it is a DIV?');
parameterHtmlElement = parentDiv.find('*[name="value"]');
}
if (parameterHtmlElement && parameterHtmlElement.get(0)) {
let cascadeParameter = new UnoChoice.CascadeParameter(name, parameterHtmlElement.get(0), randomName, cascadeChoiceParameter);
UnoChoice.cascadeParameters.push(cascadeParameter);
// filter
if (filterable) {
let filterHtmlElement = parentDiv.find('.uno_choice_filter');
if (filterHtmlElement && filterHtmlElement.get(0)) {
let filterElement = new UnoChoice.FilterElement(parameterHtmlElement.get(0), filterHtmlElement.get(0), filterLength);
cascadeParameter.setFilterElement(filterElement);
} else {
console.log('Filter error: Missing filter element!');
}
}

for (let i = 0; i < referencedParameters.length ; ++i) {
let parameterElement = null;
// FIXME: review the block below
let divs = jQuery('div[name="parameter"]');
for (let j = 0; j < divs.length ; j++) {
let div = divs[j];
let hiddenNames = jQuery(div).find('input[name="name"]');
if (hiddenNames[0].value === referencedParameters[i]) {
let children = div.children;
for (let k = 0; k < children.length; ++k) {
let child = children[k];
if (child.getAttribute('name') === 'value') {
parameterElement = child;
break;
} else if (child.tagName === 'DIV' || child.tagName === 'SPAN') {
let subValues = jQuery(child).find('input[name="value"]');
if (subValues && subValues.get(0)) {
parameterElement = child;
break;
} else {
parameterElement = child;
break;
}
} else if (child.getAttribute('type') === 'file') {
parameterElement = child;
break;
} else if (child.tagName === 'INPUT' && !['', 'name'].includes(child.name)) {
parameterElement = child;
break;
}
}
}
}

new UnoChoice.ReferencedParameter(referencedParameters[i], parameterElement, cascadeParameter);
}

// call update methods in Java passing the HTML values
console.log('Updating cascade of parameter [', name, '] ...');
cascadeParameter.update(false);
} else {
console.log('Parameter error: Missing parameter [', paramName, '] HTML element!');
}
}

function renderDynamicRenderParameter(parentDivRef, name, paramName, referencedParameters, dynamicReferenceParameter) {
// find the cascade parameter element
let parentDiv = jQuery(parentDivRef);
// if the parameter class has been set to hidden, then we hide it now
if (parentDiv.get(0).getAttribute('class') === 'hidden_uno_choice_parameter') {
let parentTbody = jQuery(parentDiv.get(0)).parents('tbody');
// FIXME: temporary fix to support both TABLE and DIV in the Jenkins UI
// remove after most users have migrated to newer versions with DIVs
if (!parentTbody || parentTbody.length === 0) {
parentTbody = jQuery(parentDiv.get(0)).parents('div > div.tr');
}
if (parentTbody && parentTbody.length > 0) {
jQuery(parentTbody.get(0)).attr('style', 'visibility:hidden;position:absolute;');
}
}
let parameterHtmlElement = null;
for(let i = 0; i < parentDiv.children().length; i++) {
let child = parentDiv.children()[i];
if (child.getAttribute('name') === 'value' || child.id.indexOf('ecp_') > -1) {
parameterHtmlElement = jQuery(child);
break;
}
if (child.id.indexOf('inputElement_') > -1) {
parameterHtmlElement = jQuery(child);
break;
}
if (child.id.indexOf('formattedHtml_') > -1) {
parameterHtmlElement = jQuery(child);
break;
}
if (child.id.indexOf('imageGallery_') > -1) {
parameterHtmlElement = jQuery(child);
break;
}
}
if (parameterHtmlElement && parameterHtmlElement.get(0)) {
let dynamicParameter = new UnoChoice.DynamicReferenceParameter(name, parameterHtmlElement.get(0), dynamicReferenceParameter);
UnoChoice.cascadeParameters.push(dynamicParameter); // TODO review whether it is right or not to add a dynamic parameter here
for (let i = 0; i < referencedParameters.length ; ++i) {
let parameterElement = null;
// FIXME: review the block below
let divs = jQuery('div[name="parameter"]');
for (let j = 0; j < divs.length ; j++) {
let div = divs[j];
let hiddenNames = jQuery(div).find('input[name="name"]');
if (hiddenNames[0].value === referencedParameters[i]) {
let children = div.children;
for (let k = 0; k < children.length; ++k) {
let child = children[k];
if (child.getAttribute('name') === 'value') {
parameterElement = child;
break;
} else if (child.tagName === 'DIV' || child.tagName === 'SPAN') {
let subValues = jQuery(child).find('input[name="value"]');
if (subValues && subValues.get(0)) {
parameterElement = child;
break;
} else {
parameterElement = child;
break;
}
} else if (child.getAttribute('type') === 'file') {
parameterElement = child;
break;
} else if (child.tagName === 'INPUT' && !['', 'name'].includes(child.name)) {
parameterElement = child;
break;
}
}
}
}

new UnoChoice.ReferencedParameter(referencedParameters[i], parameterElement, dynamicParameter);
}

// call update methods in Java passing the HTML values
console.log('Updating cascade of parameter [', name, '] ...');
dynamicParameter.update(false);
} else {
console.log('Parameter error: Missing parameter [', paramName,'] HTML element!');
}
}

// Deciding on what is exported and returning instance
instance.fakeSelectRadioButton = fakeSelectRadioButton;
instance.getParameterValue = getParameterValue;
Expand All @@ -827,6 +996,9 @@ var UnoChoice = UnoChoice || ($ => {
instance.FilterElement = FilterElement;
instance.makeStaplerProxy2 = makeStaplerProxy2;
instance.cascadeParameters = cascadeParameters;
instance.renderChoiceParameter = renderChoiceParameter;
instance.renderCascadeChoiceParameter = renderCascadeChoiceParameter;
instance.renderDynamicRenderParameter = renderDynamicRenderParameter;
return instance;
})(jQuery3);
window.UnoChoice = UnoChoice;