jiraMule 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d5f1f193633dde0eb039525564c5014d6c194ea
-  data.tar.gz: 2fa236f539408984963b7e54ff0cadc0ceacd9fa
+  metadata.gz: cbbaa7c560ccffc684631d28f866e682e8b16e22
+  data.tar.gz: 806095be43a2c49ffdeda778ea4e66a78510e006
 SHA512:
-  metadata.gz: d57a6e8ba761e0de2f1b9ffeca7f1ce09f98d6448a5c2928d5268cb33cf5c31df226e7e571e024a8d680ff0db088fa9de9fe541a7b51c580383cea408d960aa8
-  data.tar.gz: a3ec4461bc79d50dd0832ab65f2f6060fb6c561a331e4b1399bbf98a1e5317911c1c6b6c86edd1c4eab460a20b91546c05254a0c5ec5a02e98b3358d1c8f72b4
+  metadata.gz: 82151664ad86051f89463bebae844a54081373bd203d98fec2e92899bc4c044bd29aff46f2ee47007d73cd51f19acd399c2e5e858383f97b8ea0a32c39e10fc7
+  data.tar.gz: bdd85768fb65763a3dc03269fa715beef2d6c2a7e9c7db571b1e8c4e9a5ace6ce0286378ab1068e9776ef2de216d16343f035e893f500b4abe23d1453cfddc27

data/Gemfile

@@ -2,6 +2,7 @@ source 'http://rubygems.org'
 
 gemspec
 
+gem 'chronic'
 gem 'chronic_duration'
 gem 'commander'
 gem 'inifile', '~> 3.0'
@@ -9,7 +10,7 @@ gem 'mime-types', '~> 1.25.1'
 gem 'mime-types-data', '~> 3.2016'
 gem 'multipart-post'
 gem 'mustache'
-gem "octokit", "~> 4.0"
+# gem "octokit", "~> 4.0"
 gem 'terminal-table'
 gem 'vine'
 gem 'zip'

data/README.md

@@ -15,7 +15,7 @@
 
 ## Setup
 
-You need to set a few config keys before anyhting really works.
+You need to set a few config keys before anything really works.
 
 Globally:
 ```
@@ -33,5 +33,5 @@ jm config jira.project <Project ID>
 
 #### Jira API Docs
 
-[https://docs.atlassian.com/jira/REST/6.4.7/][]
+[https://docs.atlassian.com/jira/REST/7.2.4/][]
 

data/Rakefile

@@ -42,14 +42,31 @@ namespace :git do
 end
 
 task :gemit do
-    mrt=Bundler::GemHelper.gemspec.version
-    sh %{git checkout v#{mrt}}
+    sh %{git checkout #{tagName}}
     Rake::Task[:build].invoke
-    Rake::Task[:bob].invoke
+    # Rake::Task[:bob].invoke
     Rake::Task['push:gem'].invoke
     sh %{git checkout develop}
 end
 
+namespace :release do
+    desc "Open a release branch"
+    task :open, [:version] do |t, args|
+        sh %{git checkout master}
+        sh %{git checkout -b release/v#{args[:version]}}
+# - update version.rb
+        sh %{git commit lib/JiraMule/version.rb}
+    end
+
+    desc "Close a release branch"
+    task :close, [:version] do |t, args|
+        sh %{git checkout develop && git merge release/v#{args[:version]}}
+        sh %{git checkout master && git merge release/v#{args[:version]}}
+        sh %{git tag "v#{args[:version]}" -m "Release v#{args[:version]}"}
+        sh %{git branch -d release/v#{args[:version]}}
+    end
+end
+
 namespace :push do
     desc 'Push gem up to RubyGems'
     task :gem do

data/TODO.taskpaper

@@ -1,6 +1,5 @@
 
 New commands:
 	- 'comment' for adding a comment. If no '-m' then open $EDITOR
-	- 'assign' Assign to another user.
 
 

data/jiraMule.gemspec

@@ -25,6 +25,7 @@ already.  Rather this is specific to things I need.
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.add_runtime_dependency('chronic', '~> 0.10.2')
   s.add_runtime_dependency('chronic_duration', '~> 0.10.6')
   s.add_runtime_dependency('commander', '~> 4.4.0')
   s.add_runtime_dependency('inifile', '~> 3.0')
@@ -32,12 +33,13 @@ already.  Rather this is specific to things I need.
   s.add_runtime_dependency('mime-types-data', '~> 3.2016')
   s.add_runtime_dependency('multipart-post', '~> 2.0.0')
   s.add_runtime_dependency('mustache', '~> 1.0')
+  s.add_runtime_dependency('octokit', '~> 4.0')
   s.add_runtime_dependency('terminal-table', '~> 1.4.5')
   s.add_runtime_dependency('vine', '~> 0.2')
   s.add_runtime_dependency('zip', '~> 2.0.0')
 
-  s.add_development_dependency('bundler', '~> 1.12.0')
-  s.add_development_dependency('rspec', '~> 3.2')
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rspec')
   s.add_development_dependency('rake')
 end
 

data/lib/JiraMule.rb

@@ -1,7 +1,9 @@
 require 'JiraMule/version'
 require 'JiraMule/Config'
-require 'JiraMule/jiraUtils'
+
 require 'JiraMule/gitUtils'
-require 'JiraMule/Tempo'
+require 'JiraMule/jiraUtils'
+require 'JiraMule/renderMagic'
+require 'JiraMule/StyleLoader'
 
 require 'JiraMule/commands'

data/lib/JiraMule/StyleLoader.rb

@@ -0,0 +1,323 @@
+
+
+module JiraMule
+  # Style is a formula for formatting the results of a query.
+  # This currently only works with single queries.
+  class Style
+    def initialize(name, &block)
+      @name = name.to_sym
+      @fields = [:key, :summary]
+      @header = [:key, :summary]
+      @footer = nil
+      @format_type = :strings
+      @format = %{{{key}} {{summary}}}
+
+      @custom_tags = {}
+
+      @prefix_query = nil
+      @default_query = nil
+      @suffix_query = nil
+
+      @bolden_tag = :bolden
+
+      block.call(self) if block_given?
+    end
+
+    ######################################################
+    def self.add(style, &block)
+      @@styles = {} unless defined?(@@styles)
+
+      if style.kind_of?(String) or style.kind_of?(Symbol) then
+        style = Style.new(style, &block)
+      end
+
+      @@styles[style.name] = style
+    end
+
+    def self.fetch(name)
+      @@styles[name.to_sym]
+    end
+
+    def self.list
+      @@styles.keys
+    end
+
+    ######################################################
+    # Apply this style to Issues
+    # @param issues [Array] Issues from the Jira query to format
+    # @return formatted string
+    def apply(issues)
+      if @format_type == :strings then
+        keys = issues.map do |issue|
+          fmt = @format
+          fmt = fmt.join(' ') if fmt.kind_of? Array
+          res = JiraMule::IssueRender.render(fmt, issue.merge(issue[:fields]), @custom_tags)
+          bolden(issue, res)
+        end
+        (@header or '').to_s + keys.join("\n") + (@footer or '').to_s
+
+      elsif [:table, :table_rows, :table_columns].include? @format_type then
+        @format = [@format] unless @format.kind_of? Array
+        rows = issues.map do |issue|
+          issue = issue.merge(issue[:fields])
+          @format.map do |col|
+            if col.kind_of? Hash then
+              col = col.dup
+              str = col[:value] or ""
+              res = JiraMule::IssueRender.render(str, issue, @custom_tags)
+              col[:value] = bolden(issue, res)
+              col
+            else
+              res = JiraMule::IssueRender.render(col, issue, @custom_tags)
+              bolden(issue, res)
+            end
+          end
+        end
+        if @format_type == :table_columns then
+          rows = rows.transpose
+        end
+        header = (@header or [])
+        header = [header] unless header.kind_of? Array
+        Terminal::Table.new :headings => header, :rows=>rows
+      end
+    end
+
+    # If this issue should be bolded or not.
+    def bolden(issue, row, color=:bold)
+      bld = issue[@bolden_tag]
+      bld = @custom_tags[@bolden_tag] if bld.nil?
+      bld = bld.call(issue.dup) if bld.kind_of? Proc
+      # ? truthy other than Ruby default?
+      return row unless bld
+      if row.kind_of? Array then
+        row.map{|r| HighLine.color(r, color)}
+      elsif row.kind_of? Hash then
+        hsh={}
+        row.each_pair{|k,v| hsh[k] = HighLine.color(v, color)}
+      else
+        HighLine.color(row.to_s, color)
+      end
+    end
+
+    # TODO: Dump method that outputs Ruby
+
+    # Build a query based on this Style and other bits from command line
+    # @param args [Array<String>] Other bits of JQL to use instead of default_query
+    def build_query(*args)
+      opts = {}
+      opts = args.pop if args.last.kind_of? Hash
+
+      # Add the default query, if there is one
+      if not @default_query.nil? then
+        # make sure there is an AND if working with a cmdline supplied part
+        args.push('AND') unless args.empty?
+        case @default_query
+        when Array
+          args.push @default_query.join(' AND ')
+        when Proc
+          args.push @default_query.call()
+        else
+          args.push @default_query.to_s
+        end
+      end
+
+      # Get prefix as a String.
+      case @prefix_query
+      when Array
+        prefix = @prefix_query.join(' AND ') + ' AND'
+      when Proc
+        prefix = @prefix_query.call()
+      else
+        prefix = @prefix_query.to_s
+      end
+      args.unshift(prefix) unless opts.has_key? :noprefix
+
+      # Get suffix as a String.
+      case @suffix_query
+      when Array
+        suffix = 'AND ' + @suffix_query.join(' AND ')
+      when Proc
+        suffix = @suffix_query.call()
+      else
+        suffix = @suffix_query.to_s
+      end
+      args.push(suffix) unless opts.has_key? :nosuffix
+
+      args.flatten.compact.join(' ')
+    end
+
+    # May need to split this into two classes. One that is the above methods
+    # and one that is the below methods.  The below one is used just for the
+    # construction of a Style. While the above is the usage of a style.
+    #
+    # Maybe the above are in a Module, that is included as part of fetch?
+    ######################################################
+
+    attr_accessor :prefix_query, :suffix_query, :default_query
+    attr_accessor :header
+
+    def name
+      @name
+    end
+
+    # takes a single flat array of key names.
+    def fields(*args)
+      return @fields if args.empty?
+      @fields = args.flatten.compact.map{|i| i.to_sym}
+    end
+    alias_method :fields=, :fields
+
+    FORMAT_TYPES = [:strings, :table_rows, :table_columns, :table].freeze
+    def format_type(type)
+      return @format_type if type.nil?
+      raise "Unknown format type: \"#{type}\"" unless FORMAT_TYPES.include? type
+      @format_type = type
+    end
+    alias_method :format_type=, :format_type
+
+    def format(*args)
+      return @format if args.empty?
+      args.flatten! if args.kind_of? Array
+      @format = args
+    end
+    alias_method :format=, :format
+
+    # Create a custom tag for formatted output
+    def add_tag(name, &block)
+      @custom_tags[name.to_sym] = block
+    end
+
+  end
+
+##############################################################################
+##############################################################################
+##############################################################################
+
+  Style.add(:basic) do |s|
+    s.fields [:key, :summary]
+    s.format %{{{key}} {{summary}}}
+    s.header = nil
+  end
+
+  Style.add(:pr) do |s|
+    s.fields [:key, :summary]
+    s.format %{{{summary}} ({{key}})}
+    s.header = nil
+  end
+
+  Style.add(:info) do |s|
+    s.fields [:key, :summary, :description, :assignee, :reporter, :priority,
+              :issuetype, :status, :resolution, :votes, :watches]
+    s.header = nil
+    s.format %{        Key: {{key}}
+    Summary: {{summary}}
+   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}}
+    }
+  end
+
+  Style.add(:test_table) do |s|
+    s.fields [:key, :assignee]
+    s.format_type :table_columns
+    s.header = nil
+    s.format [%{{{key}}}, %{{{assignee.displayName}}}]
+  end
+
+  Style.add(:progress) do |s|
+    s.fields [:key, :workratio, :aggregatetimespent, :duedate,
+              :aggregatetimeoriginalestimate]
+    s.format_type :table_rows
+    s.header = [:key, :estimated, :progress, :percent, :due]
+    s.format [%{{{key}}},
+              {:value=>%{{{estimate}}},:alignment=>:right},
+              {:value=>%{{{progress}}},:alignment=>:right},
+              {:value=>%{{{percent}}%},:alignment=>:right},
+              {:value=>%{{{duedate}}},:alignment=>:center},
+    ]
+    # Use lambda when there is logic that needs to be deferred.
+    s.prefix_query = lambda do
+      r = []
+      r << %{assignee = #{$cfg['user.name']}} unless $cfg['user.name'].nil?
+      prjs = $cfg['jira.project']
+      unless prjs.nil? then
+        r << '(' + prjs.split(' ').map{|prj| %{project = #{prj}}}.join(' OR ') + ')'
+      end
+      r.join(' AND ') + ' AND'
+    end
+    s.default_query = %{(status = "In Progress" OR status = "In Design/Estimation")}
+    s.suffix_query = %{ORDER BY Rank}
+
+    s.add_tag(:bolden) do |issue|
+      estimate = (issue[:aggregatetimeoriginalestimate] or 0)
+      progress = (issue[:aggregatetimespent] or 0)
+      due = issue[:duedate]
+      progress > estimate or (not due.nil? and Date.new >= Date.parse(due))
+    end
+    s.add_tag(:estimate) do |issue|
+      "%.2f"%[(issue[:aggregatetimeoriginalestimate] or 0) / 3600.0]
+    end
+    s.add_tag(:progress) do |issue|
+      "%.2f"%[(issue[:aggregatetimespent] or 0) / 3600.0]
+    end
+    s.add_tag(:percent) do |issue|
+      percent = issue[:workratio]
+      if percent < 0 then
+        estimate = (issue[:aggregatetimeoriginalestimate] or 0) / 3600.0
+        if estimate > 0 then
+          progress = (issue[:aggregatetimespent] or 0) / 3600.0
+          percent = (progress / estimate * 100).floor
+        else
+          percent = 100 # XXX ??? what is this line doing? why is it here?
+        end
+      end
+      if percent > 1000 then
+        ">1000"
+      else
+        "%.1f"%[percent]
+      end
+    end
+  end
+
+  Style.add(:todo) do |s|
+    s.fields [:key, :summary]
+    s.header = "## Todo\n"
+    s.format %{- {{fixkey}}\t{{summary}}}
+
+    # Use lambda when there is logic that needs to be deferred.
+    s.prefix_query = lambda do
+      r = []
+      r << %{assignee = #{$cfg['user.name']}} unless $cfg['user.name'].nil?
+      prjs = $cfg['jira.project']
+      unless prjs.nil? then
+        r << '(' + prjs.split(' ').map{|prj| %{project = #{prj}}}.join(' OR ') + ')'
+      end
+      r.join(' AND ') + ' AND'
+    end
+    s.default_query = '(' + [
+                       %{status = "On Deck"},
+    ].join(' OR ') + ')'
+    s.suffix_query = %{ORDER BY Rank}
+
+    s.add_tag(:fixkey) do |issue|
+      "%-10s" % issue[:key]
+    end
+  end
+
+
+  Style.add(:comments) do |s|
+    s.fields [:key, :comment]
+    s.header = nil
+    s.format %{{{#comment.comments}}
+---------------------------------------------
+> {{author.displayName}} {{created}}  {{editied}}
+{{body}}
+{{/comment.comments}}
+    }
+  end
+
+end
+#  vim: set ai et sw=2 ts=2 :