selenium_plus 0.0.3 → 0.0.4

data/README.md

@@ -17,7 +17,7 @@ Using page object model and page factory
 
 ```ruby
 
-# define page
+# define pages
 class LoginPage < SeleniumPlus::Page
   element(:username_input, :id, 'username')
   element(:password_input, :id, 'password')
@@ -30,39 +30,86 @@ class LoginPage < SeleniumPlus::Page
   end
 end
 
-# define your site
-require 'pages/home_page'
+class HomePage < SeleniumPlus::Page
+
+  section(:info_section, InfoSection, :id, 'info')
+  element(:show_btn, :css, 'input[value=Show]')
+
+  def show_first_table
+    show_btn.click
+  end
+end
+
+# define sections
+
+class InfoSection < SeleniumPlus::Section
+  element(:h_table, :css, 'table.horizontal_headers')
+  element(:v_table, :css, 'table.vertical_headers')
+end
+
+# define site
+
+require 'selenium_plus'
+Dir.glob("#{File.dirname(__FILE__)}/sections/*.rb").each{ |file| require file }
+Dir.glob("#{File.dirname(__FILE__)}/pages/*.rb").each{ |file| require file }
 
 class TestSite
+  def login_page
+    Test::LoginPage.new
+  end
 
   def home_page
     Test::HomePage.new
   end
-
 end
 
-SeleniumPlus.register_driver :chrome_driver do
-  SeleniumPlus::Driver.new(:browser => :chrome)
-end
+```
+
+# Using SeleniumPlus with Cucumber
+
+In env.rb, you need to require 'test_site'
 
+You can select different browser using cucumber Tag,
+such as @firefox, @chrome and @ie, by default cucumber will use firefox browser.
 
-SeleniumPlus.using_driver(:chrome_driver)
+```ruby
 
-# start some test
-@Test = TestSite.new
-@Test.home_page.goto('/test_site/html/home.html')
-@Test.home_page.show_first_table
-@Test.home_page.info_section.h_table.rows_text.should == h_table.rows
+@chrome
+Scenario: Verify HTML Table with horizontal header
+  When I login to home page
+  And I show first table
+  Then Horizontal table text should be:
+    | ID: | Name: | Company: |
+    | 1   | Smith | VMware   |
+    | 2   | James | EMC      |
+
+Steps:
+
+When /^I login to home page$/ do
+  @site = TestSite.new
+  @site.login_page.goto('login.html')
+  @site.login_page.login
+end
+
+Then /^Horizontal table text should be:$/ do |h_table|
+  @site.home_page.info_section.h_table.headers_text.should == h_table.headers
+  @site.home_page.info_section.h_table.rows_text.should == h_table.rows
+end
 
 ```
 
 Without using page object model
 
 ```ruby
-# Use default firefox driver, skipping driver registration
-driver = SeleniumPlus.using_driver(:chrome_driver)
-driver.goto('http://www.google.com.hk')
-driver.find(:id,'lst-ib').type('Mozy')
-driver.find(:css,'input[name=btnK]').click
+
+SeleniumPlus.register_driver :firefox_driver do
+  SeleniumPlus::Driver.new(:browser => :firefox)
+end
+
+driver = SeleniumPlus.using_driver(:firefox_driver)
+
+driver.visit('http://www.google.com.hk')
+driver.find(:id, 'lst-ib').type('Selenium')
+driver.find(:css, 'input[name=btnK]').click
 
 ```

data/features/finders.feature

@@ -0,0 +1,15 @@
+Feature: Verify finders
+
+  Scenario: Verify find element using element.find
+    When I login to home page
+    And Title inside div#info should be: Information tables
+
+  Scenario: Verify find element using element.find
+    When I login to home page
+    And Title outside div#info should be: Test Home Page
+
+  Scenario: Verify find elements using driver.all
+    When I login to home page
+    And Titles should be:
+    | Test Home Page     |
+    | Information tables |

data/features/step_definitions/finder_steps.rb

@@ -0,0 +1,12 @@
+Then /^Title (inside|outside) div#info should be: (.+)$/ do |where, title|
+  case where
+    when 'inside'
+      @site.home_page.info_section.title.should == title
+    when 'outside'
+      @site.home_page.title.should == title
+  end
+end
+
+Then /^Titles should be:$/ do |titles_table|
+  @site.home_page.titles.should == titles_table.raw.flatten
+end

data/features/step_definitions/tables_steps.rb

@@ -1,6 +1,7 @@
 When /^I show first table$/ do
   @site.home_page.show_first_table
 end
+
 Then /^Horizontal table text should be:$/ do |h_table|
   @site.home_page.info_section.h_table.headers_text.should == h_table.headers
   @site.home_page.info_section.h_table.rows_text.should == h_table.rows

data/features/support/env.rb

@@ -1,13 +1,2 @@
-$:.unshift(File.dirname(__FILE__) + '/../../test_site')
-
-require 'test_site'
-
-SeleniumPlus.register_driver :firefox_driver do
-  SeleniumPlus::Driver.new(:browser => :firefox)
-end
-
-SeleniumPlus.register_driver :chrome_driver do
-  SeleniumPlus::Driver.new(:browser => :chrome)
-end
-
-SeleniumPlus.using_driver(:firefox_driver)
+$:.unshift("#{File.dirname(__FILE__)}/../../test_site")
+require 'test_site'

data/features/support/hooks.rb

@@ -3,18 +3,9 @@ Before do |scenario|
 end
 
 After do |scenario|
-  SeleniumPlus.driver.reset!
+  #
 end
 
 AfterStep do
   # Do things after each step.
-end
-
-# Setup driver using tags
-Before('@chrome') do
-  SeleniumPlus.using_driver(:chrome_driver)
-end
-
-Before('@firefox') do
-  SeleniumPlus.using_driver(:firefox_driver)
 end

data/lib/selenium_plus.rb

@@ -3,7 +3,9 @@ require 'logger'
 require 'selenium-webdriver'
 require 'selenium_plus/version'
 require 'selenium_plus/exceptions'
+require 'selenium_plus/finders'
 require 'selenium_plus/driver'
+require 'selenium_plus/cucumber'
 require 'selenium_plus/page_obj/container'
 require 'selenium_plus/page_obj/page'
 require 'selenium_plus/page_obj/section'
@@ -57,7 +59,7 @@ module SeleniumPlus
     #
     # @return [Symbol]
     def default_driver
-      @default_driver || :firefox_driver
+      @default_driver || :firefox
     end
 
     # The name of the driver currently in use
@@ -67,22 +69,38 @@ module SeleniumPlus
       @current_driver || default_driver
     end
 
+    # Use the default driver as the current driver
+    #
+    def use_default_driver
+      @current_driver = nil
+    end
+
     def using_driver(driver)
       unless drivers.has_key?(driver)
         other_drivers = drivers.keys.map { |key| key.inspect }
         raise SeleniumPlus::Exceptions::DriverNotFoundError, "Driver #{driver} was not found. Available types: #{other_drivers.join(', ')}"
       end
-      @driver = drivers[driver].call
+      if @driver.nil? || @driver.native.browser != driver
+        @driver = drivers[driver].call
+      end
     end
   end
-end
 
+end
 
 SeleniumPlus.configure do |config|
   config.default_wait_time =10
   config.enable_highlight_element = true
 end
 
-SeleniumPlus.register_driver :firefox_driver do
+SeleniumPlus.register_driver :firefox do
   SeleniumPlus::Driver.new(:browser => :firefox)
+end
+
+SeleniumPlus.register_driver :chrome do
+  SeleniumPlus::Driver.new(:browser => :chrome)
+end
+
+SeleniumPlus.register_driver :ie do
+  SeleniumPlus::Driver.new(:browser => :ie)
 end

data/lib/selenium_plus/cucumber.rb

@@ -0,0 +1,20 @@
+if defined?(Cucumber)
+
+  Before do |scenario|
+    SeleniumPlus.use_default_driver
+  end
+
+  After do |scenario|
+    SeleniumPlus.driver.reset!
+  end
+
+  Before do |scenario|
+    scenario.source_tag_names.each do |tag|
+      driver_name = tag.sub(/^@/, '').to_sym
+      if SeleniumPlus.drivers.has_key?(driver_name)
+        SeleniumPlus.current_driver = driver_name
+      end
+    end
+    SeleniumPlus.using_driver(SeleniumPlus.current_driver)
+  end
+end

data/lib/selenium_plus/driver.rb

@@ -1,6 +1,7 @@
 module SeleniumPlus
 
   class Driver
+    include Finders
 
     DEFAULT_OPTIONS = { :browser => :firefox }
 
@@ -12,6 +13,9 @@ module SeleniumPlus
       @options = DEFAULT_OPTIONS.merge(options)
     end
 
+    # Start Selenium::Webdriver::Driver
+    #
+    # @return [Selenium::Webdriver::Driver]
     def native
       unless @native
         @native = Selenium::WebDriver.for(options[:browser])
@@ -31,15 +35,33 @@ module SeleniumPlus
       native.get(url)
     end
 
-    def find(*args)
-      native.find_element(*args)
-      #highlight_element(el) if enable_highlight_element
-      #el
-    end
+    #def find(*args)
+    #  if self.class.superclass == SeleniumPlus::Section
+    #    @el =root_element.find_element(*args)
+    #  else
+    #    @el = native.find_element(*args)
+    #  end
+    #  highlight_element(@el) if SeleniumPlus.enable_highlight_element
+    #  @el
+    #end
+    #
+    #def all(*args)
+    #  if self.class.superclass == SeleniumPlus::Section
+    #    root_element.find_elements(*args)
+    #  else
+    #    native.find_elements(*args)
+    #  end
+    #end
 
-    def all(*args)
-      native.find_elements(*args)
-    end
+    #def find(*args)
+    #  el = native.find_element(*args)
+    #  highlight_element(el) if SeleniumPlus.enable_highlight_element
+    #  el
+    #end
+    #
+    #def all(*args)
+    #  native.find_elements(*args)
+    #end
 
     def active_element
       native.switch_to.active_element

data/lib/selenium_plus/finders.rb

@@ -0,0 +1,21 @@
+module SeleniumPlus
+  module Finders
+    def find(*args)
+      if self.class.superclass == SeleniumPlus::Section
+        @el =root_element.find_element(*args)
+      else
+        @el = SeleniumPlus.driver.native.find_element(*args)
+      end
+      SeleniumPlus.driver.highlight_element(@el) if SeleniumPlus.enable_highlight_element
+      @el
+    end
+
+    def all(*args)
+      if self.class.superclass == SeleniumPlus::Section
+        root_element.find_elements(*args)
+      else
+        SeleniumPlus.driver.native.find_elements(*args)
+      end
+    end
+  end
+end

data/lib/selenium_plus/page_obj/page.rb

@@ -1,18 +1,19 @@
 module SeleniumPlus
   class Page
+    include Finders
     extend Container
 
     def goto(url)
       SeleniumPlus.driver.visit(url)
     end
 
-    private
-    def find(*args)
-      SeleniumPlus.driver.find(*args)
-    end
-
-    def all(*args)
-      SeleniumPlus.driver.all(*args)
-    end
+    #private
+    #def find(*args)
+    #  SeleniumPlus.driver.find(*args)
+    #end
+    #
+    #def all(*args)
+    #  SeleniumPlus.driver.all(*args)
+    #end
   end
 end

data/lib/selenium_plus/page_obj/section.rb

@@ -1,5 +1,6 @@
 module SeleniumPlus
   class Section
+    include Finders
     extend Container
 
     attr_reader :root_element
@@ -8,13 +9,14 @@ module SeleniumPlus
       @root_element = root_element
     end
 
-    private
-    def find(*args)
-      root_element.find(*args)
-    end
-
-    def all(*args)
-      root_element.all(*args)
-    end
+    #private
+    #
+    #def find(*args)
+    #  root_element.find(*args)
+    #end
+    #
+    #def all(*args)
+    #  root_element.all(*args)
+    #end
   end
 end

data/lib/selenium_plus/selenium/element.rb

@@ -1,6 +1,7 @@
 # Public: Add extension method to Element class
 #
 class Selenium::WebDriver::Element
+ # include SeleniumPlus::Finders
   include SeleniumPlus::Elements::Table
 
   # Retrieve the given attribute

data/lib/selenium_plus/selenium/table.rb

@@ -1,14 +1,32 @@
 module SeleniumPlus
   module Elements
     module Table
-      # Raw elements of table
+
+      # Raw Selenium::WebDriver::Element of the table
+      #
+      # Examples:
+      #   A html table:
+      #   | id | name  |
+      #   | 1  | alex  |
+      #   | 2  | smith |
+      #
+      #   gets converted into the following:
+      #   #=> [[Element, Element],[Element, Element], [Element, Element]]
       #
       # @return [Array[Array<Selenium::WebDriver::Element>]]
       def raw
         self.all(:css, 'tr').map{ |row| row.all(:css, 'th,td')}
       end
 
-      # Raw text of table
+      # Raw text of this table
+      # Examples:
+      #   A html table:
+      #   | id | name  |
+      #   | 1  | alex  |
+      #   | 2  | smith |
+      #
+      #   gets converted into the following:
+      #   #=> [['id', 'name'],['1', 'alex'], ['2', 'smith']]
       #
       # @return [Array[Array<String>]]
       def raw_text
@@ -45,21 +63,54 @@ module SeleniumPlus
         end
       end
 
-      # Text of table header
+      # Table headers text
+      # Examples:
+      #   A html table header with horizontal headers
+      #   | id | name |
+      #
+      #   and
+      #
+      #   A html table header with vertical headers
+      #   | id   |
+      #   | name |
+      #
+      #   get converted into the following:
+      #   #=> ['id', 'name']
       #
       # @return [Array<String>]
       def headers_text
         headers.map { |cell| cell.text.strip }
       end
 
-      # Text of table rows
+      # Table body rows text
+      # Examples:
+      #   A html table body with horizontal headers
+      #   | 1  | alex  |
+      #   | 2  | smith |
+      #
+      #   and
+      #
+      #   A html table body with vertical headers
+      #   | 1    | 2     |
+      #   | alex | smith |
+      #
+      #   get converted into the following:
+      #   #=> [['1', 'alex'], ['2', 'smith']]
       #
       # @return [Array[Array<String>]]
       def rows_text
         rows.map { |row| row.map { |cell| cell.text.strip } }
       end
 
-      # Array of Hash where the keys of each Hash are the headers in the table
+      # Converts this table into an Array of Hash where the keys of each Hash are the headers in the table.
+      # Examples:
+      #   A html table:
+      #   | id | name  | age |
+      #   | 1  | alex  | 10  |
+      #   | 2  | smith | 16  |
+      #
+      #   Gets converted into the following:
+      #   # => [{'id' => '1', 'name' => 'alex', 'age' => '10'}, {'id' => '2', 'name' => 'smith', 'age' => '16'}]
       #
       # @return [Array<Hash>]
       def hashes

data/lib/selenium_plus/version.rb

@@ -1,3 +1,3 @@
 module SeleniumPlus
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/selenium_plus.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |gem|
   gem.version       = SeleniumPlus::VERSION
   gem.authors       = ['SparkYao']
   gem.email         = %w(shipuyao@gmail.com)
-  gem.description   = ''
+  gem.description   = 'SeleniumPlus creates a very thin layer between Selenium and your applications, it gives your a simple and quick way to describe your web site using the Page Object Model.'
   gem.summary       = ''
-  gem.homepage      = ''
+  gem.homepage      = 'https://github.com/shipuyao/selenium_plus'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/test_site/html/home.html

@@ -9,8 +9,10 @@
     </script>
 </head>
 <body>
+    <div class='title'>Test Home Page</div>
     <input type='submit' name='Show First Table' value='Show' onclick="showFirstTable('first')"/>
     <div id='info'>
+        <div class='title'>Information tables</div>
         <table id="first" class='horizontal_headers' style="display: none">
             <tr>
                 <th>ID:</th>

data/test_site/pages/home_page.rb

@@ -2,11 +2,23 @@ module Test
   class HomePage < SeleniumPlus::Page
 
     section(:info_section, InfoSection, :id, 'info')
+
     element(:show_btn, :css, 'input[value=Show]')
 
+    element(:title_div, :css, 'div.title')
+    elements(:title_divs, :css, 'div.title')
+
     def show_first_table
       show_btn.click
     end
+
+    def title
+      title_div.text
+    end
+
+    def titles
+      title_divs.map{ |cell| cell.text.strip }
+    end
   end
 end
 

data/test_site/sections/info_section.rb

@@ -4,6 +4,10 @@ module Test
 
     element(:h_table, :css, 'table.horizontal_headers')
     element(:v_table, :css, 'table.vertical_headers')
+    element(:title_div, :css, 'div.title')
 
+    def title
+      title_div.text
+    end
   end
 end

data/test_site/test_project.rb

@@ -8,5 +8,5 @@ end
 driver = SeleniumPlus.using_driver(:firefox_driver)
 
 driver.visit('http://www.google.com.hk')
-driver.find(:id, 'lst-ib')
-
+driver.find(:id, 'lst-ib').type('Selenium')
+driver.find(:css, 'input[name=btnK]').click

data/test_site/test_site.rb

@@ -1,10 +1,7 @@
-$:.unshift(File.dirname(__FILE__))
-
 require 'selenium_plus'
-require 'sections/info_section'
-require 'pages/login_page'
-require 'pages/home_page'
 
+Dir.glob("#{File.dirname(__FILE__)}/sections/*.rb").each{ |file| require file }
+Dir.glob("#{File.dirname(__FILE__)}/pages/*.rb").each{ |file| require file }
 
 class TestSite
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70285072777900 !ruby/object:Gem::Requirement
+  requirement: &70240881264280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70285072777900
+  version_requirements: *70240881264280
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: &70285072776760 !ruby/object:Gem::Requirement
+  requirement: &70240881262740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.25.0
   type: :runtime
   prerelease: false
-  version_requirements: *70285072776760
+  version_requirements: *70240881262740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70285072775160 !ruby/object:Gem::Requirement
+  requirement: &70240881261720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70285072775160
+  version_requirements: *70240881261720
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70285072774360 !ruby/object:Gem::Requirement
+  requirement: &70240881260520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,8 +54,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70285072774360
-description: ''
+  version_requirements: *70240881260520
+description: SeleniumPlus creates a very thin layer between Selenium and your applications,
+  it gives your a simple and quick way to describe your web site using the Page Object
+  Model.
 email:
 - shipuyao@gmail.com
 executables: []
@@ -68,14 +70,18 @@ files:
 - README.md
 - Rakefile
 - features/drivers.feature
+- features/finders.feature
+- features/step_definitions/finder_steps.rb
 - features/step_definitions/general_steps.rb
 - features/step_definitions/tables_steps.rb
 - features/support/env.rb
 - features/support/hooks.rb
 - features/tables.feature
 - lib/selenium_plus.rb
+- lib/selenium_plus/cucumber.rb
 - lib/selenium_plus/driver.rb
 - lib/selenium_plus/exceptions.rb
+- lib/selenium_plus/finders.rb
 - lib/selenium_plus/page_obj/container.rb
 - lib/selenium_plus/page_obj/page.rb
 - lib/selenium_plus/page_obj/section.rb
@@ -90,7 +96,7 @@ files:
 - test_site/sections/info_section.rb
 - test_site/test_project.rb
 - test_site/test_site.rb
-homepage: ''
+homepage: https://github.com/shipuyao/selenium_plus
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -116,6 +122,8 @@ specification_version: 3
 summary: ''
 test_files:
 - features/drivers.feature
+- features/finders.feature
+- features/step_definitions/finder_steps.rb
 - features/step_definitions/general_steps.rb
 - features/step_definitions/tables_steps.rb
 - features/support/env.rb