celerity 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,13 @@
+== 0.0.2 2008-05-15
+* 3 major enhancements:
+  * Support for multiple how => what conditions
+  * Fixed performance issue with collections
+  * Specs will now run on Windows
+* 3 minor enhancements:
+  * Benchmark scripts
+  * Method generator
+  * Fixed multi-byte characters issue for text fields
+
 == 0.0.1 2008-05-07
 
 * 1 major enhancement:

data/README.txt

@@ -7,9 +7,14 @@
 	Celerity is a JRuby/RJB wrapper around the HtmlUnit Java library (http://htmlunit.sourceforge.net/).
 	The goal of the project is to implement the Watir API (http://wtf.rubyforge.org/) on top of HtmlUnit.
 
-== FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+== FEATURES:
+
+* Fast: No time-consuming GUI rendering or unessential downloads
+* Scalable: Java threads lets you run tests in parallel
+* Easy to use: Simple API
+* Portable: Cross-platform
+* Unintrusive: No browser window interrupting your workflow (runs in background)
 
 == SYNOPSIS:
 
@@ -25,20 +30,12 @@
 
 * JRuby 1.1
 	
-	or 
-
-* Ruby Java Bridge (on MRI)
-
-NOTE: RJB currently has problems with threading. Use JRuby if you want to run your tests concurrently. 
+* Java 6
 
 == INSTALL:
 
 * jruby -S gem install celerity
 
-	or
-	
-* (sudo) gem install rjb celerity
-
 == LICENSE:
 
 Celerity - JRuby wrapper for HtmlUnit

data/Rakefile

@@ -1,4 +1,6 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
+begin
+  require 'config/requirements'
+  require 'config/hoe' # setup Hoe + all gem configuration
+rescue LoadError
+end
 Dir['tasks/**/*.rake'].each { |rake| load rake }

data/benchmark/bm_2000_spans.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + "/loader"
+
+# Create browser object
+browser = FRAMEWORK::IE.new
+browser.goto(TEST_HOST + "/2000_spans.html")
+
+TESTS = 100
+res = Benchmark.bmbm do |results|
+  results.report("Loop through all spans (n = 1)") do
+    1.times do # Hard coded 1 run
+      browser.spans.each do |span|
+        span.text
+      end
+    end
+  end
+  
+#  results.report("Loop through all spans (raw)") do
+#    TESTS.times do
+#      if RUBY_PLATFORM =~ /java/
+#        browser.document.getHtmlElementsByTagName("span").each do |span|
+#          span.asText
+#        end
+#      else
+#        browser.document.getElementsByTagName("span").each do |span|
+#          span.innerText
+#        end
+#      end
+#    end
+#  end
+  
+  results.report("Last span by id (String)") do
+    TESTS.times do
+      browser.span(:id, "id_2000").exists?
+    end
+  end
+  
+  results.report("Last span by id (Regexp)") do
+    TESTS.times do
+      browser.span(:id, "/2000/").exists?
+    end
+  end
+  
+end
+
+puts
+total = res.inject(0.0) { |mem, bm| mem + bm.real }
+puts "total  : " + total.to_s
+puts "average: " + (total/res.size.to_f).to_s

data/benchmark/bm_digg.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + "/loader"
+
+TESTS = 5
+res = Benchmark.bmbm do |results|
+  results.report("Diggs on front page") do
+    TESTS.times do
+      # Create browser object
+      browser = FRAMEWORK::IE.new
+      
+      # Go to digg.com
+      browser.goto('http://digg.com/')
+
+      # Gather statistics
+      total_diggs = 0
+      digg_number_elements = browser.links.select { |link| link.id =~ /diggs/ }
+      digg_numbers = digg_number_elements.collect { |digg_number_element| digg_number_element.text }
+      digg_numbers.each { |digg_number| total_diggs += digg_number.to_i }
+      #puts "Found #{digg_numbers.size} stories, with a total of #{total_diggs} diggs."
+    end
+  end
+end
+
+puts
+total = res.inject(0.0) { |mem, bm| mem + bm.real }
+puts "total  : " + total.to_s
+puts "average: " + (total/res.size.to_f).to_s

data/benchmark/bm_google_images.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + "/loader"
+
+TESTS = 5
+res = Benchmark.bmbm do |results|
+  results.report("Google image search results") do
+    TESTS.times do
+      # Create browser object
+      browser = FRAMEWORK::IE.new
+      
+      # Goto images.google.com
+      browser.goto('http://images.google.com/ncr')
+
+      # Search for Watir
+      browser.text_field(:name, 'q').set('Watir')
+      browser.button(:value, 'Search Images').click
+
+      src_pool = []
+      pages = 1
+      # Gather statistics and click Next if there are more results
+      while browser.link(:text, 'Next').exists?
+        pages += 1
+        browser.link(:text, 'Next').click unless src_pool.empty?
+        table_cells = browser.cells.select { |cell| cell.id =~ /tDataImage\d+/ }
+        table_cells.each do |cell|
+          src_pool << cell.image(:index, 1).src if cell.image(:index, 1).exists?
+        end
+      end
+      #puts "Looked at #{pages} pages of image search results. Got #{src_pool.size} images."
+    end
+  end
+end
+
+puts
+total = res.inject(0.0) { |mem, bm| mem + bm.real }
+puts "total  : " + total.to_s
+puts "average: " + (total/res.size.to_f).to_s

data/benchmark/bm_input_locator.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + "/loader"
+
+browser = FRAMEWORK::IE.new
+browser.goto(TEST_HOST + "/forms_with_input_elements.html")
+
+TESTS = 1000
+res = Benchmark.bmbm do |results|
+  results.report("text input by id (String)") do
+    TESTS.times { browser.text_field(:id, "new_user_first_name").exists? }
+  end
+  results.report("text input by id (Regexp)") do
+    TESTS.times { browser.text_field(:id, /first_name/).exists? }
+  end
+  results.report("text input by name (String)") do
+    TESTS.times { browser.text_field(:name, "new_user_email").exists? }
+  end
+  results.report("text input by name (Regexp)") do
+    TESTS.times { browser.text_field(:name, /user_email/).exists? }
+  end
+  
+  results.report("select list by id (String)") do
+    TESTS.times { browser.select_list(:id, 'new_user_country').exists? }
+  end
+  results.report("select list by id (Regexp)") do
+    TESTS.times { browser.select_list(:id, /user_country/).exists? }
+  end
+  results.report("select list by name (String)") do
+    TESTS.times { browser.select_list(:name, 'new_user_country').exists? }
+  end
+  results.report("select list by name (Regexp)") do
+    TESTS.times { browser.select_list(:name, /user_country/).exists? }
+  end
+  
+  results.report("checkbox by id (String)") do
+    TESTS.times { browser.checkbox(:id, 'new_user_interests_books').exists? }
+  end
+  results.report("checkbox by id (Regexp)") do
+    TESTS.times { browser.checkbox(:id, /interests_books/).exists? }
+  end
+  
+  results.report("checkbox by name (String)") do
+    TESTS.times { browser.checkbox(:name, 'new_user_interests').exists? }
+  end
+  results.report("checkbox by name (Regexp)") do
+    TESTS.times { browser.checkbox(:name, /user_interests/).exists? }
+  end
+  
+  results.report("checkbox by id (String) and value (String)") do
+    TESTS.times { browser.checkbox(:id, 'new_user_interests_books', 'cars').exists? }
+  end
+  results.report("checkbox by id (Regexp) and value (Regexp)") do
+    TESTS.times { browser.checkbox(:id, /interests_books/, /car/).exists? }
+  end
+  
+  results.report("checkbox by name (String) and value (String)") do
+    TESTS.times { browser.checkbox(:name, 'new_user_interests', 'dancing').exists? }
+  end
+  results.report("checkbox by name (Regexp) and value (Regexp)") do
+    TESTS.times { browser.checkbox(:name, /user_interests/, /danc/).exists? }
+  end
+
+  
+  
+end
+
+puts
+total = res.inject(0.0) { |mem, bm| mem + bm.real }
+puts "total  : " + total.to_s
+puts "average: " + (total/res.size.to_f).to_s

data/benchmark/loader.rb

@@ -0,0 +1,9 @@
+require 'benchmark'
+require File.dirname(__FILE__) + "/../spec/spec_helper"
+
+if RUBY_PLATFORM =~ /java/
+  FRAMEWORK = Celerity
+else
+  require 'watir'
+  FRAMEWORK = Watir
+end

data/lib/celerity.rb

@@ -27,6 +27,8 @@ require "celerity/clickable_element"
 require "celerity/disabled_element"
 require "celerity/element_collections"
 require "celerity/collections"
+require "celerity/element_locator"
+require "celerity/identifier"
 require "celerity/container"
 require "celerity/element"
 require "celerity/input_element"
@@ -34,7 +36,6 @@ require "celerity/non_control_elements"
 Dir[File.dirname(__FILE__) + "/celerity/elements/*.rb"].each { |f| require(f) }
 require "celerity/ie"
 
-
 require "logger"
 require "uri"
 require "pp"
@@ -45,3 +46,4 @@ Log.level = Logger::DEBUG
 # undefine deprecated methods to use them for Element attributes
 Object.send :undef_method, :id
 Object.send :undef_method, :type
+

data/lib/celerity/container.rb

@@ -1,29 +1,16 @@
 module Celerity
   module Container
     include Celerity::Exception
-    
     attr_accessor :page_container
 
     def set_container(container)
       @container = container
       @page_container = container.page_container
     end
-    
+
     def update_page(page)
       @page_container.set_page(page)
     end
-    
-    def contains_text(expected_text)
-      assert_exists
-      case expected_text
-      when Regexp
-        text().match(expected_text)
-      when String
-        text().index(expected_text)
-      else
-        raise ArgumentError, "Argument #{expected_text.inspect} should be a String or Regexp."
-      end
-    end
 
     def frame(*args)
       assert_exists
@@ -33,21 +20,21 @@ module Celerity
     def table(*args)
       assert_exists
       Table.new(self, *args)
-    end 
+    end
     def tables
       assert_exists
       Tables.new(self)
     end
-    
+
     def cell(*args)
-      assert_exists      
+      assert_exists
       TableCell.new(self, *args)
     end
     def cells
       assert_exists
       TableCells.new(self)
     end
-    
+
     def row(*args)
       assert_exists
       TableRow.new(self, *args)
@@ -56,7 +43,7 @@ module Celerity
       assert_exists
       TableRows.new(self)
     end
-  
+
     def button(*args)
       assert_exists
       Button.new(self, *args)
@@ -74,7 +61,7 @@ module Celerity
       assert_exists
       FileFields.new(self)
     end
-    
+
     def text_field(*args)
       assert_exists
       TextField.new(self, *args)
@@ -83,7 +70,7 @@ module Celerity
       assert_exists
       TextFields.new(self)
     end
-    
+
     def hidden(*args)
       assert_exists
       Hidden.new(self, *args)
@@ -92,7 +79,7 @@ module Celerity
       assert_exists
       Hiddens.new(self)
     end
-    
+
     def select_list(*args)
       assert_exists
       SelectList.new(self, *args)
@@ -101,28 +88,28 @@ module Celerity
       assert_exists
       SelectLists.new(self)
     end
-    
-    def check_box(how, what, value = nil)
+
+    def check_box(*args)
       assert_exists
-      CheckBox.new(self, how, what, ["checkbox"], value)
+      CheckBox.new(self, *args)
     end
     alias_method :checkbox, :check_box
     alias_method :checkBox, :check_box
-    
+
     def checkboxes
       assert_exists
       CheckBoxes.new(self)
     end
-    
-    def radio(how, what, value = nil)
+
+    def radio(*args)
       assert_exists
-      Radio.new(self, how, what, ["radio"], value)
+      Radio.new(self, *args)
     end
     def radios
       assert_exists
       Radios.new(self)
     end
-    
+
     def link(*args)
       assert_exists
       Link.new(self, *args)
@@ -141,7 +128,7 @@ module Celerity
       assert_exists
       Lis.new(self)
     end
-    
+
     def map(*args)
       assert_exists
       Map.new(self, *args)
@@ -150,7 +137,7 @@ module Celerity
       assert_exists
       Maps.new(self)
     end
-    
+
     def area(*args)
       assert_exists
       Area.new(self, *args)
@@ -159,7 +146,7 @@ module Celerity
       assert_exists
       Areas.new(self)
     end
-    
+
     def image(*args)
       assert_exists
       Image.new(self, *args)
@@ -168,9 +155,7 @@ module Celerity
       assert_exists
       Images.new(self)
     end
-    
-    #TODO: Popup method here?
-    
+
     def div(*args)
       assert_exists
       Div.new(self, *args)
@@ -216,7 +201,7 @@ module Celerity
       assert_exists
       Pres.new(self)
     end
-    
+
     def label(*args)
       assert_exists
       Label.new(self, *args)
@@ -225,145 +210,12 @@ module Celerity
       assert_exists
       Labels.new(self)
     end
-    
-    #
-    #                Locator Methods
-    #
-
-    # Returns the specified ole object for input elements on a web page.
-    #
-    # This method is used internally by Watir and should not be used externally. It cannot be marked as private because of the way mixins and inheritance work in watir
-    #   * element_instance - an Element subclass instance
-    #   * how - symbol - the way we look for the object. Supported values are
-    #                  - :name
-    #                  - :id
-    #                  - :index
-    #                  - :value etc
-    #   * what  - string that we are looking for, ex. the name, or id tag attribute or index of the object we are looking for.
-    #   * value - used for objects that have one name, but many values. ex. radio lists and checkboxes
-    def locate_input_element(element_instance, how, what, value = nil)
-      idents = element_instance.class::TAGS
-      tags = idents.map { |e| e.tag }
-      begin
-        case how
-        when :id
-          case what
-          when Regexp
-            elements_by_tag_names(tags).find { |elem| elem.getIdAttribute =~ what }
-          when String
-            @object.getHtmlElementById(what)
-          else
-            raise ArgumentError, "Argument #{what.inspect} should be a String or Regexp"
-          end
-        when :name, :value
-          elements_by_idents(idents).find do |e|
-            matches?(e.getAttribute(how.to_s), what) && (value ? matches?(e.getValueAttribute, value) : true)
-          end
-        when :caption
-          elements_by_idents(idents).find { |e| matches?(e.getValueAttribute, what) }
-        when :class
-          elements_by_idents(idents).find { |e| matches?(e.getClassAttribute, what) }
-        when :text
-          elements_by_idents(idents).find { |e| matches?(e.asText, what) }
-        when :index
-          elements_by_idents(idents)[what.to_i - 1]
-        when :xpath
-          what = ".#{what}" if what[0] == ?/
-          @object.getByXPath(what).to_a.first
-        else
-          raise MissingWayOfFindingObjectException
-        end
-      rescue HtmlUnit::ElementNotFoundException
-      end
-    end
 
-    def locate_tagged_element(element_instance, how, what)
-      tags = element_instance.class::TAGS
-      begin
-        case how
-        when :id
-          case what
-          when Regexp
-            elements_by_tag_names(tags).find { |elem| elem.getIdAttribute =~ what }
-          when String
-            @object.getHtmlElementById(what)
-          else
-            raise ArgumentError, "Argument #{what.inspect} should be a String or Regexp"
-          end
-        when :name, :value, :title
-          elements_by_tag_names(tags).find { |elem| matches?(elem.getAttributeValue(how.to_s), what) }
-        when :class
-          elements_by_tag_names(tags).find { |elem| matches?(elem.getClassAttribute, what)}
-        when :text
-          elements_by_tag_names(tags).find { |elem| matches?(elem.asText, what) }
-        when :index
-          elements_by_tag_names(tags)[what.to_i-1]
-        when :xpath
-          what = ".#{what}" if what[0] == ?/
-          @object.getByXPath(what).to_a.first
-        when :url
-          case element_instance
-          when Celerity::Link, Celerity::Map, Celerity::Area
-            elements_by_tag_names(tags).find { |elem| matches?(elem.getHrefAttribute, what) }
-          end
-        when :src
-          case element_instance
-          when Celerity::Image
-            elements_by_tag_names(tags).find { |elem| matches?(elem.getSrcAttribute, what) }
-          end
-        when :alt
-          case element_instance
-          when Celerity::Image
-            elements_by_tag_names(tags).find { |elem| matches?(elem.getAltAttribute, what) }
-          end
-        when :action
-          case element_instance
-          when Celerity::Form
-            elements_by_tag_names(tags).find { |elem| matches?(elem.getActionAttribute, what) }
-          end
-        when :method
-          case element_instance
-          when Celerity::Form
-            elements_by_tag_names(tags).find { |elem| matches?(elem.getMethodAttribute, what) }
-          end
-        else
-          raise MissingWayOfFindingObjectException, "No how #{how.inspect}"
-        end
-      rescue HtmlUnit::ElementNotFoundException
-      end
-    end
-    
     private
-    
-    # this could be optimized when iterating - we don't need to check the class of 'what' for each element
-    # perhaps something like this
-    # find_matching_element(collection, method = :to_s, what)
+
     def matches?(string, what)
       Regexp === what ? string.match(what) : string == what.to_s
     end
     
-    def elements_by_tag_names(tags)
-      # HtmlUnit's getHtmlElementsByTagNames won't get elements in the correct order, making :index fail
-      tags.map! { |t| t.downcase }
-      @object.getAllHtmlChildElements.iterator.to_a.select do |elem|
-        tags.include?(elem.getTagName)
-      end
-    end
-    
-    def elements_by_idents(idents)
-      elements = elements_by_tag_names(idents.map { |i| i.tag })
-      # Log.debug elements.inspect
-      elements.select do |e| 
-        idents.any? do |ident| 
-          next unless ident.tag == e.getTagName
-          if ident.attributes.empty?
-            true
-          else
-            ident.attributes.any? { |key, value| value.include?(e.getAttributeValue(key.to_s)) } 
-          end
-        end
-      end
-    end
-    
   end # Container
 end # Celerity