patir 0.6.4 → 0.7.0

data/History.txt

@@ -1,6 +1,12 @@
-==0.6.4 / 2009-09-4
-* context parameter added to Command#run
+==0.7.0 / 2011-08-11
+* Ruby 1.9 compatibility
+* updated systemu dependency
+* Unit tests extended
+* added context parameter to RubyCommand instances
+* ShellCommand now sets the error output consistently (at times it was nil)
 
+==0.6.4 / 2009-09-04
+* context parameter added to Command#run
 ==0.6.3
 * Repository restructured (git is used internally so the svn repository matches now the master branch)
 * Cleanup. Some obsolete code was removed

data/Manifest.txt

@@ -1,3 +1,4 @@
+COPYING.txt
 History.txt
 Manifest.txt
 README.txt
@@ -6,29 +7,7 @@ Rakefile
 lib/patir/base.rb
 lib/patir/command.rb
 lib/patir/configuration.rb
+test/samples/empty.cfg
 test/test_patir_base.rb
 test/test_patir_command.rb
 test/test_patir_configuration.rb
-test/samples/empty.cfg
-docu/style.css
-docu/tie_logo.gif
-docu/welcome.html
-docu/bg_menu.gif
-docu/bg_submenu.gif
-docu/contact.html
-docu/index.html
-docu/patir02.html
-docu/patir03.html
-docu/patir04.html
-docu/patir05.html
-docu/rutema01.html
-docu/rutema02.html
-docu/rutema03.html
-docu/rutema04.html
-docu/rw-intro.png
-docu/rw-run.png
-docu/rw-scenario.png
-docu/screenshots.html
-docu/style.css
-docu/tie_logo.gif
-docu/welcome.html

data/README.txt

@@ -1,32 +1,22 @@
-patir - http://patir.rubyforge.org
-
+patir http://patir.rubyforge.org
 == DESCRIPTION:
   
-patir provides the libraries common to all the project automation tools included in the Patir project.
-
-== FEATURES/PROBLEMS:
-  
-* Configuration library for creating Ruby configuration files
-* Command library abstracting the execution of commands
-
-== SYNOPSIS:
-
-patir is the library of common functionality used in the patir projects.
-This includes a class that allows you to build configuration files in Ruby and a library for command abstraction.
-
-== REQUIREMENTS:
+patir provides code to enable project automation tasks:
 
-* systemu 
+* A default logging format for ruby's built-in Logger
+* A command abstraction (Patir::Command) with a platform independent implementation for running shell commands (Patir::ShellCommand) and ruby code (Patir::RubyCommand)
+* Command sequences using the same command abstraction as single commands.
+* Code that allows the use of configuration files written in ruby.
 
 == INSTALL:
 
-* gem install patir
+ gem install patir
 
 == LICENSE:
 
 (The Ruby License)
 
-patir is copyright (c) 2007 Vassilis Rizopoulos
+patir is copyright (c) 2007-2011 Vassilis Rizopoulos
 
 You can redistribute it and/or modify it under either the terms of the GPL
 (see COPYING.txt file), or the conditions below:

data/Rakefile

@@ -4,16 +4,18 @@ require 'rubygems'
 require 'hoe'
 require 'patir/base'
 
-Hoe.spec('patir') do |p|
-  p.version = Patir::Version::STRING
-  p.author = "Vassilis Rizopoulos"
-  p.email = "riva@braveworld.net"
-  p.summary = 'patir (Project Automation Tools in Ruby) provides libraries for use in automation tools'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.rubyforge_name="patir"
-  p.extra_deps<<['systemu']
+Hoe.plugins.delete :compiler
+
+Hoe.spec('patir') do
+  self.version = Patir::Version::STRING
+  self.rubyforge_name = 'patir'
+  self.author = "Vassilis Rizopoulos"
+  self.email = "vassilisrizopoulos@gmail.com"
+  self.summary = 'patir (Project Automation Tools in Ruby) provides libraries for use in project automation tools'
+  self.description = paragraphs_of('README.md', 1..4).join("\n\n")
+  self.url = "http://patir.rubyforge.org"
+  self.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+  extra_deps<<['systemu',"~>2.2.0"]
 end
 
 # vim: syntax=Ruby

data/lib/patir/base.rb

@@ -1,12 +1,12 @@
-#  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
+#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 require 'logger'
 #This is the base module of the Patir system. It contains some usefull helper methods used by all child projects.
 module Patir
   #The Patir version used
   module Version
     MAJOR=0
-    MINOR=6
-    TINY=4
+    MINOR=7
+    TINY=0
     STRING=[ MAJOR, MINOR, TINY ].join( "." )  	
   end
   #Error thrown usually in initialize methods when missing required parameters
@@ -32,13 +32,9 @@ module Patir
   #It creates a logger just as we want it.
   #
   #mode can be
-  #
-  #:mute to set the level to FATAL
-  #
-  #:silent to set the level to WARN
-  #
-  #:debug to set the level to DEBUG. Debug is set also if $DEBUG is true.
-  #
+  # :mute to set the level to FATAL
+  # :silent to set the level to WARN
+  # :debug to set the level to DEBUG. Debug is set also if $DEBUG is true.
   #The default logger level is INFO
   def self.setup_logger(filename=nil,mode=nil)
     if filename

data/lib/patir/command.rb

@@ -1,4 +1,4 @@
-#  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
+#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 require 'observer'
 require 'fileutils'
 require 'rubygems'
@@ -83,14 +83,10 @@ module Patir
     #returns the command status.
     #
     #valid stati are
-    #
-    #:not_executed when the command was not run
-    #
-    #:success when the command has finished succesfully
-    #
-    #:error when the command has an error
-    #
-    #:warning when the command finished without errors, but there where warnings
+    # :not_executed when the command was not run
+    # :success when the command has finished succesfully
+    # :error when the command has an error
+    # :warning when the command finished without errors, but there where warnings
     def status
       #initialize nil values to something meaningful
       @status||=:not_executed
@@ -98,16 +94,14 @@ module Patir
     end
   end
 
-  #This class wraps the http://codeforpeople.com/lib/ruby/systemu/ as a Command duck.
+  #This class wraps the Command interface around https://github.com/ahoward/systemu 
   #
-  #It allows for execution of any shell command.
+  #It allows for execution of any shell command on any platform.
   #
   #Accepted keys are
-  #
-  #:cmd should be the shell command to execute (required - ParameterException will be raised).
-  #
-  #:working_directory for specifying the working directory (default is '.') and :name for assigning a name to the command (default is "").
-  #
+  # :cmd - the shell command to execute (required - ParameterException will be raised).
+  # :working_directory - specify the working directory (default is '.')
+  # :name - assign a name to the command (default is "").
   class ShellCommand
     include Command
     #The constructor will throw CommandError if :cmd is missing.
@@ -127,7 +121,6 @@ module Patir
     #Executes the shell command and returns the status
     def run context=nil
       start_time=Time.now
-      super
       begin
         #create the working directory if it does not exist
         FileUtils::mkdir_p(@working_directory,:verbose=>false)
@@ -150,6 +143,8 @@ module Patir
           @status=:warning
         end
       rescue
+        #if it blows in systemu it will be nil
+        @error||=""
         @error<<"\n#{$!.message}"
         @error<<"\n#{$!.backtrace}" if $DEBUG
         @status=:error
@@ -320,18 +315,12 @@ module Patir
   #In order to extract the status from steps, classes should quack to the rythm of Command. CommandSequenceStatus does this, so you can nest Stati
   #
   #The status of an action sequence is :not_executed, :running, :success, :warning or :error and represents the overall status
-  #
-  #:not_executed is set when all steps are :not_executed
-  #
-  #:running is set while the sequence is running.
-  #
+  # :not_executed is set when all steps are :not_executed
+  # :running is set while the sequence is running.
   #Upon completion or interruption one of :success, :error or :warning will be set.
-  #
-  #:success is set when all steps are succesfull.
-  #
-  #:warning is set when at least one step generates warnings and there are no failures.
-  #
-  #:error is set when after execution at least one step has the :error status
+  # :success is set when all steps are succesfull.
+  # :warning is set when at least one step generates warnings and there are no failures.
+  # :error is set when after execution at least one step has the :error status
   class CommandSequenceStatus
     attr_accessor :start_time,:stop_time,:sequence_runner,:sequence_name,:status,:step_states,:sequence_id,:strategy
     #You can pass an array of Commands to initialize CommandSequenceStatus
@@ -466,16 +455,16 @@ module Patir
   #== Examples
   #An example (using the excellent HighLine lib) of a CLI prompt as a RubyCommand
   # RubyCommand.new("prompt") do |cmd|  
-  #     cmd.output=""
-  #     cmd.error=""
-  #     unless HighLine.agree("#{step.text}?")
-  #       cmd.error="Why not?"
-  #       raise "You did not agree" 
-  #     end
+  #   cmd.output=""
+  #   cmd.error=""
+  #   unless HighLine.agree("#{step.text}?")
+  #     cmd.error="Why not?"
+  #     raise "You did not agree" 
   #   end
+  # end
   class RubyCommand
     include Patir::Command
-    attr_reader :cmd,:working_directory
+    attr_reader :cmd,:working_directory,:context
     def initialize name,working_directory=nil,&block
       @name=name
       @working_directory=working_directory||"."
@@ -488,6 +477,7 @@ module Patir
     #Runs the associated block
     def run context=nil
       @run=true
+      @context=context
       begin
         t1=Time.now
         Dir.chdir(@working_directory) do
@@ -501,6 +491,7 @@ module Patir
       ensure
         @exec_time=Time.now-t1
       end
+      @context=nil
       return @status
     end
   end

data/lib/patir/configuration.rb

@@ -1,4 +1,4 @@
-#  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
+#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 
 require 'patir/base'
 module Patir

data/test/test_patir_command.rb

@@ -73,7 +73,7 @@ class TestShellCommand<Test::Unit::TestCase
   #when passed a wroking directory, the command should change into that directory
   def test_cwd
     cmd=nil
-    assert_nothing_raised(){cmd=ShellCommand.new(:cmd=>"echo", :working_directory=>"samples/")}
+    assert_nothing_raised(){cmd=ShellCommand.new(:cmd=>"echo", :working_directory=>"missing/")}
     assert_nothing_raised(){cmd.run}
     assert(cmd.success?)
   end
@@ -222,6 +222,16 @@ class TestRubyCommand<Test::Unit::TestCase
     assert(!cmd.success?, "Successful?!")
     assert_equal(:error, cmd.status)
   end
+  def test_context
+    context="complex"
+    cmd=RubyCommand.new("test"){|c| c.output=c.context}
+    assert_nothing_raised() { cmd.run(context)}
+    assert(cmd.success?, "Not successful.")
+    assert_equal(context, cmd.output)
+    assert_nothing_raised() { cmd.run("other")}
+    assert_equal("other", cmd.output)
+    assert_equal(:success, cmd.status)
+  end
 end
 
 class TestCommandSequenceStatus<Test::Unit::TestCase

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: patir
 version: !ruby/object:Gem::Version 
-  version: 0.6.4
+  hash: 3
+  prerelease: 
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -9,85 +15,77 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-04 00:00:00 +02:00
-default_executable: 
+date: 2011-08-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: systemu
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  type: :development
+  version_requirements: *id002
 description: |-
-  == FEATURES/PROBLEMS:
+  ##DESCRIPTION:
     
-  * Configuration library for creating Ruby configuration files
-  * Command library abstracting the execution of commands
+  patir provides code to enable project automation tasks:
   
-  == SYNOPSIS:
+   * A default logging format for ruby's built-in Logger
+   * A command abstraction with a platform independent implementation for running shell commands and ruby code
+   * Command sequences using the same command abstraction as single commands.
+   * Code that allows the use of configuration files written in ruby.
   
-  patir is the library of common functionality used in the patir projects.
-  This includes a class that allows you to build configuration files in Ruby and a library for command abstraction.
+  ##INSTALL:
   
-  == REQUIREMENTS:
-email: riva@braveworld.net
+   gem install patir
+email: vassilisrizopoulos@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- COPYING.txt
 - History.txt
 - Manifest.txt
 - README.txt
-- COPYING.txt
 files: 
+- COPYING.txt
 - History.txt
 - Manifest.txt
 - README.txt
-- COPYING.txt
 - Rakefile
 - lib/patir/base.rb
 - lib/patir/command.rb
 - lib/patir/configuration.rb
+- test/samples/empty.cfg
 - test/test_patir_base.rb
 - test/test_patir_command.rb
 - test/test_patir_configuration.rb
-- test/samples/empty.cfg
-- docu/style.css
-- docu/tie_logo.gif
-- docu/welcome.html
-- docu/bg_menu.gif
-- docu/bg_submenu.gif
-- docu/contact.html
-- docu/index.html
-- docu/patir02.html
-- docu/patir03.html
-- docu/patir04.html
-- docu/patir05.html
-- docu/rutema01.html
-- docu/rutema02.html
-- docu/rutema03.html
-- docu/rutema04.html
-- docu/rw-intro.png
-- docu/rw-run.png
-- docu/rw-scenario.png
-- docu/screenshots.html
-has_rdoc: true
-homepage: 
+- .gemtest
+homepage: http://patir.rubyforge.org
 licenses: []
 
 post_install_message: 
@@ -97,24 +95,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: patir
-rubygems_version: 1.3.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: patir (Project Automation Tools in Ruby) provides libraries for use in automation tools
+summary: patir (Project Automation Tools in Ruby) provides libraries for use in project automation tools
 test_files: 
 - test/test_patir_base.rb
 - test/test_patir_command.rb