brake 0.2.3 → 0.2.4

data/README

@@ -1,6 +1,11 @@
 README
 A Brandwatch rake wrapper, Brake
 
+Simply this is a wrapper disigned to give the end user some control by being able to pass command line options
+but still having the conviniance of rake tasks
+Primarly used to aid in the brandwatch automation tasting hence brake for brandwatch rake
+The tool has now evolved and if used cleverly could be used by anyome
+
 Brake Version:0.2.0
 
 Brake, The Brandwatch Rake wrapper for cucumber, Give Rake a Brake.
@@ -23,7 +28,7 @@ Browser options:
     -H, --[no-]highlight             Bool: To turn off the highlight of elements
 
     -u, --[no-]untangle              Bool: Turns Debug on/off
-    -h, --help                       You'r looking at it
+    -h, --help                       You're looking at it
 For furthur assistance please contact Ben Slaughter or Jonathan Chrisp
 bens@brandwatch.com or jonathan@brandwatch.com
 
@@ -54,4 +59,8 @@ Jon - Updated API task to run release as default
 Ben - Removed '--require features' from the default args so now only -P disable profiles and -s disable source code line numbers
 Ben - Removed platform, this is no longer required
 
+2.2.4
+Ben - Some typos in comments and improved readme and code comments for yard docs
+Jon - Added headless, retries, highlight and cleanup options
+
 END

data/lib/brake.rb

@@ -10,8 +10,15 @@ rescue LoadError
 end
 
 # @author Ben Slaughter
+# class brake the heart and soul of brake
+# simply this is a wrapper disigned to give the end user some control by being able to pass command line options
+# but still having the conviniance of rake tasks
+# Primarly used to aid in the brandwatch automation tasting hence brake for brandwatch rake
+# The tool has now evolved and if used cleverly could be used by anyome
 class Brake
   # Starts the Brake Class
+  # Outputs the brake version at runtime
+  # If there is no information given to brake it will rin the 'default task'
   def genesis
     puts "Brake Version:" + Gem.loaded_specs["brake"].version.to_s
     @arguments = self.parse_command_line_options
@@ -31,7 +38,8 @@ class Brake
   end
 
   # Parses the options from the command line
-  # converts the information into a Hash that is returned
+  # Converts the parsed information into a Hash
+  # The Hash is then returned
   # @return [hash] arguemnts a hash containg the parsed and  data
   def parse_command_line_options
     options = []
@@ -46,21 +54,25 @@ class Brake
         opts.on("-e", "--enviroment release", String, "String: The enviroment to run the tests against eg Release" ) { |o| options.push([:env, o]) }
         opts.on("-t", "--tags @high,@login", Array, "Array:  A list of all tagged test to be run" ) { |o| options.push([:tags, o]) }
         opts.on("-l", "--log_level debug", String, "String: The log output level debug|info" ) { |o| options.push([:log_level, o]) }
-        opts.on("-d", "--dru-run", "Bool: turns on the selenium dry run feature" ) { |o| options.push([:dry_run, o]) }
+        opts.on("-d", "--dry-run", "Bool: turns on the selenium dry run feature" ) { |o| options.push([:dry_run, o]) }
+        opts.on("-c", "--controller chrome", String, "String: The type of controller to run (API, Chrome, Safari)" ) { |o| options.push([:controller, o]) }
+        opts.on("--[no-]headless", "Bool: To turn on/off headless mode (only works on Linux!)" ) { |o| options.push([:headless, o]) }
+        opts.on("--[no-]cleanup", "Bool: To turn on/off setup cleanup" ) { |o| options.push([:cleanup, o]) }
+        opts.on("--retries 3", String, "String: The number of retries to perform on element methods" ) { |o| options.push([:retries, o]) }
+        opts.on("--timeouts 10", String, "String: The length of the timeouts on element methods" ) { |o| options.push([:timeouts, o]) }     
         opts.separator ""
         opts.separator "BrandwatchWeb options:"
-        opts.on("-c", "--controller chrome", String, "String: The type of controller to run (API, Chrome, Safari)" ) { |o| options.push([:controller, o]) }
         opts.on("-s", "--screen 1280,1024", Array, "Array:  The width,hight of the browser window" ) { |o| options.push([:screen, o]) }
         opts.on("--pos", "--position 0,0", Array, "Array:  The x,y coords of the browser 0,0 top left" ) { |o| options.push([:position, o]) }
         opts.separator ""
+        opts.separator "Browser options:"
+        opts.on("-H", "--[no-]highlight", "Bool: To turn on/off the highlight of elements" ) { |o| options.push([:highlight, o]) }
+        opts.separator ""
         opts.separator "API options:"
         opts.on("-v", "--version 00", String, "String: API Version number" ) { |o| options.push([:version, o]) }
         opts.separator ""
-        opts.separator "Browser options:"
-        opts.on("-H", "--[no-]highlight", "Bool: To turn off the highlight of elements" ) { |o| options.push([:highlight, o]) }
-        opts.separator ""
         opts.on("-u", "--[no-]untangle", "Bool: Turns Debug on/off" ) { |o| @untangle = o }
-        opts.on_tail("-h", "--help", "Show this message") do
+        opts.on_tail("-h", "--help", "You're Looking at it") do
           puts opts
           puts "For furthur assistance please contact Ben Slaughter or Jonathan Chrisp"
           puts "bens@brandwatch.com or jonathan@brandwatch.com"
@@ -74,8 +86,8 @@ class Brake
     end
 
     # creates the default arguments
-    # --require features Ensures that all features are included
     # -P Disables profiles, we no longer need it as all data is given at command line
+    # -s removes the extra source code line no note displayed in the command line
     arguments = { :req => "-P -s" }
 
     # takes the parsed options and turns them into meaningful data
@@ -91,6 +103,14 @@ class Brake
           arguments[:log_level] = "LOGLEVEL=#{value[1].downcase}"
         when :dry_run
           arguments[:dry_run] = "--dry-run"
+        when :headless
+          arguments[:headless] = "HEADLESS=#{value[1].to_s}"
+        when :cleanup
+          arguments[:cleanup] = "CLEANUP=#{value[1].to_s}"
+        when :retries
+          arguments[:retries] = "RETRIES=#{value[1].downcase}"
+        when :timeouts
+          arguments[:timeouts] = "TIMEOUTS=#{value[1].downcase}"
         when :highlight
           arguments[:highlight] = "HIGHLIGHT=true"
         when :controller
@@ -109,6 +129,7 @@ class Brake
   # Runs the given rake task with the given arguments
   # @param [string] task This is the name of the rake task to be invoked
   # @param [hash] arguments a hash containing the arguments to be passed to the task
+  # @note There are 2 pre built tasks bw/brandwatchWeb and api/brandwatchapi
   def run_rake_task( task, arguments )
     puts "running task: " + task
     self.debug( arguments )
@@ -127,6 +148,10 @@ class Brake
         puts "WARNING: No Defaults set for custom task"
         Rake::Task[task].execute( arguments.values.join( ' ' ) )
       end # case
+      
+    # This cased me some problems while running tasks
+    # There is no raise as several tasks may be run
+    # and due to that nature of the wrapper I do not want the code to quit
     rescue RuntimeError => e
       puts "Brake Aborted!"
       puts e.message

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brake
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000 Z
+date: 2012-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake