Skip to content

Commit

Permalink
[IMP] openupgrade_160, openupgrade_tool: special case for class
Browse files Browse the repository at this point in the history
text-justify removed
  • Loading branch information
duong77476-viindoo committed Aug 26, 2023
1 parent a953cdd commit 41799ce
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 13 deletions.
11 changes: 8 additions & 3 deletions openupgradelib/openupgrade_160.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
convert_html_fragment,
convert_html_replacement_class_shortcut as _r,
replace_html_replacement_attr_shortcut as _attr_replace,
replace_html_replacement_class_rp_by_inline_shortcut as _class_rp_by_inline,
)

logger = logging.getLogger("OpenUpgrade")
Expand Down Expand Up @@ -102,9 +103,13 @@ def migrate_translations_to_jsonb(env, fields_spec):
# Content, Reboot, etc
_r("thead-light", "table-light"),
_r("thead-dark", "table-dark"),
_r(
"text-justify", "text-center"
), # actually boostrap 5 only drop without any replacements
# Special case where text-justify no longer exist
_class_rp_by_inline(
selector="//*[contains(@class, 'text-justify')]",
selector_mode="xpath",
class_rp_by_inline={"text-justify": ["text-align: justify"]},
),
_r(class_rm="text-justify", class_add=""),
# RTL
*(
_r("%s-%s" % (elem, t4), "%s-%s" % (elem, t5))
Expand Down
65 changes: 55 additions & 10 deletions openupgradelib/openupgrade_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ def convert_html_fragment(html_string, replacements, pretty_print=True):
return tostring(fragment, pretty_print=pretty_print, encoding="unicode")


# flake8: noqa: C901
def convert_xml_node(
node,
attr_add=None,
Expand All @@ -105,6 +106,7 @@ def convert_xml_node(
tag="",
wrap="",
attr_rp=None,
class_rp_by_inline=None,
):
"""Apply conversions to an XML node.
Expand Down Expand Up @@ -160,12 +162,18 @@ def convert_xml_node(
XML element that will wrap the :param:`node`.
:param dict attr_rp:
Specify a dict of attribute to place from old to the new one
Specify a dict of attribute to replace from old to the new one
Ex: {"data-toggle": "data-bs-togle"} (typical case when convert BS4 to BS5 in odoo 16)
:param dict class_rp_by_inline:
Specify a dict of class to replace with inline css
Ex: {"text-justify": ["text-align: justify", "anothor_inline"]}
(BS5 has removed text-justify class)
"""
# Fix params
attr_add = attr_add or {}
attr_rp = attr_rp or {}
class_rp_by_inline or {}
class_add = set(class_add.split())
class_rm = set(class_rm.split())
style_add = style_add or {}
Expand All @@ -187,22 +195,33 @@ def convert_xml_node(
attr_add = _call(attr_add)
attr_rm = _call(attr_rm)
attr_rp = _call(attr_rp)
class_rp_by_inline = _call(class_rp_by_inline)
class_add = _call(class_add)
class_rm = _call(class_rm)
style_add = _call(style_add)
style_rm = _call(style_rm)
tag = _call(tag)
wrap = _call(wrap)
# Patch node attributes
if attr_add or attr_rm or attr_rp:
for key, value in attr_rp.items():
if key in node.attrib:
node.attrib[value] = node.attrib.pop(key, None)
for key in attr_rm:
node.attrib.pop(key, None)
for key, value in attr_add.items():
if key not in node.attrib:
node.attrib[key] = value
if attr_add or attr_rm or attr_rp or class_rp_by_inline:
if class_rp_by_inline:
inline_style = ""
for _, value in class_rp_by_inline.items():
for inline_css_style in value:
inline_style += inline_css_style + ";"
if "style" in node.attrib and node.attrib["style"]:
node.attrib["style"] += inline_style
else:
node.attrib["style"] = inline_style
else:
for key, value in attr_rp.items():
if key in node.attrib:
node.attrib[value] = node.attrib.pop(key, None)
for key in attr_rm:
node.attrib.pop(key, None)
for key, value in attr_add.items():
if key not in node.attrib:
node.attrib[key] = value
# Patch node classes
if class_add or class_rm:
classes = (classes | class_add) ^ class_rm
Expand Down Expand Up @@ -259,6 +278,32 @@ def convert_html_replacement_class_shortcut(class_rm="", class_add="", **kwargs)
return kwargs


def replace_html_replacement_class_rp_by_inline_shortcut(
class_rp_by_inline="", **kwargs
):
"""Shortcut to replace an attribute spec.
:param dict attr_rp:
EX: {'data-toggle': 'data-bs-toggle'}
Where the 'key' is the attribute will be replaced by the 'value'
:return dict:
Generated spec, to be included in a list of replacements to be
passed to :meth:`convert_xml_fragment`.
"""

# Disallow selector to be empty
assert "selector" in kwargs and kwargs["selector"] != ""
# Also to be able to get exact element that have that attribute need selector_mode xpath
assert "selector_mode" in kwargs and kwargs["selector_mode"] == "xpath"
kwargs.update(
{
"class_rp_by_inline": class_rp_by_inline,
}
)
return kwargs


def replace_html_replacement_attr_shortcut(attr_rp="", **kwargs):
"""Shortcut to replace an attribute spec.
Expand Down

0 comments on commit 41799ce

Please sign in to comment.