onlyoffice_webdriver_wrapper 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463293b09305f4239661d7a2b5ede7401f2413727901404f62803b7039de8eb6
-  data.tar.gz: 64d8ba2953c044d3e16027788b5422acbe908d8e6c01a3e4777c101ceaf8268c
+  metadata.gz: fa55ec4ecf7da6b705cf7e5f61e561c7a70e319b7e1b17ce33eb2aa29a93e6ef
+  data.tar.gz: f517118579f4efe962a5a81818e7f95a60be4c1fa6b02844f93c0b79a5c3cb28
 SHA512:
-  metadata.gz: 5889b7d26d11ca03c1f2b20241c17bcae0f20e63745d1426f3f64e24aee9288716c2ea0e3faa4220aff813d36b70b14f9d745a434c669f872bb134be7bce4818
-  data.tar.gz: 504842e409da31df07eb312d420d8a39caff748b52d6ade7611b6a3a5304e244a9561b6cffe19ce47ee3e62951a1995092a79e955d46f99c052e0c3988a7f6fa
+  metadata.gz: b6771021256d643efe30cb7ef4d039f7964e384784841f9d41f93d581a9263bc7bc70c10b335bf06c3f748bc3f8298fe00bbed7c91de3c4f875fba273c8c0747
+  data.tar.gz: 7c3e5b157d9ecbad1688e59877ff49fdc17aa28074377d2bc974cb1868c94204855ba0a0bf2272cdac7be0500413f344ba8b9fa1c4e64e499e15948581aae72c

data/lib/onlyoffice_webdriver_wrapper/version.rb

@@ -2,6 +2,6 @@
 
 module OnlyofficeWebdriverWrapper
   module Version
-    STRING = '0.16.1'
+    STRING = '0.17.0'
   end
 end

data/lib/onlyoffice_webdriver_wrapper/webdriver.rb

@@ -14,8 +14,11 @@ require_relative 'webdriver/webdriver_attributes_helper'
 require_relative 'webdriver/webdriver_browser_info_helper'
 require_relative 'webdriver/webdriver_type_helper'
 require_relative 'webdriver/webdriver_exceptions'
+require_relative 'webdriver/webdriver_frame_methods'
 require_relative 'webdriver/webdriver_helper'
 require_relative 'webdriver/webdriver_js_methods'
+require_relative 'webdriver/webdriver_move_cursor_methods'
+require_relative 'webdriver/webdriver_navigation_methods'
 require_relative 'webdriver/webdriver_screenshot_helper'
 require_relative 'webdriver/webdriver_style_helper'
 require_relative 'webdriver/webdriver_tab_helper'
@@ -34,8 +37,11 @@ module OnlyofficeWebdriverWrapper
     include WebdriverAttributesHelper
     include WebdriverBrowserInfo
     include WebdriverTypeHelper
+    include WebdriverFrameMethods
     include WebdriverHelper
     include WebdriverJsMethods
+    include WebdriverMoveCursorMethods
+    include WebdriverNavigationMethods
     include WebdriverScreenshotHelper
     include WebdriverStyleHelper
     include WebdriverTabHelper
@@ -83,37 +89,6 @@ module OnlyofficeWebdriverWrapper
       @browser_running = true
     end
 
-    def open(url)
-      url = "http://#{url}" unless url.include?('http') || url.include?('file://')
-      loop do
-        @driver.navigate.to url
-        break
-      rescue Timeout::Error
-        @driver.navigate.refresh
-      end
-      sleep(1) # Correct wait for Page to init focus
-      OnlyofficeLoggerHelper.log("Opened page: #{url}")
-    end
-
-    def quit
-      return unless browser_running
-
-      begin
-        @driver.execute_script('window.onbeforeunload = null') # off popup window
-      rescue StandardError
-        Exception
-      end
-      begin
-        @driver.quit
-      rescue Exception => e
-        OnlyofficeLoggerHelper.log("Some error happened on webdriver.quit #{e.backtrace}")
-      end
-      alert_confirm
-      @headless.stop
-      cleanup_download_folder
-      @browser_running = false
-    end
-
     def get_element(object_identification)
       return object_identification unless object_identification.is_a?(String)
 
@@ -145,57 +120,6 @@ module OnlyofficeWebdriverWrapper
       @driver.find_element(:xpath, xpath_name).find_elements(tag_name: 'option').map { |el| el.attribute('value') }
     end
 
-    # @return [String] url of current frame, or browser url if
-    # it is a root frame
-    def get_url
-      execute_javascript('return window.location.href')
-    rescue Selenium::WebDriver::Error::NoSuchDriverError, TimeoutError => e
-      raise(e.class, "Browser is crushed or hangup with #{e}")
-    end
-
-    def refresh
-      @driver.navigate.refresh
-      OnlyofficeLoggerHelper.log('Refresh page')
-    end
-
-    def go_back
-      @driver.navigate.back
-      OnlyofficeLoggerHelper.log('Go back to previous page')
-    end
-
-    # Perform drag'n'drop action in one element (for example on big canvas area)
-    # for drag'n'drop one whole element use 'drag_and_drop_by'
-    # ==== Attributes
-    #
-    # * +xpath+ - xpath of element on which drag and drop performed
-    # * +x1+ - x coordinate on element to start drag'n'drop
-    # * +y1+ - y coordinate on element to start drag'n'drop
-    # * +x2+ - shift vector x coordinate
-    # * +y2+ - shift vector y coordinate
-    # * +mouse_release+ - release mouse after move
-    def drag_and_drop(xpath, x1, y1, x2, y2, mouse_release: true)
-      canvas = get_element(xpath)
-
-      move_action = @driver.action
-                           .move_to(canvas, x1.to_i, y1.to_i)
-                           .click_and_hold
-                           .move_by(x2, y2)
-      move_action = move_action.release if mouse_release
-
-      move_action.perform
-    end
-
-    # Perform drag'n'drop one whole element
-    # for drag'n'drop inside one element (f.e. canvas) use drag_and_drop
-    # ==== Attributes
-    #
-    # * +source+ - xpath of element on which drag and drop performed
-    # * +right_by+ - shift vector x coordinate
-    # * +down_by+ - shift vector y coordinate
-    def drag_and_drop_by(source, right_by, down_by = 0)
-      @driver.action.drag_and_drop_by(get_element(source), right_by, down_by).perform
-    end
-
     def scroll_list_to_element(list_xpath, element_xpath)
       execute_javascript("$(document.evaluate(\"#{list_xpath}\", document, null, XPathResult.ANY_TYPE, null).
           iterateNext()).jScrollPane().data('jsp').scrollToElement(document.evaluate(\"#{element_xpath}\",
@@ -227,22 +151,6 @@ module OnlyofficeWebdriverWrapper
       (0...times).inject(@driver.action.move_to(element, right_by.to_i, down_by.to_i)) { |acc, _elem| acc.send(action) }.perform
     end
 
-    def move_to_element(element)
-      element = get_element(element) if element.is_a?(String)
-      @driver.action.move_to(element).perform
-    end
-
-    def move_to_element_by_locator(xpath_name)
-      element = get_element(xpath_name)
-      @driver.action.move_to(element).perform
-      OnlyofficeLoggerHelper.log("Moved mouse to element: #{xpath_name}")
-    end
-
-    def mouse_over(xpath_name, x_coordinate = 0, y_coordinate = 0)
-      wait_until_element_present(xpath_name)
-      @driver.action.move_to(@driver.find_element(:xpath, xpath_name), x_coordinate.to_i, y_coordinate.to_i).perform
-    end
-
     def element_present?(xpath_name)
       case xpath_name
       when PageObject::Elements::Element
@@ -320,38 +228,6 @@ module OnlyofficeWebdriverWrapper
       webdriver_error("Raise unkwnown exception: #{e}")
     end
 
-    def wait_element(xpath_name, period_of_wait = 1, critical_time = 3)
-      wait_until_element_present(xpath_name)
-      time = 0
-      until element_visible?(xpath_name)
-        sleep(period_of_wait)
-        time += 1
-        return if time == critical_time
-      end
-    end
-
-    # Select frame as current
-    # @param [String] xpath_name name of current xpath
-    def select_frame(xpath_name = '//iframe', count_of_frames = 1)
-      (0...count_of_frames).each do
-        frame = @driver.find_element(:xpath, xpath_name)
-        @driver.switch_to.frame frame
-      rescue Selenium::WebDriver::Error::NoSuchElementError
-        OnlyofficeLoggerHelper.log('Raise NoSuchElementError in the select_frame method')
-      rescue Exception => e
-        webdriver_error("Raise unkwnown exception: #{e}")
-      end
-    end
-
-    # Select top frame of browser (even if several subframes exists)
-    def select_top_frame
-      @driver.switch_to.default_content
-    rescue Timeout::Error
-      OnlyofficeLoggerHelper.log('Raise TimeoutError in the select_top_frame method')
-    rescue Exception => e
-      raise "Browser is crushed or hangup with error: #{e}"
-    end
-
     # Get text of current element
     # @param [String] xpath_name name of xpath
     # @param [true, false] wait_until_visible wait until element visible [@default = true]

data/lib/onlyoffice_webdriver_wrapper/webdriver/wait_until_methods.rb

@@ -34,6 +34,21 @@ module OnlyofficeWebdriverWrapper
       webdriver_error("Element #{xpath_name} not visible for #{timeout} seconds")
     end
 
+    # Wait until element present and visible
+    # @param [String] xpath_name xpath of element
+    # @param [Integer] period_of_wait how much time sleep each iteration of wait
+    # @param [Integer] critical_time maximum time for wait for element
+    # @return [nil]
+    def wait_element(xpath_name, period_of_wait = 1, critical_time = 3)
+      wait_until_element_present(xpath_name)
+      time = 0
+      until element_visible?(xpath_name)
+        sleep(period_of_wait)
+        time += 1
+        return if time == critical_time
+      end
+    end
+
     # Wait until some element present
     # If timeout exceeded - raise an error
     # @param xpath_name [String] xpath of element

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_frame_methods.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OnlyofficeWebdriverWrapper
+  # Methods for webdriver frame operations
+  module WebdriverFrameMethods
+    # Select frame as current
+    # @param [String] xpath_name name of current xpath
+    # @param [Integer] count_of_frames how much times select xpath_name
+    # @return [nil]
+    def select_frame(xpath_name = '//iframe', count_of_frames = 1)
+      (0...count_of_frames).each do
+        frame = @driver.find_element(:xpath, xpath_name)
+        @driver.switch_to.frame frame
+      rescue Selenium::WebDriver::Error::NoSuchElementError
+        OnlyofficeLoggerHelper.log('Raise NoSuchElementError in the select_frame method')
+      rescue Exception => e
+        webdriver_error("Raise unkwnown exception: #{e}")
+      end
+    end
+
+    # Select top frame of browser (even if several subframes exists)
+    # @return [nil]
+    def select_top_frame
+      @driver.switch_to.default_content
+    rescue Timeout::Error
+      OnlyofficeLoggerHelper.log('Raise TimeoutError in the select_top_frame method')
+    rescue Exception => e
+      raise "Browser is crushed or hangup with error: #{e}"
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_move_cursor_methods.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OnlyofficeWebdriverWrapper
+  # Methods for webdriver to move cursor
+  module WebdriverMoveCursorMethods
+    # Perform drag'n'drop action in one element (for example on big canvas area)
+    # for drag'n'drop one whole element use 'drag_and_drop_by'
+    # ==== Attributes
+    #
+    # * +xpath+ - xpath of element on which drag and drop performed
+    # * +x1+ - x coordinate on element to start drag'n'drop
+    # * +y1+ - y coordinate on element to start drag'n'drop
+    # * +x2+ - shift vector x coordinate
+    # * +y2+ - shift vector y coordinate
+    # * +mouse_release+ - release mouse after move
+    def drag_and_drop(xpath, x1, y1, x2, y2, mouse_release: true)
+      canvas = get_element(xpath)
+
+      move_action = @driver.action
+                           .move_to(canvas, x1.to_i, y1.to_i)
+                           .click_and_hold
+                           .move_by(x2, y2)
+      move_action = move_action.release if mouse_release
+
+      move_action.perform
+    end
+
+    # Perform drag'n'drop one whole element
+    # for drag'n'drop inside one element (f.e. canvas) use drag_and_drop
+    # ==== Attributes
+    #
+    # * +source+ - xpath of element on which drag and drop performed
+    # * +right_by+ - shift vector x coordinate
+    # * +down_by+ - shift vector y coordinate
+    def drag_and_drop_by(source, right_by, down_by = 0)
+      @driver.action.drag_and_drop_by(get_element(source), right_by, down_by).perform
+    end
+
+    # Move cursor to element
+    # @param [String, Selenium::WebDriver::Element] element xpath or webdriver element
+    # @return [nil]
+    def move_to_element(element)
+      element = get_element(element) if element.is_a?(String)
+      @driver.action.move_to(element).perform
+    end
+
+    # Move cursor to element
+    # @param [String] xpath_name
+    # @return [nil]
+    def move_to_element_by_locator(xpath_name)
+      element = get_element(xpath_name)
+      @driver.action.move_to(element).perform
+      OnlyofficeLoggerHelper.log("Moved mouse to element: #{xpath_name}")
+    end
+
+    # Move mouse over element
+    # @param [String] xpath_name element to move
+    # @param [Integer] x_coordinate position relate to center of element
+    # @param [Integer] y_coordinate position relate to center of element
+    # @return [nil]
+    def mouse_over(xpath_name, x_coordinate = 0, y_coordinate = 0)
+      wait_until_element_present(xpath_name)
+      @driver.action.move_to(@driver.find_element(:xpath, xpath_name), x_coordinate.to_i, y_coordinate.to_i).perform
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_navigation_methods.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OnlyofficeWebdriverWrapper
+  # Methods for webdriver navigations
+  module WebdriverNavigationMethods
+    # Open specific url
+    # @param [String] url to open
+    # @return [nil]
+    def open(url)
+      url = "http://#{url}" unless url.include?('http') || url.include?('file://')
+      @driver.navigate.to url
+      sleep(1) # Correct wait for Page to init focus
+      OnlyofficeLoggerHelper.log("Opened page: #{url}")
+    rescue StandardError => e
+      message = "Received error `#{e}` while opening page `#{url}`"
+      OnlyofficeLoggerHelper.log(message)
+      raise e.class, message, e.backtrace
+    end
+
+    # @return [String] url of current frame, or browser url if
+    #   it is a root frame
+    def get_url
+      execute_javascript('return window.location.href')
+    rescue Selenium::WebDriver::Error::NoSuchDriverError, TimeoutError => e
+      raise(e.class, "Browser is crushed or hangup with #{e}")
+    end
+
+    # Refresh current page
+    # @return [nil]
+    def refresh
+      @driver.navigate.refresh
+      OnlyofficeLoggerHelper.log('Refresh page')
+    end
+
+    # Go back like pressing `Back` button in browser
+    # @return [nil]
+    def go_back
+      @driver.navigate.back
+      OnlyofficeLoggerHelper.log('Go back to previous page')
+    end
+
+    # Quit current browser session
+    # @return [nil]
+    def quit
+      return unless browser_running
+
+      begin
+        @driver.execute_script('window.onbeforeunload = null') # off popup window
+      rescue StandardError
+        Exception
+      end
+      begin
+        @driver.quit
+      rescue Exception => e
+        OnlyofficeLoggerHelper.log("Some error happened on webdriver.quit #{e.backtrace}")
+      end
+      alert_confirm
+      @headless.stop
+      cleanup_download_folder
+      @browser_running = false
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_webdriver_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: headless
@@ -271,8 +271,11 @@ files:
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_browser_info_helper.rb
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_browser_log_helper.rb
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_exceptions.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_frame_methods.rb
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_helper.rb
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_js_methods.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_move_cursor_methods.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_navigation_methods.rb
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_screenshot_helper.rb
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_style_helper.rb
 - lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_tab_helper.rb