mingle-macro-development-toolkit 1.0 → 1.1

data/History.txt

@@ -0,0 +1,4 @@
+== 1.1 April 8, 2009
+
+* 1 bug fix
+  * Fix project variable value to return the display value. In response to post http://community.thoughtworks.com/posts/462f0f399b

data/README.rdoc

@@ -23,7 +23,7 @@ The preferred method of installing the Macro Development Toolkit is through its
 RubyGems[http://www.rubygems.org/] installed for that, though. If you have it,
 then use:
 
-  % [sudo] gem install macro_development_toolkit-1.0.gem
+  % [sudo] gem install mingle-macro-development-toolkit
 
 == GETTING STARTED:
 
@@ -63,4 +63,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/bin/new_mingle_macro

@@ -15,7 +15,7 @@ def print_usage
     
     Usage: new_mingle_macro <macro_name> [macro_class_name]
     
-    macro_name      : The name of your new macro. Should be aplphabetic, possibly including underscores(_)
+    macro_name      : The name of your new macro. Should be alphabetic, possibly including underscores(_)
     macro_class_name: (optional) The name of the class that implements the macro. Should be a CamelCased alphabetic string. Defaults to CamelCased version of macro_name.
     
   EOS
@@ -34,11 +34,11 @@ if macro_name !~ /^[_A-Za-z]+$/
   macro_name = macro_name.gsub(/[^_A-Za-z]/, '_').squeeze('_')
 end
 
-macro_class_name = ARGV[1] || macro_name.gsub(/\W/, '_').classify
-if macro_class_name.classify != macro_class_name
-  print "Your macro class name is not a valid class name. Continue with the default class name of #{macro_name.classify}? [Yes/No]"
+macro_class_name = ARGV[1] || macro_name.gsub(/\W/, '_').camelize
+if macro_class_name.camelize != macro_class_name
+  print "Your macro class name is not a valid class name. Continue with the default class name of #{macro_name.camelize}? [Yes/No]"
   exit if STDIN.gets.downcase =~ /^n/
-  macro_class_name = macro_name.classify
+  macro_class_name = macro_name.camelize
 end
 
 if File.exists?(macro_name)

data/example/integration_test.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + '/integration_test_helper.rb'
 
+# The Mingle API supports basic authentication and must be used in order to run integration tests. However it is disabled in the default configuration. To enable basic authentication, you need set the basic_authentication_enabled configuration option to true in the Mingle data directory/config/auth_config.yml file where Mingle data directory is the path to the mingle data directory on your installation e.g.basic_authentication_enabled: true.
+
 class <%= macro_class_name %>IntegrationTest < Test::Unit::TestCase
   
   PROJECT_RESOURCE = 'http://username:password@your.mingle.server:port/lightweight_projects/your_project_identifier.xml'

data/getting_started.txt

@@ -125,6 +125,44 @@ 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.
+
+class GoogleMap
+
+  def initialize(parameters, project, current_user)
+    @latitude = parameters['latitude'] || 39.55
+    @longitude = parameters['longitude'] || 116.25
+    @zoom_level = parameters['zoom_level'] || 8
+  end
+
+  def execute
+    <<-HTML
+    h2. Google Maps JavaScript API Example: Simple Map
+    
+    <div id="map_canvas" style="width: 600px; height: 400px"></div>
+    <script src="http://maps.google.com/maps?file=api" type="text/javascript"></script>
+    <script type="text/javascript">
+      // register the initialize function for executing after page loaded.
+      MingleJavascript.register(function initialize() {
+        if (GBrowserIsCompatible()) {
+          var map = new GMap2(document.getElementById("map_canvas"));
+          map.setCenter(new GLatLng(#{@latitude}, #{@longitude}), #{@zoom_level});
+        }
+      })
+    </script>
+    HTML
+  end
+
+  def can_be_cached?
+    false  # if appropriate, switch to true once you move your macro to production
+  end
+    
+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.
+
 You can find both simpler and more complex examples in the vendor/plugins/sample_macros directory.
 
 Unit testing your macro

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.0'
+  VERSION = '1.1'
 end
 
 require 'yaml'

data/lib/macro_development_toolkit/mingle/project.rb

@@ -50,6 +50,20 @@ module Mingle
       CardQuery.parse(mql, @card_query_options).values
     end
     
+    # The macros on a page determine whether the page content is cached.  Macros that use certain MQL concepts
+    # (for example TODAY, CURRENT USER, or cross-project functionality) should report that they cannot be
+    # cached so that the page they are on is not cached.  This method indicates whether a MQL query uses
+    # those concepts, and can be used by a macro to determine whether or not to report that it should be
+    # 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]
+    # 
+    # *returns*: A boolean indicating whether the data pertaining to the MQL can be cached
+    def can_be_cached?(mql)
+      CardQuery.parse(mql, @card_query_options).can_be_cached?
+    end
+    
     # *returns*: The full list of Users who are members of this project
     def team
       @team_loader.load

data/lib/macro_development_toolkit/mingle/project_variable.rb

@@ -16,7 +16,7 @@ module Mingle
   
     # *returns*: The display value of the value configured for this project variable
     def value
-      @full_project_variable.value
+      @full_project_variable.display_value
     end
   end
   

data/test/integration/rest_loader.rb

@@ -95,28 +95,29 @@ module RESTfulLoaders
       end
       
       def execute_mql(mql)
-        begin
-          @mql_executor.execute_mql(mql, self)
-        rescue => e
-          __getobj__.send(:add_alert, e.message)
-          []
-        end    
+        @mql_executor.execute_mql(mql, self)
+      rescue => e
+        __getobj__.send(:add_alert, e.message)
+        []
+      end
+      
+      def can_be_cached?(mql)
+        @mql_executor.can_be_cached?(mql, self)
+      rescue => e
+        __getobj__.send(:add_alert, e.message)
+        []
       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    
+        @mql_executor.format_number_with_project_precision(number, self)
+      rescue => e
+        __getobj__.send(:add_alert, e.message)
       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    
+        @mql_executor.format_date_with_project_date_format(date, self)
+      rescue => e
+        __getobj__.send(:add_alert, e.message)
       end
     end  
 
@@ -146,6 +147,13 @@ module RESTfulLoaders
             build_request_url(:path => "/projects/#{project.identifier}/cards/execute_mql.xml", :query => "mql=#{mql}"))))
     end
     
+    def can_be_cached?(mql, project)
+      from_xml_data(
+        Hash.from_xml(
+          get(
+          build_request_url(:path => "/projects/#{project.identifier}/cards/can_be_cached.xml", :query => "mql=#{mql}"))))
+    end
+    
     def format_number_with_project_precision(number, project)
       from_xml_data(
         Hash.from_xml(

data/test/integration/rest_loader_test.rb

@@ -83,4 +83,9 @@ class RestLoaderTest < Test::Unit::TestCase
     assert_raise(RuntimeError) { added_on.values }
   end  
   
+  def test_should_tell_whether_mql_query_is_cacheable
+    assert project(TEST_PROJECT).can_be_cached?("SELECT 'Estimate - planning'")
+    assert_equal false, project(TEST_PROJECT).can_be_cached?("SELECT 'Estimate - planning' WHERE 'Added On' IS TODAY")
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mingle-macro-development-toolkit
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: "1.1"
 platform: ruby
 authors: 
 - ThoughtWorks Inc
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-08 00:00:00 -08:00
+date: 2009-04-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,10 +43,12 @@ extra_rdoc_files:
 - getting_started.txt
 - README.rdoc
 - LICENSE.txt
+- History.txt
 files: 
 - getting_started.txt
 - README.rdoc
 - LICENSE.txt
+- History.txt
 - Rakefile
 - lib/macro_development_toolkit.rb
 - lib/macro_development_toolkit/mingle/card_type_property_definition.rb
@@ -102,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: mingle-macros
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: ""