Refactor js_utils from page_utils

Author: mdmintz

seleniumbase/core/tour_helper.py

@@ -10,7 +10,6 @@
 from seleniumbase.fixtures import constants
 from seleniumbase.fixtures import js_utils
 from seleniumbase.fixtures import page_actions
-from seleniumbase.fixtures import page_utils
 
 
 def raise_unable_to_load_jquery_exception(driver):
@@ -691,7 +690,7 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
         bootstrap_tour_js = constants.BootstrapTour.MIN_JS
         backdrop_style = style_sheet.bt_backdrop_style
         backdrop_style = backdrop_style.replace('\n', '')
-        backdrop_style = page_utils.escape_quotes_if_needed(backdrop_style)
+        backdrop_style = js_utils.escape_quotes_if_needed(backdrop_style)
         instructions += 'injectJS("%s");' % jquery_js
         instructions += '\n\n////////  Resources - Load 2  ////////\n\n'
         instructions += 'injectCSS("%s");\n' % bootstrap_tour_css
@@ -703,7 +702,7 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
         hopscotch_js = constants.Hopscotch.MIN_JS
         backdrop_style = style_sheet.hops_backdrop_style
         backdrop_style = backdrop_style.replace('\n', '')
-        backdrop_style = page_utils.escape_quotes_if_needed(backdrop_style)
+        backdrop_style = js_utils.escape_quotes_if_needed(backdrop_style)
         instructions += 'injectCSS("%s");\n' % hopscotch_css
         instructions += 'injectStyle("%s");\n' % backdrop_style
         instructions += 'injectJS("%s");' % hopscotch_js
@@ -727,7 +726,7 @@ def export_tour(tour_steps, name=None, filename="my_tour.js"):
         spinner_css = constants.Messenger.SPINNER_CSS
         backdrop_style = style_sheet.sh_backdrop_style
         backdrop_style = backdrop_style.replace('\n', '')
-        backdrop_style = page_utils.escape_quotes_if_needed(backdrop_style)
+        backdrop_style = js_utils.escape_quotes_if_needed(backdrop_style)
         instructions += 'injectCSS("%s");\n' % spinner_css
         instructions += 'injectJS("%s");\n' % jquery_js
         instructions += 'injectJS("%s");' % tether_js

seleniumbase/fixtures/base_case.py

@@ -748,10 +748,10 @@ def activate_jquery(self):
         js_utils.activate_jquery(self.driver)
 
     def __are_quotes_escaped(self, string):
-        return page_utils.are_quotes_escaped(string)
+        return js_utils.are_quotes_escaped(string)
 
     def __escape_quotes_if_needed(self, string):
-        return page_utils.escape_quotes_if_needed(string)
+        return js_utils.escape_quotes_if_needed(string)
 
     def create_tour(self, name=None, theme=None):
         """ Creates a tour for a website. By default, the Shepherd Javascript
@@ -1453,7 +1453,7 @@ def ad_block(self):
 
     def jq_format(self, code):
         # DEPRECATED - Use re.escape() instead, which does the action you want.
-        return page_utils._jq_format(code)
+        return js_utils._jq_format(code)
 
     def get_domain_url(self, url):
         return page_utils.get_domain_url(url)

seleniumbase/fixtures/js_utils.py

@@ -8,7 +8,14 @@
 from selenium.common.exceptions import WebDriverException
 from seleniumbase.config import settings
 from seleniumbase.fixtures import constants
-from seleniumbase.fixtures import page_utils
+
+
+def is_jquery_activated(driver):
+    try:
+        driver.execute_script("jQuery('html')")  # Fails if jq is not defined
+        return True
+    except Exception:
+        return False
 
 
 def activate_jquery(driver):
@@ -42,6 +49,37 @@ def activate_jquery(driver):
         '''directive. ''' % driver.current_url)
 
 
+def are_quotes_escaped(string):
+    if (string.count("\\'") != string.count("'") or
+            string.count('\\"') != string.count('"')):
+        return True
+    return False
+
+
+def escape_quotes_if_needed(string):
+    """
+    re.escape() works differently in Python 3.7.0 than earlier versions:
+
+    Python 3.6.5:
+    >>> import re
+    >>> re.escape('"')
+    '\\"'
+
+    Python 3.7.0:
+    >>> import re
+    >>> re.escape('"')
+    '"'
+
+    SeleniumBase needs quotes to be properly escaped for Javascript calls.
+    """
+    if are_quotes_escaped(string):
+        if string.count("'") != string.count("\\'"):
+            string = string.replace("'", "\\'")
+        if string.count('"') != string.count('\\"'):
+            string = string.replace('"', '\\"')
+    return string
+
+
 def safe_execute_script(driver, script):
     """ When executing a script that contains a jQuery command,
         it's important that the jQuery library has been loaded first.
@@ -125,7 +163,7 @@ def wait_for_css_query_selector(
     for x in range(int(timeout * 10)):
         try:
             selector = re.escape(selector)
-            selector = page_utils.escape_quotes_if_needed(selector)
+            selector = escape_quotes_if_needed(selector)
             element = driver.execute_script(
                 """return document.querySelector('%s')""" % selector)
             if element:
@@ -230,7 +268,7 @@ def add_css_link(driver, css_link):
               head.appendChild(link);
            }
            injectCSS("%s");""")
-    css_link = page_utils.escape_quotes_if_needed(css_link)
+    css_link = escape_quotes_if_needed(css_link)
     driver.execute_script(script_to_add_css % css_link)
 
 
@@ -247,7 +285,7 @@ def add_js_link(driver, js_link):
               head.appendChild(script);
            }
            injectJS("%s");""")
-    js_link = page_utils.escape_quotes_if_needed(js_link)
+    js_link = escape_quotes_if_needed(js_link)
     driver.execute_script(script_to_add_js % js_link)
 
 
@@ -262,7 +300,7 @@ def add_css_style(driver, css_style):
            }
            injectStyle("%s");""")
     css_style = css_style.replace('\n', '')
-    css_style = page_utils.escape_quotes_if_needed(css_style)
+    css_style = escape_quotes_if_needed(css_style)
     driver.execute_script(add_css_style_script % css_style)
 
 
@@ -278,7 +316,7 @@ def add_js_code_from_link(driver, js_link):
         '''s.appendChild(document.createTextNode("%s"));'''
         '''h.appendChild(s);''')
     js_code = js_code.replace('\n', '')
-    js_code = page_utils.escape_quotes_if_needed(js_code)
+    js_code = escape_quotes_if_needed(js_code)
     driver.execute_script(add_js_code_script % js_code)
 
 
@@ -395,7 +433,7 @@ def post_message(driver, message, msg_dur, style="info", duration=None):
         else:
             duration = msg_dur
     message = re.escape(message)
-    message = page_utils.escape_quotes_if_needed(message)
+    message = escape_quotes_if_needed(message)
     messenger_script = ('''Messenger().post({message: "%s", type: "%s", '''
                         '''hideAfter: %s, hideOnNavigate: true});'''
                         % (message, style, duration))
@@ -548,3 +586,18 @@ def slow_scroll_to_element(driver, element, browser):
     if distance > 430 or distance < -300:
         # Add small recovery time for long-distance slow-scrolling
         time.sleep(0.162)
+
+
+def _jq_format(code):
+    """
+    DEPRECATED - Use re.escape() instead, which performs the intended action.
+    Use before throwing raw code such as 'div[tab="advanced"]' into jQuery.
+    Selectors with quotes inside of quotes would otherwise break jQuery.
+    If you just want to escape quotes, there's escape_quotes_if_needed().
+    This is similar to "json.dumps(value)", but with one less layer of quotes.
+    """
+    code = code.replace('\\', '\\\\').replace('\t', '\\t').replace('\n', '\\n')
+    code = code.replace('\"', '\\\"').replace('\'', '\\\'')
+    code = code.replace('\v', '\\v').replace('\a', '\\a').replace('\f', '\\f')
+    code = code.replace('\b', '\\b').replace(r'\u', '\\u').replace('\r', '\\r')
+    return code

seleniumbase/fixtures/page_utils.py

@@ -83,55 +83,9 @@ def _save_data_as(data, destination_folder, file_name):
     out_file.close()
 
 
-def are_quotes_escaped(string):
-    if (string.count("\\'") != string.count("'") or
-            string.count('\\"') != string.count('"')):
-        return True
-    return False
-
-
-def escape_quotes_if_needed(string):
-    """
-    re.escape() works differently in Python 3.7.0 than earlier versions:
-
-    Python 3.6.5:
-    >>> import re
-    >>> re.escape('"')
-    '\\"'
-
-    Python 3.7.0:
-    >>> import re
-    >>> re.escape('"')
-    '"'
-
-    SeleniumBase needs quotes to be properly escaped for Javascript calls.
-    """
-    if are_quotes_escaped(string):
-        if string.count("'") != string.count("\\'"):
-            string = string.replace("'", "\\'")
-        if string.count('"') != string.count('\\"'):
-            string = string.replace('"', '\\"')
-    return string
-
-
 def make_css_match_first_element_only(selector):
     # Only get the first match
     last_syllable = selector.split(' ')[-1]
     if ':' not in last_syllable and ':contains' not in selector:
         selector += ':first'
     return selector
-
-
-def _jq_format(code):
-    """
-    DEPRECATED - Use re.escape() instead, which performs the intended action.
-    Use before throwing raw code such as 'div[tab="advanced"]' into jQuery.
-    Selectors with quotes inside of quotes would otherwise break jQuery.
-    If you just want to escape quotes, there's escape_quotes_if_needed().
-    This is similar to "json.dumps(value)", but with one less layer of quotes.
-    """
-    code = code.replace('\\', '\\\\').replace('\t', '\\t').replace('\n', '\\n')
-    code = code.replace('\"', '\\\"').replace('\'', '\\\'')
-    code = code.replace('\v', '\\v').replace('\a', '\\a').replace('\f', '\\f')
-    code = code.replace('\b', '\\b').replace(r'\u', '\\u').replace('\r', '\\r')
-    return code

seleniumbase/utilities/selenium_ide/convert_ide.py

@@ -17,7 +17,7 @@
 import codecs
 import re
 import sys
-from seleniumbase.fixtures import page_utils
+from seleniumbase.fixtures import js_utils
 
 
 def main():
@@ -587,7 +587,7 @@ def main():
             # quote_type = data.group(1)
             selector = data.group(2)
             selector = re.escape(selector)
-            selector = page_utils.escape_quotes_if_needed(selector)
+            selector = js_utils.escape_quotes_if_needed(selector)
             if int(line_num) < num_lines - 1:
                 regex_string = (r'''^\s*self.click\(["|']''' +
                                 selector + r'''["|']\)\s*$''')
@@ -615,7 +615,7 @@ def main():
             # quote_type = data.group(1)
             link_text = data.group(2)
             link_text = re.escape(link_text)
-            link_text = page_utils.escape_quotes_if_needed(link_text)
+            link_text = js_utils.escape_quotes_if_needed(link_text)
             if int(line_num) < num_lines - 2:
                 regex_string = (r'''^\s*self.click\(["|']link=''' +
                                 link_text + r'''["|']\)\s*$''')