abt-cli 0.0.11 → 0.0.16

data/lib/abt/providers/devops/base_command.rb

@@ -3,24 +3,39 @@
 module Abt
   module Providers
     module Devops
-      class BaseCommand
-        attr_reader :arg_str, :organization_name, :project_name, :board_id, :work_item_id, :cli, :config
+      class BaseCommand < Abt::Cli::BaseCommand
+        attr_reader :organization_name, :project_name, :board_id, :work_item_id, :config
 
-        def initialize(arg_str:, cli:)
-          @arg_str = arg_str
+        def initialize(path:, cli:, **)
+          super
 
           @config = Configuration.new(cli: cli)
-          @cli = cli
 
-          if arg_str.nil?
-            use_current_args
+          if path.nil?
+            use_current_path
           else
-            use_arg_str(arg_str)
+            use_path(path)
           end
         end
 
         private
 
+        def require_board!
+          return if organization_name && project_name && board_id
+
+          cli.abort 'No current/specified board. Did you initialize DevOps?'
+        end
+
+        def require_work_item!
+          unless organization_name && project_name && board_id
+            cli.abort 'No current/specified board. Did you initialize DevOps and pick a work item?'
+          end
+
+          return if work_item_id
+
+          cli.abort 'No current/specified work item. Did you pick a DevOps work item?'
+        end
+
         def sanitize_work_item(work_item)
           return nil if work_item.nil?
 
@@ -39,28 +54,28 @@ module Abt
         end
 
         def print_board(organization_name, project_name, board)
-          arg_str = "#{organization_name}/#{project_name}/#{board['id']}"
+          path = "#{organization_name}/#{project_name}/#{board['id']}"
 
-          cli.print_provider_command('devops', arg_str, board['name'])
+          cli.print_scheme_argument('devops', path, board['name'])
           # cli.warn board['url'] if board.key?('url') && cli.output.isatty # TODO: Web URL
         end
 
         def print_work_item(organization, project, board, work_item)
-          arg_str = "#{organization}/#{project}/#{board['id']}/#{work_item['id']}"
+          path = "#{organization}/#{project}/#{board['id']}/#{work_item['id']}"
 
-          cli.print_provider_command('devops', arg_str, work_item['name'])
+          cli.print_scheme_argument('devops', path, work_item['name'])
           cli.warn work_item['url'] if work_item.key?('url') && cli.output.isatty
         end
 
-        def use_current_args
+        def use_current_path
           @organization_name = config.organization_name
           @project_name = config.project_name
           @board_id = config.board_id
           @work_item_id = config.work_item_id
         end
 
-        def use_arg_str(arg_str)
-          args = arg_str.to_s.split('/')
+        def use_path(path)
+          args = path.to_s.split('/')
 
           if args.length < 3
             cli.abort 'Argument format is <organization>/<project>/<board-id>[/<work-item-id>]'
@@ -73,7 +88,8 @@ module Abt
           Abt::Providers::Devops::Api.new(organization_name: organization_name,
                                           project_name: project_name,
                                           username: config.username_for_organization(organization_name),
-                                          access_token: config.access_token_for_organization(organization_name))
+                                          access_token: config.access_token_for_organization(organization_name),
+                                          cli: cli)
         end
       end
     end

data/lib/abt/providers/devops/commands/boards.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Boards < BaseCommand
+          def self.usage
+            'abt boards devops'
+          end
+
+          def self.description
+            'List all boards - useful for piping into grep etc'
+          end
+
+          def perform
+            if organization_name.nil?
+              cli.abort 'No organization selected. Did you initialize DevOps?'
+            end
+            cli.abort 'No project selected. Did you initialize DevOps?' if project_name.nil?
+
+            boards.map do |board|
+              print_board(organization_name, project_name, board)
+            end
+          end
+
+          private
+
+          def boards
+            @boards ||= api.get_paged('work/boards')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/branch_name.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class BranchName < BaseCommand
+          def self.usage
+            'abt branch-name devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
+          end
+
+          def self.description
+            'Suggest a git branch name for the current/specified work-item.'
+          end
+
+          def perform
+            require_work_item!
+
+            cli.puts name
+          rescue HttpError::NotFoundError
+            args = [organization_name, project_name, board_id, work_item_id].compact
+            cli.warn 'Unable to find work item for configuration:'
+            cli.abort "devops:#{args.join('/')}"
+          end
+
+          private
+
+          def name
+            str = work_item['id']
+            str += '-'
+            str += work_item['name'].downcase.gsub(/[^\w]/, '-')
+            str.gsub(/-+/, '-')
+          end
+
+          def work_item
+            @work_item ||= begin
+              work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+              sanitize_work_item(work_item)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/clear.rb

@@ -5,17 +5,28 @@ module Abt
     module Devops
       module Commands
         class Clear < BaseCommand
-          def self.command
-            'clear devops'
+          def self.usage
+            'abt clear devops'
           end
 
           def self.description
-            'Clear DevOps config for current git repository'
+            'Clear DevOps configuration'
           end
 
-          def call
-            cli.warn 'Clearing configuration'
-            config.clear_local
+          def self.flags
+            [
+              ['-g', '--global', 'Clear global instead of local DevOp configuration (credentials etc.)'],
+              ['-a', '--all', 'Clear all DevOp configuration']
+            ]
+          end
+
+          def perform
+            if flags[:global] && flags[:all]
+              abort('Flags --global and --all cannot be used at the same time')
+            end
+
+            config.clear_local unless flags[:global]
+            config.clear_global if flags[:global] || flags[:all]
           end
         end
       end

data/lib/abt/providers/devops/commands/current.rb

@@ -5,15 +5,17 @@ module Abt
     module Devops
       module Commands
         class Current < BaseCommand
-          def self.command
-            'current devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
+          def self.usage
+            'abt current devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
           end
 
           def self.description
             'Get or set DevOps configuration for current git repository'
           end
 
-          def call
+          def perform
+            require_board!
+
             if same_args_as_config? || !config.local_available?
               show_current_configuration
             else
@@ -25,13 +27,7 @@ module Abt
           private
 
           def show_current_configuration
-            if organization_name.nil?
-              cli.warn 'No organization selected'
-            elsif project_name.nil?
-              cli.warn 'No project selected'
-            elsif board_id.nil?
-              cli.warn 'No board selected'
-            elsif work_item_id.nil?
+            if work_item_id.nil?
               print_board(organization_name, project_name, board)
             else
               print_work_item(organization_name, project_name, board, work_item)

data/lib/abt/providers/devops/commands/harvest_time_entry_data.rb

@@ -5,15 +5,17 @@ module Abt
     module Devops
       module Commands
         class HarvestTimeEntryData < BaseCommand
-          def self.command
-            'harvest-time-entry-data devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
+          def self.usage
+            'abt harvest-time-entry-data devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
           end
 
           def self.description
             'Print Harvest time entry data for DevOps work item as json. Used by harvest start script.'
           end
 
-          def call
+          def perform
+            require_work_item!
+
             body = {
               notes: notes,
               external_reference: {

data/lib/abt/providers/devops/commands/init.rb

@@ -8,21 +8,21 @@ module Abt
           AZURE_DEV_URL_REGEX = %r{^https://dev\.azure\.com/(?<organization>[^/]+)/(?<project>[^/]+)}.freeze
           VS_URL_REGEX = %r{^https://(?<organization>[^.]+)\.visualstudio\.com/(?<project>[^/]+)}.freeze
 
-          def self.command
-            'init devops'
+          def self.usage
+            'abt init devops'
           end
 
           def self.description
             'Pick DevOps board for current git repository'
           end
 
-          def call
+          def perform
             cli.abort 'Must be run inside a git repository' unless config.local_available?
 
             @organization_name = config.organization_name = organization_name_from_url
             @project_name = config.project_name = project_name_from_url
 
-            board = cli.prompt_choice 'Select a project work board', boards
+            board = cli.prompt.choice 'Select a project work board', boards
 
             config.board_id = board['id']
 
@@ -52,7 +52,7 @@ module Abt
           def project_url
             @project_url ||= begin
               loop do
-                url = cli.prompt([
+                url = cli.prompt.text([
                   'Please provide the URL for the devops project',
                   'For instance https://{organization}.visualstudio.com/{project} or https://dev.azure.com/{organization}/{project}',
                   '',

data/lib/abt/providers/devops/commands/pick.rb

@@ -5,35 +5,46 @@ module Abt
     module Devops
       module Commands
         class Pick < BaseCommand
-          def self.command
-            'pick devops[:<organization-name>/<project-name>/<board-id>]'
+          def self.usage
+            'abt pick devops[:<organization-name>/<project-name>/<board-id>]'
           end
 
           def self.description
             'Pick work item for current git repository'
           end
 
-          def call
+          def self.flags
+            [
+              ['-d', '--dry-run', 'Keep existing configuration']
+            ]
+          end
+
+          def perform
             cli.abort 'Must be run inside a git repository' unless config.local_available?
+            require_board!
 
             cli.warn "#{project_name} - #{board['name']}"
 
             work_item = select_work_item
+            print_work_item(organization_name, project_name, board, work_item)
+
+            return if flags[:"dry-run"]
+
+            update_config!(work_item)
+          end
 
-            # We might have gotten org, project, board as arg str
+          private
+
+          def update_config!(work_item)
             config.organization_name = organization_name
             config.project_name = project_name
             config.board_id = board_id
             config.work_item_id = work_item['id']
-
-            print_work_item(organization_name, project_name, board, work_item)
           end
 
-          private
-
           def select_work_item
             loop do
-              column = cli.prompt_choice 'Which column?', columns
+              column = cli.prompt.choice 'Which column?', columns
               cli.warn 'Fetching work items...'
               work_items = work_items_in_column(column)
 
@@ -42,22 +53,20 @@ module Abt
                 next
               end
 
-              work_item = cli.prompt_choice 'Select a work item', work_items, true
+              work_item = cli.prompt.choice 'Select a work item', work_items, true
               return work_item if work_item
             end
           end
 
           def work_items_in_column(column)
-            wiql = <<~WIQL
-              SELECT [System.Id]
-              FROM WorkItems
-              WHERE [System.BoardColumn] = '#{column['name']}'
-              ORDER BY [Microsoft.VSTS.Common.BacklogPriority] ASC
-            WIQL
-
-            response = api.post('wit/wiql', Oj.dump({ query: wiql }, mode: :json))
-            ids = response['workItems'].map { |work_item| work_item['id'] }
-            work_items = api.get_paged('wit/workitems', ids: ids.join(','))
+            work_items = api.work_item_query(
+              <<~WIQL
+                SELECT [System.Id]
+                FROM WorkItems
+                WHERE [System.BoardColumn] = '#{column['name']}'
+                ORDER BY [Microsoft.VSTS.Common.BacklogPriority] ASC
+              WIQL
+            )
 
             work_items.map { |work_item| sanitize_work_item(work_item) }
           end

data/lib/abt/providers/devops/commands/share.rb

@@ -5,25 +5,19 @@ module Abt
     module Devops
       module Commands
         class Share < BaseCommand
-          def self.command
-            'share devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
+          def self.usage
+            'abt share devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
           end
 
           def self.description
             'Print DevOps config string'
           end
 
-          def call
-            if organization_name.nil?
-              cli.warn 'No organization selected'
-            elsif project_name.nil?
-              cli.warn 'No project selected'
-            elsif board_id.nil?
-              cli.warn 'No board selected'
-            else
-              args = [organization_name, project_name, board_id, work_item_id].compact
-              cli.print_provider_command('devops', args.join('/'))
-            end
+          def perform
+            require_work_item!
+
+            args = [organization_name, project_name, board_id, work_item_id].compact
+            cli.print_scheme_argument('devops', args.join('/'))
           end
         end
       end

data/lib/abt/providers/devops/commands/work-items.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class WorkItems < BaseCommand
+          def self.usage
+            'abt work-items devops'
+          end
+
+          def self.description
+            'List all work items on board - useful for piping into grep etc.'
+          end
+
+          def perform
+            require_board!
+
+            work_items.each do |work_item|
+              print_work_item(organization_name, project_name, board, work_item)
+            end
+          end
+
+          private
+
+          def work_items
+            @work_items ||= begin
+              cli.warn 'Fetching work items...'
+              api.work_item_query(
+                <<~WIQL
+                  SELECT [System.Id]
+                  FROM WorkItems
+                  ORDER BY [System.Title] ASC
+                WIQL
+              ).map { |work_item| sanitize_work_item(work_item) }
+            end
+          end
+
+          def board
+            @board ||= api.get("work/boards/#{board_id}")
+          end
+        end
+      end
+    end
+  end
+end