Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CMSP-992] plugin documentation update (#273)
* add initial admin interface class hook to mu-plugin > 1.4.0 * some more scaffolding * require at least 6.4 * don't show notices if wp_admin_notice doesn't exist * add notice if mu-plugin was not found * add notice if the mu-plugin is old * fix link and change decimal to string * use spaces instead of line breaks * add helper function to get current max age this is either set in the mu-plugin or empty. if empty, it should default to 1 week * add notice if less than 1 week but not == 600 seconds * add docblock * add translator comments * update tested up to and requires at least values in readmes * version bump * bump composer deps * don't display the warnings if we aren't on the pantheon cache admin page * convert static class to a namespace there's no reason to make this a class since we're not using any class features * add a bootstrapper for namespace-only files * lint * escape the wp_die message * use a helper for humanized time calculations * we still need to test the current max age * pass the current max age to the message, too and be specific that we're talking about seconds * use the filterable value for default max age because it could be something different * add a helper function for retrieving the default max age this is helpful so we can always return the filtered value * also display the seconds in the successful test * rank the max age value don't say it's "very low" unless that's actually accurate. * add caching to the ranked compare * make the color more severe if it's a bigger issue * change the color of the admin notice based on the severity of the diff * clear the transient when the option is updated * break notice type into a variable * fix the translator note * keep the rank but hide it from the dom * add unit tests * add initial behat test let's just see if we can assume this will work * fix failing test * specify the element where the notices are * add site health check test * actually save the changes * remove max age check only exists in an html comment anyway * simplify the site health check * add the message when you expand the accordion * add other site health things * change press to click? * add "open the accordion" as a custom step * move behat stuff around * move stuff around again * update the behat.yml * remove custom context and try "when I follow" * move to checking the text inside the elements * target the hidden element * use hidden='hidden' * call it a div * simplify the tests * remove press since we can't actually press * it did actually find the right heading maybe it will find the right text? * add @\since tags * add changelog and upgrade notice * let's try checking for some of the hidden text * period at the end of the sentence * add the ranks back this shows us that our ranking function is working * add the messages * remove age rank tests because goutte doesn't natively interpret html comments * add github testing badge since phpunit is no longer run on circle * add script to maybe skip behat tests if we don't need to run them * add step to workflow * do not run if the circle config changes * also ignore if scripts (that aren't behat-related) have changed * fix the logic (again) * one more flippity flip * remove the "ignoring" message it's actually implied by the fact that is_ignored is checked * use function to determine if a file should be ignored Co-authored-by: Phil Tyler <[email protected]> * update changelog to note mu-plugin updates * add functionality to automatically set the default_ttl if it was set to 600 * trigger the setting change and display an admin notice informing users it was done only show the notice to users who haven't already seen it and who can manage_options * add unit tests for set_max_age_to_default * move the max age update notice to the bootstrap * remove the set_max_age_updated helper this wasn't working and meant that we were needing to make multiple update options in a short space of time. we might have actually been running into race conditions where one update was overwriting the other one. * use a new option for the updated flag * add _notice to the user meta key so it's distinct from the new option * update tests for new changes * add translator note * user notice about 600 second update is not dismissable because it only appears once * don't show seconds in updated notice * pass the function into the apply_filter hook so you can selectively disable specific notices * add docblock * add test for the notice * return the value of disable_notices rather than hard-coded "false" * Add scenario to set max-age to 600 and auto-update to the default value * here's a behat test that might not work not sure if it will know what pantheon-cache[default-ttl] is without giving it an element to look at. * fixed it based on upstream tests * refresh the page * go to instead of refresh since refresh isn't a thing ¯\_(ツ)_/¯ * remove all the old npm stuff and use all new npm stuff * add node build to the build & tag workflow * add del package * repurpos gruntfile into gulpfile * repackage gulpfile and package.json as a module * add additional test failure messaging * gitignore assets * don't export the gulpfile * invoke sass correctly * proper sassing * add a main.scss file * compiler tweaks * use concat * initial styles * enqueue css * use the filter added in pantheon-systems/pantheon-mu-plugin#46 to add header * some initial styles for the max age box * add a global admin notice that appears once * remove seconds from the notice * test the new notice * set dismissable depending on which notice we're showing * show the max age rank html comment * fix the conditionals for cs * update behat tests for new notice language * bugfix: don't update user meta that max_age was updated if it hasn't been * add one more thing to test in behat * add a test for the error, specifically * add a test for the warning * simplify the conditionals * lint * specify the pages that we're on? * remove specific element * fix typo * take out the dashboard main page goto * validate the setting was saved * let's just remove the 5 days notice * just remove the test we have similar things being tested in phpunit * we can actually remove current_max_age >= WEEK_IN_SECONDS this is covered by max_age_rank. if max_age_rank is 0 it, by definition, means that the current max age is >= WEEK_IN_SECONDS * if we're only comparing two things, we don't need to break the if clauses up * we do want to warn users if they have manually set their max age to 600 we just don't want to warn them if we're about to (or just did) change it to a week for them * there should only be one css file * remove seconds * check stored default_ttl value * fix failing test * fix translators note * remove seconds * remove redundant check * tweak the logic again * fix the test by updating the default ttl * add the description after the input * styles for box and info bar * update the filter name * filter the input box * add a padding helper * ...and use it * lint * add styling for links in the info bar. * no padding on the right padding the right makes the bar flush with the edge of the box * adjust h3 margin so it looks better when there's no banner * style the select input * don't render the info bar * use wp_kses_post instead of esc_html_e we might want to add links to this bar * helper function for available dropdown options and make it filterable * Refactor default_ttl_input function to handle custom options and filterable dropdown * remove seconds from behat tests * add a period for dumb lint rule * remove hyphen from max-age in everything user-facing * update the tests * conditionally append a timestamp to the css version to refresh it on each page load if debug is true * don't show the input box if the ttl is unset * remove filters in teardown * remove hyphen in tests * specify method visibility * test the setting description callback * test the default ttl option input callback * test max_age_options and filter * add a behat test for the select input * maybe change the then * remove all hyphens * be more specific about the select input * try using the class and the select * let's try checking to see if the response contains the selected option * print for debugging * one last try before I give up * remove the new behat test * use a simple true/false gate for max_age header * display a warning if the default_ttl is saved to a value that's not one of the default optiosn * show the dropdown with the custom value so a new value can be selected from the droptdown when prompted * remove placeholder comment * gix the global warning shown logic * make sure to take into consideration custom and filtered * bail early if the max age is filtered * better comment * remove value range entirely * remove recommendation if filtered * break out custom and filtered outputs filtered displays the grayed out input box custom adds to the dropdown * update tests * translator note * move the debug note Co-authored-by: Phil Tyler <[email protected]> * add since and return values * push the description down a bit * personalized message based on current cache max age * remove current when not necessary * update tests, add a data provider * update changelog * cache max age filter docs * document filter to disable notices * emdash Co-authored-by: Phil Tyler <[email protected]> * add missing links * emdash * update the 2.0.0 upgrade notice * add upgrade notice to .md * remove linebreak * add -dev tag to versions * fix readme spacing --------- Co-authored-by: Phil Tyler <[email protected]>
- Loading branch information
1 parent
a399b1a
commit abe003f
