vapir-common 1.7.0 → 1.7.1.rc1

data/lib/vapir-common/browser.rb

@@ -172,7 +172,7 @@ before you invoke Browser.new.
       exists?
     end
     def locate!(options={})
-      locate(options) || raise(Vapir::Exception::NoMatchingWindowFoundException, "The browser window seems to be gone")
+      locate(options) || raise(Vapir::Exception::WindowGoneException, "The browser window seems to be gone")
     end
     def inspect
       "#<#{self.class}:0x#{(self.hash*2).to_s(16)} " + (exists? ? "url=#{url.inspect} title=#{title.inspect}" : "exists?=false") + '>'

data/lib/vapir-common/container.rb

@@ -112,6 +112,48 @@ module Vapir
       end
       result
     end
+    public
+    # catch exceptions that indicate some failure of something existing. 
+    # 
+    # takes an option, :handle, which indicates how the method should handle an 
+    # encountered exception. 
+    # :handle may be one of:
+    # * :ignore (default) - the exception is ignored and nil is returned. 
+    # * :raise - the exception is raised (same as if this method weren't used at all). 
+    # * :return - returns the exception which was raised. 
+    # * Proc, Method - the proc or method is called with the exception as an argument. 
+    #
+    # If no exception was raised, then the result of the give block is returned. 
+    #--
+    # this may be overridden elsewhere to deal with any other stuff that indicates failure to exist, as it is
+    # to catch WIN32OLERuntimeErrors. 
+    def handling_existence_failure(options={})
+      options=handle_options(options, :handle => :ignore)
+      begin
+        yield
+      rescue Vapir::Exception::ExistenceFailureException
+        handle_existence_failure($!, options)
+      end
+    end
+    private
+    # handles any errors encountered by #handling_existence_failure (either the
+    # common one or a browser-specific one) 
+    def handle_existence_failure(error, options={})
+      options=handle_options(options, :handle => :ignore)
+      case options[:handle]
+      when :raise
+        raise error
+      when :ignore
+        nil
+      when :return
+        error
+      when Proc, Method
+        options[:handle].call(error)
+      else
+        raise ArgumentError, "Don't know what to do when told to handle by :handle => #{options[:handle].inspect}"
+      end
+    end
+    public
     
     def default_extra_for_contained
       extra={:container => self}

data/lib/vapir-common/element.rb

@@ -671,10 +671,8 @@ module Vapir
     public
     # Returns whether this element actually exists.
     def exists?
-      begin
-        !!locate
-      rescue Vapir::Exception::UnknownObjectException, Exception::NoMatchingWindowFoundException # if the window itself is gone, certainly we don't exist. 
-        false
+      handling_existence_failure(:handle => proc { return false }) do
+        return !!locate
       end
     end
     alias :exist? :exists?
@@ -740,18 +738,10 @@ module Vapir
           result=yield
         ensure
           @highlighting=was_highlighting
-          if !@highlighting && options[:highlight] && exists? # if we stopped existing during the highlight, don't try to clear. 
-            if Object.const_defined?('WIN32OLE') # if WIN32OLE exists, calling clear_highlight may raise WIN32OLERuntimeError, even though we just checked existence. 
-              exception_to_rescue=WIN32OLERuntimeError
-            else # otherwise, make a dummy class, inheriting from Exception that won't ever be instantiated to be rescued. 
-              exception_to_rescue=(@@dummy_exception ||= Class.new(::Exception))
-            end
-            begin
+          if !@highlighting && options[:highlight]
+            handling_existence_failure do
+              assert_exists :force => true
               clear_highlight(highlight_options)
-            rescue exception_to_rescue
-              # apparently despite checking existence above, sometimes the element object actually disappears between checking its existence 
-              # and clear_highlight using it, raising WIN32OLERuntimeError. 
-              # don't actually do anything in the rescue block here. 
             end
           end
         end
@@ -894,8 +884,94 @@ module Vapir
     def element_object_style(element_object, document_object)
       self.class.element_object_style(element_object, document_object)
     end
-    
     public
+    
+    # returns an array of all text nodes below this element in the DOM heirarchy 
+    def text_nodes
+      # TODO: needs tests 
+      assert_exists do
+        recurse_text_nodes=proc do |rproc, e_obj|
+          case e_obj.nodeType
+          when 1 # TODO: name a constant ELEMENT_NODE, rather than magic number 
+            object_collection_to_enumerable(e_obj.childNodes).inject([]) do |result, c_obj|
+              result + rproc.call(rproc, c_obj)
+            end
+          when 3 # TODO: name a constant TEXT_NODE, rather than magic number 
+            [e_obj.data]
+          else
+            #Kernel.warn("ignoring node of type #{e_obj.nodeType}")
+            []
+          end
+        end
+        recurse_text_nodes.call(recurse_text_nodes, element_object)
+      end
+    end
+    # returns an array of text nodes below this element in the DOM heirarchy which are visible - 
+    # that is, their parent element is visible. 
+    def visible_text_nodes
+      # TODO: needs tests 
+      assert_exists do
+        # define a nice recursive function to iterate down through the children 
+        recurse_text_nodes=proc do |rproc, e_obj, parent_visibility|
+          case e_obj.nodeType
+          when 1 # TODO: name a constant ELEMENT_NODE, rather than magic number 
+            style=element_object_style(e_obj, document_object)
+            our_visibility = style && (visibility=style.invoke('visibility'))
+            unless our_visibility && ['hidden', 'collapse', 'visible'].include?(our_visibility=our_visibility.strip.downcase)
+              our_visibility = parent_visibility
+            end
+            if (display=style.invoke('display')) && display.strip.downcase=='none'
+              []
+            else
+              object_collection_to_enumerable(e_obj.childNodes).inject([]) do |result, c_obj|
+                result + rproc.call(rproc, c_obj, our_visibility)
+              end
+            end
+          when 3 # TODO: name a constant TEXT_NODE, rather than magic number 
+            if ['hidden','collapse'].include?(parent_visibility)
+              []
+            else
+              [e_obj.data]
+            end
+          else
+            #Kernel.warn("ignoring node of type #{e_obj.nodeType}")
+            []
+          end
+        end
+  
+        # determine the current visibility and display. TODO: this is copied/adapted from #visible?; should DRY 
+        element_to_check=element_object
+        real_visibility=nil
+        while element_to_check #&& !element_to_check.instanceof(nsIDOMDocument)
+          if (style=element_object_style(element_to_check, document_object))
+            # only pay attention to the innermost definition that really defines visibility - one of 'hidden', 'collapse' (only for table elements), 
+            # or 'visible'. ignore 'inherit'; keep looking upward. 
+            # this makes it so that if we encounter an explicit 'visible', we don't pay attention to any 'hidden' further up. 
+            # this style is inherited - may be pointless for firefox, but IE uses the 'inherited' value. not sure if/when ff does.
+            if real_visibility==nil && (visibility=style.invoke('visibility'))
+              visibility=visibility.strip.downcase
+              if ['hidden', 'collapse', 'visible'].include?(visibility)
+                real_visibility=visibility
+              end
+            end
+            # check for display property. this is not inherited, and a parent with display of 'none' overrides an immediate visibility='visible' 
+            display=style.invoke('display')
+            if display && (display=display.strip.downcase)=='none'
+              # if display is none, then this element is not visible, and thus has no visible text nodes underneath. 
+              return []
+            end
+          end
+          element_to_check=element_to_check.parentNode
+        end
+        recurse_text_nodes.call(recurse_text_nodes, element_object, real_visibility)
+      end
+    end
+    # returns an visible text inside this element by concatenating text nodes below this element in the DOM heirarchy which are visible.
+    def visible_text
+      # TODO: needs tests 
+      visible_text_nodes.join('')
+    end
+
     # returns a Vector with two elements, the x,y 
     # coordinates of this element (its top left point)
     # from the top left edge of the window
@@ -1065,8 +1141,14 @@ module Vapir
         object.to_array
       elsif Object.const_defined?('WIN32OLE') && object.is_a?(WIN32OLE)
         array=[]
-        (0...object.length).each do |i|
-          array << object.item(i)
+        length = object.length
+        (0...length).each do |i|
+          begin
+            array << object.item(i)
+          rescue WIN32OLERuntimeError
+            # not rescuing, just adding information
+            raise $!.class, "accessing item #{i} of #{length}, encountered:\n"+$!.message, $!.backtrace
+          end
         end
         array
       else

data/lib/vapir-common/element_collection.rb

@@ -32,13 +32,21 @@ module Vapir
     def each_with_element_index
       index=1
       candidates.each do |candidate|
-        yield @collection_class.new(:index, nil, @extra.merge(:index => index, :element_object => candidate)), index
+        yield @collection_class.new(:index, nil, @extra.merge(:index => index, :element_object => candidate, :locate => false)), index
         index+=1
       end
       self
     end
     alias each_with_index each_with_element_index
     
+    # yields each element, specified by index (as opposed to by :element_object as #each yields)
+    # same as #each_with_index, except it doesn't yield the index number. 
+    def each_by_index # :yields: element
+      each_with_element_index do |element, i|
+        yield element
+      end
+    end
+    # returns the element at the given index in the collection. indices start at 1. 
     def [](index)
       at(index)
     end

data/lib/vapir-common/elements/elements.rb

@@ -386,22 +386,24 @@ module Vapir
       assert_enabled
       any_matched=false
       with_highlight(method_options) do
-        # using #each_with_index (rather than #each) because sometimes the OLE object goes away when a 
-        # new option is selected (seems to be related to javascript events) and it has to be relocated. 
-        # see documentation on ElementCollection#each_with_index vs. #each. 
-        self.options.each_with_index do |option,i|
-          # javascript events on previous option selections can cause the select list or its options to change, so this may not actually exist. but only check if we've actually done anything. 
-          break if any_matched && !option.exists? 
-          if yield option
-            any_matched=true
-            option.set_selected(true, method_options) # note that this fires the onchange event on this SelectList 
-            if !self.exists? || !multiple? # javascript events firing can cause us to stop existing at this point. we should not continue if we don't exist. 
-              break
+        handling_existence_failure do
+          # using #each_by_index (rather than #each) because sometimes the OLE object goes away when a 
+          # new option is selected (seems to be related to javascript events) and it has to be relocated. 
+          # see documentation on ElementCollection#each_by_index vs. #each. 
+          self.options.each_by_index do |option|
+            # javascript events on previous option selections can cause the select list or its options to change, so this may not actually exist. but only check if we've actually done anything. 
+            break if any_matched && !option.exists? 
+            if yield option
+              any_matched=true
+              option.set_selected(true, method_options) # note that this fires the onchange event on this SelectList 
+              if !self.exists? || !multiple? # javascript events firing can cause us to stop existing at this point. we should not continue if we don't exist. 
+                break
+              end
             end
           end
         end
         if !any_matched
-          raise Vapir::Exception::NoValueFoundException, "Could not find any options matching those specified on #{self.inspect}"
+          raise Vapir::Exception::NoValueFoundException, "Could not find any options matching those specified on #{self.inspect}.\nAvailable options are: \n#{options.map{|option| option.inspect}.join("\n")}"
         end
         self
       end
@@ -416,8 +418,8 @@ module Vapir
 
     # Unchecks the radio button or check box element.
     # Raises ObjectDisabledException exception if element is disabled.
-    def clear
-      set(false)
+    def clear(options={})
+      set(false, options)
     end
     
   end
@@ -438,17 +440,18 @@ module Vapir
     #
     # Fires the onchange event if value changes. 
     # Fires the onclick event the state is true. 
-    def set(state=true)
-      with_highlight do
+    def set(state=true, options={})
+      options=handle_options(options, :highlight => true, :wait => true)
+      with_highlight(options) do
         assert_enabled
         if checked!=state
           element_object.checked=state
-          fire_event :onchange if exists? # don't fire event if we stopped existing due to change in state 
+          fire_event(:onchange, options) if exists? # don't fire event if we stopped existing due to change in state 
         end
         if state && exists?
-          fire_event :onclick # fire this even if the state doesn't change; javascript can respond to clicking an already-checked radio. 
+          fire_event(:onclick, options) # fire this even if the state doesn't change; javascript can respond to clicking an already-checked radio. 
         end
-        wait
+        wait if options[:wait]
       end
       return self
     end
@@ -466,8 +469,13 @@ module Vapir
     inspect_these :checked
     # Checks this check box, or clears (defaults to setting if no argument is given)
     # Raises ObjectDisabledException exception if element is disabled.
-    def set(state=true)
-      with_highlight do
+    #
+    # takes options:
+    # * :highlight => true/false (defaults to true)
+    # * :wait => true/false (defaults to false)
+    def set(state=true, options={})
+      options=handle_options(options, :highlight => true, :wait => true)
+      with_highlight(options) do
         assert_enabled
         if checked!=state
           if browser_class.name != 'Vapir::Firefox'  # compare by name to not trigger autoload or raise NameError if not loaded 
@@ -475,10 +483,10 @@ module Vapir
             # todo/fix: this is browser-specific stuff, shouldn't it be in the browser-specific class? 
             element_object.checked=state
           end
-          fire_event :onclick if exists?  # sometimes previous actions can cause self to stop existing 
-          fire_event :onchange if exists? 
+          fire_event(:onclick, options) if exists?  # sometimes previous actions can cause self to stop existing 
+          fire_event(:onchange, options) if exists? 
         end
-        wait
+        wait if options[:wait]
       end
       return self
     end
@@ -648,7 +656,7 @@ module Vapir
     
     def column_count
       cells.inject(0) do |count, cell|
-        count+ cell.colSpan || 1
+        count+ (cell.colSpan || 1)
       end
     end
     def cell_count

data/lib/vapir-common/exceptions.rb

@@ -2,16 +2,15 @@ module Vapir
   module Exception
 
     # Root class for all Vapir Exceptions
-    class VapirException < RuntimeError
-      def initialize(message="")
-        super(message)
-      end
-    end
+    class VapirException < StandardError; end
     
-    class NoBrowserException < VapirException; end
+    # Base class for variouss sorts of errors when a thing does not exist 
+    class ExistenceFailureException < VapirException; end
 
+    class NoBrowserException < ExistenceFailureException; end
+    
     # This exception is thrown if an attempt is made to access an object that doesn't exist
-    class UnknownObjectException < VapirException; end
+    class UnknownObjectException < ExistenceFailureException; end
 
     # This exception is raised if attempting to relocate an Element that was located in a way that does not support relocating 
     class UnableToRelocateException < UnknownObjectException; end
@@ -33,6 +32,7 @@ module Vapir
 
     class WindowException < VapirException; end
     # This exception is thrown if the window cannot be found
+    class WindowGoneException < ExistenceFailureException; end
     class NoMatchingWindowFoundException < WindowException; end
     class WindowFailedToCloseException < WindowException; end
 

data/lib/vapir-common/modal_dialog.rb

@@ -11,7 +11,7 @@ module Vapir
     alias initialize default_initialize
     
     def locate!(options={})
-      exists? || raise(Vapir::Exception::NoMatchingWindowFoundException, "The modal dialog seems to have stopped existing.")
+      exists? || raise(Vapir::Exception::WindowGoneException, "The modal dialog seems to have stopped existing.")
     end
     alias assert_exists locate!
     

data/lib/vapir-common/page_container.rb

@@ -0,0 +1,21 @@
+module Vapir
+  module PageContainer
+    include Vapir::Container
+    def containing_object
+      document_object
+    end
+    def document_element
+      document_object.documentElement || raise(Exception::ExistenceFailureException, "document_object.documentElement was nil")
+    end
+    def title
+      document_object.title
+    end
+    # The url of the page object. 
+    def url
+      document_object.location.href
+    end
+    def page_container
+      self
+    end
+  end
+end

data/lib/vapir-common/specifier.rb

@@ -226,6 +226,11 @@ module Vapir
         # IF YOU CHANGE THIS CODE CHANGE THE CORRESPONDING JAVASCRIPT ABOVE TOO 
         matched_candidates=[]
         candidates.each do |candidate|
+          # this bit isn't reflected in the javascript above because firefox doesn't behave this way, returning nil 
+          if candidate==nil
+            raise Exception::ExistenceFailureException, "when searching for an element, a candidate was nil. (this tends to happen when a page is changing and things stop existing.)\nspecifiers are: #{specifiers_list.inspect}"
+          end
+          
           candidate_attributes=proc do |attr|
             attrs=[]
             if Object.const_defined?('WIN32OLE') && candidate.is_a?(WIN32OLE)
@@ -261,7 +266,7 @@ module Vapir
             end
           else
             if candidate.object_respond_to?(:nodeType)
-              match &&= candidate.candidate.nodeType==1
+              match &&= candidate.nodeType==1
             else
               match=false
             end

data/lib/vapir-common.rb

@@ -1,6 +1,6 @@
 module Vapir
   module Common
-    VERSION = '1.7.0'
+    VERSION = '1.7.1.rc1'
   end
 end
 require 'vapir-common/browser'

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vapir-common
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
   - 1
   - 7
-  - 0
-  version: 1.7.0
+  - 1
+  - rc1
+  version: 1.7.1.rc1
 platform: ruby
 authors: 
 - Ethan
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-02 00:00:00 -04:00
+date: 2010-08-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +48,7 @@ files:
 - lib/vapir-common/browser.rb
 - lib/vapir-common/browsers.rb
 - lib/vapir-common/container.rb
+- lib/vapir-common/page_container.rb
 - lib/vapir-common/modal_dialog.rb
 - lib/vapir-common/specifier.rb
 - lib/vapir-common/element.rb
@@ -82,11 +84,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: