redmine_cli 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00076ae6856ab08c117ae349cddb9612fecf323e
-  data.tar.gz: 2984d5491b6ad7522e37ae98b1e406c90cb835e5
+  metadata.gz: 8ef953c22fdb0728f89e601513e196f11b889b31
+  data.tar.gz: 3b90592c3f4c0f1c0718e9d78ca1c0db5e5a3ab6
 SHA512:
-  metadata.gz: d3b4cd2a1337400909ab272e2116afc5d8b43f3b5256eec464e9f567cc12a88d25a3b07679d878adec4fc462e341f59498f99be59d55fcb6546e88e99ec8f19c
-  data.tar.gz: 6b314ee1180f075de75ac480c70c633d7d19c66a0a75689d066ceeeffd36f6eb5126c1a96d4a07d799067829d23efb827649fa8c3cb7c2aadfea1e1d9c216316
+  metadata.gz: 01555ab7dbf899ab495bb2ab252bf48f3f925650d4b76e738065e67cc10fb3f89715bd865c7fd645c94a87dd985a500fdd1f630c684fef0f3f6b95c32943ae51
+  data.tar.gz: f0721ac52ad8029dcc6fe08c4d7b5cc846c860bb0bd8c6dc6f6485b3bfb1fc10ac396f08f862086e0ff2614059eaad0be3463082fb23dfec5179561ea0506ebf

data/README.md

@@ -15,6 +15,8 @@ Why? Because web-browser + mouse sucks
     redmine conf init
     redmine issue list [user id]
     redmine issue show <issue id>
+    redmine issue update <issue id> --comment --done 80  --status progress --time 00:30
+
     redmine user find vasya
     redmine user find 123
     redmine user find pupkin@yet.another.mail.com

data/bin/console

@@ -11,4 +11,6 @@ require 'redmine_cli'
 # Pry.start
 
 require 'irb'
+
+ActiveResource::Base.logger = Logger.new(STDOUT)
 IRB.start

data/lib/assets/default_config.yml

@@ -2,3 +2,4 @@
 user: nil
 password: nil
 site: nil
+locale: en

data/lib/assets/messages/en.yml

@@ -7,6 +7,17 @@ en:
     issue:
       list: 'Lists issues of user. By default it is you'
       show: 'More info about issue'
+      update: 'Change some issue params, add time entry, comment'
+      options:
+        show:
+          limit: 'Amount of comments (last journals).'
+        update:
+          done: 'Readiness percentage'
+          assign: 'ID of user issue will be assigned to'
+          time: 'Add time entry. Formats: HH:MM; M (minutes); H.h (hours in float)'
+          status: 'Change status of issue. Search by status name substring'
+          comment: 'Leave comment. It will open your text editor.'
+          description: 'Change description with your text editor.'
     conf:
       init: 'Asks you few question to make your config file useful'
     user:
@@ -18,8 +29,16 @@ en:
         enter_user: 'Enter your login to Redmine: '
         enter_password: 'Enter your password: '
         enter_site: 'Enter URL to your Redmine: '
+    issue:
+      update:
+        type_comment_here: 'Type your comment here, save file and close'
 
   thank_you: 'Thank you!'
   error_try_again: 'Error! Try again.'
   error_input_required: 'Input cant be empty.'
   not_found: 'Not found'
+  success: 'success'
+  error: 'error'
+  wrong_format: 'Wrong format'
+  creation_error: 'Creation error'
+  enter_object_number: 'Enter object number: '

data/lib/assets/templates/en/issue/show.erb

@@ -0,0 +1,69 @@
+
+% ljust_value = 15
+% info =  { 'ID' => issue.id,
+%           'Subject' => issue.subject,
+%           'Status' => issue.status.name,
+%           'Priority' => issue.priority.name,
+%           'Readiness' => issue.done_ratio + '%',
+%           'Author' => "#{issue.author.name} (#{issue.author.id})" }
+%
+% info['Assigned to'] = "#{issue.assigned_to.name} (#{issue.assigned_to.id})" if issue.assigned_to?
+% info['Project'] = issue.project.name if issue.project?
+% info['Version'] = issue.version.name if issue.version?
+% info['Parent'] = "#{issue.parent.id} - #{issue.parent.reload.subject.cut(80)}" if issue.parent?
+%
+% info.each do |title, value|
+<%= "#{title}:".ljust(ljust_value).yellow %> <%= value + "\n" %>
+% end
+%
+% if issue.children?
+<%= 'Children'.yellow %>:
+%   issue.children.each do |i|
+  * <%= i.id %> - <%= i.reload.subject.cut(70) %>
+%   end
+% end
+%
+% if issue.relations?
+<%= 'Relations'.yellow %>:
+%   issue.relations.each do |r|
+%     issue_id = r.prefix_options[:issue_id]
+%     issue_to_id = r.issue_to_id
+%     relation_type = r.relation_type
+  * <%= issue_id == issue.id ? 'this' : issue_id %> <%= relation_type %> <%= issue_to_id == issue.id ? 'this' : issue_to_id %>
+%   end
+
+% end
+%
+% if issue.description? && !issue.description.empty?
+
+<%= issue.description %>
+
+
+% end
+%
+% if issue.journals? && journals_limit > 0
+%   journals = []
+%   issue.journals.reverse.each do |j|
+%     break if journals.size > journals_limit
+%     next unless j.notes?
+%     journals.push j
+%   end
+
+%   journals.reverse.each do |j|
+
+<%= "----------\n".yellow %>
+%     journal_info = { 'From' => "#{j.user.name} (#{j.user.id})",
+%                      'Created' => j.created_on }
+%
+%     journal_info.each do |k, v|
+<%= "#{k}:".ljust(ljust_value).yellow %> <%= v %>
+
+%     end
+
+
+<%= j.notes %>
+
+
+%   end
+
+% end

data/lib/redmine_cli.rb

@@ -5,11 +5,12 @@ require 'i18n'
 I18n.load_path = Dir["#{File.dirname __FILE__}/assets/messages/*"]
 
 # helpers
-Dir[File.expand_path('../redmine_cli/helpers/*.rb', __FILE__)].each { |f| require f }
+Dir[File.expand_path('../redmine_cli/helpers/**/*.rb', __FILE__)].each { |f| require f }
 
 require 'redmine_cli/version'
+require 'redmine_cli/exceptions'
 require 'redmine_cli/config'
-I18n.locale = RedmineCLI::Config['locale'] || :en
+I18n.locale = RedmineCLI::Config['locale']
 
 require 'redmine_cli/template_renderer'
 Dir[File.expand_path('../redmine_cli/subcommands/*.rb', __FILE__)].each { |f| require f }

data/lib/redmine_cli/exceptions.rb

@@ -0,0 +1,5 @@
+module RedmineCLI
+  class UserNotFound < StandardError; end
+  class BadInputTime < StandardError; end
+  class EmptyList < StandardError; end
+end

data/lib/redmine_cli/helpers/input.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'tempfile'
 
 require_relative 'output'
 
@@ -10,6 +11,59 @@ module RedmineCLI
     module Input
       include Helpers::Output
 
+      def ask_from_text_editor(welcome_message = '')
+        file = Tempfile.open('redmine_cli') do |f|
+          f.write welcome_message
+          f
+        end
+
+        editor = Config['editor'] || ENV['EDITOR'] || 'nano'
+
+        system(editor + ' ' + file.path)
+        result = File.read(file)
+        file.unlink
+
+        result
+      end
+
+      #
+      # prints names as enumerable list and asks user for element
+      #
+      def ask_for_object(object_list)
+        fail EmptyList if object_list.size.zero?
+
+        # From 1
+        i = 0
+        object_list = object_list.map { |obj| [(i += 1), obj] }.to_h
+
+        print_object_list(object_list)
+        puts
+        input = ask m(:enter_object_number),
+                    default: '1',
+                    limited_to: ->(str) { (1..i).cover? str.to_i }
+
+        object_list[input.to_i]
+      end
+
+      #
+      # Parses time from user's input.
+      # Formats: HH:MM; M; H.h
+      #
+      # @param input [String]
+      #
+      def parse_time(input)
+        fail(BadInputTime) unless input =~ /^\d+[\:\.]?\d*/
+
+        if input.include?(':')
+          h, m = input.split(':').map(&:to_i)
+          (60 * h + m) / 60.0
+        elsif input.include?('.')
+          input.to_f
+        else
+          input.to_i
+        end
+      end
+
       #
       # #ask with :limited_to set to url regexp
       #
@@ -73,11 +127,13 @@ module RedmineCLI
       end
 
       def fit_in_limit?(input, limit)
-        fail('limit should be Array or Regexp') unless limit.is_a?(Array) || limit.is_a?(Regexp)
+        case limit
+        when Array then limit.include?(input)
+        when Proc then limit.call(input)
+        when Regexp then limit =~ input
 
-        return limit.include?(input) if limit.is_a? Array
-
-        limit =~ input
+        else fail('limit should be Array or Regexp or Proc')
+        end
       end
 
       def read_line

data/lib/redmine_cli/helpers/issue/update.rb

@@ -0,0 +1,86 @@
+module RedmineCLI
+  module Helpers
+    module Issue
+      #
+      # some methods for `issue update`
+      #
+      module Update
+        include RedmineRest
+        include Helpers::Input
+
+        private
+
+        def update_issue(issue)
+          @errors = []
+
+          update_description(issue)
+          leave_comment(issue)
+          update_done_ratio(issue)
+          update_assigned_to(issue)
+          update_status(issue)
+
+          # it should be last, because it creates new object
+          add_time_entry_to_issue(issue) if @errors.empty?
+
+          @errors.empty?
+        end
+
+        def update_done_ratio(issue)
+          return unless options[:done]
+          issue.done_ratio = options[:done]
+        end
+
+        def update_assigned_to(issue)
+          return unless options[:assign]
+
+          # it can raise exception if there's no such user
+          Models::User.find(options[:assign])
+          issue.assigned_to_id = options[:assign]
+
+        rescue ActiveResource::ResourceNotFound
+          @errors.push "Assigned: #{m(:not_found)}"
+        end
+
+        def update_status(issue)
+          return unless options[:status]
+
+          found_statuses = Models::IssueStatus.all.filter_by_name_substring(options[:status])
+          case found_statuses.size
+          when 0 then @errors.push "Status: #{m(:not_found)}"
+          when 1 then issue.status_id = found_statuses.first.id
+          else issue.status_id = ask_for_object(found_statuses).id
+          end
+        end
+
+        def update_description(issue)
+          return unless options[:description]
+
+          issue.description = ask_from_text_editor(issue.description || '')
+        end
+
+        def leave_comment(issue)
+          return unless options[:comment]
+
+          comment = ask_from_text_editor(m('commands.issue.update.type_comment_here'))
+          return if comment.strip.empty?
+
+          issue.notes = comment
+        end
+
+        def add_time_entry_to_issue(issue)
+          return unless options[:time]
+
+          hours = parse_time(options[:time])
+          entry = Models::TimeEntry.create issue_id: issue.id,
+                                           hours: hours
+
+          return if entry.persisted?
+          @errors.push "Time: #{m(:creation_error)}"
+
+        rescue BadInputTime
+          @errors.push "Time: #{m(:wrong_format)}"
+        end
+      end
+    end
+  end
+end

data/lib/redmine_cli/helpers/output.rb

@@ -4,6 +4,18 @@ module RedmineCLI
     # Helpers for output
     #
     module Output
+      #
+      # for Helpers::Input.
+      #
+      # Prints keys of `list` and `value.name`
+      #
+      # @param list [Hash]
+      #
+      def print_object_list(list)
+        key_max_len = list.keys.map { |key| key.to_s.size }.max
+        list.each { |k, v| puts "#{k.to_s.ljust(key_max_len)} - #{v.name}" }
+      end
+
       #
       # for Helpers::Input
       #

data/lib/redmine_cli/subcommands/issue.rb

@@ -20,11 +20,42 @@ module RedmineCLI
       end
 
       desc 'show <id>', m('desc.issue.show')
+      option :limit, aliases: ['-l'], type: :numeric, default: 5, desc: m('desc.issue.options.show.limit')
       def show(id)
-        puts erb('issue/show', issue: Models::Issue.find(id))
+        puts erb('issue/show', issue: Models::Issue.find(id), journals_limit: options[:limit])
+
+      rescue ActiveResource::ResourceNotFound # WARNING: it can be raised by associations in template
+        puts m(:not_found)
+      end
+
       #
-      # WARNING: it can be raised by associations in template
+      # TODO:
+      # * estimated time
+      # * priority
+      # * subject
+      # * tracker
+      # * project
+      # * version
+      # * parent (?) - mb it will be in command for relations
       #
+      desc 'update <id>', m('desc.issue.update')
+      option :done,          type: :numeric, aliases: '-d', desc: m('desc.issue.options.update.done')
+      option :assign,        type: :numeric, aliases: '-a', desc: m('desc.issue.options.update.assign')
+      option :time,          type: :string, aliases: '-t', desc: m('desc.issue.options.update.time')
+      option :status,        type: :string, aliases: '-s', desc: m('desc.issue.options.update.status')
+      option :comment,       type: :boolean, aliases: '-c', desc: m('desc.issue.options.update.comment')
+      option :description,   type: :boolean, desc: m('desc.issue.options.update.description')
+      def update(id)
+        # load helpers inside instance method for better performance
+        self.class.include Helpers::Issue::Update
+
+        issue = Models::Issue.find(id)
+        if update_issue(issue) # update_issue will return nil/false if something goes wrong
+          puts m(issue.save ? :success : :error)
+        else
+          @errors.each { |e| puts e }
+        end
+
       rescue ActiveResource::ResourceNotFound
         puts m(:not_found)
       end

data/lib/redmine_cli/template_renderer.rb

@@ -1,12 +1,14 @@
 require 'erb'
 require 'colorize'
 
+require_relative 'config'
+
 module RedmineCLI
   #
   # Renders templates
   #
   module TemplateRenderer
-    @template_directory = File.expand_path('../../assets/templates', __FILE__)
+    @template_directory = File.expand_path("../../assets/templates/#{Config.locale}", __FILE__)
 
     #
     # finds template and renders it

data/lib/redmine_cli/version.rb

@@ -1,3 +1,3 @@
 module RedmineCLI
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/redmine_cli.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor', '~> 0.19'
   spec.add_dependency 'i18n', '~> 0.7'
-  spec.add_dependency 'redmine_rest', '0.2.0'
+  spec.add_dependency 'redmine_rest', '0.4.0'
   spec.add_dependency 'non_config', '0.1.2'
   spec.add_dependency 'colorize', '~> 0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dmitriy Non
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: non_config
   requirement: !ruby/object:Gem::Requirement
@@ -157,12 +157,14 @@ files:
 - exe/redmine
 - lib/assets/default_config.yml
 - lib/assets/messages/en.yml
-- lib/assets/templates/issue/list.erb
-- lib/assets/templates/issue/show.erb
-- lib/assets/templates/user/find.erb
+- lib/assets/templates/en/issue/list.erb
+- lib/assets/templates/en/issue/show.erb
+- lib/assets/templates/en/user/find.erb
 - lib/redmine_cli.rb
 - lib/redmine_cli/config.rb
+- lib/redmine_cli/exceptions.rb
 - lib/redmine_cli/helpers/input.rb
+- lib/redmine_cli/helpers/issue/update.rb
 - lib/redmine_cli/helpers/monkey_patching.rb
 - lib/redmine_cli/helpers/output.rb
 - lib/redmine_cli/subcommands/conf.rb

data/lib/assets/templates/issue/show.erb

@@ -1,26 +0,0 @@
-
-ID:           <%= issue.id %>
-Subject:      <%= issue.subject %>
-Status:       <%= issue.status.name %>
-Priority:     <%= issue.priority.name %>
-Readiness:    <%= issue.done_ratio + '%' %>
-% if issue.project?
-Project:      <%= issue.project.name %>
-% end
-% if issue.version?
-Version:      <%= issue.version.name %>
-% end
-% if issue.assigned_to?
-Assigned to:  <%= issue.assigned_to.name %> (<%= issue.assigned_to.id %>)
-% end
-Author:       <%= issue.author.name %> (<%= issue.author.id %>)
-% if issue.description? && !issue.description.empty?
-
-*****
-
-<%= issue.description %>
-
-
-*****
-% end
-