mingle4r 0.4.3 → 0.4.5

data/History.txt

@@ -1,3 +1,13 @@
+0.4.5
+-----
+* fixed card updation
+* user type properties of a card can be set directly either by using the user name or the user id
+* properties of type 'tree relationship' and 'Card' can be updated by giving a number
+
+0.4.4
+-----
+* more bug fixes
+
 0.4.3
 -----
 * Lots of bug fixes

data/README

@@ -108,6 +108,34 @@ m_c.proj_id = 'great_mingle_project'
 card = m_c.project.cards[0]
 card.property_value('Status')
 
+Setting a particular property
+-----------------------------
+
+sets the value of the property. The property name given should be the same as in Mingle.
+Type, name and description should be set directly when creating or updating a card.
+In case of a custom property use the following method. The value given should be one of 
+the values that Mingle accepts in case of a managed list
+
+m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+m_c.proj_id = 'great_mingle_project'
+defect_card = m_c.project.cards.first
+defect_card.property_value('Status', 'Closed')
+defect_card.save
+
+In case of properties of type 'Tree Relatioship property' or 'Card'(properties which link
+to another card) you can should set the property by giving the number of the card. For e.g.
+
+story_card = m_c.projects.cards.find {|c| c.type == 'Story'}.first
+story_card.property_value('Feature', 12)
+story_card.save
+
+In case of properties of type 'Team member' you can either use the user id (not the name or
+the login id, you would have to look at the xml to get the id) or more simply the user name.
+For e.g.
+
+story_card.property_value('Assignee', 'James Bond')
+story_card.save
+
 Creating a card
 ---------------
 
@@ -124,20 +152,6 @@ task = Mingle4r::API::new :name => 'set up Cruise build', :type => 'task',
         :description => 'a basic cruise build needs to be set up so that we can start working'
 task.save => It simply won't work, there is a workaround but rather use as described above.
 
-Setting a particular property
------------------------------
-
-sets the value of the property. The property name given should be the same as in Mingle.
-Type, name and description should be set directly when creating or updating a card.
-In case of a custom property use the following method. The value given should be one of 
-the values that Mingle accepts in case of a managed list
-
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-m_c.proj_id = 'great_mingle_project'
-defect_card = m_c.project.cards.first
-defect_card.property_value('Status', 'Closed')
-defect_card.save
-
 Adding comment to a particular card
 -----------------------------------
 
@@ -274,7 +288,7 @@ gem install mingle4r
 
 (The MIT License)
 
-Copyright (c) 2009 Arusarka Haldar
+Copyright (c) 2010 Arusarka Haldar
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/TODO.txt

@@ -1,13 +1,15 @@
 will be fixed/implemented very soon
 -----------------------------------
 
-* fix updation of card properties
+* write documentation about updating card properties of type 'Card', 'Tree Relationship property'
+  and 'Team member'
+* complete manual QA to ensure/prioritize what needs to be done for card object
+* performance fixes
 
 will be implemented, but not very important for now
 ----------------------------------------------------
 
 * update documentation - write about executing transitions directly on the transition
-* provide a helper method to link to a card
 * write tests for project class
 * implement card_types for a project
 * mingle client should have cards method

data/lib/mingle4r/api/card.rb

@@ -21,13 +21,8 @@ module Mingle4r
       end
 
       module InstanceMethods
-        # so that active resource tries to find by number
-        def id
-          number()
-        end
-        
         def type
-          card_type.name
+          attributes['card_type_name']
         end
         
         def type=(type)
@@ -112,7 +107,8 @@ EOS
         # as the mingle property name. the value is optional
         def property_value(name, val = nil)
           property = properties.detect { |p| p.name == name }
-          val ? property.value = val : property.value
+          val ? set_prop_val(property, val) : property.value
+          # val ? property.value = val : property.value
         end
     
         # Gets the custom properties in the form of an array of hashes with the property names as keys and
@@ -121,9 +117,31 @@ EOS
           properties.map { |p| {p.name => p.value} }
         end
         
+        def encode(options = {})
+          options.merge! :root => 'card'
+          self.class.format.encode(attributes, options)
+        end
+        
         private
+        def set_prop_val(prop, val)
+          val = find_user_id_with_name(val) if(prop.type_description == 'Automatically generated from the team list' && is_not_a_num?(val))
+          prop.value = val
+        end
+        
+        def is_not_a_num?(val)
+          !(val.is_a?(Fixnum))
+        end
+        
+        def find_user_id_with_name(name)
+          set_attributes_for(User)
+          users = User.find(:all)
+          user = users.detect { |mingle_user| mingle_user.user.name == name }
+          user.user.id
+        end
+        
         def set_attributes_for(klass)
-          resource_site  = File.join(self.class.site.to_s, "cards/#{self.number()}").to_s
+          nested_resource_site = File.join(self.class.site.to_s, "cards/#{self.number()}").to_s
+          resource_site  = (klass == User) ? self.class.site.to_s : nested_resource_site
           klass.site     = resource_site
           klass.user     = self.class.user
           klass.password = self.class.password
@@ -146,6 +164,19 @@ EOS
           return @transition_class_set unless val
           @transition_class_set = val
         end
+        
+        def user_class_set(val = nil)
+          return @user_class_set unless val
+          @user_class_set = val
+        end
+      end
+      
+      private
+      # post setup hook
+      def self.on_setup(klass)
+        klass.format = Mingle4r::CardFormat.new
+        klass.primary_key = 'number'
+        klass
       end
     end
   end

data/lib/mingle4r/api/project.rb

@@ -89,6 +89,11 @@ module Mingle4r
       end # module InstanceMethods
 
       extend Mingle4r::CommonClassMethods
+      
+      private
+      def self.on_setup(klass)
+        klass.primary_key = 'identifier'
+      end
     end # class Project
   end # class API
 end

data/lib/mingle4r/api/wiki.rb

@@ -2,6 +2,11 @@ module Mingle4r
   module API
     class Wiki
       extend Mingle4r::CommonClassMethods
+            
+      private
+      def self.on_setup(klass)
+        klass.primary_key = 'identifier'
+      end
     end
   end
 end

data/lib/mingle4r/card_format.rb

@@ -9,10 +9,13 @@ module Mingle4r
     end
     
     def decode(xml)
-      from_xml_data(Hash.from_xml(xml))
+      data = from_xml_data(Hash.from_xml(xml))
+      convert_properties(data)
+      data
     end
     
     def encode(hash, options={})
+      options.merge! :dasherize => false
       hash.to_xml(options)
     end
 
@@ -24,5 +27,61 @@ module Mingle4r
         data
       end
     end
+    
+    def convert_properties(data)
+      types_to_convert = ['Any card used in tree', 'Card',
+        'Automatically generated from the team list']
+      types_to_convert.each { |type| convert_prop_tags_of_type(type, data)}
+      convert_card_type_tag(data)
+    end
+    
+    def for_every_card_in(data, &block)
+      if data.is_a?(Hash)
+        block.call(data)
+      else
+        data.collect! { |card| block.call(card) }
+      end      
+    end
+    
+    def convert_prop_tags_of_type(type, data)
+      for_every_card_in(data) { |card| convert_card_for_prop_tags_of_type(card, type) }
+    end
+    
+    def convert_card_for_prop_tags_of_type(card, type)
+      return card unless card['properties']
+      card['properties'].collect! do |prop|
+        convert_prop(prop) if (prop_is_of_type?(prop, type))
+        prop
+      end
+      card
+    end
+    
+    def convert_prop(prop)
+      if prop_is_of_type?(prop, 'Automatically generated from the team list')
+        prop = convert_team_member_prop(prop)
+      else
+        prop['value'] = prop['value']['number'] if prop['value']
+      end
+      prop
+    end
+    
+    def convert_team_member_prop(prop)
+      return prop unless prop['value']
+      url = prop['value']['url']
+      prop['value'] = File.basename(url).gsub('.xml', '').to_i
+      prop
+    end
+    
+    def prop_is_of_type?(prop, type)
+      prop['type_description'] == type
+    end
+    
+    def convert_card_type_tag(data)
+      for_every_card_in(data) do |card|
+        card_type = card.delete('card_type')
+        card['card_type_name'] = card_type['name']
+        card
+      end
+    end
   end
 end

data/lib/mingle4r/common_class_methods.rb

@@ -88,10 +88,11 @@ module Mingle4r
     end
     
     def setup_class(klass)
-      set_resource_options(klass)
+      set_resource_attributes(klass)
       set_class_name(klass)
       include_instance_methods(klass)
       include_singleton_methods(klass)
+      on_setup(klass) if(respond_to?('on_setup'))
     end
     
     def include_singleton_methods(klass)
@@ -108,7 +109,7 @@ module Mingle4r
       klass
     end
     
-    def set_resource_options(klass)
+    def set_resource_attributes(klass)
       klass.site = self.site
       klass.user = self.user
       klass.password = self.password
@@ -130,7 +131,7 @@ module Mingle4r
     end
     
     def method_missing(meth_id, *args, &block)
-      raise ResourceNotSetup.new("Site is not set for #{name}. Please set it.") unless @resource_class
+      raise ResourceNotSetup.new("Site not set for #{name}.") unless @resource_class
       @resource_class.send(meth_id.to_sym, *args, &block)
     end
   end

data/lib/mingle4r/version.rb

@@ -2,7 +2,7 @@ module Mingle4r
   module Version
     Major = '0'
     Minor = '4'
-    Tiny  = '3'
+    Tiny  = '5'
     
     def self.to_s
       Major + '.' + Minor + '.' + Tiny

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mingle4r
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 4
-  - 3
-  version: 0.4.3
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - asur
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-24 00:00:00 +05:30
+date: 2010-06-02 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: "  A connector wrapper for connecting to Mingle(http://studios.thoughtworks.com/mingle-agile-project-management).\n  It uses active resource to handle the restful connections to Mingle. Makes the job of connecting to Mingle a \n  lot easier. Also since it uses lazy evaluation, resources are fetched only when they are requested.\n"
+description: "  A wrapper connector for connecting to Mingle(http://studios.thoughtworks.com/mingle-agile-project-management).\n  It uses active resource to handle the restful connections to Mingle. Makes the job of connecting to Mingle a \n  lot easier.\n"
 email: arusarka@gmail.com
 executables: []