operawatir 0.4-jruby → 0.4.1-jruby

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+[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 [Watir 2](https://github.com/jarib/watirspec) and the [Watir 3](https://github.com/operasoftware/watir3-spec) specifications.
 
 * __License:__ [New BSD](https://github.com/operasoftware/operawatir/blob/master/LICENSE)
 * __Project Home:__ [http://www.opera.com/developer/tools/operawatir/](http://www.opera.com/developer/tools/operawatir/)
@@ -9,31 +9,11 @@
 * __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
-
-OperaWatir uses the following libraries:
-
-- [OperaDriver](http://www.opera.com/developer/tools/operadriver/) (Apache 2.0 License)
-- [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)
-- [bluecloth](http://deveiate.org/projects/BlueCloth) (BSD License)
-- [inifile](https://github.com/TwP/inifile) (MIT License)
-- [clipboard](https://github.com/janlelis/clipboard) (MIT License)
-- [activesupport](http://rubyonrails.org/) (MIT License)
-- [i18n](https://github.com/svenfuchs/i18n) (MIT License)
-- [deprecated](https://github.com/erikh/deprecated) (BSD License)
-- [bundler](http://gembundler.com/) (MIT License)
-
 ## Install
 
 ### Requirements
 
-OperaWatir runs on GNU/Linux, Mac OS X and Windows operating systems. Required dependencies are _Java_ >= 1.6.0, _JRuby_ =< 1.5.5, _RubyGems_ >= 1.3.5, _RSpec_ = 2.4, and a somewhat recent desktop or nightly build of Opera.  For Windows you must also have the Microsoft Visual C++ 2010 Redistributable Package (x86).
+OperaWatir runs on GNU/Linux, Mac OS X and Windows operating systems. Required dependencies are _Java_ >= 1.6.0, _JRuby_ <= 1.5.5, _RubyGems_ >= 1.3.5, _RSpec_ >= 2.4, and a somewhat recent build of Opera (desktop, internal, mobile).  For Windows you must also have the Microsoft Visual C++ 2008 Redistributable Package.
 
 ### Installation procedure
 
@@ -45,16 +25,6 @@ To install (leave out the “sudo” command if you're installing on Windows):
 
 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. 
@@ -67,8 +37,8 @@ Let's take a closer look at how this works.
     browser = OperaWatir::Browser.new
     
     browser.goto 'http://en.wikipedia.org/'
-    browser.text_field(:id => 'searchInput').set 'Opera'
-    browser.button(:id => 'searchButton').click
+    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. 
 
@@ -84,10 +54,9 @@ As Watir scripts are run in a full-featured browser, all keypresses and clicks w
     browser = OperaWatir::Browser.new
     
     browser.goto 'http://en.wikipedia.org/'
-    browser.text_field(:id => 'searchInput').click
+    browser.text_field(:id, 'searchInput').click
     browser.type 'Hello world'
-    browser.key 'Down'
-    browser.key 'Enter'
+    browser.keys.send :down, :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: 
 
@@ -96,12 +65,12 @@ The first suggested link will be selected by pressing arrow down (``'Down'``) an
   
     browser.goto 'http://www.phoboslab.org/biolab/'
     sleep 2
-    browser.key 'X'
+    browser.keys.send 'X'
     sleep 1
-    browser.key_down 'Right'
-    5.times { browser.key 'X' }
-    2.times { browser.key 'C' }
-    browser.key_up 'Right'
+    browser.keys.down :right
+    5.times { browser.keys.send 'X' }
+    2.times { browser.keys.send 'C' }
+    browser.keys.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.
 
@@ -111,9 +80,9 @@ Sending commands to the browser is great, but sometimes we want to get something
     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
+    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. 
 
@@ -125,15 +94,15 @@ When writing test suites you can use the OperaWatir::Helper class to help ease s
       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.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'
+        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
 
@@ -149,3 +118,51 @@ Each block of code corresponds to a single named test case returning PASS or FAI
     2 examples, 0 failures
 
 If anything fails, more information about each failure will be provided.
+
+You can also see ``operawatir -h`` for more usage information:
+
+    Usage: operawatir [-m|--manual] [-l|--launcher=BINARY] [--binary=BINARY]
+           [-a|--args=ARGUMENTS] [-q|--no-quit] [--opera-idle] [-b|--backtrace]
+           [--no-color] [-t|--tag=TAG] [-f|--format=FORMAT] [-o|--out=FILE]
+           [-h|--help] [-v|--version] FILES
+    
+    Specific options:
+        -m, --manual                     Wait for a manual connection from opera:debug
+        -l, --launcher=BINARY            Path to launcher binary, will use environmental 
+                                         variable OPERA_LAUNCHER if not specified
+            --binary=BINARY              Browser to run the test with, will use guess the 
+                                         path or use environmental variable OPERA_PATH if 
+                                         not specified
+        -a, --args=ARGUMENTS             Arguments passed to the binary, will override  
+                                         environmental variable OPERA_ARGS
+        -q, --no-quit                    Disable quitting of Opera at the end of a test run
+            --opera-idle                 Enable OperaIdle
+        -b, --backtrace                  Enable full backtrace
+            --no-color                   Disable colorized output
+        -t, --tag=TAG                    Specify tags to only run examples with the specified
+                                         tag, to exclude examples, add ~ before the tag (e.g.
+                                         `~slow')
+        -o, --out=FILE                   Send output to a file instead of STDOUT
+        -f, --format=FORMAT              Specify RSpec output formatter (documentation, 
+                                         html, progress (default), textmate)
+    
+    Common options:
+        -h, --help                       Show this message
+       -v, --version                    Show version
+
+## Third-Party Libraries
+
+OperaWatir uses the following libraries:
+
+- [OperaDriver](http://www.opera.com/developer/tools/operadriver/) (Apache 2.0 License)
+- [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)
+- [bluecloth](http://deveiate.org/projects/BlueCloth) (BSD License)
+- [clipboard](https://github.com/janlelis/clipboard) (MIT License)
+- [deprecated](https://github.com/erikh/deprecated) (BSD License)
+- [bundler](http://gembundler.com/) (MIT License)

data/Rakefile

@@ -17,24 +17,20 @@ Jeweler::Tasks.new do |gem|
   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.
+    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 Watir 2 and Watir 3
+    specifications.
 EOF
 
   gem.rubyforge_project = gem.name
 
   gem.platform              = 'jruby'
-  gem.required_ruby_version = '>= 1.8.7'
   gem.has_rdoc              = true
   gem.extra_rdoc_files      = ['README.md']
 
-  gem.add_dependency 'rspec', '= 2.4'
-  gem.add_dependency 'inifile', '>= 0.3'
-  gem.add_dependency 'i18n'
-  gem.add_dependency 'activesupport', '>= 3.0.1'
+  gem.add_dependency 'rspec', '>= 2.4'
   gem.add_dependency 'deprecated'
 
   gem.add_development_dependency 'jeweler'

data/VERSION

@@ -1 +1 @@
-0.4
+0.4.1

data/bin/desktopwatir

@@ -4,15 +4,19 @@ require 'optparse'
 require 'rspec'
 require 'rbconfig'
 require 'operawatir'
-require 'operawatir/desktop_helper'
+
 
 @options = {
-  :ng            => false,
-  :color_enabled => Config::CONFIG['host_os'] =~ /mswin|mingw|bccwin|wince|emx/ ? false : true,
-  :check_syntax  => false,
-  :format	     => 'progress', 
-  :no_quit		 => false,
-  :no_restart   => false
+  #:manual        => false,
+  :ng             => false,
+  :color_enabled  => true,
+  :check_syntax   => false,
+  :output_stream  => IO.new(1, 'w'),
+  :format         => 'progress',
+  :no_quit        => false,
+  :no_restart     => false,
+  :opera_idle     => false,
+  #:full_backtrace => false  # TODO: Provide fix for RSpec
 }
 
 # TODO
@@ -21,13 +25,21 @@ require 'operawatir/desktop_helper'
 begin
   OptionParser.new do |opts|
     opts.banner = <<EOS
-Usage: desktopwatir [-l|--launcher=BINARY] [-e|--executable=BINARY] [-a|--args=ARGUMENTS]
-       [--no-color] [-q|--no-quit] [-r|--no-restart] [-f|--format=FORMAT] [-o|--out=FILE] [-h|--help] [-v|--version] FILES
+
+Usage: desktopwatir [-l|--launcher=BINARY] [-e|--executable=BINARY]
+       [-a|--args=ARGUMENTS] [--no-color] [-q|--no-quit] [-r|--no-restart]
+       [--opera-idle] [-b|--backtrace] [-t|--tag=TAG] [-f|--format=FORMAT]
+       [-o|--out=FILE] [-h|--help] [-v|--version] FILES
 EOS
 
-    opts.separator ""
-    opts.separator "Specific options:"
+    opts.separator ''
+    opts.separator 'Specific options:'
 
+    #run without launcher and with manual connection, restart not possible (same as -rq)
+    #opts.on('-m', '--manual', 'Wait for a manual connection from opera:debug') do |c|
+    #  @options[:manual] = c
+    #end
+    
     opts.on('-l', '--launcher=BINARY', 'Path to launcher binary, will use environmental ',
             'variable OPERA_LAUNCHER if not specified') do |c|
       @options[:launcher] = c
@@ -46,35 +58,41 @@ EOS
     opts.on('--no-color', 'Disable colorized output') do |c|
       @options[:color_enabled] = false
     end
-
+    
     opts.on('-q', '--no-quit', 'Disable quitting of Opera at the end of a testrun') do |c|
       @options[:no_quit] = true
     end
 
-   opts.on('-r', '--no-restart', 'Disables automatic relaunching of Opera') do |c|
+    opts.on('-r', '--no-restart', 'Disables automatic relaunching of Opera') do |c|
       @options[:no_restart] = true
     end
 
-    #opts.on('-c', '--check-syntax', 'Check syntax only') do |c|
-    #  @options[:check_syntax] = true
-    #end
+    opts.on('--opera-idle', 'Enable OperaIdle') do |c|
+      @options[:opera_idle] = true
+    end
 
-    #opts.on('--ng', 'Connect to Nailgun server instead of starting out ',
-    #        'own JVM') do |ng|
-    #  @options[:ng] = ng
-    #end
+    opts.on('-b', '--backtrace', 'Enable full backtrace') do |c|
+      @options[:full_backtrace] = true
+    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 "desktopwatir: Unable to write to file `#{o}'"
+    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 "desktopwatir: Unable to write to file `#{o}'"
+ 
+    opts.on('-t', '--tag=TAG',
+            'Specify tags to only run examples with the specified tag
+            To exclude examples, add ~ before the tag (e.g. ~slow)
+            (TAG is always converted to a symbol)') do |tag|
+      @options[:filter_run] = tag
     end
-
+ 
     opts.separator ''
     opts.separator 'Common options:'
 
@@ -93,10 +111,15 @@ end
 if ARGV.empty?
   abort 'desktopwatir: You need to specify at least one test file to run'
 else
-  @options[:files_to_run] = ARGV
-  @options[:files_to_run].map! { | f | Dir.glob(f) }.flatten!
+  @options[:files_or_directories_to_run] = ARGV
+  @options[:files_or_directories_to_run].map! do | f |
+    if f.include? "\\"
+      f
+    else 
+      Dir.glob(f)
+  	end 
+  end.flatten!
 end
 
-#abort 'desktopwatir: --ng and --check-syntax are disabled for now' if @options[:ng] || @options[:check_syntax]
-
+require 'operawatir/desktop_helper'
 OperaWatir::DesktopHelper.run! @options

data/bin/operawatir

@@ -1,16 +1,21 @@
 #!/usr/bin/env jruby
 require 'rubygems'
 require 'optparse'
+require 'stringio'
 require 'rspec'
 require 'rbconfig'
 require 'operawatir'
-require 'operawatir/helper'
 
 @options = {
-  :ng            => false,
-  :color_enabled => OperaWatir::Platform.os == :windows ? false : true,
-  :check_syntax  => false,
-  :format        => 'progress'
+  :manual         => false,
+  :ng             => false,
+  :color_enabled  => true,
+  :check_syntax   => false,
+  :output_stream  => IO.new(1, 'w'),
+  :format         => 'progress',
+  :no_quit        => false,
+  :opera_idle     => false,
+  #:full_backtrace => false  # TODO: Provide fix for RSpec
 }
 
 # TODO
@@ -19,36 +24,56 @@ require 'operawatir/helper'
 begin
   OptionParser.new do |opts|
     opts.banner = <<EOS
-Usage: operawatir [-l|--launcher=BINARY] [-b|--binary=BINARY] [-a|--args=ARGUMENTS]
-       [--no-color] [-f|--format=FORMAT] [-o|--out=FILE] [-h|--help] [-v|--version] FILES
+Usage: operawatir [-m|--manual] [-l|--launcher=BINARY] [--binary=BINARY]
+       [-a|--args=ARGUMENTS] [-q|--no-quit] [--opera-idle] [-b|--backtrace]
+       [--no-color] [-t|--tag=TAG] [-f|--format=FORMAT] [-o|--out=FILE]
+       [-h|--help] [-v|--version] FILES
 EOS
 
-    opts.separator ""
-    opts.separator "Specific options:"
+    opts.separator ''
+    opts.separator 'Specific options:'
+
+    opts.on('-m', '--manual', 'Wait for a manual connection from opera:debug') do |c|
+      @options[:manual] = c
+    end
 
     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('-b', '--binary=BINARY', 'Browser to run the test with, will use environmental ',
-            'variable OPERA_PATH if not specified') do |e|
+    opts.on('--binary=BINARY', 'Browser to run the test with, will use guess the ',
+            'path or 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|
+    opts.on('-a', '--args=ARGUMENTS', 'Arguments passed to the binary, will override  ',
+            'environmental variable OPERA_ARGS') do |a|
       @options[:args] = a
     end
 
+    opts.on('-q', '--no-quit', 'Disable quitting of Opera at the end of a test run') do |c|
+      @options[:no_quit] = true
+    end
+
+    opts.on('--opera-idle', 'Enable OperaIdle') do |c|
+      @options[:opera_idle] = true
+    end
+
+    opts.on('-b', '--backtrace', 'Enable full backtrace') do |c|
+      @options[:full_backtrace] = true
+    end
+
     opts.on('--no-color', 'Disable colorized output') do |c|
       @options[:color_enabled] = false
     end
 
-    opts.on('-f', '--format=FORMAT',
-            'Specify RSpec output formatter (documentation, html, ',
-            'progress (default), textmate)') do |formatter|
-      @options[:formatter] = formatter
+    opts.on('-t', '--tag=TAG',
+            'Specify tags to only run examples with the specified',
+            'tag, to exclude examples, add ~ before the tag (e.g.',
+            "`~slow')") do |tag|
+      @options[:filter_run] = tag
     end
 
     opts.on('-o', '--out=FILE', 'Send output to a file instead of STDOUT') do |o|
@@ -56,6 +81,12 @@ EOS
         abort "operawatir: Unable to write to file `#{o}'"
     end
 
+    opts.on('-f', '--format=FORMAT',
+            'Specify RSpec output formatter (documentation, ',
+            'html, progress (default), textmate)') do |formatter|
+      @options[:formatter] = formatter
+    end
+
     opts.separator ''
     opts.separator 'Common options:'
 
@@ -74,7 +105,8 @@ end
 if ARGV.empty?
   abort 'operawatir: You need to specify at least one test file to run'
 else
-  @options[:files_to_run] = ARGV
+  @options[:files_or_directories_to_run] = ARGV
 end
 
+require 'operawatir/helper'
 OperaWatir::Helper.run! @options