operawatir 0.3-jruby

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/new_watirspec"]
+	path = spec/new_watirspec
+	url = ssh://dvcs.oslo.osa/var/git/core-systems/watirspec.git

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--title "OperaWatir"
+--exclude bin/desktopwatir
+--exclude lib/operawatir/desktop*
+--exclude lib/operawatir/quickwidget*

data/AUTHORS

@@ -0,0 +1,7 @@
+Karianne Ekern <karianne.ekern@opera.com>
+Stuart Knightley <stuartk@opera.com>
+Chris Lloyd <christopherl@opera.com>
+Adam Minchinton <adamm@opera.com>
+Andreas Tolf Tolfsen <andreastt@opera.com>
+Deniz Turkoglu <dturkoglu@opera.com>
+

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+#gemspec
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end
+

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2010 Opera Software ASA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the
+   distribution.
+
+3. Neither the name of Opera Software ASA nor the names of its
+   contributors may be used to endorse or promote products derived
+   from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+“AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL OPERA SOFTWARE
+ASA BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,158 @@
+# Readme
+
+[OperaWatir](http://operawatir.org/) is a part of the [Watir](http://watir.com/) (pronounced _water_) family of free software Ruby libraries for automating web browsers.  OperaWatir provides a querying engine and Ruby bindings for a backend Java library, OperaDriver, for driving the [Opera web browser](http://opera.com/).  It aims for full compliance with the [watirspec](https://github.com/jarib/watirspec) specification.
+
+License:: [New BSD](https://github.com/operasoftware/operawatir/blob/master/LICENSE)
+Project Home:: [http://operawatir.org/](http://operawatir.org/)
+Source Code:: [https://github.com/operasoftware/operawatir](https://github.com/operasoftware/operawatir)
+Mailing List:: [https://list.opera.com/mailman/listinfo/operawatir-users](https://list.opera.com/mailman/listinfo/operawatir-users)
+Issues:: [https://github.com/operasoftware/operawatir/issues](https://github.com/operasoftware/operawatir/issues)
+Gem:: [https://rubygems.org/operawatir](http://rubygems.org/gems/operawatir)
+
+## Third-Party Libraries
+
+OperaDriver uses the following third-party Java libraries:
+
+- [Google protobuf](http://code.google.com/p/protobuf/) (New BSD License)
+- [Apache Commons JXPath](http://commons.apache.org/jxpath/) (Apache 2.0 License)
+
+More information about the New BSD (AKA Modified BSD or BSD-3) and Apache 2.0 licenses can be found in the appropriate text files in ``lib/operadriver``.
+
+OperaWatir uses the following libraries:
+
+- [rspec](https://github.com/rspec/rspec) (MIT License)
+- [jeweler](https://github.com/technicalpickles/jeweler) (MIT License)
+- [rake](https://github.com/jimweirich/rake) (MIT License)
+- [yard](https://github.com/lsegal/yard) (MIT License)
+- [mongrel](http://rubyforge.org/projects/mongrel) (Ruby License)
+- [sinatra](http://www.sinatrarb.com/) (MIT License)
+- [rr](http://rubyforge.org/projects/double-ruby) (MIT License)
+
+## Install
+
+### Requirements
+
+OperaWatir runs on GNU/Linux and Windows operating systems.  Other UNIX-like systems, such as BSD and OS X, are not currently supported, but support is planned.  Required dependencies are _Java_ >= 1.6.0, _JRuby_ >= 1.5.1 (ruby 1.8.7 patchlevel 249), _RubyGems_ >= 1.3.5, _RSpec_ >= 2.0.0, and a somewhat recent desktop or nightly build of Opera.
+
+### Installation procedure
+
+Make sure that you have the right requirements for installing and running OperaWatir.  Please note that OperaWatir will only run on the JRuby platform. For more detailed installation instructions, please see our [Getting Started](http://operasoftware.github.com/operawatir/tutorial.html) guide.
+
+To install (leave out the “sudo” command if you're installing on Windows):
+
+    % sudo jruby -S gem install operawatir
+
+Next, make sure that JRuby's ``bin`` directory is a part of your ``PATH`` environmental variable on GNU/Linux.
+
+## Limitations
+
+__Before you get started playing with OperaWatir, there are a few important things you need to keep in mind.__
+
+This is a __pre-release__ of OperaWatir (0.3), and should not be considered stable or suitable for use in production.  It should be treated as a proof of concept. 
+
+It is not possible to run OperaWatir without specifying the ``OPERA_PATH`` (full path to Opera binary) and ``OPERA_LAUNCHER`` (full path to Opera launcher binary) environmental variables. 
+
+Since the launcher applications are not shipped with the latest public release of Opera, we have bundled them with the gem.  They can be found in ``./utils/launchers/`` under the gem's directory (typically ``/usr/lib/jruby/lib/ruby/gems/1.8/gems/operawatir-0.3-java/utils/launchers/`` on GNU/Linux systems and ``C:\\JRuby-1.5.2\\lib\\ruby\\gems\\1.8\\gems\\operawatir-0.3-java\\utils\\launchers\\`` on Windows).  The launchers provided will work on 32-bit GNU/Linux and Windows operating systems.  OS X support is planned.
+
+## Examples
+
+The Watir API allows you to write scripts that interact with any web page.  Its primary purpose is to ease test automation for web applications.  Your scripts can, for example, before you deploy automatically go through all the steps your users normally would and alert you of any regressions. 
+
+Let's take a closer look at how this works. 
+
+    require 'rubygems'
+    require 'operawatir'
+    
+    browser = OperaWatir::Browser.new
+    
+    browser.goto 'http://en.wikipedia.org/'
+    browser.text_field(:id => 'searchInput').set 'Opera'
+    browser.button(:id => 'searchButton').click
+
+The script above will tell the browser to load the front page of Wikipedia, write “Opera” in the search field and click the search button.  If all goes as intended, the browser will end up at a relevant article. 
+
+To run the script, use the following command:
+
+    % jruby example.rb
+
+As Watir scripts are run in a full-featured browser, all keypresses and clicks will be interpreted as if they were real, and invoke attached JavaScript event listeners.  If we want to test the JavaScript-powered suggestion feature on the Wikipedia search box, we can do this: 
+
+    require 'rubygems'
+    require 'operawatir'
+    
+    browser = OperaWatir::Browser.new
+    
+    browser.goto 'http://en.wikipedia.org/'
+    browser.text_field(:id => 'searchInput').click
+    browser.type 'Hello world'
+    browser.key 'Down'
+    browser.key 'Enter'
+
+The first suggested link will be selected by pressing arrow down (``'Down'``) and navigated to (``'Enter'``).  Using the same key events, you could even teach a script to play platform games: 
+
+    require 'rubygems'
+    require 'operawatir'
+  
+    browser.goto 'http://www.phoboslab.org/biolab/'
+    sleep 2
+    browser.key 'X'
+    sleep 1
+    browser.key_down 'Right'
+    5.times { browser.key 'X' }
+    2.times { browser.key 'C' }
+    browser.key_up 'Right'
+
+Sending commands to the browser is great, but sometimes we want to get something back too.  The following lines of code will have the browser automatically look up the phone number of Opera Software in the [yellow pages](http://gulesider.no/) and write it to the console.
+
+    require 'rubygems'
+    require 'operawatir'
+    
+    browser = OperaWatir::Browser.new
+    
+    browser.goto 'http://gulesider.no/'
+    browser.text_field(:name => 'search_word').set 'Opera Software'
+    browser.button(:name => 'btn_cs').click
+    puts browser.li(:class => 'tel').text
+
+When running proper functional tests on your web application with Watir, you might want a bit more structured output.  To define assertions and get pretty test reports, you can use [RSpec](http://rspec.info/), a behaviour-driven testing framework. 
+
+When writing test suites you can use the OperaWatir::Helper class to help ease some tasks, such as constructing and tearing down the Browser object.  A simple test suite looks like this:
+
+    describe 'Yellow Pages' do
+      before :each do
+        browser.goto 'http://gulesider.no/'
+      end
+    
+      it 'finds the phone number to Opera Software' do
+        browser.text_field(:name => 'search_word').set 'Opera Software'
+        browser.button(:name => 'btn_cs').click
+        browser.li(:class => 'tel').text.should == '24 16 40 00'
+      end
+    
+      it 'finds the phone number to the Norwegian Opera and Ballet' do
+        browser.text_field(:name => 'search_word').set 'Den Norske Opera'
+        browser.button(:name => 'btn_cs').click
+        browser.li(:class => 'tel').text.should == '21 42 21 00'
+      end
+    end
+
+Since this is an RSpec test you can run it using the operawatir binary, which is simply a shortcut for running tests: 
+
+    % operawatir yellow_pages.rb
+
+Each block of code corresponds to a single named test case returning PASS or FAIL.  Whether you got back the expected and correct return value is evaluated with ``.should``.  If all tests pass, you will see the following output: 
+
+    ..
+  
+    Finished in 2.04 seconds
+    2 examples, 0 failures
+
+If anything fails, more information about each failure will be provided.
+
+## Merry Christmas!
+
+Despite its shortcomings, we hope you will enjoy playing around with the Watir libraries for using OperaDriver driving Opera. We decided that we would rather see it go out to the public before Christmas than waiting for another month or two until it is pristine and perfect. 
+
+One of the things we are most excited about is the new Watir 2 API that we have made a prototype implementation of, which is based on [Jari Bakken's ideas for a new API](https://github.com/jarib/watir-webdriver/wiki/Comparison-with-Watir-1.X). On top of this, we have written a Watir 1 compatibility layer which is switched on by default. We are looking forward to the design discussions that this will bring. Oh, and by the way, will you be able to find the magic switch for Watir 2? (-; 
+
+We hope you'll enjoy this little Christmas gift! Furthermore, we wish you a Merry Christmas and a Happy New Year from us here at Opera Software in Oslo!

data/Rakefile

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+require 'rake/clean'
+require 'jeweler'
+require 'rspec/core/rake_task'
+require 'yard/rake/yardoc_task'
+
+require './lib/operawatir/version'
+
+Jeweler::Tasks.new do |gem|
+  gem.name    = 'operawatir'
+  gem.version = OperaWatir.version
+  gem.date    = Date.today.to_s
+
+  gem.authors     = ['Deniz Turkoglu', 'Andreas Tolf Tolfsen', 'Chris Lloyd', 'Stuart Knightley']
+  gem.email       = ['dturkoglu@opera.com', 'andreastt@opera.com', 'christopherl@opera.com', 'stuartk@opera.com']
+  gem.homepage    = 'http://operasoftware.github.com/operawatir'
+  gem.summary     = 'Toolkit for automating interactions with the Opera web browser.'
+  gem.description = <<-EOF
+    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 backend Java library, OperaDriver, for driving the Opera web
+    browser.  It aims for full compliancy with the watirspec
+    specification.
+EOF
+
+  gem.rubyforge_project = gem.name
+
+  gem.platform         = 'jruby'
+  gem.has_rdoc         = true
+  gem.extra_rdoc_files = ['README.md']
+
+  gem.add_dependency 'rspec', '>= 2'
+
+  gem.add_development_dependency 'jeweler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'mongrel', '>= 1.1.5'
+  gem.add_development_dependency 'sinatra', '>= 1.1'
+  gem.add_development_dependency 'rr'
+
+  gem.files.exclude '.gitignore'
+  gem.files.exclude 'bin/desktopwatir'
+  gem.files.exclude 'lib/operawatir/desktop*.rb'
+  gem.files.exclude 'lib/operawatir/quickwidgets'
+end
+
+CLEAN.add 'pkg'
+
+RSpec::Core::RakeTask.new do |t|
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--no-private']
+end
+
+task :doc => :yard
+
+CLEAN.add 'doc'

data/VERSION

@@ -0,0 +1 @@
+0.3

data/bin/desktopwatir

@@ -0,0 +1,106 @@
+#!/usr/bin/env jruby
+
+require 'rubygems'
+
+require 'optparse'
+require 'ostruct'
+require 'rbconfig'
+require 'rspec'
+require 'operawatir'
+
+class Options
+
+  def self.parse(args)
+    options = OpenStruct.new
+
+    options.ng           = false
+    options.inspectr     = ENV['OPERA_INSPECTR'] || ''
+    options.color        = Config::CONFIG['host_os'] =~ /mswin|msys|mingw32/ ? false : true
+    options.check_syntax = false
+    options.format       = 'progress'
+    options.executable   = ENV['OPERA_PATH'] || ''
+    options.options      = ENV['OPERA_ARGS'] || ''
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: operawatir [--ng] [-i|--inspectr] [--color] [-c|--check-syntax]\n" +
+        "       [-f|--format=FORMAT[:OUT_FILE]] [-e|--executable=BINARY] [-o|--options=OPTIONS]\n" +
+        "       [-h|--help] [-v|--version] FILES"
+
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      opts.on('--ng', 'Connect to Nailgun server instead of starting our ',
+              'own JVM') do |ng|
+        options.ng = ng
+      end
+
+      opts.on('-i', '--inspectr', 'Attach inspectr to browser instance') do |i|
+        options.inspectr = i
+      end
+
+      opts.on('--color', 'Enable colorized output (default: enabled)') do |c|
+        options.color = c
+      end
+
+      opts.on('-c', '--check-syntax', 'Check syntax only') do |c|
+        options.check_syntax = c
+      end
+
+      opts.on('-f', '--format=FORMAT[:OUT_FILE]',
+              [:OperaHelperFormatter, :SpartanFormatter, :progress,
+              :documentation],
+              'Specify RSpec output format (OperaHelperFormatter,',
+              'SpartanFormatter, Specdoc) and optionally an output',
+              'file') do |t|
+        options.format = t
+      end
+
+      opts.on('-e', '--executable=EXECUTABLE', 'Browser to run the test with.  ',
+              'Will override environmental variable OPERA_PATH') do |e|
+        options.executable = e
+      end
+
+      opts.on('-o', '--options=OPTIONS', 'Options passed to the optional executable.  ',
+              'Will override environmental variable OPERA_ARGS') do |o|
+        options.options = o
+      end
+
+      opts.separator ''
+      opts.separator 'Common options:'
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        abort opts
+      end
+
+      opts.on_tail('-v', '--version', 'Show version') do
+        abort "OperaWatir version #{OperaWatir.version}"
+      end
+    end
+
+    opts.parse!(args)
+    options
+  end
+
+end
+
+options = Options.parse(ARGV)
+
+abort 'operawatir: You need to specify at least one test file to run' if ARGV.empty?
+abort 'operawatir: --ng and --check-syntax is disabled for now' if options.ng or options.check_syntax
+
+RSpec.configure do |c|
+  c.color_enabled = options.color
+  c.formatter     = options.format
+  c.files_to_run  = ARGV
+  c.formatter 	  = "documentation"
+end
+
+require 'operawatir/desktop-waiter'
+
+OperaWatir::Waiter.configure do |c|
+  c.path = options.executable
+  c.args = options.options
+  c.inspectr = options.inspectr
+end
+
+OperaWatir::Waiter.run!

data/bin/operawatir

@@ -0,0 +1,95 @@
+#!/usr/bin/env jruby
+require 'rubygems'
+require 'optparse'
+require 'rspec'
+require 'rbconfig'
+require 'operawatir'
+require 'operawatir/helper'
+
+@options = {
+  :ng            => false,
+  :color_enabled => Config::CONFIG['host_os'] =~ /mswin|mingw|bccwin|wince|emx/ ? false : true,
+  :check_syntax  => false,
+  :formatter     => 'progress'
+}
+
+# TODO
+#   Should steal https://github.com/rspec/rspec-core/blob/master/lib/rspec/core/option_parser.rb
+
+begin
+  OptionParser.new do |opts|
+    opts.banner = <<EOS
+Usage: operawatir [-l|--launcher=BINARY] [-e|--executable=BINARY] [-a|--args=ARGUMENTS]
+       [--no-color] [-f|--format=FORMAT] [-o|--out=FILE] [-h|--help] [-v|--version] FILES
+EOS
+
+    opts.separator ""
+    opts.separator "Specific options:"
+
+    opts.on('-l', '--launcher=BINARY', 'Path to launcher binary, will use environmental ',
+            'variable OPERA_LAUNCHER if not specified') do |c|
+      @options[:launcher] = c
+    end
+
+    opts.on('-e', '--executable=BINARY', 'Browser to run the test with, will use environmental ',
+            'variable OPERA_PATH if not specified') do |e|
+      @options[:path] = e
+    end
+
+    opts.on('-a', '--args=ARGUMENTS', 'Arguments passed to the executable.  ',
+            'Will override environmental variable OPERA_ARGS') do |a|
+      @options[:args] = a
+    end
+
+    opts.on('--no-color', 'Disable colorized output') do |c|
+      @options[:color_enabled] = false
+    end
+
+    #opts.on('-c', '--check-syntax', 'Check syntax only') do |c|
+    #  @options[:check_syntax] = true
+    #end
+
+    #opts.on('--ng', 'Connect to Nailgun server instead of starting out ',
+    #        'own JVM') do |ng|
+    #  @options[:ng] = ng
+    #end
+  
+    opts.on('-f', '--format=FORMAT',
+            'Specify RSpec output formatter (documentation, html, ',
+            'progress (default), textmate)') do |formatter|
+      @options[:formatter] = formatter
+    end
+
+    opts.on('-o', '--out=FILE', 'Send output to a file instead of STDOUT') do |o|
+      @options[:output_stream] = File.open(o, 'w') or
+        abort "operawatir: Unable to write to file `#{o}'"
+    end
+
+    opts.separator ''
+    opts.separator 'Common options:'
+
+    opts.on_tail('-h', '--help', 'Show this message') do
+      abort opts
+    end
+
+    opts.on_tail('-v', '--version', 'Show version') do
+      abort "OperaWatir version #{OperaWatir.version}"
+    end
+  end.parse!(ARGV)
+rescue OptionParser::InvalidOption => e
+  abort "operawatir: Unknown option `#{e.to_s.sub(/invalid option:\s+/, '')}'"
+end
+
+if ARGV.empty?
+  abort 'operawatir: You need to specify at least one test file to run'
+else
+  @options[:files_to_run] = ARGV
+end
+
+#abort 'operawatir: --ng and --check-syntax are disabled for now' if @options[:ng] || @options[:check_syntax]
+
+# TODO Be smarter about figuring out the Opera/Launcher path
+warn 'operawatir: Launch path is not specified.' if !ENV['OPERA_LAUNCHER'] && !@options[:launcher]
+warn 'operawatir: Browser path is not specified.' if !ENV['OPERA_PATH'] && !@options[:path]
+
+OperaWatir::Helper.run! @options