web-object 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b27cc7c593f89557072eb0230513efa244302191
-  data.tar.gz: 9835f0fa4aa79272ad5365bbcff74def017e570a
+  metadata.gz: fd547488b2887d00bb588a8db5ff4944bb20d515
+  data.tar.gz: 15c86935df1d98dc89f594732a6f43f625ffe4dd
 SHA512:
-  metadata.gz: bc1dd0cabf5605ff0915436b590e13a9e37a58babdd3d41cac1ea4cdab27df275e9d540762fa966ee749f1149c55d8d596e6ba984f8c302275f0b4efc932a974
-  data.tar.gz: 0e0c2175d5c9046b235bb93eca9d42340ae6184e30abaca4500fc87c53e58aa83e266f3ff23a1573df0e123d47e5b02eb7d1604850fb2b7693c8fa34dbfb2122
+  metadata.gz: 96df1f4533a1130f7e3f5ba0608537182e8dd848f5c38b738be6f6ba9a5e69285737cb1d9623d3a1b188a50cf3f7ca99a5ff3ce12ddb951a24876cad3965eb8c
+  data.tar.gz: 6aaa349dc3b5fa0a4f25cb505a9c044a0ca89a396e28116fa000bb4e30f29054f7d445000acee9aad460ef4bbf6ae49cdc53cfd35ef7ee4c435377cfd5c9952e

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2016-2017 Kaushal Rupani
+
+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. 

data/README.md

@@ -1,4 +1,4 @@
-#web-object  
+# 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.
@@ -13,7 +13,8 @@ commands on it like send_keys, click, displayed? .. and so on...
     - [Install using bundler](#bundler)    
 - [Syntax](#syntax)   
     - [Finding Element](#find_element)    
-    - [Finding Multiple Elements](#find_elements)    
+    - [Finding Multiple Elements](#find_elements)   
+    - [Syntax Summary](#summary) 
 - [Usage](#usage)   
 - [Aliases](#alias)    
 - [Contributing](#contributing)  
@@ -21,7 +22,7 @@ commands on it like send_keys, click, displayed? .. and so on...
     
 
 ## <a name="install"></a> Installation :eyes:  
-There are multiple ways in which you can install and use testnow gem.
+There are multiple ways in which you can install and use web-object gem.
 You must have Ruby installed before you can install this gem.   
 
 ### <a name="gem" /> 1. Install using gem command
@@ -51,10 +52,9 @@ To use web-object, you need to extend your page class with web-object
 Syntax   
 element :name_of_element, {:locator_strategy => "locator value"}   
 or   
-find :name_of_element, {:locator_strategy => "locator value"}   
-
-Returns an object of WebElement
-
+find :name_of_element, {:locator_strategy => "locator value"}, error=false   
+    
+   
 Eg:   
 ```   
 element :login_email, {:id => "email"}   
@@ -68,21 +68,34 @@ find :login_password, {:css => "#pwd"}
 find :login_button, {:xpath => "//button[@id='signin']"}
 ```
    
+Returns an object of WebElement.   
+Raise an exception by default if element is not found.   
+Will return Boolean false if error=false parameter is explicitly passed and element is not found.  
+
+Eg of error handling as mentioned above:   
+```   
+1) element :login_button, {:id => 'signIn'}
+2) element :profile_link, {:css => '.user_profile'}, error=false
+   
+# Example 1 will raise element not found exception if element not found on the page   
+# Example 2 will just return a Boolean false if element not found on the page   
+
+```
+
+   
 
 ### <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"}   
+all :name_of_element, {:locator_strategy => "locator value"}, error=true   
 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"}   
+elements :active_users, {:css => ".users>#active"}, error=true    
 ```      
 or   
 ```   
@@ -95,10 +108,30 @@ 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.__  
+Returns an array of WebElement objects.   
+Return an empty array in element is not found by default.   
+Will raise an error if error=true parameter explicitly passed and element is not found.   
   
+  
+Eg of error handling as mentioned above:   
+```   
+1) elements :names, {:id => 'names'}, error=true
+2) elements :header_tabs, {:css => '.menu-item'}
+   
+# Example 1 will raise element not found exception if element not found on the page   
+# Example 2 will just return an empty array if element not found on the page   
+
+```
     
+### <a name="summary"></a> 3. Syntax Summary : 
+* error parameter is completely optional and web-object will continue to work as before.   
+* Default behaviour will now match the same as webdriver.   
+* __Finding single element will raise an exception by default if element not found on the page.__    
+* __Finding multiple elements will return a blank array by default if element not found on the page.__   
+* error parameter is used only to reverse the natural default behaviour.
+* __Finding single element will return Boolean false if error paramter is sent as false and element not found on the page.__
+* __Finding multiple elements will raise exception if error paramter is sent as true and element not found on the page.__
+      
       
 ## <a name="usage"></a> Usage :eyes:   
 Now as we saw how to create page objects, lets see how to put it to practical use.

data/lib/web-object.rb

@@ -1,2 +1,19 @@
 require 'selenium-webdriver'
-require 'web-object/web-object'
+require 'web-object/element'
+require 'web-object/elements'
+
+class WebObject
+  include Element
+  include Elements
+
+  def initialize(driver)
+    @driver = driver
+  end
+
+  singleton_class.send(:alias_method, :find, :element)
+  singleton_class.send(:alias_method, :element_list, :elements)
+  singleton_class.send(:alias_method, :all, :elements)
+
+end
+
+PageObject = WebObject

data/lib/web-object/element.rb

@@ -0,0 +1,34 @@
+module Element
+
+  def self.included(base)
+    base.extend FindElement
+  end
+
+  module FindElement
+
+    # @method element(element_name, locator, error=true)
+    # @param element_name [:Symbol]
+    # @param locator [Hash]
+    # @param error [Boolean] -- default true
+    # @return [Selenium::WebDriver::Element]
+    # @return [Boolean false] -- if element not found and error parameter = false
+
+    def element(element_name, locator, error=true)
+      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
+          if error
+            raise "Could not find element using '#{locator.first.key}=#{locator.first.key}' strategy"
+          else
+            return false
+          end
+        end
+      end
+    end
+
+
+  end
+
+end

data/lib/web-object/elements.rb

@@ -0,0 +1,34 @@
+module Elements
+
+  def self.included(base)
+    base.extend FindElements
+  end
+
+  module FindElements
+
+    # @method element(element_name, locator, error=false)
+    # @param element_name [:Symbol]
+    # @param locator [Hash]
+    # @param error [Boolean] - default false
+    # @return [Selenium::WebDriver::Element]
+    # @return [empty Array] -- if element not found and error parameter = false
+
+    def elements(element_name, locator, error=false)
+      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
+          if error
+            raise "Could not find any elements using '#{locator.first.key}=#{locator.first.key}' strategy"
+          else
+            return []
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/web-object/version

@@ -1 +1 @@
-0.1
+0.2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web-object
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Kaushal Rupani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -35,10 +35,12 @@ files:
 - LICENCE
 - README.md
 - lib/web-object.rb
+- lib/web-object/element.rb
+- lib/web-object/elements.rb
 - lib/web-object/version
-- lib/web-object/web-object.rb
 homepage: https://github.com/krupani/web_object
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

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

@@ -1,38 +0,0 @@
-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
-