vapir-ie 1.7.2 → 1.8.0

data/lib/vapir-ie/clear_tracks.rb

@@ -0,0 +1,56 @@
+require 'vapir-ie/browser.rb'
+
+module Vapir
+  class IE
+    module ClearTracks
+      History =         1 << 0
+      Cookies =         1 << 1
+      # ?? =             1 << 2
+      TemporaryFiles =  1 << 3
+      FormData =        1 << 4
+      StoredPasswords = 1 << 5
+      # ?? =             1 << 6
+      # ?? =             1 << 7
+      All = (1 << 8)-1 # this is called 'All' by such references as exist, despite higher bits being meaningful too. 
+      FilesAndSettingsStoredByAddOns = 1 << 12 # don't know what happened to any of bits 6 through 11. also this only seems to be documented anywhere as 4351 = 1000011111111 (= All | FilesAndSettingsStoredByAddOns)
+      # apparently 1 << 13 is also meaningful, but I have no idea what it is. I have seen ClearMyTracksByProcess called with the argument 8651 = 10000111001011 (so bits 0, 1, 3, 6, 7, 8, 13)
+      
+      # Clears tracks according to the given argument, which should be one of the constants of 
+      # this module, or any number of those constants bitwise-OR'd together. 
+      #
+      #  ClearTracks.clear_tracks(ClearTracks::FormData)
+      #  ClearTracks.clear_tracks(ClearTracks::History | ClearTracks::StoredPasswords)
+      def self.clear_tracks(what)
+        unless const_defined?('InetCpl')
+          require 'ffi'
+          define_const('InetCpl', Module.new)
+          InetCpl.extend(FFI::Library)
+          InetCpl.ffi_lib 'InetCpl.cpl'
+          InetCpl.ffi_convention :stdcall
+          InetCpl.attach_function :ClearMyTracksByProcess, :ClearMyTracksByProcessW, [:int], :void
+        end
+        InetCpl.ClearMyTracksByProcess(what)
+      end
+    end
+    module ClearTracksMethods
+      # Clear the history of sites that have been visited from the browser 
+      def clear_history
+        ClearTracks.clear_tracks(ClearTracks::History)
+      end
+      # Clear all cookies from the browser 
+      def clear_cookies
+        ClearTracks.clear_tracks(ClearTracks::Cookies)
+      end
+      # Clear temporary copies of web pages, images, and media that are saved 
+      def clear_temporary_files
+        ClearTracks.clear_tracks(ClearTracks::TemporaryFiles)
+      end
+      # Clear all history, cookies, temporary files, form data, and passwords from the browser 
+      def clear_all_tracks
+        ClearTracks.clear_tracks(ClearTracks::All)
+      end
+    end
+    include ClearTracksMethods
+    extend ClearTracksMethods
+  end
+end

data/lib/vapir-ie/close_all.rb

@@ -1,4 +1,4 @@
-require 'vapir-ie/ie-class'
+require 'vapir-ie/browser'
 
 module Vapir
   class IE

data/lib/vapir-ie/config.rb

@@ -0,0 +1,22 @@
+require 'vapir-common/config'
+require 'vapir-ie' # need the class to be set first
+
+module Vapir
+  # if vapir-ie is required before any other browser-specific library, then set the default browser to ie
+  @base_configuration.default_browser = :ie unless @base_configuration.locally_defined_key?(:default_browser)
+
+  # add ie-specific stuff to base, and then bring them in from env and yaml 
+  @base_configuration.create_update(:ie_launch_new_process, false, :validator => :boolean)
+  @base_configuration.create_update(:browser_visible, true, :validator => :boolean)
+  if defined?($HIDE_IE)
+    if config.warn_deprecated
+      Kernel.warn "WARNING: The $HIDE_IE global is gone. Please use the new config framework, and unset that global to silence this warning."
+    end
+    Vapir.config.browser_visible=false
+  end
+  @configurations.update_from_source
+  class IE
+    @configuration_parent = Vapir.config
+    extend Configurable
+  end
+end

data/lib/vapir-ie/container.rb

@@ -23,41 +23,19 @@ module Vapir
     
     public
     # see documentation for the common Vapir::Container#handling_existence_failure 
-    def handling_existence_failure(options={})
-      options=handle_options(options, :handle => :ignore)
+    def handling_existence_failure(options={}, &block)
       begin
-        yield
+        base_handling_existence_failure(options, &block)
       rescue WIN32OLERuntimeError, RuntimeError, NoMethodError, Vapir::Exception::ExistenceFailureException
-        raise if $!.class==RuntimeError && $!.message !~ /HRESULT/ # sometimes WIN32OLE raises a RuntimeError instead of a WIN32OLERuntimeError. only catch a RuntimeError if it's from WIN32OLE, indicated by HRESULT in the error message. 
+        if [WIN32OLERuntimeError, RuntimeError, NoMethodError].any?{|klass| $!.is_a?(klass) } && $!.message !~ Vapir::IE::ExistenceFailureCodesRE
+          raise
+        end
         handle_existence_failure($!, options)
       end
     end
-    public
-    # Note: @container is the container of this object, i.e. the container
-    # of this container.
-    # In other words, for ie.table().this_thing().text_field().set,
-    # container of this_thing is the table.
-    
-    # This is used to change the typing speed when entering text on a page.
-    attr_accessor :typingspeed
-    attr_accessor :type_keys
-    
-    def copy_test_config(container) # only used by form and frame
-      @typingspeed = container.typingspeed
-      @type_keys = container.type_keys
-    end
-    private :copy_test_config
-    
     # Write the specified string to the log.
     def log(what)
       @container.logger.debug(what) if @logger
     end
-    
-#    def set_container container
-#      @container = container 
-#      @page_container = container.page_container
-#    end
-        
-    private
   end # module
 end

data/lib/vapir-ie/element.rb

@@ -41,15 +41,33 @@ module Vapir
     # Return the outer html of the object - see http://msdn.microsoft.com/workshop/author/dhtml/reference/properties/outerhtml.asp?frame=true
     dom_attr :outerHTML => :outer_html
 
-    # return the text before the element
-    def before_text
-      element_object.getAdjacentText("afterEnd")
-    end
-    
-    # return the text after the element
-    def after_text
+    # text immediately before this element 
+    # 
+    # http://msdn.microsoft.com/en-us/library/ms536427(VS.85).aspx
+    def text_before_begin
       element_object.getAdjacentText("beforeBegin")
     end
+    # text after the start of the element but before all other content in the element
+    # 
+    # http://msdn.microsoft.com/en-us/library/ms536427(VS.85).aspx
+    def text_after_begin
+      element_object.getAdjacentText("afterBegin")
+    end
+    # text immediately before the end of the element but after all other content in the element
+    # 
+    # http://msdn.microsoft.com/en-us/library/ms536427(VS.85).aspx
+    def text_before_end
+      element_object.getAdjacentText("beforeEnd")
+    end
+    # text immediately before this element 
+    #
+    # http://msdn.microsoft.com/en-us/library/ms536427(VS.85).aspx
+    def text_after_end
+      element_object.getAdjacentText("afterEnd")
+    end
+    # strange, counterintuitive aliases from watir 
+    alias before_text text_after_end
+    alias after_text text_before_begin
     
     # Returns the text content of the element.
     dom_attr :innerText => :text
@@ -71,13 +89,6 @@ module Vapir
       source_index > other.source_index
     end
       
-    def typingspeed
-      @container.typingspeed
-    end
-    def type_keys
-      @type_keys || @container.type_keys
-    end
-    
     private
     # for use with events' button property
     MouseButtonCodes=
@@ -111,7 +122,7 @@ module Vapir
           :shiftLeft => false,
         }
 
-      if %w(onclick onmousedown onmouseup ondblclick onmouseover onmouseout).include?(event_type)
+      if %w(onclick onmousedown onmouseup ondblclick onmouseover onmouseout onmousemove).include?(event_type)
         client_center=self.client_center
 
         button_code=options[:button_code] || 
@@ -181,7 +192,6 @@ module Vapir
           actions.each do |action|
             # javascript stuff responding to previous events can cause self to stop existing, so check at every subsequent step
             handling_existence_failure(:handle => proc{ return result }) do
-              assert_exists :force => true
               result=action.call
             end
           end

data/lib/vapir-ie/ie-process.rb

@@ -1,5 +1,4 @@
-require 'win32/process'
-require 'vapir-ie/ie-class'
+require 'vapir-ie/browser'
 
 module Vapir
   class IE
@@ -18,10 +17,9 @@ module Vapir
       @@ie_version_parts ||= IE.version.split('.').map{|part| part.to_i }
     end
     class Process
-      # Vapir::IE::Process.start is called by Vapir::IE.new_process and does not start a new process correctly in IE8. 
-      # Calling IE8 with the -nomerge option correctly starts a new process, so call Process.create with this option if 
-      # IE's version is 8 
+      # start a new IE process and return a new Vapir::IE::Process object representing it. 
       def self.start
+        require 'win32/process'
         program_files = ENV['ProgramFiles'] || "c:\\Program Files"
         startup_command = "#{program_files}\\Internet Explorer\\iexplore.exe"
         startup_command << " -nomerge" if ::Vapir::IE.version_parts.first==8
@@ -31,30 +29,22 @@ module Vapir
         new process_id
       end
       
+      # takes a process id 
       def initialize process_id
         @process_id = process_id
       end
       attr_reader :process_id
       
-      def window
-        Waiter.wait_until do
-          IE.each do | ie |
-            window = ie.ie
-            hwnd = ie.hwnd
-            process_id = Process.process_id_from_hwnd hwnd
-            return window if process_id == @process_id
+      # returns the browser object corresponding to the process id 
+      def browser_object(options={})
+        options=handle_options(options, :timeout => 32)
+        Vapir.require_winwindow
+        ::Waiter.try_for(options[:timeout], :exception => RuntimeError.new("Could not find a browser for process #{self.inspect}")) do
+          Vapir::IE.browser_objects.detect do |browser_object|
+            @process_id == WinWindow.new(Vapir::IE.fix_win32ole_hwnd(browser_object.hwnd)).process_id
           end
         end
       end
-      
-      # Returns the process id for the specifed hWnd.
-      def self.process_id_from_hwnd hwnd
-        pid_info = ' ' * 32
-        Win32API.new('user32', 'GetWindowThreadProcessId', 'ip', 'i').
-        call(hwnd, pid_info)
-        process_id =  pid_info.unpack("L")[0]
-      end
-      
     end
   end
 end

data/lib/vapir-ie/input_elements.rb

@@ -87,15 +87,6 @@ module Vapir
       end
     end
     alias_deprecated :dragContentsTo, :drag_contents_to
-    
-    def requires_typing
-      @type_keys = true
-      self
-    end
-    def abhors_typing
-      @type_keys = false
-      self
-    end
   end
   
   # this class can be used to access hidden field objects
@@ -122,7 +113,7 @@ module Vapir
         # of this browser, this process will handle the former, and we'll spawn another to do the
         # latter.
         require 'win32/process'
-        require 'vapir-common/win_window'
+        Vapir.require_winwindow
         rubyw_exe= File.join(Config::CONFIG['bindir'], 'rubyw')
         error_file_name=File.expand_path(File.join(File.dirname(__FILE__), 'scripts', 'select_file_error_status.marshal_dump'))
         select_file_script=File.expand_path(File.join(File.dirname(__FILE__), 'scripts', 'select_file.rb'))

data/lib/vapir-ie/modal_dialog.rb

@@ -1,7 +1,5 @@
-require 'vapir-common/win_window'
 require 'vapir-common/modal_dialog'
 require 'vapir-ie/page_container'
-require 'Win32API'
 
 module Vapir
   class IE::ModalDialog
@@ -61,6 +59,7 @@ module Vapir
     @@iedialog_file = (File.expand_path(File.dirname(__FILE__) + '/..') + "/vapir-ie/IEDialog/Release/IEDialog.dll").gsub('/', '\\')
 
     def get_unknown(*args)
+      require 'Win32API'
       @@get_unknown ||= Win32API.new(@@iedialog_file, 'GetUnknown', ['l', 'p'], 'v')
       @@get_unknown.call(*args)
     end
@@ -104,120 +103,3 @@ module Vapir
     end
   end
 end
-=begin
-module Watir
-  class IE::ModalDialog
-    include IE::Container
-    include IE::PageContainer
-    include Win32
-
-    # Return the current window handle
-    attr_reader :hwnd
-
-    def find_modal_from_window
-      # Use handle of our parent window to see if we have any currently
-      # enabled popup.
-      hwnd = @container.hwnd
-      hwnd_modal = 0
-      begin
-        Watir::until_with_timeout do
-          hwnd_modal, arr = GetWindow.call(hwnd, GW_ENABLEDPOPUP) # GW_ENABLEDPOPUP = 6
-          hwnd_modal > 0
-        end
-      rescue TimeOutException
-        return nil
-      end
-      if hwnd_modal == hwnd || hwnd_modal == 0
-        hwnd_modal = nil
-      end
-      @hwnd = hwnd_modal
-    end
-    private :find_modal_from_window
-
-    def locate
-      how = @how
-      what = @what
-
-      case how
-      when nil
-        unless find_modal_from_window
-          raise NoMatchingWindowFoundException, 
-            "Modal Dialog not found. Timeout = #{Watir::IE.attach_timeout}"
-        end
-      when :title
-        case what.class.to_s
-        # TODO: re-write like WET's so we can select on regular expressions too.
-        when "String"
-          begin
-            Watir::until_with_timeout do
-              title = "#{what} -- Web Page Dialog"
-              @hwnd, arr = FindWindowEx.call(0, 0, nil, title)
-              @hwnd > 0
-            end
-          rescue TimeOutException
-            raise NoMatchingWindowFoundException, 
-              "Modal Dialog with title #{what} not found. Timeout = #{Watir::IE.attach_timeout}"
-          end
-        else
-          raise ArgumentError, "Title value must be String"
-        end
-      else
-        raise ArgumentError, "Only null and :title methods are supported"
-      end
-
-      intUnknown = 0
-      begin
-        Watir::until_with_timeout do
-          intPointer = " " * 4 # will contain the int value of the IUnknown*
-          GetUnknown.call(@hwnd, intPointer)
-          intArray = intPointer.unpack('L')
-          intUnknown = intArray.first
-          intUnknown > 0
-        end
-      rescue TimeOutException => e
-        raise NoMatchingWindowFoundException, 
-          "Unable to attach to Modal Window #{what.inspect} after #{e.duration} seconds."
-      end
-      
-      copy_test_config @parent_container
-      @document = WIN32OLE.connect_unknown(intUnknown)
-    end
-
-    def initialize(container, how, what=nil)
-      set_container container
-      @how = how
-      @what = what
-      @parent_container = container
-      # locate our modal dialog's Document object and save it
-      begin
-        locate
-      rescue NoMethodError => e
-        message = 
-          "IE#modal_dialog not supported with the current version of Ruby (#{RUBY_VERSION}).\n" + 
-          "See http://jira.openqa.org/browse/WTR-2 for details.\n" +
-            e.message
-        raise NoMethodError.new(message)
-      end
-    end
-
-    def document
-      @document
-    end
-    
-    # Return the title of the document
-    def title
-      document.title
-    end
-
-    def wait(options={})
-    end
-    
-    # Return true if the modal exists. Mostly this is useful for testing whether
-    # a modal has closed.
-    def exists?
-      Watir::Win32::window_exists? @hwnd
-    end
-    alias :exist? :exists?
-  end
-end
-=end

data/lib/vapir-ie/page_container.rb

@@ -101,11 +101,13 @@ module Vapir
       if respond_to?(:browser_object)
         ::Waiter.try_for(options[:timeout]-(Time.now-start_load_time), :interval => options[:interval], :exception => "The browser was still busy after #{options[:timeout]} seconds") do
           return unless exists?
-          !browser_object.busy
+          handling_existence_failure(:handle => proc { false }) { !browser_object.busy }
         end
         ::Waiter.try_for(options[:timeout]-(Time.now-start_load_time), :interval => options[:interval], :exception => "The browser's readyState was still not ready for interaction after #{options[:timeout]} seconds") do
           return unless exists?
-          [WebBrowserReadyState::Interactive, WebBrowserReadyState::Complete].include?(browser_object.readyState)
+          handling_existence_failure(:handle => proc { false }) do
+            [WebBrowserReadyState::Interactive, WebBrowserReadyState::Complete].include?(browser_object.readyState)
+          end
         end
       end
       # if the document object is gone, then we want to just return. 

data/lib/vapir-ie/process.rb

@@ -1,4 +1,4 @@
-require 'vapir-ie/ie-class'
+require 'vapir-ie/browser'
 
 module Vapir
   module Process