style: add lint

Author: keepcosmos

.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   Exclude:
+    - 'bin/*'
     - '*.gemspec'
+    - 'lib/terjira/ext/**/*'
+    - 'Rakefile'
 
 Style/Documentation:
   Enabled: false
@@ -9,6 +12,8 @@ Style/EachWithObject:
 
 Lint/AssignmentInCondition:
   Enabled: false
+Lint/Eval:
+  Enabled: false
 
 Metrics/BlockLength:
   Enabled: false

README.md

@@ -5,42 +5,39 @@
 
 # Terjira
 
-Terjira is a very interactive and easy to use command line interface for Jira.
+Terjira is interactive and easy to use command line interface (or Application) for Jira. You do not need to remember reosurce key or id. Terjira suggests with interactive prompt.
 
 
-I'm working now..
+**I'm working now..**
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it yourself as:
 
-```ruby
-gem 'terjira'
-```
+    $ gem install terjira
 
-And then execute:
+If you have permission problem,
 
-    $ bundle
+    $ sudo gem install terjira
 
-Or install it yourself as:
+    # or
 
-    $ gem install terjira
+    $ gem install terjira --user-install
+    # You need to export your gem path
 
 ## Usage
 
-TODO: Write usage instructions here
 
-* Mock data is from jira-ruby
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/terjira. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/keepcosmos/terjira. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

bin/console

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # Do I need bundler setup?
-# require "bundler/setup"
+require "bundler/setup"
 require "terjira"
 
 # You can add fixtures and/or initialization code here to make experimenting

lib/terjira/base_cli.rb

@@ -1,11 +1,13 @@
 require 'thor'
 
 require_relative 'option_supportable'
-Dir[File.dirname(__FILE__) + "/presenters/*.rb"].each { |f| require f }
+Dir[File.dirname(__FILE__) + '/presenters/*.rb'].each { |f| require f }
 
 module Terjira
+  # Jira client based on jira-ruby gem
   module Client
-    %w[Base Field Project Board Sprint Issue User Status Resolution Priority RapidView Agile].each do |klass|
+    %w(Base Field 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
@@ -19,7 +21,7 @@ class BaseCLI < Thor
     include BoardPresenter
     include SprintPresenter
 
-    def self.banner(command, namespace = nil, subcommand = false)
+    def self.banner(command, _namespace = nil, _subcommand = false)
       "#{basename} #{subcommand_prefix} #{command.usage}"
     end
 

lib/terjira/client/agile.rb

@@ -7,22 +7,22 @@ class << self
         delegate :all, :get_sprints, :backlog_issues, to: :resource
 
         def project_by_board(board_id)
-          resp = agile_api_get("board/#{board_id}/project")
+          agile_api_get("board/#{board_id}/project")
         end
 
         def boards
-          all["values"]
+          all['values']
         end
 
-        def sprints(board_id, options = {})
-          sprints = get_sprints(board_id)["values"]
+        def sprints(board_id)
+          sprints = get_sprints(board_id)['values']
           sprints.sort_by do |sprint|
-            if sprint["state"] == 'active'
-              [0, sprint["id"]]
-            elsif sprint["state"] == 'future'
-              [1, sprint["id"]]
-            elsif sprint["state"] == 'closed'
-              [2, sprint["id"] * -1]
+            if sprint['state'] == 'active'
+              [0, sprint['id']]
+            elsif sprint['state'] == 'future'
+              [1, sprint['id']]
+            elsif sprint['state'] == 'closed'
+              [2, sprint['id'] * -1]
             else
               [3, 0]
             end
@@ -32,9 +32,6 @@ def sprints(board_id, options = {})
         def backlog_issues(board_id)
           get_backlog_issues(board_id)
         end
-
-        def sprint_issues(board_id)
-        end
       end
     end
   end

lib/terjira/client/base.rb

@@ -9,15 +9,14 @@ class Base
       extend AuthOptionBuilder
 
       DEFAULT_CACHE_SEC = 60
-      DEFAULT_API_PATH = "/rest/api/2/"
-      AGILE_API_PATH = "/rest/agile/1.0/"
+      DEFAULT_API_PATH = '/rest/api/2/'.freeze
+      AGILE_API_PATH = '/rest/agile/1.0/'.freeze
 
       class << self
-
         delegate :build, to: :resource
 
         def client
-          @@client ||= JIRA::Client.new(build_auth_options)
+          @client ||= JIRA::Client.new(build_auth_options)
         end
 
         def resource
@@ -29,7 +28,7 @@ def username
         end
 
         def class_name
-          self.to_s.split("::").last
+          to_s.split('::').last
         end
 
         def cache(options = {})
@@ -38,16 +37,14 @@ def cache(options = {})
         end
 
         # define `#api_get(post, put, delete)` and `#agile_api_get(post, put, delete)`
-        { DEFAULT_API_PATH => "api_",
-          AGILE_API_PATH => "agile_api_"
-        }.each do |url_prefix, method_prefix|
-
+        { DEFAULT_API_PATH => 'api_',
+          AGILE_API_PATH => 'agile_api_' }.each do |url_prefix, method_prefix|
           [:get, :delete].each do |http_method|
             method_name = "#{method_prefix}#{http_method}"
             define_method(method_name) do |path, params = {}, headers = {}|
               url = url_prefix + path
               if params.present?
-                params.reject! { |k, v| v.blank? }
+                params.reject! { |_k, v| v.blank? }
                 url += "?#{URI.encode_www_form(params)}"
               end
               parse_body client.send(http_method, url, headers)

lib/terjira/client/board.rb

@@ -6,13 +6,13 @@ class << self
 
         def all(options = {})
           params = options.slice(:type)
-          resp = agile_api_get("board", params)
-          resp["values"].map { |value| build(value) }
+          resp = agile_api_get('board', params)
+          resp['values'].map { |value| build(value) }
         end
 
         def find(board_id)
           resp = agile_api_get("board/#{board_id}")
-          self.build(resp)
+          build(resp)
         end
       end
     end

lib/terjira/client/field.rb

@@ -9,7 +9,7 @@ def all
         end
 
         def epic_name
-          all.find { |field| field.name == "Epic Name" }
+          all.find { |field| field.name == 'Epic Name' }
         end
       end
     end

lib/terjira/client/issue.rb

@@ -5,13 +5,11 @@ module Client
     class Issue < Base
       class << self
         delegate :build, :find, to: :resource
-        ISSUE_JQL_KEYS = [:sprint, :assignee, :reporter, :project, :issuetype, :priority, :status, :statusCategory]
 
         def all(options = {})
-          opts = options.slice(*ISSUE_JQL_KEYS)
           return resource.all if options.blank?
           max_results = options.delete(:max_results) || 500
-          resource.jql(build_jql_query(opts), max_results: max_results)
+          resource.jql(build_jql_query(options), max_results: max_results)
         end
 
         def find(issue, options = {})
@@ -20,7 +18,7 @@ def find(issue, options = {})
         end
 
         def current_my_issues
-          jql("assignee = #{self.key_value} AND statusCategory != 'Done'")
+          jql("assignee = #{key_value} AND statusCategory != 'Done'")
         end
 
         def assign(issue, assignee)
@@ -29,7 +27,7 @@ def assign(issue, assignee)
         end
 
         def write_comment(issue, message)
-          resp = api_post("issue/#{issue.key_value}/comment", { body: message }.to_json)
+          api_post("issue/#{issue.key_value}/comment", { body: message }.to_json)
           find(issue)
         end
 
@@ -39,9 +37,8 @@ def create(options = {})
             params.merge!(transition_param)
           end
 
-          resp = api_post "issue", params.to_json
-          result_id = resp["id"]
-          find(result_id)
+          resp = api_post 'issue', params.to_json
+          find(resp['id'])
         end
 
         def update(issue, options = {})
@@ -80,7 +77,7 @@ def extract_to_fields_params(options = {})
           params = {}
 
           custom_fields = options.keys.select { |k| k.to_s =~ /^customfield/ }
-          (custom_fields + [:summary, :description]).each do |k, v|
+          (custom_fields + [:summary, :description]).each do |k, _v|
             params[k] = opts.delete(k) if opts.key?(k)
           end
 

lib/terjira/client/jql_query_builer.rb

@@ -4,19 +4,19 @@ module JQLQueryBuilder
       JQL_KEYS = %w(board sprint assignee issuetype priority project status statusCategory).freeze
 
       def build_jql_query(options = {})
-        q_options = options.inject({}) do |memo,(k,v)|
+        q_options = options.inject({}) do |memo, (k, v)|
           memo[k.to_s] = v
           memo
         end.slice(*JQL_KEYS)
 
         query = q_options.map do |key, value|
           if value.is_a? Array
-            values = value.map { |v| "\"#{v.key_value}\""}.join(",")
+            values = value.map { |v| "\"#{v.key_value}\"" }.join(',')
             "#{key} IN (#{values})"
           else
             "#{key}=#{value.key_value}"
           end
-        end.reject(&:blank?).join(" AND ")
+        end.reject(&:blank?).join(' AND ')
 
         query
       end

lib/terjira/client/priority.rb

@@ -5,7 +5,7 @@ module Client
     class Priority < Base
       class << self
         def all
-          resp = api_get "priority"
+          resp = api_get 'priority'
           resp.map { |priority| build(priority) }
         end
       end

lib/terjira/client/resolution.rb

@@ -5,7 +5,7 @@ module Client
     class Resolution < Base
       class << self
         def all
-          resp = api_get("resolution")
+          resp = api_get('resolution')
           resp.map { |resolution| build(resolution) }
         end
       end

lib/terjira/client/status.rb

@@ -6,7 +6,7 @@ class Status < Base
       class << self
         def all(project)
           resp = api_get "project/#{project.key_value}/statuses"
-          statuses_json = resp.map { |issuetype| issuetype["statuses"] }.flatten.uniq
+          statuses_json = resp.map { |issuetype| issuetype['statuses'] }.flatten.uniq
           statuses_json.map { |status| build(status) }
         end
       end

lib/terjira/client/user.rb

@@ -6,10 +6,10 @@ class User < Base
       class << self
         def assignables_by_project(project)
           if project.is_a? Array
-            keys = project.map(&:key_value).join(",")
-            fetch_assignables "user/assignable/multiProjectSearch", {projectKeys: keys }
+            keys = project.map(&:key_value).join(',')
+            fetch_assignables 'user/assignable/multiProjectSearch', projectKeys: keys
           else
-            fetch_assignables "user/assignable/search", { project: project.key_value }
+            fetch_assignables 'user/assignable/search', project: project.key_value
           end
         end
 
@@ -28,15 +28,14 @@ def assignables_by_sprint(sprint)
         end
 
         def assignables_by_issue(issue)
-          fetch_assignables "user/assignable/search", {issueKey: issue.key_value }
+          fetch_assignables 'user/assignable/search', issueKey: issue.key_value
         end
 
         private
 
         def fetch_assignables(path, params)
           resp = api_get(path, params)
-          resp.map { |user| build(user) }.
-            reject { |user| user.key_value =~ /^addon/ }
+          resp.map { |user| build(user) }.reject { |user| user.key_value =~ /^addon/ }
         end
       end
     end

lib/terjira/ext/tty_prompt.rb

@@ -3,9 +3,6 @@
 module TTY
   class Prompt
     class Question
-      # Decide how to handle input from user
-      #
-      # @api private
       def process_input
         @input = read_input
         if Utils.blank?(@input)

lib/terjira/option_support/option_selector.rb

@@ -79,14 +79,14 @@ def select_issue_status
       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