Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

Merged
archmoj merged 14 commits into from
Jun 17, 2020
Merged

Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template #4904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
bddaafa
allow template input in Lib.coerce2 - fix issue 4852
archmoj Jun 5, 2020
11fd23c
update axes_breaks-round-weekdaysm baseline
archmoj Jun 5, 2020
756a0ee
refactor coerce rename v to valIn
archmoj Jun 7, 2020
a2c1c93
refactor coerce rename out to valOut
archmoj Jun 7, 2020
8d0b4cb
exit early
archmoj Jun 7, 2020
5c3be81
rename propOut to valOut
archmoj Jun 7, 2020
642bf28
add internal _coerce function
archmoj Jun 7, 2020
57cec14
reduce condition checks
archmoj Jun 8, 2020
1d9cc4a
keep track of source and input in _coerce function
archmoj Jun 9, 2020
cf7c061
fixup Lib.coerce2 description and color test
archmoj Jun 10, 2020
21b86cd
add jasmine tests to cover invalid inputs in Lib.coerce2
archmoj Jun 10, 2020
2b911d1
make room for opts - rename opts to attr
archmoj Jun 16, 2020
adc36cd
validate input when calling from coerce2
archmoj Jun 16, 2020
24d1da9
remove unnecessary validation, also
archmoj Jun 17, 2020
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
69 changes: 46 additions & 23 deletions src/lib/coerce.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
* as a convenience, returns the value it finally set
*/
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
var opts = nestedProperty(attributes, attribute).get();
return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
var shouldValidate = (opts || {}).shouldValidate;

var attr = nestedProperty(attributes, attribute).get();
if(dflt === undefined) dflt = attr.dflt;
var src = false;

var propIn = nestedProperty(containerIn, attribute);
var propOut = nestedProperty(containerOut, attribute);
var v = propIn.get();
var valIn = propIn.get();

var template = containerOut._template;
if(v === undefined && template) {
v = nestedProperty(template, attribute).get();
if(valIn === undefined && template) {
valIn = nestedProperty(template, attribute).get();
src = (valIn !== undefined);

// already used the template value, so short-circuit the second check
template = 0;
}

if(dflt === undefined) dflt = opts.dflt;

/**
* arrayOk: value MAY be an array, then we do no value checking
* at this point, because it can be more complicated than the
* individual form (eg. some array vals can be numbers, even if the
* single values must be color strings)
*/
if(opts.arrayOk && isArrayOrTypedArray(v)) {
propOut.set(v);
return v;
if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
propOut.set(valIn);
return {
inp: valIn,
val: valIn,
src: true
};
}

var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
coerceFunction(v, propOut, dflt, opts);
var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
coerceFunction(valIn, propOut, dflt, attr);

var valOut = propOut.get();
src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

var out = propOut.get();
// in case v was provided but invalid, try the template again so it still
// overrides the regular default
if(template && out === dflt && !validate(v, opts)) {
v = nestedProperty(template, attribute).get();
coerceFunction(v, propOut, dflt, opts);
out = propOut.get();
if(template && valOut === dflt && !validate(valIn, attr)) {
valIn = nestedProperty(template, attribute).get();
coerceFunction(valIn, propOut, dflt, attr);
valOut = propOut.get();

src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
}
return out;
};

return {
inp: valIn,
val: valOut,
src: src
};
}

/**
* Variation on coerce
* useful when setting an attribute to a valid value
* can change the default for another attribute.
*
* Uses coerce to get attribute value if user input is valid,
* returns attribute default if user input it not valid or
* returns false if there is no user input.
*/
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
var propIn = nestedProperty(containerIn, attribute);
var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
var valIn = propIn.get();

return (valIn !== undefined && valIn !== null) ? propOut : false;
var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
shouldValidate: true
});
return (out.src && out.inp !== undefined) ? out.val : false;

@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.

I see we actually do have a test that contradicts one thing I was hoping to "fix":

plotly.js/test/jasmine/tests/lib_test.js

Line 781 in be70865

it('should set and return the default if the user input is not valid',function(){

Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:

should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.

(while we're at it there's a piece of copypasta in that test

plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798 in be70865

expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);
- should be 2 colOut lines and 2 sizeOut lines)

So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:

  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:
    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType

I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2

@archmojarchmojJun 10, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.

@archmojarchmojJun 16, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797
Shouldn't it be

expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');

?

@archmojarchmojJun 16, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.
Please see adc36cd.

};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 42 additions & 38 deletions test/image/mocks/axes_custom-ticks_log-date.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
"layout": {
"width": 500,
"height": 300,
"title": {
"text": "custom ticks on date & log axes"
},
"paper_bgcolor": "lightblue",
"plot_bgcolor": "#ddd",
"yaxis": {
"type": "log",
"tickmode": "array",
"tickvals": [
1,
10,
100
],
"ticktext": [
"one",
"ten",
"one<br>hundred"
],
"gridwidth": 2,
"tickwidth": 15,
"tickcolor": "green",
"gridcolor": "green"
},
"xaxis": {
"type": "date",
"tickmode": "array",
"tickvals": [
"2010-01-16",
"2010-02-14"
],
"ticktext": [
"Jan 16",
"Feb 14"
],
"gridwidth": 10,
"tickwidth": 50,
"tickcolor": "rgba(255,0,0,0.75)",
"gridcolor": "rgba(255,0,0,0.25)"
"template": {
"layout": {
"title": {
"text": "custom ticks on date & log axes"
},
"paper_bgcolor": "lightblue",
"plot_bgcolor": "#ddd",
"yaxis": {
"type": "log",
"tickmode": "array",
"tickvals": [
1,
10,
100
],
"ticktext": [
"one",
"ten",
"one<br>hundred"
],
"gridwidth": 2,
"tickwidth": 15,
"tickcolor": "green",
"gridcolor": "green"
},
"xaxis": {
"type": "date",
"tickmode": "array",
"tickvals": [
"2010-01-16",
"2010-02-14"
],
"ticktext": [
"Jan 16",
"Feb 14"
],
"gridwidth": 10,
"tickwidth": 50,
"tickcolor": "rgba(255,0,0,0.75)",
"gridcolor": "rgba(255,0,0,0.25)"
}
}
}
}
}
8 changes: 4 additions & 4 deletions test/jasmine/tests/axes_test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
Plotly.plot(gd, data, layout);

var yaxis = gd._fullLayout.yaxis;
expect(yaxis.ticklen).toBe(5);
expect(yaxis.tickwidth).toBe(1);
expect(yaxis.tickcolor).toBe('#444');
expect(yaxis.ticks).toBe('outside');
expect(yaxis.ticklen).toBe(undefined);
expect(yaxis.tickwidth).toBe(undefined);
expect(yaxis.tickcolor).toBe(undefined);
expect(yaxis.ticks).toBe('');
expect(yaxis.showticklabels).toBe(true);
expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
expect(yaxis.tickangle).toBe('auto');
Expand Down
74 changes: 71 additions & 3 deletions test/jasmine/tests/lib_test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
expect(sizeOut).toBe(outObj.testMarker.testSize);
});

it('should set and return the default if the user input is not valid', function() {
it('should set the default and return false if the user input is not valid', function() {
var colVal = 'r';
var sizeVal = 'aaaaah!';
var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(colOut).toBe(false);
expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(false);
expect(outObj.testMarker.testSize).toBe(20);
});

it('should set the user input', function() {
var colVal = 'red';
var sizeVal = '1e2';
var attrs = {
testMarker: {
testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
testSize: {valType: 'number', dflt: 20}
}
};
var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
var outObj = {};
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe('red');
expect(colOut).toBe(outObj.testMarker.testColor);
expect(sizeOut).toBe(100);
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
});

it('should set to template if the container input is not valid', function() {
var attrs = {
testMarker: {
testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
testSize: {valType: 'number', dflt: 20}
}
};
var obj = {
testMarker: {testColor: 'invalid', testSize: 'invalid'}
};
var outObj = {
_template: {
testMarker: {testColor: 'red', testSize: '1e2'}
}
};
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe('red');
expect(colOut).toBe(outObj.testMarker.testColor);
expect(sizeOut).toBe(100);
expect(sizeOut).toBe(outObj.testMarker.testSize);
});

it('should set to default and return false if the both container and template inputs are not valid', function() {
var attrs = {
testMarker: {
testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
testSize: {valType: 'number', dflt: 20}
}
};
var obj = {
testMarker: {testColor: 'invalid', testSize: 'invalid'}
};
var outObj = {
_template: {
testMarker: {testColor: 'invalid', testSize: 'invalid'}
}
};
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe(false);
expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(false);
expect(outObj.testMarker.testSize).toBe(20);
});

it('should return false if there is no user input', function() {
var colVal = null;
var sizeVal; // undefined
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

 Merged

archmoj
merged 14 commits into

from

Jun 17, 2020
 Merged


Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template
#4904
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
bddaafa

allow template input in Lib.coerce2 - fix issue 4852


archmoj Jun 5, 2020
11fd23c

update axes_breaks-round-weekdaysm baseline


archmoj Jun 5, 2020
756a0ee

refactor coerce rename v to valIn


archmoj Jun 7, 2020
a2c1c93

refactor coerce rename out to valOut


archmoj Jun 7, 2020
8d0b4cb

exit early


archmoj Jun 7, 2020
5c3be81

rename propOut to valOut


archmoj Jun 7, 2020
642bf28

add internal _coerce function


archmoj Jun 7, 2020
57cec14

reduce condition checks


archmoj Jun 8, 2020
1d9cc4a

keep track of source and input in _coerce function


archmoj Jun 9, 2020
cf7c061

fixup Lib.coerce2 description and color test


archmoj Jun 10, 2020
21b86cd

add jasmine tests to cover invalid inputs in Lib.coerce2


archmoj Jun 10, 2020
2b911d1

make room for opts - rename opts to attr


archmoj Jun 16, 2020
adc36cd

validate input when calling from coerce2


archmoj Jun 16, 2020
24d1da9

remove unnecessary validation, also


archmoj Jun 17, 2020

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


69 changes: 46 additions & 23 deletions
src/lib/coerce.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
 * as a convenience, returns the value it finally set
 */
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
 var opts = nestedProperty(attributes, attribute).get();
 return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
 var shouldValidate = (opts || {}).shouldValidate;

 var attr = nestedProperty(attributes, attribute).get();
 if(dflt === undefined) dflt = attr.dflt;
 var src = false;

 var propIn = nestedProperty(containerIn, attribute);
 var propOut = nestedProperty(containerOut, attribute);
 var v = propIn.get();
 var valIn = propIn.get();

 var template = containerOut._template;
 if(v === undefined && template) {
 v = nestedProperty(template, attribute).get();
 if(valIn === undefined && template) {
 valIn = nestedProperty(template, attribute).get();
 src = (valIn !== undefined);

 // already used the template value, so short-circuit the second check
 template = 0;
 }

 if(dflt === undefined) dflt = opts.dflt;

 /**
 * arrayOk: value MAY be an array, then we do no value checking
 * at this point, because it can be more complicated than the
 * individual form (eg. some array vals can be numbers, even if the
 * single values must be color strings)
 */
 if(opts.arrayOk && isArrayOrTypedArray(v)) {
 propOut.set(v);
 return v;
 if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
 propOut.set(valIn);
 return {
 inp: valIn,
 val: valIn,
 src: true
 };
 }

 var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
 coerceFunction(v, propOut, dflt, opts);
 var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
 coerceFunction(valIn, propOut, dflt, attr);

 var valOut = propOut.get();
 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

 var out = propOut.get();
 // in case v was provided but invalid, try the template again so it still
 // overrides the regular default
 if(template && out === dflt && !validate(v, opts)) {
 v = nestedProperty(template, attribute).get();
 coerceFunction(v, propOut, dflt, opts);
 out = propOut.get();
 if(template && valOut === dflt && !validate(valIn, attr)) {
 valIn = nestedProperty(template, attribute).get();
 coerceFunction(valIn, propOut, dflt, attr);
 valOut = propOut.get();

 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
 }
 return out;
};

 return {
 inp: valIn,
 val: valOut,
 src: src
 };
}

/**
 * Variation on coerce
 * useful when setting an attribute to a valid value
 * can change the default for another attribute.
 *
 * Uses coerce to get attribute value if user input is valid,
 * returns attribute default if user input it not valid or
 * returns false if there is no user input.
 */
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
 var propIn = nestedProperty(containerIn, attribute);
 var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
 var valIn = propIn.get();

 return (valIn !== undefined && valIn !== null) ? propOut : false;
 var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
 shouldValidate: true
 });
 return (out.src && out.inp !== undefined) ? out.val : false;
@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.
I see we actually do have a test that contradicts one thing I was hoping to "fix":
plotly.js/test/jasmine/tests/lib_test.js

Line 781
in
be70865
it('should set and return the default if the user input is not valid',function(){
Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:
should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.
(while we're at it there's a piece of copypasta in that test 
plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798
in
be70865
expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);

- should be 2 colOut lines and 2 sizeOut lines)
So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:
  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:

    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType
I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2
@archmojarchmojJun 10, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797

Shouldn't it be
expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');
?
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.

Please see adc36cd.
};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

80 changes: 42 additions & 38 deletions
test/image/mocks/axes_custom-ticks_log-date.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
 "layout": {
 "width": 500,
 "height": 300,
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 "template": {
 "layout": {
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 }
 }
 }
 }
}

8 changes: 4 additions & 4 deletions
test/jasmine/tests/axes_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
 Plotly.plot(gd, data, layout);

 var yaxis = gd._fullLayout.yaxis;
 expect(yaxis.ticklen).toBe(5);
 expect(yaxis.tickwidth).toBe(1);
 expect(yaxis.tickcolor).toBe('#444');
 expect(yaxis.ticks).toBe('outside');
 expect(yaxis.ticklen).toBe(undefined);
 expect(yaxis.tickwidth).toBe(undefined);
 expect(yaxis.tickcolor).toBe(undefined);
 expect(yaxis.ticks).toBe('');
 expect(yaxis.showticklabels).toBe(true);
 expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
 expect(yaxis.tickangle).toBe('auto');
Expand Down

74 changes: 71 additions & 3 deletions
test/jasmine/tests/lib_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set and return the default if the user input is not valid', function() {
 it('should set the default and return false if the user input is not valid', function() {
 var colVal = 'r';
 var sizeVal = 'aaaaah!';
 var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('rgba(0, 0, 0, 0)');
 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should set the user input', function() {
 var colVal = 'red';
 var sizeVal = '1e2';
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
 var outObj = {};
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 expect(sizeOut).toBe(20);
 });

 it('should set to template if the container input is not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'red', testSize: '1e2'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set to default and return false if the both container and template inputs are not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should return false if there is no user input', function() {
 var colVal = null;
 var sizeVal; // undefined
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

 Merged

archmoj
merged 14 commits into

from

Jun 17, 2020
 Merged


Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template
#4904
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
bddaafa

allow template input in Lib.coerce2 - fix issue 4852


archmoj Jun 5, 2020
11fd23c

update axes_breaks-round-weekdaysm baseline


archmoj Jun 5, 2020
756a0ee

refactor coerce rename v to valIn


archmoj Jun 7, 2020
a2c1c93

refactor coerce rename out to valOut


archmoj Jun 7, 2020
8d0b4cb

exit early


archmoj Jun 7, 2020
5c3be81

rename propOut to valOut


archmoj Jun 7, 2020
642bf28

add internal _coerce function


archmoj Jun 7, 2020
57cec14

reduce condition checks


archmoj Jun 8, 2020
1d9cc4a

keep track of source and input in _coerce function


archmoj Jun 9, 2020
cf7c061

fixup Lib.coerce2 description and color test


archmoj Jun 10, 2020
21b86cd

add jasmine tests to cover invalid inputs in Lib.coerce2


archmoj Jun 10, 2020
2b911d1

make room for opts - rename opts to attr


archmoj Jun 16, 2020
adc36cd

validate input when calling from coerce2


archmoj Jun 16, 2020
24d1da9

remove unnecessary validation, also


archmoj Jun 17, 2020

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


69 changes: 46 additions & 23 deletions
src/lib/coerce.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
 * as a convenience, returns the value it finally set
 */
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
 var opts = nestedProperty(attributes, attribute).get();
 return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
 var shouldValidate = (opts || {}).shouldValidate;

 var attr = nestedProperty(attributes, attribute).get();
 if(dflt === undefined) dflt = attr.dflt;
 var src = false;

 var propIn = nestedProperty(containerIn, attribute);
 var propOut = nestedProperty(containerOut, attribute);
 var v = propIn.get();
 var valIn = propIn.get();

 var template = containerOut._template;
 if(v === undefined && template) {
 v = nestedProperty(template, attribute).get();
 if(valIn === undefined && template) {
 valIn = nestedProperty(template, attribute).get();
 src = (valIn !== undefined);

 // already used the template value, so short-circuit the second check
 template = 0;
 }

 if(dflt === undefined) dflt = opts.dflt;

 /**
 * arrayOk: value MAY be an array, then we do no value checking
 * at this point, because it can be more complicated than the
 * individual form (eg. some array vals can be numbers, even if the
 * single values must be color strings)
 */
 if(opts.arrayOk && isArrayOrTypedArray(v)) {
 propOut.set(v);
 return v;
 if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
 propOut.set(valIn);
 return {
 inp: valIn,
 val: valIn,
 src: true
 };
 }

 var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
 coerceFunction(v, propOut, dflt, opts);
 var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
 coerceFunction(valIn, propOut, dflt, attr);

 var valOut = propOut.get();
 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

 var out = propOut.get();
 // in case v was provided but invalid, try the template again so it still
 // overrides the regular default
 if(template && out === dflt && !validate(v, opts)) {
 v = nestedProperty(template, attribute).get();
 coerceFunction(v, propOut, dflt, opts);
 out = propOut.get();
 if(template && valOut === dflt && !validate(valIn, attr)) {
 valIn = nestedProperty(template, attribute).get();
 coerceFunction(valIn, propOut, dflt, attr);
 valOut = propOut.get();

 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
 }
 return out;
};

 return {
 inp: valIn,
 val: valOut,
 src: src
 };
}

/**
 * Variation on coerce
 * useful when setting an attribute to a valid value
 * can change the default for another attribute.
 *
 * Uses coerce to get attribute value if user input is valid,
 * returns attribute default if user input it not valid or
 * returns false if there is no user input.
 */
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
 var propIn = nestedProperty(containerIn, attribute);
 var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
 var valIn = propIn.get();

 return (valIn !== undefined && valIn !== null) ? propOut : false;
 var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
 shouldValidate: true
 });
 return (out.src && out.inp !== undefined) ? out.val : false;
@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.
I see we actually do have a test that contradicts one thing I was hoping to "fix":
plotly.js/test/jasmine/tests/lib_test.js

Line 781
in
be70865
it('should set and return the default if the user input is not valid',function(){
Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:
should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.
(while we're at it there's a piece of copypasta in that test 
plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798
in
be70865
expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);

- should be 2 colOut lines and 2 sizeOut lines)
So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:
  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:

    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType
I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2
@archmojarchmojJun 10, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797

Shouldn't it be
expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');
?
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.

Please see adc36cd.
};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

80 changes: 42 additions & 38 deletions
test/image/mocks/axes_custom-ticks_log-date.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
 "layout": {
 "width": 500,
 "height": 300,
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 "template": {
 "layout": {
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 }
 }
 }
 }
}

8 changes: 4 additions & 4 deletions
test/jasmine/tests/axes_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
 Plotly.plot(gd, data, layout);

 var yaxis = gd._fullLayout.yaxis;
 expect(yaxis.ticklen).toBe(5);
 expect(yaxis.tickwidth).toBe(1);
 expect(yaxis.tickcolor).toBe('#444');
 expect(yaxis.ticks).toBe('outside');
 expect(yaxis.ticklen).toBe(undefined);
 expect(yaxis.tickwidth).toBe(undefined);
 expect(yaxis.tickcolor).toBe(undefined);
 expect(yaxis.ticks).toBe('');
 expect(yaxis.showticklabels).toBe(true);
 expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
 expect(yaxis.tickangle).toBe('auto');
Expand Down

74 changes: 71 additions & 3 deletions
test/jasmine/tests/lib_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set and return the default if the user input is not valid', function() {
 it('should set the default and return false if the user input is not valid', function() {
 var colVal = 'r';
 var sizeVal = 'aaaaah!';
 var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('rgba(0, 0, 0, 0)');
 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should set the user input', function() {
 var colVal = 'red';
 var sizeVal = '1e2';
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
 var outObj = {};
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 expect(sizeOut).toBe(20);
 });

 it('should set to template if the container input is not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'red', testSize: '1e2'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set to default and return false if the both container and template inputs are not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should return false if there is no user input', function() {
 var colVal = null;
 var sizeVal; // undefined
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

 Merged

archmoj
merged 14 commits into

from

Jun 17, 2020
 Merged


Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template
#4904
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
bddaafa

allow template input in Lib.coerce2 - fix issue 4852


archmoj Jun 5, 2020
11fd23c

update axes_breaks-round-weekdaysm baseline


archmoj Jun 5, 2020
756a0ee

refactor coerce rename v to valIn


archmoj Jun 7, 2020
a2c1c93

refactor coerce rename out to valOut


archmoj Jun 7, 2020
8d0b4cb

exit early


archmoj Jun 7, 2020
5c3be81

rename propOut to valOut


archmoj Jun 7, 2020
642bf28

add internal _coerce function


archmoj Jun 7, 2020
57cec14

reduce condition checks


archmoj Jun 8, 2020
1d9cc4a

keep track of source and input in _coerce function


archmoj Jun 9, 2020
cf7c061

fixup Lib.coerce2 description and color test


archmoj Jun 10, 2020
21b86cd

add jasmine tests to cover invalid inputs in Lib.coerce2


archmoj Jun 10, 2020
2b911d1

make room for opts - rename opts to attr


archmoj Jun 16, 2020
adc36cd

validate input when calling from coerce2


archmoj Jun 16, 2020
24d1da9

remove unnecessary validation, also


archmoj Jun 17, 2020

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


69 changes: 46 additions & 23 deletions
src/lib/coerce.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
 * as a convenience, returns the value it finally set
 */
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
 var opts = nestedProperty(attributes, attribute).get();
 return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
 var shouldValidate = (opts || {}).shouldValidate;

 var attr = nestedProperty(attributes, attribute).get();
 if(dflt === undefined) dflt = attr.dflt;
 var src = false;

 var propIn = nestedProperty(containerIn, attribute);
 var propOut = nestedProperty(containerOut, attribute);
 var v = propIn.get();
 var valIn = propIn.get();

 var template = containerOut._template;
 if(v === undefined && template) {
 v = nestedProperty(template, attribute).get();
 if(valIn === undefined && template) {
 valIn = nestedProperty(template, attribute).get();
 src = (valIn !== undefined);

 // already used the template value, so short-circuit the second check
 template = 0;
 }

 if(dflt === undefined) dflt = opts.dflt;

 /**
 * arrayOk: value MAY be an array, then we do no value checking
 * at this point, because it can be more complicated than the
 * individual form (eg. some array vals can be numbers, even if the
 * single values must be color strings)
 */
 if(opts.arrayOk && isArrayOrTypedArray(v)) {
 propOut.set(v);
 return v;
 if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
 propOut.set(valIn);
 return {
 inp: valIn,
 val: valIn,
 src: true
 };
 }

 var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
 coerceFunction(v, propOut, dflt, opts);
 var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
 coerceFunction(valIn, propOut, dflt, attr);

 var valOut = propOut.get();
 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

 var out = propOut.get();
 // in case v was provided but invalid, try the template again so it still
 // overrides the regular default
 if(template && out === dflt && !validate(v, opts)) {
 v = nestedProperty(template, attribute).get();
 coerceFunction(v, propOut, dflt, opts);
 out = propOut.get();
 if(template && valOut === dflt && !validate(valIn, attr)) {
 valIn = nestedProperty(template, attribute).get();
 coerceFunction(valIn, propOut, dflt, attr);
 valOut = propOut.get();

 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
 }
 return out;
};

 return {
 inp: valIn,
 val: valOut,
 src: src
 };
}

/**
 * Variation on coerce
 * useful when setting an attribute to a valid value
 * can change the default for another attribute.
 *
 * Uses coerce to get attribute value if user input is valid,
 * returns attribute default if user input it not valid or
 * returns false if there is no user input.
 */
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
 var propIn = nestedProperty(containerIn, attribute);
 var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
 var valIn = propIn.get();

 return (valIn !== undefined && valIn !== null) ? propOut : false;
 var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
 shouldValidate: true
 });
 return (out.src && out.inp !== undefined) ? out.val : false;
@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.
I see we actually do have a test that contradicts one thing I was hoping to "fix":
plotly.js/test/jasmine/tests/lib_test.js

Line 781
in
be70865
it('should set and return the default if the user input is not valid',function(){
Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:
should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.
(while we're at it there's a piece of copypasta in that test 
plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798
in
be70865
expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);

- should be 2 colOut lines and 2 sizeOut lines)
So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:
  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:

    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType
I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2
@archmojarchmojJun 10, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797

Shouldn't it be
expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');
?
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.

Please see adc36cd.
};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

80 changes: 42 additions & 38 deletions
test/image/mocks/axes_custom-ticks_log-date.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
 "layout": {
 "width": 500,
 "height": 300,
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 "template": {
 "layout": {
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 }
 }
 }
 }
}

8 changes: 4 additions & 4 deletions
test/jasmine/tests/axes_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
 Plotly.plot(gd, data, layout);

 var yaxis = gd._fullLayout.yaxis;
 expect(yaxis.ticklen).toBe(5);
 expect(yaxis.tickwidth).toBe(1);
 expect(yaxis.tickcolor).toBe('#444');
 expect(yaxis.ticks).toBe('outside');
 expect(yaxis.ticklen).toBe(undefined);
 expect(yaxis.tickwidth).toBe(undefined);
 expect(yaxis.tickcolor).toBe(undefined);
 expect(yaxis.ticks).toBe('');
 expect(yaxis.showticklabels).toBe(true);
 expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
 expect(yaxis.tickangle).toBe('auto');
Expand Down

74 changes: 71 additions & 3 deletions
test/jasmine/tests/lib_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set and return the default if the user input is not valid', function() {
 it('should set the default and return false if the user input is not valid', function() {
 var colVal = 'r';
 var sizeVal = 'aaaaah!';
 var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('rgba(0, 0, 0, 0)');
 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should set the user input', function() {
 var colVal = 'red';
 var sizeVal = '1e2';
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
 var outObj = {};
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 expect(sizeOut).toBe(20);
 });

 it('should set to template if the container input is not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'red', testSize: '1e2'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set to default and return false if the both container and template inputs are not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should return false if there is no user input', function() {
 var colVal = null;
 var sizeVal; // undefined
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

 Merged

archmoj
merged 14 commits into

from

Jun 17, 2020
 Merged


Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template
#4904
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
bddaafa

allow template input in Lib.coerce2 - fix issue 4852


archmoj Jun 5, 2020
11fd23c

update axes_breaks-round-weekdaysm baseline


archmoj Jun 5, 2020
756a0ee

refactor coerce rename v to valIn


archmoj Jun 7, 2020
a2c1c93

refactor coerce rename out to valOut


archmoj Jun 7, 2020
8d0b4cb

exit early


archmoj Jun 7, 2020
5c3be81

rename propOut to valOut


archmoj Jun 7, 2020
642bf28

add internal _coerce function


archmoj Jun 7, 2020
57cec14

reduce condition checks


archmoj Jun 8, 2020
1d9cc4a

keep track of source and input in _coerce function


archmoj Jun 9, 2020
cf7c061

fixup Lib.coerce2 description and color test


archmoj Jun 10, 2020
21b86cd

add jasmine tests to cover invalid inputs in Lib.coerce2


archmoj Jun 10, 2020
2b911d1

make room for opts - rename opts to attr


archmoj Jun 16, 2020
adc36cd

validate input when calling from coerce2


archmoj Jun 16, 2020
24d1da9

remove unnecessary validation, also


archmoj Jun 17, 2020

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


69 changes: 46 additions & 23 deletions
src/lib/coerce.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
 * as a convenience, returns the value it finally set
 */
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
 var opts = nestedProperty(attributes, attribute).get();
 return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
 var shouldValidate = (opts || {}).shouldValidate;

 var attr = nestedProperty(attributes, attribute).get();
 if(dflt === undefined) dflt = attr.dflt;
 var src = false;

 var propIn = nestedProperty(containerIn, attribute);
 var propOut = nestedProperty(containerOut, attribute);
 var v = propIn.get();
 var valIn = propIn.get();

 var template = containerOut._template;
 if(v === undefined && template) {
 v = nestedProperty(template, attribute).get();
 if(valIn === undefined && template) {
 valIn = nestedProperty(template, attribute).get();
 src = (valIn !== undefined);

 // already used the template value, so short-circuit the second check
 template = 0;
 }

 if(dflt === undefined) dflt = opts.dflt;

 /**
 * arrayOk: value MAY be an array, then we do no value checking
 * at this point, because it can be more complicated than the
 * individual form (eg. some array vals can be numbers, even if the
 * single values must be color strings)
 */
 if(opts.arrayOk && isArrayOrTypedArray(v)) {
 propOut.set(v);
 return v;
 if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
 propOut.set(valIn);
 return {
 inp: valIn,
 val: valIn,
 src: true
 };
 }

 var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
 coerceFunction(v, propOut, dflt, opts);
 var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
 coerceFunction(valIn, propOut, dflt, attr);

 var valOut = propOut.get();
 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

 var out = propOut.get();
 // in case v was provided but invalid, try the template again so it still
 // overrides the regular default
 if(template && out === dflt && !validate(v, opts)) {
 v = nestedProperty(template, attribute).get();
 coerceFunction(v, propOut, dflt, opts);
 out = propOut.get();
 if(template && valOut === dflt && !validate(valIn, attr)) {
 valIn = nestedProperty(template, attribute).get();
 coerceFunction(valIn, propOut, dflt, attr);
 valOut = propOut.get();

 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
 }
 return out;
};

 return {
 inp: valIn,
 val: valOut,
 src: src
 };
}

/**
 * Variation on coerce
 * useful when setting an attribute to a valid value
 * can change the default for another attribute.
 *
 * Uses coerce to get attribute value if user input is valid,
 * returns attribute default if user input it not valid or
 * returns false if there is no user input.
 */
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
 var propIn = nestedProperty(containerIn, attribute);
 var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
 var valIn = propIn.get();

 return (valIn !== undefined && valIn !== null) ? propOut : false;
 var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
 shouldValidate: true
 });
 return (out.src && out.inp !== undefined) ? out.val : false;
@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.
I see we actually do have a test that contradicts one thing I was hoping to "fix":
plotly.js/test/jasmine/tests/lib_test.js

Line 781
in
be70865
it('should set and return the default if the user input is not valid',function(){
Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:
should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.
(while we're at it there's a piece of copypasta in that test 
plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798
in
be70865
expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);

- should be 2 colOut lines and 2 sizeOut lines)
So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:
  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:

    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType
I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2
@archmojarchmojJun 10, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797

Shouldn't it be
expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');
?
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.

Please see adc36cd.
};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

80 changes: 42 additions & 38 deletions
test/image/mocks/axes_custom-ticks_log-date.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
 "layout": {
 "width": 500,
 "height": 300,
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 "template": {
 "layout": {
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 }
 }
 }
 }
}

8 changes: 4 additions & 4 deletions
test/jasmine/tests/axes_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
 Plotly.plot(gd, data, layout);

 var yaxis = gd._fullLayout.yaxis;
 expect(yaxis.ticklen).toBe(5);
 expect(yaxis.tickwidth).toBe(1);
 expect(yaxis.tickcolor).toBe('#444');
 expect(yaxis.ticks).toBe('outside');
 expect(yaxis.ticklen).toBe(undefined);
 expect(yaxis.tickwidth).toBe(undefined);
 expect(yaxis.tickcolor).toBe(undefined);
 expect(yaxis.ticks).toBe('');
 expect(yaxis.showticklabels).toBe(true);
 expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
 expect(yaxis.tickangle).toBe('auto');
Expand Down

74 changes: 71 additions & 3 deletions
test/jasmine/tests/lib_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set and return the default if the user input is not valid', function() {
 it('should set the default and return false if the user input is not valid', function() {
 var colVal = 'r';
 var sizeVal = 'aaaaah!';
 var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('rgba(0, 0, 0, 0)');
 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should set the user input', function() {
 var colVal = 'red';
 var sizeVal = '1e2';
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
 var outObj = {};
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 expect(sizeOut).toBe(20);
 });

 it('should set to template if the container input is not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'red', testSize: '1e2'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set to default and return false if the both container and template inputs are not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should return false if there is no user input', function() {
 var colVal = null;
 var sizeVal; // undefined
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

 Merged

archmoj
merged 14 commits into

from

Jun 17, 2020
 Merged


Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template
#4904
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
bddaafa

allow template input in Lib.coerce2 - fix issue 4852


archmoj Jun 5, 2020
11fd23c

update axes_breaks-round-weekdaysm baseline


archmoj Jun 5, 2020
756a0ee

refactor coerce rename v to valIn


archmoj Jun 7, 2020
a2c1c93

refactor coerce rename out to valOut


archmoj Jun 7, 2020
8d0b4cb

exit early


archmoj Jun 7, 2020
5c3be81

rename propOut to valOut


archmoj Jun 7, 2020
642bf28

add internal _coerce function


archmoj Jun 7, 2020
57cec14

reduce condition checks


archmoj Jun 8, 2020
1d9cc4a

keep track of source and input in _coerce function


archmoj Jun 9, 2020
cf7c061

fixup Lib.coerce2 description and color test


archmoj Jun 10, 2020
21b86cd

add jasmine tests to cover invalid inputs in Lib.coerce2


archmoj Jun 10, 2020
2b911d1

make room for opts - rename opts to attr


archmoj Jun 16, 2020
adc36cd

validate input when calling from coerce2


archmoj Jun 16, 2020
24d1da9

remove unnecessary validation, also


archmoj Jun 17, 2020

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


69 changes: 46 additions & 23 deletions
src/lib/coerce.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
 * as a convenience, returns the value it finally set
 */
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
 var opts = nestedProperty(attributes, attribute).get();
 return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
 var shouldValidate = (opts || {}).shouldValidate;

 var attr = nestedProperty(attributes, attribute).get();
 if(dflt === undefined) dflt = attr.dflt;
 var src = false;

 var propIn = nestedProperty(containerIn, attribute);
 var propOut = nestedProperty(containerOut, attribute);
 var v = propIn.get();
 var valIn = propIn.get();

 var template = containerOut._template;
 if(v === undefined && template) {
 v = nestedProperty(template, attribute).get();
 if(valIn === undefined && template) {
 valIn = nestedProperty(template, attribute).get();
 src = (valIn !== undefined);

 // already used the template value, so short-circuit the second check
 template = 0;
 }

 if(dflt === undefined) dflt = opts.dflt;

 /**
 * arrayOk: value MAY be an array, then we do no value checking
 * at this point, because it can be more complicated than the
 * individual form (eg. some array vals can be numbers, even if the
 * single values must be color strings)
 */
 if(opts.arrayOk && isArrayOrTypedArray(v)) {
 propOut.set(v);
 return v;
 if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
 propOut.set(valIn);
 return {
 inp: valIn,
 val: valIn,
 src: true
 };
 }

 var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
 coerceFunction(v, propOut, dflt, opts);
 var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
 coerceFunction(valIn, propOut, dflt, attr);

 var valOut = propOut.get();
 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

 var out = propOut.get();
 // in case v was provided but invalid, try the template again so it still
 // overrides the regular default
 if(template && out === dflt && !validate(v, opts)) {
 v = nestedProperty(template, attribute).get();
 coerceFunction(v, propOut, dflt, opts);
 out = propOut.get();
 if(template && valOut === dflt && !validate(valIn, attr)) {
 valIn = nestedProperty(template, attribute).get();
 coerceFunction(valIn, propOut, dflt, attr);
 valOut = propOut.get();

 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
 }
 return out;
};

 return {
 inp: valIn,
 val: valOut,
 src: src
 };
}

/**
 * Variation on coerce
 * useful when setting an attribute to a valid value
 * can change the default for another attribute.
 *
 * Uses coerce to get attribute value if user input is valid,
 * returns attribute default if user input it not valid or
 * returns false if there is no user input.
 */
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
 var propIn = nestedProperty(containerIn, attribute);
 var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
 var valIn = propIn.get();

 return (valIn !== undefined && valIn !== null) ? propOut : false;
 var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
 shouldValidate: true
 });
 return (out.src && out.inp !== undefined) ? out.val : false;
@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.
I see we actually do have a test that contradicts one thing I was hoping to "fix":
plotly.js/test/jasmine/tests/lib_test.js

Line 781
in
be70865
it('should set and return the default if the user input is not valid',function(){
Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:
should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.
(while we're at it there's a piece of copypasta in that test 
plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798
in
be70865
expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);

- should be 2 colOut lines and 2 sizeOut lines)
So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:
  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:

    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType
I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2
@archmojarchmojJun 10, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797

Shouldn't it be
expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');
?
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.

Please see adc36cd.
};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

80 changes: 42 additions & 38 deletions
test/image/mocks/axes_custom-ticks_log-date.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
 "layout": {
 "width": 500,
 "height": 300,
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 "template": {
 "layout": {
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 }
 }
 }
 }
}

8 changes: 4 additions & 4 deletions
test/jasmine/tests/axes_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
 Plotly.plot(gd, data, layout);

 var yaxis = gd._fullLayout.yaxis;
 expect(yaxis.ticklen).toBe(5);
 expect(yaxis.tickwidth).toBe(1);
 expect(yaxis.tickcolor).toBe('#444');
 expect(yaxis.ticks).toBe('outside');
 expect(yaxis.ticklen).toBe(undefined);
 expect(yaxis.tickwidth).toBe(undefined);
 expect(yaxis.tickcolor).toBe(undefined);
 expect(yaxis.ticks).toBe('');
 expect(yaxis.showticklabels).toBe(true);
 expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
 expect(yaxis.tickangle).toBe('auto');
Expand Down

74 changes: 71 additions & 3 deletions
test/jasmine/tests/lib_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set and return the default if the user input is not valid', function() {
 it('should set the default and return false if the user input is not valid', function() {
 var colVal = 'r';
 var sizeVal = 'aaaaah!';
 var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('rgba(0, 0, 0, 0)');
 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should set the user input', function() {
 var colVal = 'red';
 var sizeVal = '1e2';
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
 var outObj = {};
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 expect(sizeOut).toBe(20);
 });

 it('should set to template if the container input is not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'red', testSize: '1e2'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set to default and return false if the both container and template inputs are not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should return false if there is no user input', function() {
 var colVal = null;
 var sizeVal; // undefined
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

 Merged

archmoj
merged 14 commits into

from

Jun 17, 2020
 Merged


Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template
#4904
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
bddaafa

allow template input in Lib.coerce2 - fix issue 4852


archmoj Jun 5, 2020
11fd23c

update axes_breaks-round-weekdaysm baseline


archmoj Jun 5, 2020
756a0ee

refactor coerce rename v to valIn


archmoj Jun 7, 2020
a2c1c93

refactor coerce rename out to valOut


archmoj Jun 7, 2020
8d0b4cb

exit early


archmoj Jun 7, 2020
5c3be81

rename propOut to valOut


archmoj Jun 7, 2020
642bf28

add internal _coerce function


archmoj Jun 7, 2020
57cec14

reduce condition checks


archmoj Jun 8, 2020
1d9cc4a

keep track of source and input in _coerce function


archmoj Jun 9, 2020
cf7c061

fixup Lib.coerce2 description and color test


archmoj Jun 10, 2020
21b86cd

add jasmine tests to cover invalid inputs in Lib.coerce2


archmoj Jun 10, 2020
2b911d1

make room for opts - rename opts to attr


archmoj Jun 16, 2020
adc36cd

validate input when calling from coerce2


archmoj Jun 16, 2020
24d1da9

remove unnecessary validation, also


archmoj Jun 17, 2020

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


69 changes: 46 additions & 23 deletions
src/lib/coerce.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
 * as a convenience, returns the value it finally set
 */
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
 var opts = nestedProperty(attributes, attribute).get();
 return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
 var shouldValidate = (opts || {}).shouldValidate;

 var attr = nestedProperty(attributes, attribute).get();
 if(dflt === undefined) dflt = attr.dflt;
 var src = false;

 var propIn = nestedProperty(containerIn, attribute);
 var propOut = nestedProperty(containerOut, attribute);
 var v = propIn.get();
 var valIn = propIn.get();

 var template = containerOut._template;
 if(v === undefined && template) {
 v = nestedProperty(template, attribute).get();
 if(valIn === undefined && template) {
 valIn = nestedProperty(template, attribute).get();
 src = (valIn !== undefined);

 // already used the template value, so short-circuit the second check
 template = 0;
 }

 if(dflt === undefined) dflt = opts.dflt;

 /**
 * arrayOk: value MAY be an array, then we do no value checking
 * at this point, because it can be more complicated than the
 * individual form (eg. some array vals can be numbers, even if the
 * single values must be color strings)
 */
 if(opts.arrayOk && isArrayOrTypedArray(v)) {
 propOut.set(v);
 return v;
 if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
 propOut.set(valIn);
 return {
 inp: valIn,
 val: valIn,
 src: true
 };
 }

 var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
 coerceFunction(v, propOut, dflt, opts);
 var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
 coerceFunction(valIn, propOut, dflt, attr);

 var valOut = propOut.get();
 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

 var out = propOut.get();
 // in case v was provided but invalid, try the template again so it still
 // overrides the regular default
 if(template && out === dflt && !validate(v, opts)) {
 v = nestedProperty(template, attribute).get();
 coerceFunction(v, propOut, dflt, opts);
 out = propOut.get();
 if(template && valOut === dflt && !validate(valIn, attr)) {
 valIn = nestedProperty(template, attribute).get();
 coerceFunction(valIn, propOut, dflt, attr);
 valOut = propOut.get();

 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
 }
 return out;
};

 return {
 inp: valIn,
 val: valOut,
 src: src
 };
}

/**
 * Variation on coerce
 * useful when setting an attribute to a valid value
 * can change the default for another attribute.
 *
 * Uses coerce to get attribute value if user input is valid,
 * returns attribute default if user input it not valid or
 * returns false if there is no user input.
 */
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
 var propIn = nestedProperty(containerIn, attribute);
 var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
 var valIn = propIn.get();

 return (valIn !== undefined && valIn !== null) ? propOut : false;
 var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
 shouldValidate: true
 });
 return (out.src && out.inp !== undefined) ? out.val : false;
@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.
I see we actually do have a test that contradicts one thing I was hoping to "fix":
plotly.js/test/jasmine/tests/lib_test.js

Line 781
in
be70865
it('should set and return the default if the user input is not valid',function(){
Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:
should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.
(while we're at it there's a piece of copypasta in that test 
plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798
in
be70865
expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);

- should be 2 colOut lines and 2 sizeOut lines)
So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:
  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:

    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType
I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2
@archmojarchmojJun 10, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797

Shouldn't it be
expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');
?
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.

Please see adc36cd.
};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

80 changes: 42 additions & 38 deletions
test/image/mocks/axes_custom-ticks_log-date.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
 "layout": {
 "width": 500,
 "height": 300,
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 "template": {
 "layout": {
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 }
 }
 }
 }
}

8 changes: 4 additions & 4 deletions
test/jasmine/tests/axes_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
 Plotly.plot(gd, data, layout);

 var yaxis = gd._fullLayout.yaxis;
 expect(yaxis.ticklen).toBe(5);
 expect(yaxis.tickwidth).toBe(1);
 expect(yaxis.tickcolor).toBe('#444');
 expect(yaxis.ticks).toBe('outside');
 expect(yaxis.ticklen).toBe(undefined);
 expect(yaxis.tickwidth).toBe(undefined);
 expect(yaxis.tickcolor).toBe(undefined);
 expect(yaxis.ticks).toBe('');
 expect(yaxis.showticklabels).toBe(true);
 expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
 expect(yaxis.tickangle).toBe('auto');
Expand Down

74 changes: 71 additions & 3 deletions
test/jasmine/tests/lib_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set and return the default if the user input is not valid', function() {
 it('should set the default and return false if the user input is not valid', function() {
 var colVal = 'r';
 var sizeVal = 'aaaaah!';
 var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('rgba(0, 0, 0, 0)');
 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should set the user input', function() {
 var colVal = 'red';
 var sizeVal = '1e2';
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
 var outObj = {};
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 expect(sizeOut).toBe(20);
 });

 it('should set to template if the container input is not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'red', testSize: '1e2'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set to default and return false if the both container and template inputs are not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should return false if there is no user input', function() {
 var colVal = null;
 var sizeVal; // undefined
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template#4904

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

 Merged

archmoj
merged 14 commits into

from

Jun 17, 2020
 Merged


Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template
#4904
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
bddaafa

allow template input in Lib.coerce2 - fix issue 4852


archmoj Jun 5, 2020
11fd23c

update axes_breaks-round-weekdaysm baseline


archmoj Jun 5, 2020
756a0ee

refactor coerce rename v to valIn


archmoj Jun 7, 2020
a2c1c93

refactor coerce rename out to valOut


archmoj Jun 7, 2020
8d0b4cb

exit early


archmoj Jun 7, 2020
5c3be81

rename propOut to valOut


archmoj Jun 7, 2020
642bf28

add internal _coerce function


archmoj Jun 7, 2020
57cec14

reduce condition checks


archmoj Jun 8, 2020
1d9cc4a

keep track of source and input in _coerce function


archmoj Jun 9, 2020
cf7c061

fixup Lib.coerce2 description and color test


archmoj Jun 10, 2020
21b86cd

add jasmine tests to cover invalid inputs in Lib.coerce2


archmoj Jun 10, 2020
2b911d1

make room for opts - rename opts to attr


archmoj Jun 16, 2020
adc36cd

validate input when calling from coerce2


archmoj Jun 16, 2020
24d1da9

remove unnecessary validation, also


archmoj Jun 17, 2020

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


69 changes: 46 additions & 23 deletions
src/lib/coerce.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -361,58 +361,81 @@ exports.valObjectMeta = {
 * as a convenience, returns the value it finally set
 */
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
 var opts = nestedProperty(attributes, attribute).get();
 return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
 var shouldValidate = (opts || {}).shouldValidate;

 var attr = nestedProperty(attributes, attribute).get();
 if(dflt === undefined) dflt = attr.dflt;
 var src = false;

 var propIn = nestedProperty(containerIn, attribute);
 var propOut = nestedProperty(containerOut, attribute);
 var v = propIn.get();
 var valIn = propIn.get();

 var template = containerOut._template;
 if(v === undefined && template) {
 v = nestedProperty(template, attribute).get();
 if(valIn === undefined && template) {
 valIn = nestedProperty(template, attribute).get();
 src = (valIn !== undefined);

 // already used the template value, so short-circuit the second check
 template = 0;
 }

 if(dflt === undefined) dflt = opts.dflt;

 /**
 * arrayOk: value MAY be an array, then we do no value checking
 * at this point, because it can be more complicated than the
 * individual form (eg. some array vals can be numbers, even if the
 * single values must be color strings)
 */
 if(opts.arrayOk && isArrayOrTypedArray(v)) {
 propOut.set(v);
 return v;
 if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
 propOut.set(valIn);
 return {
 inp: valIn,
 val: valIn,
 src: true
 };
 }

 var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
 coerceFunction(v, propOut, dflt, opts);
 var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
 coerceFunction(valIn, propOut, dflt, attr);

 var valOut = propOut.get();
 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

 var out = propOut.get();
 // in case v was provided but invalid, try the template again so it still
 // overrides the regular default
 if(template && out === dflt && !validate(v, opts)) {
 v = nestedProperty(template, attribute).get();
 coerceFunction(v, propOut, dflt, opts);
 out = propOut.get();
 if(template && valOut === dflt && !validate(valIn, attr)) {
 valIn = nestedProperty(template, attribute).get();
 coerceFunction(valIn, propOut, dflt, attr);
 valOut = propOut.get();

 src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
 }
 return out;
};

 return {
 inp: valIn,
 val: valOut,
 src: src
 };
}

/**
 * Variation on coerce
 * useful when setting an attribute to a valid value
 * can change the default for another attribute.
 *
 * Uses coerce to get attribute value if user input is valid,
 * returns attribute default if user input it not valid or
 * returns false if there is no user input.
 */
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
 var propIn = nestedProperty(containerIn, attribute);
 var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
 var valIn = propIn.get();

 return (valIn !== undefined && valIn !== null) ? propOut : false;
 var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
 shouldValidate: true
 });
 return (out.src && out.inp !== undefined) ? out.val : false;
@alexcjohnsonalexcjohnsonJun 9, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.
I see we actually do have a test that contradicts one thing I was hoping to "fix":
plotly.js/test/jasmine/tests/lib_test.js

Line 781
in
be70865
it('should set and return the default if the user input is not valid',function(){
Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:
should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.
(while we're at it there's a piece of copypasta in that test 
plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798
in
be70865
expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);

- should be 2 colOut lines and 2 sizeOut lines)
So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:
  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:

    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType
I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2
@archmojarchmojJun 10, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797

Shouldn't it be
expect(yaxis.ticklen).toBe(undefined);expect(yaxis.tickwidth).toBe(undefined);expect(yaxis.tickcolor).toBe(undefined);expect(yaxis.ticks).toBe('');
?
@archmojarchmojJun 16, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@alexcjohnson this PR is ready for another review.

Please see adc36cd.
};

/*
Expand Down
Binary file modifiedtest/image/baselines/axes_breaks-round-weekdays.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

80 changes: 42 additions & 38 deletions
test/image/mocks/axes_custom-ticks_log-date.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,44 +15,48 @@
 "layout": {
 "width": 500,
 "height": 300,
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 "template": {
 "layout": {
 "title": {
 "text": "custom ticks on date & log axes"
 },
 "paper_bgcolor": "lightblue",
 "plot_bgcolor": "#ddd",
 "yaxis": {
 "type": "log",
 "tickmode": "array",
 "tickvals": [
 1,
 10,
 100
 ],
 "ticktext": [
 "one",
 "ten",
 "one<br>hundred"
 ],
 "gridwidth": 2,
 "tickwidth": 15,
 "tickcolor": "green",
 "gridcolor": "green"
 },
 "xaxis": {
 "type": "date",
 "tickmode": "array",
 "tickvals": [
 "2010-01-16",
 "2010-02-14"
 ],
 "ticktext": [
 "Jan 16",
 "Feb 14"
 ],
 "gridwidth": 10,
 "tickwidth": 50,
 "tickcolor": "rgba(255,0,0,0.75)",
 "gridcolor": "rgba(255,0,0,0.25)"
 }
 }
 }
 }
}

8 changes: 4 additions & 4 deletions
test/jasmine/tests/axes_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1803,10 +1803,10 @@ describe('Test axes', function() {
 Plotly.plot(gd, data, layout);

 var yaxis = gd._fullLayout.yaxis;
 expect(yaxis.ticklen).toBe(5);
 expect(yaxis.tickwidth).toBe(1);
 expect(yaxis.tickcolor).toBe('#444');
 expect(yaxis.ticks).toBe('outside');
 expect(yaxis.ticklen).toBe(undefined);
 expect(yaxis.tickwidth).toBe(undefined);
 expect(yaxis.tickcolor).toBe(undefined);
 expect(yaxis.ticks).toBe('');
 expect(yaxis.showticklabels).toBe(true);
 expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
 expect(yaxis.tickangle).toBe('auto');
Expand Down

74 changes: 71 additions & 3 deletions
test/jasmine/tests/lib_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set and return the default if the user input is not valid', function() {
 it('should set the default and return false if the user input is not valid', function() {
 var colVal = 'r';
 var sizeVal = 'aaaaah!';
 var attrs = {
Expand All@@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('rgba(0, 0, 0, 0)');
 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should set the user input', function() {
 var colVal = 'red';
 var sizeVal = '1e2';
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
 var outObj = {};
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 expect(sizeOut).toBe(20);
 });

 it('should set to template if the container input is not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'red', testSize: '1e2'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe('red');
 expect(colOut).toBe(outObj.testMarker.testColor);
 expect(sizeOut).toBe(100);
 expect(sizeOut).toBe(outObj.testMarker.testSize);
 });

 it('should set to default and return false if the both container and template inputs are not valid', function() {
 var attrs = {
 testMarker: {
 testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
 testSize: {valType: 'number', dflt: 20}
 }
 };
 var obj = {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 };
 var outObj = {
 _template: {
 testMarker: {testColor: 'invalid', testSize: 'invalid'}
 }
 };
 var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
 var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

 expect(colOut).toBe(false);
 expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
 expect(sizeOut).toBe(false);
 expect(outObj.testMarker.testSize).toBe(20);
 });

 it('should return false if there is no user input', function() {
 var colVal = null;
 var sizeVal; // undefined
Expand Down