web-object 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b27cc7c593f89557072eb0230513efa244302191
+  data.tar.gz: 9835f0fa4aa79272ad5365bbcff74def017e570a
+SHA512:
+  metadata.gz: bc1dd0cabf5605ff0915436b590e13a9e37a58babdd3d41cac1ea4cdab27df275e9d540762fa966ee749f1149c55d8d596e6ba984f8c302275f0b4efc932a974
+  data.tar.gz: 0e0c2175d5c9046b235bb93eca9d42340ae6184e30abaca4500fc87c53e58aa83e266f3ff23a1573df0e123d47e5b02eb7d1604850fb2b7693c8fa34dbfb2122

data/README.md

@@ -0,0 +1,140 @@
+#web-object  
+
+Create page-object style test framework using original webdriver flavor.
+Now what does original webdriver flavor is, it simply means, no additional wrappers, no additional syntax.
+Hence just create page-objects and start using basic webdriver commands on it.
+
+Moral of the story, elements created using web-object gem will be objects of WebElement class and one can perform all webdriver
+commands on it like send_keys, click, displayed? .. and so on...
+
+## Table of Contents
+- [Installation](#install)  
+    - [Install using gem command](#gem)    
+    - [Install using bundler](#bundler)    
+- [Syntax](#syntax)   
+    - [Finding Element](#find_element)    
+    - [Finding Multiple Elements](#find_elements)    
+- [Usage](#usage)   
+- [Aliases](#alias)    
+- [Contributing](#contributing)  
+- [Issues](#issues)     
+    
+
+## <a name="install"></a> Installation :eyes:  
+There are multiple ways in which you can install and use testnow gem.
+You must have Ruby installed before you can install this gem.   
+
+### <a name="gem" /> 1. Install using gem command
+Just use following command from you Terminal.
+``` 
+gem install web-object 
+```
+   
+### <a name="bundler" /> 2. Install using bundler    
+You can include it in your Gemfile and run bundle install
+
+``` 
+gem 'web-object' 
+```   
+then run following   
+```   
+bundle install   
+```   
+  
+  
+    
+## <a name="syntax"></a> Syntax :eyes:    
+    
+To use web-object, you need to extend your page class with web-object
+
+### <a name="find_element"></a> 1. Finding Element   
+Syntax   
+element :name_of_element, {:locator_strategy => "locator value"}   
+or   
+find :name_of_element, {:locator_strategy => "locator value"}   
+
+Returns an object of WebElement
+
+Eg:   
+```   
+element :login_email, {:id => "email"}   
+element :login_password, {:css => "#pwd"}   
+element :login_button, {:xpath => "//button[@id='signin']"}   
+```      
+or   
+```   
+find :login_email, {:id => "email"}   
+find :login_password, {:css => "#pwd"}   
+find :login_button, {:xpath => "//button[@id='signin']"}
+```
+   
+
+### <a name="find_elements"></a> 2. Finding Multiple Element   
+Syntax   
+elements :name_of_element, {:locator_strategy => "locator value"}   
+or   
+all :name_of_element, {:locator_strategy => "locator value"}   
+or   
+element_list :name_of_element, {:locator_strategy => "locator value"}
+
+Returns an array of WebElement objects
+
+Eg:   
+```   
+elements :product_prices, {:id => "prices"}   
+elements :active_users, {:css => ".users>#active"}   
+```      
+or   
+```   
+element_list :product_prices, {:id => "prices"}   
+element_list :active_users, {:css => ".users>#active"}   
+```   
+or
+```   
+all :product_prices, {:id => "prices"}   
+all :active_users, {:css => ".users>#active"}   
+```   
+  
+__Note: Currently finding multiple elements will raise an exception if no element is found. 
+In subsequent version, there will be an option to get back an empty array if no element is found.__  
+  
+    
+      
+## <a name="usage"></a> Usage :eyes:   
+Now as we saw how to create page objects, lets see how to put it to practical use.
+
+```   
+class Login < WebObject
+  element :login_email, {:id => "email"}   
+  element :login_password, {:css => "#pwd"}   
+  element :login_button, {:xpath => "//button[@id='signin']"}   
+  elements :active_users, {:css => ".users>#active"} 
+  
+  def login_to_portal(email,pwd)  
+    login_email.send_keys(email)  
+    login_pwd.send_keys(pwd)  
+    login_button.click  
+  end  
+    
+  def get_active_user_count   
+    active_users.size
+  end
+end  
+```   
+
+## <a name="alias"></a> Aliases :eyes:   
+There is an option to use PageObject class instead of WebObject.  
+Eg:
+``` class LoginPage < PageObject ```   
+   
+Also for elements as mentioned above   
+for `element` there is an option to use `find` (for capybara flavor loving people)  
+for `elements` there is an option to use `element_list` or `all`   
+
+  
+## <a name="contributing"></a> Contributing :eyes:
+Ideas and suggestions are always always most welcome. Please fork this gem code and feel free to add any updates, suggestions etc and create a pull request.  
+
+## <a name="issues"></a> Issues :eyes:
+If you face any problem related to syntax, usability, documentation then please raise an [issues](https://github.com/krupani/web-object/issues)...   
+

data/lib/web-object/version

@@ -0,0 +1 @@
+0.1

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

@@ -0,0 +1,38 @@
+class WebObject
+
+  def initialize(driver)
+    @driver = driver
+  end
+
+  def self.element(element_name, locator)
+    send(:define_method, element_name) do
+      wait = Selenium::WebDriver::Wait.new(:timeout => 0.5)
+      begin
+        wait.until { @driver.find_element(locator) }
+      rescue Selenium::WebDriver::Error::TimeOutError
+        raise "Could not find element using '#{locator.first.key}=#{locator.first.key}' strategy"
+      end
+    end
+  end
+
+  singleton_class.send(:alias_method, :find, :element)
+
+  def self.elements(element_name, locator)
+    send(:define_method, element_name) do
+      wait = Selenium::WebDriver::Wait.new(:timeout => 0.5)
+      begin
+        wait.until { !@driver.find_elements(locator).empty? }
+        @driver.find_elements(locator)
+      rescue Selenium::WebDriver::Error::TimeOutError
+        raise "Could not find any elements using '#{locator.first.key}=#{locator.first.key}' strategy"
+      end
+    end
+  end
+
+  singleton_class.send(:alias_method, :element_list, :elements)
+  singleton_class.send(:alias_method, :all, :elements)
+
+end
+
+PageObject = WebObject
+

data/lib/web-object.rb

@@ -0,0 +1,2 @@
+require 'selenium-webdriver'
+require 'web-object/web-object'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: web-object
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Kaushal Rupani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-02 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'
+description: Helps in generating page object style framework using original webdriver
+  flavor
+email:
+- kushrupani@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE
+- README.md
+- lib/web-object.rb
+- lib/web-object/version
+- lib/web-object/web-object.rb
+homepage: https://github.com/krupani/web_object
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Page Objects in Original WebDriver flavor
+test_files: []