| Summary: | Lists: Use "size" as names/hash keys leads to an unexpected results when using Template::Toolkit (name of a virtual method there) | ||
|---|---|---|---|
| Product: | Koha | Reporter: | David Cook <dcook> |
| Component: | Templates | Assignee: | David Cook <dcook> |
| Status: | CLOSED FIXED | QA Contact: | |
| Severity: | minor | ||
| Priority: | P5 - low | CC: | bgkriegel, chrish, gmcharlt, m.de.rooy, tomascohen |
| Version: | Main | ||
| Hardware: | All | ||
| OS: | All | ||
| See Also: |
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=6374 http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=11357 |
||
| Change sponsored?: | --- | Patch complexity: | --- |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: | ||
| Circulation function: | |||
| Attachments: |
Bug 10466 - Lists: Use "size" as names/hash keys leads to an unexpected results when using Template::Toolkit (name of a virtual method there)
Bug 10466 - Lists: Use "size" as names/hash keys leads to an unexpected results when using Template::Toolkit (name of a virtual method there) |
||
|
Description
David Cook
2013-06-14 02:40:13 UTC
Created attachment 18977 [details] [review] Bug 10466 - Lists: Use "size" as names/hash keys leads to an unexpected results when using Template::Toolkit (name of a virtual method there) Test Plan: Before applying the patch: 0) Make sure you have opac search result XSLT turned off 1) Find bib records that do not have a 300$c (Dimensions) value. 2) Find bib records that do have a 300$c (Dimensions) value. (N.B. These values should be stored in the `size` column of biblioitems). 3) Add items from both sets of records to a List 4) Note that records without a 300$c will display a number at the end of the "Publication" description/string. It should be something like 33 or 34 in most cases. 5) Note that records with a 300$c don't display this number. They just show the value from 300$c. Apply the patch. 6) Clear your cache, refresh the page, etc. 7) Note that the number (e.g. 33 or 34) has disappeared from the end of the "Publication" description/string. I do remember this bug. Do not know where it was. But I think there was code that forces the size value to be there. Wow. So much words for one line :) Compliments for such a detailed test plan and even for finding such a small bug. Created attachment 18980 [details] [review] Bug 10466 - Lists: Use "size" as names/hash keys leads to an unexpected results when using Template::Toolkit (name of a virtual method there) This patch checks to see if "size" is undefined. If it is, we add a blank (i.e. "") value to it in place of undef. If we do not do this, calling "itemloo.size" will return the size of the "itemloo" hash, rather than the value for the "size" key. This is because "size" is a virtual method in Template Toolkit. It's uncertain why the value is retrieved for the "size" key when there is a defined value and why TT doesn't use the method instead, and that it uses "size" as a method only if there is either no "size" key or if the value tied to the "size" key is null/undef. This might be a feature or it might be a bug in TT... In the mean-time, we will check to see if it's undefined. If it is, we'll give it a value. This bug has been identified in the opac-search.pl, search.pl and addbooks.pl pages before. To address it, we're currently checking if there is a "size" key, and if not...we're adding one with a blank value. This patch takes up that same idea, although I think it might be better to rename the variable before passing it to TT in case the behaviour of TT changes in the future in regards to how it handles virtual methods. N.B. Obviously, this only affects users not using XSLTs. -- Test Plan: Before applying the patch: 0) Make sure you have opac search result XSLT turned off 1) Find bib records that do not have a 300$c (Dimensions) value. 2) Find bib records that do have a 300$c (Dimensions) value. (N.B. These values should be stored in the `size` column of biblioitems). 3) Add items from both sets of records to a List 4) Note that records without a 300$c will display a number at the end of the "Publication" description/string. It should be something like 33 or 34 in most cases. 5) Note that records with a 300$c don't display this number. They just show the value from 300$c. Apply the patch. 6) Clear your cache, refresh the page, etc. 7) Note that the number (e.g. 33 or 34) has disappeared from the end of the "Publication" description/string. Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Added a small comment at the end of this one line. QA Comment: One line patch fixes a small problem. Altough we could indeed solve this problem even better by replacing size with something else, this fix deserves to be pushed if it were only for the commit message and test plan :) Additionally, there is at least one other place where this same problem is also solved in this same way (and was pushed before..) Note that I took the liberty to amend with a small comment at the end of your line about the reason you explained so thoroughly in the commit message. Passed QA I've pushed this to master. I updated the commit message to clarify to normal users the problem being corrected. Yes, I fully realize that this has made the commit message EVEN LONGER! :) Thanks, David, especially for taking the time to fully describe your thinking on this. This patch has been pushed to 3.12.x, will be in 3.12.2. Thanks David! Pushed to 3.10.x, will be in 3.10.8 Pushed to 3.8.x, will be in 3.8.15 |