abt-cli 0.0.21 → 0.0.22

data/lib/abt/docs.rb

@@ -9,37 +9,39 @@ module Abt
     class << self
       def basic_examples
         {
-          'Getting started:' => {
-            'abt init asana harvest' => 'Setup asana and harvest project for local git repo',
-            'abt pick harvest' => 'Pick harvest task. This will likely stay the same throughout the project',
-            'abt pick asana | abt start harvest' => 'Pick asana task and start tracking time',
-            'abt stop harvest' => 'Stop time tracker',
-            'abt start asana harvest' => 'Continue working, e.g., after a break',
-            'abt finalize asana' => 'Finalize the selected asana task'
+          "Getting started:" => {
+            "abt init asana harvest" => "Setup asana and harvest project for local git repo",
+            "abt pick harvest" => "Pick harvest task. This will likely stay the same throughout the project",
+            "abt pick asana | abt start harvest" => "Pick asana task and start tracking time",
+            "abt stop harvest" => "Stop time tracker",
+            "abt start asana harvest" => "Continue working, e.g., after a break",
+            "abt finalize asana" => "Finalize the selected asana task"
           }
         }
       end
 
-      def extended_examples
+      def extended_examples # rubocop:disable Metrics/MethodLength
         {
-          'Tracking meetings (without switching current task setting):' => {
-            'abt pick asana -d | abt track harvest' => 'Track on asana meeting task',
-            'abt pick harvest -d | abt track harvest -c "Name of meeting"' => 'Track on separate harvest-task'
+          "Tracking meetings (without switching current task setting):" => {
+            "abt pick asana -d | abt track harvest" => "Track on asana meeting task",
+            'abt pick harvest -d | abt track harvest -c "Name of meeting"' => "Track on separate harvest-task"
           },
-          'Many commands output ARIs that can be piped into other commands:' => {
-            'abt tasks asana | grep -i <name of task>' => nil,
-            'abt tasks asana | grep -i <name of task> | abt start' => nil
+          "Many commands output ARIs that can be piped into other commands:" => {
+            "abt tasks asana | grep -i <name of task>" => nil,
+            "abt tasks asana | grep -i <name of task> | abt start" => nil
           },
-          'Sharing ARIs:' => {
-            'abt share asana harvest | tr "\n" " "' => 'Print current asana and harvest ARIs on a single line',
-            'abt share asana harvest | tr "\n" " " | pbcopy' => 'Copy ARIs to clipboard (mac only)',
-            'abt start <ARIs from coworker>' => 'Work on a task your coworker shared with you',
-            'abt current <ARIs from coworker> | abt start' => 'Set task as current, then start it'
+          "Sharing ARIs:" => {
+            'abt share asana harvest | tr "\n" " "' => "Print current asana and harvest ARIs on a single line",
+            'abt share asana harvest | tr "\n" " " | pbcopy' => "Copy ARIs to clipboard (mac only)",
+            "abt start <ARIs from coworker>" => "Work on a task your coworker shared with you",
+            "abt current <ARIs from coworker> | abt start" => "Set task as current, then start it"
           },
-          'Flags:' => {
-            'abt start harvest -c "comment"' => 'Add command flags after ARIs',
-            'abt start harvest -c "comment" -- asana' => 'Use -- to end a list of flags, so that it can be followed by another ARI',
-            'abt pick harvest | abt start -c "comment"' => 'Flags placed directly after a command applies to the piped in ARI'
+          "Flags:" => {
+            'abt start harvest -c "comment"' => "Add command flags after ARIs",
+            'abt start harvest -c "comment" -- asana' =>
+              "Use -- to end a list of flags, so that it can be followed by another ARI",
+            'abt pick harvest | abt start -c "comment"' =>
+              "Flags placed directly after a command applies to the piped in ARI"
           }
         }
       end
@@ -48,15 +50,7 @@ module Abt
         @providers ||= begin
           providers = {}
 
-          global_command_names = Abt::Cli.global_command_names
-          providers['Global'] = global_command_names.each_with_object({}) do |name, definition|
-            command_class = Abt::Cli.global_command_class(name)
-            full_name = "abt #{name}"
-
-            if command_class.respond_to?(:usage) && command_class.respond_to?(:description)
-              definition[full_name] = [command_class.usage, command_class.description]
-            end
-          end
+          providers["Global"] = global_command_definitions
 
           Abt.schemes.sort.each_with_object(providers) do |scheme, definition|
             definition[scheme] = command_definitions(scheme)
@@ -68,6 +62,18 @@ module Abt
 
       private
 
+      def global_command_definitions
+        global_command_names = Abt::Cli::GlobalCommands.command_names
+        global_command_names.each_with_object({}) do |name, definition|
+          command_class = Abt::Cli::GlobalCommands.command_class(name)
+          full_name = "abt #{name}"
+
+          if command_class.respond_to?(:usage) && command_class.respond_to?(:description)
+            definition[full_name] = [command_class.usage.strip, command_class.description.strip]
+          end
+        end
+      end
+
       def command_definitions(scheme)
         provider = Abt.scheme_provider(scheme)
         provider.command_names.each_with_object({}) do |name, definition|
@@ -75,7 +81,7 @@ module Abt
           full_name = "abt #{name} #{scheme}"
 
           if command_class.respond_to?(:usage) && command_class.respond_to?(:description)
-            definition[full_name] = [command_class.usage, command_class.description]
+            definition[full_name] = [command_class.usage.strip, command_class.description.strip]
           end
         end
       end

data/lib/abt/docs/cli.rb

@@ -45,14 +45,14 @@ module Abt
         private
 
         def usage_line
-          'abt <command> [<ARI>] [<options> --] [<ARI>] ...'
+          "abt <command> [<ARI>] [<options> --] [<ARI>] ..."
         end
 
         def formatted_examples(example_groups)
           lines = []
 
           example_groups.each_with_index do |(title, examples), index|
-            lines << '' unless index.zero?
+            lines << "" unless index.zero?
             lines << title
 
             max_length = examples.keys.map(&:length).max
@@ -68,7 +68,7 @@ module Abt
           lines = []
 
           Docs.providers.each_with_index do |(scheme, commands_definition), index|
-            lines << '' unless index.zero?
+            lines << "" unless index.zero?
             lines << "#{inflector.humanize(scheme)}:"
 
             max_length = commands_definition.keys.map(&:length).max

data/lib/abt/docs/markdown.rb

@@ -52,11 +52,11 @@ module Abt
 
           examples = Docs.basic_examples.merge(Docs.extended_examples)
           examples.each_with_index do |(title, commands), index|
-            lines << '' unless index.zero?
+            lines << "" unless index.zero?
             lines << title
 
             commands.each do |(command, description)|
-              formatted_description = description.nil? ? '' : ": #{description}"
+              formatted_description = description.nil? ? "" : ": #{description}"
               lines << "- `#{command}`#{formatted_description}"
             end
           end
@@ -68,10 +68,10 @@ module Abt
           lines = []
 
           Docs.providers.each_with_index do |(scheme, commands), index|
-            lines << '' unless index.zero?
+            lines << "" unless index.zero?
             lines << "### #{inflector.humanize(scheme)}"
-            lines << '| Command | Description |'
-            lines << '| :------ | :---------- |'
+            lines << "| Command | Description |"
+            lines << "| :------ | :---------- |"
 
             max_length = commands.values.map(&:first).map(&:length).max
 

data/lib/abt/git_config.rb

@@ -6,12 +6,10 @@ module Abt
 
     class UnsafeNamespaceError < StandardError; end
 
-    def initialize(scope = 'local', namespace = '')
+    def initialize(scope = "local", namespace = "")
       @namespace = namespace
 
-      unless %w[local global].include? scope
-        raise ArgumentError, 'scope must be "local" or "global"'
-      end
+      raise ArgumentError, 'scope must be "local" or "global"' unless %w[local global].include?(scope)
 
       @scope = scope
     end
@@ -50,7 +48,7 @@ module Abt
     end
 
     def clear(output: nil)
-      raise UnsafeNamespaceError, 'Keys can only be cleared within a namespace' if namespace.empty?
+      raise UnsafeNamespaceError, "Keys can only be cleared within a namespace" if namespace.empty?
 
       keys.each do |key|
         output&.puts "Clearing #{scope}: #{key_with_namespace(key)}"
@@ -67,7 +65,7 @@ module Abt
     def ensure_scope_available!
       return if available?
 
-      raise StandardError, 'Local configuration is not available outside a git repository'
+      raise StandardError, "Local configuration is not available outside a git repository"
     end
 
     def key_with_namespace(key)

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

@@ -4,8 +4,8 @@ module Abt
   module Providers
     module Asana
       class Api
-        API_ENDPOINT = 'https://app.asana.com/api/1.0'
-        VERBS = %i[get post put].freeze
+        API_ENDPOINT = "https://app.asana.com/api/1.0"
+        VERBS = [:get, :post, :put].freeze
 
         attr_reader :access_token
 
@@ -15,7 +15,7 @@ module Abt
 
         VERBS.each do |verb|
           define_method(verb) do |*args|
-            request(verb, *args)['data']
+            request(verb, *args)["data"]
           end
         end
 
@@ -24,10 +24,10 @@ module Abt
 
           loop do
             result = request(:get, path, query.merge(limit: 100))
-            records += result['data']
-            break if result['next_page'].nil?
+            records += result["data"]
+            break if result["next_page"].nil?
 
-            path = result['next_page']['path'][1..-1]
+            path = result["next_page"]["path"][1..-1]
           end
 
           records
@@ -40,15 +40,15 @@ 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
         end
 
         def connection
           @connection ||= Faraday.new(API_ENDPOINT) do |connection|
-            connection.headers['Authorization'] = "Bearer #{access_token}"
-            connection.headers['Content-Type'] = 'application/json'
+            connection.headers["Authorization"] = "Bearer #{access_token}"
+            connection.headers["Content-Type"] = "application/json"
           end
         end
       end

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

@@ -21,25 +21,23 @@ module Abt
         private
 
         def require_project!
-          abort 'No current/specified project. Did you initialize Asana?' if project_gid.nil?
+          abort("No current/specified project. Did you initialize Asana?") if project_gid.nil?
         end
 
         def require_task!
-          if project_gid.nil?
-            abort 'No current/specified project. Did you initialize Asana and pick a task?'
-          end
-          abort 'No current/specified task. Did you pick an Asana task?' if task_gid.nil?
+          abort("No current/specified project. Did you initialize Asana and pick a task?") if project_gid.nil?
+          abort("No current/specified task. Did you pick an Asana task?") if task_gid.nil?
         end
 
         def print_project(project)
-          cli.print_ari('asana', project['gid'], project['name'])
-          warn project['permalink_url'] if project.key?('permalink_url') && cli.output.isatty
+          cli.print_ari("asana", project["gid"], project["name"])
+          warn(project["permalink_url"]) if project.key?("permalink_url") && cli.output.isatty
         end
 
         def print_task(project, task)
-          project = { 'gid' => project } if project.is_a?(String)
-          cli.print_ari('asana', "#{project['gid']}/#{task['gid']}", task['name'])
-          warn task['permalink_url'] if task.key?('permalink_url') && cli.output.isatty
+          project = { "gid" => project } if project.is_a?(String)
+          cli.print_ari("asana", "#{project['gid']}/#{task['gid']}", task["name"])
+          warn(task["permalink_url"]) if task.key?("permalink_url") && cli.output.isatty
         end
 
         def api

data/lib/abt/providers/asana/commands/add.rb

@@ -6,22 +6,22 @@ module Abt
       module Commands
         class Add < BaseCommand
           def self.usage
-            'abt add asana[:<project-gid>]'
+            "abt add asana[:<project-gid>]"
           end
 
           def self.description
-            'Create a new task for the current/specified Asana project'
+            "Create a new task for the current/specified Asana project"
           end
 
           def perform
             require_project!
 
             task
-            warn 'Task created'
+            warn("Task created")
 
             if section
               move_task
-              warn "Moved to section: #{section['name']}"
+              warn("Moved to section: #{section['name']}")
             end
 
             print_task(project, task)
@@ -38,36 +38,37 @@ module Abt
                   projects: [project_gid]
                 }
               }
-              api.post('tasks', Oj.dump(body, mode: :json))
+              api.post("tasks", Oj.dump(body, mode: :json))
             end
           end
 
           def move_task
-            body = { data: { task: task['gid'] } }
+            body = { data: { task: task["gid"] } }
             body_json = Oj.dump(body, mode: :json)
             api.post("sections/#{section['gid']}/addTask", body_json)
           end
 
           def name
-            @name ||= cli.prompt.text 'Enter task description'
+            @name ||= cli.prompt.text("Enter task description")
           end
 
           def notes
-            @notes ||= cli.prompt.text 'Enter task notes'
+            @notes ||= cli.prompt.text("Enter task notes")
           end
 
           def project
-            @project ||= api.get("projects/#{project_gid}", opt_fields: 'name')
+            @project ||= api.get("projects/#{project_gid}", opt_fields: "name")
           end
 
           def section
-            @section ||= cli.prompt.choice 'Add to section?', sections, ['q', 'Don\'t add to section']
+            @section ||= cli.prompt.choice("Add to section?", sections,
+                                           nil_option: ["q", "Don't add to section"])
           end
 
           def sections
             @sections ||= begin
-              warn 'Fetching sections...'
-              api.get_paged("projects/#{project_gid}/sections", opt_fields: 'name')
+              warn("Fetching sections...")
+              api.get_paged("projects/#{project_gid}/sections", opt_fields: "name")
             end
           end
         end

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

@@ -6,11 +6,11 @@ module Abt
       module Commands
         class BranchName < BaseCommand
           def self.usage
-            'abt branch-name asana[:<project-gid>/<task-gid>]'
+            "abt branch-name asana[:<project-gid>/<task-gid>]"
           end
 
           def self.description
-            'Suggest a git branch name for the current/specified task.'
+            "Suggest a git branch name for the current/specified task."
           end
 
           def perform
@@ -23,21 +23,21 @@ module Abt
           private
 
           def name
-            task['name'].downcase.gsub(/[^\w]+/, '-')
+            task["name"].downcase.gsub(/[^\w]+/, "-").gsub(/(^-|-$)/, "")
           end
 
           def ensure_current_is_valid!
-            abort "Invalid task gid: #{task_gid}" if task.nil?
+            abort("Invalid task gid: #{task_gid}") if task.nil?
 
-            return if task['memberships'].any? { |m| m.dig('project', 'gid') == project_gid }
+            return if task["memberships"].any? { |m| m.dig("project", "gid") == project_gid }
 
-            abort "Invalid or unmatching project gid: #{project_gid}"
+            abort("Invalid or unmatching project gid: #{project_gid}")
           end
 
           def task
             @task ||= begin
-              warn 'Fetching task...'
-              api.get("tasks/#{task_gid}", opt_fields: 'name,memberships.project')
+              warn("Fetching task...")
+              api.get("tasks/#{task_gid}", opt_fields: "name,memberships.project")
             rescue Abt::HttpError::NotFoundError
               nil
             end

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

@@ -6,29 +6,28 @@ module Abt
       module Commands
         class Clear < BaseCommand
           def self.usage
-            'abt clear asana'
+            "abt clear asana"
           end
 
           def self.description
-            'Clear asana configuration'
+            "Clear asana configuration"
           end
 
           def self.flags
             [
-              ['-g', '--global', 'Clear global instead of local asana configuration (credentials etc.)'],
-              ['-a', '--all', 'Clear all asana configuration']
+              ["-g", "--global",
+               "Clear global instead of local asana configuration (credentials etc.)"],
+              ["-a", "--all", "Clear all asana 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/asana/commands/current.rb

@@ -6,22 +6,22 @@ module Abt
       module Commands
         class Current < BaseCommand
           def self.usage
-            'abt current asana[:<project-gid>[/<task-gid>]]'
+            "abt current asana[:<project-gid>[/<task-gid>]]"
           end
 
           def self.description
-            'Get or set project and or task for current git repository'
+            "Get or set project and or task for current git repository"
           end
 
           def perform
-            abort 'Must be run inside a git repository' unless config.local_available?
+            abort("Must be run inside a git repository") unless config.local_available?
 
             require_project!
             ensure_valid_configuration!
 
             if path != config.path
               config.path = path
-              warn 'Configuration updated'
+              warn("Configuration updated")
             end
 
             print_configuration
@@ -34,25 +34,25 @@ module Abt
           end
 
           def ensure_valid_configuration!
-            abort "Invalid project: #{project_gid}" if project.nil?
-            abort "Invalid task: #{task_gid}" if task_gid && task.nil?
+            abort("Invalid project: #{project_gid}") if project.nil?
+            abort("Invalid task: #{task_gid}") if task_gid && task.nil?
           end
 
           def project
             @project ||= begin
-              warn 'Fetching project...'
-              api.get("projects/#{project_gid}", opt_fields: 'name,permalink_url')
-                         rescue Abt::HttpError::NotFoundError
-                           nil
+              warn("Fetching project...")
+              api.get("projects/#{project_gid}", opt_fields: "name,permalink_url")
+            rescue Abt::HttpError::NotFoundError
+              nil
             end
           end
 
           def task
             @task ||= begin
-              warn 'Fetching task...'
-              api.get("tasks/#{task_gid}", opt_fields: 'name,permalink_url')
-                      rescue Abt::HttpError::NotFoundError
-                        nil
+              warn("Fetching task...")
+              api.get("tasks/#{task_gid}", opt_fields: "name,permalink_url")
+            rescue Abt::HttpError::NotFoundError
+              nil
             end
           end
         end