selenium_webdriver_helper 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e08ab77d20d3af314a73856fcfacbb67f67c8631f1b92b950c953ee6de1426ff
-  data.tar.gz: 24bf1affb19c70ef8165f58bec05dceb29fea32c1d4b42abf8a0685caefdc441
+  metadata.gz: d124968bcf54480e5dc80cc2e9c609b743e7777ba38e0638d28d264766ea2110
+  data.tar.gz: 3e2a846de538ccc648bc2128c2a966fe163aa86ee72829b745942192e8bf7a2c
 SHA512:
-  metadata.gz: dfda801b0245d864ea1d974ecc15dea69c74a5e0df756e25fde1e6c2fa7f130b8c42ea9ddc9d65e28fc1d598f43c12f5cd13783e69c9a03f21675f0c8c82258f
-  data.tar.gz: 9b2ebd792fa7f9b1c162146758a4773954a305d67763d21475a758e254f2a6cf90f0e380f0483a5386ecaf7e35b2378364c0965a63020d9173ee7f4bc0ccc8b5
+  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 'logger'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'
+gem 'selenium-webdriver'

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 amitsingh-bisht
+Copyright (c) 2022 amit-singh-bisht
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/selenium_webdriver_helper/constants.rb

@@ -0,0 +1,10 @@
+SUPER_ULTRA_SHORT_WAIT = 0.5
+ULTRA_SHORT_WAIT = 1
+SHORTEST_WAIT = 2
+SHORTER_WAIT = 5
+SHORT_WAIT = 10
+LONG_WAIT = 15
+LONGER_WAIT = 30
+LONGEST_WAIT = 45
+ULTRA_LONG_WAIT = 60
+SUPER_ULTRA_LONG_WAIT = 90

data/lib/selenium_webdriver_helper/version.rb

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

data/lib/selenium_webdriver_helper.rb

@@ -1,8 +1,203 @@
 # frozen_string_literal: true
 
-require_relative "selenium_webdriver_helper/version"
+# The MIT License (MIT)
+#
+# Copyright (c) 2022 amit-singh-bisht
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 
+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
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  attr_accessor :driver
+
+  def log_info(message)
+    logger = Logger.new('selenium.log')
+    logger.info(message)
+  end
+
+  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)
+    output = []
+    if page_object.is_a?(Array)
+      output << page_object.first
+      output << page_object.last
+    elsif page_object.is_a?(Hash)
+      output = page_object.first
+    elsif value.nil?
+      raise "Locator cannot be nil - #{page_object} #{value}"
+    end
+    output
+  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?
+  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)
+      begin
+        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: LONGER_WAIT, driver: $driver)
+    how, what = selectors_from_page_objects(selector)
+    block_execution(3) do
+      wait = Selenium::WebDriver::Wait.new(timeout: custom_timeout)
+      begin
+        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 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 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)
+    element_list = get_elements(selector, false)
+    element_list.each do |element|
+      return element if element.displayed?
+    end
+    raise "No visible element found for selector - #{selector}"
+  end
+
+  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
+      wait.until { element_displayed?(selector_or_element) == visibility }
+    end
+  end
+
+  def wait_for_element(selector, driver = $driver)
+    how, what = selectors_from_page_objects(selector)
+    5.times do
+      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)
+    how, what = selectors_from_page_objects(selector)
+    block_execution(3) do
+      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)
+    how, what = selectors_from_page_objects(selector)
+    block_execution(3) do
+      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(driver = $driver)
+    driver.navigate.refresh
+  end
+
+  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.1.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,14 +17,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - 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