onlyoffice_webdriver_wrapper 1.6.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29b6744e1acea477bcbfce6af74b2eaab02864d6985be19be496ab26c7a66208
-  data.tar.gz: 7c2c0b68f14012ccb7f95f3a6f2d7698f12e83a8f06cdd0f48382037cdf33d9c
+  metadata.gz: 776391f3667781696f5c73f6b3839fa17ed3965deaaaa53e4c0717b4915f2ced
+  data.tar.gz: 5d9c932257c2e35e99464657ac3c00f8069a90d40bfc7ffc0d1e1c599ab3aee2
 SHA512:
-  metadata.gz: 06ab15b74f6d81bdcb0fda5b6893465cff70499ab72f68d3483b4aeec91d8abf7f4ae653a650b8b8f5ac7d69d2e75b5c78017d45f2ca795110b40920725fe1c5
-  data.tar.gz: 55c083c94d1d1ead6acccb73244131670a0796cb2927424c123b557aee2c67e00b4e5f5266ae16657c1250e89fe243dd6ccf36638fbdb938f950fe447e472c73
+  metadata.gz: 15a1d5affae01a3e6857ec9b7b592e89f9007e841f7a4d9c83043c1fc020b1086f6d9b59594f94239a47469d727db095d83187a3e2f9e25fd2caba632d958dbc
+  data.tar.gz: d313861c4bda34d5452b95e9caaf29a53c13899f53d16fb95d699c98ead637311ff28b67b8533a7718f746c6eeb576f078a8dd6df211f48f6f88d62a97288326

data/lib/onlyoffice_webdriver_wrapper/dimensions.rb

@@ -10,6 +10,15 @@ module OnlyofficeWebdriverWrapper
       @top = top
     end
 
+    # Compare two dimensions object
+    # @param [Object] other object
+    # @return [Boolean] result of comparison
+    def ==(other)
+      return false unless other.respond_to?(:left) && other.respond_to?(:top)
+
+      @left == other.left && @top == other.top
+    end
+
     alias width left
     alias height top
     alias x left
@@ -19,5 +28,10 @@ module OnlyofficeWebdriverWrapper
     def to_s
       "Dimensions(left: #{@left}, top: #{@top})"
     end
+
+    # @return [Dimensions] Center point of current dimension
+    def center
+      Dimensions.new(@left / 2, @top / 2)
+    end
   end
 end

data/lib/onlyoffice_webdriver_wrapper/helpers/firefox_helper.rb

@@ -29,7 +29,7 @@ module OnlyofficeWebdriverWrapper
 
     # @return [Array<String>] list of formats to save
     def read_firefox_files_to_save
-      path_to_file = "#{Dir.pwd}/lib/onlyoffice_webdriver_wrapper/"\
+      path_to_file = "#{Dir.pwd}/lib/onlyoffice_webdriver_wrapper/" \
                      'helpers/firefox_helper/save_to_disk_files.list'
       OnlyofficeFileHelper::FileHelper.read_array_from_file(path_to_file)
                                       .join(', ')

data/lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/{headless_screenshot_patch.rb → headless_patch.rb}

@@ -21,3 +21,26 @@ class Headless
     end
   end
 end
+
+# Until https://github.com/leonid-shevtsov/headless/pull/106
+# is released in stable version
+class Headless
+  # Class for handling video records
+  class VideoRecorder
+    # Stop recording and save it
+    # @param [String] path to save
+    # @retunr [nil, String] path to result file or nil if error
+    def stop_and_save(path)
+      CliUtil.kill_process(@pid_file_path, :wait => true)
+      if File.exist? @tmp_file_path
+        begin
+          FileUtils.mkdir_p(File.dirname(path))
+          FileUtils.mv(@tmp_file_path, path)
+        rescue Errno::EINVAL
+          nil
+        end
+      end
+    end
+  end
+end
+

data/lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb

@@ -3,7 +3,7 @@
 require_relative 'headless_helper/real_display_tools'
 require_relative 'headless_helper/ruby_helper'
 require 'headless'
-require_relative 'headless_helper/headless_screenshot_patch'
+require_relative 'headless_helper/headless_patch'
 require_relative 'headless_helper/headless_video_recorder'
 
 module OnlyofficeWebdriverWrapper

data/lib/onlyoffice_webdriver_wrapper/version.rb

@@ -4,6 +4,6 @@ module OnlyofficeWebdriverWrapper
   # Module for storing version data
   module Version
     # @return [String] Current stable version of gem
-    STRING = '1.6.0'
+    STRING = '1.8.1'
   end
 end

data/lib/onlyoffice_webdriver_wrapper/webdriver/click_methods.rb

@@ -50,9 +50,8 @@ module OnlyofficeWebdriverWrapper
     # @return [nil]
     def click_on_locator_coordinates(xpath_name, right_by, down_by)
       wait_until_element_visible(xpath_name)
-      element = @driver.find_element(:xpath, xpath_name)
-      @driver.action.move_to(element, right_by.to_i, down_by.to_i).perform
-      @driver.action.move_to(element, right_by.to_i, down_by.to_i).click.perform
+      move_to_driver_action(xpath_name, right_by, down_by).perform
+      move_to_driver_action(xpath_name, right_by, down_by).click.perform
     end
 
     # Click on one of several which displayed
@@ -99,9 +98,8 @@ module OnlyofficeWebdriverWrapper
     # @return [nil]
     def right_click_on_locator_coordinates(xpath_name, right_by = nil, down_by = nil)
       wait_until_element_visible(xpath_name)
-      element = @driver.find_element(:xpath, xpath_name)
-      @driver.action.move_to(element, right_by.to_i, down_by.to_i).perform
-      @driver.action.move_to(element, right_by.to_i, down_by.to_i).context_click.perform
+      move_to_driver_action(xpath_name, right_by, down_by).perform
+      move_to_driver_action(xpath_name, right_by, down_by).context_click.perform
     end
 
     # Perform double_click on element
@@ -119,7 +117,7 @@ module OnlyofficeWebdriverWrapper
     # @return [nil]
     def double_click_on_locator_coordinates(xpath_name, right_by, down_by)
       wait_until_element_visible(xpath_name)
-      @driver.action.move_to(@driver.find_element(:xpath, xpath_name), right_by.to_i, down_by.to_i).double_click.perform
+      move_to_driver_action(xpath_name, right_by, down_by).double_click.perform
     end
   end
 end

data/lib/onlyoffice_webdriver_wrapper/webdriver/wait_until_methods.rb

@@ -71,8 +71,8 @@ module OnlyofficeWebdriverWrapper
       begin
         wait.until { get_element(xpath_name) }
       rescue Selenium::WebDriver::Error::TimeoutError => e
-        timeout_message = "wait_until_element_present(#{xpath_name}) "\
-                          'Selenium::WebDriver::Error::TimeoutError: '\
+        timeout_message = "wait_until_element_present(#{xpath_name}) " \
+                          'Selenium::WebDriver::Error::TimeoutError: ' \
                           "timed out after #{timeout} seconds"
         webdriver_error(e.class, timeout_message)
       end
@@ -88,8 +88,8 @@ module OnlyofficeWebdriverWrapper
       begin
         wait.until { get_element(xpath_name) ? false : true }
       rescue Selenium::WebDriver::Error::TimeoutError => e
-        timeout_message = "wait_until_element_present(#{xpath_name}) "\
-                          'Selenium::WebDriver::Error::TimeoutError: '\
+        timeout_message = "wait_until_element_present(#{xpath_name}) " \
+                          'Selenium::WebDriver::Error::TimeoutError: ' \
                           "timed out after #{timeout} seconds"
         webdriver_error(e.class, timeout_message)
       end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_helper.rb

@@ -33,7 +33,7 @@ module OnlyofficeWebdriverWrapper
       if @download_directory.start_with?(Dir.tmpdir)
         FileUtils.remove_dir(@download_directory)
       else
-        OnlyofficeLoggerHelper.log("Download directory #{@download_directory} is not at tmp dir. "\
+        OnlyofficeLoggerHelper.log("Download directory #{@download_directory} is not at tmp dir. " \
                                    'It will be not deleted')
       end
     end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_js_methods.rb

@@ -104,8 +104,8 @@ module OnlyofficeWebdriverWrapper
     # @param [String] xpath of element to remove
     # @return [String] result of javascript execution
     def remove_element(xpath)
-      script = "element = #{dom_element_by_xpath(xpath)};"\
-               'if (element !== null) '\
+      script = "element = #{dom_element_by_xpath(xpath)};" \
+               'if (element !== null) ' \
                '{element.parentNode.removeChild(element);};'
       execute_javascript(script)
     end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_move_cursor_methods.rb

@@ -14,12 +14,9 @@ module OnlyofficeWebdriverWrapper
     # * +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_to_driver_action(xpath, x1, y1)
+                    .click_and_hold
+                    .move_by(x2, y2)
       move_action = move_action.release if mouse_release
 
       move_action.perform
@@ -33,15 +30,10 @@ module OnlyofficeWebdriverWrapper
     # * +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
+      shift_to_zero = move_to_shift_to_top_left(source)
+      @driver.action.drag_and_drop_by(get_element(source),
+                                      right_by - shift_to_zero.x,
+                                      down_by - shift_to_zero.y).perform
     end
 
     # Move cursor to element
@@ -60,7 +52,34 @@ module OnlyofficeWebdriverWrapper
     # @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
+      move_to_driver_action(xpath_name, x_coordinate, y_coordinate).perform
+    end
+
+    private
+
+    # Since v4.3.0 of `webdriver` gem `move_to` method is moving
+    # from the center of the element
+    # Add additional negative shift if this version is used
+    def move_to_shift_to_top_left(xpath)
+      if Gem.loaded_specs['selenium-webdriver'].version >= Gem::Version.new('4.3.0')
+        element_size = element_size_by_js(xpath)
+        Dimensions.new(element_size.x / 2, element_size.y / 2)
+      else
+        Dimensions.new(0, 0)
+      end
+    end
+
+    # Generate action to move cursor to element
+    # @param [String] xpath xpath to move
+    # @param [Integer] right_by shift vector x coordinate
+    # @param [Integer] down_by shift vector y coordinate
+    # @return [Selenium::WebDriver::ActionBuilder] object to perform actions
+    def move_to_driver_action(xpath, right_by, down_by)
+      element = @driver.find_element(:xpath, xpath)
+      shift_to_zero = move_to_shift_to_top_left(xpath)
+      @driver.action.move_to(element,
+                             right_by.to_i - shift_to_zero.x,
+                             down_by.to_i - shift_to_zero.y)
     end
   end
 end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_screenshot_helper.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'fileutils'
 require 'onlyoffice_s3_wrapper'
 module OnlyofficeWebdriverWrapper
   # Working with screenshots
@@ -25,7 +26,7 @@ module OnlyofficeWebdriverWrapper
       begin
         get_screenshot(path_to_screenshot)
         cloud_screenshot = publish_screenshot(path_to_screenshot)
-        File.delete(path_to_screenshot) if File.exist?(path_to_screenshot)
+        FileUtils.rm_rf(path_to_screenshot)
         OnlyofficeLoggerHelper.log("upload screenshot: #{cloud_screenshot}")
         return cloud_screenshot
       rescue Errno::ENOENT => e

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_tab_helper.rb

@@ -22,16 +22,17 @@ module OnlyofficeWebdriverWrapper
     end
 
     # Switch to popup window
+    # @param popup_appear_timeout [Integer] how much time to wait for popup window
     # @param after_switch_timeout [Integer] wait after switch to window
     # non-zero to workaround bug with page load hanging up after switch
     # @return [void]
-    def switch_to_popup(after_switch_timeout: 3)
+    def switch_to_popup(after_switch_timeout: 3, popup_appear_timeout: 30)
       counter = 0
-      while tab_count < 2 && counter < 30
+      while tab_count < 2 && counter < popup_appear_timeout
         sleep 1
         counter += 1
       end
-      webdriver_error('switch_to_popup: Popup window not found') if counter >= 30
+      webdriver_error('switch_to_popup: Popup window not found') if counter >= popup_appear_timeout
       list_of_handlers = @driver.window_handles
       last_window_handler = list_of_handlers.last
       @driver.switch_to.window(last_window_handler)

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_type_helper.rb

@@ -38,9 +38,9 @@ module OnlyofficeWebdriverWrapper
         begin
           element.clear
         rescue Exception => e
-          webdriver_error(e.class, "Error in element.clear #{e} for "\
-                                   "type_to_locator(#{xpath_name}, #{text_to_send}, "\
-                                   "#{clear_content}, #{click_on_it}, "\
+          webdriver_error(e.class, "Error in element.clear #{e} for " \
+                                   "type_to_locator(#{xpath_name}, #{text_to_send}, " \
+                                   "#{clear_content}, #{click_on_it}, " \
                                    "#{by_action}, #{by_element_send_key})")
         end
       end
@@ -73,7 +73,7 @@ module OnlyofficeWebdriverWrapper
       element = get_element(xpath_name)
       if element.nil?
         webdriver_error(Selenium::WebDriver::Error::NoSuchElementError,
-                        "type_to_input(#{xpath_name}, #{text_to_send}, "\
+                        "type_to_input(#{xpath_name}, #{text_to_send}, " \
                         "#{clear_content}, #{click_on_it}): element not found")
       end
       element.clear if clear_content

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_user_agent_helper.rb

@@ -4,20 +4,20 @@ module OnlyofficeWebdriverWrapper
   # Module for working with webdriver useragent
   module WebdriverUserAgentHelper
     # @return [String] useragent for Android phone browser
-    USERAGENT_ANDROID_PHONE = 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MDB08M) '\
-                              'AppleWebKit/537.36 (KHTML, like Gecko) '\
+    USERAGENT_ANDROID_PHONE = 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MDB08M) ' \
+                              'AppleWebKit/537.36 (KHTML, like Gecko) ' \
                               'Chrome/51.0.2704.81 Mobile Safari/537.36'
     # @return [String] useragent for iPhone browser
-    USERAGENT_IPHONE = 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_3_2 like Mac OS X) '\
-                       'AppleWebKit/601.1.46 (KHTML, like Gecko) '\
+    USERAGENT_IPHONE = 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_3_2 like Mac OS X) ' \
+                       'AppleWebKit/601.1.46 (KHTML, like Gecko) ' \
                        'Version/9.0 Mobile/13F69 Safari/601.1'
     # @return [String] useragent for iPad Air 2 Safari browser
-    USERAGENT_IPAD_AIR_2_SAFARI = 'Mozilla/5.0 (iPad; CPU OS 10_0 like Mac OS X) '\
-                                  'AppleWebKit/602.1.50 (KHTML, like Gecko) '\
+    USERAGENT_IPAD_AIR_2_SAFARI = 'Mozilla/5.0 (iPad; CPU OS 10_0 like Mac OS X) ' \
+                                  'AppleWebKit/602.1.50 (KHTML, like Gecko) ' \
                                   'Version/10.0 Mobile/14A5346a Safari/602.1'
     # @return [String] useragent for Nexus 10 Chrome browser
-    USERAGENT_NEXUS_10_CHROME = 'Mozilla/5.0 (Linux; Android 4.3; Nexus 10 Build/JSS15Q) '\
-                                'AppleWebKit/537.36 (KHTML, like Gecko) '\
+    USERAGENT_NEXUS_10_CHROME = 'Mozilla/5.0 (Linux; Android 4.3; Nexus 10 Build/JSS15Q) ' \
+                                'AppleWebKit/537.36 (KHTML, like Gecko) ' \
                                 'Chrome/48.0.2564.23 Safari/537.36'
 
     # @return [String, nil] user agent string for current device

data/lib/onlyoffice_webdriver_wrapper/webdriver.rb

@@ -119,12 +119,13 @@ module OnlyofficeWebdriverWrapper
     end
 
     # Get index of element by it's text
-    # @param [String] title to compare text
-    # @param [Array<Objects>] list_elements to find in which
-    # @return [Object, nil] nil if nothing found
-    def get_element_index(title, list_elements)
+    # @param [String] text to compare text
+    # @param [Array<PageObject::Elements::Element>] list_elements array with
+    #   PageObject elements to find in
+    # @return [Integer, nil] nil if nothing found, index if found
+    def get_element_index(text, list_elements)
       list_elements.each_with_index do |current, i|
-        return i if get_text(current) == title
+        return i if get_text(current) == text
       end
       nil
     end
@@ -168,7 +169,7 @@ module OnlyofficeWebdriverWrapper
         set_style_attribute("#{xpath_name}/button", 'display', 'inline-block')
         set_style_attribute(xpath_name, 'display', 'block')
       else
-        @driver.action.move_to(element, horizontal_shift, vertical_shift).click.perform
+        move_to_driver_action(xpath_name, horizontal_shift, vertical_shift).click.perform
       end
     end
 
@@ -181,11 +182,11 @@ module OnlyofficeWebdriverWrapper
     # @return [void]
     def action_on_locator_coordinates(xpath_name, right_by, down_by, action = :click, times = 1)
       wait_until_element_visible(xpath_name)
-      element = @driver.find_element(:xpath, xpath_name)
-      (0...times).inject(@driver.action.move_to(element, right_by.to_i, down_by.to_i)) { |acc, _elem| acc.send(action) }.perform
+      (0...times).inject(move_to_driver_action(xpath_name, right_by, down_by)) { |acc, _elem| acc.send(action) }.perform
     end
 
     # Check if element present on page
+    # It may be visible or invisible, but should be present in DOM tree
     # @param [String] xpath_name to find element
     # @return [Boolean] result of check
     def element_present?(xpath_name)
@@ -243,6 +244,7 @@ module OnlyofficeWebdriverWrapper
     end
 
     # Check if element visible on page
+    # It should be part of DOM and should be visible on current visible part of page
     # @param [String] xpath_name element to find
     # @return [Boolean] result of check
     def element_visible?(xpath_name)
@@ -254,7 +256,8 @@ module OnlyofficeWebdriverWrapper
 
         begin
           visible = element.displayed?
-        rescue Exception
+        rescue Exception => e
+          OnlyofficeLoggerHelper.log("Element #{xpath_name} is not visible because of: #{e.message}")
           visible = false
         end
         visible
@@ -295,7 +298,7 @@ module OnlyofficeWebdriverWrapper
     # @param [String] xpath_several_elements to find objects
     # @return [Array<String>] text of those elements
     def get_text_of_several_elements(xpath_several_elements)
-      @driver.find_elements(:xpath, xpath_several_elements).map { |element| element.text unless element.text == '' }.compact
+      @driver.find_elements(:xpath, xpath_several_elements).filter_map { |element| element.text unless element.text == '' }
     end
 
     # Select value of combo box

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_webdriver_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.1
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: headless
@@ -275,14 +275,14 @@ files:
 - lib/onlyoffice_webdriver_wrapper/helpers/bin/geckodriver
 - lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper.rb
 - lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper/chrome_version_helper.rb
-- lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper/chromedriver_bin/chromedriver_linux_100
 - lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper/chromedriver_bin/chromedriver_linux_101
 - lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper/chromedriver_bin/chromedriver_linux_102
+- lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper/chromedriver_bin/chromedriver_linux_103
 - lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper/chromedriver_bin/chromedriver_mac
 - lib/onlyoffice_webdriver_wrapper/helpers/firefox_helper.rb
 - lib/onlyoffice_webdriver_wrapper/helpers/firefox_helper/save_to_disk_files.list
 - lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb
-- lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/headless_screenshot_patch.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/headless_patch.rb
 - lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/headless_video_recorder.rb
 - lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/real_display_tools.rb
 - lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/ruby_helper.rb
@@ -325,14 +325,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.17
 signing_key: 
 specification_version: 4
 summary: ONLYOFFICE Webdriver Wrapper Gem