mingle-macro-development-toolkit 1.1 → 1.2

data/History.txt

@@ -1,4 +1,15 @@
+== 1.2 April 16, 2009
+  
+  * Mingle 2.3 integration
+  * Ability to emit Javascript from a macro 
+  * Fixed RDoc documentation 
+
 == 1.1 April 8, 2009
 
-* 1 bug fix
+  * 1 bug fix
   * Fix project variable value to return the display value. In response to post http://community.thoughtworks.com/posts/462f0f399b
+  * Added documentation
+
+== 1.0 August 1, 2008
+
+  * Initial release

data/README.rdoc

@@ -38,7 +38,7 @@ of fleshing out your macro.
 
 == SUPPORT:
  
-For any issues/clarifications/comments with installation or using this gem, contact us at the Mingle forums[http://studios.thoughtworks.com/discussion/forums/]. You can also get in touch with the ThoughtWorks Studios support
+For any issues/clarifications/comments with installation or using this gem, contact us at the Mingle forums[http://community.thoughtworks.com/pages/home]. You can also get in touch with the ThoughtWorks Studios support
 team over email at support@thoughtworks.com
 
 == LICENSE:

data/example/macro.rb

@@ -7,7 +7,7 @@ class <%= macro_class_name %>
   end
     
   def execute
-    "Customize me and return some HTML"
+    "Customize me and return some HTML/JS"
   end
   
   def can_be_cached?

data/getting_started.txt

@@ -53,7 +53,7 @@ All data that is required to execute the macro is injected into the macro throug
 
 The execute method uses the MQL execution facility that the project class provides, to execute the MQL string that is passed into through the parameters hash. It then formats the results to be a number, and provides that result of the execute command.
 
-For more help on what constitutes valid MQL, you can refer to our help documentation at http://studios.thoughtworks.com/mingle-agile-project-management/2.2/help/mql_reference.html
+For more help on what constitutes valid MQL, you can refer to our help documentation at http://studios.thoughtworks.com/mingle-agile-project-management/2.3/help/mql_reference.html
 
 Writing your own macro
 ----------------------
@@ -125,8 +125,11 @@ class WorkGauge
   
 end
 
-You can output any html source as the result of the macro execution including script tag.
-The following example demonstrates how to embed Google Maps with JavaScript.
+The execute method can return any valid HTML or Javascript content. The ability to emit Javascript content, specifically, can only be used on Mingle version 2.3 and above.
+
+The following example demonstrates how to use the Javascript emission functionality to embed a Google Maps map. 
+
+Note: For this example to work, you will have to supply your own Google Maps API key as a part of the script tag that loads the Google API.
 
 class GoogleMap
 
@@ -161,7 +164,7 @@ class GoogleMap
 end
 
 Long running or integration macros which run on server will result in long page render times. We recommend these sort
-of macros use javascript or JSONP for cross-domain.
+of macros use Javascript (or JSONP) to offload work to the browser.
 
 You can find both simpler and more complex examples in the vendor/plugins/sample_macros directory.
 
@@ -201,7 +204,7 @@ Integration testing your macro
 
 ########################################################NOTE###############################################################
 #                                                                                                                         #
-# IN ORDER TO RUN THE INTEGRATION TESTS, YOU WILL NEED TO TURN ON BASIC AUTHENTICATION FOR THE MINGLE 2.2 SERVER THAT YOU # 
+# IN ORDER TO RUN THE INTEGRATION TESTS, YOU WILL NEED TO TURN ON BASIC AUTHENTICATION FOR THE MINGLE 2.3 SERVER THAT YOU # 
 # ARE GOING TO BE TESTING AGAINST.                                                                                        #
 #                                                                                                                         #
 #########################################################NOTE##############################################################
@@ -232,7 +235,7 @@ end
 
 The skeleton project also has a sample integration test set up for you, which points to a bogus Mingle server, and uses bad credentials. Replace this resource URL with the URL for a deployed instance within your organization. The helper method project(...) which takes the resource URL, loads the data from the XML data obtained from the live instance of Mingle. 
 
-You can see examples of integration tests in the average macro that is packaged with Mingle in the vendor/plugins/average_macro directory. These tests run against a standard template that ships with Mingle2.2, and so you should be able to run them within your organization too, without a problem.
+You can see examples of integration tests in the average macro that is packaged with Mingle in the vendor/plugins/average_macro directory. These tests run against a standard template that ships with Mingle2.3, and so you should be able to run them within your organization too, without a problem.
 
 To run your integration tests, run 
 
@@ -254,6 +257,7 @@ Deploying your macro
 #          DATA THAT PEOPLE WOULD NORMALLY NOT BE AUTHORIZED TO SEE                                                       #
 #     *    LENGTHY CALLS TO EXTERNAL SYSTEMS COULD TIE UP MINGLE RESOURCES AND LEAVE THE APP UNRESPONSIVE                 #
 #     *    SYSTEM CALLS, IF USED, MUST BE INSPECTED AND WELL-UNDERSTOOD PRIOR TO DEPLOYMENT                               #
+#     *    IF THE MACRO EMITS BAD JAVASCRIPT, YOU COULD BREAK BASIC FUNCTIONALITY ON THE MINGLE UI                        #
 #     *    OTHER DATABASE ACTIVITY, SUCH AS TRANSACTION COMMITS, SHOULD BE MONITORED AND AVOIDED                          #
 #                                                                                                                         #
 ######################################################## CAUTION ##########################################################
@@ -263,7 +267,7 @@ To deploy your macro to a locally deployed instance of Mingle, which is running
 
 % rake macro:deploy MINGLE_LOCATION=/path/to/mingle_root
 
-where /path/to/mingle_root is the location where Mingle2.2 is installed. 
+where /path/to/mingle_root is the location where Mingle2.3 is installed. 
 
 * On Windows, this is the location that the installer installed Mingle at
 * On OSX, this will be within the app bundle, at <mingle_application_bundle>/Contents/Resources/app
@@ -279,7 +283,7 @@ Alternatively, you could also copy the folder by hand into the same location.
 #                                                                                                                          #
 #########################################################NOTE###############################################################
 
-This Getting Started file and the mingle-macro-development-toolkit-1.0.gem are owned exclusively by ThoughtWorks, Inc., 
+This Getting Started file and the mingle-macro-development-toolkit-1.2.gem are owned exclusively by ThoughtWorks, Inc., 
 and ThoughtWorks reserves all rights therein.
 
 We believe that it is a sound practice from legal, business and software development perspectives to always provide copyright 

data/lib/macro_development_toolkit.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module MacroDevelopmentToolkit
-  VERSION = '1.1'
+  VERSION = '1.2'
 end
 
 require 'yaml'

data/lib/macro_development_toolkit/mingle/project.rb

@@ -43,9 +43,11 @@ module Mingle
     end
     
     # *accepts*: A valid MQL string. To see what constitutes valid MQL, 
-    # look here[http://studios.thoughtworks.com/mingle-agile-project-management/2.2/help/index.html]
+    # look here[http://studios.thoughtworks.com/mingle-agile-project-management/2.3/help/index.html]
     # 
-    # *returns*: The display value of the PropertyValue(s) that project_variable_name represents
+    # *returns*: An Array of Hashes, in which each Hash represents one row of results from the MQL execution
+    # The keys in the Hash are the names of the properties selected, with spaces and special characters replaced 
+    # with underscores(_). 
     def execute_mql(mql)
       CardQuery.parse(mql, @card_query_options).values
     end
@@ -57,7 +59,7 @@ module Mingle
     # cached.
     #
     # *accepts*: A valid MQL string. To see what constitutes valid MQL, 
-    # look here[http://studios.thoughtworks.com/mingle-agile-project-management/2.2/help/index.html]
+    # look here[http://studios.thoughtworks.com/mingle-agile-project-management/2.3/help/index.html]
     # 
     # *returns*: A boolean indicating whether the data pertaining to the MQL can be cached
     def can_be_cached?(mql)

data/test/fixtures/sample/project_variables.yml

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

data/test/integration/rest_loader_test.rb

@@ -4,11 +4,11 @@ require File.dirname(__FILE__) + '/integration_test_helper.rb'
 
 class RestLoaderTest < Test::Unit::TestCase
   
-  TEST_PROJECT = 'http://bjanakir:p@localhost:8080/lightweight_projects/scrum_template_2_2.xml'
+  TEST_PROJECT = 'http://bjanakir:p@localhost:8080/lightweight_projects/scrum_template_2_3.xml'
   
   def test_should_load_direct_project_attributes_from_correct_fixture
     assert_not_nil project(TEST_PROJECT)
-    assert_equal 'scrum_template_2_2', project(TEST_PROJECT).identifier
+    assert_equal 'scrum_template_2_3', project(TEST_PROJECT).identifier
   end
   
   def test_should_load_first_level_project_associations_from_correct_fixture

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mingle-macro-development-toolkit
 version: !ruby/object:Gem::Version 
-  version: "1.1"
+  version: "1.2"
 platform: ruby
 authors: 
 - ThoughtWorks Inc
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-08 00:00:00 -07:00
+date: 2009-04-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: mingle-macros
-rubygems_version: 1.3.1
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: ""