powirb 1.1 → 1.2

data/README.markdown

@@ -8,7 +8,7 @@
   
 # Intro
 
-Often when using Polarion ALM and you refine (and redefine) step-by-step you process, or perhaps you need a fine-tune over the way you defines wor items the workflows and so and so. Other time you need to import data from other tools and - again - you need an adjustment on some workitems (eg: author name, status, etc).
+Often when using Polarion ALM you refine (and redefine) step-by-step your process, or perhaps you need a fine-tune over the way you defines work items, workflows and so and so. Other time you need to import data from other tools and - again - you need an adjustment on some workitems (eg: author name, status, external references, etc).
 
 I've fonud extremely valuable and fast to do all this operation in [CLI](http://en.wikipedia.org/wiki/Command-line_interface) with ruby.
 
@@ -29,21 +29,26 @@ Only basic operation on workitems are implemented, see the example above:
 
 	# this referes to a project working copy of the subversion repository
 	h = Powirb::Handler.new('./SampleProject')
-
-	h.workitems.each do |wi|
-	  if  wi['status'] == 'closed' and wi[:type] == 'action'
-	    wi[:resolution] = 'done'
-	    wi.save!
-	  end
+	# now the handler has loaded all workitems data in memory (very fast)
+
+	# we can access a particular workitem with its "wid"
+	wi = h.workitems['WI-1234']
+	
+	# or by and AND'ed set of conditions, eg: all closed requirements
+	h.workitems(:type => 'requirements', :status => 'closed').each do |wid,wi|
+	  puts "#{wid} - #{wi[:title]}"
+      wi[:resolution] = 'done'
+	  wi.save!
 	end
 
-Please, *remember*: In order to "save" the modification we have to hit a commit with subversion.
+Please, *remember*: In order to "save" the modification we have to hit a subsequent *commit* with subversion.
 
 
 # Notes
 
-* it does work with Polarion 2011
-* it does **not** support the "old" *LiveDoc* technology
+* Powirb can't create new workitems, only updating on existing ones is allowed
+* it does **not** support the "old" *LiveDoc* technology, but it's ok with the new one
+* the only fields you can change are "string/text" (more work have to be done here!)
 * the actual version was tested under Linux and Mac OS X only
 
 
@@ -51,7 +56,4 @@ Please, *remember*: In order to "save" the modification we have to hit a commit
 
 **Powirb** is written by [Carlo Pecchia](mailto:info@carlopecchia.eu) and released under the terms of Apache License (see LICENSE file).
 
-
 ----
-
-

data/lib/powirb.rb

@@ -7,6 +7,7 @@ end
 
 require 'powirb/workitem'
 require 'powirb/handler'
+require 'powirb/version'
 require 'logger'
 
 # This module represent a container for Powirb classes.

data/lib/powirb/handler.rb

@@ -14,35 +14,32 @@ class Handler
   # working copy)
   def initialize(project_path)
   	unless File.exist?(project_path)
-	    msg = "Invalid project path '#{project_path}'"  
-	    Powirb.log.error(msg)
-	    raise msg
-	  end
+	  msg = "Invalid project path '#{project_path}'"  
+	  Powirb.log.error(msg)
+	  raise msg
+	end
     @project_path = project_path
-	  Powirb.log.debug("Initialized handler for #{@project_path}")
+	Powirb.log.debug("Initialized handler for #{@project_path}")
 	
-	  @workitems_count = 0
-	  self.workitems_paths.each do |path|
-	    @workitems_count += Dir[File.join(@project_path, path, "/**/workitem.xml")].size
-	  end
-	  Powirb.log.debug("Found #{@workitems_count} workitems.")
+	# workitems are stored in a big hash, indexed by 'wid's
+	@space = {}
+	self.workitems_paths.each do |path|
+      Dir[File.join(@project_path, path, "/**/workitem.xml")].each do |filename|
+	    wid = File.dirname(filename).split(/\//).last
+        @space[wid] = Workitem.new(filename)
+        Powirb.log.debug("Added workitem from #{filename}")
+      end
+	end
+	Powirb.log.debug("Found #{@space.keys.size} workitems.")
   end
-  
+
   # Return all workitems in the project
-  def workitems
-	  tmp = []
-	  self.workitems_paths.each do |path|
-	    Dir[File.join(@project_path, path, "/**/workitem.xml")].each do |filename|
-	      tmp << Workitem.new(filename)
-		    Powirb.log.debug("Added workitem from #{filename}")
-	    end
-	  end
-	  tmp
-  end
-  
-  # Return the number of total workitems found in the project
-  def workitems_count
-    @workitems_count
+  def workitems(conditions=nil)
+    return @space  if conditions.nil?
+	# Return only workitems for which *all* specified conditions are true
+	@space.select do |wid,wi|
+	  conditions.map{|k,v| wi[k] == v}.reduce(:&)
+	end
   end
   
   # Returns the path for workitems in the specified project

data/lib/powirb/version.rb

@@ -1,4 +1,4 @@
 module Powirb
-  VERSION = '1.1'
+  VERSION = '1.2'
 end
 

data/lib/powirb/workitem.rb

@@ -10,51 +10,110 @@ module Powirb
 # Copyright:: Copyright (c) 2011 Carlo Pecchia
 # License:: See LICENSE file
 class Workitem
+  attr_reader :filename
 
   # Create a new instance of a workitem belonging to its representation 
   # in the standard way Polarion does it
   def initialize(filename)
     @filename = filename
-  	Powirb.log.debug("Initializing workitem with #{filename}")
-  end
-  
-  # Read workitem content
-  def read
     Powirb.log.debug("Retrieving workitem from #{@filename}")
     begin
-	    @doc = Nokogiri::XML(open(@filename))
-	  rescue Exception => e
-	    Powirb.log.error(e)
-	  end
+	  @doc = Nokogiri::XML(open(@filename))
+	rescue Exception => e
+	  Powirb.log.error(e)
+	end	
   end
   
   # Return a field value
   def [](fname)
     fname = fname.to_s
     node = @doc.xpath("//field[@id=\"#{fname}\"]")
-	  return nil  if node.text.empty?
-	  node.text
+    return nil  if node.text.empty?
+	node.text
   end
   
-  # Set/remove a field
-  def []=(fname, fvalue)
-    fname = fname.to_s
-    if self[fname].nil?
-	    # inserting new field
-	    Powirb.log.debug("[#{wid}] adding new field '#{fname}' with value '#{fvalue}'")
-	    @doc.xpath('//field[@id="type"]').last.add_next_sibling("\n    <field id=\"#{fname}\">#{fvalue}</field>")
-    else
-	    if fvalue.nil?
-	      # removing existing field
-		    Powirb.log.debug("[#{wid}] removing field '#{fname}'")
-		    @doc.xpath("//field[@id=\"#{fname}\"]").last.remove
-	    else
-	      # updating existing field
-		    Powirb.log.debug("[#{wid}] updating field '#{fname}' with value '#{fvalue}'")
-	      e = @doc.xpath("//field[@id=\"#{fname}\"]").last
-	      e.content = fvalue
-	    end
-	  end
+  # Set/remove a field, optionally is possible to specify a 'type'
+  # eg: wi[:foo] = nil   -> remove the field 'foo'
+  #     wi[:foo] = 'bar' -> add/update the field 'foo'
+  #     wi[:foo] = {:value => 'bar', :type => 'enum:foo'} -> the same as above
+  def []=(f,v)
+    f = f.to_s
+
+	# with a null value we remove and existing field
+	if v.nil?
+	  # Delete
+      Powirb.log.debug("[#{wid}] removing field '#{f}'")
+      @doc.xpath("//field[@id=\"#{f}\"]").last.remove
+	  return
+	end
+	# assert: v is defined (String or Hash)
+	
+	# retrieve the 'value' and the optional 'type'
+	if v.instance_of?(Hash)
+	  value = v[:value]
+	  type  = v[:type]
+	else 
+	  value = v
+	  type  = nil
+	end
+	# assert: 'value' and 'type' are defined
+	
+	if self[f].nil?
+	  # Create: the field is not already present
+      Powirb.log.debug("[#{wid}] adding new field '#{f}' with value '#{value}'")
+	  e = Nokogiri::XML::Node.new('field', @doc)
+	  e['id'] = f
+	  e['type'] = type  unless type.nil?
+	  e.content = value
+	  # we are sure the 'type' field always exists for any workitem, so attach after that
+	  @doc.xpath('//field[@id="type"]').last.add_next_sibling(e)
+	else
+	  # Update: the field is already present
+	  Powirb.log.debug("[#{wid}] updating existing field '#{f}' with value '#{value}'")
+	  e = @doc.xpath("//field[@id=\"#{f}\"]").last
+	  e['type'] = type  unless type.nil?
+	  e.content = value	  
+	end	
+  end
+  
+  
+  # Return the list of linked workitems ['role1:wid1', ..., 'roleN:widN']
+  def links
+	tmp = []
+    @doc.xpath('//field[@id="linkedWorkItems"]/list/struct').each do |struct|
+	  linked_wid = struct.xpath('item[@id="workItem"]').text
+	  role = struct.xpath('item[@id="role"]').text
+	  tmp << "#{role}:#{linked_wid}"
+	end
+	return tmp
+  end
+  
+  # Add a link to another workitem with specified role
+  def add_link(lh)
+    lnk_wid  = lh[:wid]
+	lnk_role = lh[:role]
+	
+	# find or create the attach node
+    if @doc.xpath('//field[@id="linkedWorkItems"]/list').last.nil?
+      Nokogiri::XML::Builder.with(@doc.xpath('//work-item').last) do
+        field(:id => 'linkedWorkItems') {
+	      list {}
+	    }
+      end
+    end
+	
+	# build and attach the link struct
+	Nokogiri::XML::Builder.with(@doc.xpath('//field[@id="linkedWorkItems"]/list').last) do
+	  struct {
+	    item(:id => 'revision')
+		item(:id => 'workItem') {
+		  text lnk_wid
+		}
+		item(:id => 'role') {
+		  text lnk_role
+		}
+	  }
+	end
   end
   
   # Save workitem on filesystem
@@ -76,7 +135,16 @@ class Workitem
   # Return a list with all field names
   def fields
     @doc.xpath("//field").map{|node| node['id']}.sort
-  end  
+  end
+  
+  # Return the "space" under which the workitem lives (tracker xor document)
+  def space
+    if @filename.include?('/.polarion/tracker/')
+	  return 'tracker'
+	else
+	  File.dirname(@filename).split(/\//)[4]
+	end
+  end
 end
 
 end

data/powirb.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "powirb"
-  s.version           = "1.1"
+  s.version           = "1.2"
   s.summary           = "POlarion WorkItems handling with RuBy"
   s.description		  = <<-EOF
   Ruby interface to Polarion workitems content, for fast manipulation.
@@ -11,6 +11,6 @@ EOF
   s.email             = ["info@carlopecchia.eu"]
   s.homepage          = "http://github.com/carlopecchia/powirb"
   s.add_dependency('nokogiri')
-  s.files = ["LICENSE", "README.markdown", "Rakefile", "lib/powirb/handler.rb", "lib/powirb/version.rb", "lib/powirb/workitem.rb", "lib/powirb.rb", "powirb.gemspec", "test/test_helper.rb", "test/test_powirb.rb", "test/test_powirb_handler.rb", "test/test_powirb_workitem.rb"]
+  s.files = ["LICENSE", "README.markdown", "Rakefile", "lib/powirb.rb", "lib/powirb/version.rb", "lib/powirb/handler.rb", "lib/powirb/workitem.rb", "powirb.gemspec", "test/test_helper.rb", "test/test_powirb_workitem.rb", "test/test_powirb.rb", "test/test_powirb_handler.rb"]
 end
 

data/test/test_helper.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'test/unit'
-#require 'ftools'
 require 'fileutils'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'..','lib'))

data/test/test_powirb.rb

@@ -12,4 +12,7 @@ class PowirbTest < Test::Unit::TestCase
 	assert_not_nil Powirb.log
   end
   
+  def test_valid_version
+    assert_not_nil Powirb::VERSION
+  end  
 end

data/test/test_powirb_handler.rb

@@ -19,10 +19,21 @@ class PowirbHandlerTest < Test::Unit::TestCase
 	end
   end
   
+  def test_wired_workitems_sources
+    assert_not_nil @h.workitems_paths
+	assert_kind_of Array, @h.workitems_paths
+  end
+  
   def test_workitems
-    assert_kind_of Array, @h.workitems
-	assert @h.workitems_count == 4
+    assert_kind_of Hash, @h.workitems
 	assert @h.workitems.size == 4
+	
+	assert_equal 1, @h.workitems(:type => 'task').size
+	assert_equal 3, @h.workitems(:type => 'action').size
+	assert_equal 0, @h.workitems(:type => 'fooz').size
+	
+	assert_not_nil @h.workitems['WI-1']
+	assert_nil @h.workitems['non existant wid']	
   end
   
 end

data/test/test_powirb_workitem.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/test_helper'
-require 'Nokogiri'
+#require 'Nokogiri'
 
 class PowirbWorkitemTest < Test::Unit::TestCase
 
@@ -9,11 +9,10 @@ class PowirbWorkitemTest < Test::Unit::TestCase
     FileUtils.rm_rf dst
     FileUtils.cp_r  src, dst
     
-    pp = File.join(File.dirname(__FILE__),'sample_project')
+    @pp = File.join(File.dirname(__FILE__),'sample_project')
 	Powirb.set_logger(:debug,'/dev/null')
-    @h = Powirb::Handler.new(pp)
-	@wi = @h.workitems.first
-	@wi.read
+    @h = Powirb::Handler.new(@pp)
+	@wi = @h.workitems[@h.workitems.keys.first]
   end
   
   def teardown
@@ -36,12 +35,18 @@ class PowirbWorkitemTest < Test::Unit::TestCase
     @wi['foo'] = 'bar'
 	assert @wi['foo'] == 'bar'
 	assert @wi[:foo] == 'bar'
+	
+	@wi['foo'] = {:value => 'new foo', :type => 'enum:fooz'}
+	assert @wi.to_xml.include?("id=\"foo\" type=\"enum:fooz\"")
   end
-  
+
   def test_updating_existing_field
     assert_not_nil @wi['title']
 	@wi['title'] = 'Some silly Title here...'
 	assert @wi['title'] == 'Some silly Title here...'
+	
+	@wi['title'] = {:value => 'new title', :type => 'text/plain'}
+	assert @wi.to_xml.include?("id=\"title\" type=\"text/plain\"")
   end
 
   def test_remove_field
@@ -67,8 +72,8 @@ class PowirbWorkitemTest < Test::Unit::TestCase
 	assert_nil @wi['priority']
 	@wi.save!
 	
-	w = @h.workitems.first
-	w.read
+	h2 = Powirb::Handler.new(@pp)
+	w = h2.workitems[@wi.wid]
     assert_nil w['priority']
   end
   
@@ -84,4 +89,32 @@ class PowirbWorkitemTest < Test::Unit::TestCase
     assert fields.include?('title')
     assert !fields.include?('foo')
   end
+  
+  def test_space
+    assert_not_nil @wi.space
+	assert_kind_of String, @wi.space
+	assert_equal 'tracker', @wi.space
+  end
+  
+  def test_links
+	wi = @h.workitems['WI-2']
+	assert_not_nil wi.links
+	assert_equal 1, wi.links.size
+	assert_equal 'parent:WI-1', wi.links.first
+  end
+  
+  def test_add_link
+    wi1 = @h.workitems['WI-1']
+	assert_not_nil wi1
+	wi2 = @h.workitems['WI-2']
+	assert_not_nil wi2
+	
+    # to empty link set
+	wi1.add_link(:wid => 'WI-2', :role => 'relates_to')
+	assert wi1.links.include?('relates_to:WI-2')
+	
+	# to non empty links set
+	wi2.add_link(:wid => 'WI-1', :role => 'relates_to')
+	assert wi2.links.include?('relates_to:WI-1')
+  end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: powirb
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 1
-  - 1
-  version: "1.1"
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - Carlo Pecchia
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 +02:00
+date: 2011-08-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,15 +44,15 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
-- lib/powirb/handler.rb
+- lib/powirb.rb
 - lib/powirb/version.rb
+- lib/powirb/handler.rb
 - lib/powirb/workitem.rb
-- lib/powirb.rb
 - powirb.gemspec
 - test/test_helper.rb
+- test/test_powirb_workitem.rb
 - test/test_powirb.rb
 - test/test_powirb_handler.rb
-- test/test_powirb_workitem.rb
 has_rdoc: true
 homepage: http://github.com/carlopecchia/powirb
 licenses: []