minglemingle 0.0.1 → 0.0.2

data/CHANGES

@@ -1,4 +1,12 @@
 = MingleMingle Changelog
+
+* release 0.0.2:
+  * read options from local environment variables name of which are started with 'MM_', e.g. an environment variable 'MM_NUMBER=102', it would be a default card number instead of cached one and you can always overwrite it by specifying a card number in command line. Type 'mm help <subcommand>' to see environment options of each command.
+  * run a transition script template stored in an environment variable by template name
+  * transition script is able to parse variable which is specified by #{variable_name}. MingleMingle will try to find the variable from options.
+  * changed card option -a to access multi attributes, and always display card summarization even specified attributes
+  * removed noise part of transition script from svn commit message, e.g. "[fixed #1 with revision => #{revision}]blah..." => "fixed #1: blah..."
+
 * release 0.0.1: fit with Mingle 2.0 REST API
 
 

data/README

@@ -2,15 +2,15 @@
 
 Supporting MingleMingle version: 0.0.x
 
-This package contains MingleMingle, a Mingle command line tool based on the Mingle REST api.
+This package contains MingleMingle, a Mingle command line tool based on the Mingle REST API. (The name is came from a cartoon book named "Hunter Hunter":)
 
 MingleMingle has the following features integrating with Mingle:
 
-* run transition
-* show card
-* show card list view
-* show team member info
-* commit code with running transition
+* run transition => mm run ...
+* show card => mm card number
+* show card list view => mm cards ... | mm view name
+* show team member info => mm user id/login
+* commit code with running transition => mm svnci ....
 
 == Download
 

data/TODO

@@ -3,12 +3,4 @@
 Send suggestions for this list to swing1979@gmail.com
 
 === To Do
-  ? get card transitions
 (moved DONE list to CHANGES file)
-  ! add a revision option for auto adding revision number into trnasition when run svncommit command
-  ! get cards specified by a card list view name
-  ! don't show password when output init project url
-  ! display card name and description as default when get a card, and add a display all option
-  ! get card by number
-  ! execute transition on one card by script
-  ! integrate executing transition with svn commit command

data/lib/mm.rb

@@ -28,7 +28,7 @@ require 'mm/cmds/view'
 require 'mm/cmds/help'
 
 module MM
-  VERSION="0.0.1"
+  VERSION="0.0.2"
   
   module API
     def team_members

data/lib/mm/cmds/abstract_command.rb

@@ -30,7 +30,10 @@ module MM
       end
       
       def options
-        @options ||= Repository.new[self.class.name] || {}
+        return @options if @options
+        @options = Repository.new[self.class.name] || {}
+        ENV.keys.each { |key| @options[$1.downcase.to_sym] = ENV[key] if key =~ /^mm_(.+)/i }
+        @options
       end
       
       def parse(argv)
@@ -50,29 +53,45 @@ module MM
           return
         elsif message.is_a?(String)
           puts message
-        elsif options[:attr]
-          value = if pd = property_definitions.find{|pd| pd.name.downcase == options[:attr].downcase}
-            property_value(pd, message)
+        elsif options[:attrs]
+          attributes = if options[:attrs].is_a?(String)
+            options[:attrs].split(',')
           else
-            message.send(options[:attr])
+            options[:attrs]
+          end
+          attributes.each do |attr_name|
+            attr_name = attr_name.strip
+            column_name = if pd = property_definitions.find{|pd| pd.name.downcase == attr_name.downcase}
+              pd.column_name
+            else
+              attr_name
+            end
+            output(" * #{attr_name}: #{display_value(column_name, message.send(column_name))}")
           end
-          output(" * #{options[:attr]}: #{value}")
         else
           output(message.to_yaml)
         end
       end
       
-      def property_value(pd, card)
-        obj_value = card.send(pd.column_name)
+      def display_value(column_name, obj_value)
         case
-        when pd.card_property?(obj_value)
+        when card_property?(column_name, obj_value)
           find_card(:id => obj_value).short_summarization
-        when pd.user_property?(obj_value)
+        when user_property?(column_name, obj_value)
           team_members.find{|u|u.id==obj_value}.name
         else
           obj_value
         end
       end
+
+      def card_property?(column_name, obj_value)
+        obj_value.to_i > 0 && column_name =~ /card_id$/
+      end
+    
+      def user_property?(column_name, obj_value)
+        obj_value.to_i > 0 && column_name =~ /user_id$/
+      end
+      
     end
   end
 end

data/lib/mm/cmds/card.rb

@@ -17,15 +17,15 @@ module MM
   module Command
     class Card < AbstractCommand
       def view(card)
-        if options[:attr] || options[:show_all]
+        super(card.summarization) unless options[:show_all]
+        if options[:attrs] || options[:show_all]
           super(card)
-        else
-          super(card.summarization) 
         end
       end
       
       def do_once
         output "card number => #{options[:number]}"
+        output "attributes => #{options[:attrs].inspect}" if options[:attrs]
         find_card_by_number(options[:number])
       end
       
@@ -37,14 +37,19 @@ module MM
         OptionParser.new do |opts|
           opts.banner = "usage: mm card <card_number>"
           opts.separator ""
+          opts.separator "Environment variable options:"
+          opts.separator "  MM_NUMBER => card number used to find the card"
+          opts.separator "  MM_ATTRS => card attributes need to show with card"
+          opts.separator "  MM_SHOW_ALL => show all card attributes"
+          opts.separator ""
           opts.separator "Synopsis:"
           opts.separator "mm card 1 => find card by card number 1 and show all attributes"
           opts.separator "mm card 1 -a description => find card by card number 1 and show its description"
           opts.separator ""
           opts.separator "Options:"
 
-          opts.on_tail("-a", "--attribute ATTR_NAME", "show specified attribute value") do |attr_name|
-            options[:attr] = attr_name
+          opts.on("-a att_name1,attr_name2", Array, "show specified attribute value.") do |names|
+            options[:attrs] = names
           end
 
           opts.on_tail("-s", "--show_all", "show all card attributes") do

data/lib/mm/cmds/cards.rb

@@ -21,17 +21,15 @@ module MM
           output '----------'
           output card.short_summarization
           if options[:attrs]
-            options[:attrs].each do |attr_name|
-              options[:attr] = attr_name
-              output card
-            end
+            output(card)
           end
         end
       end
       
       def do_once
-        output "card list params => #{options.inspect}"
-        find_cards(options)
+        params = options.reject{|key, value| key.to_s=~/^transition_script_template/}
+        output "card list params => #{params.inspect}"
+        find_cards(params)
       end
       
       def parse(argv)
@@ -43,6 +41,10 @@ module MM
         OptionParser.new do |opts|
           opts.banner = "usage: mm cards [options]"
           opts.separator ""
+          opts.separator "Environment variable options:"
+          opts.separator "  MM_ATTRS => attributes want to be displayed"
+          opts.separator "  Could be any param's name with 'MM' started, e.g. MM_VIEW='favorite name', MM_PAGE=1"
+          opts.separator ""
           opts.separator "Synopsis:"
           opts.separator "mm cards \"{:view => 'favorite/tab name'}\" => find cards by favorite's/tab's name"
           opts.separator "mm cards \"{:view => 'favorite/tab name', :page => 2}\" => find cards in the page 2 by favorite's/tab's name"

data/lib/mm/cmds/help.rb

@@ -36,7 +36,7 @@ module MM
 mingle mingle, version #{MM::VERSION}
 Type 'mm help <subcommand>' for help on a specific subcommand.
 
-Queck start:
+Queck start part 1:
   * Suppose I am working on a project pet_store checked out at '~/pet_store'.
   * cd ~/pet_store
   * mm init http://my_login:password@mingle_server/projects/pet_store
@@ -44,10 +44,23 @@ Queck start:
   * mm view My Work -a owner,priority => list cards on card list view named 'My Work' including property owner and priority
   * mm card 102 => show name and description of the card
   * mm run 'Start fix #102' => run transition 'Start fix' on card 102
-  * mm svnci -m "[complete development #1 with 'fixed revision' => \#{revision}, resolution => fixed (some comment)] blabla..." => commit code and run transition script inside of []
+  * mm svnci -m "[complete fix #1 with 'fixed revision' => \#{revision}, resolution => fixed (some comment)] blabla..." => commit code and run transition script inside of []
   * mm view => show view cached which is 'My Work' with property 'owner' and 'priority' by last time using view command
   * mm card => show card cached number of which is 102 by last time using card command
 
+Queck start part 2:
+  * export MM_NUMBER=103 => setup my working card number
+  * export MM_ATTRS=priority,created_by_user_id 
+    => setup attributes want to be displayed whenever showing a card. 'created_by_user_id' is not a custom property definition but you'll see the user name instead of id in this case, and it's same with 'Created by' column in the card list view.
+  * mm card 
+    => show the working card summarization and attributes owner and priority which are just setup.
+  * export MM_TRANSITION_SCRIPT_TEMPLATE_COMPLETE_FIX="complete fix #\#{number} with 'fixed revision' => \#{revision}, resolution => fixed" 
+    => setup a transition script template named 'complete fix'
+  * mm svnci -m "[complete fix] blabla..." 
+    => commit code and run transition script template named 'complete fix', the number variable would be found in the environment which is MM_NUMBER=103
+  * mm svnci -m "[complete fix] blabla..." -n 105 
+    => commit code and run transition script template named 'complete fix', card number is 105 instead of current working card number
+
 Available subcommands:
   help [subcommand] show help doc of subcommand
   init [url]        init MingleMingle working directory with Mingle REST api project base url

data/lib/mm/cmds/init.rb

@@ -33,6 +33,9 @@ module MM
 %{
 usage: mm init [site_url]
 
+environment variable options:
+  MM_SITE => the Mingle REST API project base url
+
 Synopsis:
   mm init => show MingleMingle working directory settings.
   mm init http://name:pass@domain.com/projects/project_identifiler/ => setup MingleMingle working directory with Mingle REST api project base url.

data/lib/mm/cmds/run.rb

@@ -17,9 +17,32 @@ require 'mm/cmds/abstract_command'
 module MM
   module Command
     class Run < AbstractCommand
+      def parse_template
+        if template = options["TRANSITION_SCRIPT_TEMPLATE_#{options[:script].gsub(/ /, '_')}".downcase.to_sym]
+          options[:script] = template
+        end
+      end
+      
+      def parse_variables
+        options.keys.each do |key|
+          if options[:script] =~ /\{#{key}\}/
+            options[:script] = if key == :number
+              options[:script].gsub(/#?#\{#{key}\}/, "##{options[key]}")
+            else
+              options[:script].gsub(/#\{#{key}\}/, options[key])
+            end
+          end
+        end
+      end
+      
+      def parse_script
+        parse_template
+        parse_variables
+      end
+
       def do_once
+        parse_script
         output "script      => #{options[:script]}"
-        
         attrs = ::TransitionExecutionLanguageParser.new.parse(options[:script])
         output "attrs       => #{attrs.inspect}"
         attrs[:properties] = attrs[:properties].collect{|key, value| {:name => key, :value => value}} if attrs[:properties]
@@ -39,13 +62,20 @@ module MM
 usage: mm run <transition_script>
 
 transition script grammar: 
-    <transition name> #<card_number>[options]
+    <transition name> #<card_number> [options]
     options: 
         1. with <properties>: properties: prop_name1 => prop_value1, prop_name2 => prop_value2
         2. (<comment>): comment: should be ok for any words except '(' and ')'
 
+Environment variable options:
+  Any variable name start with 'MM_TRANSITION_SCRIPT_TEMPLATE_' would be handled as a transition script template. The string following the prefix would be template name, e.g. MM_TRANSITION_SCRIPT_TEMPLATE_FIX means a transition script template named 'fix'. You can specify a template name to run the transition, and MingleMingle also would help you to fill options into the template by same name, e.g. MM_TRANSITION_SCRIPT_TEMPLATE_FIX='Fix #\#{number} with resolution => fixed', MingleMingle would look for option named number in the options which is get from another environment variable MM_NUMBER=102. So type in 'mm run fix' would be translated to 'Fix #102 with fixed_revision => fixed'
+
 Synopsis:
-    mm run 'complete development #1 with revision => 100, status => open (some comment)'
+    mm run 'complete fix #1 with revision => 100, status => open (some comment)'
+    mm run fix => run template named fix, you need setup environment variable
+    
+Notes:
+  * You can specify variable in the transition script by \#{variable name}, MingleMingle will look for variable in the environment variable. For example, set up environment variable: export MM_NUMBER=105, then transition script 'Start fix \#{number}' would be parsed as 'Start fix #105'.
 }
       end
       

data/lib/mm/cmds/svncommit.rb

@@ -16,25 +16,47 @@ require 'mm/cmds/run'
 module MM
   module Command
     class Svncommit < AbstractCommand
-      TRANSITION_EXECUTION_SCRIPT_REGEX = /\[([^\]]+)\]/
+      TRANSITION_EXECUTION_SCRIPT_REGEX = /\[([^\]]+)\](.*)/
+      
+      def self.parse_commit_message(msg)
+        if msg =~ /\[(.+) with .+\](.*)/
+          "#{$1}#{": #{$2.strip}" unless $2.blank?}"
+        elsif msg =~ /\[(.+)\](.*)/
+          "#{$1}#{": #{$2.strip}" unless $2.blank?}"
+        else
+          msg
+        end
+      end
 
       def do_once
-        cmd = "svn ci #{svncmd_opts.join(' ')} -m #{options[:message].inspect}"
-        output "svn command: #{cmd}"
-        svnci = execute_cmd(cmd)
-        output svnci
-        if $?.exitstatus == 0
-          revision = svnci.split("\n").last.gsub(/[^0-9]/, '')
-          output "revision: #{revision}"
-          options[:message].gsub!(/#\{revision\}/, revision)
-          if options[:message] =~ TRANSITION_EXECUTION_SCRIPT_REGEX
-            run = Run.new
-            run.options[:script] = $1
+        if options[:message] =~ TRANSITION_EXECUTION_SCRIPT_REGEX
+          run = Run.new
+          run.options[:script] = $1
+          p "options[:number]: #{options[:number]}"
+          run.options[:number] = options[:number] if options[:number]
+          run.parse_script
+          options[:message] = "[#{run.options[:script]}] #{$2}"
+          svnci_output = svn_ci
+          if $?.exitstatus == 0
+            revision = svnci_output.split("\n").last.gsub(/[^0-9]/, '')
+            output "revision: #{revision}"
+            run.options[:revision] = revision
             run.do_once 
           end
+        else
+          svn_ci
         end
       end
       
+      def svn_ci
+        commit_message = self.class.parse_commit_message(options[:message])
+        cmd = "svn ci #{svncmd_opts.join(' ')} -m #{commit_message.inspect}"
+        output "svn command: #{cmd}"
+        svnci_output = execute_cmd(cmd)
+        output svnci_output
+        svnci_output
+      end
+      
       #don't want to cache options of this command
       def cache_options
       end
@@ -49,18 +71,27 @@ module MM
       
       def option_parser
         OptionParser.new do |opts|
-          opts.banner = "usage: mm svnci -m '[<transition_script>] other commit messages' [other svn options] [args]"
+          opts.banner = "usage: mm svnci -m '[<transition_script>] commit message' [other svn options] [args]"
+          opts.separator ""
+          opts.separator "WARNING: '[' AND ']' SHOULD ONLY BE USED TO SPECIFY TRANSITION SCRIPT!"
+          opts.separator ""
           opts.separator "transition script: should be inside of '[' and ']'. Type 'mm help run' for help on transition script grammar. "
+          opts.separator ""
           opts.separator 'specify a #{revision} in the message to run the transition with revision commited number'
+          opts.separator 'noise part of transition script would be removed from commit message, e.g. "[fixed #1 with revision => #{revision}]blah..." => "fixed #1: blah..."'
           opts.separator ""
           opts.separator "Synopsis:"
-          opts.separator 'mm svnci -m "[complete development #1 with fixed_revision => #{revision}, status => closed (some comment)]: details, blabla..."'
+          opts.separator 'mm svnci -m "[complete fix #1 with fixed_revision => #{revision}, status => closed (some comment)]: details, blabla..."'
           opts.separator ""
           opts.separator "Options:"
 
           opts.on_tail("-m", "--message MESSAGE", "specify log message ARG") do |message|
             options[:message] = message
           end
+          
+          opts.on_tail("-n", "--number CARD_NUMBER", "specify card number") do |number|
+            options[:number] = number
+          end
         end
       end
     end

data/lib/mm/cmds/user.rb

@@ -30,6 +30,9 @@ module MM
 %{
 usage: mm user [login/user id]
 
+Environment variable options:
+  MM_USER => user id/login used to find the user info
+
 Synopsis:
   mm user 'login' => find team member info by login
   mm user id => find team member info by id

data/lib/mm/cmds/view.rb

@@ -24,6 +24,9 @@ module MM
 %{
 usage: mm view <view_name>
 
+Environment variable options:
+  MM_VIEW => view name used to show cards, setup it as your working queue.
+
 Synopsis:
 mm view My Work => show cards in the view
 mm view My Work -a priority,owner => show cards in the view with attributes specified

data/lib/mm/rest_api.rb

@@ -36,13 +36,6 @@ module MM
     end
 
     class PropertyDefinition < ActiveResource::Base
-      def card_property?(obj_value)
-        obj_value.to_i > 0 && column_name =~ /card_id$/
-      end
-    
-      def user_property?(obj_value)
-        obj_value.to_i > 0 && column_name =~ /user_id$/
-      end
     end
 
     class Project < ActiveResource::Base

data/test/abstract_command_test.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/test_helper'
 class AbstractCommandTest < Test::Unit::TestCase
   
   def setup
+    ENV.delete_if{|k,v| k=~/^MM_/}
     MM::Repository.destroy rescue nil
   end
   
@@ -28,4 +29,9 @@ class AbstractCommandTest < Test::Unit::TestCase
     card_cmd.cache_options
     assert_equal({}, MM::Command::User.new.options)
   end
+  
+  def test_load_mm_options_from_env
+    ENV['MM_NUMBER'] = '10'
+    assert_equal({:number => '10'}, MM::Command::Card.new.options)
+  end
 end

data/test/run_test.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class AbstractCommandTest < Test::Unit::TestCase
+  
+  def setup
+    ENV.delete_if{|k,v| k=~/^MM_/}
+    MM::Repository.destroy rescue nil
+  end
+  
+  def teardown
+    MM::Repository.destroy rescue nil
+  end
+  
+  def test_run_with_script_template_stored_in_environment
+    ENV['MM_TRANSITION_SCRIPT_TEMPLATE_START_FIX'] = 'Start fix ##{number} with property => #{value}'
+    ENV['MM_NUMBER'] = '102'
+    ENV['MM_VALUE'] = 'mm_value'
+    run = MM::Command::Run.new
+    run.parse(['start', 'fix'])
+    run.do_once
+    assert_equal ["create_transition_execution", {:card=>"102", :comment=>nil, :transition=>"Start fix", :properties=>[{:value=>"mm_value", :name=>"property"}]}], run.run_apis.first
+  end
+  
+  def test_script_template_doesnt_need_sharp_for_card_number
+    ENV['MM_TRANSITION_SCRIPT_TEMPLATE_START_FIX'] = 'Start fix #{number}'
+    ENV['MM_NUMBER'] = '102'
+    run = MM::Command::Run.new
+    run.parse(['start', 'fix'])
+    run.do_once
+    assert_equal ["create_transition_execution", {:card=>"102", :comment=>nil, :transition=>"Start fix", :properties => nil}], run.run_apis.first
+  end
+end

data/test/svncommit_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class AbstractCommandTest < Test::Unit::TestCase
+  
+  def setup
+    ENV.delete_if{|k,v| k=~/^MM_/}
+    MM::Repository.destroy rescue nil
+  end
+  
+  def teardown
+    MM::Repository.destroy rescue nil
+  end
+  
+  def test_parse_commit_message
+    assert_equal "complete fix #1: blah", MM::Command::Svncommit.parse_commit_message('[complete fix #1 with revision => #{revision}]blah')
+    assert_equal "complete fix #1: blah", MM::Command::Svncommit.parse_commit_message('[complete fix #1]blah')
+    assert_equal "complete fix #1", MM::Command::Svncommit.parse_commit_message('[complete fix #1]')
+    assert_equal "complete fix #1: blah", MM::Command::Svncommit.parse_commit_message('[complete fix #1]      blah')
+    assert_equal "blah", MM::Command::Svncommit.parse_commit_message('blah')
+  end
+end

data/test/test_helper.rb

@@ -24,3 +24,55 @@ module Test
     end
   end
 end
+
+module MM
+  
+  module APIStub
+    def run_apis
+      @run_apis ||= []
+    end
+    def team_members
+      run_apis << 'team_members'
+      []
+    end
+  
+    def property_definitions
+      run_apis << 'property_definitions'
+      []
+    end
+  
+    def favorites
+      run_apis << 'favorites'
+      []
+    end
+    
+    def create_transition_execution(attrs)
+      run_apis << ['create_transition_execution', attrs]
+    end
+  
+    def find_card(options)
+      run_apis << ['find_card', options]
+      nil
+    end
+    
+    def find_card_by_number(number)
+      run_apis << ['find_card_by_number', number]
+      nil
+    end
+    
+    def find_cards(options)
+      run_apis << ['find_cards', options]
+      []
+    end
+    
+    def init(klass=nil)
+      run_apis << ['init', klass]
+    end
+    
+    def execute_cmd(cmd)
+      run_apis << ["execute_cmd", cmd]
+    end
+  end
+end
+
+MM::Command::AbstractCommand.send(:include, MM::APIStub)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: minglemingle
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Li Xiao
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-18 00:00:00 +08:00
+date: 2008-04-23 00:00:00 +08:00
 default_executable: mm
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,6 +54,8 @@ files:
 - lib/mm/utils.rb
 - lib/mm.rb
 - test/abstract_command_test.rb
+- test/run_test.rb
+- test/svncommit_test.rb
 - test/test_helper.rb
 - doc/jamis.rb
 has_rdoc: true