operawatir 0.3-jruby → 0.3.2-jruby

data/lib/operawatir/exceptions.rb

@@ -34,5 +34,8 @@ module OperaWatir::Exceptions
   
   # Raised when trying to access a table cell that doesn't exist.
   class UnknownCellException < OperaWatirException; end
+
+  # Raised when pressing a modifier key that doesn't exist.
+  class InvalidKeyException < OperaWatirException; end
   
 end

data/lib/operawatir/keys.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+class OperaWatir::Keys
+
+  attr_accessor :browser
+
+  def initialize(browser)
+    self.browser = browser
+  end
+
+  # Holds down supplied arbitrary list of keys indefinitely.
+  #
+  # @param [Symbol, String] *args Arbitrary list of symbols
+  #   (modification keys) or strings (regular keys) to be pressed
+  #   down.
+  #
+  # @example
+  #   browser.keys.down 'a'
+  #   browser.keys.down 'a', :right
+  #
+  # @seealso up
+  # @seealso send
+  def down(*args)
+    args.each { |key| driver.keyDown(key) }
+  end
+
+  # Depresses supplied arbitrary list of keys.
+  #
+  # @param [Symbol, String] *args Arbitrary list of symbols
+  #   (modification keys) or strings (regular keys) to be depressed.
+  #
+  # @example
+  #   browser.keys.up 'a', :right
+  #
+  # @seealso release
+  def up(*args)
+    args.each { |key| driver.keyUp(key) }
+  end
+
+  # Releases all pressed down keys.
+  #
+  # @example
+  #   browser.keys.down :control, :shift, 'a'
+  #   browser.keys.release
+  def release
+    driver.releaseKeys
+  end
+
+  # Presses an arbitrary list of keys or key combinations.  Provided
+  # arguments are performed in sequence.
+  #
+  # Symbols are parsed as modification keys (such as :control, :shift,
+  # :backspace, &c.), arraysd are interpreted as key combinations
+  # (e.g. [:control, 'a'] will perform the combination C-a), and
+  # strings will be typed as regular words.
+  #
+  # Note that this method is not OS indepdendent in the sense that
+  # even though OS X does not have Control keys, it will not replace
+  # your sent keys with Command.
+  #
+  # Available modification keys:  control, shift, access …
+  # TODO
+  #
+  # @param [Symbol, Array, String] *list Arbitrary list of symbols,
+  #   arrays or strings which will form a sequence of keys to be
+  #   pressed.
+  #
+  # @example
+  #   browser.keys.send 'a'
+  #   browser.keys.send 'foo', 'bar'
+  #   browser.keys.send :control
+  #   browser.keys.send [:control, 'a']
+  #   browser.keys.send [:control, 'a'], :backspace
+  def send(*list)  # TODO rename?
+    list.each do |item|
+      case item
+      when Array
+        item.each_with_index do |key, index|
+          case key
+          when :access
+            access_key item[index + 1]
+          when Symbol
+            down key
+          else
+            key key
+            release
+          end
+        end
+      when Symbol
+        key item
+      else
+        type item
+      end
+    end
+  end
+
+private
+
+  def driver
+    browser.driver    
+  end
+
+  def key(key)
+    driver.key key
+  end
+
+  def type(text)
+    driver.type text
+  end
+
+  def access_key(key)
+    driver.operaAction 'Enter access key mode'
+    send key
+    driver.operaAction 'Leave access key mode'
+  end
+
+end

data/lib/operawatir/platform.rb

@@ -0,0 +1,59 @@
+require 'rbconfig'
+
+class OperaWatir::Platform
+  def self.launcher
+    return ENV['OPERA_LAUNCHER'] if ENV['OPERA_LAUNCHER']
+
+    path = case os
+    when :windows
+      raise Exceptions::NotImplementedException, 'only 32-bit windows supported' if bitsize == 64
+      'utils/launchers/launcher-win32-i86pc.exe'
+    when :linux
+      postfix = bitsize == 64 ? 'x86_64' : 'i686'
+      "utils/launchers/launcher-linux-#{postfix}"
+    when :macosx
+      'utils/launchers/launcher-mac'
+    end
+
+    if path
+      File.join(root, path)
+    else
+      raise Exceptions::NotImplementedException, "no known launcher for #{os.inspect}, set OPERA_LAUNCHER to override"
+    end
+
+  end
+
+  def self.opera
+    ENV['OPERA_PATH']
+  end
+
+  def self.args
+    ENV['OPERA_ARGS'] || ''
+  end
+
+  def self.os
+    @os ||= (
+      host_os = RbConfig::CONFIG['host_os']
+      case host_os
+      when /mswin|msys|mingw|bccwin|wince|emc/
+        :windows
+      when /darwin|mac os/
+        :macosx
+      when /linux/
+        :linux
+      when /solaris|bsd/
+        :unix
+      else
+        raise Exceptions::NotImplementedException, "#{host_os.inspect} not supported"
+      end
+    )
+  end
+
+  def self.bitsize
+    ENV_JAVA['sun.arch.data.model'].to_i
+  end
+
+  def self.root
+    @root ||= File.expand_path('../../..', __FILE__)
+  end
+end

data/lib/operawatir/quickwidgets.rb

@@ -0,0 +1,3 @@
+%w(quick_widget quick_button quick_checkbox quick_editfield 
+    quick_dropdown quick_dialogtab quick_label quick_radiobutton quick_treeview quick_addressfield 
+    quick_searchfield quick_toolbar quick_window quick_tab quick_treeitem quick_thumbnail).each {|widget| require "operawatir/quickwidgets/#{widget}"}

data/lib/operawatir/quickwidgets/quick_addressfield.rb

@@ -0,0 +1,23 @@
+module OperaWatir
+  class QuickAddressField < QuickEditField
+
+    # Checks the type of the widget is correct
+    #
+    # @private
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:addressfield]
+    end
+
+    # Enters the url into the address field, and waits for page loading 
+    # to finish
+    #
+    # @param  [String] URL to load
+    # @return [String] text in the address field after the page is loaded
+    #                  or a blank string
+    def load_page_with_url(url)
+      # Enters text in a field and then hits enter
+      enter_text_and_hit_enter(url)
+    end
+    
+  end
+end

data/lib/operawatir/quickwidgets/quick_button.rb

@@ -0,0 +1,151 @@
+module OperaWatir
+  class QuickButton < QuickWidget
+ 
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:button]
+    end
+
+    ######################################################################
+    # Checks if the button is the default button
+    #
+    # @return [Boolean] true if the default button otherwise false
+    #
+    def default?
+      element.isDefault
+    end
+
+    ######################################################################
+    # Clicks the button, and waits for the window with window name 
+    # win_name to be shown
+    #
+    # @param [String] win_name name of the window that will be opened (Pass a blank string for any window)
+    #
+    # @return [int] Window ID of the window shown or 0 if no window is shown
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the button
+    #            is not visible
+    #
+    def open_window_with_click(win_name)
+      wait_start
+      click
+      wait_for_window_shown(win_name)
+    end
+    
+    alias_method :open_dialog_with_click, :open_window_with_click
+
+    ######################################################################
+    # Clicks the button, and waits for the dialog wizard to switch
+    # to the next page
+    #
+    # @return [int] Window ID of the dialog wizard or 0 if no window is shown
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the button
+    #            is not visible
+    #
+    def change_page_with_click()
+      wait_start
+      click
+      wait_for_window_shown("")
+    end
+    
+    ######################################################################
+    # Clicks the button, and waits for the window with window name 
+    # win_name to closed
+    #
+    # @param [String] win_name name of the window that will be closed (Pass a blank string for any window)
+    #
+    # @return [int] Window ID of the window is closed or 0 if no window is closed
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the button
+    #            is not visible
+    #
+    def close_window_with_click(win_name)
+      wait_start
+      click
+      wait_for_window_close(win_name)
+    end
+    
+    alias_method :close_dialog_with_click, :close_window_with_click
+    
+    ######################################################################
+    # Clicks the button, and waits for loading to finish
+    #
+    # @return [int] Window ID of the window shown or 0 if no window is shown
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the button
+    #            is not visible
+    #
+    def load_page_with_click
+      wait_start
+      click()
+      # Just wait for the load
+      wait_for_window_loaded("")
+    end
+        
+    
+    ######################################################################
+    # Clicks a button or expand control and toggles it state
+    #
+    # @return [int] the new state of the button or expand control,
+    #               0 for not pressed, or 1 for pressed
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the button
+    #            is not visible
+    #
+    def toggle_with_click
+      click
+          
+      # Cheat since we don't have an event yet 
+      sleep(0.1)
+        
+      element(true).getValue
+    end
+  
+    ######################################################################
+    # Clicks button to close the toolbar 
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the button
+    #            is not visible
+    #
+    def close_toolbar_with_click
+      click
+      
+      # Cheat since we don't have an event yet
+      sleep(0.1)
+    end
+          
+    alias_method :close_panel_with_click, :close_toolbar_with_click
+    
+    def expand_with_click
+      click
+      sleep(0.1)
+      #No refresh element because it might not be there still (after click):)
+    end
+    
+    alias_method :collapse_with_click, :expand_with_click
+    
+    ######################################################################
+    # Gets the value of the button or expand control.
+    #
+    # @return [int] 0 if not pressed, or 1 if pressed
+    #
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
+    def value
+      element.getValue
+    end
+    
+    ######################################################################
+    # Pauses to wait for security dialogs when buttons are not active
+    # right away on opening 
+    #
+    # @return [Boolean] Returns true if the button becomes active
+    #
+    def wait_for_enabled
+      wait_for_widget_enabled
+    end
+    
+  end
+end

data/lib/operawatir/quickwidgets/quick_checkbox.rb

@@ -0,0 +1,58 @@
+module OperaWatir
+  class QuickCheckbox < QuickWidget
+    
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:checkbox]
+    end
+
+    ######################################################################
+    # Checks if the checkbox is checked
+    #
+    # @return [Boolean] true if the checkbox is checked otherwise false
+    #
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
+    def checked?
+      element.isSelected
+    end
+    
+    ######################################################################
+    # Clicks a radio button or checkbox and toggles it state
+    #
+    # @return [int] the new state of the radio button or checkbox,
+    #               false for not checked, or true for checked
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the checkbox
+    #            is not visible
+    #
+    def toggle_with_click
+      click
+      
+      # Cheat since we don't have an even yet 
+      sleep(0.1)
+
+      element(true).isSelected
+    end
+
+    
+    ######################################################################
+    # Clicks the checkbox, and waits for the window with window name 
+    # win_name to be shown
+    #
+    # @param [String] win_name name of the window that will be opened (Pass a blank string for any window)
+    #
+    # @return [int] Window ID of the window shown or 0 if no window is shown
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the checkbox
+    #            is not visible
+    #
+    def open_dialog_with_click(win_name)
+      wait_start
+      click
+      wait_for_window_shown(win_name)
+    end
+    
+  end
+end

data/lib/operawatir/quickwidgets/quick_dialogtab.rb

@@ -0,0 +1,23 @@
+module OperaWatir
+  class QuickDialogTab < QuickWidget
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:dialogtab]
+    end
+    
+    ######################################################################
+    # Switch to the dialog tab by clicking on it 
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the dialogtab 
+    #            is not visible
+    #
+    def activate_tab_with_click
+      click
+      
+      # No event yet so just cheat and sleep
+      sleep(0.1);
+    end
+  end  
+end