jiraMule 0.1.1

data/lib/jiraMule/commands/kanban.rb

@@ -0,0 +1,243 @@
+require 'terminal-table'
+require 'mustache'
+require 'yaml'
+require 'JiraMule/jiraUtils'
+
+command :kanban do |c|
+  extra_columns = []
+  c.syntax = 'jm query [options] kanban'
+  c.summary = 'Show a kanban table'
+  c.description = %{
+Display issues grouped by a query.  Each group is a column in a table or a section in a list.
+
+Original intent was to build kanban tables, hence the name.  However, the output is quite
+configurable can can be used for many other styles.
+
+Use the --dump option to see how things have been styled.
+
+Formatting is done with Mustash.
+  }
+  c.example 'Show a kanban table', 'jm kanban'
+  c.example 'Show a status list', 'jm status'
+  c.example 'Another way to show a status list', 'jm --style status'
+  c.example 'Show a list to use with Taskpaper', 'jm --style taskpaper'
+  c.example 'Show status list, with differnt styling', %{jm --style status --header '# {{column}}' --item '** {{key}} {{summary}}'}
+  c.example 'Showoff', %{jm kanban --style empty --heading '<h1>{{column}}</h1>' \\
+  --column 'Working=status="In Progress"' \\
+  --column 'Done=status="Pending Release"' \\
+  --fields key,summary,assignee \\
+  --item '<h2>{{key}}</h2><b>Who:{{assignee.name}}</b><p>{{summary}}</p>'}
+
+  c.option '--[no-]raw', 'Do not prefix queries with project and assignee'
+  c.option '-w', '--width WIDTH', Integer, 'Width of the terminal'
+  c.option '-s', '--style STYLE', String, 'Which style to use'
+  c.option '--heading STYLE', String, 'Format for heading'
+  c.option '--item STYLE', String, 'Format for items'
+  c.option('-c', '--column NAME=QUERY', '') {|ec| extra_columns << ec}
+  c.option '-f', '--fields FIELDS', Array, 'Which fields to return'
+  c.option '-d', '--dump', 'Dump the style to STDOUT as yaml'
+  c.option '--file FILE', String, %{Style definition file to load}
+
+  c.action do |args, options|
+    options.default :width=>HighLine::SystemExtensions.terminal_size[0],
+      :style => 'kanban'
+
+    # Table of Styles. Appendable via config file. ??and command line??
+    allOfThem = {
+      :empty => {
+        :fields => [:key, :summary],
+        :format => {
+          :heading => "{{column}}",
+          :item => "{{key}} {{summary}}",
+        },
+        :columns => {}
+      },
+      :status => {
+        :fields => [:key, :summary],
+        :format => {
+          :heading => "#### {{column}}",
+          :item => "- {{key}} {{summary}}",
+          :order => [:Done, :Testing, :InProgress, :Todo],
+        },
+        :columns => {
+          :Done => [%{status = 'Pending Release'}],
+          :Testing => [%{status = Testing}],
+          :InProgress => [%{status = "In Progress"}],
+          :Todo => [%{(status = Open OR},
+               %{status = Reopened OR},
+               %{status = "On Deck" OR},
+               %{status = "Waiting Estimation Approval" OR},
+               %{status = "Reopened" OR},
+               %{status = "Testing (Signoff)" OR},
+               %{status = "Testing (Review)" OR},
+               %{status = "Testing - Bug Found")}],
+        },
+
+      },
+      :kanban => {
+        :fields => [:key, :summary],
+        :format => {
+          :heading => "{{column}}",
+          :item => "{{key}}\n {{summary}}",
+          :order => [:Todo, :InProgress, :Done],
+          :usetable => true
+        },
+        :columns => {
+          :Done => [%{(status = Released OR status = "Not Needed - Closed")}],
+          :InProgress => [%{(status = "In Progress" OR},
+                          %{status = "In Dev" OR},
+                          %{status = "Pending Release" OR},
+                          %{status = "In QA" OR},
+                          %{status = "Integration QA" OR},
+                          %{status = "In Design")},
+                  ],
+          :Todo => [%{(status = Open OR},
+               %{status = Reopened OR},
+               %{status = "On Deck" OR},
+               %{status = "Waiting Estimation Approval" OR},
+               %{status = "Reopened" OR},
+               %{status = "Testing (Signoff)" OR},
+               %{status = "Testing (Review)" OR},
+               %{status = "Testing - Bug Found" OR},
+               %{status = "Backlog" OR},
+               %{status = "Ready For Dev" OR},
+               %{status = "Ready For QA" OR},
+               %{status = "To Do" OR},
+               %{status = "Release Package")},
+            ],
+        },
+      },
+      :taskpaper => {
+        :fields => [:key, :summary, :duedate],
+        :format => {
+          :heading => "{{column}}:",
+          :item => "- {{summary}} @jira({{key}}) {{#duedate}}@due({{duedate}}){{/duedate}}",
+        },
+        :columns => {
+          :InProgress => %{status = "In Progress"},
+          :Todo => [%{(status = Open OR},
+               %{status = "Testing - Bug Found")}],
+        }
+      },
+    }
+    # TODO: Load styles from project dir
+
+    if options.file.nil? then
+      theStyle = allOfThem[options.style.to_sym]
+    else
+      theStyle = allOfThem[:empty]
+      File.open(options.file) {|io|
+        theStyle = YAML.load(io)
+        # make sure the required keys are symbols.
+        %w{fields format columns}.each do |key|
+          if theStyle.has_key? key then
+            theStyle[key.to_sym] = theStyle[key]
+            theStyle.delete(key)
+          end
+        end
+        %w{heading item}.each do |key|
+          if theStyle[:format].has_key? key then
+            theStyle[:format][key.to_sym] = theStyle[:format][key]
+            theStyle[:format].delete(key)
+          end
+        end
+      }
+    end
+
+    #### look for command line overrides
+    extra_columns.each do |cm|
+      name, query = cm.split(/=/, 2)
+      theStyle[:columns][name.to_sym] = [query]
+    end
+
+    theStyle[:fields] = options.fields if options.fields
+    theStyle[:format][:heading] = options.heading if options.heading
+    theStyle[:format][:item] = options.item if options.item
+
+
+    # All loading and computing of the style is complete, now fetch and print
+
+    if options.dump then
+      puts theStyle.to_yaml
+    else
+
+      ### Fetch the issues for each column
+      columns = theStyle[:columns]
+
+      jira = JiraMule::JiraUtils.new(args, options)
+
+      #### Fetch these fields
+      fields = theStyle[:fields]
+
+      #### Now fetch
+      qBase = []
+      qBase.unshift("assignee = #{jira.username} AND") unless options.raw
+      qBase.unshift("project = #{jira.project} AND") unless options.raw
+      qBase.unshift('(' + args.join(' ') + ') AND') unless args.empty? 
+
+      results = {}
+      columns.each_pair do |name, query|
+        query = [query] unless query.is_a? Array
+        q = qBase + query + [%{ORDER BY Rank}]
+        issues = jira.getIssues(q.join(' '), fields)
+        results[name] = issues
+      end
+
+      ### Now format the output
+      format = theStyle[:format]
+
+      #### Setup ordering
+      format[:order] = columns.keys.sort unless format.has_key? :order
+
+      #### setup column widths
+      cW = options.width.to_i
+      cW = -1 if cW == 0
+      cWR = cW
+      if format[:usetable] and cW > 0 then
+        borders = 4 + (columns.count * 3);   # 2 on left, 2 on right, 3 for each internal
+        cW = (cW - borders) / columns.count
+        cWR = cW + ((cW - borders) % columns.count)
+      end
+
+      #### Format Items
+      formatted={}
+      results.each_pair do |name, issues|
+        formatted[name] = issues.map do |issue|
+          line = Mustache.render(format[:item], issue.merge(issue[:fields]))
+          #### Trim length?
+          if format[:order].last == name
+            line[0..cWR]
+          else
+            line[0..cW]
+          end
+        end
+      end
+
+      #### Print
+      if format.has_key?(:usetable) and format[:usetable] then
+        # Table type
+        #### Pad
+        longest = formatted.values.map{|l| l.length}.max
+        formatted.each_pair do |name, issues|
+          if issues.length <= longest then
+            issues.fill(' ', issues.length .. longest)
+          end
+        end
+
+        #### Transpose
+        rows = format[:order].map{|n| formatted[n]}.transpose
+        puts Terminal::Table.new :headings => format[:order], :rows=>rows
+
+      else
+        # List type
+        format[:order].each do |columnName|
+          puts Mustache.render(format[:heading], :column => columnName.to_s)
+          formatted[columnName].each {|issue| puts issue}
+        end
+      end
+    end
+  end
+end
+alias_command :status, :kanban, '--style', 'status'
+
+#  vim: set sw=2 ts=2 :

data/lib/jiraMule/commands/logWork.rb

@@ -0,0 +1,39 @@
+require 'chronic_duration'
+require 'date'
+require 'JiraMule/jiraUtils'
+
+command :logwork do |c|
+  c.syntax = 'jm logwork [options] <key> <time spent...>'
+  c.summary = 'Log work spent'
+  c.description = %{Log time spent on a issue}
+  c.option '-m', '--message MSG', String, 'Message to add to work log'
+  c.option '--date DATE', String, 'When this work was done'
+  c.example 'Log some work done on an issue', %{jm logwork BUG-42 1h 12m}
+
+  c.action do |args, options|
+    options.default :message => ''
+    jira = JiraMule::JiraUtils.new(args, options)
+
+    key = jira.expandKeys(args).shift
+    ts = ChronicDuration.parse(args.join(' '))
+
+    unless options.date.nil? then
+      options.date = DateTime.parse(options.date)
+      if options.date.day_fraction.numerator == 0 then
+        # No time component. Need to add timezone...
+        offset = -(Time.now.gmt_offset/3600)
+        options.date += Rational(offset,24)
+      end
+    end
+
+    begin
+      jira.logWork(key, ts, options.message, options.date)
+    rescue JiraUtilsException => e
+      pp e.response.body
+    end
+
+  end
+end
+alias_command :lw, :logwork
+
+#  vim: set et sw=2 ts=2 :

data/lib/jiraMule/commands/next.rb

@@ -0,0 +1,89 @@
+require 'vine'
+require 'pp'
+require 'JiraMule/jiraUtils'
+
+command :next do |c|
+  c.syntax = 'jm next [options] [keys]'
+  c.summary = 'Move issue to the next state'
+  c.description = %{
+  Move to the next state. For states with multiple exits, use the 'preferred' one.
+  }
+  c.example 'Move BUG-4 into the next state.', %{jm next BUG-4}
+  c.option '--[no-]save-next', %{Save transition as preferred}
+  c.option '--force-choice', %{Always show menu of transitions (if more than one)}
+
+  c.action do |args, options|
+    jira = JiraMule::JiraUtils.new(args, options)
+
+    # keys can be with or without the project prefix.
+    keys = jira.expandKeys(args)
+    jira.printVars(:keys=>keys)
+    return if keys.empty?
+
+    keys.each do |key|
+      # First see if there is a single exit. If so, just do that.
+      trans = jira.transitionsFor(key)
+      if trans.length == 1 then
+        id = trans.first[:id]
+        jira.verbose "Taking single exit: '#{trans.first[:name]}'"
+        jira.transition(key, id)
+
+      else
+        # If more than one:
+
+        # Need to know the name of the state we are currently in
+        #query = "assignee = #{jira.username} AND project = #{jira.project} AND "
+        query = "key = #{key}"
+        issues = jira.getIssues(query, ["status"])
+        raise "Cannot find #{key}" if issues.empty?
+        at = issues.first.access('fields.status.name')
+
+        unless options.force_choice then
+          # If a preferred transition is set, use that
+          nxt = $cfg["next-preferred.#{at}"]
+          unless nxt.nil? then
+            direct = trans.select {|item| jira.fuzzyMatchStatus(item, nxt) }
+            unless direct.empty? then
+              id = direct.first[:id]
+              jira.verbose "Taking preferred exit #{key} to #{direct.first['name']} (#{id})"
+              jira.transition(key, id)
+              exit
+            end
+          end
+
+          # Filter ignored transitions; If only one left, goto it.
+          skiplist = $cfg['next.ignore'] || []
+          check = trans.reject{|t| skiplist.include? t[:name] }
+          if check.length == 1 then
+            id = check.first[:id]
+            jira.verbose "Taking filtered single exit: '#{check.first[:name]}'"
+            jira.transition(key, id)
+            exit
+          end
+        end
+
+        # Otherwise, ask which transition to use.
+        # - save that as preferred
+        # - goto it.
+        choose do |menu|
+          menu.prompt = "Follow which transition?"
+          trans.each do |tr|
+            menu.choice(tr[:name]) do
+              if options.save_next then
+                $cfg.set("next-preferred.#{at}", tr[:name], :project)
+              end
+              jira.verbose "Transitioning #{key} to #{tr[:name]} (#{tr[:id]})"
+              jira.transition(key, tr[:id])
+            end
+          end
+        end
+
+      end
+
+    end #keys.each
+  end
+end
+
+
+#  vim: set sw=2 ts=2 :
+

data/lib/jiraMule/commands/progress.rb

@@ -0,0 +1,68 @@
+require 'date'
+require 'terminal-table'
+require 'vine'
+require 'JiraMule/jiraUtils'
+
+command :progress do |c|
+  c.syntax = 'jm progress [options] [<key>]'
+  c.summary = 'Show progress on issues'
+  c.description = %{}
+  # Show only overdue (today > duedate)
+  # Show only unstarted (timespent == 0)
+  # Show only Started (timespent > 0)
+  c.option '-s', '--status STATUSES', Array, %{Which status to limit to. (default is "In Progress")}
+
+  c.example 'Show how current project is going', %{jm progress}
+  c.example 'Show how work on task 5 is going', %{jm progress 5}
+
+  c.action do |args, options|
+    options.default :status=>[]
+
+    jira = JiraMule::JiraUtils.new(args, options)
+    keys = jira.expandKeys(args)
+    if keys.empty? and options.status.empty? then
+      options.status << 'In Progress'
+    end
+
+    query = []
+    query << %{assignee = #{jira.username}}
+    query << %{project = #{jira.project}} if keys.empty?
+    unless keys.empty? then
+      query << '(' + keys.map{|k| "key=#{k}"}.join(' OR ') + ')'
+    end
+    unless options.status.empty? then
+      query << '(' + options.status.map{|s| %{status="#{s}"}}.join(' OR ') + ')'
+    end
+    query = query.join(' AND ')
+
+    #jira.printVars(:q=>query)
+    progresses = jira.getIssues(query, ['key', 'workratio', 'aggregatetimespent',
+                                        'duedate', 'aggregatetimeoriginalestimate'])
+
+    rows = progresses.map do |issue|
+      estimate = (issue.access('fields.aggregatetimeoriginalestimate') or 0)/3600.0
+      progress = (issue.access('fields.aggregatetimespent') or 0)/3600.0
+      due = issue.access('fields.duedate')
+      percent = issue.access('fields.workratio')
+      if percent < 0 then
+        estimate = progress if estimate == 0
+        percent = (progress / estimate * 100).floor
+      end
+      ret = [ issue[:key], "%.2f"%[estimate], "%.2f"%[progress],
+              %{#{"%.1f"%[percent]}%}, due ]
+      if progress > estimate or (not due.nil? and Date.new >= Date.parse(due)) then
+        ret.map!{|v| HighLine.color((v or ''), :bold)}
+      end
+      ret
+    end.sort{|a,b| a[0].sub(/^\D+(\d+)$/,'\1').to_i <=> b[0].sub(/^\D+(\d+)$/,'\1').to_i }
+
+    tbl = Terminal::Table.new :headings=>[:key, :estimated, :progress, :percent, :due], :rows=>rows
+    tbl.align_column(1, :right)
+    tbl.align_column(2, :right)
+    tbl.align_column(3, :right)
+    puts tbl
+
+  end
+end
+
+#  vim: set sw=2 ts=2 :

data/lib/jiraMule/commands/query.rb

@@ -0,0 +1,80 @@
+require 'terminal-table'
+require 'mustache'
+
+command :query do |c|
+  c.syntax = 'jm query [options] query'
+  c.summary = 'Get the keys from a jira query'
+  c.description = 'Run a query. '
+  c.example 'Get Open issues and dump everything', %{jm query status=Open --fields "" --json}
+  c.option '--[no-]raw', 'Do not prefix query with project and assignee'
+  c.option '--[no-]json', 'Output json reply instead of summary'
+  c.option '--fields FIELDS', Array, 'Which fields to return.'
+  c.option '--all_fields', 'Return all fields'
+  c.option '--format STYLE', String, 'Format for keys'
+  c.option '--style STYLE', String, 'Which style to use'
+
+  c.action do |args, options|
+    options.default :json => false, :all_fields => false, :style => 'basic'
+
+    allOfThem = {
+      :basic => {
+        :fields => [:key, :summary],
+        :format => %{{{key}} {{summary}}},
+      },
+      :info => {
+        :fields => [:key, :description, :assignee, :reporter, :priority, :issuetype,
+                    :status, :resolution, :votes, :watches],
+        :format => %{{{key}}
+   Reporter: {{reporter.displayName}}
+   Assignee: {{assignee.displayName}}
+       Type: {{issuetype.name}} ({{priority.name}})
+     Status: {{status.name}} (Resolution: {{resolution.name}})
+    Watches: {{watches.watchCount}}  Votes: {{votes.votes}}
+Description: {{description}}
+        }
+      },
+    }
+
+    theStyle = allOfThem[options.style.to_sym]
+    theStyle[:fields] = options.fields if options.fields
+
+    jira = JiraMule::JiraUtils.new(args, options)
+    args.unshift("assignee = #{jira.username} AND") unless options.raw
+    args.unshift("project = #{jira.project} AND") unless options.raw
+    q = args.join(' ')
+    if options.all_fields then
+      issues = jira.getIssues(q, [])
+    else
+      issues = jira.getIssues(q, theStyle[:fields])
+    end
+    if options.json then
+      puts JSON.dump(issues)
+    else
+
+      format = theStyle[:format]
+      keys = issues.map do |issue|
+        Mustache.render(format, issue.merge(issue[:fields]))
+      end
+      keys.each {|k| puts k}
+
+
+
+
+#      headers = [:key]
+#      rows = issues.map do |item|
+#        rw = [item[:key]]
+#        item[:fields].each_pair do |fname, fvalue|
+#          headers << fname unless headers.include? fname
+#          rw << fvalue
+#        end
+#        rw
+#      end
+#
+#      puts Terminal::Table.new :headings => headers, :rows=>rows
+
+    end
+  end
+end
+alias_command :q, :query
+
+#  vim: set sw=2 ts=2 :

data/lib/jiraMule/commands/release.rb

@@ -0,0 +1,44 @@
+
+command :release do |c|
+  c.syntax = 'jm release [options]'
+  c.summary = 'Little tool for releasing a version in Jira'
+  c.description = ''
+  c.example 'description', 'command example'
+  c.option '--some-switch', 'Some switch that does something'
+  c.action do |args, options|
+    # Do something or c.when_called Jira::Commands::Release
+
+		version = GitUtils.getVersion
+		newver = ask("\033[1m=?\033[0m Enter the version you want to release (#{version}) ")
+		version = newver unless newver == ''
+
+		project = $cfg['jira.project']
+		jira = JiraUtils.new(args, options)
+
+		jira.createVersion(project, version)
+
+		### Find all unreleased issues
+		query ="assignee = #{jira.username} AND project = #{project} AND (status = Resolved OR status = Closed) AND fixVersion = EMPTY" 
+		keys = jira.getIssues(query).map {|item| item['key'] }
+		printVars({:keys=>keys})
+
+		### Mark issues as fixed by version
+		updt = { 'fixVersions'=>[{'add'=>{'name'=>version}}] }
+		jira.updateKeys(keys, updt)
+
+		### This is old process residue.  So should consider removing
+		if $cfg['jira.alsoClose'] == true
+			puts "Also closing." if options.verbose
+			query = "assignee = #{jira.username} AND project = #{project} AND status = Resolved AND fixVersion != EMPTY" 
+			keys = jira.getIssues(query).map {|item| item['key'] }
+			printVars({:Rkeys=>keys})
+
+			if !keys.empty?
+				jira.transition(keys, 'Closed')
+			end
+		end
+
+  end
+end
+
+#  vim: set sw=2 ts=2 :

data/lib/jiraMule/commands/testReady.rb

@@ -0,0 +1,68 @@
+
+def printErr(msg)
+	$stdout.print("\033[1m=!\033[0m ")
+	$stdout.print(msg)
+	$stdout.print("\n")
+end
+
+command :testReady do |c|
+	c.syntax = 'jm testReady [options] [version]'
+	c.summary = 'Little tool for setting the fix version on testable issues'
+	c.description = %{On all issues in the Testing state, set the fix version and optionally reassign.
+	}
+	c.example 'Set the release version to the latest git tag', %{jm testReady}
+	c.example 'Set the release version to "v2.0"', %{jm testReady v2.0}
+	c.example 'Also reassign to the default', %{jm testReady -r v2.0}
+	c.example 'Also reassign to BOB', %{jm testReady v2.0 --assign BOB}
+	c.option '-r', '--[no-]reassign', 'Also reassign to Default'
+	c.option '-a', '--assign USER', 'Assign to USER'
+	c.action do |args, options|
+		options.default :reassign => false
+
+		if args[0].nil? then
+			version = GitUtils.getVersion
+			newver = ask("\033[1m=?\033[0m Enter the version you want to release (#{version}) ")
+			version = newver unless newver == ''
+		else
+			version = args[0]
+		end
+
+		jira = JiraUtils.new(args, options)
+		project = jira.project
+
+		if !options.assign.nil? then
+			users = jira.checkUser(options.assign)
+			if users.length > 1 then
+				printErr "User name '#{options.assign}' is ambigious."
+				printVars('Could be'=>users)
+				exit 4
+			end
+			if users.length <= 0 then
+				printErr "No users match #{options.assign}"
+				exit 4
+			end
+			options.assign = users[0]
+			printVars(:assign=>options.assign)
+		end
+
+		jira.createVersion(project, version)
+
+		### Find all unreleased issues
+		query ="assignee = #{jira.username} AND project = #{project} AND status = Testing" 
+		keys = jira.getIssues(query).map {|item| item['key'] }
+		printVars({:keys=>keys})
+
+		### Mark issues as fixed by version
+		updt = { 'fixVersions'=>[{'add'=>{'name'=>version}}] }
+		## assign to '-1' to have Jira automatically assign it
+		updt['assignee'] = [{'set'=>{'name'=>'-1'}}] if options.reassign
+		updt['assignee'] = [{'set'=>{'name'=>options.assign}}] if options.assign
+
+		printVars(:update=>updt) if options.verbose
+
+		jira.updateKeys(keys, updt)
+
+	end
+end
+
+#  vim: set sw=2 ts=2 :

data/lib/jiraMule/commands.rb

@@ -0,0 +1,20 @@
+require 'JiraMule/commands/assign'
+require 'JiraMule/commands/attach'
+require 'JiraMule/commands/config'
+require 'JiraMule/commands/githubImport'
+require 'JiraMule/commands/goto'
+require 'JiraMule/commands/kanban'
+require 'JiraMule/commands/link'
+require 'JiraMule/commands/logWork'
+require 'JiraMule/commands/next'
+require 'JiraMule/commands/progress'
+require 'JiraMule/commands/query'
+require 'JiraMule/commands/timesheet'
+
+#require 'JiraMule/commands/release'
+#require 'JiraMule/commands/testReady'
+# difference between testReady and release is two things:
+# 1. testReady also assigns
+# 2. release also transitions
+#
+# So, merge all that into one command and have the parts be --options; maybe

data/lib/jiraMule/gitUtils.rb

@@ -0,0 +1,11 @@
+
+
+class GitUtils
+
+	def self.getVersion
+		tag = `git for-each-ref --sort=taggerdate --format '%(refname)' refs/tags | head -1`.chomp
+		return tag.split('/').last
+	end
+end
+
+#  vim: set sw=4 ts=4 :