brake 0.2.4 → 0.3.0

data/README

@@ -2,33 +2,40 @@ 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
+but still having the conviniance and structure of rake tasks
 
-Brake Version:0.2.0
+Brake Version:0.2.5
 
-Brake, The Brandwatch Rake wrapper for cucumber, Give Rake a Brake.
+Brake, A Cucumber options parser wrapper for Rake, because, cake was already taken!, Give Rake a Brake.
 Usage: brake <task> [options]
 
+Cucmber options:
+    -t, --tags @high,@login          Array:  A list of all tagged test to be run
+    -d, --dry-run                    Bool: turns on the selenium dry run feature
+    -v, --verbose                    Bool: Show the files and features loaded
+    -f, --format                     String: How to format the features (Default: pretty)
+
 Global options:
     -e, --enviroment release         String: The enviroment to run the tests against eg Release
-    -t, --tags @high,@login          Array:  A list of all tagged test to be run
     -l, --log_level debug            String: The log output level debug|info
-
-BrandwatchWeb options:
     -c, --controller chrome          String: The type of controller to run (API, Chrome, Safari)
+        --[no-]headless              Bool: To turn on/off headless mode (only works on Linux!)
+        --[no-]cleanup               Bool: To turn on/off setup cleanup
+        --retries 3                  String: The number of retries to perform on element methods
+        --timeouts 10                String: The length of the timeouts on element methods
+
+Web options:
     -s, --screen 1280,1024           Array:  The width,hight of the browser window
         --pos, --position 0,0        Array:  The x,y coords of the browser 0,0 top left
 
-API options:
-    -v, --version 00                 String: API Version number
-
 Browser options:
-    -H, --[no-]highlight             Bool: To turn off the highlight of elements
+    -H, --[no-]highlight             Bool: To turn on/off the highlight of elements
+Brake options:
+
+    -I, --iterate                    Int: Number of times to run the task
+    -U, --[no-]untangle              Bool: Turns Debug on/off
+    -h, --help                       You're Looking at it
 
-    -u, --[no-]untangle              Bool: Turns Debug on/off
-    -h, --help                       You're looking at it
 For furthur assistance please contact Ben Slaughter or Jonathan Chrisp
 bens@brandwatch.com or jonathan@brandwatch.com
 
@@ -55,12 +62,19 @@ Ben - Added -s as default (removes source)
 0.2.2
 Jon - Updated API task to run release as default
 
-2.2.3
+0.2.3
 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
+0.2.4
 Ben - Some typos in comments and improved readme and code comments for yard docs
 Jon - Added headless, retries, highlight and cleanup options
 
+0.3.0
+Ben - Improved code, Cleaned up options parser, now a single block of code
+Ben - There are no more pre included tasks, it is either default or user entered
+Ben - Error checking on screen and position
+Ben - Brake passes a hash of arguments to the rake task
+Ben - Cucumber options added and task iterations
+
 END

data/bin/brake

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'brake'
 
-Brake.new.genesis
+brake = Brake.new
+brake.genesis

data/lib/brake.rb

@@ -5,7 +5,8 @@ require 'optparse'
 begin
   load 'Brakefile'
 rescue LoadError
-  puts "Brakefile not present"
+  puts "Brakefile load error"
+  puts "please check your brake file"
   exit
 end
 
@@ -13,24 +14,44 @@ end
 # 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
+# The tool has now evolved and if used cleverly could be used by anyone
 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
-    self.debug( ARGV )
 
+    # creates the default arguments
+    # -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" }
+    # Untangle is false untill the options parser has run
+    @untangle = false
+    # Brake can run Its task several times
+    @taskIterations = 1
+
+    # Runs the options parser, Arguments and Untangle are now inst variables
+    self.parse_command_line_options
+
+    self.debug( ARGV )
+    # Default is assigned to the ARGV if there is no task given
     ARGV.push('default') if ARGV == []
-    ARGV.each do | task |
-      self.debug( task )
-      self.run_rake_task( task, @arguments )
+    # Brake only runs one task at a time
+    @taskIterations.times do
+      self.run_rake_task( ARGV[0] )
     end
+
+    # This code is commented out to keep things simple
+    # Brake will execute the first task and then drop everything else
+    # This stops incorrect options causing problems
+    # ARGV.each do | task |
+    #   self.debug( task )
+    #   self.run_rake_task( task )
+    # end
   end
 
+  # prints out the passed message if debug/untangle is on
   def debug( message )
     if @untangle
       puts message.to_s
@@ -42,116 +63,112 @@ class Brake
   # The Hash is then returned
   # @return [hash] arguemnts a hash containg the parsed and  data
   def parse_command_line_options
-    options = []
-    @untangle = false
-
     begin
       # parses the options from the command line
       OptionParser.new do |opts|
-        opts.banner = "\nBrake, The Brandwatch Rake wrapper for cucumber, Give Rake a Brake.\nUsage: brake <task> [options]"
+        opts.banner = "\nBrake, A Cucumber options parser wrapper for Rake, because, cake was already taken!, Give Rake a Brake.\nUsage: brake <task> [options]"
         opts.separator ""
-        opts.separator "Global options:"  
-        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", "--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 "Cucmber options:"
+         opts.on("-t", "--tags @high,@login", Array, "Array:  A list of all tagged test to be run" ) do |opt|
+          @arguments[:tags] ||= []
+          @arguments[:tags].push( "--tags #{opt.join(',')}" )
+        end
+        opts.on("-d", "--dry-run", "Bool: turns on the selenium dry run feature" ) do |opt|
+          @arguments[:dry_run] = "--dry-run"
+        end
+        opts.on("-v", "--verbose", "Bool: Show the files and features loaded" ) do |opt|
+          @arguments[:verbose] = "--verbose"
+        end
+        opts.on("-f", "--format", String, "String: How to format the features (Default: pretty)" ) do |opt|
+          @arguments[:format] = "--format #{opt}"
+        end
+
+        opts.separator ""
+        opts.separator "Global options:" 
+        opts.on("-e", "--enviroment release", String, "String: The enviroment to run the tests against eg Release" ) do |opt|
+          @arguments[:env] = "ENVIRONMENT=#{opt.downcase}"
+        end
+        opts.on("-l", "--log_level debug", String, "String: The log output level debug|info" ) do |opt|
+          @arguments[:log_level] = "LOGLEVEL=#{opt.downcase}"
+        end
+        opts.on("-c", "--controller chrome", String, "String: The type of controller to run (API, Chrome, Safari)" ) do |opt|
+          @arguments[:controller] = "CONTROLLER=#{opt.downcase}"
+        end
+        opts.on("--[no-]headless", "Bool: To turn on/off headless mode (only works on Linux!)" ) do |opt|
+          @arguments[:headless] = "HEADLESS=#{opt.to_s}"
+        end
+        opts.on("--[no-]cleanup", "Bool: To turn on/off setup cleanup" ) do |opt|
+          @arguments[:cleanup] = "CLEANUP=#{opt.to_s}"
+        end
+        opts.on("--retries 3", String, "String: The number of retries to perform on element methods" ) do |opt|
+          @arguments[:retries] = "RETRIES=#{opt.downcase}"
+        end
+        opts.on("--timeouts 10", String, "String: The length of the timeouts on element methods" ) do |opt|
+          @arguments[:timeouts] = "TIMEOUTS=#{opt.downcase}"
+        end     
+
         opts.separator ""
-        opts.separator "BrandwatchWeb options:"
-        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 "Web options:"
+        opts.on("-s", "--screen 1280,1024", Array, "Array:  The width,hight of the browser window" ) do |opt|
+          if opt.length != 2
+            puts "Incorrect number of args for screen: " + opt.to_s
+            exit
+          end
+          @arguments[:screen] = "SCREENWIDTH=#{opt[0].downcase} SCREENHEIGHT=#{opt[1].downcase}"
+        end
+        opts.on("--pos", "--position 0,0", Array, "Array:  The x,y coords of the browser 0,0 top left" ) do |opt|
+          if opt.length > 2
+            puts "Incorrect number of args for position: " + opt.to_s
+            exit
+          end
+          @arguments[:position] = "XPOSITION=#{opt[0].downcase} YPOSITION=#{opt[1].downcase}"
+        end
+
         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.on("-H", "--[no-]highlight", "Bool: To turn on/off the highlight of elements" ) do |opt|
+          @arguments[:highlight] = "HIGHLIGHT=#{opt.to_s}"
+        end
+
+        opts.separator "Brake options:"
         opts.separator ""
-        opts.on("-u", "--[no-]untangle", "Bool: Turns Debug on/off" ) { |o| @untangle = o }
+        opts.on("-I", "--iterate", String, "Int: Number of times to run the task" ) do |opt|
+          @taskIterations = opt.to_i
+        end
+        opts.on("-U", "--[no-]untangle", "Bool: Turns Debug on/off" ) do |opt|
+          @untangle = opt
+        end
         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 "\nFor furthur assistance please contact Ben Slaughter or Jonathan Chrisp"
           puts "bens@brandwatch.com or jonathan@brandwatch.com"
           exit
         end
-      end.parse!
+      end.parse! # options parser
     rescue OptionParser::InvalidOption => e
       puts e.message
       self.debug( e.backtrace.to_s )
       exit
-    end
-
-    # creates the default arguments
-    # -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
-    # the data is later read by the automation code
-    options.each do | value |
-      case value[0]
-        when :env
-          arguments[:env] = "ENVIRONMENT=#{value[1].downcase}"
-        when :tags
-          arguments[:tags] ||= []
-          arguments[:tags].push( "--tags #{value[1].join(',')}" )
-        when :log_level
-          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
-          arguments[:controller] = "CONTROLLER=#{value[1].downcase}"
-        when :screen
-          arguments.push( "SCREENWIDTH=#{value[1][0].downcase} SCREENHEIGHT=#{value[1][1].downcase}" )
-        when :position
-          arguments.push( "XPOSITION=#{value[1][0].downcase} YPOSITION=#{value[1][1].downcase}" )
-        when :version
-          arguments.push( "VERSION=#{value[1].downcase}" )
-      end
-    end
-    return arguments
-  end
+    end # begin
+  end # def
 
   # 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 )
+  def run_rake_task( task )
     puts "running task: " + task
-    self.debug( arguments )
+    self.debug( @arguments )
     begin
-      case task.downcase
-      when 'default'
-        puts "WARNING: No Defaults set for default task"
-        Rake::Task['default'].execute( arguments.values.join( ' ' ) )
-      when 'brandwatchweb', 'bw'
-        arguments = { :env => 'ENVIRONMENT=release', :controller => 'CONTROLLER=chrome' }.merge(arguments)
-        Rake::Task['brandwatchweb'].execute( arguments.values.join( ' ' ) )
-      when 'brandwatchapi', 'api'
-        arguments = { :env => 'ENVIRONMENT=release', :controller => 'CONTROLLER=api', :version => 'VERSION=1' }.merge(arguments)
-        Rake::Task['brandwatchapi'].execute( arguments.values.join( ' ' ) )
+      if task.downcase == 'default'
+        Rake::Task['default'].execute( @arguments )
       else
-        puts "WARNING: No Defaults set for custom task"
-        Rake::Task[task].execute( arguments.values.join( ' ' ) )
-      end # case
+        Rake::Task[task].execute( @arguments )
+      end # if
       
-    # This cased me some problems while running tasks
+    # This caused 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
+    # and due to the design requierments 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.4
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,7 +28,8 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.9.2.2
-description: A Brandwatch made, options parser wrapper for Rake, No Brake for Rake.
+description: A Cucumber options parser wrapper for Rake, because, cake was already
+  taken!
 email: bens@brandwatch.com
 executables:
 - brake
@@ -41,7 +42,7 @@ files:
 homepage: http://rubygems.org/gems/brake
 licenses:
 - GPL-2
-post_install_message: Thanks for installing brake!
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -62,6 +63,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A Brandwatch wrapper for rake, No Brake for Rake.
+summary: A Cucumber options parser wrapper for Rake.
 test_files: []
 has_rdoc: