devcreek 0.1 → 0.2

data/History.txt

@@ -2,3 +2,7 @@
 
 * Beta Release
   * Initial release of DevCreek Ruby gem. Support for Test::Unit framework.
+
+== 0.2 / 2007-12-07
+
+* Small change to the documentation. Add logging functionality.

data/README.txt

@@ -50,7 +50,7 @@
 	DevCreek::Core.instance().load(
 	  :user => 'your_devcreek_username',
       :password => 'your_devcreek_password',
-      :project => 'your_devcreek_project'
+      :project => 'your_devcreek_project',
       :enabled => true
 	)  
 	--------

data/lib/devcreek.rb

@@ -5,6 +5,11 @@
 # Licensed under the LGPL, see the file README.txt in the distribution
 
 require 'devcreek_testrunnermediator.rb' #for test/unit library
+require 'logger'
+
+$DEV_CREEK_LOG = Logger.new($stderr)
+$DEV_CREEK_LOG.level = Logger::INFO
+
 module DevCreek
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/lib/devcreek_testrunnermediator.rb

@@ -15,17 +15,9 @@ require 'rubygems'
 require 'uuidtools'
 require 'test/unit/ui/testrunnermediator'
 
-#class Test::Unit::TestCase
-#  alias_method :old_run,  :run
-#  def run(*args)
-#    puts "TestCase.run.start #{name}"
-##    result = old_run(*args, &block)
-#    puts "TestCase.run.start #{name}"
-#  end
-#end
-
 class Test::Unit::UI::TestRunnerMediator
   alias_method :old_initialize,  :initialize
+
   def initialize(*args)
     result = old_initialize(*args)
     
@@ -34,16 +26,19 @@ class Test::Unit::UI::TestRunnerMediator
     @@dev_creek_reg = /([\w]*)\(([\w]*)\)/
     
     add_listener(Test::Unit::UI::TestRunnerMediator::STARTED) do |test_result| 
+      $DEV_CREEK_LOG.debug "Test::Unit::TestRunnerMediator::STARTED: #{test_result}"
       @@dev_creek_test_suite = DevCreek::TestSuite.new("Test::Unit")
     end
     
     add_listener(Test::Unit::TestCase::STARTED) do |name| 
+      $DEV_CREEK_LOG.debug "Test::Unit::TestCase::STARTED: #{name}"
       test_name = name.match(@@dev_creek_reg)[1]
       test_class = name.match(@@dev_creek_reg)[2]
       @@dev_creek_test_suite.test_results[name] = DevCreek::TestResult.new(test_name, test_class)
     end
     
     add_listener(Test::Unit::TestResult::FAULT) do |fault| 
+      $DEV_CREEK_LOG.debug "Test::Unit::TestResult::FAULT: #{fault}"
       dc_test_result = @@dev_creek_test_suite.test_results[fault.test_name]
       if fault.instance_of? Test::Unit::Failure
         dc_test_result.has_a_failure
@@ -53,6 +48,7 @@ class Test::Unit::UI::TestRunnerMediator
     end
     
     add_listener(Test::Unit::TestCase::FINISHED) do |test_name|
+      $DEV_CREEK_LOG.debug "Test::Unit::TestCase::FINISHED: #{test_name}"
       @@dev_creek_test_suite.test_results[test_name].has_finished
     end
     
@@ -62,14 +58,14 @@ class Test::Unit::UI::TestRunnerMediator
         if @@dev_creek_test_suite.has_test_results?
           session_id = UUID.timestamp_create().to_s
           xml_data = @@dev_creek_test_suite.to_xml(session_id)
-          puts xml_data
-          p 'Attempting DevCreek transmission...'
+          $DEV_CREEK_LOG.debug "Submitting body: \n #{xml_data}"
+          $DEV_CREEK_LOG.info "Attempting DevCreek transmission..."
           response = DevCreek::Transmitter.submit(session_id, xml_data)     
           case response
           when Net::HTTPSuccess
-            puts '...transmission successful.'
+            $DEV_CREEK_LOG.info "...transmission successful."
           else
-            puts "...failure transmiting TestUnit results to DevCreek: ${response.error!}"
+            $DEV_CREEK_LOG.error "...failure transmiting TestUnit results to DevCreek - HTTPResponse with Code # #{response.code}, HTTPResponse message \"#{response.message}\""
           end  
         end  
       end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: devcreek
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2007-12-06 00:00:00 -05:00
+  version: "0.2"
+date: 2007-12-07 00:00:00 -05:00
 summary: The DevCreek gem enables programmers to collect and transmit metrics from their Ruby test framework to a DevCreek server.
 require_paths: 
 - lib
 email: caleb.powell@gmail.com
 homepage: http://rubyforge.org/projects/devcreek/
 rubyforge_project: devcreek
-description: "The DevCreek gem enables programmers to collect and transmit metrics from their Ruby Test::Unit test suites to a DevCreek server. Please visit the DevCreek site (http://devcreek.com/index.html/) for more info.  == FEATURES/PROBLEMS:  Test::Unit is the currently the only supported framework. Rspec support is on it's way ;-)  == SYNOPSIS:  The DevCreek Ruby Gem is library that, when loaded, will automatically listen to and collect metrics from your Test::Unit  unit tests. All you have to do is load the DevCreek library in your code and give it your DevCreek account info so  that it can transmit the metrics to the server. Here is the simplest example of how to load DevCreek:  -------- #Load the devcreek gem require 'rubygems' require 'devcreek'  #set your account info  DevCreek::Core.instance().load_from_yaml(\"#{ENV['HOME']}/.yoursettingsfile.devcreek.yml\")   --------  There are two ways to provide DevCreek with your account settings. The first (as shown above) is to point DevCreek to a  settings file. The 'enabled' attribute tells devcreek whether or not it should actually transmit the metrics that it  collects. The yaml file would like this:  -------- user: your_devcreek_username password: your_devcreek_password project: your_devcreek_project enabled: true --------  The other way to provide DevCreek with your settings is via a hash. So, instead of loading a yaml file, you could do this:  -------- #Load the devcreek gem require 'rubygems' require 'devcreek'  #set your account info  DevCreek::Core.instance().load( :user => 'your_devcreek_username', :password => 'your_devcreek_password', :project => 'your_devcreek_project' :enabled => true )   --------  The first method is preferrable because it allows you to keep your account settings outside of your project (and therefore  your source control tool).  If you only have 1 test file, you can place the code to load devcreek in the test file and your done. However, most projects will have many test files. In this case, you need to make sure that the Ruby interpreter loads devcreek before running the test classes. This can be done via the Ruby '-r' option. For example, assuming your code to load devcreek is in a file called foo.rb, you would run your tests from the command line like this:  ruby -r foo.rb test/test_*  If you run your tests from a Rakefile, then you need to tell rake to include the -r option when it runs the tests (rake runs it's tests in a separate Ruby process). You can do this pretty easily in your Rakefile, like so;  -------- require 'rake/testtask' Rake::TestTask.new('all_tests') do |t| t.ruby_opts = ['-r foo.rb'] t.test_files = ['test/test_*.rb'] end --------   == REQUIREMENTS:"
+description: "The DevCreek gem enables programmers to collect and transmit metrics from their Ruby Test::Unit test suites to a DevCreek server. Please visit the DevCreek site (http://devcreek.com/index.html/) for more info.  == FEATURES/PROBLEMS:  Test::Unit is the currently the only supported framework. Rspec support is on it's way ;-)  == SYNOPSIS:  The DevCreek Ruby Gem is library that, when loaded, will automatically listen to and collect metrics from your Test::Unit  unit tests. All you have to do is load the DevCreek library in your code and give it your DevCreek account info so  that it can transmit the metrics to the server. Here is the simplest example of how to load DevCreek:  -------- #Load the devcreek gem require 'rubygems' require 'devcreek'  #set your account info  DevCreek::Core.instance().load_from_yaml(\"#{ENV['HOME']}/.yoursettingsfile.devcreek.yml\")   --------  There are two ways to provide DevCreek with your account settings. The first (as shown above) is to point DevCreek to a  settings file. The 'enabled' attribute tells devcreek whether or not it should actually transmit the metrics that it  collects. The yaml file would like this:  -------- user: your_devcreek_username password: your_devcreek_password project: your_devcreek_project enabled: true --------  The other way to provide DevCreek with your settings is via a hash. So, instead of loading a yaml file, you could do this:  -------- #Load the devcreek gem require 'rubygems' require 'devcreek'  #set your account info  DevCreek::Core.instance().load( :user => 'your_devcreek_username', :password => 'your_devcreek_password', :project => 'your_devcreek_project', :enabled => true )   --------  The first method is preferrable because it allows you to keep your account settings outside of your project (and therefore  your source control tool).  If you only have 1 test file, you can place the code to load devcreek in the test file and your done. However, most projects will have many test files. In this case, you need to make sure that the Ruby interpreter loads devcreek before running the test classes. This can be done via the Ruby '-r' option. For example, assuming your code to load devcreek is in a file called foo.rb, you would run your tests from the command line like this:  ruby -r foo.rb test/test_*  If you run your tests from a Rakefile, then you need to tell rake to include the -r option when it runs the tests (rake runs it's tests in a separate Ruby process). You can do this pretty easily in your Rakefile, like so;  -------- require 'rake/testtask' Rake::TestTask.new('all_tests') do |t| t.ruby_opts = ['-r foo.rb'] t.test_files = ['test/test_*.rb'] end --------   == REQUIREMENTS:"
 autorequire: 
 default_executable: 
 bindir: bin