intelement 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'capybara', '2.0.3'
+gem 'cucumber', '1.2.5'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    intelement (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    capybara (2.0.3)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 1.0.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.2.5)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.7)
+      multi_json (~> 1.3)
+    diff-lcs (1.2.4)
+    ffi (1.9.0)
+    gherkin (2.11.8)
+      multi_json (~> 1.3)
+    mime-types (1.24)
+    mini_portile (0.5.1)
+    multi_json (1.7.9)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.35.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    websocket (1.0.7)
+    xpath (1.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  capybara (= 2.0.3)
+  cucumber (= 1.2.5)
+  intelement!
+  rake

data/LICENSE.txt

@@ -0,0 +1 @@
+Copyright (c) 2013 lavanya

data/README.md

@@ -0,0 +1,63 @@
+# ElementHelper
+
+Gem is a wrapper around Capybara.
+It provides users with a method that can does a lot of element related operations like check the presence of an element on page, get value of the element, get the attribute value, find multiple elements with same selector, find all their values, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'intelement'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install intelement
+
+## Usage
+
+# Require ElementHelper in your file
+    $ require 'intelement'
+
+# To visit the page, specify the URL
+    $ ElementHelper.visit_page("http://www.flipkart.com/")
+  Driver to be used can also be specified. By default it is selenium.
+    $ ElementHelper.visit_page("http://www.flipkart.com/", :selenium)
+
+# To check whether an element for a given CSS selector or XPath is present (returns a boolean)
+    $ ElementHelper.get_element_details(".btn.btn-blue.btn-cart")
+    $ ElementHelper.get_element_details("//div[@class='btn btn-blue btn-cart']")
+
+# To get the value of a particular element, we need to specify the type of element
+    $ ElementHelper.get_element_details(".fk-cstext", :text)
+  The options supported for this are :text, :link and :button. (:text and :link do .text after finding the element while :button does a .value)
+
+# When multiple elements are obtained using a specified selector, to get the value of an element at a particular index
+    $ ElementHelper.get_element_details("//a[@href='/']", :text, 1)
+
+# When attribute value of a particular element is to be found
+    $ ElementHelper.get_element_details("//a[@href='/s/help']", "class")
+    Above, "class" is the attribute whoes value we require
+
+# When multiple elements are obtained using a specified selector, to get the attribute value of an element at a particular index
+    $ ElementHelper.get_element_details("//a[@class='fk-footer-unit fk-footer-link']", "href", 0)
+
+# When multiple elements are obtained using a specified selector, to get the values of all element
+    $ ElementHelper.get_element_details("//a[@class='fk-footer-unit fk-footer-link']", :text, :all)
+
+# When multiple elements are obtained using a specified selector, to get the attribute values of all element
+    $ ElementHelper.get_element_details("//a[@class='fk-footer-unit fk-footer-link']", "href", :all)
+
+# To get the number of elements with the specified Xpath or CSS selector
+    $ ElementHelper.get_element_details("//a[@href='/']", nil, :all)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/intelement.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'intelement/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "intelement"
+  spec.version       = IntelementVersion::VERSION
+  spec.authors       = ["bitweft"]
+  spec.email         = ["bitweft@gmail.com"]
+  spec.description   = %q{A gem that provides an intelligent way to get various different element details}
+  spec.summary       = %q{An intelligent wrapper over capybara that provides one generic method to get the details of a web element}
+  spec.homepage      = "http://www.bitweft.com"
+  spec.license       = "To be decided"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/intelement.rb

@@ -0,0 +1,116 @@
+require_relative 'intelement/version'
+require 'capybara'
+
+module Intelement
+
+  class << self
+    include Capybara::DSL
+    attr_reader :uri, :driver
+
+    def visit_page uri=nil, driver=:selenium
+      @uri = uri
+      @driver = driver
+      Capybara.default_driver = @driver
+      Capybara.visit uri
+    end
+
+    def is_element_present? locator
+      selector = get_selector locator
+      has_selector?(selector, locator)
+    end
+
+    def get_element_value locator, type=:text
+      selector = get_selector locator
+      case type
+        when :text, :link
+          find(selector, locator).text
+        when :button
+          find(selector, locator).value
+      end
+    end
+
+    def get_all_elements locator
+      selector = get_selector locator
+      all(selector, locator)
+    end
+
+    def get_element_value_of_index locator, type=:text, index=0
+      selector = get_selector locator
+      case type
+        when :text, :link
+          all(selector, locator)[index].text
+        when :button
+          all(selector, locator)[index].value
+      end
+    end
+
+    def get_attribute_value locator, attribute_name
+      selector = get_selector locator
+      find(selector, locator)[attribute_name]
+    end
+
+    def get_attribute_value_of_index locator, attribute_name, index=0
+      selector = get_selector locator
+      all(selector, locator)[index][attribute_name]
+    end
+
+    def get_all_elements_value locator, type=:text
+      selector = get_selector locator
+      all_elements = all(selector, locator)
+      element_values = case type
+                         when :text, :link
+                           all_elements.map do |element|
+                             element.text
+                           end
+                         when :button
+                           all_elements.map do |element|
+                             element.value
+                           end
+                       end
+      element_values
+    end
+
+    def get_all_element_attribute_value locator, attribute_name
+      selector = get_selector locator
+      all_elements = all(selector, locator)
+      attribute_values = all_elements.map do |element|
+        element[attribute_name]
+      end
+      attribute_values
+    end
+
+    def get_element_details locator, value_to_get=nil, index=nil
+      if value_to_get.nil? && index.nil?
+        is_element_present? locator
+      elsif value_to_get.nil? && index.eql?(:all)
+        get_all_elements locator
+      elsif index.nil?
+        if value_to_get.class.eql?(String)
+          get_attribute_value locator, value_to_get
+        else
+          get_element_value locator, value_to_get
+        end
+      else
+        if index.class.eql?(Symbol)
+          if value_to_get.class.eql?(String)
+            get_all_element_attribute_value locator, value_to_get
+          else
+            get_all_elements_value locator, value_to_get
+          end
+        else
+          if value_to_get.class.eql?(String)
+            get_attribute_value_of_index locator, value_to_get, index
+          else
+            get_element_value_of_index locator, value_to_get, index
+          end
+        end
+      end
+    end
+
+    def get_selector locator
+      locator[0] == '/' ? :xpath : :css
+    end
+
+  end
+end
+

data/lib/intelement/version.rb

@@ -0,0 +1,3 @@
+module IntelementVersion
+  VERSION = "0.0.1"
+end

data/test/lib/intelement/intelement.rb

@@ -0,0 +1,105 @@
+require_relative '../../test_helper'
+
+describe Intelement, "When the presence of an element on a page is requested by using a css selector" do
+  it "should return true when the element is present" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.is_element_present?(".btn.btn-blue.btn-cart").must_equal true
+  end
+
+  it "should return false when the element is not present" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.is_element_present?("#invalid_element_css_selector").must_equal false
+  end
+end
+
+describe Intelement, "When the presence of an element on a page is requested by using an xpath selector" do
+  it "should return true when the element is present" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.is_element_present?("//div[@class='btn btn-blue btn-cart']").must_equal true
+  end
+
+  it "should return false when the element is not present" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.is_element_present?("//div[@class='invalid_element_xpath_selector']").must_equal false
+  end
+end
+
+describe Intelement, "When the value of a single element is requested for" do
+  it "should return the appropriate value" do
+    Intelement.visit_page("http://www.dell.com/")
+    Intelement.get_element_value("//button[@type='submit']").must_equal "Search"
+  end
+
+  it "should return the appropriate value" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_element_value(".fk-cstext", :text).must_equal "24x7 Customer Support"
+  end
+
+  it "should return the appropriate value" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_element_value("//a[@href='/s/help']", :link).must_equal "FAQ"
+  end
+
+  it "should return the appropriate value" do
+    Intelement.visit_page("http://www.w3schools.com/html/html_forms.asp")
+    Intelement.get_element_value("//input[@type='submit']", :button).must_equal "Submit"
+  end
+end
+
+describe Intelement, "When all the matches for elements with a particular selector is requested for" do
+  it "should give an array of all the matches" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_all_elements("//a[@href='/']").size.must_equal 2
+  end
+end
+
+describe Intelement, "When we need an elements value with a particular selector that returns multiple candidates" do
+  it "should give us the value of the element we requested for" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_element_value_of_index("//a[@href='/']", :text, 1).must_equal "Home"
+  end
+end
+
+
+describe Intelement, "When we need to get the attribute value of an element" do
+  it "should give us the requested attribute value" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_attribute_value("//a[@href='/s/help']", "class").must_equal "fk-footer-unit fk-footer-link"
+  end
+end
+
+describe Intelement, "When we need to get the attribute value of an element from multiple candidates" do
+  it "should give us the requested attribute value for the requested element" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_attribute_value_of_index("//a[@class='fk-footer-unit fk-footer-link']", "href", 0).must_equal "http://www.flipkart.com/s/help/payments"
+  end
+end
+
+describe Intelement, "When requested for all the values" do
+  it "should give a map of all the values" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_all_elements_value("//a[@class='fk-footer-unit fk-footer-link']", :text).must_equal ["Payments", "Saved Cards", "Shipping", "Cancellation & Returns", "FAQ", "Contact Us", "About Us", "Careers", "Blog", "Press", "Slash N", "Download Manager", "MP3 FAQ", "MP3 App", "eBooks FAQ", "eBooks App", "Online Shopping", "Affiliate", "Wallet", "e-Gift Voucher", "Flipkart lite", "Store Directory"]
+  end
+end
+
+describe Intelement, "When requested for all the values of attributes" do
+  it "should give a map of all the attribute values" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_all_element_attribute_value("//a[@class='fk-footer-unit fk-footer-link']", "href").must_equal ["http://www.flipkart.com/s/help/payments", "http://www.flipkart.com/help/savedcard_how", "http://www.flipkart.com/s/help/shipping", "http://www.flipkart.com/s/help/cancellation-returns", "http://www.flipkart.com/s/help", "http://www.flipkart.com/s/contact", "http://www.flipkart.com/about-us", "http://www.flipkart.com/s/careers", "http://www.flipkart.com/ol?link=http%3A%2F%2Fblog.flipkart.com%2F", "http://www.flipkart.com/s/press", "http://slashn.flipkart.net/", "http://www.flipkart.com/help/downloadmanager", "http://www.flipkart.com/s/mp3help", "http://www.flipkart.com/help/flytemp3app", "http://www.flipkart.com/help/flyteeBookfaq", "http://www.flipkart.com/ebooks/apps", "http://www.flipkart.com/", "http://www.flipkart.com/affiliate/", "http://www.flipkart.com/help/wallet", "http://www.flipkart.com/buy-gift-voucher", "http://www.flipkart.com/m?sitevariant=mobile", "http://www.flipkart.com/store-directory"]
+  end
+end
+
+
+describe Intelement, "When we need a single method to get the value or attribute or presence of an element" do
+  it "should give us the correct result" do
+    Intelement.visit_page("http://www.flipkart.com/")
+    Intelement.get_element_details(".btn.btn-blue.btn-cart").must_equal true
+    Intelement.get_element_details(".fk-cstext", :text).must_equal "24x7 Customer Support"
+    Intelement.get_element_details("//a[@href='/']", :text, 1).must_equal "Home"
+    Intelement.get_element_details("//a[@href='/s/help']", "class").must_equal "fk-footer-unit fk-footer-link"
+    Intelement.get_element_details("//a[@class='fk-footer-unit fk-footer-link']", "href", 0).must_equal "http://www.flipkart.com/s/help/payments" # get particular element attribute
+    Intelement.get_element_details("//a[@class='fk-footer-unit fk-footer-link']", :text, :all).must_equal ["Payments", "Saved Cards", "Shipping", "Cancellation & Returns", "FAQ", "Contact Us", "About Us", "Careers", "Blog", "Press", "Slash N", "Download Manager", "MP3 FAQ", "MP3 App", "eBooks FAQ", "eBooks App", "Online Shopping", "Affiliate", "Wallet", "e-Gift Voucher", "Flipkart lite", "Store Directory"]
+    Intelement.get_element_details("//a[@class='fk-footer-unit fk-footer-link']", "href", :all).must_equal ["http://www.flipkart.com/s/help/payments", "http://www.flipkart.com/help/savedcard_how", "http://www.flipkart.com/s/help/shipping", "http://www.flipkart.com/s/help/cancellation-returns", "http://www.flipkart.com/s/help", "http://www.flipkart.com/s/contact", "http://www.flipkart.com/about-us", "http://www.flipkart.com/s/careers", "http://www.flipkart.com/ol?link=http%3A%2F%2Fblog.flipkart.com%2F", "http://www.flipkart.com/s/press", "http://slashn.flipkart.net/", "http://www.flipkart.com/help/downloadmanager", "http://www.flipkart.com/s/mp3help", "http://www.flipkart.com/help/flytemp3app", "http://www.flipkart.com/help/flyteeBookfaq", "http://www.flipkart.com/ebooks/apps", "http://www.flipkart.com/", "http://www.flipkart.com/affiliate/", "http://www.flipkart.com/help/wallet", "http://www.flipkart.com/buy-gift-voucher", "http://www.flipkart.com/m?sitevariant=mobile", "http://www.flipkart.com/store-directory"]
+    Intelement.get_element_details("//a[@href='/']", nil, :all).size.must_equal 2
+  end
+end

data/test/lib/intelement/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe IntelementVersion do
+  it "must have a defined version" do
+    IntelementVersion::VERSION.wont_be_nil
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/intelement.rb', __FILE__)

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: intelement
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- bitweft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that provides an intelligent way to get various different element
+  details
+email:
+- bitweft@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- intelement.gemspec
+- lib/intelement.rb
+- lib/intelement/version.rb
+- test/lib/intelement/intelement.rb
+- test/lib/intelement/version_test.rb
+- test/test_helper.rb
+homepage: http://www.bitweft.com
+licenses:
+- To be decided
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An intelligent wrapper over capybara that provides one generic method to
+  get the details of a web element
+test_files:
+- test/lib/intelement/intelement.rb
+- test/lib/intelement/version_test.rb
+- test/test_helper.rb