mingle-macro-development-toolkit 1.3.3 → 2.0.0

data/{History.txt → History}

@@ -1,3 +1,14 @@
+== 2.0.0 April 2012
+
+ * 1.3.4 was meant to be a major version update, sorry for the inconvenience caused.
+ * This version will generate macros that work with the upcoming Mingle 12.1 release.
+ * To work with older Mingle versions, you can use 1.3.3 version.
+
+== 1.3.4 April 2012
+
+  * Minor bug fix
+  * Code refactoring
+
 == 1.3.3 January 2011
 
   * Minor bug fix

data/{README.txt → README}

@@ -1,11 +1,13 @@
 = Macro Development Toolkit - supporting development of custom macros for Mingle
 
-http://mingle-macros.rubyforge.org/
+https://github.com/ThoughtWorksStudios/mingle_macro_development_toolkit
+
+NOTE: This new version will only work with upcoming Mingle 12.1 release and later. For older versions of Mingle, please use version 1.3.3
 
 This toolkit provides support for developing, testing and deploying custom Mingle macros.
 
 Use the built in generator to create a skeleton of a plugin which you can then deploy to an instance of Mingle running
-version 2.2 or later of the software.
+version 12.1 or later of the software.
 
 This allows you to take advantage of free charting utilities such as the Google Charts API, to create
 new visualizations, specific to your project or organization.

data/Rakefile

@@ -1,40 +1,15 @@
-#Copyright 2009 ThoughtWorks, Inc.  All rights reserved.
-
-begin
-  require 'rubygems'
-  
-  unless Gem::RubyGemsVersion >= '1.2.0'
-    $stderr.puts %(Rails requires RubyGems >= 1.2.0 (you have #{rubygems_version}). Please `gem update --system` and try again.)
-    exit 1
-  end
-
-rescue LoadError
-  $stderr.puts %(Rails requires RubyGems >= 1.2.0. Please install RubyGems and try again: http://rubygems.rubyforge.org)
-  exit 1
-end
-
-%w[rake rake/clean rake/testtask  fileutils].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/macro_development_toolkit'
-
-
-%w[newgem rubigen hoe].each { |f| require f }
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec('mingle-macro-development-toolkit') do |p|
-  p.version = MacroDevelopmentToolkit::VERSION
-  p.developer('ThoughtWorks Inc', 'support@thoughtworks.com')
-  p.post_install_message = 'getting_started.txt'
-  p.rubyforge_name       = 'mingle-macros'
-  p.extra_deps         = [
-    ['activesupport','2.3.5'],
-  ]
-  p.summary = "This toolkit provides support for developing, testing and deploying custom Mingle macros."
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = ''
-  p.rsync_args = '-av --delete --ignore-errors'
-end
-require 'newgem/tasks'
-
-Dir['tasks/**/*.rake'].each { |t| load t }
+require "rake/testtask"
+
+namespace :test do
+  Rake::TestTask.new(:unit) 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/bin/new_mingle_macro

@@ -1,151 +1,39 @@
-#!/usr/bin/env ruby
-#Copyright 2011 ThoughtWorks, Inc.  All rights reserved.
- 
-module NewMingleMacro
-  module Messages
-    USAGE = <<-USAGE
-Macro name cannot be blank.
+#!/usr/bin/env ruby -rubygems -w
 
-Usage: new_mingle_macro <macro_name> [macro_class_name]
+require "fileutils"
+require 'thread'
+require 'active_support'
+require "erb"
+
+USAGE = <<-USAGE
+Usage: new_mingle_macro <macro_name>
 
 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. We highly recommend setting
-                  your own class name with an appropriate namespace to avoid 
-                  collisions with standard libraries or Mingle classes.
 USAGE
-    
-    SPECIAL_CHARACTER_REPLACEMENT_MESSAGE = <<-SPECIAL_CHARACTER_REPLACEMENT_MESSAGE
-Your macro name contains special characters that will be replaced with 
-underscores (_). Is this OK? [Yes/No]"
-SPECIAL_CHARACTER_REPLACEMENT_MESSAGE
 
-  AUTO_GENERATED_CLASS_NAME_MESSAGE = <<-AUTO_GENERATED_CLASS_NAME_MESSAGE
-Succeeded with warnings: You did not provide a class name for your macro. A class name has been generated
-for you. This name should be considered a guide and we highly recommend naming your own 
-classes name with appropriate namespaces to avoid collisions with standard libraries
-or Mingle classes. Please run this tool with no command-line arguments to learn
-how to provide a class name.
-AUTO_GENERATED_CLASS_NAME_MESSAGE
-  end
-end
+macro_name = ARGV[0]
+raise "Macro name is required!\n" + USAGE if macro_name.blank?
+raise "Invalid macro name!\n" + USAGE if macro_name !~ /^[a-z]([a-z0-9_]+)?/i
 
-require 'erb'
-require 'fileutils'
-begin
-  require 'active_support/all'
-rescue LoadError
-  require 'rubygems'
-  require 'active_support/all'
-end
+macro_class_name = macro_name.downcase.camelcase
 
-require 'active_support/version'
-REQUIRED_ACTIVE_SUPPORT_VERSION = '2.3.5'
-unless ActiveSupport::VERSION::STRING == REQUIRED_ACTIVE_SUPPORT_VERSION
-  raise "For guaranteed compatibility with Mingle, you must develop macros using ActiveSupport #{REQUIRED_ACTIVE_SUPPORT_VERSION}.  You are using version #{ActiveSupport::VERSION::STRING}" 
-end
-
-def print_usage
-  puts NewMingleMacro::Messages::USAGE
-end
+destination = File.expand_path(macro_name)
+raise "#{destination} already exists!" if File.exists? destination
 
-if ARGV[0].blank?
-  print_usage
-  exit!
-end
-
-def read_macro_name
-  result = ARGV[0].downcase.gsub(/\s/, '_')
-  if result !~ /^[_A-Za-z]+$/
-    print NewMingleMacro::Messages::SPECIAL_CHARACTER_REPLACEMENT_MESSAGE
-    exit if STDIN.gets.downcase =~ /^n/
-    result = result.gsub(/[^_A-Za-z]/, '_').squeeze('_')
-  end
-  result
-end
-
-def read_or_generate_macro_class_name(macro_name)
-  if ARGV[1]
-    ARGV[1]
-  else
-    puts NewMingleMacro::Messages::AUTO_GENERATED_CLASS_NAME_MESSAGE
-    macro_name.gsub(/\W/, '_').camelize
-  end
-end
+FileUtils.mkdir destination
 
-def validate_class_name(macro_class_name)
-  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.camelize
+Dir.chdir(File.join(File.dirname(__FILE__), "..", "templates")) do
+  Dir.glob("**/*").each do |f|
+    next if File.directory? f
+    output = File.join(destination, f)
+    FileUtils.mkdir_p(File.dirname(output))
+    File.open(output, 'w').write(ERB.new(File.read(f), nil, '-').result(binding))
   end
-  macro_class_name
-end
-
-macro_name = read_macro_name
-macro_class_name = validate_class_name(read_or_generate_macro_class_name(macro_name))
-
-if File.exists?(macro_name)
-  print "Folder #{macro_name} already exists in your current directory. Either rename the macro or delete the folder and then execute this command to continue."
-  exit
 end
 
-class Path
-  def initialize(location=:gem)
-    @base_location = if location.to_s == 'gem'
-      File.expand_path(File.join(File.dirname(__FILE__), '..'))
-    else
-      File.expand_path(location)
-    end    
-      
-  end
-  
-  def /(another_fragment)
-    self.class.new(File.join(@base_location, another_fragment))
-  end  
-  
-  def cp(options = {:to => nil, :r => true})
-    if options[:r]
-      FileUtils.cp(@base_location, options[:to].to_s, :verbose => false)
-    else
-      FileUtils.cp_r(@base_location, options[:to].to_s, :verbose => false)
-    end    
-  end
-  
-  def mkdir_p
-    FileUtils.mkdir_p(@base_location)
-  end  
-
-  def to_s
-    @base_location
-  end
-end  
-
-gem_dir = Path.new(:gem)
-macro_dir = Path.new(macro_name)
-
-[macro_dir/'lib', macro_dir/'test'/'unit', macro_dir/'test'/'fixtures', macro_dir/'test'/'integration', macro_dir/'tasks'].each(&:mkdir_p)
-
-(gem_dir/'test'/'fixtures'/'sample').cp :to => macro_dir/'test'/'fixtures'
-(gem_dir/'test'/'unit'/'fixture_loader.rb').cp :to => macro_dir/'test'/'unit'/'fixture_loader.rb'
-(gem_dir/'test'/'integration'/'rest_loader.rb').cp :to => macro_dir/'test'/'integration'/'rest_loader.rb'
-(gem_dir/'tasks'/'test.rake').cp :to => macro_dir/'tasks'/'test.rake'
-(gem_dir/'example'/'deploy.rake').cp :to => macro_dir/'tasks'/'deploy.rake'
-(gem_dir/'getting_started.txt').cp :to => macro_dir/'getting_started.txt'
-
-templates = {
-  gem_dir/'example'/'Rakefile' => macro_dir/'Rakefile',
-  gem_dir/'example'/'init.rb' => macro_dir/'init.rb',
-  gem_dir/'example'/'macro.rb' => macro_dir/'lib'/"#{macro_name}.rb",
-  gem_dir/'example'/'unit_test.rb' => macro_dir/'test'/'unit'/"#{macro_name}_test.rb",
-  gem_dir/'example'/'unit_test_helper.rb' => macro_dir/'test'/'unit'/'unit_test_helper.rb',
-  gem_dir/'example'/'integration_test.rb' => macro_dir/'test'/'integration'/"#{macro_name}_integration_test.rb",
-  gem_dir/'example'/'integration_test_helper.rb' => macro_dir/'test'/'integration'/'integration_test_helper.rb'
-}
-
-templates.each do |template, output|
-  template_file = File.open(template.to_s)
-  File.open(output.to_s, 'w').write(ERB.new(template_file.read, nil, '-').result(binding))
+Dir.chdir(destination) do
+  FileUtils.mv("lib/macro.rb", File.join("lib", "#{macro_name}.rb"))
+  FileUtils.mv("test/unit/unit_test.rb", File.join("test", "unit", "#{macro_name}_test.rb"))
+  FileUtils.mv("test/integration/integration_test.rb", File.join("test", "integration", "#{macro_name}_integration_test.rb"))
 end

data/lib/mingle_macro_development_toolkit.rb

@@ -0,0 +1,4 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+require "rubygems"
+require 'mingle_macro_models'
+require "mingle_macro_development_toolkit/loaders"

data/lib/mingle_macro_development_toolkit/loaders.rb

@@ -0,0 +1,5 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+
+Dir.glob(File.join(File.dirname(__FILE__), "loaders", "**/*.rb")).each do |file|
+  require file
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/base.rb

@@ -0,0 +1,19 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+require "yaml"
+
+module FixtureLoaders
+  class Base
+    def initialize(attributes)
+      @attributes = attributes
+    end
+    
+    def load_fixtures_for(name)
+      path = File.join(FixtureLoaders::FIXTURE_PATH, "#{name}.yml")
+      YAML::load(File.read(path))
+    end
+    
+    def match?(record)
+      @attributes.all? { |key, value| value == record[key] }
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/card_type_loader.rb

@@ -0,0 +1,15 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class CardTypeLoader < Base
+    def card_type
+      @card_type ||= load
+    end
+
+    def load
+      record = load_fixtures_for('card_types').find {|ct| match?(ct)}
+      card_type = Mingle::CardType.new(OpenStruct.new(record))
+      card_type.card_types_property_definitions_loader = CardTypesPropertyDefinitionsLoader.new('card_type_id' => record['id'])
+      card_type
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/card_types_loader.rb

@@ -0,0 +1,10 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class CardTypesLoader < Base
+    def load
+      load_fixtures_for('card_types').collect do |ct|
+        CardTypeLoader.new('id' => ct['id']) if match?(ct)
+      end.compact.sort_by { |loader| loader.card_type.position }
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/card_types_property_definitions_loader.rb

@@ -0,0 +1,12 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class CardTypesPropertyDefinitionsLoader < Base
+    def load
+      load_fixtures_for('property_type_mappings').collect do |mapping|
+        pd = PropertyDefinitionLoader.new('id' => mapping['property_definition_id']) if match?(mapping)
+        ct = CardTypeLoader.new('id' => mapping['card_type_id']) if match?(mapping)
+        OpenStruct.new(:card_type => ct.load, :property_definition => pd.load) if ct && pd
+      end.compact
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/project_loader.rb

@@ -0,0 +1,16 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+require "ostruct"
+
+module FixtureLoaders
+  class ProjectLoader < Base
+    attr_reader :project
+    def initialize(identifier)
+      project_attributes = load_fixtures_for('projects').detect {|project| project['identifier'] == identifier }
+      @project = Mingle::Project.new(OpenStruct.new(project_attributes), nil)
+      project.card_types_loader = CardTypesLoader.new('project_id' => project_attributes['id'])
+      project.property_definitions_loader = PropertyDefinitionsLoader.new('project_id' => project_attributes['id'])
+      project.team_loader = TeamLoader.new('project_id' => project_attributes['id'])
+      project.project_variables_loader = ProjectVariablesLoader.new('project_id' => project_attributes['id'])
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/project_variables_loader.rb

@@ -0,0 +1,10 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class ProjectVariablesLoader < Base
+    def load
+      load_fixtures_for('project_variables').collect do |pv|
+        Mingle::ProjectVariable.new(OpenStruct.new(pv)) if match?(pv)
+      end.compact
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/property_definition_loader.rb

@@ -0,0 +1,16 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class PropertyDefinitionLoader < Base
+    def property_definition
+      @property_definition ||= load
+    end
+
+    def load
+      record = load_fixtures_for('property_definitions').find { |pd| match?(pd)}
+      property_definition = Mingle::PropertyDefinition.new(OpenStruct.new(record))
+      property_definition.card_types_property_definitions_loader = CardTypesPropertyDefinitionsLoader.new('property_definition_id' => record['id'])
+      property_definition.values_loader = PropertyValuesLoader.new('property_definition_id' => record['id'])
+      property_definition
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/property_definitions_loader.rb

@@ -0,0 +1,10 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class PropertyDefinitionsLoader < Base
+    def load
+      load_fixtures_for('property_definitions').collect do |pd|
+        PropertyDefinitionLoader.new('id' => pd['id']) if match?(pd)
+      end.compact
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/property_values_loader.rb

@@ -0,0 +1,10 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class PropertyValuesLoader < Base
+    def load
+      load_fixtures_for('property_values').collect do |pv|
+        Mingle::PropertyValue.new(OpenStruct.new(pv)) if match?(pv)
+      end.compact
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/fixture_loaders/team_loader.rb

@@ -0,0 +1,10 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+module FixtureLoaders
+  class TeamLoader < Base
+    def load
+      load_fixtures_for('users').collect do |user|
+        Mingle::User.new(OpenStruct.new(user)) if match?(user)
+      end.compact
+    end
+  end
+end

data/lib/mingle_macro_development_toolkit/loaders/restful_loaders/base.rb

@@ -0,0 +1,85 @@
+#Copyright 2012 ThoughtWorks, Inc.  All rights reserved.
+require 'delegate'
+require 'uri'
+require 'net/http'
+require 'thread'
+require 'active_support'
+
+module RESTfulLoaders
+
+  class RemoteError < StandardError
+    def self.parse(response_body)
+      Hash.from_xml(response_body)['errors'].delete("error")
+    end
+  end
+
+  module LoaderHelper
+
+    def extract(key, container)
+      container[key] ? container[key][key.singularize] : []
+    end
+
+    def get(resource)
+      url = URI.parse(resource)
+      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
+      Hash.from_xml(response.body)
+    end
+  end
+
+  class MqlExecutor < SimpleDelegator
+    include LoaderHelper
+
+    def initialize(resource, error_handler, delegator)
+      super(delegator)
+      @uri = URI.parse(resource)
+      @error_handler = error_handler
+      @version = /(\/api\/([^\/]*))\//.match(@uri.request_uri)[2]
+    end
+
+    def execute_mql(mql)
+      from_xml_data(get(url_for(:action => "execute_mql", :query => "mql=#{mql}")))
+    rescue => e
+      @error_handler.alert(e.message)
+      []
+    end
+
+    def can_be_cached?(mql)
+      from_xml_data(get(url_for(:action => "can_be_cached", :query => "mql=#{mql}")))
+    rescue => e
+      @error_handler.alert(e.message)
+      []
+    end
+
+    def format_number_with_project_precision(number)
+      from_xml_data(get(url_for(:action => "format_number_to_project_precision", :query => "number=#{number}")))
+    rescue => e
+      @error_handler.alert(e.message)
+      []
+    end
+
+    def format_date_with_project_date_format(date)
+      from_xml_data(get(url_for(:action => "format_string_to_date_format", :query => "date=#{date}")))
+    rescue => e
+      @error_handler.alert(e.message)
+      []
+    end
+
+    def url_for(params)
+      relative_path = URI.escape("/api/#{@version}/projects/#{identifier}/cards/#{params[:action]}.xml?#{params[:query]}")
+      @uri.merge(relative_path).to_s
+    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
+end