selenium_webdriver_helper 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7349efe2787f5c5a2234be89e0a933b9250a879b8b93eb9dba2de373a3c8a1b6
-  data.tar.gz: 7ae2eaf291e8d58aa460b7ddc7099217c5a6fe5dddab0944b9624e0a27643c75
+  metadata.gz: d124968bcf54480e5dc80cc2e9c609b743e7777ba38e0638d28d264766ea2110
+  data.tar.gz: 3e2a846de538ccc648bc2128c2a966fe163aa86ee72829b745942192e8bf7a2c
 SHA512:
-  metadata.gz: d1e0a0a2b688e941bc9867b2aad62d0c5f88316cb891217ff91093a90cea2ce114b1fd54b4c16f5a470626c1bd437f49d54bfef7b0653de3413c1e7c787f545e
-  data.tar.gz: 77663ef3f73c5ed9ee489331aa94e28400ea051f84b7bc3b6a28e72503f2d61d95f07da3705d06addea6f69152f3b971dbf76ad65664c6e330f961e03628add3
+  metadata.gz: 60e09a27671c024c9c27fee727d3caddfaba6496247041017ae34d1066c122c33cec38b4732b079aba6207c928f341f1a8cf662924abdeb2d14722498cfa3e0d
+  data.tar.gz: dd62e3d4632a50fb3f17d2587da02d1c42c911f82b0490de9ec7501aab1ab5af325b19e666a161286a4267551caecaea6a85813e0f70631ade259f17de055f27

data/Gemfile

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in selenium_webdriver_helper.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.21"
-gem "selenium-webdriver"
+gem 'logger'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'
+gem 'selenium-webdriver'

data/lib/selenium_webdriver_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SeleniumWebdriverHelper
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/lib/selenium_webdriver_helper.rb

@@ -22,8 +22,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require "selenium-webdriver"
-require_relative "selenium_webdriver_helper/version"
+require 'selenium-webdriver'
+require 'logger'
+require_relative 'selenium_webdriver_helper/version'
+require_relative 'selenium_webdriver_helper/constants'
 
 # below is the code to make life easier as it already has selenium webdriver methods defined
 module SeleniumWebdriverHelper
@@ -32,16 +34,19 @@ module SeleniumWebdriverHelper
 
   attr_accessor :driver
 
-  def initialize(driver)
-    @driver = driver
+  def log_info(message)
+    logger = Logger.new('selenium.log')
+    logger.info(message)
   end
 
-  def block_execution(retry_count = 3, &block)
-    block.call
-  rescue Selenium::WebDriver::Error => e
-    logger.info "#{e.message} \n #{e.backtrace}"
-    retry_count -= 1
-    retry if retry_count.positive?
+  def log_debug(message)
+    logger = Logger.new('selenium.log')
+    logger.debug(message)
+  end
+
+  def log_error(message)
+    logger = Logger.new('selenium.log')
+    logger.error(message)
   end
 
   def selectors_from_page_objects(page_object, value = nil)
@@ -57,41 +62,89 @@ module SeleniumWebdriverHelper
     output
   end
 
-  def get_element(selector, custom_timeout: nil, driver2: nil)
+  def block_execution(retry_count = 3, &block)
+    block.call
+  rescue Selenium::WebDriver::Error => e
+    logger.info "#{e.message} \n #{e.backtrace}"
+    retry_count -= 1
+    retry if retry_count.positive?
+  end
+
+  def initialize_driver(driver, implicit_wait = LONGER_WAIT)
+    $driver = driver
+    $driver.manage.timeouts.implicit_wait = implicit_wait
+    $wait = Selenium::WebDriver::Wait.new(timeout: implicit_wait) # seconds
+  end
+
+  def execute_script(js, *args)
+    $driver.execute_script(js, *args)
+  rescue Selenium::WebDriver::Error::UnsupportedOperationError => e
+    log_error("[Exception] underlying webdriver instance does not support javascript #{e.message}")
+  end
+
+  def wait_for_page_load(custom_timeout = SHORTER_WAIT)
+    wait = Selenium::WebDriver::Wait.new(timeout: custom_timeout)
+    wait.until { execute_script('return document.readyState;') == 'complete' }
+  end
+
+  def get_url(url, driver = $driver)
+    driver.get(url)
+    wait_for_page_load
+    log_info("visited #{url}")
+  end
+
+  def maximize_window(driver = $driver)
+    driver.manage.window.maximize
+    log_info('window maximized')
+  end
+
+  def save_screenshot(path, driver = $driver)
+    driver.save_screenshot(path)
+    log_info("screenshot captured and saved at path #{path}")
+  end
+
+  def get_element(selector, custom_timeout = LONGER_WAIT, driver = $driver)
     how, what = selectors_from_page_objects(selector)
     block_execution(3) do
-      wait = Selenium::WebDriver::Wait.new(timeout: (custom_timeout.nil? ? LONGER_WAIT : custom_timeout))
+      wait = Selenium::WebDriver::Wait.new(timeout: custom_timeout)
       begin
-        wait.until { (driver2.nil? ? @driver : driver2).find_element(how, what).displayed? }
-        (driver2.nil? ? @driver : driver2).find_element(how, what)
+        wait.until { driver.find_element(how, what).displayed? }
+        driver.find_element(how, what)
       rescue Selenium::WebDriver::Error::NoSuchElementError => e
         raise "Exception #{e.message} \n #{e.backtrace}"
       end
     end
   end
 
-  def get_elements(selector, custom_timeout: nil, driver2: nil)
+  def get_elements(selector, custom_timeout: LONGER_WAIT, driver: $driver)
     how, what = selectors_from_page_objects(selector)
     block_execution(3) do
-      wait = Selenium::WebDriver::Wait.new(timeout: (custom_timeout.nil? ? LONGER_WAIT : custom_timeout))
+      wait = Selenium::WebDriver::Wait.new(timeout: custom_timeout)
       begin
-        wait.until { (driver2.nil? ? @driver : driver2).find_elements(how, what)[0].displayed? }
-        (driver2.nil? ? @driver : driver2).find_elements(how, what)
+        wait.until { driver.find_elements(how, what)[0].displayed? }
+        driver.find_elements(how, what)
       rescue Selenium::WebDriver::Error::NoSuchElementError => e
         raise "Exception #{e.message} \n #{e.backtrace}"
       end
     end
   end
 
-  def find_element_and_send_keys(selector, value)
+  def element_text(selector, custom_timeout = LONGER_WAIT, driver = $driver)
+    block_execution(3) do
+      get_element(selector, custom_timeout, driver).text
+    end
+  end
+
+  def find_element_and_send_keys(selector, value, driver = $driver)
     block_execution(3) do
       get_element(selector).send_keys(value)
     end
   end
 
-  def wait_for_page_load
-    wait = Selenium::WebDriver::Wait.new(LONG_WAIT)
-    wait.until { execute_script("return document.readyState;") == "complete" }
+  def element_click(selector, custom_timeout = LONGER_WAIT, driver = $driver)
+    block_execution(3) do
+      get_element(selector, custom_timeout, driver).click
+    end
   end
 
   def visible_element(selector)
@@ -102,8 +155,8 @@ module SeleniumWebdriverHelper
     raise "No visible element found for selector - #{selector}"
   end
 
-  def wait_for_element_visibility(selector_or_element, visibility: true, timeout: LONG_WAIT)
-    wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+  def wait_for_element_visibility(selector_or_element, visibility = true, custom_timeout = LONG_WAIT)
+    wait = Selenium::WebDriver::Wait.new(timeout: custom_timeout)
     if !(selector_or_element.is_a?(Array) || selector_or_element.is_a?(Hash))
       wait.until { selector_or_element.displayed? == visibility }
     else
@@ -111,40 +164,40 @@ module SeleniumWebdriverHelper
     end
   end
 
-  def wait_for_element(selector, driver2: nil)
+  def wait_for_element(selector, driver = $driver)
     how, what = selectors_from_page_objects(selector)
     5.times do
-      (driver2.nil? ? @driver : driver2).find_element(how, what)
+      driver.find_element(how, what)
       break
     rescue Selenium::WebDriver::Error::NoSuchElementError => e
       logger.info "[Exception] Retrying to find element due to exception #{e.message}"
     end
   end
 
-  def get_child_element(parent_element, selector, custom_timeout: LONG_WAIT)
+  def get_child_element(parent_element, selector, custom_timeout = LONG_WAIT)
     how, what = selectors_from_page_objects(selector)
     block_execution(3) do
-      wait = Selenium::WebDriver::Wait.new(timeout: (custom_timeout.nil? ? LONGER_WAIT : custom_timeout))
+      wait = Selenium::WebDriver::Wait.new(timeout: custom_timeout)
       wait.until { parent_element.find_element(how, what).displayed? }
       parent_element.find_element(how, what)
     end
   end
 
-  def get_child_elements(parent_element, selector, custom_timeout: LONG_WAIT)
+  def get_child_elements(parent_element, selector, custom_timeout = LONG_WAIT)
     how, what = selectors_from_page_objects(selector)
     block_execution(3) do
-      wait = Selenium::WebDriver::Wait.new(timeout: (custom_timeout.nil? ? LONGER_WAIT : custom_timeout))
+      wait = Selenium::WebDriver::Wait.new(timeout: custom_timeout)
       wait.until { parent_element.find_elements(how, what)[0].displayed? }
       parent_element.find_elements(how, what)
     end
   end
 
-  def page_refresh(driver2: nil)
-    (driver2.nil? ? @driver : driver2).navigate.refresh
+  def page_refresh(driver = $driver)
+    driver.navigate.refresh
   end
 
-  def page_refresh_js(driver2: nil)
-    (driver2.nil? ? @driver : driver2).execute_script("location.reload(true);")
+  def page_refresh_js
+    execute_script('location.reload(true);')
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selenium_webdriver_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - amit-singh-bisht
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies: []
 description: Write a longer description or delete this line.
 email:
@@ -17,7 +17,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -25,7 +24,6 @@ files:
 - lib/selenium_webdriver_helper.rb
 - lib/selenium_webdriver_helper/constants.rb
 - lib/selenium_webdriver_helper/version.rb
-- sig/selenium_webdriver_helper.rbs
 homepage: https://github.com/amit-singh-bisht/selenium_webdriver_helper_ruby
 licenses:
 - MIT

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.5
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/sig/selenium_webdriver_helper.rbs

@@ -1,4 +0,0 @@
-module SeleniumWebdriverHelper
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end