operawatir 0.3.2-jruby → 0.3.7.pre1-jruby

data/lib/operawatir/window.rb

@@ -1,7 +1,18 @@
 class OperaWatir::Window
+  include Deprecated
 
   attr_accessor :browser
 
+  # Creates a new window in the browser.  Note that Opera does not
+  # differentiate between windows and tabs.  To directly create a
+  # _Window_ object, pass in the _Browser_.
+  #
+  # @example
+  #   window = browser.url = 'http://example.org/'
+  #   => OperaWatir::Window
+  #
+  # @param  [Object] browser The _Browser_ object.
+  # @return [Object]         A new _Window_ object.
   def initialize(browser)
     self.browser = browser
   end
@@ -9,60 +20,92 @@ class OperaWatir::Window
 
   # Navigation
 
+  # Navigates back one step in the browser's history.
   def back
     driver.navigate.back
   end
 
+  # Navigates forward one step in the browser's history.
   def forward
     driver.navigate.forward
   end
 
+  # Stops the currently loading page.
   def stop
     driver.stop
   end
 
-  # FIXME No window management support
+  # Closes the currently open window.
   def close
-    driver.close
+    driver.close  # FIXME?
   end
 
+  # Refreshes the currently loaded page.
   def refresh
     driver.navigate.refresh
   end
 
+  # Gets the title of the document.
+  #
+  # @return [String] The title of the current document.
   def title
     driver.getTitle
   end
 
+  # Gets the URL of the document.
+  #
+  # @return [String] The URL of the current document.
   def url
     driver.getCurrentUrl
   end
 
+  # Navigates to a new URL.
+  #
+  # @param [String] url The new URL to navigate to.
   def url=(url)
     driver.get(url)
   end
   alias_method :goto, :url=  # deprecate?
 
+  # Retrieves the text without the DOM or source code from the
+  # currently loaded document.
+  #
+  # @return [String] The text of the document.
   def text
     driver.getText
   end
 
+  # Retrieves the HTML/source code of the currently loaded document.
+  #
+  # @return [String] The page source code.
   def html
     driver.getPageSource
   end
 
-  # TODO: Expose window querying from driver
+  # Checks if the window is still open.  True if the window is still
+  # present, false otherwise.
+  #
+  # @return [Boolean] Whether the window is open or not.
   def exists?
+    # TODO: Expose window querying from driver
     url != ''
   end
 
+  # TODO
+=begin
   def document
   end
+=end
 
-  def eval_js(js)
+  # Executes the given JavaScript on the current window.
+  #
+  # @param  [String] js The script to be executed.
+  # @return [String]    Optionally returns the JS result.
+  def execute_script(js)
     object = driver.executeScript(js, [].to_java(:string))
   end
-  alias_method :execute_script, :eval_js
+  alias_method :eval_js, :execute_script
+  deprecated :eval_js, "window.execute_script"
 
 
   # Keyboard
@@ -70,28 +113,46 @@ class OperaWatir::Window
   def key(key)
     driver.key(key)
   end
+  deprecated :key, "browser.keys.send"
 
   def key_down(key)
     driver.keyDown(key)
   end
+  deprecated :key, "browser.keys.down"
 
   def key_up(key)
     driver.keyUp(key)
   end
+  deprecated :key, "browser.keys.up or browser.keys.release"
 
   def type(text)
     driver.type(text)
   end
+  deprecated :key, "browser.keys.send"
 
 
   # Opera-specific
 
+  # Saves a screenshot of the window to the filesystem of the server.
+  #
+  # @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.
+  #
+  # @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))
   end
 
   def visual_hash(time_out=50)
-    document.visual_hash timeout
+    document.visual_hash time_out
   end
 
   # Raw finders
@@ -107,6 +168,9 @@ class OperaWatir::Window
   alias_method :find_by_class, :find_by_class_name
   alias_method :find_by_tag, :find_by_tag_name
 
+  # Finds all elements in document.
+  #
+  # @return [Collection] A collection of elements.
   def elements
     find_by_tag('*')
   end
@@ -123,7 +187,7 @@ private
 
   # Locate elements by id.
   #
-  # @return [Array] an array of found elements
+  # @return [Array] An array of found elements.
   def find_elements_by_id(value)
     driver.findElementsById(value).to_a.map do |node|
       OperaWatir::Element.new(node)
@@ -132,7 +196,7 @@ private
 
   # Locate elements by class.
   #
-  # @return [Array] an array of found elements
+  # @return [Array] An array of found elements.
   def find_elements_by_class_name(value)
     driver.findElementsByClassName(value).to_a.map do |node|
       OperaWatir::Element.new(node)
@@ -141,7 +205,7 @@ private
 
   # Locate elements by tag name.
   #
-  # @return [Array] an array of found elements
+  # @return [Array] An array of found elements.
   def find_elements_by_tag_name(value)
     driver.findElementsByTagName(value).to_a.map do |node|
       OperaWatir::Element.new(node)
@@ -150,7 +214,7 @@ private
 
   # Locate elements by CSS selector.
   #
-  # @return [Array] an array of found elements
+  # @return [Array] An array of found elements.
   def find_elements_by_css(value)
     driver.findElementsByCssSelector(value).to_a.map do |node|
       OperaWatir::Element.new(node)
@@ -159,7 +223,7 @@ private
 
   # Locate elements by XPath expression.
   #
-  # @return [Array] an array of found elements
+  # @return [Array] An array of found elements.
   def find_elements_by_xpath(value)
     driver.findElementsByXPath(value).to_a.map do |node|
       OperaWatir::Element.new(node)
@@ -168,7 +232,7 @@ private
 
   # Locate elements by attribute @name.
   #
-  # @return [Array] an array of found elements
+  # @return [Array] An array of found elements.
   def find_elements_by_name(value)
     driver.findElementsByName(value).to_a.map do |node|
       OperaWatir::Element.new(node)

data/lib/operawatir.rb

@@ -1,25 +1,31 @@
 $LOAD_PATH.unshift File.expand_path('..', __FILE__)
 require 'forwardable'
+require 'deprecated'
 require 'java'
 include Java
 
 %w(commons-jxpath-1.3.jar protobuf-java-2.3.0.jar selenium-common.jar
-   webdriver-opera.jar).each { |jar| require "operadriver/#{jar}" }
+   webdriver-opera.jar commons-io-2.0.1.jar).each { |jar| require "operadriver/#{jar}" }
 
 include_class org.openqa.selenium.WebDriver
 include_class org.openqa.selenium.RenderedWebElement
 include_class org.openqa.selenium.NoSuchElementException
-include_class com.opera.core.systems.OperaDesktopDriver
 include_class com.opera.core.systems.OperaDriver
 include_class com.opera.core.systems.OperaWebElement
 include_class com.opera.core.systems.settings.OperaDriverSettings
 
+# Desktop stuff
+include_class com.opera.core.systems.OperaDesktopDriver
+include_class com.opera.core.systems.scope.protos.DesktopWmProtos
+include_class com.opera.core.systems.scope.protos.SystemInputProtos
+include_class com.opera.core.systems.QuickWidget
+
 $KCODE = 'u'  # UTF-8 support
 
 # TODO This should be replaced when we decide upon a better way of
-# enabling the Watir 2 API.
+# enabling the Watir 3 API.
 module OperaWatir
-  @current_api = 1
+  @current_api = 2
 
   # Set the API version you wish to use.  Please note that setting
   # this after OperaWatir::Browser has been initialized will have no
@@ -41,6 +47,8 @@ end
 require 'operawatir/version'
 require 'operawatir/platform'
 require 'operawatir/keys'
+require 'operawatir/preferences'
+require 'operawatir/spatnav'
 
 require 'operawatir/exceptions'
 require 'operawatir/selector'
@@ -50,3 +58,11 @@ require 'operawatir/window'
 require 'operawatir/browser'
 
 require 'operawatir/compat'
+
+# Desktop stuff
+require 'operawatir/desktop_enums'
+require 'operawatir/desktop_common'
+require 'operawatir/desktop_container'
+require 'operawatir/desktop_browser'
+require 'operawatir/quickwidgets'
+require 'operawatir/desktop_exceptions'

data/operawatir.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{operawatir}
-  s.version = "0.3.2"
+  s.version = "0.3.5"
   s.platform = %q{jruby}
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Deniz Turkoglu", "Andreas Tolf Tolfsen", "Chris Lloyd", "Stuart Knightley"]
-  s.date = %q{2011-01-31}
+  s.date = %q{2011-02-08}
   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
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".gitmodules",
     ".yardopts",
     "AUTHORS",
     "Gemfile",
@@ -35,6 +36,7 @@ Gem::Specification.new do |s|
     "bin/operawatir",
     "lib/operadriver/APACHE_2.0_LICENSE.txt",
     "lib/operadriver/NEW_BSD_LICENSE.txt",
+    "lib/operadriver/commons-io-2.0.1.jar",
     "lib/operadriver/commons-jxpath-1.3.jar",
     "lib/operadriver/protobuf-java-2.3.0.jar",
     "lib/operadriver/selenium-common.jar",
@@ -45,7 +47,6 @@ Gem::Specification.new do |s|
     "lib/operawatir/compat.rb",
     "lib/operawatir/compat/browser.rb",
     "lib/operawatir/compat/collection.rb",
-    "lib/operawatir/compat/deprecation.rb",
     "lib/operawatir/compat/element.rb",
     "lib/operawatir/compat/element_finders.rb",
     "lib/operawatir/compat/window.rb",
@@ -55,11 +56,13 @@ Gem::Specification.new do |s|
     "lib/operawatir/desktop_container.rb",
     "lib/operawatir/desktop_enums.rb",
     "lib/operawatir/desktop_exceptions.rb",
+    "lib/operawatir/desktop_helper.rb",
     "lib/operawatir/element.rb",
     "lib/operawatir/exceptions.rb",
     "lib/operawatir/helper.rb",
     "lib/operawatir/keys.rb",
     "lib/operawatir/platform.rb",
+    "lib/operawatir/preferences.rb",
     "lib/operawatir/quickwidgets.rb",
     "lib/operawatir/quickwidgets/quick_addressfield.rb",
     "lib/operawatir/quickwidgets/quick_button.rb",
@@ -78,6 +81,7 @@ Gem::Specification.new do |s|
     "lib/operawatir/quickwidgets/quick_widget.rb",
     "lib/operawatir/quickwidgets/quick_window.rb",
     "lib/operawatir/selector.rb",
+    "lib/operawatir/spatnav.rb",
     "lib/operawatir/version.rb",
     "lib/operawatir/window.rb",
     "operawatir.gemspec",
@@ -216,10 +220,8 @@ Gem::Specification.new do |s|
     "spec/legacy_watirspec/watir_compatibility_spec.rb",
     "spec/legacy_watirspec/watirspec_helper.rb",
     "utils/Rakefile",
-    "utils/launchers/launcher-linux-i686",
-    "utils/launchers/launcher-linux-x86_64",
-    "utils/launchers/launcher-mac",
-    "utils/launchers/launcher-win32-i86pc.exe"
+    "utils/formatters/operahelper_formatter.rb",
+    "utils/formatters/spartan_formatter.rb"
   ]
   s.homepage = %q{http://operasoftware.github.com/operawatir}
   s.require_paths = ["lib"]
@@ -316,7 +318,10 @@ Gem::Specification.new do |s|
     "spec/new_watirspec/element_spec.rb",
     "spec/new_watirspec/guards.rb",
     "spec/new_watirspec/keys_spec.rb",
+    "spec/new_watirspec/preferences_spec.rb",
+    "spec/new_watirspec/screenshot_spec.rb",
     "spec/new_watirspec/server.rb",
+    "spec/new_watirspec/spatnav_spec.rb",
     "spec/new_watirspec/watirspec_helper.rb",
     "spec/new_watirspec/window_spec.rb"
   ]
@@ -327,56 +332,71 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0.6.3"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<bluecloth>, ["= 1.0.1"])
-      s.add_development_dependency(%q<rspec>, [">= 2.4"])
-      s.add_development_dependency(%q<sinatra>, [">= 1.0.0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<mongrel>, [">= 1.1.5"])
-      s.add_development_dependency(%q<rr>, [">= 1.0.2"])
-      s.add_runtime_dependency(%q<rspec>, [">= 2.4"])
+      s.add_development_dependency(%q<sinatra>, [">= 1.1"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<clipboard>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, ["= 2.4"])
+      s.add_runtime_dependency(%q<inifile>, [">= 0.3"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_runtime_dependency(%q<deprecated>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<bluecloth>, ["= 1.0.1"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<mongrel>, [">= 1.1.5"])
       s.add_development_dependency(%q<sinatra>, [">= 1.1"])
       s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<clipboard>, [">= 0"])
     else
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0.6.3"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<bluecloth>, ["= 1.0.1"])
-      s.add_dependency(%q<rspec>, [">= 2.4"])
-      s.add_dependency(%q<sinatra>, [">= 1.0.0"])
+      s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<mongrel>, [">= 1.1.5"])
-      s.add_dependency(%q<rr>, [">= 1.0.2"])
-      s.add_dependency(%q<rspec>, [">= 2.4"])
+      s.add_dependency(%q<sinatra>, [">= 1.1"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<clipboard>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["= 2.4"])
+      s.add_dependency(%q<inifile>, [">= 0.3"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_dependency(%q<deprecated>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<bluecloth>, ["= 1.0.1"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<mongrel>, [">= 1.1.5"])
       s.add_dependency(%q<sinatra>, [">= 1.1"])
       s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<clipboard>, [">= 0"])
     end
   else
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0.6.3"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<bluecloth>, ["= 1.0.1"])
-    s.add_dependency(%q<rspec>, [">= 2.4"])
-    s.add_dependency(%q<sinatra>, [">= 1.0.0"])
+    s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<mongrel>, [">= 1.1.5"])
-    s.add_dependency(%q<rr>, [">= 1.0.2"])
-    s.add_dependency(%q<rspec>, [">= 2.4"])
+    s.add_dependency(%q<sinatra>, [">= 1.1"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<clipboard>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["= 2.4"])
+    s.add_dependency(%q<inifile>, [">= 0.3"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+    s.add_dependency(%q<deprecated>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<bluecloth>, ["= 1.0.1"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<mongrel>, [">= 1.1.5"])
     s.add_dependency(%q<sinatra>, [">= 1.1"])
     s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<clipboard>, [">= 0"])
   end
 end
 

data/spec/new_watirspec/browser_spec.rb

@@ -48,9 +48,9 @@ describe 'Browser' do
     end
   end
 
-  describe '#quit!' do
+  describe '#quit' do
     before :each do
-      browser.quit!
+      browser.quit
     end
 
     it 'quits the browser' do
@@ -78,6 +78,7 @@ describe 'Browser' do
     end
   end
 
+=begin
   describe '#windows' do
     before :all do
       puts 'AFTER QUIT!'
@@ -106,6 +107,7 @@ describe 'Browser' do
     # TODO: Window selectors
 
   end
+=end
 
   describe '#version' do
     it 'fetches the version number of the driver' do
@@ -153,7 +155,7 @@ describe 'Browser' do
     end
 
     it 'is not attached to a browser instance' do
-      browser.quit!
+      browser.quit
       browser.connected?.should be_false
     end
   end
@@ -195,85 +197,4 @@ describe 'Browser' do
     end
   end
 
-  describe '#preferences' do
-    it 'is a list of all preferences' do
-      browser.preferences.length.should > 10
-    end
-
-    it 'contains options' do
-      browser.preferences('Developer Tools', 'Proxy Auto Connect').should_not be_empty
-    end
-
-    it 'gets a value of an option' do
-      browser.preferences('Cache', 'SVG Cache Size').should be_numeric
-      browser.preferences('Cache', 'SVG Cache Size').should_not be_zero
-    end
-
-    it 'returns a top block of preferences' do
-      browser.preferences.each do |section, option, value|
-        section.should_not be_empty
-        option.should_not be_empty
-      end
-    end
-
-    it 'returns a sub block of preferences' do
-      browser.preferences('Cache').each do |option, value|
-        option.should_not be_empty
-      end
-    end
-
-    # I'm not sure if this works, we'll have to extend all returned values
-    # (see 'gets a value of an option') with a .default and .reset! property
-    describe '#default' do
-      it 'fetches default value of an option' do
-        browser.preferences('Cache', 'SVG Cache Size').default.should > 2000
-      end
-    end
-
-    describe '#reset!' do
-      it 'resets an option to default' do
-        browser.preferences('Cache', 'SVG Cache Size').reset!
-        browser.preferences('Cache', 'SVG Cache Size').should == browser.preferences('Cache', 'SVG Cache Size').default
-      end
-    end
-
-  end
-
-  describe '#preferences=' do
-    before :all do
-      # Caches options that we will tamper with.
-      @preferences = browser.preferences
-    end
-
-    it 'sets an option' do
-      browser.preferences('Cache', 'Application Cache Quota').value = 0
-      browser.preferences('Cache', 'Application Cache Quota').should == 0
-    end
-
-    it 'sets options by a given block' do
-      preferences = {
-        'Cache' => {
-          'Always Check Never-Expiring GET queries' => false,
-          'Application Cache Quota' => -5000,
-          'SVG Cache Size' => 2000
-        }
-      }
-
-      browser.preferences = preferences
-
-      browser.preferences('Cache', 'Always Check Never-Expiring GET queries').should_not be_true
-      browser.preferences('Cache', 'Application Cache Quota').should == -5000
-      browser.preferences('Cache', 'SVG Cache Size').should == 2000
-
-      # Making sure setting block didn't affect any other blocks.
-      browser.preferences('Colors', 'Background').should == @preferences['Colors']['Background']
-      browser.preferences('Fonts', 'Dialog').should == @preferences['Fonts']['Dialog']
-    end
-
-    after :all do
-      # Resets options that we've tampered with.
-      browser.preferences = @preferences
-    end
-  end
-
 end