selenium_plus 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjE1MThkNTIwYzVlOGM4YTA4NzAwZWM0NGU5ZGQxODEyNDMxNmFjMw==
+    MmEyMDM1ZjgxNDg3ZmU4M2VlNTllZTIyMDk2NWFhZWEzYWM1YjhjZg==
   data.tar.gz: !binary |-
-    YWVkZjU0ODMxNmY4MjBhYjExNjExNjQ2ZDJlMGJlOWNmMTM1MjgyMA==
+    MmMzNjc3MjVlMjY4MDI2N2FkNDRiMGQ2Nzg2MTM4YTJkNmEzM2U2Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Y2JmNmVkYjAwM2Q1NTBmOGMyYTk3ZGFkZTAzMTAxMDQ0NWZlOGU5YmM0NjAy
-    ZDY4OWFiNWYwZWUyZTFjMjkzYjBkNzZmMzYzYmM4YjU3Nzc0M2E3ODI5NGRl
-    M2U4NTU5OWVjY2E4NTRjMjdiZjg2YjRlMzIyZDkyMjlmMjhhYjQ=
+    MmMwNDA3OWZjNzRmN2ZlODI0NTUyMDUzYmI1NmJjNTg4MWIwMzUxOGE3MDI4
+    OTdkZTA3MjE3YjJlMTNjNDg4ZmU5YTdiYjU4YjAwMWQzNDA2YmQ3ZGFmYTA3
+    OWVkZGE3YjU0ZmRkYzY1ZjM4ZDM5YmNkY2EyZDhjOGMzNGU4MDg=
   data.tar.gz: !binary |-
-    NDc4N2Q0NGQ2ZDVlYTI3MTQzZjdjZDIwMmU1MzQ2MDFlMjg5ZjUyYmNkZWZm
-    ZTM0ZTBmYjU1YjBjZjk2YTkyZDA3OWQ4MTliMjUyNDhiZGMxNjU5ZmE4YWQy
-    NzBiMmU5NGRmMjBlZWFiNzlkYzM2ZWQ5N2E2MzJiYWEwZjkwYWE=
+    YjQxNWQ1OTk3NDk4MzgyMTYxOTI4NDZhZmE2NWZmOGRhNjk3ZTViMzI5MjUz
+    ZDRmZWE4M2ZmNWVhNDc5ZjI1OWY0YzE2YzE1OWFiNTZhYWU2OTI3OTcyNzMx
+    YWE4ODIxYjE0ODAyZTAzMDg0Mzc1OGExZjk3N2EzOGFhZWU5OGE=

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 .yardoc/
 .rvmrc
 chromedriver.log
+.gem

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/lib/selenium_plus/exception.rb

@@ -0,0 +1,6 @@
+module SeleniumPlus
+  module Exceptions
+    class SeleniumPlusError < StandardError; end
+    class DriverNotFoundError < SeleniumPlusError; end
+  end
+end

data/lib/selenium_plus/page_obj/container.rb

@@ -1,73 +1,81 @@
 module SeleniumPlus
   module Container
 
-    # Public: Define a new method with the name of the symbol after locator returns element
-    # and highlight element
+    # Define a new method with the name of the symbol and return an element
     #
-    # Example
-    #   element(:username_tb, 'username')
+    # Examples:
+    #   class DemoPage < SeleniumPlus::Page
+    #     element(:username_tb, :id, 'username')
+    #   end
     #
-    # Returns element
-    def element(element_name, *find_args)
-      define_method(element_name.to_sym) do
+    #
+    # @param [Symbol] name        The name of new element
+    # @param [Array]  find_args
+    #
+    # @return [Selenium::WebDriver::Element]
+    def element(name, *find_args)
+      define_method(name) do
         driver.find(*find_args)
       end
-      add_existence_checker(element_name, *find_args)
-      private element_name
+      add_existence_checker(name, *find_args)
+      private name
     end
 
-    # Public: Define a new method with the name of the symbol after locator returns elements
+    # Define a new method with the name of the symbol and return elements
     #
-    # Example
-    #   elements(:aria_message_div, xpath: "//div[@id='ariaErrors']//li")
-    #   # => <Capybara::Elements>
+    # Examples:
+    #   class DemoPage < SeleniumPlus::Page
+    #     elements(:results_list, :css, 'li.view')
+    #   end
     #
-    # Returns elements
-    def elements(element_name, *find_args)
-      define_method(:define_method, element_name) do
+    # @param [Symbol] name         The name of new elements array
+    # @param [Array]  find_args
+    #
+    # @return [Array<Selenium::WebDriver::Element>]
+    def elements(name, *find_args)
+      define_method(name) do
         driver.all(*find_args)
       end
-      private element_name
+      private name
     end
 
-    # Public: Define Partial section of the page
+    # Define partial section of the page
     #
-    # Returns page object
-    def section(section_name, section_class, *find_args)
-      send(:define_method, section_name) do
-        section_class.new(driver, driver.find(*find_args))
-      end
-    end
-
-    # Public: Add element name into list
+    # Examples:
+    #   class DemoPage < SeleniumPlus::Page
+    #     Section(:search_section, SearchSection, :id, 'div#search_me')
+    #   end
     #
-    # Returns nothing
-    def add_element_name(element_name)
-      @element_names ||= []
-      @element_names << element_name
-    end
-
-    # Public: Element names in the page object
+    # @param [Symbol] name        The name of new section
+    # @param [Array]  find_args
     #
-    # return element names array
-    def element_names
-      @element_names
+    # @return [SeleniumPlus::Section]
+    def section(name, section_class, *find_args)
+      define_method(name) do
+        section_class.new(driver, driver.find(*find_args))
+      end
     end
 
     private
     # Define an existence check method
-    # This method tries to find all elements by given locator with no wait time
-    # please make sure your page/section is fully loaded before use this method
+    #   This method tries to find element by given locator with no wait time
+    #   please make sure your page/section is fully loaded before use this method
+    #
+    # Examples:
+    #   class DemoPage < SeleniumPlus::Page
+    #     element(:username_tb, :id, 'username')
+    #   end
+    #
+    #   demo_page = DemoPage.new(driver)
+    #   demo_page.has_username_tb?
     #
-    # Example
-    #   login_page.has_username_tb?
-    #   # => true
+    # @param [Symbol] name        The name of new section
+    # @param [Array]  find_args
     #
-    # Returns
-    def add_existence_checker(element_name, *find_args)
-      method_name = "has_#{element_name}?"
-      define_method(method_name.to_sym) do
-        all(*find_args).size > 0
+    # @return [Boolean]
+    def add_existence_checker(name, *find_args)
+      define_method("has_#{name.to_s}?") do
+        driver.all(*find_args).size > 0
       end
     end
   end

data/lib/selenium_plus/selenium/element.rb

@@ -3,12 +3,28 @@
 class Selenium::WebDriver::Element
   include SeleniumPlus::Elements::Table
 
-  def [](name)
-    self.attribute(name.to_s)
+  # Retrieve the given attribute
+  #
+  # Examples:
+  #   element[:name]                HTML name attribute
+  #
+  # @param [Symbol] attribute       The attribute to retrieve
+  #
+  # @return [String]                The value of the attribute
+  def [](attribute)
+    self.attribute(attribute.to_s)
   rescue Selenium::WebDriver::Error::WebDriverError
     nil
   end
 
+  # Set the value of the element to the given value.
+  #
+  # Examples:
+  #   element.set('Hello')
+  #
+  # @param [String] value     The new value
+  #
+  # @return []
   def set(value)
     tag_name = self.tag_name
     type = self[:type]
@@ -27,26 +43,30 @@ class Selenium::WebDriver::Element
     end
   end
 
-  # Public: type text into text field
+  # Type text into text field element
   #
-  # Example
-  #   element.type_text("hello")
+  # Examples:
+  #   element.type('hello world')
   #
-  # Returns nothing
-  def type(value)
+  # @param [Symbol] text
+  #
+  # @return []
+  def type(text)
     self.clear
-    self.set(value)
+    self.set(text)
   end
 
-  # Public: append text into text field
+  # Append text into text field element
+  #
+  # Examples:
+  #   element.append('hello world')
   #
-  # Example
-  #   element.append_text("hello")
+  # @param [Symbol] text
   #
-  # Returns nothing
-  def append(value)
-    old = self.value
-    self.set(old + value)
+  # @return []
+  def append(text)
+    old = self.text
+    self.set(old + text)
   end
 
 end

data/lib/selenium_plus/version.rb

@@ -1,3 +1,3 @@
 module SeleniumPlus
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/selenium_plus.rb

@@ -1,25 +1,45 @@
 require 'selenium-webdriver'
-
 require 'selenium_plus/version'
+require 'selenium_plus/exception'
 require 'selenium_plus/driver'
-require 'selenium_plus/page_obj/site'
 require 'selenium_plus/page_obj/container'
+require 'selenium_plus/page_obj/site'
 require 'selenium_plus/page_obj/page'
 require 'selenium_plus/page_obj/section'
 require 'selenium_plus/selenium/table'
 require 'selenium_plus/selenium/element'
 
 module SeleniumPlus
-  class SeleniumPlusError < StandardError; end
-  class DriverNotFoundError < SeleniumPlusError; end
 
   class << self
-    attr_accessor :default_driver, :current_driver, :default_wait_time, :driver
+    attr_accessor :driver, :default_driver, :current_driver, :default_wait_time, :enable_highlight
 
+    # Configure SeleniumPlus
+    #
+    # Examples:
+    #     SeleniumPlus.configure do |config|
+    #       config.default_wait_time  = 10
+    #       config.enable_highlight   = true
+    #     end
+    #
+    # [default_wait_time = Integer]
+    # [enable_highlight = Boolean]
+    #
     def configure
       yield self
     end
 
+    # Register a new driver for SeleniumPlus
+    #
+    # Example:
+    #   SeleniumPlus.register_driver :chrome_driver do
+    #     SeleniumPlus::Driver.new(:browser => :chrome)
+    #   end
+    #
+    # @param [Symbol] name              The name of the new driver
+    # @yield                            A block executed in the context of the new {SeleniumPlus::Driver}
+    #
+    # @return [] nothing
     def register_driver(name, &block)
       drivers[name] = block
     end
@@ -28,22 +48,39 @@ module SeleniumPlus
       @drivers ||= {}
     end
 
+    # @return [Symbol]    The name of the driver to use by default
+    def default_driver
+      @default_driver || :firefox_driver
+    end
+
+    # @return [Symbol]    The name of the driver currently in use
     def current_driver
       @current_driver || default_driver
     end
 
+    # Yield a block using a specific driver
+    #
+    # Example:
+    #   SeleniumPlus.using_driver
+    #
+    # @return [SeleniumPlus::Driver]      A SeleniumPlus driver instance
     def using_driver
-      drivers[current_driver].call
+      @driver ||= begin
+        unless drivers.has_key?(@current_driver)
+          other_drivers = drivers.keys.map { |key| key.inspect }
+          raise SeleniumPlus::Exceptions::DriverNotFoundError, "Driver #{@current_driver} was not found. Available types: #{other_drivers.join(', ')}"
+        end
+        drivers[@current_driver].call
+      end
     end
   end
-
 end
 
 SeleniumPlus.configure do |config|
   config.default_wait_time =10
-  config.default_driver = :firefox
+  config.enable_highlight = true
 end
 
-SeleniumPlus.register_driver :firefox do
+SeleniumPlus.register_driver :firefox_driver do
   SeleniumPlus::Driver.new(:browser => :firefox)
 end

data/selenium_plus.gemspec

@@ -6,7 +6,7 @@ require 'selenium_plus/version'
 Gem::Specification.new do |gem|
   gem.name          = 'selenium_plus'
   gem.version       = SeleniumPlus::VERSION
-  gem.authors       = ['Spark Yao']
+  gem.authors       = ['SparkYao']
   gem.email         = %w(shipuyao@gmail.com)
   gem.description   = ''
   gem.summary       = ''

data/test_project/test_project.rb

@@ -1,21 +1,26 @@
 $:.unshift(File.dirname(__FILE__))
-require 'selenium_plus'
+require '../lib/selenium_plus'
 require 'rspec'
 require 'test_site/test_site'
 
-SeleniumPlus.register_driver :chrome do
+
+SeleniumPlus.register_driver :firefox_driver do
   SeleniumPlus::Driver.new(:browser => :chrome)
 end
-#
-SeleniumPlus.current_driver = :chrome
 
-driver = SeleniumPlus.using_driver
-driver.visit('http://www.google.com.hk')
-driver.find(:id,'lst-ib').type('hello')
-driver.find(:css,'input[name=btnK]').click
-driver.browser.title.should == 'Google'
+SeleniumPlus.register_driver :chrome_driver do
+  SeleniumPlus::Driver.new(:browser => :chrome)
+end
+
+SeleniumPlus.current_driver = :chrome_driver
+
+#driver = SeleniumPlus.using_driver
+#driver.visit('http://www.google.com.hk')
+#driver.find(:id,'lst-ib').type('Mozy')
+#driver.find(:css,'input[name=btnK]').click
+#sleep 5
 
 @Test = TestSite.new
 @Test.home_page.visit('file:///Users/shipuy/Github/selenium_plus/test_project/test_site/html/home.html')
 @Test.home_page.show
-@Test.home_page.info_section.names_table_rows
+puts @Test.home_page.info_section.has_names_table?

data/test_project/test_site/pages/home_page.rb

@@ -6,7 +6,7 @@ module Test
 
     # Private elements
     #
-    element(:search_input, :id, 'keyword')
+    element(:search_input, :id, 'keywords')
     element(:submit_btn, :css, 'input[name=Submit]')
 
     def show

data/test_project/test_site/sections/info_section.rb

@@ -7,7 +7,7 @@ module Test
     element(:names_table, :css, 'table.view:first-child')
 
     def names_table_rows
-       # Not implemented
+      names_table
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selenium_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
-- Spark Yao
+- SparkYao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,7 @@ files:
 - Rakefile
 - lib/selenium_plus.rb
 - lib/selenium_plus/driver.rb
+- lib/selenium_plus/exception.rb
 - lib/selenium_plus/page_obj/container.rb
 - lib/selenium_plus/page_obj/page.rb
 - lib/selenium_plus/page_obj/section.rb