terjira 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69d3616c8893bba879da6ebdc366da41d27c024a
-  data.tar.gz: 8374ec2e15f699f16d84045d9ba017d981a95de9
+  metadata.gz: a25d4e42aca093fd16ddd3aa3a653132f7716549
+  data.tar.gz: f1d2c6ff0b4c3aa3ee421f73d0d153cb67fc73f0
 SHA512:
-  metadata.gz: c3648d9c23d61e971ac7c64b2e76eef62aa959add14127f456f6d4e86c8c9b842a0abb4a7f22e96715f648d5f34cf42546bc30a522c3c263239f92aa1667075c
-  data.tar.gz: a49aa79742ff2a2d4074eebf9c510827d2dcb1f36b6fcc5b4ee201871e52c195146cda609a6f139bed3f86ab85861827c8fe206b406fc424e55fce03427e9659
+  metadata.gz: f621c41ba152ddada71cd29cfd993ebbef00351a5a56e54ec4b9989db2de2297232c48fc977bc7dd86cd35741d49f362aadff7cf34081508310c41cae179b60c
+  data.tar.gz: a78015b6021e980146aa79dd1b55a7cf7a89975df31ddee8076b68126748b3088e3ce205956efa29a73f1c0acec26fe780565ed6409aef70d45a2c41bb283dcf

data/.gitignore

@@ -1,3 +1,5 @@
+full_test
+
 .vagrant
 
 *.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terjira (0.2.5)
+    terjira (0.2.6)
       activesupport (= 4.0.13)
       jira-ruby (~> 1.1)
       pastel (~> 0.6.1)

data/README.md

@@ -5,11 +5,11 @@
 
 # Terjira
 
-Terjira is an interactive and easy to use command line interface (or Application) for Jira. You do not need to remember resource key or id. Terjira suggests it with interactive prompt.
+Terjira is an interactive and easy to use command line interface (or Application) for Jira. You do not need to remember the resource key or id. Terjira suggests it with an interactive prompt.
 
 Your Jira must support Rest API 2.0 and Agile Rest API 1.0
 
-## Domo
+## Demo
 [Watch full demo](https://www.youtube.com/watch?v=T0hbhaXtH-Y)
 
 [![Sample](./dev/demo.gif)](https://www.youtube.com/watch?v=T0hbhaXtH-Y)
@@ -58,6 +58,9 @@ Issue:
                                      #   default assignee option is current loggined user
                                      #   To show issues of all users(include no assignee)
                                      #   pass `--assignee ALL` option.
+  jira issue jql "[QUERY]"           # Search issues with JQL
+                                     # ex)
+                                     #   jira issue jql "project = 'TEST' AND summary ~ 'authentication'"
   jira issue [ISSUE_KEY]             # Show detail of the issue
   jira issue assign [ISSUE_KEY] ([ASSIGNEE])  # Assign the issue to user
   jira issue comment [ISSUE_KEY]     # Write comment on the issue
@@ -72,6 +75,7 @@ Issue:
 
 ## Todo
 **Contributions are welcome!**
+- [x] Add JQL command for find issues
 - [ ] Manage worklog and estimate of issues
 - [ ] Manage component and version of issues
 - [ ] Track history of transitions

data/lib/terjira.rb

@@ -33,7 +33,7 @@ module Terjira
       Client::Base.expire_auth_options
     end
 
-    desc 'project SUBCOMMAND ...ARGS', 'Manage proejcts'
+    desc 'project SUBCOMMAND ...ARGS', 'Manage projects'
     subcommand 'project', ProjectCLI
 
     desc 'board SUBCOMMAND ...ARGS', 'Manage boards'

data/lib/terjira/base_cli.rb

@@ -2,16 +2,9 @@ require 'thor'
 
 require_relative 'option_supportable'
 Dir[File.dirname(__FILE__) + '/presenters/*.rb'].each { |f| require f }
+Dir[File.dirname(__FILE__) + '/client/*.rb'].each { |f| require f }
 
 module Terjira
-  # Jira client based on jira-ruby gem
-  module Client
-    %w(Base Field Issuetype Project Board Sprint Issue User
-       Status Resolution Priority RapidView Agile).each do |klass|
-      autoload klass, "terjira/client/#{klass.gsub(/(.)([A-Z](?=[a-z]))/,'\1_\2').downcase}"
-    end
-  end
-
   class BaseCLI < Thor
     include OptionSupportable
 

data/lib/terjira/client/field.rb

@@ -3,6 +3,8 @@ require_relative 'base'
 module Terjira
   module Client
     class Field < Base
+      CACHE_PATH = "resource/fields".freeze
+
       class << self
         def all
           @all_fields ||= file_cache.fetch("all") do
@@ -14,16 +16,24 @@ module Terjira
           all.find { |field| field.key == key }
         end
 
+        def find_by_name(name)
+          all.find { |field| field.name == name }
+        end
+
         def epic_name
-          all.find { |field| field.name == 'Epic Name' }
+          find_by_name('Epic Name')
+        end
+
+        def epic_link
+          find_by_name('Epic Link')
         end
 
-        def epiclink
-          all.find { |field| field.name == 'Epic Link' }
+        def story_points
+          find_by_name('Story Points')
         end
 
         def file_cache
-          Terjira::FileCache.new("resource/fields", 60 * 60 * 24)
+          Terjira::FileCache.new(CACHE_PATH, 60 * 60 * 24)
         end
       end
     end

data/lib/terjira/client/issue.rb

@@ -4,12 +4,12 @@ module Terjira
   module Client
     class Issue < Base
       class << self
-        delegate :build, :find, to: :resource
+        delegate :jql, :find, to: :resource
 
         def all(options = {})
           return resource.all if options.blank?
           max_results = options.delete(:max_results) || 500
-          resource.jql(build_jql(options), max_results: max_results)
+          jql(build_jql(options), max_results: max_results)
         end
 
         def all_epic_issues(epic)

data/lib/terjira/client/status_category.rb

@@ -0,0 +1,20 @@
+require_relative 'base'
+
+module Terjira
+  module Client
+    class StatusCategory < Base
+      class << self
+        def all
+          @all_statuscategory ||= file_cache.fetch("all") do
+            resp = api_get "statuscategory"
+            resp.map { |category| build(category) }
+          end
+        end
+
+        def file_cache
+          Terjira::FileCache.new("resource/statuscategory", 60 * 60 * 48)
+        end
+      end
+    end
+  end
+end

data/lib/terjira/ext/jira_ruby.rb

@@ -27,12 +27,6 @@ module JIRA
   end
 
   module Resource
-    class BoardFactory < JIRA::BaseFactory # :nodoc:
-    end
-
-    class EpicFactory < JIRA::BaseFactory # :nodoc:
-    end
-
     class Board < JIRA::Base
       def self.key_attribute; :id; end
     end
@@ -41,6 +35,10 @@ module JIRA
       def self.key_attribute; :key; end
     end
 
+    class StatusCategory < JIRA::Base
+      def self.key_attribute; :name; end
+    end
+
     class User
       def self.key_attribute; :name; end
     end
@@ -60,12 +58,29 @@ module JIRA
     class Resolution
       def self.key_attribute; :name; end
     end
+
+    class BoardFactory < JIRA::BaseFactory
+    end
+
+    class EpicFactory < JIRA::BaseFactory
+    end
+
+    class StatusCategoryFactory < JIRA::BaseFactory
+    end
   end
 
   class Client
     def Board # :nodoc:
       JIRA::Resource::BoardFactory.new(self)
     end
+
+    def Epic
+      JIRA::Resource::EpicFactory.new(self)
+    end
+
+    def StatusCategory
+      JIRA::Resource::StatusCategoryFactory.new(self)
+    end
   end
 end
 

data/lib/terjira/issue_cli.rb

@@ -34,7 +34,7 @@ module Terjira
     map ls: :list
     def list
       opts = suggest_options
-      opts[:statusCategory] ||= %w(To\ Do In\ Progress) unless opts[:status]
+      opts[:statusCategory] ||= default_status_categories unless opts[:status]
       opts[:assignee] ||= current_username
       opts.delete(:assignee) if opts[:assignee] =~ /^all/i
 
@@ -42,6 +42,15 @@ module Terjira
       render_issues(issues)
     end
 
+    desc 'jql "[QUERY]"', "Search issues with JQL"
+    long_desc <<-EXAMPLE
+      jira issue jql "project = 'IST' AND assignee = currentuser()"
+    EXAMPLE
+    def jql(*query)
+      jql = query.join(" ")
+      render_issues Client::Issue.jql(jql)
+    end
+
     desc 'new', 'Create an issue'
     jira_options :summary, :description, :project, :issuetype,
                  :priority, :assignee, :parent, :epiclink
@@ -121,5 +130,11 @@ module Terjira
       issue = client_class.trans(issue, opts)
       render_issue_detail(issue)
     end
+
+    no_commands do
+      def default_status_categories
+        Client::StatusCategory.all.reject { |category| category.key =~ /done/i }.map(&:name)
+      end
+    end
   end
 end

data/lib/terjira/option_supportable.rb

@@ -90,7 +90,7 @@ module Terjira
       end
 
       if opts[:epiclink]
-        epiclink_field = Client::Field.epiclink
+        epiclink_field = Client::Field.epic_link
         opts[epiclink_field.key] ||= opts.delete(:epiclink)
       end
 

data/lib/terjira/presenters/issue_presenter.rb

@@ -64,9 +64,10 @@ module Terjira
 
       <%= 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) %>
+      <%= 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 %>
+
+        <%= 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 %>
@@ -74,21 +75,16 @@ module Terjira
       <% 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 -%>
+      <% if estimate = issue_estimate(issue) -%>
+
+        <%= estimate[0] %>: <%= estimate[1] %>
+      <% end -%>
 
       <%= bold('Assignee') %>: <%= username(issue.assignee) %>
       <%= bold('Reporter') %>: <%= username(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') %>
@@ -184,6 +180,23 @@ module Terjira
       pastel.decorate(title, infos[0])
     end
 
+    # Extract estimate or story points
+    # @return Array, first element is title and second is value
+    def issue_estimate(issue)
+      field = Client::Field.story_points
+      story_points = issue.try(field.key) if field.respond_to? :key
+      return [bold('Story Points'), story_points] if story_points
+
+      return unless issue.try(:timetracking).is_a? Hash
+
+      if origin = issue.timetracking['originalEstimate']
+        remain = issue.timetracking['remainingEstimate']
+        [bold('Estimate'), "#{remain} / #{origin}"]
+      else
+        [bold('Estimate'), dim_none]
+      end
+    end
+
     def extract_status_names(issues)
       issue_names = issues.sort_by do |issue|
         status_key = %w(new indeterminate done)

data/lib/terjira/presenters/sprint_presenter.rb

@@ -41,7 +41,7 @@ module Terjira
     end
 
     def colorize_sprint_state(state)
-      state = state.to_s.capitalize
+      state = " #{state.to_s.capitalize} "
       if state =~ /active/i
         pastel.on_blue.bold(state)
       elsif state =~ /close/i

data/lib/terjira/version.rb

@@ -1,7 +1,7 @@
 require 'terjira/utils/file_cache'
 
 module Terjira
-  VERSION = '0.2.5'.freeze
+  VERSION = '0.2.6'.freeze
 
   class VersionChecker
     VERSION_CHECK_DURATION = (60 * 60 * 24 * 5).freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terjira
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Jaehyun Shin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -235,6 +235,7 @@ files:
 - lib/terjira/client/resolution.rb
 - lib/terjira/client/sprint.rb
 - lib/terjira/client/status.rb
+- lib/terjira/client/status_category.rb
 - lib/terjira/client/user.rb
 - lib/terjira/ext/jira_ruby.rb
 - lib/terjira/ext/tty_prompt.rb