mingle-macro-development-toolkit 1.0

data/tasks/test.rake

@@ -0,0 +1,15 @@
+namespace :test do |ns|
+
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test/unit"
+    t.pattern = 'test/unit/*_test.rb'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << "test/integration"
+    t.pattern = 'test/integration/*_test.rb'
+    t.verbose = true
+  end
+
+end

data/test/fixtures/sample/card_types.yml

@@ -0,0 +1,29 @@
+--- 
+- name: Story
+  position: 3
+  color: 'ff3300'
+  id: 339
+- name: Defect
+  position: 5
+  color: '000599'
+  id: 340
+- name: Task
+  position: 4
+  color: 'ffe066'
+  id: 341
+- name: Sprint
+  position: 2
+  color: 'ff0db6'
+  id: 342
+- name: Release
+  position: 1
+  color: '990024'
+  id: 343
+- name: Feature
+  position: 6
+  color: '296600'
+  id: 344
+- name: Epic Story
+  position: 7
+  color: '00d91d'
+  id: 345

data/test/fixtures/sample/card_types_property_definitions.yml

@@ -0,0 +1,81 @@
+--- 
+- card_type_id: 342
+  position: 3
+  property_definition_id: 1145
+  id: 2015
+- card_type_id: 341
+  position: 1
+  property_definition_id: 1145
+  id: 2016
+- card_type_id: 341
+  position: 2
+  property_definition_id: 1146
+  id: 2017
+- card_type_id: 341
+  position: 3
+  property_definition_id: 1144
+  id: 2018
+- card_type_id: 341
+  position: 4
+  property_definition_id: 1141
+  id: 2019
+- card_type_id: 341
+  position: 6
+  property_definition_id: 1149
+  id: 2021
+- card_type_id: 341
+  position: 7
+  property_definition_id: 1147
+  id: 2022
+- card_type_id: 340
+  position: 1
+  property_definition_id: 1145
+  id: 2023
+- card_type_id: 340
+  position: 2
+  property_definition_id: 1146
+  id: 2024
+- card_type_id: 340
+  position: 3
+  property_definition_id: 1144
+  id: 2025
+- card_type_id: 340
+  position: 5
+  property_definition_id: 1141
+  id: 2027
+- card_type_id: 340
+  position: 7
+  property_definition_id: 1149
+  id: 2029
+- card_type_id: 339
+  position: 1
+  property_definition_id: 1148
+  id: 2033
+- card_type_id: 339
+  position: 4
+  property_definition_id: 1145
+  id: 2036
+- card_type_id: 339
+  position: 5
+  property_definition_id: 1146
+  id: 2037
+- card_type_id: 339
+  position: 6
+  property_definition_id: 1141
+  id: 2038
+- card_type_id: 339
+  position: 7
+  property_definition_id: 1140
+  id: 2039
+- card_type_id: 339
+  position: 8
+  property_definition_id: 1149
+  id: 2040
+- card_type_id: 339
+  position: 12
+  property_definition_id: 1142
+  id: 2044
+- card_type_id: 339
+  position: 13
+  property_definition_id: 1143
+  id: 2045

data/test/fixtures/sample/project_variables.yml

@@ -0,0 +1,5 @@
+--- 
+- name: Current Release
+  value: 'Release 3'
+- name: Current Sprint
+  value: 'Iteration 7'

data/test/fixtures/sample/projects.yml

@@ -0,0 +1,4 @@
+--- 
+- identifier: scrum_template_2_1
+  id: 78
+  name: scrum_template(2.1)

data/test/fixtures/sample/property_definitions.yml

@@ -0,0 +1,41 @@
+--- 
+- id: 1140
+  name: Status
+  description: ""
+  type_description: Managed text list
+- id: 1141
+  name: Priority
+  description: ""
+  type_description: Managed text list
+- id: 1142
+  name: Development Started On
+  description: ""
+  type_description: Managed text list
+- id: 1143
+  description: ""
+  name: Development Completed On
+  type_description: Date
+- id: 1144
+  description: ""
+  name: Added On
+  type_description: Date
+- id: 1145
+  description: ""
+  name: Estimate - Planning
+  type_description: Formula  
+- id: 1146
+  description: ""
+  name: Risk
+  type_description: Managed text list  
+- id: 1147
+  description: ""
+  name: Task Estimate
+  type_description:  Managed text list
+- id: 1148
+  description: 
+  name: Estimate - Task
+  type_description:  Managed text list
+- id: 1149
+  description: Individual assigned to a work item
+  name: Owner
+  type_description: User  

data/test/fixtures/sample/users.yml

@@ -0,0 +1,16 @@
+---
+- project_id: 78
+  login: groucho
+  name: Groucho Marx
+  version_control_user_name: gmarx
+  email: gmarx@example.com    
+- project_id: 78
+  login: harpo
+  name: Harpo Marx
+  version_control_user_name:
+  email: kmarx@example.com
+- project_id: 78
+  login: karl
+  name: Karl Marx
+  version_control_user_name: kmarx
+  email: kmarx@example.com

data/test/integration/integration_test_helper.rb

@@ -0,0 +1,20 @@
+#Copyright 2008 ThoughtWorks, Inc.  All rights reserved.
+
+require 'test/unit'
+require 'macro_development_toolkit'
+require File.dirname(__FILE__) + '/rest_loader'
+
+class Test::Unit::TestCase
+
+  def project(name)
+    @project ||= RESTfulLoaders::ProjectLoader.new(name, nil, self).project
+  end  
+
+  def errors
+    @errors ||= []
+  end  
+  
+  def alert(message)
+    errors << message
+  end  
+end  

data/test/integration/rest_loader.rb

@@ -0,0 +1,302 @@
+#Copyright 2008 ThoughtWorks, Inc.  All rights reserved.
+
+module RESTfulLoaders
+  class RemoteError < StandardError
+    def self.parse(response_body)
+      Hash.from_xml(response_body)['hash'].delete("message")
+    end  
+  end  
+  
+  class Base
+    def initialize(project_name)
+      @xml_model = if (String === project_name)
+        @project_name = project_name
+        OpenStruct.new(Hash.from_xml(get(project_name)))
+      else
+        project_name
+      end    
+      raise "No such project resource available! #{@project_name}" unless (@xml_model && @xml_model.to_s != '')
+    end
+
+    def get(url)
+      url = URI.parse(url) unless url.respond_to?(:path)
+      get_request = Net::HTTP::Get.new(url.request_uri)
+      get_request.basic_auth(url.user, url.password)
+      response = Net::HTTP.start(url.host, url.port) { |http| http.request(get_request) }
+      if response.code.to_s != "200" 
+        raise RemoteError, RemoteError.parse(response.body)
+      end  
+      response.body
+    end  
+  
+    def load_all_card_types_from_xml
+      extract_array_of 'card_types', :from => @xml_model.project
+    end  
+
+    def load_all_property_definitions_from_xml
+      extract_array_of 'property_definitions', :from => @xml_model.project
+    end  
+
+    def load_all_card_types_property_definitions_from_xml
+      load_all_card_types_from_xml.collect do |card_type_xml| 
+        card_types_property_definitions = OpenStruct.new(card_type_xml).card_types_property_definitions
+        [card_types_property_definitions['card_type_property_definition']].flatten if card_types_property_definitions
+      end.compact.flatten
+    end  
+
+    def card_types_property_definitions_by_card_type_id_loader(card_type_id)
+      LoadCardTypesPropertyDefinitionsByCardTypeId.new(card_type_id, @xml_model)
+    end  
+  
+    def card_types_property_definitions_by_property_definition_id_loader(property_definition_id)
+      LoadCardTypesPropertyDefinitionsByPropertyDefinitionId.new(property_definition_id, @xml_model)
+    end
+  
+    def values_by_property_definition_id_loader(property_definition_id)
+      LoadValuesByPropertyDefinitionId.new(property_definition_id, @xml_model)
+    end  
+
+    def card_type_by_id_loader(card_type_id)
+      LoadCardTypeById.new(card_type_id, @xml_model)
+    end
+  
+    def property_definition_by_id_loader(property_definition_id)
+      LoadPropertyDefinitionById.new(property_definition_id, @xml_model)
+    end
+    
+    def card_types_by_project_id_loader
+      LoadCardTypesByProjectId.new(@xml_model)
+    end  
+
+    def property_definitions_by_project_id_loader
+      LoadPropertyDefinitionsByProjectId.new(@xml_model)
+    end  
+    
+    def team_by_project_id_loader
+      LoadTeamByProjectId.new(@xml_model)
+    end
+    
+    def project_variables_by_project_id_loader
+      LoadProjectVariablesByProjectId.new(@xml_model)
+    end
+    
+    def extract_array_of(container_key, options)
+      contents_hash = options[:from]
+      container = contents_hash[container_key]
+      container ? [container[container_key.singularize]].flatten : []
+    end      
+  end
+
+  class ProjectLoader < Base
+    class MqlExecutionDelegate < SimpleDelegator
+      def initialize(delegate, mql_executor)
+        @mql_executor = mql_executor
+        __setobj__(delegate)
+      end
+      
+      def execute_mql(mql)
+        begin
+          @mql_executor.execute_mql(mql, self)
+        rescue => e
+          __getobj__.send(:add_alert, e.message)
+          []
+        end    
+      end
+      
+      def format_number_with_project_precision(number)
+        begin
+          @mql_executor.format_number_with_project_precision(number, self)
+        rescue => e
+          __getobj__.send(:add_alert, e.message)
+        end    
+      end
+      
+      def format_date_with_project_date_format(date)
+        begin
+          @mql_executor.format_date_with_project_date_format(date, self)
+        rescue => e
+          __getobj__.send(:add_alert, e.message)
+        end    
+      end
+    end  
+
+    def initialize(project_name, macro_context=nil, alert_receiver=nil)
+      super(project_name)
+      @macro_context = macro_context
+      @alert_receiver = alert_receiver
+    end
+      
+    def load_project_from_xml
+      @xml_model.project
+    end  
+    
+    def project
+      project = MqlExecutionDelegate.new(Mingle::Project.new(OpenStruct.new(load_project_from_xml), :alert_receiver => @alert_receiver), self)
+      project.card_types_loader = card_types_by_project_id_loader
+      project.property_definitions_loader = property_definitions_by_project_id_loader
+      project.team_loader = team_by_project_id_loader
+      project.project_variables_loader = project_variables_by_project_id_loader
+      project
+    end
+    
+    def execute_mql(mql, project)
+      from_xml_data(
+        Hash.from_xml(
+          get(
+            build_request_url(:path => "/projects/#{project.identifier}/cards/execute_mql.xml", :query => "mql=#{mql}"))))
+    end
+    
+    def format_number_with_project_precision(number, project)
+      from_xml_data(
+        Hash.from_xml(
+          get(
+            build_request_url(:path => "/projects/#{project.identifier}/cards/format_number_to_project_precision.xml", :query => "number=#{number}"))))
+    end
+    
+    def format_date_with_project_date_format(date, project)  
+      from_xml_data(
+        Hash.from_xml(
+          get(
+            build_request_url(:path => "/projects/#{project.identifier}/cards/format_string_to_date_format.xml", :query => "date=#{date}"))))
+    end
+    
+    def build_request_url(params)
+      url = URI.parse(@project_name)
+      request_class = if url.scheme == 'http'
+        URI::HTTP
+      elsif
+        URI::HTTPS
+      else
+        raise "Unknown protocol used to access project resource #{@project_name}. Supported protocols are HTTP & HTTPS"
+      end  
+      default_params = {:userinfo => "#{url.user}:#{url.password}", :host => url.host, :port => url.port.to_s}      
+      request_class.build2(default_params.merge(params))
+    end  
+    
+    def from_xml_data(data)
+      if data.is_a?(Hash) && data.keys.size == 1
+        from_xml_data(data.values.first)
+      else
+        data
+      end
+    end
+      
+  end
+
+  class LoadCardTypesByProjectId < Base
+    def load
+      load_all_card_types_from_xml.collect do |ct|
+        card_type = Mingle::CardType.new(OpenStruct.new(ct))
+        card_type.card_types_property_definitions_loader = card_types_property_definitions_by_card_type_id_loader(ct['id'])
+        card_type
+      end.sort_by(&:position)
+    end  
+  end
+
+  class LoadPropertyDefinitionsByProjectId < Base
+    def load
+      load_all_property_definitions_from_xml.collect do |pd|
+        property_definition = Mingle::PropertyDefinition.new(OpenStruct.new(pd))
+        property_definition.card_types_property_definitions_loader = card_types_property_definitions_by_property_definition_id_loader(pd['id'])
+        property_definition.values_loader = values_by_property_definition_id_loader(pd['id'])
+        property_definition
+      end
+    end  
+  end
+
+  class LoadCardTypesPropertyDefinitionsByCardTypeId < Base
+    def initialize(card_type_id, fixture_file_name)
+      super(fixture_file_name)
+      @card_type_id = card_type_id
+    end  
+  
+    def load
+      load_all_card_types_property_definitions_from_xml.collect do |ctpd|
+        next unless ctpd['card_type_id'] == @card_type_id
+
+        card_type_property_definition = Mingle::CardTypePropertyDefinition.new(OpenStruct.new(ctpd))
+        card_type_property_definition.card_type_loader = card_type_by_id_loader(ctpd['card_type_id'])
+        card_type_property_definition.property_definition_loader = property_definition_by_id_loader(ctpd['property_definition_id'])
+        card_type_property_definition
+      end.compact.sort_by(&:position).compact
+    end  
+
+  end  
+
+  class LoadCardTypesPropertyDefinitionsByPropertyDefinitionId < Base
+    def initialize(property_definition_id, fixture_file_name)
+      super(fixture_file_name)
+      @property_definition_id = property_definition_id
+    end  
+
+    def load
+      load_all_card_types_property_definitions_from_xml.collect do |ctpd|
+        next unless ctpd['property_definition_id'] == @property_definition_id
+      
+        card_type_property_definition = Mingle::CardTypePropertyDefinition.new(OpenStruct.new(ctpd))
+        card_type_property_definition.card_type_loader = card_type_by_id_loader(ctpd['card_type_id'])
+        card_type_property_definition.property_definition_loader = property_definition_by_id_loader(ctpd['property_definition_id'])
+        card_type_property_definition
+      end.compact.sort_by(&:position).compact
+    end  
+
+  end
+
+  class LoadCardTypeById < Base
+    def initialize(card_type_id, fixture_file_name)
+      super(fixture_file_name)
+      @card_type_id = card_type_id
+    end  
+
+    def load
+      yaml = load_all_card_types_from_xml.detect { |ct| ct['id'] == @card_type_id }
+      ct = Mingle::CardType.new(OpenStruct.new(yaml))
+      ct.card_types_property_definitions_loader = card_types_property_definitions_by_card_type_id_loader(yaml['id'])
+      ct
+    end  
+  end  
+
+  class LoadPropertyDefinitionById < Base
+    def initialize(property_definition_id, fixture_file_name)
+      super(fixture_file_name)
+      @property_definition_id = property_definition_id
+    end
+
+    def load
+      yaml = load_all_property_definitions_from_xml.detect { |pd| pd['id'] == @property_definition_id }
+      pd = Mingle::PropertyDefinition.new(OpenStruct.new(yaml))
+      pd.card_types_property_definitions_loader = card_types_property_definitions_by_property_definition_id_loader(yaml['id'])
+      pd.values_loader = values_by_property_definition_id_loader(yaml['id'])
+      pd
+    end  
+  end
+
+  class LoadValuesByPropertyDefinitionId < Base
+    def initialize(property_definition_id, fixture_file_name)
+      super(fixture_file_name)
+      @property_definition_id = property_definition_id
+    end
+  
+    def load
+      property_definition = load_all_property_definitions_from_xml.detect { |property_definition_xml| property_definition_xml['id'] == @property_definition_id }
+      return unless property_definition
+      extract_array_of('values', :from => property_definition).collect do |property_value_xml| 
+        property_value = Mingle::PropertyValue.new(OpenStruct.new(property_value_xml)) 
+        property_value.property_definition_loader = property_definition_by_id_loader(property_value_xml['property_definition_id'])
+        property_value
+      end.compact
+    end  
+  end
+  
+  class LoadTeamByProjectId < Base
+    def load
+      extract_array_of('users', :from => @xml_model.project).collect { |user| Mingle::User.new(OpenStruct.new(user)) }
+    end  
+  end
+
+  class LoadProjectVariablesByProjectId < Base
+    def load
+      extract_array_of('project_variables', :from => @xml_model.project).collect { |pv| Mingle::ProjectVariable.new(OpenStruct.new(pv)) }
+    end  
+  end
+end