powirb 1.0

data/LICENSE

@@ -0,0 +1,14 @@
+ Copyright 2011 Carlo Pecchia
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.markdown

@@ -0,0 +1,57 @@
+**Powirb** (*PO*larion *W*ork*I*tems handling with *R*u*B*y) aims to offer a Ruby interface to [Polarion ALM](http://www.polarion.com/)™ workitems content, for fast manipulation.
+
+
+# Installation
+
+    $ gem install powirb
+
+  
+# 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).
+
+I've fonud extremely valuable and fast to do all this operation in [CLI](http://en.wikipedia.org/wiki/Command-line_interface) with ruby.
+
+
+# Examples
+
+First, we need a working copy of the project repository. Usually this live under something like  http://yourpolarionserver/repo/ProjectName
+
+Only basic operation on workitems are implemented, see the example above:
+
+	#!/usr/bin/env ruby
+
+	require 'rubygems'
+	require 'powirb'
+
+	# Set a logger level, on a specified filename (default is STDOUT)
+	Powirb.set_logger(:debug, 'log.txt')
+
+	# 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
+	end
+
+Please, *remember*: In order to "save" the modification we have to hit a commit with subversion.
+
+
+# Notes
+
+* it does work with Polarion 2011
+* it does **not** support the "old" *LiveDoc* technology
+* the actual version was tested under Linux and Mac OS X only
+
+
+# Author
+
+**Powirb** is written by [Carlo Pecchia](mailto:info@carlopecchia.eu) and released under the terms of Apache License (see LICENSE file).
+
+
+----
+
+

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'rake'
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'powirb/version'
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Powirb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+
+desc "Build gem for release"
+task :build do
+  system "erb powirb.gemspec.erb > powirb.gemspec"
+  system "gem build powirb.gemspec"
+end
+ 
+desc "Release gem to RubyGems.org"
+task :release => :build do
+  #system "gem push powirb-#{Powirb::VERSION}"
+end

data/lib/powirb/handler.rb

@@ -0,0 +1,55 @@
+
+module Powirb
+
+# This class represent the workitems handler, that is an "iterator"
+# over workitems in the same projects.
+#
+# Author:: Carlo Pecchia (mailto:info@carlopecchia.eu)
+# Copyright:: Copyright (c) 2011 Carlo Pecchia
+# License:: See LICENSE file
+class Handler
+  attr_reader :project_path
+
+  # Initialize the handler with the project path (usually a subversion
+  # working copy)
+  def initialize(project_path)
+	unless File.exist?(project_path)
+	  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}")
+	
+	@workitems_count = 0
+	self.workitems_paths.each do |path|
+	  @workitems_count += Dir[@project_path + path + "/**/workitem.xml"].size
+	end
+	Powirb.log.debug("Found #{@workitems_count} workitems.")
+  end
+  
+  # Return all workitems in the project
+  def workitems
+	tmp = []
+	self.workitems_paths.each do |path|
+	  Dir[@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
+  end
+  
+  # Returns the path for workitems in the specified project
+  def workitems_paths
+    ["/.polarion/tracker/workitems", "/modules/**/workitems"]
+  end
+end
+
+end
+

data/lib/powirb/version.rb

@@ -0,0 +1,4 @@
+module Powirb
+  VERSION = '1.0'
+end
+

data/lib/powirb/workitem.rb

@@ -0,0 +1,73 @@
+require 'nokogiri'
+
+module Powirb
+
+# This class represent a workitem instance, that is serialized in a XML
+# file under Polarion subversion repository (for us - more conveniently - 
+# a working copy of it).
+#
+# Author:: Carlo Pecchia (mailto:info@carlopecchia.eu)
+# Copyright:: Copyright (c) 2011 Carlo Pecchia
+# License:: See LICENSE file
+class Workitem
+
+  # 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
+  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
+  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
+  end
+  
+  # Save workitem on filesystem
+  def save!
+    Powirb.log.debug("[#{wid}] saving on #{@filename}")
+    File.open(@filename, 'w+') {|io| io.puts @doc}
+  end
+  
+  # Return workitem ID
+  def wid
+    File.basename(File.dirname(@filename))
+  end
+end
+
+end
+

data/lib/powirb.rb

@@ -0,0 +1,53 @@
+
+$:.unshift(File.dirname(__FILE__))
+
+Dir.glob(File.join('..','vendor','gems','*','lib')).each do |lib|
+  $:.unshift(File.expand_path(lib))
+end
+
+require 'powirb/workitem'
+require 'powirb/handler'
+require 'logger'
+
+# This module represent a container for Powirb classes.
+#
+# Author:: Carlo Pecchia (mailto:info@carlopecchia.eu)
+# Copyright:: Copyright (c) 2011 Carlo Pecchia
+# License:: See LICENSE file
+module Powirb
+
+  # Set the logger used for all classes under Powirb module.
+  #
+  # +level+ debug, info, warn (default), error, fatal
+  #
+  # +filename+ if not specified STDOUT is used
+  def self.set_logger(level, filename=STDOUT)
+    @logger = Logger.new(filename)
+	@logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+	@logger.level = case level.to_s
+	  when 'debug'
+		Logger::DEBUG
+	  when 'info'
+		Logger::INFO
+	  when 'warn'
+		Logger::WARN
+	  when 'error'
+		Logger::ERROR
+	  when 'fatal'
+		Logger::FATAL
+	  else
+	    Logger::WARN
+	end	
+  end
+  
+  # we have to provide a default logger
+  self.set_logger(:warn)
+  
+  # Provide access to internal Logger instance.
+  # Usual classes are used: fatal, error, warn, info, debug
+  #
+  # eg: <tt>Powirb.log.warn("message here...")</tt>
+  def self.log
+    @logger
+  end
+end

data/powirb.gemspec

@@ -0,0 +1,15 @@
+
+Gem::Specification.new do |s|
+  s.name              = "powirb"
+  s.version           = "1.0"
+  s.summary           = "POlarion WorkItems handling with RuBy"
+  s.description		  = <<-EOF
+  Ruby interface to Polarion workitems content, for fast manipulation.
+EOF
+  s.authors           = ["Carlo Pecchia"]
+  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"]
+end
+

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+#require 'ftools'
+require 'fileutils'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'..','lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'powirb'
+
+class Test::Unit::TestCase
+  def test_true
+    assert true
+  end
+end

data/test/test_powirb.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+
+class PowirbTest < Test::Unit::TestCase
+
+  def test_valid_default_logger
+    assert_not_nil Powirb.log
+  end
+
+  def test_valid_logger
+	Powirb.set_logger(:debug)
+	assert_not_nil Powirb.log
+  end
+  
+end

data/test/test_powirb_handler.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+
+class PowirbHandlerTest < Test::Unit::TestCase
+
+  def setup
+    pp = File.join(File.dirname(__FILE__),'_sample_project')
+	Powirb.set_logger(:debug,'/dev/null')
+    @h = Powirb::Handler.new(pp)
+  end
+  
+  def test_valid_handler
+	assert_not_nil @h
+  end
+  
+  def test_invalid_project_path
+	assert_raise RuntimeError do
+		assert_nil Powirb::Handler.new(File.join('s0m3','n0n','ex1st3nt','p4thn4m3'))
+	end
+  end
+  
+  def test_workitems
+    assert_kind_of Array, @h.workitems
+	assert @h.workitems_count == 4
+	assert @h.workitems.size == 4
+  end
+  
+end

data/test/test_powirb_workitem.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class PowirbWorkitemTest < Test::Unit::TestCase
+
+  def setup
+    src = File.join(File.dirname(__FILE__), '_sample_project')
+    dst = File.join(File.dirname(__FILE__), 'sample_project')
+    FileUtils.rm_rf dst
+    FileUtils.cp_r  src, dst
+    
+    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
+  end
+  
+  def teardown
+    FileUtils.rm_rf File.join(File.dirname(__FILE__), 'sample_project')
+  end
+  
+  def test_valid_workitem
+	assert_not_nil @wi
+	assert_kind_of Powirb::Workitem, @wi
+  end
+
+  def test_wid
+    assert_not_nil @wi.wid
+	assert_match /(\w+)\-(\d+)/, @wi.wid
+  end
+  
+  def test_add_field
+	assert_nil @wi['foo']
+	assert_nil @wi[:foo]
+    @wi['foo'] = 'bar'
+	assert @wi['foo'] == 'bar'
+	assert @wi[:foo] == 'bar'
+  end
+  
+  def test_updating_existing_field
+    assert_not_nil @wi['title']
+	@wi['title'] = 'Some silly Title here...'
+	assert @wi['title'] == 'Some silly Title here...'
+  end
+
+  def test_remove_field
+    assert_not_nil @wi['priority']
+	@wi['priority'] = nil
+	assert_nil @wi['priority']
+  end
+
+  def test_change_field_name
+    value = @wi['priority']
+    assert_not_nil value
+
+	@wi['extimatedPriority'] = value
+	@wi['priority'] = nil
+	
+	assert_nil @wi['priority']
+	assert @wi['extimatedPriority'] == value
+  end
+  
+  def test_save
+    assert_not_nil @wi['priority']
+	@wi['priority'] = nil
+	assert_nil @wi['priority']
+	@wi.save!
+	
+	w = @h.workitems.first
+	w.read
+    assert_nil w['priority']
+  end
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: powirb
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Carlo Pecchia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "  Ruby interface to Polarion workitems content, for fast manipulation.\n"
+email: 
+- info@carlopecchia.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+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
+has_rdoc: true
+homepage: http://github.com/carlopecchia/powirb
+licenses: []
+
+post_install_message: 
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: POlarion WorkItems handling with RuBy
+test_files: []
+