operawatir 0.4.1.pre2-jruby → 0.4.1.pre3-jruby

data/lib/operawatir/compat/selector.rb

@@ -0,0 +1,7 @@
+class OperaWatir::Selector
+  include Deprecated
+
+  BASE_TYPES << :selector
+  alias_method :selector, :css
+  deprecated :selector, "element(:css, 'foo')"
+end

data/lib/operawatir/compat/window.rb

@@ -1,6 +1,7 @@
 module OperaWatir
   module Compat
     module Window
+      include Deprecated
 
       # Checks whether the body has the given text in it.
       #
@@ -22,6 +23,13 @@ module OperaWatir
 
       alias_method :element_by_xpath, :elements_by_xpath
 
+      # Opera specific
+      def get_hash
+        visual_hash
+      end
+
+      deprecated :get_hash, 'browser.visual_hash'
+
     end
   end
 end

data/lib/operawatir/compat.rb

@@ -2,7 +2,7 @@ module OperaWatir
   
   module Compat; end
 
-  # Switches on compatibility layer (Watir 1 API).
+  # Switches on compatibility layer (Watir 2 API).
   def self.compatibility!
     require 'operawatir/compat/browser'
     require 'operawatir/compat/element_finders'
@@ -16,7 +16,8 @@ module OperaWatir
     # TODO Ruby Modules can't override methods defined in their included klass
     #   Requiring the files is OK, but there needs to be some way of detecting
     #   that we are in compatibility mode.
-    
+
+    require 'operawatir/compat/selector'
     require 'operawatir/compat/collection'
     require 'operawatir/compat/element'
   end

data/lib/operawatir/desktop_browser.rb

@@ -3,9 +3,9 @@ module OperaWatir
     include DesktopContainer
     include DesktopCommon
     
-    #@private
-    LoadActions = ["Open url in new page", "Open url in current page", "Open url in background page",
-      "Open url in new window"]
+    LoadActions = ["Open url in new page", "Open url in current page", "Open url in new background page",
+      "Open url in new window", "New private page", "Paste and go", "Paste and go background", 
+      "Hotclick search", "Duplicate page", "Reopen page", "Back", "Forward", "Help"]
     
     # @private
     def initialize
@@ -238,12 +238,24 @@ module OperaWatir
     #       puts quick_widget.to_s
     #   end
     #
-    # @param win_name [String] name or [int] id of the window to retrieve the list of widgets from,
+    # @param window [String] name or [int] id of the window to retrieve the list of widgets from,
     #
     # @return [Array] Array of widgets retrieved from the window
     #
-    def widgets(win_name)
-      driver.getQuickWidgetList(win_name).map do |java_widget|
+    def widgets(window)
+      
+      # If window specifies window name, and the active window has this name
+      # use its id to get the widgets,
+      if window.is_a? String
+        active_win_id = driver.getActiveQuickWindowID()
+        active_win_name = driver.getQuickWindowName(active_win_id)
+        
+        #If the active window is of same type, then grab that one, not first
+        if active_win_name == window #e.g. Both Document Window 
+          window = active_win_id
+        end
+      end
+      driver.getQuickWidgetList(window).map do |java_widget|
         case java_widget.getType
           when QuickWidget::WIDGET_ENUM_MAP[:button]
             QuickButton.new(self,java_widget)

data/lib/operawatir/desktop_helper.rb

@@ -8,6 +8,8 @@ require 'operawatir'
 require 'rspec'
 require 'rbconfig'
 
+require File.expand_path('../../../spec/operawatir/matchers', __FILE__)
+
 module OperaWatir::DesktopHelper
   extend self
   

data/lib/operawatir/quickwidgets/quick_addressfield.rb

@@ -14,7 +14,11 @@ module OperaWatir
     # @param  [String] URL to load
     # @return [String] text in the address field after the page is loaded
     #                  or a blank string
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
     def load_page_with_url(url)
+      # Must focus field before calling enter_text...
+      focus_with_click
       # Enters text in a field and then hits enter
       enter_text_and_hit_enter(url)
     end
@@ -22,6 +26,10 @@ module OperaWatir
     #
     # Gets the visible text in the address field
     #
+    # @return [String] visible text in address field
+    #
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
     def visible_text
       element.getVisibleText()
     end
@@ -29,6 +37,10 @@ module OperaWatir
     #
     # Gets the highlighted text in the address field
     #
+    # @return [String] higlighted text in address field, if any, else empty
+    #
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
     def highlighted_text
       element.getAdditionalText()     
     end

data/lib/operawatir/quickwidgets/quick_checkbox.rb

@@ -21,7 +21,7 @@ module OperaWatir
     ######################################################################
     # Clicks a radio button or checkbox and toggles it state
     #
-    # @return [int] the new state of the radio button or checkbox,
+    # @return [Boolean] the new state of the radio button or checkbox,
     #               false for not checked, or true for checked
     #
     # @raise [DesktopExceptions::WidgetNotVisibleException] if the checkbox

data/lib/operawatir/quickwidgets/quick_editfield.rb

@@ -45,9 +45,9 @@ module OperaWatir
     ######################################################################
     # Clears the contents of the edit field
     #
-    # @note The edit field must have focus for this method to work
-    #
     def clear
+      focus_with_click
+      
       key_press_direct("a", :ctrl)
       key_press_direct("backspace")
       
@@ -96,10 +96,13 @@ module OperaWatir
     def enter_text_and_hit_enter(text)
       loaded_url = ""
       
+      # OBS: only caller should set focus, if not this will happily type 
+      # away in the incorrect field, if for example called from subclass address_field
       # Set focus
-      focus_with_click
+      # focus_with_click
+      
       # Clear the field
-      clear()
+      clear
       # Type in the text
       typed_text = type_text(text) #Opens dropdown window
       # Check that some text was typed, note the text might be changed in the

data/lib/operawatir/quickwidgets/quick_searchfield.rb

@@ -17,6 +17,8 @@ module OperaWatir
     #                   or a blank string
     #
     def search_with_text(search_text)
+      # Must focus field before calling enter_text...
+      focus_with_click
       # Enters text in a field and then hits enter
       enter_text_and_hit_enter(search_text)
     end

data/lib/operawatir/quickwidgets/quick_widget.rb

@@ -303,7 +303,7 @@ private
     
     # Click widget
     def click(button = :left, times = 1, *opts)
-      raise Exceptions::WidgetDisabledException, "Element #{@selector} is disabled" unless enabled?
+      raise DesktopExceptions::WidgetDisabledException, "Element #{@selector} is disabled" unless enabled?
       
       #Some buttons etc. aren't visible until hovering them
       if (visible? == false and type != :dialogtab)

data/lib/operawatir/quickwidgets/quick_window.rb

@@ -32,6 +32,8 @@ module OperaWatir
     #
     # @return [Symbol] type of the window (e.g. :dropdown, :button)
     #
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
     def type
       return WINDOW_ENUM_MAP.invert[@elm.getType] unless @elm == nil
       return WINDOW_ENUM_MAP.invert[element.getType] 
@@ -149,8 +151,10 @@ private
       case @method
       when :name
         # Use active window when specifying by name "Document Window"
-        # and not the first if there are more than one 
-        if (@selector == "Document Window")
+        # and not the first if there are more than one
+        active_window_id = driver.getActiveQuickWindowID()
+        name = driver.getQuickWindowName(active_window_id);
+        if (@selector == "Document Window" && name == "Document Window")
           @element = driver.findWindowById(driver.getActiveQuickWindowID())
         else
           @element = driver.findWindowByName(@selector)

data/lib/operawatir/screenshot.rb

@@ -0,0 +1,46 @@
+class OperaWatir::Screenshot
+
+  attr_accessor :browser, :reply
+
+  def initialize(parent)
+    self.browser = parent.browser
+    self.reply   = driver.saveScreenshot(2, [].to_java(:string))
+  end
+
+  # Saves screenshot to specified location.
+  #
+  # @param [String]  Path to where you want the screenshot saved.
+  # @return [String] The full path to the file that was saved.
+  def save(filename)
+    File.open(filename, 'w') { |f| f.write png }
+    File.expand_path filename
+  end
+
+  # Is the screenshot blank?
+  #
+  # @return [Boolean] True/false depending on the screenshot is blank.
+  def blank?
+    reply.isBlank
+  end
+
+  # Returns the raw byte string of the screenshot in PNG format.
+  #
+  # @return [String] A png image in a raw byte string.
+  def png
+    String.from_java_bytes reply.getPng
+  end
+
+  # Lets you get a MD5 sum of the screen.
+  #
+  # @return [String] A hash. 
+  def md5
+    reply.getMd5
+  end
+
+private
+
+  def driver
+    browser.driver
+  end
+
+end

data/lib/operawatir/window.rb

@@ -105,26 +105,22 @@ class OperaWatir::Window
 
   # Opera-specific
 
-  # Saves a screenshot of the window to the filesystem of the server.
+  # Creates a Screenshot interface or saves screenshot to specified
+  # location if a file path is given.
   #
-  # @param [String]  file_name The absolute path to the location where 
-  #   you want the screenshot saved.
-  # @param [Hash]    hashes    A list of hashes to compare.  If the hashes
-  #   match the hashes of what you are trying to take a screenshot of,
-  #   this method will return a boolean value instead of an actual
-  #   screenshot.
-  # @param [Integer] time_out  Specifies how long we should wait before
-  #   timing out.
+  # @param [String] file_name The absolute path to the location where 
+  #                           you want the screenshot saved.
   #
-  # @return [Object]  A ScreenShotReply object.
-  # @return [Boolean] True/false depending on whether you have given a
-  #   hash as an argument.
-  def screenshot(file_name, hashes=[], time_out=2)
-    driver.saveScreenshot(file_name, time_out, hashes.to_java(:string))
+  # @return [Object]          A Screenshot object.
+  # @return [String]          Filename to the saved file.
+  def screenshot(filename=nil)
+    # TODO: This should call document.screenshot instead, but that
+    # requires a generic ScreenShotReply interface in OperaDriver.
+    filename.nil? ? OperaWatir::Screenshot.new(self) : OperaWatir::Screenshot.new(self).save(filename)
   end
 
-  def visual_hash(time_out=50)
-    document.visual_hash time_out
+  def visual_hash
+    document.visual_hash
   end
 
   # Raw finders
@@ -140,6 +136,13 @@ class OperaWatir::Window
   alias_method :find_by_class, :find_by_class_name
   alias_method :find_by_tag, :find_by_tag_name
 
+  # Finds the document of a page.
+  #
+  # @return [Element] The body/document of a page.
+  def document
+    find_by_tag('body')
+  end
+
   # Finds all elements in document.
   #
   # @return [Collection] A collection of elements.

data/lib/operawatir.rb

@@ -47,6 +47,7 @@ end
 require 'operawatir/version'
 require 'operawatir/platform'
 require 'operawatir/keys'
+require 'operawatir/screenshot'
 require 'operawatir/preferences'
 require 'operawatir/spatnav'
 

data/operawatir.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{operawatir}
-  s.version = "0.4.1.pre2"
+  s.version = "0.4.1.pre3"
   s.platform = %q{jruby}
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andreas Tolf Tolfsen", "Chris Lloyd", "Stuart Knightley", "Deniz Turkoglu"]
-  s.date = %q{2011-03-08}
+  s.date = %q{2011-03-14}
   s.description = %q{    OperaWatir is a part of the Watir (pronounced water) family of
     free software Ruby libraries for automating web browsers.
     OperaWatir provides a querying engine and Ruby bindings for a
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     ".gitmodules",
     ".yardopts",
     "AUTHORS",
+    "CHANGES",
     "Gemfile",
     "LICENSE",
     "README.md",
@@ -49,6 +50,7 @@ Gem::Specification.new do |s|
     "lib/operawatir/compat/collection.rb",
     "lib/operawatir/compat/element.rb",
     "lib/operawatir/compat/element_finders.rb",
+    "lib/operawatir/compat/selector.rb",
     "lib/operawatir/compat/window.rb",
     "lib/operawatir/desktop-waiter.rb",
     "lib/operawatir/desktop_browser.rb",
@@ -80,6 +82,7 @@ Gem::Specification.new do |s|
     "lib/operawatir/quickwidgets/quick_treeview.rb",
     "lib/operawatir/quickwidgets/quick_widget.rb",
     "lib/operawatir/quickwidgets/quick_window.rb",
+    "lib/operawatir/screenshot.rb",
     "lib/operawatir/selector.rb",
     "lib/operawatir/spatnav.rb",
     "lib/operawatir/version.rb",
@@ -101,8 +104,15 @@ Gem::Specification.new do |s|
     "spec/operawatir/core/browser_spec.rb",
     "spec/operawatir/core/element_spec.rb",
     "spec/operawatir/core/preferences_spec.rb",
+    "spec/operawatir/core/screenshot_spec.rb",
     "spec/operawatir/core/spatnav_spec.rb",
     "spec/operawatir/core/window_spec.rb",
+    "spec/operawatir/desktop/desktopbrowser_spec.rb",
+    "spec/operawatir/desktop/quickaddressfield_spec.rb",
+    "spec/operawatir/desktop/quickbutton_spec.rb",
+    "spec/operawatir/desktop/quickwidget_spec.rb",
+    "spec/operawatir/desktop/quickwindow_spec.rb",
+    "spec/operawatir/desktop/shared/shared.rb",
     "spec/operawatir/fixtures/boxes.html",
     "spec/operawatir/fixtures/grid.html",
     "spec/operawatir/fixtures/input_fields_value.html",
@@ -110,8 +120,10 @@ Gem::Specification.new do |s|
     "spec/operawatir/fixtures/paragraphs.html",
     "spec/operawatir/fixtures/two_input_fields.html",
     "spec/operawatir/guards.rb",
+    "spec/operawatir/matchers.rb",
     "spec/operawatir/server.rb",
     "spec/operawatir/watirspec.rake",
+    "spec/operawatir/watirspec_desktophelper.rb",
     "spec/operawatir/watirspec_helper.rb",
     "spec/watir2/area_spec.rb",
     "spec/watir2/areas_spec.rb",
@@ -249,10 +261,19 @@ Gem::Specification.new do |s|
     "spec/operawatir/core/browser_spec.rb",
     "spec/operawatir/core/element_spec.rb",
     "spec/operawatir/core/preferences_spec.rb",
+    "spec/operawatir/core/screenshot_spec.rb",
     "spec/operawatir/core/spatnav_spec.rb",
     "spec/operawatir/core/window_spec.rb",
+    "spec/operawatir/desktop/desktopbrowser_spec.rb",
+    "spec/operawatir/desktop/quickaddressfield_spec.rb",
+    "spec/operawatir/desktop/quickbutton_spec.rb",
+    "spec/operawatir/desktop/quickwidget_spec.rb",
+    "spec/operawatir/desktop/quickwindow_spec.rb",
+    "spec/operawatir/desktop/shared/shared.rb",
     "spec/operawatir/guards.rb",
+    "spec/operawatir/matchers.rb",
     "spec/operawatir/server.rb",
+    "spec/operawatir/watirspec_desktophelper.rb",
     "spec/operawatir/watirspec_helper.rb",
     "spec/watir2/area_spec.rb",
     "spec/watir2/areas_spec.rb",

data/spec/operawatir/core/screenshot_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../../watirspec_helper', __FILE__)
+require 'tmpdir'
+
+RSpec::Matchers.define :save_file do
+  match { |filename| File.exists? filename }
+end
+
+RSpec::Matchers.define :be_boolean do
+  match { |variable| !!variable == variable }
+end
+
+describe 'Screenshot' do
+
+  before :all do
+    browser.url = fixture('boxes.html')
+    @screenshot = window.screenshot
+    @filename   = "#{Dir.tmpdir}/screenshot.png"
+  end
+
+  describe '#new' do
+    context 'given no argument' do
+      it 'creates a new Screenshot object' do
+        @screenshot.should be_kind_of OperaWatir::Screenshot
+      end
+    end
+
+    context 'given an argument' do
+      it 'saves a screenshot' do
+        window.screenshot(@filename).should save_file
+      end
+    end
+  end
+
+  describe '#save' do
+    it 'saves screenshot to disk' do
+      @screenshot.save(@filename).should save_file
+    end
+  end
+
+  describe '#blank?' do
+    it 'returns a valid type' do
+      @screenshot.blank?.should be_boolean
+    end
+
+    it 'is not blank' do
+      @screenshot.blank?.should be_false
+    end
+  end
+
+  describe '#png' do
+    before(:all) { @png = @screenshot.png }
+
+    it 'returns a valid type' do
+      @png.should be_kind_of String
+    end
+
+    it 'is a real type PNG image' do
+      @png.should match /PNG/
+    end
+  end
+
+  describe '#md5' do
+    before(:all) { @md5 = @screenshot.md5 }
+
+    it 'returns a valid type' do
+      @md5.should be_kind_of String
+    end
+
+    it 'returns a hash' do
+      @md5.should match /^(0x)[a-f0-9]{32}$/
+    end
+  end
+
+  after(:all) { File.delete @filename if File.exists? @filename }
+
+end