web-object 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd547488b2887d00bb588a8db5ff4944bb20d515
-  data.tar.gz: 15c86935df1d98dc89f594732a6f43f625ffe4dd
+  metadata.gz: 2a2fffeb3acf048b6957849ea39944b1c75a8c23
+  data.tar.gz: 0ea943c4bb8d2532da1539d40d490e40c6818249
 SHA512:
-  metadata.gz: 96df1f4533a1130f7e3f5ba0608537182e8dd848f5c38b738be6f6ba9a5e69285737cb1d9623d3a1b188a50cf3f7ca99a5ff3ce12ddb951a24876cad3965eb8c
-  data.tar.gz: 6aaa349dc3b5fa0a4f25cb505a9c044a0ca89a396e28116fa000bb4e30f29054f7d445000acee9aad460ef4bbf6ae49cdc53cfd35ef7ee4c435377cfd5c9952e
+  metadata.gz: cafb9c804bb6d197f8d2ad9ada415a51e0921fa2466703c5b7f39702d876467e3260e6c902442f0eb2a8387e2a71d49c1611b0b56513f99361e43866c291f5b5
+  data.tar.gz: 2ea732d8685f7ba1a2e6128e100870e735ee0d979722f7fc7a2786fd5f780659eb08de51ba7695d1812a7e2d1485bed492f39974f1b1cfe7684b0443c9934a1d

data/README.md

@@ -154,6 +154,30 @@ class Login < WebObject
   end
 end  
 ```   
+  
+## <a name="webconditions"></a> WebConditions :eyes: 
+Always envied the fancy ExpectedConditions class which Java and Python has where they smoothly pass a condition within the WebDriver explicit wait object... And when it comes to Ruby, you need to go through a painfully lenghty procudere of creating your own method or fallback to other framweworks like Capybara or Watir loosing the original WebDriver flavor.   
+  
+Well, not to worry as web-object gem to the rescue.     
+   
+web-object gem is now equipped with an extensive list of WebConditions (we do not want to be called people who copied the name from Java so we call it WebConditions).  It can be used for both waiting for a particular condition inside the wait.until object and also in rspec assertions.   
+   
+   
+How to use it then: here is how:    
+```   
+wait = Selenium::WebDriver::Wait.new(:timeout => 30)
+wait.until{alert_present?}
+```
+or
+```
+wait = Selenium::WebDriver::Wait.new(:timeout => 30)    # Create wait object
+wait.until{element_is_visible(element)}                 # Pass a condition with web element parameter 
+wait.until{element_is_invisible(:id => 'some_button')}  # or just pass a condition with a locator hash
+
+```  
+
+Full list of WebConditions and [documentation](https://github.com/krupani/web-object/wiki) on how to use can be found [here](https://github.com/krupani/web-object/wiki).
+
 
 ## <a name="alias"></a> Aliases :eyes:   
 There is an option to use PageObject class instead of WebObject.  

data/Rakefile

@@ -0,0 +1,5 @@
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new('run_unit') do |feature|
+  feature.cucumber_opts = 'features --profile default'
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --require features --no-source --color --format progress --format html --out wo_report.html

data/features/pages/web_object_form_page.rb

@@ -0,0 +1,81 @@
+class WebObjectFormPage < WebObject
+
+  element :delayed_alert_button, {:id => 'alert_button'}
+
+  element :toggle_visibility_button, {:id => 'toggle_visibility'}
+  element :toggle_visibility_text, {:id => 'visible_text'}
+
+  element :toggle_presence_button, {:id => 'toggle_presence'}
+  element :toggle_presence_link, {:id => 'toggle_presence_link'}, error=false
+
+  element :toggle_enability_button, {:id => 'enable_button'}
+  element :toggle_enability_field, {:id => 'enable_field'}
+
+  element :delayed_clickability_button, {:id => 'delayed_clickability'}
+  element :desired_clickable_button, {name: 'clickable_button'}
+
+  element :toggle_attribute_button, {:id => 'toggle_attribute'}
+  element :empty_attribute_button, {:id => 'empty_attribute'}
+
+
+  def wait_for_text_visibility(state)
+    wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+    if state=="visible"
+      # puts ExpectedConditions.instance_methods
+      wait.until{element_is_visible(toggle_visibility_text)}
+    else
+      wait.until{element_is_invisible(toggle_visibility_text)}
+    end
+  end
+
+  def wait_for_link_presence(state)
+    wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+    if state=="present"
+      wait.until{element_is_present(:id => 'toggle_presence_link')}
+    else
+      wait.until{element_is_absent(:id => 'toggle_presence_link')}
+    end
+  end
+
+  def wait_for_field_to_be_enabled(state)
+    wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+    if state=="enabled"
+      wait.until{element_is_enabled(toggle_enability_field)}
+    else
+      wait.until{element_is_disabled(toggle_enability_field)}
+    end
+  end
+
+  def wait_for_button_to_be_clickable
+    wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+    wait.until{element_is_clickable(desired_clickable_button)}
+  end
+
+  def wait_for_attribute(state)
+    wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+    if state=="present"
+      wait.until{attribute_is_present(toggle_attribute_button,'style')}
+    else
+      wait.until{attribute_is_absent(toggle_attribute_button,'style')}
+    end
+  end
+
+  def wait_for_attribute_value(state)
+    wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+    if state=="set"
+      wait.until{attribute_is_not_empty(empty_attribute_button,'style')}
+    else
+      wait.until{attribute_is_empty(empty_attribute_button,'style')}
+    end
+  end
+
+  def wait_for_attribute_value_match(action)
+    wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+    if action=="match"
+      wait.until{attribute_to_match(toggle_attribute_button, 'style', 'color: red;')}
+    else
+      wait.until{attribute_to_contain(toggle_attribute_button, 'style', 'red')}
+    end
+  end
+
+end

data/features/scenarios/alert.feature

@@ -0,0 +1,8 @@
+Feature: As a web-object author, I want to make sure
+  conditional method around alerts work fine.
+
+  Scenario: Verify condition for delayed alert
+    Given I am on web-object form page
+    When I follow delayed_alert button
+    And I wait for alert to appear
+    Then I verify n accept alert

data/features/scenarios/element_interaction.feature

@@ -0,0 +1,38 @@
+Feature: As a web-object author, I want to make sure
+  conditional method around element presence and visibility work fine.
+
+  Background:
+    Given I am on web-object form page
+
+  Scenario: Verify condition for delayed visibility and invisibility
+    And I verify text is invisible
+    When I follow toggle_visibility button
+    Then I wait for text to become visible
+    And I verify text is visible
+    When I follow toggle_visibility button
+    Then I wait for text to become invisible
+    And I verify text is invisible
+
+  Scenario: Verify condition for delayed presence and absence
+    And I verify link is absent
+    When I follow toggle_presence button
+    Then I wait for link to be present
+    And I verify link is present
+    When I follow toggle_presence button
+    Then I wait for link to be absent
+    And I verify link is absent
+
+  Scenario: Verify condition for delayed enabling and disabling
+    And I verify text field is disabled
+    When I follow toggle_enabling button
+    Then I wait for text field to be enabled
+    And I verify text field is enabled
+    When I follow toggle_enabling button
+    Then I wait for text field to be disabled
+    And I verify text field is disabled
+
+  Scenario: Verify conditions for delayed clickability
+    And I verify desired button is not clickable
+    When I follow delayed_clickability button
+    Then I wait for desired button to be clickable
+    And I verify desired button is now clickable

data/features/scenarios/element_property.feature

@@ -0,0 +1,33 @@
+Feature: As a web-object author, I want to make sure
+  conditional method around element properties work fine.
+
+  Background:
+    Given I am on web-object form page
+
+  Scenario: Verify condition for delayed attribute presence and absence
+    Given I verify element attribute is absent
+    When I follow toggle_attribute button
+    Then I wait for attribute to be present
+    And I verify element attribute is present
+    When I follow toggle_attribute button
+    Then I wait for attribute to be absent
+    And I verify element attribute is absent
+
+  Scenario: Verify condition for delayed attribute value presence and absence
+    Given I verify element attribute value is set
+    When I follow empty_attribute button
+    Then I wait for attribute value to be empty
+    And I verify element attribute value is empty
+    When I follow empty_attribute button
+    Then I wait for attribute value to be set
+    And I verify element attribute value is set
+
+  Scenario: Verify condition for attribute value to match expected value
+    When I follow toggle_attribute button
+    Then I wait for attribute to be match value
+    And I verify element attribute is present
+
+  Scenario: Verify condition for attribute value to contain expected text
+    When I follow toggle_attribute button
+    Then I wait for attribute to be contain value
+    And I verify element attribute is present

data/features/step_definitions/alert_steps.rb

@@ -0,0 +1,30 @@
+Given(/^I am on web-object form page$/) do
+  url = "https://krupani.github.io/web-object"
+  # url = "file:////Users/kaushal.rupani/projects/web-object/docs/index.html"
+  @driver.get(url)
+end
+
+When(/^I follow ([^"]*) button$/) do |btn|
+  wo = WebObjectFormPage.new(@driver)
+  case btn
+    when "delayed_alert"
+      wo.delayed_alert_button.click
+    when "toggle_visibility"
+      wo.toggle_visibility_button.click
+    when "toggle_presence"
+      wo.toggle_presence_button.click
+    when "toggle_enabling"
+      wo.toggle_enability_button.click
+    when "delayed_clickability"
+      wo.delayed_clickability_button.click
+    when "toggle_attribute"
+      wo.toggle_attribute_button.click
+    when "empty_attribute"
+     wo.empty_attribute_button.click
+  end
+end
+
+Then(/^I wait for alert to appear$/) do
+  wait = Selenium::WebDriver::Wait.new(timeout: 10)
+  wait.until{alert_present?}
+end

data/features/step_definitions/element_interaction_steps.rb

@@ -0,0 +1,55 @@
+
+Then(/^I wait for text to become (invisible|visible)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  wo.wait_for_text_visibility(state)
+end
+
+Then(/^I verify n accept alert$/) do
+  alert = @driver.switch_to.alert
+  expect(alert.text).to eq "This is a delayed alert, came 5 seconds late"
+  alert.accept
+end
+
+And(/^I verify text is (visible|invisible)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  state=="visible" ? flag=true : flag=false
+  expect(wo.toggle_visibility_text.displayed?).to be flag
+end
+
+And(/^I verify link is (absent|present)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  if state=="present"
+    expect(wo.toggle_presence_link.displayed?).to be true
+  else
+    expect(wo.toggle_presence_link).to be false
+  end
+end
+
+Then(/^I wait for link to be (present|absent)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  wo.wait_for_link_presence(state)
+end
+
+
+And(/^I verify text field is (enabled|disabled)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  state=="enabled" ? flag=true : flag=false
+  expect(wo.toggle_enability_field.enabled?).to be flag
+end
+
+Then(/^I wait for text field to be (enabled|disabled)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  wo.wait_for_field_to_be_enabled(state)
+end
+
+
+And(/^I verify desired button is (now|not) clickable$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  state=="now" ? flag=true : flag=false
+  expect(element_is_clickable(wo.desired_clickable_button)).to be flag
+end
+
+Then(/^I wait for desired button to be clickable$/) do
+  wo = WebObjectFormPage.new(@driver)
+  wo.wait_for_button_to_be_clickable
+end

data/features/step_definitions/element_property_steps.rb

@@ -0,0 +1,26 @@
+Given(/^I verify element attribute is (present|absent)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  state=="present" ? flag="color: red;" : flag=""
+  expect(wo.toggle_attribute_button.attribute('style')).to eq flag
+end
+
+Then(/^I wait for attribute to be (present|absent)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  wo.wait_for_attribute(state)
+end
+
+Given(/^I verify element attribute value is (set|empty)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  state=="set" ? flag="background: yellow" : flag=""
+  expect(wo.empty_attribute_button.attribute('style')).to include flag
+end
+
+Then(/^I wait for attribute value to be (set|empty)$/) do |state|
+  wo = WebObjectFormPage.new(@driver)
+  wo.wait_for_attribute_value(state)
+end
+
+Then(/^I wait for attribute to be (match|contain) value$/) do |action|
+  wo = WebObjectFormPage.new(@driver)
+  wo.wait_for_attribute_value_match(action)
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'cucumber'
+require 'selenium-webdriver'
+require 'web-object'
+require 'rspec'
+include RSpec::Matchers

data/features/support/hooks.rb

@@ -0,0 +1,21 @@
+driver = Selenium::WebDriver.for :chrome
+
+Before do
+  @driver = driver
+  @driver.manage.delete_all_cookies
+end
+
+After do |scenario|
+  if scenario.failed?
+    begin
+      encoded_img = driver.screenshot_as(:base64)
+      embed("#{encoded_img}", "image/png;base64")
+    rescue
+      p "*** Could not take failed scenario screenshot ***"
+    end
+  end
+end
+
+at_exit do
+  driver.quit
+end

data/lib/web-object.rb

@@ -2,6 +2,13 @@ require 'selenium-webdriver'
 require 'web-object/element'
 require 'web-object/elements'
 
+require 'web-object/conditions/alert'
+require 'web-object/conditions/element_interaction'
+require 'web-object/conditions/element_property'
+
+include WebConditions
+
+
 class WebObject
   include Element
   include Elements

data/lib/web-object/conditions/alert.rb

@@ -0,0 +1,14 @@
+module WebConditions
+
+  # @method alert_present?
+  # @return [Boolean true] -- if alert is present on page
+  # @return [Boolean false] -- if alert is absent from page
+
+  def alert_present?
+    @driver.switch_to.alert
+    true
+  rescue
+    false
+  end
+
+end #module WebConditions

data/lib/web-object/conditions/element_interaction.rb

@@ -0,0 +1,124 @@
+module WebConditions
+
+  # @method element_is_clickable(ele)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @return [Boolean true] -- if element is clickable(visible and enabled) on page
+  # @return [Boolean false] -- if element is not clickable(visible and enabled) on page
+
+  def element_is_clickable(ele)
+    element = element_or_locator(ele)
+    if element_is_visible(element) and element_is_enabled(element)
+      true
+    else
+      false
+    end
+  end
+
+
+  # @method element_is_enabled(ele)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @return [Boolean true] -- if element is enabled on page
+  # @return [Boolean false] -- if element is disabled on page
+
+  def element_is_enabled(ele)
+    element = element_or_locator(ele)
+    if element.enabled?
+      true
+    else
+      false
+    end
+  end
+
+
+  # @method element_is_disabled(ele)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @return [Boolean true] -- if element is disabled on page
+  # @return [Boolean false] -- if element is enabled on page
+
+  def element_is_disabled(ele)
+    element = element_or_locator(ele)
+    if element.enabled?
+      false
+    else
+      true
+    end
+  end
+
+
+  # @method element_is_visible(ele)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @return [Boolean true] -- if element is visible on page
+  # @return [Boolean false] -- if element is invisible / hidden on page
+
+  def element_is_visible(ele)
+    element = element_or_locator(ele)
+    if element.displayed?
+      true
+    else
+      false
+    end
+  end
+
+
+  # @method element_is_invisible(ele)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @return [Boolean true] -- if element is invisible / hidden on page
+  # @return [Boolean false] -- if element is visible on page
+
+  def element_is_invisible(ele)
+    element = element_or_locator(ele)
+    if element.displayed?
+      false
+    else
+      true
+    end
+  end
+
+
+  # @method element_is_present(ele)
+  # @param locator [locator Hash] -- eg {:id => 'some_id'}]
+  # @return [Boolean true] -- if element is present in DOM of page
+  # @return [Boolean false] -- if element is absent from DOM of page
+
+  def element_is_present(locator)
+    begin
+      @driver.find_element(locator)
+      true
+    rescue
+      false
+    end
+  end
+
+  # @method element_is_absent(ele)
+  # @param locator [locator Hash] -- eg {:id => 'some_id'}]
+  # @return [Boolean true] -- if element is absent in DOM of page
+  # @return [Boolean false] -- if element is present from DOM of page
+
+  def element_is_absent(locator)
+    begin
+      @driver.find_element(locator)
+      false
+    rescue
+      true
+    end
+  end
+
+  # internal method
+  def element_or_locator(ele)
+    if ele.class == Hash
+      begin
+        @driver.find_element(ele)
+      rescue
+        raise 'Looks like the element itself is not present on the page, Please wait for element to be present'
+      end
+    else
+      ele
+    end
+  end
+
+end #module WebConditions

data/lib/web-object/conditions/element_property.rb

@@ -0,0 +1,76 @@
+module WebConditions
+
+
+  # @method attribute_is_present(ele,attr)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @param attr [String] -- attribute that need to be checked for presence
+  # @return [Boolean true] -- if element attribute is found in the html tag in page source
+  # @return [Boolean false] -- if element attribute is not found in the html tag in page source
+
+  def attribute_is_present(ele,attr)
+    element = element_or_locator(ele)
+    if element.attribute(attr).empty?
+      false
+    else
+      true
+    end
+  end
+  alias_method :attribute_is_not_empty, :attribute_is_present
+
+
+  # @method attribute_is_absent(ele,attr)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @param attr [String] -- attribute that need to be checked for absence
+  # @return [Boolean true] -- if element attribute is not found in the html tag in page source
+  # @return [Boolean false] -- if element attribute is found in the html tag in page source
+
+  def attribute_is_absent(ele,attr)
+    element = element_or_locator(ele)
+    if element.attribute(attr).empty?
+      true
+    else
+      false
+    end
+  end
+  alias_method :attribute_is_empty, :attribute_is_absent
+
+
+  # @method attribute_to_match(ele,attr)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @param attr [String] -- attribute that need to be checked for actual value in page source
+  # @param item [String] -- expected value of attribute that needs to be exactly matched with actual in page source
+  # @return [Boolean true] -- if element attribute value is exact match with expected value in the html tag in page source
+  # @return [Boolean false] -- if element attribute is mismatch with expected value in the html tag in page source
+
+  def attribute_to_match(ele,attr,item)
+    element = element_or_locator(ele)
+    if element.attribute(attr).to_s == (item.to_s)
+      true
+    else
+      false
+    end
+  end
+
+
+  # @method attribute_to_match(ele,attr)
+  # @param ele [WebElement object]
+  # @param ele [locator Hash] -- eg {:id => 'some_id'}]
+  # @param attr [String] -- attribute that need to be checked for actual value in page source
+  # @param item [String] -- substring value of attribute that needs to be contained within actual in page source
+  # @return [Boolean true] -- if element attribute substring is present within actual value in the html tag in page source
+  # @return [Boolean false] -- if actual attribute value does not contain passed substring
+
+  def attribute_to_include(ele,attr,item)
+    element = element_or_locator(ele)
+    if element.attribute(attr).to_s.include?(item.to_s)
+      true
+    else
+      false
+    end
+  end
+  alias_method :attribute_to_contain, :attribute_to_include
+
+end #module WebConditions

data/lib/web-object/version

@@ -1 +1 @@
-0.2
+0.3

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: web-object
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Kaushal Rupani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
+date: 2017-05-17 00:00:00.000000000 Z
+dependencies: []
 description: Helps in generating page object style framework using original webdriver
   flavor
 email:
@@ -34,7 +20,23 @@ extra_rdoc_files: []
 files:
 - LICENCE
 - README.md
+- Rakefile
+- cucumber.yml
+- features/pages/web_object_form_page.rb
+- features/scenarios/alert.feature
+- features/scenarios/element_interaction.feature
+- features/scenarios/element_property.feature
+- features/step_definitions/alert_steps.rb
+- features/step_definitions/element_interaction_steps.rb
+- features/step_definitions/element_property_steps.rb
+- features/support/env.rb
+- features/support/hooks.rb
 - lib/web-object.rb
+- lib/web-object/conditions/alert.rb
+- lib/web-object/conditions/element_interaction.rb
+- lib/web-object/conditions/element_property.rb
+- lib/web-object/conditions/url_n_title.rb
+- lib/web-object/conditions/window_n_frame.rb
 - lib/web-object/element.rb
 - lib/web-object/elements.rb
 - lib/web-object/version
@@ -50,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -58,8 +60,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Page Objects in Original WebDriver flavor
-test_files: []
+summary: Page Objects in Original WebDriver flavor + Vast list of Expected Conditions
+  and WebDriver Utilities
+test_files:
+- features/pages/web_object_form_page.rb
+- features/scenarios/alert.feature
+- features/scenarios/element_interaction.feature
+- features/scenarios/element_property.feature
+- features/step_definitions/alert_steps.rb
+- features/step_definitions/element_interaction_steps.rb
+- features/step_definitions/element_property_steps.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- cucumber.yml
+- Rakefile