abt-cli 0.0.19 → 0.0.24

data/lib/abt/providers/asana/path.rb

@@ -4,15 +4,15 @@ module Abt
   module Providers
     module Asana
       class Path < String
-        PATH_REGEX = %r{^(?<project_gid>\d+)?(/(?<task_gid>\d+))?$}.freeze
+        PATH_REGEX = %r{^(?<project_gid>\d+)?/?(?<task_gid>\d+)?$}.freeze
 
-        def self.from_ids(project_gid = nil, task_gid = nil)
-          path = project_gid ? [project_gid, *task_gid].join('/') : ''
-          new path
+        def self.from_ids(project_gid: nil, task_gid: nil)
+          path = project_gid ? [project_gid, *task_gid].join("/") : ""
+          new(path)
         end
 
-        def initialize(path = '')
-          raise Abt::Cli::Abort, "Invalid path: #{path}" unless path =~ PATH_REGEX
+        def initialize(path = "")
+          raise Abt::Cli::Abort, "Invalid path: #{path}" unless PATH_REGEX.match?(path)
 
           super
         end

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

@@ -4,9 +4,9 @@ module Abt
   module Providers
     module Devops
       class Api
-        VERBS = %i[get post put].freeze
+        VERBS = [:get, :post, :put].freeze
 
-        CONDITIONAL_ACCESS_POLICY_ERROR_CODE = 'VS403463'
+        CONDITIONAL_ACCESS_POLICY_ERROR_CODE = "VS403463"
 
         attr_reader :organization_name, :project_name, :username, :access_token, :cli
 
@@ -26,18 +26,18 @@ module Abt
 
         def get_paged(path, query = {})
           result = request(:get, path, query)
-          result['value']
+          result["value"]
 
           # TODO: Loop if necessary
         end
 
         def work_item_query(wiql)
-          response = post('wit/wiql', Oj.dump({ query: wiql }, mode: :json))
-          ids = response['workItems'].map { |work_item| work_item['id'] }
+          response = post("wit/wiql", Oj.dump({ query: wiql }, mode: :json))
+          ids = response["workItems"].map { |work_item| work_item["id"] }
 
           work_items = []
           ids.each_slice(200) do |page_ids|
-            work_items += get_paged('wit/workitems', ids: page_ids.join(','))
+            work_items += get_paged("wit/workitems", ids: page_ids.join(","))
           end
 
           work_items
@@ -50,7 +50,7 @@ module Abt
             Oj.load(response.body)
           else
             error_class = Abt::HttpError.error_class_for_status(response.status)
-            encoded_response_body = response.body.force_encoding('utf-8')
+            encoded_response_body = response.body.force_encoding("utf-8")
             raise error_class, "Code: #{response.status}, body: #{encoded_response_body}"
           end
         rescue Abt::HttpError::ForbiddenError => e
@@ -75,9 +75,9 @@ module Abt
 
         def connection
           @connection ||= Faraday.new(api_endpoint) do |connection|
-            connection.basic_auth username, access_token
-            connection.headers['Content-Type'] = 'application/json'
-            connection.headers['Accept'] = 'application/json; api-version=6.0'
+            connection.basic_auth(username, access_token)
+            connection.headers["Content-Type"] = "application/json"
+            connection.headers["Accept"] = "application/json; api-version=6.0"
           end
         end
 
@@ -87,14 +87,14 @@ module Abt
         # https://apidock.com/ruby/ERB/Util/url_encode
         def rfc_3986_encode_path_segment(string)
           string.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/) do |match|
-            format('%%%02X', match.unpack1('C')) # rubocop:disable Style/FormatStringToken
+            format("%%%02X", match.unpack1("C"))
           end
         end
 
         def handle_denied_by_conditional_access_policy!(exception)
           raise exception unless exception.message.include?(CONDITIONAL_ACCESS_POLICY_ERROR_CODE)
 
-          cli.abort <<~TXT
+          cli.abort(<<~TXT)
             Access denied by conditional access policy.
             Try logging into the board using the URL below, then retry the command.
 

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

@@ -19,44 +19,48 @@ module Abt
 
         private
 
+        def require_local_config!
+          abort("Must be run inside a git repository") unless config.local_available?
+        end
+
         def require_board!
           return if organization_name && project_name && board_id
 
-          abort 'No current/specified board. Did you initialize DevOps?'
+          abort("No current/specified board. Did you initialize DevOps?")
         end
 
         def require_work_item!
           unless organization_name && project_name && board_id
-            abort 'No current/specified board. Did you initialize DevOps and pick a work item?'
+            abort("No current/specified board. Did you initialize DevOps and pick a work item?")
           end
 
           return if work_item_id
 
-          abort 'No current/specified work item. Did you pick a DevOps work item?'
+          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?
 
           work_item.merge(
-            'id' => work_item['id'].to_s,
-            'name' => work_item['fields']['System.Title'],
-            'url' => api.url_for_work_item(work_item)
+            "id" => work_item["id"].to_s,
+            "name" => work_item["fields"]["System.Title"],
+            "url" => api.url_for_work_item(work_item)
           )
         end
 
         def print_board(organization_name, project_name, board)
           path = "#{organization_name}/#{project_name}/#{board['id']}"
 
-          cli.print_ari('devops', path, board['name'])
-          warn api.url_for_board(board) if cli.output.isatty
+          cli.print_ari("devops", path, board["name"])
+          warn(api.url_for_board(board)) if cli.output.isatty
         end
 
         def print_work_item(organization, project, board, work_item)
           path = "#{organization}/#{project}/#{board['id']}/#{work_item['id']}"
 
-          cli.print_ari('devops', path, work_item['name'])
-          warn work_item['url'] if work_item.key?('url') && cli.output.isatty
+          cli.print_ari("devops", path, work_item["name"])
+          warn(work_item["url"]) if work_item.key?("url") && cli.output.isatty
         end
 
         def api

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

@@ -6,18 +6,16 @@ module Abt
       module Commands
         class Boards < BaseCommand
           def self.usage
-            'abt boards devops'
+            "abt boards devops"
           end
 
           def self.description
-            'List all boards - useful for piping into grep etc'
+            "List all boards - useful for piping into grep etc"
           end
 
           def perform
-            if organization_name.nil?
-              abort 'No organization selected. Did you initialize DevOps?'
-            end
-            abort 'No project selected. Did you initialize DevOps?' if project_name.nil?
+            abort("No organization selected. Did you initialize DevOps?") if organization_name.nil?
+            abort("No project selected. Did you initialize DevOps?") if project_name.nil?
 
             boards.map do |board|
               print_board(organization_name, project_name, board)
@@ -27,7 +25,7 @@ module Abt
           private
 
           def boards
-            @boards ||= api.get_paged('work/boards')
+            @boards ||= api.get_paged("work/boards")
           end
         end
       end

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

@@ -6,11 +6,11 @@ module Abt
       module Commands
         class BranchName < BaseCommand
           def self.usage
-            'abt branch-name devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
+            "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.'
+            "Suggest a git branch name for the current/specified work-item."
           end
 
           def perform
@@ -21,24 +21,24 @@ module Abt
             args = [organization_name, project_name, board_id, work_item_id].compact
 
             error_message = [
-              'Unable to find work item for configuration:',
+              "Unable to find work item for configuration:",
               "devops:#{args.join('/')}"
             ].join("\n")
-            abort error_message
+            abort(error_message)
           end
 
           private
 
           def name
-            str = work_item['id']
-            str += '-'
-            str += work_item['name'].downcase.gsub(/[^\w]/, '-')
-            str.gsub(/-+/, '-')
+            str = work_item["id"]
+            str += "-"
+            str += work_item["name"].downcase.gsub(/[^\w]/, "-")
+            str.squeeze("-").gsub(/(^-|-$)/, "")
           end
 
           def work_item
             @work_item ||= begin
-              work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+              work_item = api.get_paged("wit/workitems", ids: work_item_id)[0]
               sanitize_work_item(work_item)
             end
           end

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

@@ -6,29 +6,28 @@ module Abt
       module Commands
         class Clear < BaseCommand
           def self.usage
-            'abt clear devops'
+            "abt clear devops"
           end
 
           def self.description
-            'Clear DevOps configuration'
+            "Clear DevOps configuration"
           end
 
           def self.flags
             [
-              ['-g', '--global', 'Clear global instead of local DevOp configuration (credentials etc.)'],
-              ['-a', '--all', 'Clear all DevOp configuration']
+              ["-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
+            abort("Flags --global and --all cannot be used at the same time") if flags[:global] && flags[:all]
 
             config.clear_local unless flags[:global]
             config.clear_global if flags[:global] || flags[:all]
 
-            warn 'Configuration cleared'
+            warn("Configuration cleared")
           end
         end
       end

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

@@ -6,22 +6,21 @@ module Abt
       module Commands
         class Current < BaseCommand
           def self.usage
-            'abt current devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
+            "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'
+            "Get or set DevOps configuration for current git repository"
           end
 
           def perform
-            abort 'Must be run inside a git repository' unless config.local_available?
-
+            require_local_config!
             require_board!
             ensure_valid_configuration!
 
             if path != config.path && config.local_available?
               config.path = path
-              warn 'Configuration updated'
+              warn("Configuration updated")
             end
 
             print_configuration
@@ -39,28 +38,28 @@ module Abt
 
           def ensure_valid_configuration!
             if board.nil?
-              abort 'Board could not be found, ensure that settings for organization, project, and board are correct'
+              abort("Board could not be found, ensure that settings for organization, project, and board are correct")
             end
-            abort "No such work item: ##{work_item_id}" if work_item_id && work_item.nil?
+            abort("No such work item: ##{work_item_id}") if work_item_id && work_item.nil?
           end
 
           def board
             @board ||= begin
-                         warn 'Fetching board...'
-                         api.get("work/boards/#{board_id}")
-                       rescue HttpError::NotFoundError
-                         nil
-                       end
+              warn("Fetching board...")
+              api.get("work/boards/#{board_id}")
+            rescue HttpError::NotFoundError
+              nil
+            end
           end
 
           def work_item
             @work_item ||= begin
-                             warn 'Fetching work item...'
-                             work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
-                             sanitize_work_item(work_item)
-                           rescue HttpError::NotFoundError
-                             nil
-                           end
+              warn("Fetching work item...")
+              work_item = api.get_paged("wit/workitems", ids: work_item_id)[0]
+              sanitize_work_item(work_item)
+            rescue HttpError::NotFoundError
+              nil
+            end
           end
         end
       end

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

@@ -6,51 +6,53 @@ module Abt
       module Commands
         class HarvestTimeEntryData < BaseCommand
           def self.usage
-            'abt harvest-time-entry-data devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
+            "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.'
+            "Print Harvest time entry data for DevOps work item as json. Used by harvest start script."
           end
 
           def perform
             require_work_item!
 
-            body = {
-              notes: notes,
-              external_reference: {
-                id: work_item['id'],
-                group_id: 'AzureDevOpsWorkItem',
-                permalink: work_item['url']
-              }
-            }
-
             puts Oj.dump(body, mode: :json)
           rescue HttpError::NotFoundError
             args = [organization_name, project_name, board_id, work_item_id].compact
 
             error_message = [
-              'Unable to find work item for configuration:',
+              "Unable to find work item for configuration:",
               "devops:#{args.join('/')}"
             ].join("\n")
-            abort error_message
+            abort(error_message)
           end
 
           private
 
+          def body
+            {
+              notes: notes,
+              external_reference: {
+                id: work_item["id"],
+                group_id: "AzureDevOpsWorkItem",
+                permalink: work_item["url"]
+              }
+            }
+          end
+
           def notes
             [
-              'Azure DevOps',
-              work_item['fields']['System.WorkItemType'],
+              "Azure DevOps",
+              work_item["fields"]["System.WorkItemType"],
               "##{work_item['id']}",
-              '-',
-              work_item['name']
-            ].join(' ')
+              "-",
+              work_item["name"]
+            ].join(" ")
           end
 
           def work_item
             @work_item ||= begin
-              work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+              work_item = api.get_paged("wit/workitems", ids: work_item_id)[0]
               sanitize_work_item(work_item)
             end
           end

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

@@ -9,26 +9,29 @@ module Abt
           VS_URL_REGEX = %r{^https://(?<organization>[^.]+)\.visualstudio\.com/(?<project>[^/]+)}.freeze
 
           def self.usage
-            'abt init devops'
+            "abt init devops"
           end
 
           def self.description
-            'Pick DevOps board for current git repository'
+            "Pick DevOps board for current git repository"
           end
 
           def perform
-            abort 'Must be run inside a git repository' unless config.local_available?
+            require_local_config!
+            board = cli.prompt.choice("Select a project work board", boards)
 
-            board = cli.prompt.choice 'Select a project work board', boards
-
-            config.path = Path.from_ids(organization_name, project_name, board['id'])
+            config.path = Path.from_ids(
+              organization_name: organization_name,
+              project_name: project_name,
+              board_id: board["id"]
+            )
             print_board(organization_name, project_name, board)
           end
 
           private
 
           def boards
-            @boards ||= api.get_paged('work/boards')
+            @boards ||= api.get_paged("work/boards")
           end
 
           def project_name
@@ -52,19 +55,23 @@ module Abt
           def project_url
             @project_url ||= begin
               loop do
-                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}',
-                  '',
-                  'Enter URL'
-                ].join("\n"))
+                url = cli.prompt.text(project_url_prompt_text)
 
                 break url if AZURE_DEV_URL_REGEX =~ url || VS_URL_REGEX =~ url
 
-                warn 'Invalid URL'
+                warn("Invalid URL")
               end
             end
           end
+
+          def project_url_prompt_text
+            <<~TXT
+              Please provide the URL for the devops project
+              For instance https://{organization}.visualstudio.com/{project} or https://dev.azure.com/{organization}/{project}
+
+              Enter URL
+            TXT
+          end
         end
       end
     end