selenium_webdriver_helper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e08ab77d20d3af314a73856fcfacbb67f67c8631f1b92b950c953ee6de1426ff
-  data.tar.gz: 24bf1affb19c70ef8165f58bec05dceb29fea32c1d4b42abf8a0685caefdc441
+  metadata.gz: 7349efe2787f5c5a2234be89e0a933b9250a879b8b93eb9dba2de373a3c8a1b6
+  data.tar.gz: 7ae2eaf291e8d58aa460b7ddc7099217c5a6fe5dddab0944b9624e0a27643c75
 SHA512:
-  metadata.gz: dfda801b0245d864ea1d974ecc15dea69c74a5e0df756e25fde1e6c2fa7f130b8c42ea9ddc9d65e28fc1d598f43c12f5cd13783e69c9a03f21675f0c8c82258f
-  data.tar.gz: 9b2ebd792fa7f9b1c162146758a4773954a305d67763d21475a758e254f2a6cf90f0e380f0483a5386ecaf7e35b2378364c0965a63020d9173ee7f4bc0ccc8b5
+  metadata.gz: d1e0a0a2b688e941bc9867b2aad62d0c5f88316cb891217ff91093a90cea2ce114b1fd54b4c16f5a470626c1bd437f49d54bfef7b0653de3413c1e7c787f545e
+  data.tar.gz: 77663ef3f73c5ed9ee489331aa94e28400ea051f84b7bc3b6a28e72503f2d61d95f07da3705d06addea6f69152f3b971dbf76ad65664c6e330f961e03628add3

data/Gemfile

@@ -6,5 +6,5 @@ source "https://rubygems.org"
 gemspec
 
 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.2.0"
 end

data/lib/selenium_webdriver_helper.rb

@@ -1,8 +1,150 @@
 # frozen_string_literal: true
 
+# 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_relative "selenium_webdriver_helper/version"
 
+# 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 initialize(driver)
+    @driver = driver
+  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 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 get_element(selector, custom_timeout: nil, driver2: nil)
+    how, what = selectors_from_page_objects(selector)
+    block_execution(3) do
+      wait = Selenium::WebDriver::Wait.new(timeout: (custom_timeout.nil? ? LONGER_WAIT : custom_timeout))
+      begin
+        wait.until { (driver2.nil? ? @driver : driver2).find_element(how, what).displayed? }
+        (driver2.nil? ? @driver : driver2).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)
+    how, what = selectors_from_page_objects(selector)
+    block_execution(3) do
+      wait = Selenium::WebDriver::Wait.new(timeout: (custom_timeout.nil? ? LONGER_WAIT : custom_timeout))
+      begin
+        wait.until { (driver2.nil? ? @driver : driver2).find_elements(how, what)[0].displayed? }
+        (driver2.nil? ? @driver : driver2).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)
+    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" }
+  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, timeout: LONG_WAIT)
+    wait = Selenium::WebDriver::Wait.new(timeout: 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, driver2: nil)
+    how, what = selectors_from_page_objects(selector)
+    5.times do
+      (driver2.nil? ? @driver : driver2).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.nil? ? LONGER_WAIT : 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.nil? ? LONGER_WAIT : 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
+  end
+
+  def page_refresh_js(driver2: nil)
+    (driver2.nil? ? @driver : driver2).execute_script("location.reload(true);")
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium_webdriver_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - amit-singh-bisht
@@ -23,6 +23,7 @@ files:
 - 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