rutema 1.1.0 → 1.1.1

data/History.txt

@@ -1,4 +1,6 @@
-== 1.1.0 /2010-12
+== 1.1.1 /2010-12-22
+* Bugfix: RakeTask constructor parameter config renamed to config_file to match the accessor methods
+== 1.1.0 /2010-12-20
 * Added Rutema::RakeTask class to allow integration of the test runner with rake
 * Email reporting now suppresses _setup and _teardown entries unless it's configured as verbose. To do this add a :verbose=>true entry in the reporter configuration
 * Fixed a bug, where on a setup spec failure the state of the actual spec was nil

data/lib/rutema/configuration.rb

@@ -3,19 +3,28 @@ $:.unshift File.join(File.dirname(__FILE__),"..")
 
 module Rutema
   #This module defines the "configuration directives" used in the configuration of RutemaX
+  #
+  #Example
+  #A configuration file needs as a minimum to define which parser to use and which tests to run.
+  #
+  #Since rutema configuration files are valid Ruby code, you can use the full power of the Ruby language including require directives
+  #
+  # require 'rubygems'
+  # require 'rake'
+  # configuration.parser={:class=>Rutema::MinimalXMLParser}
+  # configuration.tests=FileList['all/of/the/tests/**/*.*']
   module RutemaXConfiguration
     #Adds a hash of values to the tools hash of the configuration
     #
-    #
     #This hash is then accessible in the parser and reporters as a property of the configuration instance
     #
     #Required keys:
     # :name - the name to use for accessing the path in code
     #Example:
-    # configuration.tool={:name=>"make",:path=>"/bin/make",:configuration=>{:important=>"info"}}
+    # configuration.tool={:name=>"nunit",:path=>"/bin/nunit",:configuration=>{:important=>"info"}}
     #
     #The path to make can be accessed in the parser as
-    # @configuration.make[:path]
+    # @configuration.tools.nunit[:path]
     #
     #This way you can pass configuration information for the tools you use
     def tool= definition
@@ -116,6 +125,8 @@ module Rutema
   end
   
   #This class reads a RutemaX configuration file
+  #
+  #See Rutema::RutemaXConfiguration for configuration examples and directives
   class RutemaXConfigurator<Patir::Configurator
     include RutemaXConfiguration
     def initialize config_file,logger=nil

data/lib/rutema/rake.rb

@@ -2,16 +2,26 @@ require 'rutema/system'
 require 'optparse'
 
 module Rutema
+  #Integrates rutema with rake
   class RakeTask
-    attr_accessor :config_file, :log_file, :step, :name
+    attr_accessor :config_file, :log_file, :name
+    #Params is a parameter hash.
+    #
+    #Valid parameters are:
+    #
+    #:config_file => path to the configuration file
+    #
+    #:log_file => path to the file where the log is saved. If missing then the logger prints in stdout
+    #
+    #:name => the name for the rutema task. If missing then the task is named rutema, otherwise it will be rutema:name
     def initialize params=nil
       params||={}
-      @config_file=params[:config]
+      @config_file=params[:config_file]
       @log_file=params[:log]
       @name=params[:name]
       yield self if block_given?
       
-      raise "No rutema configuration given" unless @config_file
+      raise "No rutema configuration given, :config_file is nil" unless @config_file
       args=['-c',@config_file]
       args+=['-l',@log_file] if @log_file
       args<<"all"

data/lib/rutema/system.rb

@@ -13,7 +13,7 @@ module Rutema
   module Version
     MAJOR=1
     MINOR=1
-    TINY=0
+    TINY=1
     STRING=[ MAJOR, MINOR, TINY ].join( "." )
   end
   #The Elements module provides the namespace for the various modules adding parser functionality
@@ -229,7 +229,7 @@ module Rutema
   end
   #The ExtensibleXMLParser allows you to easily add methods to handle specification elements.
   #
-  #A method element_foo(step) allows you to add behaviour for <foo> scenario elements.
+  #A method element_foo(step) allows you to add behaviour for foo scenario elements.
   #
   #The method will receive a Rutema::TestStep instance. 
   class ExtensibleXMLParser<BaseXMLParser
@@ -252,9 +252,7 @@ module Rutema
       return spec
     end
   end
-  #MinimalXMLParser offers three runnable steps in the scenarios
-  #
-  #
+  #MinimalXMLParser offers three runnable steps in the scenarios as defined in Rutema::Elements::Minimal
   class MinimalXMLParser<ExtensibleXMLParser
     include Rutema::Elements::Minimal
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rutema
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 +02:00
+date: 2010-12-22 00:00:00 +02:00
 default_executable: rutemax
 dependencies: 
 - !ruby/object:Gem::Dependency