bauxite 0.2.0 → 0.3.0

data/lib/bauxite/application.rb

@@ -24,8 +24,121 @@ require 'optparse'
 require_relative  'core/Context.rb'
 
 module Bauxite
+	# +bauxite+ command-line program.
+	# 
+	# This program executes Bauxite tests and outputs the execution progress
+	# and tests results to the terminal.
+	#
+	# == Synopsis
+	#
+	#    bauxite [OPTIONS] file1 file2 ...
+	#    # => Executes file1, then file2, and so on.
+	#    
+	#    bauxite [OPTIONS] -d
+	#    # => Start Bauxite directly in the debug console.
+	#    
+	#    bauxite [OPTIONS]
+	#    # => Start Bauxite and read test actions from the standard input.
+	#
+	# == Options
+	# For a detailed list of options for your Bauxite version execute:
+	#    bauxite -h
+    #
+	#
+	# [-v, \--verbose]
+	#     Show verbose error messages (i.e. print exception names and
+	#     backtraces).
+	#
+	# [-t, \--timeout SECONDS]
+	#     Number of seconds to wait before issuing a timeout error. This
+	#     timeout applies only to Selectors. 
+	#
+	# [-d, \--debug]
+	#     If an error occurs, break into the debug console. This mode is very
+	#     useful to try different selector combinations and debug
+	#     NoSuchElementError errors.
+	#
+	# [-p, \--provider DRIVER]
+	#     Selenium WebDriver provider. Defaults to +firefox+.
+	#
+	#     Other options include:
+	#     - +remote+
+	#     - +ie+
+	#     - +chrome+
+	#     - +android+
+	#     - +iphone+
+	#     - +opera+
+	#     - +phantomjs+
+	#     - +safari+
+	#
+	#     Driver availability dependes on the system running Bauxite.
+	# [-P, \--provider-option OPTION] 
+	#    A <tt>name=value</tt> pair of options that are directly forwarded to
+	#    the Selenium WebDriver provider. This option argument can appear
+	#    multiple times in the command line to specify multiple options.
+	#
+	# [-l, \--logger LOGGER]
+	#    Logger instance to use. Defaults to +xterm+ if the +TERM+ environment
+	#    variable is set to +xterm+, otherwise it defaults to +terminal+.
+	#
+	#    To see a complete list of the available loggers execute:
+	#        bauxite -h
+	#
+	# [-L, \--logger-option OPTION]
+	#    A <tt>name=value</tt> pair of options that are directly forwarded to
+	#    the logger. This option argument can appear multiple times in the
+	#    command line to specify multiple options.
+	#
+	# [-r, \--reset]
+	#    Issue a Action#reset action between every test specified in
+	#    the command line. This option enforces test isolation by resetting
+	#    the test context before each test (this removes cookies, sessions,
+	#    etc. from the previous test).
+	#
+	# [-w, \--wait]
+	#    Wait for user input when the test completes instead of closing the
+	#    browser window.
+	#
+	# [-u, \--url URL]
+	#    This option is an alias of:
+	#        -p remote -P url=URL
+	#    If +URL+ is not present <tt>http://localhost:4444/wd/hub</tt> will be
+	#    assumed.
+	#
+	# [-e, \--extension DIR]
+	#    Loads every Ruby file (*.rb) inside +DIR+ (and subdirectories). This
+	#    option can be used to load custom Bauxite extensions (e.g. Actions, 
+	#    Selectors, Loggers, etc.) for a specific test run.
+	#
+	#    For example:
+	#        # === custom/my_selector.rb ======= #
+	#        class Bauxite::Selector
+	#            def by_attr(value)
+	#                attr "by_attr:#{value}"
+	#            end
+	#        end
+	#        # === end custom/my_selector.rb === #
+	#
+	#        # === custom/my_test.bxt ========== #
+	#        # ...
+	#        assert "by_attr=attr_value" hello
+	#        # ...
+	#        # === end custom/my_test.bxt ====== #
+	#
+	#        bauxite -e custom custom/my_test.bxt
+	#
+	# [\--version]
+	#     Shows the Bauxite version.
+	#
+	# == Exit Status
+	# The +bauxite+ program exits with +zero+ if every action in the test
+	# succeeded and +non-zero+ otherwise.
+	# 
+	# If the test run includes multiple Action#test actions, the exit status
+	# equals the number of failed test cases (again, +zero+ indicates success).
+	#
 	class Application
-		def self.start
+		def self.start #:nodoc:
 			options = {
 				:logger     => (ENV['TERM'] == 'xterm') ?  'xterm' : 'terminal',
 				:verbose    => false,

data/lib/bauxite/core/Context.rb

@@ -71,7 +71,8 @@ module Bauxite
 			@options = options
 			@driver_name = (options[:driver] || :firefox).to_sym
 			@variables = {
-				'__TIMEOUT__' => (options[:timeout] || 10).to_i
+				'__TIMEOUT__' => (options[:timeout] || 10).to_i,
+				'__DEBUG__'   => false
 			}
 			@aliases = {}
 			@tests = []
@@ -315,13 +316,15 @@ module Bauxite
 				p e
 				puts e.backtrace
 			end
-			if break_into_debug and @options[:debug]
-				debug
-			elsif exit_on_error
-				if @variables['__RAISE_ERROR__']
-					raise
-				else
-					exit false
+			unless @variables['__DEBUG__']
+				if break_into_debug and @options[:debug]
+					debug
+				elsif exit_on_error
+					if @variables['__RAISE_ERROR__']
+						raise
+					else
+						exit false
+					end
 				end
 			end
 		end

data/lib/bauxite/loggers/xterm.rb

@@ -68,12 +68,27 @@ protected
 		true
 	end
 	
+	#--
+	# Adapted from:
+	#   https://github.com/jimweirich/rake/blob/master/lib/rake/application.rb
+	# See Rake::Application#terminal_width
+	#++
 	def _screen_width
-		begin
-			require 'terminfo'
-			TermInfo.screen_size[1]
-		rescue Exception
+		if RbConfig::CONFIG['host_os'] =~
+        /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+			(_dynamic_width_stty.nonzero? || _dynamic_width_tput)
+		else
 			super
 		end
+	rescue Exception => e
+		super
 	end
+	
+private
+    def _dynamic_width_stty
+      %x{stty size 2>/dev/null}.split[1].to_i
+    end
+    def _dynamic_width_tput
+      %x{tput cols 2>/dev/null}.to_i
+    end
 end

data/lib/bauxite.rb

@@ -22,7 +22,7 @@
 
 #--
 module Bauxite
-	VERSION = "0.2.0"
+	VERSION = "0.3.0"
 end
 #++
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bauxite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Patricio Zavolinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -52,6 +52,7 @@ files:
 - doc/Bauxite.html
 - doc/Bauxite/Action.html
 - doc/Bauxite/ActionModule.html
+- doc/Bauxite/Application.html
 - doc/Bauxite/Context.html
 - doc/Bauxite/Errors.html
 - doc/Bauxite/Errors/AssertionError.html