brake 0.1.6 → 0.2.0

data/README

@@ -0,0 +1,47 @@
+README
+A Brandwatch rake wrapper, Brake
+
+Brake Version:0.2.0
+
+Brake, The Brandwatch Rake wrapper for cucumber, Give Rake a Brake.
+Usage: brake <task> [options]
+
+Global options:
+    -e, --enviroment release         String: The enviroment to run the tests against eg Release
+    -p, --platform brandwatchWeb     String: The platform to run the tests on eg brandwatchWeb
+    -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)
+    -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
+
+    -u, --[no-]untangle              Bool: Turns Debug on/off
+    -h, --help                       Show this message
+For furthur assistance please contact Ben Slaughter or Jonathan Chrisp
+bens@brandwatch.com or jonathan@brandwatch.com
+
+Release Notes:
+0.1.0
+Class structure created
+
+0.1.6
+Code cleanup
+Changed the names so that all the task names are strings rather than half symbol and half strings
+
+0.2.0
+Added this readme file
+Cleaned up the debug code
+Added the Version output to display the current version number
+Added the debug method so that the code looks cleaner and easier to understand
+Added the RuntimeError handling to mimic the same rake functionality
+Moved rake requier to be called before the Brakefile load
+
+END

data/lib/brake.rb

@@ -13,15 +13,20 @@ end
 class Brake
   # Starts the Brake Class
   def genesis
-    arguments, untangle = self.parse_command_line_options
-
-    # puts out the command line arguments if untangle is true
-    p ARGV if untangle
+    puts "Brake Version:" + Gem.loaded_specs["brake"].version.to_s
+    @arguments = self.parse_command_line_options
+    self.debug( ARGV )
 
     ARGV.push('default') if ARGV == []
     ARGV.each do | task |
-      p task if untangle
-      self.run_rake_task( task, arguments )
+      self.debug( task )
+      self.run_rake_task( task, @arguments )
+    end
+  end
+
+  def debug( message )
+    if @untangle
+      puts message.to_s
     end
   end
 
@@ -30,7 +35,7 @@ class Brake
   # @return [hash] arguemnts a hash containg the parsed and  data
   def parse_command_line_options
     options = []
-    untangle = false
+    @untangle = false
 
     begin
       # parses the options from the command line
@@ -54,7 +59,7 @@ class Brake
         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("-u", "--[no-]untangle", "Bool: Turns Debug on/off" ) { |o| @untangle = o }
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
           puts "For furthur assistance please contact Ben Slaughter or Jonathan Chrisp"
@@ -64,14 +69,14 @@ class Brake
       end.parse!
     rescue OptionParser::InvalidOption => e
       puts e.message
-      # puts e.backtrace[0].to_s
+      self.debug( e.backtrace.to_s )
       exit
     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
-    arguments = { :req => "--require features -P" }
+    arguments = { :req => "--require features" }
 
     # takes the parsed options and turns them into meaningful data
     # the data is later read by the automation code
@@ -98,7 +103,7 @@ class Brake
           arguments.push( "VERSION=#{value[1].downcase}" )
       end
     end
-    return arguments, untangle
+    return arguments
   end
 
   # Runs the given rake task with the given arguments
@@ -106,20 +111,27 @@ class Brake
   # @param [hash] arguments a hash containing the arguments to be passed to the task
   def run_rake_task( task, arguments )
     puts "running task: " + task
-    case task.downcase
-    when 'default'
-      puts "WARNING: No Defaults set for default task"
-      Rake::Task['default'].invoke( arguments.values.join( ' ' ) )
-    when 'brandwatchweb', 'bw'
-      arguments = { :platform => "PLATFORM=brandwatchweb", :env => 'ENVIRONMENT=release', :controller => 'CONTROLLER=chrome' }.merge(arguments)
-      Rake::Task['brandwatchweb'].invoke( arguments.values.join( ' ' ) )
-    when 'brandwatchapi', 'api'
-      arguments = { :platform => "PLATFORM=brandwatchapi", :env => 'ENVIRONMENT=int', :controller => 'CONTROLLER=api', :version => 'VERSION=1' }.merge(arguments)
-      Rake::Task['brandwatchapi'].invoke( arguments.values.join( ' ' ) )
-    else
-      puts "WARNING: No Defaults set for custom task"
-      Rake::Task[task].invoke( arguments.values.join( ' ' ) )
-    end
-  end
-
-end
+    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 = { :platform => "PLATFORM=brandwatchweb", :env => 'ENVIRONMENT=release', :controller => 'CONTROLLER=chrome' }.merge(arguments)
+        Rake::Task['brandwatchweb'].execute( arguments.values.join( ' ' ) )
+      when 'brandwatchapi', 'api'
+        arguments = { :platform => "PLATFORM=brandwatchapi", :env => 'ENVIRONMENT=int', :controller => 'CONTROLLER=api', :version => 'VERSION=1' }.merge(arguments)
+        Rake::Task['brandwatchapi'].execute( arguments.values.join( ' ' ) )
+      else
+        puts "WARNING: No Defaults set for custom task"
+        Rake::Task[task].execute( arguments.values.join( ' ' ) )
+      end # case
+    rescue RuntimeError => e
+      puts "Brake Aborted!"
+      puts e.message
+      puts "( For full backtrace run again with --untangle )"
+      self.debug( e.backtrace )
+    end # begin
+  end # def
+end # class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brake
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -37,12 +37,11 @@ extra_rdoc_files: []
 files:
 - bin/brake
 - lib/brake.rb
+- README
 homepage: http://rubygems.org/gems/brake
 licenses:
 - GPL-2
-post_install_message: ! 'Thanks for installing brake!
-
-  No Brake for Rake.'
+post_install_message: Thanks for installing brake!
 rdoc_options: []
 require_paths:
 - lib