terjira 0.1.1 → 0.2.0

data/lib/terjira/issue_cli.rb

@@ -16,7 +16,12 @@ module Terjira
     def show(issue_key = nil)
       return invoke(:help) unless issue_key
       issue = client_class.find(issue_key)
-      render_issue_detail(issue)
+      if issue.issuetype.name.casecmp('epic').zero?
+        epic_issues = client_class.all_epic_issues(issue)
+        render_issue_detail(issue, epic_issues)
+      else
+        render_issue_detail(issue)
+      end
     end
 
     desc '( ls | list )', 'List of issues'
@@ -56,14 +61,11 @@ module Terjira
 
     desc 'new', 'Create issue'
     jira_options :summary, :description, :project, :issuetype,
-                 :priority, :assignee
+                 :priority, :assignee, :parent, :epiclink
     def new
       opts = suggest_options(required: [:project, :summary, :issuetype])
 
-      if opts[:issuetype].key_value.casecmp('epic').zero?
-        epic_name_field = Client::Field.epic_name
-        opts[epic_name_field.key] = write_epic_name
-      end
+      suggest_related_value_options(opts)
 
       issue = client_class.create(opts)
       render_issue_detail(issue)
@@ -71,11 +73,13 @@ module Terjira
 
     desc 'edit', 'Edit issue'
     jira_options :summary, :description, :project, :issuetype,
-                 :priority, :assignee
+                 :priority, :assignee, :epiclink
     def edit(issue)
       return if options.blank?
       issue = client_class.find(issue)
       opts = suggest_options(resources: { issue: issue })
+      suggest_related_value_options(opts)
+
       issue = client_class.update(issue, opts)
       render_issue_detail(issue)
     end

data/lib/terjira/option_support/option_selector.rb

@@ -61,7 +61,8 @@ module Terjira
 
     def select_issuetype
       fetch(:issuetype) do
-        project = select_project
+        project = get(:issue).try(:project).try(:key)
+        project ||= select_project
         if project.is_a? String
           project = Client::Project.find(project)
           set(:project, project)
@@ -79,14 +80,14 @@ module Terjira
       fetch(:status) do
         statuses = fetch(:statuses) do
           project = if issue = get(:issue)
-            if issue.respond_to?(:project)
-              issue.project
-            else
-              set(:issue, Client::Issue.find(issue)).project
-            end
-          else
-            select_project
-          end
+                      if issue.respond_to?(:project)
+                        issue.project
+                      else
+                        set(:issue, Client::Issue.find(issue)).project
+                      end
+                    else
+                      select_project
+                    end
           Client::Status.all(project)
         end
 
@@ -120,6 +121,12 @@ module Terjira
       end
     end
 
+    def write_epiclink_key
+      fetch(:epiclink) do
+        option_prompt.ask('Epic key?')
+      end
+    end
+
     def write_epic_name
       option_prompt.ask('Epic name?')
     end
@@ -142,6 +149,10 @@ module Terjira
       fetch(:summary) { option_prompt.ask('Summary?') }
     end
 
+    def write_parent_issue_key
+      fetch(:parent) { option_prompt.ask('Parent issue key?') }
+    end
+
     private
 
     def sprint_choice_title(sprint)

data/lib/terjira/option_support/shared_options.rb

@@ -4,7 +4,6 @@ module Terjira
       'project' => {
         type: :string,
         aliases: '-p',
-        desc: 'project key'
       },
       'board' => {
         type: :numeric,
@@ -31,7 +30,6 @@ module Terjira
       'status' => {
         type: :string,
         aliases: '-s',
-        desc: 'status'
       },
       'resolution' => {
         type: :string,
@@ -56,6 +54,10 @@ module Terjira
       'comment' => {
         type: :string,
         aliases: '-m'
+      },
+      'epiclink' => {
+        type: :string,
+        aliases: '-e'
       }
     }.freeze
 

data/lib/terjira/option_supportable.rb

@@ -23,6 +23,7 @@ module Terjira
       status: :select_issue_status,
       priority: :select_priority,
       resolution: :select_resolution,
+      epiclink: :write_epiclink_key,
       comment: :write_comment
     }.freeze
 
@@ -73,6 +74,29 @@ module Terjira
       origin.merge! default_value_options
     end
 
+    def suggest_related_value_options(opts = {})
+      if opts[:issuetype]
+        if opts[:issuetype].key_value.casecmp('epic').zero?
+          # Suggest epic name
+          epic_name_field = Client::Field.epic_name
+          opts[epic_name_field.key] ||= write_epic_name
+        else
+          subtask_issuetypes = Client::Issuetype.subtask_issuetypes.map(&:name)
+          if subtask_issuetypes.include? opts[:issuetype].key_value
+            # Suggest parent issue
+            opts[:parent] ||= write_parent_issue_key
+          end
+        end
+      end
+
+      if opts[:epiclink]
+        epiclink_field = Client::Field.epiclink
+        opts[epiclink_field.key] ||= opts.delete(:epiclink)
+      end
+
+      opts
+    end
+
     def resource_store
       ResourceStore.instance
     end

data/lib/terjira/presenters/common_presenter.rb

@@ -5,6 +5,10 @@ require 'pastel'
 
 module Terjira
   module CommonPresenter
+    extend Forwardable
+
+    def_delegators :pastel, :bold, :dim
+
     def render(text)
       if text.is_a? Array
         puts text.join("\n")
@@ -17,14 +21,18 @@ module Terjira
       @pastel ||= Pastel.new
     end
 
-    def formatted_date(date_str)
+    def dim_none
+      dim('None')
+    end
+
+    def formatted_date(date_str, date_format = '%c')
       return nil if date_str.nil? || date_str.empty?
-      Time.parse(date_str).strftime('%c')
+      Time.parse(date_str).strftime(date_format)
     end
 
     def username_with_email(user)
       if user.nil?
-        'None'
+        dim_none
       else
         title = "#{user.name}, #{user.displayName}"
         title += " <#{user.emailAddress}>" if user.respond_to?(:emailAddress)
@@ -40,12 +48,13 @@ module Terjira
     # when string display length is longger than length argument
     def insert_new_line(str, length)
       str.split(/\r\n|\n/).map do |line|
+        line.strip!
         if line.display_width < 1
           line
         else
           display_length = pastel.strip(line).display_width
           split_length = (line.length * length / display_length).to_i
-          line.scan(/.{1,#{split_length}}/).join("\n")
+          line.scan(/.{1,#{split_length}}/).join("\n") rescue line
         end
       end.join("\n")
     end

data/lib/terjira/presenters/issue_presenter.rb

@@ -3,9 +3,12 @@
 require 'tty-prompt'
 require 'tty-table'
 require 'pastel'
+require 'erb'
 
 module Terjira
   module IssuePresenter
+    COMMENTS_SIZE = 3
+
     def render_issues(issues, opts = {})
       return render('Empty') if issues.blank?
 
@@ -34,63 +37,21 @@ module Terjira
       end
     end
 
-    def render_issue_detail(issue)
-      header_title = "#{pastel.bold(issue.key)} in #{issue.project.name}"
-      header = [insert_new_line(header_title, screen_width - 10)]
-
-      rows = []
-      rows << pastel.underline.bold(issue.summary)
-      rows << ''
-      rows << issue_sutats_bar(issue)
-      rows << ''
-
-      rows << [pastel.bold('Assignee'), username_with_email(issue.assignee)].join(' ')
-      rows << [pastel.bold('Reporter'), username_with_email(issue.reporter)].join(' ')
-      rows << ''
-      rows << pastel.bold('Description')
-      rows << (issue.description.blank? ? 'None' : issue.description)
-
-      if issue.respond_to?(:environment) && issue.environment.present?
-        rows << pastel.bold('Environment')
-        rows << issue.environment
-      end
-
-      if issue.comments.present?
-        rows << ''
-        rows << pastel.bold('Comments')
-        remain_comments = issue.comments
-        comments = remain_comments.pop(4)
-
-        if comments.size.zero?
-          rows << 'None'
-        elsif remain_comments.empty?
-          rows << pastel.dim("- #{remain_comments.size} previous comments exist -")
-        end
-
-        comments.each do |comment|
-          comment_title = pastel.bold(comment.author['displayName'])
-          comment_title += " #{formatted_date(comment.created)}"
-          rows << comment_title
-          rows << comment.body
-          rows << ''
-        end
-      end
-
-      rows = rows.map { |row| insert_new_line(row, screen_width - 10) }
-
-      table = TTY::Table.new header, rows.map { |r| [r] }
-      result = table.render(:unicode, padding: [0, 1, 0, 1], multiline: true)
-
-      render(result)
+    def render_issue_detail(issue, epic_issues = [])
+      result = ERB.new(issue_detail_template, nil, '-').result(binding)
+      result += ERB.new(comments_template, nil, '-').result(binding)
+      rows = insert_new_line(result, screen_width - 10)
+      table = TTY::Table.new nil, rows.split("\n").map { |r| [r] }
+      render table.render(:unicode, padding: [0, 1, 0, 1], multiline: true)
     end
 
     def summarise_issue(issue)
       first_line = [colorize_issue_stastus(issue.status),
-                    issue.summary.tr("\t", ' ')].join
+                    issue.summary.tr("\t", ' ')].join(' ')
 
       second_line = [colorize_priority(issue.priority),
                      colorize_issue_type(issue.issuetype),
-                     assign_info(issue)].join(' ')
+                     issue.assignee.try(:name)].join(' ')
 
       lines = [first_line, second_line].map do |line|
         insert_new_line(line, screen_width - 30)
@@ -98,67 +59,124 @@ module Terjira
       lines.join("\n")
     end
 
-    private
-
-    def assign_info(issue)
-      reporter = issue.reporter ? issue.reporter.name : 'None'
-      assignee = issue.assignee ? issue.assignee.name : 'None'
-      "#{reporter} ⇨ #{assignee}"
+    def issue_detail_template
+      """<%= bold(issue.key) + ' in ' + issue.project.name %>
+
+      <%= pastel.underline.bold(issue.summary) %>
+
+      <%= bold('Type') %>: <%= colorize_issue_type(issue.issuetype) %>\s\s\s<%= bold('Status') %>: <%= colorize_issue_stastus(issue.status) %>\s\s\s<%= bold('priority') %>: <%= colorize_priority(issue.priority, title: true) %>
+      <% if issue.parent.nil?  -%>
+      <%= bold('Epic Link') %>: <%= issue.try(:epic).try(:key) %> <%= issue.try(:epic).try(:name) || dim_none %>
+      <% end -%>
+      <% if issue.try(:parent) && issue.epic.nil? -%>
+        <%= bold('Parent') %>: <%= issue.parent.key %>
+      <% end %>
+      <% if issue.try(:sprint) -%>
+        <%= bold('Sprint') %>: <%= colorize_sprint_state(issue.try(:sprint).try(:state)) %> <%= issue.try(:sprint).try(:id) %>. <%= issue.try(:sprint).try(:name) %>
+      <% end -%>
+
+      <%= bold('Assignee') %>: <%= username_with_email(issue.assignee) %>
+      <%= bold('Reporter') %>: <%= username_with_email(issue.reporter) %>
+
+      <%= bold('Description') %>
+      <%= issue.description || dim_none %>
+      <% if issue.try(:timetracking).is_a? Hash -%>
+
+        <%= bold('Estimate') %>
+        <% if issue.timetracking['originalEstimate'] -%>
+          <%= issue.timetracking['originalEstimate'] %> / <%= issue.timetracking['remainingEstimate'] %>
+        <% else -%>
+          <%= dim_none %>
+        <% end -%>
+      <% end -%>
+      <% if issue.try(:environment) -%>
+
+        <%= bold('Environment') %>
+        <%= issue.environment %>
+      <% end -%>
+      <% if issue.subtasks.size > 0 -%>
+
+        <%= bold('SubTasks') %>
+        <% issue.subtasks.each do |subtask| -%>
+          * <%= bold(subtask.key) %> <%= colorize_issue_stastus(subtask.status) %> <%= subtask.summary %>
+        <% end -%>
+      <% end -%>
+      <% if epic_issues.present? -%>
+        <%= bold('Issues in Epic') %>
+        <% epic_issues.each do |epic_issue| -%>
+          * <%= bold(epic_issue.key) %> <%= colorize_issue_stastus(epic_issue.status) %> <%= epic_issue.summary %> <%= issue.assignee.try(:name) %>
+        <% end -%>
+      <% end -%>
+      """
     end
 
-    def issue_sutats_bar(issue)
-      bar = ["#{pastel.bold('Type')}: #{colorize_issue_type(issue.issuetype)}",
-             "#{pastel.bold('Status')}: #{colorize_issue_stastus(issue.status)}",
-             "#{pastel.bold('priority')}: #{colorize_priority(issue.priority, title: true)}"]
-      bar.join("\s\s\s")
+    def comments_template
+      """
+      <% remain_comments = issue.comments -%>
+      <% visiable_comments = remain_comments.pop(COMMENTS_SIZE) -%>
+      <%= bold('Comments') %>
+      <% if visiable_comments.empty? -%>
+        <%= dim_none %>
+      <% elsif remain_comments.size != 0 -%>
+        <%= pastel.dim('- ' + remain_comments.size.to_s + ' previous comments exist -') %>
+      <% end -%>
+      <% visiable_comments.each do |comment| -%>
+        <%=  pastel.bold(comment.author['displayName']) %> <%= formatted_date(comment.created) %>
+        <%= comment.body %>
+
+      <% end -%>
+      """
     end
 
+    private
+
     def colorize_issue_type(issue_type)
       title = " #{issue_type.name} "
-      if title =~ /bug/i
-        pastel.on_red.white.bold(title)
-      elsif title =~ /task/i
-        pastel.on_blue.white.bold(title)
-      elsif title =~ /story/i
-        pastel.on_green.white.bold(title)
-      elsif title =~ /epic/i
-        pastel.on_magenta.white.bold(title)
-      else
-        pastel.on_cyan.white.bold(title)
-      end
+      background = if title =~ /bug/i
+                     :on_red
+                   elsif title =~ /task/i
+                     :on_blue
+                   elsif title =~ /story/i
+                     :on_green
+                   elsif title =~ /epic/i
+                     :on_magenta
+                   else
+                     :on_cyan
+                   end
+      pastel.decorate(title, :white, background, :bold)
     end
 
     def colorize_issue_stastus(status)
-      title = "#{status.name} "
-      category = title
-      if status.respond_to? :statusCategory
-        category = (status.statusCategory || {})['name'] || ''
-      end
-      if category =~ /to\sdo|open/i
-        pastel.blue.bold(title)
-      elsif category =~ /in\sprogress/i
-        pastel.yellow.bold(title)
-      elsif category =~ /done|close/i
-        pastel.green.bold(title)
-      else
-        pastel.magenta.bold(title)
-      end
+      category = status.statusCategory['name'] rescue nil
+      category ||= status.name
+      title = "#{status.name}"
+
+      color = if category =~ /to\sdo|open/i
+                :blue
+              elsif category =~ /in\sprogress/i
+                :yellow
+              elsif category =~ /done|close/i
+                :green
+              else
+                :magenta
+              end
+      pastel.decorate(title, color, :bold)
     end
 
     def colorize_priority(priority, opts = {})
       return '' unless priority.respond_to? :name
       name = priority.name
-      info = if name =~ /high|major|critic/i
-               { color: :red, icon: '⬆' }
-             elsif name =~ /medium|default/i
-               { color: :yellow, icon: '⬆' }
-             elsif name =~ /minor|low|trivial/i
-               { color: :green, icon: '⬇' }
-             else
-               { color: :green, icon: '•' }
-             end
-      title = opts[:title] ? "#{info[:icon]} #{name}" : info[:icon]
-      pastel.send(info[:color], title)
+      infos = if name =~ /high|major|critic/i
+                [:red, '⬆']
+              elsif name =~ /medium|default/i
+                [:yellow, '⬆']
+              elsif name =~ /minor|low|trivial/i
+                [:green, '⬇']
+              else
+                [:green, '•']
+              end
+      title = opts[:title] ? "#{infos[1]} #{name}" : infos[1]
+      pastel.decorate(title, infos[0])
     end
 
     def extract_status_names(issues)

data/lib/terjira/presenters/project_presenter.rb

@@ -12,7 +12,7 @@ module Terjira
       end
 
       rows = projects.map do |project|
-        [project.key, project.name, project.projectTypeKey]
+        [project.key, project.name, project.try(:projectTypeKey)]
       end
 
       table = TTY::Table.new head, rows

data/lib/terjira/presenters/sprint_presenter.rb

@@ -3,19 +3,19 @@
 module Terjira
   module SprintPresenter
     def render_sprint_detail(sprint)
-      return render("Empty") if sprint.nil?
+      return render('Empty') if sprint.nil?
       attrs = sprint.attrs
       summary = [
         pastel.bold("#{sprint.id}. #{sprint.name} #{colorize_sprint_state(sprint.state)}"),
-        "#{attrs["goal"]}",
-        "#{formatted_date(attrs["startDate"])} ~ #{formatted_date(attrs["endDate"])}"
+        attrs['goal'].to_s,
+        "#{formatted_date(attrs['startDate'])} ~ #{formatted_date(attrs['endDate'])}"
       ]
 
       render(summary.reject(&:empty?).join("\n"))
     end
 
     def render_sprints_summary(sprints)
-      headers = ["ID", "Summary"].map { |h| pastel.bold(h) }
+      headers = %w(ID Summary).map { |h| pastel.bold(h) }
       rows = []
       sort_sprint_by_state(sprints).each do |sprint|
         rows << [pastel.bold(sprint.id), summarise_sprint(sprint)]
@@ -30,10 +30,10 @@ module Terjira
 
     def summarise_sprint(sprint)
       summary = colorize_sprint_state(sprint.state)
-      summary += " " + pastel.bold(sprint.name)
+      summary += ' ' + pastel.bold(sprint.name)
       if sprint.respond_to? :startDate
         summary += "\n"
-        summary += formatted_date(sprint.startDate) + " ~ "
+        summary += formatted_date(sprint.startDate) + ' ~ '
         summary += formatted_date(sprint.endDate) if sprint.respond_to? :endDate
       end
       summary += "\n#{sprint.goal}" if sprint.respond_to? :goal
@@ -41,10 +41,10 @@ module Terjira
     end
 
     def colorize_sprint_state(state)
-      state = state.capitalize
-      if(state =~ /active/i)
+      state = state.to_s.capitalize
+      if state =~ /active/i
         pastel.on_blue.bold(state)
-      elsif(state =~ /close/i)
+      elsif state =~ /close/i
         pastel.dim(state)
       else
         pastel.on_magenta.bold(state)

data/lib/terjira/sprint_cli.rb

@@ -27,6 +27,7 @@ module Terjira
     def active
       opts = suggest_options(required: [:board])
       board = opts[:board]
+
       sprints = client_class.find_active(board)
 
       opts[:assignee] ||= current_username

data/lib/terjira/utils/file_cache.rb

@@ -3,21 +3,28 @@ require 'fileutils'
 
 module Terjira
   class FileCache
-
     MAX_DEPTH = 32
-    ROOT_DIR = ENV["HOME"] ? "#{ENV["HOME"]}/.terjira/" : "~/.terjira/"
+    ROOT_DIR = ENV['HOME'] ? "#{ENV['HOME']}/.terjira/" : '~/.terjira/'
+
+    class << self
+      def clear_all
+        return unless File.exist?(ROOT_DIR)
+        FileUtils.rm_r(ROOT_DIR)
+        FileUtils.mkdir_p(ROOT_DIR)
+      end
+    end
 
     def initialize(domain, expiry = 0, depth = 2)
       @domain  = domain
       @expiry  = expiry
       @depth   = depth > MAX_DEPTH ? MAX_DEPTH : depth
-      FileUtils.mkdir_p(get_root)
+      FileUtils.mkdir_p(root_path)
     end
 
     # Set a cache value for the given key. If the cache contains an existing value for
     # the key it will be overwritten.
     def set(key, value)
-      f = File.open(get_path(key), "w")
+      f = File.open(get_path(key), 'w')
       Marshal.dump(value, f)
       f.close
     end
@@ -31,14 +38,12 @@ module Terjira
         FileUtils.rm(path)
       end
 
-      if File.exist?(path)
-        f = File.open(path, "r")
+      return nil unless File.exist?(path)
+      result = nil
+      File.open(path, 'r') do |f|
         result = Marshal.load(f)
-        f.close
-        return result
-      else
-        return nil
       end
+      result
     end
 
     # Return the value for the specified key from the cache if the key exists in the
@@ -54,21 +59,20 @@ module Terjira
 
     # Delete the value for the given key from the cache
     def delete(key)
-      FileUtils.rm(get_path(key))
+      FileUtils.rm(get_path(key)) if File.exists? get_path(key)
     end
 
     # Delete ALL data from the cache, regardless of expiry time
     def clear
-      if File.exist?(get_root)
-        FileUtils.rm_r(get_root)
-        FileUtils.mkdir_p(get_root)
-      end
+      return unless File.exist?(root_path)
+      FileUtils.rm_r(root_path)
+      FileUtils.mkdir_p(root_path)
     end
 
     # Delete all expired data from the cache
     def purge
       @t_purge = Time.new
-      purge_dir(get_root) if @expiry > 0
+      purge_dir(root_path) if @expiry > 0
     end
 
     private
@@ -76,16 +80,14 @@ module Terjira
     def get_path(key)
       md5 = Digest::MD5.hexdigest(key.to_s).to_s
 
-      dir = File.join(get_root, md5.split(//)[0..@depth - 1])
+      dir = File.join(root_path, md5.split(//)[0..@depth - 1])
       FileUtils.mkdir_p(dir)
-      return File.join(dir, md5)
+      File.join(dir, md5)
     end
 
-    def get_root
-      if @root == nil
-        @root = File.join(ROOT_DIR, @domain)
-      end
-      return @root
+    def root_path
+      @root = File.join(ROOT_DIR, @domain) if @root.nil?
+      @root
     end
 
     def purge_dir(dir)
@@ -102,9 +104,7 @@ module Terjira
       end
 
       # Delete empty directories
-      if Dir.entries(dir).delete_if{|e| e =~ /^\.\.?$/}.empty?
-        Dir.delete(dir)
-      end
+      Dir.delete(dir) if Dir.entries(dir).delete_if { |e| e =~ /^\.\.?$/ }.empty?
     end
   end
 end

data/lib/terjira/version.rb

@@ -1,3 +1,3 @@
 module Terjira
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/terjira.rb

@@ -13,8 +13,19 @@ module Terjira
   class CLI < Thor
     desc 'login', 'login your Jira'
     def login
+      pastel = Pastel.new
       Client::Base.expire_auth_options
       Client::Base.build_auth_options
+
+      # for touch base resource
+      Client::Field.all
+      puts pastel.blue("Login successful")
+    rescue JIRA::HTTPError => e
+      puts pastel.red(e.message)
+      Client::Base.expire_auth_options
+    rescue => e
+      Client::Base.expire_auth_options
+      raise e
     end
 
     desc 'logout', 'logout your Jira'