hydra 0.13.0 → 0.14.0

data/README.rdoc

@@ -132,6 +132,36 @@ Use ssh_opts to set the port or compression options.
 The *directory* option is the path for the project directory
 where the tests should be run.
 
+=== Using Hydra::Listeners
+
+Hydra comes with a couple of listeners for the events it fires. By
+default, Hydra::Listener::MinimalOutput is used to display the
+files being tests and the ./F/E for each file and F/E output.
+
+It also uses Hydra::Listener::ReportGenerator to generate reports
+of the test files to that it can order them by their run times.
+
+To use another listener, just add a listeners node to the config file.
+For example, if you are on Ubuntu Linux (or have access to the 
+notify-send command) you can add a notifier listener like this:
+
+  listeners:
+    - Hydra::Listener::Notifier.new
+
+Note that if you make a listener node, the default listeners will be
+overridden, so you will no longer have the standard minimal output
+unless you do:
+
+  listeners:
+    - Hydra::Listener::Notifier.new
+    - Hydra::Listener::MinimalOutput.new
+
+Listeners take one argument to their contstructor: an IO object. So,
+you can easily output Hydra to a variety of log files. For example:
+
+  listeners:
+    - Hydra::Listener::ReportGenerator.new(File.new('/home/ngauthier/Desktop/hydra_log.yml', 'w'))
+
 == More Information
 
 For more information on Hydra, check out the rdocs:

data/VERSION

@@ -1 +1 @@
-0.13.0
+0.14.0

data/hydra.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hydra}
-  s.version = "0.13.0"
+  s.version = "0.14.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nick Gauthier"]
@@ -26,12 +26,15 @@ Gem::Specification.new do |s|
      "TODO",
      "VERSION",
      "caliper.yml",
+     "hydra-icon-64x64.png",
      "hydra.gemspec",
      "hydra_gray.png",
      "lib/hydra.rb",
      "lib/hydra/hash.rb",
      "lib/hydra/listener/abstract.rb",
      "lib/hydra/listener/minimal_output.rb",
+     "lib/hydra/listener/notifier.rb",
+     "lib/hydra/listener/progress_bar.rb",
      "lib/hydra/listener/report_generator.rb",
      "lib/hydra/master.rb",
      "lib/hydra/message.rb",

data/lib/hydra.rb

@@ -10,5 +10,6 @@ require 'hydra/master'
 require 'hydra/listener/abstract'
 require 'hydra/listener/minimal_output'
 require 'hydra/listener/report_generator'
-
+require 'hydra/listener/notifier'
+require 'hydra/listener/progress_bar'
 

data/lib/hydra/listener/notifier.rb

@@ -0,0 +1,17 @@
+module Hydra #:nodoc:
+  module Listener #:nodoc:
+    # Sends a command to Notifier when the testing has finished
+    # http://manpages.ubuntu.com/manpages/gutsy/man1/notify-send.1.html
+    class Notifier < Hydra::Listener::Abstract
+      # output a finished notification
+      def testing_end
+        icon_path = File.join(
+          File.dirname(__FILE__), '..', '..', '..',
+          'hydra-icon-64x64.png'
+        )
+        `notify-send -i #{icon_path} "Hydra" "Testing Completed"`
+      end
+    end
+  end
+end
+

data/lib/hydra/listener/progress_bar.rb

@@ -0,0 +1,48 @@
+module Hydra #:nodoc:
+  module Listener #:nodoc:
+    # Output a progress bar as files are completed
+    class ProgressBar < Hydra::Listener::Abstract
+      # Store the total number of files
+      def testing_begin(files)
+        @total_files = files.size
+        @files_completed = 0
+        @test_output = ""
+        @errors = false
+        render_progress_bar
+      end
+
+      # Increment completed files count and update bar
+      def file_end(file, output)
+        unless output == '.'
+          @output.write "\r#{' '*60}\r#{output}\n"
+          @errors = true
+        end
+        @files_completed += 1
+        render_progress_bar
+      end
+
+      # Break the line
+      def testing_end
+        render_progress_bar
+        @output.write "\n"
+      end
+
+      private
+
+      def render_progress_bar
+        width = 30
+        complete = ((@files_completed.to_f / @total_files.to_f) * width).to_i
+        @output.write "\r" # move to beginning
+        @output.write 'Progress ['
+        @output.write @errors ? "\033[1;31m" : "\033[1;32m"
+        complete.times{@output.write '#'}
+        @output.write '>'
+        (width-complete).times{@output.write ' '}
+        @output.write "\033[0m"
+        @output.write "] #{@files_completed}/#{@total_files}"
+        @output.flush
+      end
+    end
+  end
+end
+

data/lib/hydra/master.rb

@@ -38,6 +38,11 @@ module Hydra #:nodoc:
       @workers = []
       @listeners = []
       @event_listeners = Array(opts.fetch('listeners') { nil } )
+      @event_listeners.select{|l| l.is_a? String}.each do |l|
+        @event_listeners.delete_at(@event_listeners.index(l))
+        listener = eval(l)
+        @event_listeners << listener if listener.is_a?(Hydra::Listener::Abstract)
+      end
       @verbose = opts.fetch('verbose') { false }
       @autosort = opts.fetch('autosort') { true }
       @sync = opts.fetch('sync') { nil }

data/lib/hydra/tasks.rb

@@ -19,16 +19,18 @@ module Hydra #:nodoc:
     # If not set, it will check 'hydra.yml' and 'config/hydra.yml'
     attr_accessor :config
 
-    # Set to true if you want hydra to generate a report.
-    # Defaults to false
-    attr_accessor :report
-
     # Automatically sort files using their historical runtimes.
     # Defaults to true
     # To disable:
     #   t.autosort = false
     attr_accessor :autosort
 
+    # Event listeners. Defaults to the MinimalOutput listener.
+    # You can add additional listeners if you'd like. For example,
+    # on linux (with notify-send) you can add the notifier listener:
+    #   t.listeners << Hydra::Listener::Notifier.new
+    attr_accessor :listeners
+
     #
     # Search for the hydra config file
     def find_config_file
@@ -66,7 +68,7 @@ module Hydra #:nodoc:
       @files = []
       @verbose = false
       @autosort = true
-      @listeners = [Hydra::Listener::MinimalOutput.new]
+      @listeners = [Hydra::Listener::ProgressBar.new]
 
       yield self if block_given?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hydra
 version: !ruby/object:Gem::Version 
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors: 
 - Nick Gauthier
@@ -41,12 +41,15 @@ files:
 - TODO
 - VERSION
 - caliper.yml
+- hydra-icon-64x64.png
 - hydra.gemspec
 - hydra_gray.png
 - lib/hydra.rb
 - lib/hydra/hash.rb
 - lib/hydra/listener/abstract.rb
 - lib/hydra/listener/minimal_output.rb
+- lib/hydra/listener/notifier.rb
+- lib/hydra/listener/progress_bar.rb
 - lib/hydra/listener/report_generator.rb
 - lib/hydra/master.rb
 - lib/hydra/message.rb