jirify 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3bdf3d78cad93234c987b4f0fe19a1c90909107532c2f6b371dd94078e9574f
-  data.tar.gz: bb9d83d6a6506ab4e310378656f0750eaded4c8a111d50f14d3664a858d1efa4
+  metadata.gz: 07d9648da98d02b0aea77481668a386b9182bdf777ca242ad61c6e5c7e793602
+  data.tar.gz: 494f816f3e49f388343949ea025fd615065e895f0f8036801b85f120206197d0
 SHA512:
-  metadata.gz: 0fc9f799bcc20fecc4cb44fbb528de7a99fe981b63046379f9d5339ae8c29a64ed9dd598f8a8c3c5894f74ef1494a3172ef2a0cc1fd432628a2704694d34f5fb
-  data.tar.gz: f4a5c0203a6317822c3a62b5863f4e80c3760c08fa51f0014ab9d59dc68a8e3c301a831cf4dcab20dec23104bb9d71fbaeebc4f2bc3bcef952e05f9e8f277b21
+  metadata.gz: 6bff2d97e9fe24848423aa4b3f4108e53bba6953603a04b3fe703c9aeba4ccec242a0f3d5308d3889b7efae71cecc2a119ba3003c186d78b663ec55a6ec4738a
+  data.tar.gz: 71c8810f34cd135794a64a492b0510d8a220e7ef9868e3abde4c1a601129c43e66182fbb17a0ad899baabae186a450d3cc11fdb2c43e69fbe91c35de5c2933c9

data/README.md

@@ -8,14 +8,17 @@ A simple ruby gem that helps me work with jira
 ## Installation
 1. Run `gem install jirify`.
 1. Execute `jira setup` and go through the setup process.
-1. Optionally source `$HOME/.jirify/jirify.bash_completion.sh` to have autocomplete in bash.
+1. Optionally source `$HOME/.jirify/jirify.bash_completion.sh` to have
+autocomplete in bash.
 1. Execute `jira` and `jira <command> help` to learn about available commands.
 
 ## Config Explained
 Currently, the config structure of `jirify` is:
 - `$HOME/.jirify` folder that contains:
   - `.jirify` - yaml file generated by `jira setup`
-  - `jirify.bash_completion.sh` - bash completion script you can source. This is placed here by `jira setup`, so if you don't see it or you want to refresh it, run `jira setup` again.
+  - `jirify.bash_completion.sh` - bash completion script you can source.
+  This is placed here by `jira setup`, so if you don't see it or you want to
+  refresh it, run `jira setup` again.
   - `.cache` - cache for completion script
 
 ### Config file: `$HOME/.jirify/.jirify`
@@ -31,4 +34,18 @@ options:
 ```
 
 ## To Do
-- Add ability to define mapping between custom statuses and custom transitions in config.
+- Tests:
+  - [ ] Test CLI classes.
+  - [ ] Test UI classes.
+  - [ ] Test `Models::Issue`.
+  - [ ] Test `Models::Transition`, `Models::BaseList` (?).
+  - [ ] Test `Config::copy_bash_completion!`.
+- [ ] Refactor Models - `BaseList` doesn't make much sense.
+- [x] ~~Refactor `SprintCell`:~~
+  - [x] ~~It should be a more general `IssueRenderer`.~~
+  - [x] ~~Use it for `jira issues describe` with additional option to draw border.~~
+- [ ] Adjust `jira issues mine` to terminal width.
+- [ ] Add ability to define mapping between custom statuses and custom
+transitions in config.
+- [ ] Add ability to specify custom filters when listing issues (both
+`jira sprint` and `jira issues`)

data/lib/jirify/cli/issue.rb

@@ -47,14 +47,20 @@ module Jirify
       desc 'describe [ISSUE]', 'Describes an issue'
       def describe(issue_id)
         issue = get_issue_or_exit issue_id
-        cell = UI::SprintCell.new(issue, IO.console.winsize[1])
+
+        issue_renderer = UI::IssueRenderer.new(issue)
 
         options = {}
+
         options[:url] = true
         options[:summary] = true
         options[:assignee] = true
-
-        say cell.to_s(options)
+        begin
+          say issue_renderer.as_card(options)
+        rescue UI::WindowTooNarrow
+          say ColorizedString['ERROR: Your terminal window is too narrow to print the sprint table!']
+            .white.on_red.bold
+        end
       end
 
       #-------------------------#
@@ -214,7 +220,7 @@ module Jirify
         issue = Models::Issue.find_by_id(issue_id)
 
         if issue.nil?
-          say ColorizedString['  ERROR: Issue not found  '].white.on_red.bold
+          say ColorizedString['ERROR: Issue not found'].white.on_red.bold
           exit(0)
         else
           issue

data/lib/jirify/cli/sprint.rb

@@ -10,15 +10,16 @@ module Jirify
       verbose = Config.always_verbose || options[:verbose]
       issues  = Models::Sprint.issues_in_current_sprint(options[:mine])
 
-      duplicate_options = options.dup
+      modified_options = options.dup
       if verbose
-        duplicate_options[:assignee] = true
-        duplicate_options[:url] = true
-        duplicate_options[:summary] = true
+        modified_options[:assignee] = true
+        modified_options[:url]      = true
+        modified_options[:summary]  = true
       end
-      say UI::SprintTable.new(issues).to_table(duplicate_options)
-    rescue UI::WindowTooNarrow, StandardError
-      say ColorizedString['  ERROR: Your terminal window is too narrow to print the sprint table!  ']
+
+      say UI::SprintTable.new(issues).to_table(modified_options)
+    rescue UI::WindowTooNarrow
+      say ColorizedString['ERROR: Your terminal window is too narrow to print the sprint table!']
         .white.on_red.bold
     end
   end

data/lib/jirify/config.rb

@@ -40,7 +40,7 @@ module Jirify
 
       def verbose=(value)
         unless initialized?
-          puts ColorizedString['  ERROR: You must initialize Jirify first!  '].white.on_red.bold
+          puts ColorizedString['ERROR: You must initialize Jirify first!'].white.on_red.bold
           exit(0)
         end
 
@@ -51,7 +51,7 @@ module Jirify
 
       def options
         unless initialized?
-          puts ColorizedString['  ERROR: You must initialize Jirify first!  '].white.on_red.bold
+          puts ColorizedString['ERROR: You must initialize Jirify first!'].white.on_red.bold
           exit(0)
         end
 

data/lib/jirify/ui/issue_renderer.rb

@@ -0,0 +1,100 @@
+module Jirify
+  module UI
+    class WindowTooNarrow < StandardError; end
+
+    class IssueRenderer
+      attr_reader :issue
+
+      def initialize(issue)
+        @issue = issue
+      end
+
+      def as_table_cell(options)
+        options[:max_length] ||= IO.console.winsize[1] - 4
+        options[:summary]    ||= false
+        options[:url]        ||= false
+        options[:assignee]   ||= false
+
+        raise UI::WindowTooNarrow, 'The terminal window is too narrow.' if options[:max_length] <= key.size
+
+        row = ''
+        row << "#{ColorizedString[key].bold}"
+        row << summary_line(options)  if show_summary?(options)
+        row << url_line               if show_url?(options)
+        row << assignee_line(options) if show_assignee?(options)
+        row
+      end
+
+      def as_card(options)
+        card = as_table_cell(options)
+        Terminal::Table.new(rows: [[card]])
+      rescue RuntimeError
+        raise UI::WindowTooNarrow, 'The terminal window is too narrow.'
+      end
+
+      protected
+
+      def key
+        issue.key
+      end
+
+      def summary
+        issue.summary
+      end
+
+      def show_assignee?(options)
+        options[:assignee] && !options[:mine]
+      end
+
+      def assignee
+        if issue.assignee.nil?
+          'Unassigned'
+        else
+          issue.assignee.displayName
+        end
+      end
+
+      def assignee_line(options)
+        max_length = options[:max_length]
+        assignee_line = assignee
+        assignee_line = "#{assignee[0...max_length - 3]}..." if assignee_line.size >= max_length
+
+        "\n#{assignee_line.magenta}"
+      end
+
+      def show_url?(options)
+        url.size <= options[:max_length] && options[:url]
+      end
+
+      def url
+        "#{Config.issue_browse_url}#{issue.key}"
+      end
+
+      def url_line
+        "\n#{ColorizedString[url].blue.underline}"
+      end
+
+      def show_summary?(options)
+        options[:summary]
+      end
+
+      def summary_line(options)
+        "\n#{wrap(summary.strip, options[:max_length])}"
+      end
+
+      def wrap(string, columns, character = "\n")
+        return '' if string.nil?
+
+        start_pos = columns
+        while start_pos < string.length
+          space = string.rindex(' ', start_pos) || start_pos - 1
+          string.slice!(space)
+          string.insert(space, character)
+          start_pos = space + columns + 1
+        end
+
+        string
+      end
+    end
+  end
+end

data/lib/jirify/ui/sprint_table.rb

@@ -9,11 +9,18 @@ module Jirify
       end
 
       def to_table(options)
+        return '' if issues.empty?
+
+        # group issues by status name
         grouped_issues = issues.group_by do |issue|
           options[:all_columns] ? issue.status.name : issue.status.statusCategory['name']
         end
 
-        grouped_issues_as_table(grouped_issues, options)
+        Terminal::Table.new(
+          headings: headings(grouped_issues),
+          rows: issues_as_rows(grouped_issues.values, options),
+          style: table_style
+        )
       end
 
       protected
@@ -26,63 +33,81 @@ module Jirify
         { width: terminal_width, border_x: '-', border_i: 'x' }
       end
 
+      def get_max_cell_length(grouped_issues)
+        col_padding_per_row = grouped_issues.size * 3 + 1
+        (terminal_width - col_padding_per_row) / grouped_issues.size
+      end
+
       def headings(grouped_issues)
-        sorted_headings = grouped_issues.keys.sort_by do |name|
+        max_cell_length = get_max_cell_length(grouped_issues)
+
+        sorted_headings = sort_headings(grouped_issues.keys)
+        sorted_headings.map do |heading|
+          original_heading = heading
+          heading = fit_heading_to_cell(heading, max_cell_length)
+
+          case original_heading
+          when Config.statuses['todo']        then ColorizedString[heading].white.on_black.bold
+          when Config.statuses['in_progress'] then ColorizedString[heading].white.on_blue.bold
+          when Config.statuses['in_review']   then ColorizedString[heading].white.on_yellow.bold
+          when Config.statuses['blocked']     then ColorizedString[heading].white.on_red.bold
+          when Config.statuses['done']        then ColorizedString[heading].white.on_green.bold
+          else                                     ColorizedString[heading].white.on_green.bold
+          end
+        end
+      end
+
+      def sort_headings(heading_names)
+        heading_names.sort_by! do |name|
           status_index = Models::Status.status_order.index(name)
           if status_index.nil?
+            # If status is not defined in order, put it at the end
             grouped_issues.keys.length
           else
             status_index
           end
         end
-
-        sorted_headings.map! do |name|
-          case name
-          when Config.statuses['todo']        then ColorizedString[name].white.on_black.bold
-          when Config.statuses['in_progress'] then ColorizedString[name].white.on_blue.bold
-          when Config.statuses['in_review']   then ColorizedString[name].white.on_yellow.bold
-          when Config.statuses['blocked']     then ColorizedString[name].white.on_red.bold
-          when Config.statuses['done']        then ColorizedString[name].white.on_green.bold
-          else                                     ColorizedString[name].white.on_green.bold
-          end
-        end
       end
 
-      def grouped_issues_as_table(grouped_issues, options)
-        transposed = transpose(grouped_issues.values, options)
-        return nil if transposed.empty?
-
-        Terminal::Table.new(
-          headings: headings(grouped_issues),
-          rows: transposed,
-          style: table_style
-        )
+      def fit_heading_to_cell(name, max_cell_length)
+        if name.length >= max_cell_length
+          # If the heading name is longer than the max length, add ellipsis.
+          "#{name[0...max_cell_length - 3]}..."
+        else
+          # Add spaces around the heading name to center it.
+          buffer = max_cell_length - name.length
+          left = ' ' * (buffer / 2)
+          right = ' ' * (buffer / 2)
+          right += ' ' if buffer.odd?
+
+          "#{left}#{name}#{right}"
+        end
       end
 
-      def transpose(grouped_issues, options)
-        col_padding_per_row = grouped_issues.size * 4
-        max_cell_length     = (terminal_width - col_padding_per_row) / grouped_issues.size
+      def issues_as_rows(grouped_issues, options)
+        options[:max_length] = get_max_cell_length(grouped_issues)
 
-        # workaround - not all groups have the same size
+        # Workaround - not all groups have the same size.
         l = grouped_issues.map(&:length).max
         grouped_as_array = grouped_issues.map { |e| e.values_at(0...l) }
 
-        grouped_as_array.sort_by! do |row|
-          issue = row.find { |i| !i.nil? }
-          issue.status
-        end
-
+        # Sort columns by status and transpose them to become rows.
+        grouped_as_array.sort_by! { |row| row.first.status }
         transposed = grouped_as_array.transpose
 
+        # Map every Issue in every row to its display representation.
         transposed.map! do |row|
           row.map do |issue|
             next if issue.nil?
-            SprintCell.new(issue, max_cell_length).to_s(options)
+            IssueRenderer.new(issue).as_table_cell(options)
           end
         end
 
+        # add separators after each row
         transposed = transposed.zip([:separator] * transposed.size).flatten(1)
+        # remove the separator after the last row, it's not needed
         transposed.pop
+
         transposed
       end
     end

data/lib/jirify/version.rb

@@ -1,3 +1,3 @@
 module Jirify
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/jirify.rb

@@ -18,7 +18,7 @@ require 'jirify/models/sprint'
 require 'jirify/models/project'
 require 'jirify/models/project_list'
 
-require 'jirify/ui/sprint_cell'
+require 'jirify/ui/issue_renderer'
 require 'jirify/ui/sprint_table'
 
 require 'jirify/cli/setup'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirify
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Georgi Gardev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -166,26 +166,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.1'
-- !ruby/object:Gem::Dependency
-  name: rake-release
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -280,7 +260,7 @@ files:
 - lib/jirify/models/transition.rb
 - lib/jirify/models/transition_list.rb
 - lib/jirify/monkey_patches/jira_issue.rb
-- lib/jirify/ui/sprint_cell.rb
+- lib/jirify/ui/issue_renderer.rb
 - lib/jirify/ui/sprint_table.rb
 - lib/jirify/version.rb
 homepage: https://github.com/GeorgeSG/jirify

data/lib/jirify/ui/sprint_cell.rb

@@ -1,84 +0,0 @@
-module Jirify
-  module UI
-    class WindowTooNarrow < StandardError; end
-
-    class SprintCell
-      attr_reader :issue, :max_cell_length
-
-      def initialize(issue, max_cell_length)
-        @issue = issue
-        @max_cell_length = max_cell_length
-      end
-
-      def to_s(options)
-        raise UI::WindowTooNarrow, 'The terminal window is too narrow.' if max_cell_length <= key.size
-
-        row = ''
-        row << key_and_summary_lines(options, max_cell_length)
-        row << "\n#{ColorizedString[url].blue.underline}" if display_url?(options)
-        row << assignee_line(max_cell_length) if show_assignee?(options)
-        row
-      end
-
-      protected
-
-      def key
-        issue.key
-      end
-
-      def summary
-        issue.summary
-      end
-
-      def show_assignee?(options)
-        options[:assignee] && !options[:mine]
-      end
-
-      def assignee
-        if issue.assignee.nil?
-          'Unassigned'
-        else
-          issue.assignee.displayName
-        end
-      end
-
-      def url
-        "#{Config.issue_browse_url}#{issue.key}"
-      end
-
-      def display_url?(options)
-        url.size <= max_cell_length && options[:url]
-      end
-
-      def wrap(string, columns, character = "\n")
-        return '' if string.nil?
-
-        start_pos = columns
-        while start_pos < string.length
-          space = string.rindex(' ', start_pos) || start_pos + 1
-          string.slice!(space)
-          string.insert(space, character)
-          start_pos = space + columns + 1
-        end
-
-        string
-      end
-
-      def key_and_summary_lines(options, max_cell_length)
-        bold_key = ColorizedString[key].bold
-        return bold_key unless options[:summary]
-
-        row = "#{bold_key}\n"
-        row << wrap(summary.strip, max_cell_length)
-        row
-      end
-
-      def assignee_line(max_cell_length)
-        assignee_line = assignee
-        assignee_line = "#{assignee[0...max_cell_length - 3]}..." if assignee_line.size >= max_cell_length
-
-        "\n#{assignee_line.magenta}"
-      end
-    end
-  end
-end