abt-cli 0.0.16 → 0.0.21

data/lib/abt/cli/global_commands/version.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Abt
+  class Cli
+    module GlobalCommands
+      class Version < Abt::BaseCommand
+        def self.usage
+          'abt version'
+        end
+
+        def self.description
+          'Print abt version'
+        end
+
+        attr_reader :cli
+
+        def perform
+          puts(Abt::VERSION)
+        end
+      end
+    end
+  end
+end

data/lib/abt/cli/prompt.rb

@@ -69,10 +69,11 @@ module Abt
       end
 
       def read_option_number(options_length, nil_option)
-        output.print '('
-        output.print options_length > 1 ? "1-#{options_length}" : '1'
-        output.print nil_option_string(nil_option)
-        output.print '): '
+        str = '('
+        str += options_length > 1 ? "1-#{options_length}" : '1'
+        str += nil_option_string(nil_option)
+        str += '): '
+        output.print str
 
         input = read_user_input
 

data/lib/abt/docs.rb

@@ -10,11 +10,11 @@ module Abt
       def basic_examples
         {
           'Getting started:' => {
-            'abt init asana harvest' => 'Setup asana and harvest project git repo in working dir',
-            'abt pick harvest' => 'Pick harvest tasks, for most projects this will stay the same',
-            'abt pick asana | abt start harvest' => 'Pick asana task and start working',
+            '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 start asana harvest' => 'Continue working, e.g., after a break',
             'abt finalize asana' => 'Finalize the selected asana task'
           }
         }
@@ -22,30 +22,47 @@ module Abt
 
       def extended_examples
         {
-          'Tracking meetings (without changing the config):' => {
+          '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'
           },
-          'Command output can be piped, e.g.:' => {
+          '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 configuration:' => {
-            'abt share asana harvest | tr "\n" " "' => 'Print current configuration',
-            'abt share asana harvest | tr "\n" " " | pbcopy' => 'Copy configuration (mac only)',
-            'abt start <shared configuration>' => 'Start a shared configuration'
+          '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 <scheme>:<path>',
-            'abt start harvest -c "comment" -- asana' => 'Use -- to mark the end of a flag list if it\'s to be followed by a <scheme-argument>',
-            'abt pick harvest | abt start -c "comment"' => 'Flags placed directly after a command applies to piped in <scheme-argument>'
+            '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
 
       def providers
-        @providers ||= Abt.schemes.sort.each_with_object({}) do |scheme, definition|
-          definition[scheme] = command_definitions(scheme)
+        @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
+
+          Abt.schemes.sort.each_with_object(providers) do |scheme, definition|
+            definition[scheme] = command_definitions(scheme)
+          end
+
+          providers
         end
       end
 

data/lib/abt/docs/cli.rb

@@ -8,10 +8,10 @@ module Abt
           <<~TXT
             Usage: #{usage_line}
 
-            <command>           Name of command to execute, e.g. start, finalize etc.
-            <scheme-argument>   A URI-like identifier; scheme:path
-                                Points to a project/task etc. within a system.
-            <options>           Optional flags for the command and scheme argument
+            <command>   Name of command to execute, e.g. start, finalize etc.
+            <ARI>       A URI-like resource identifier with a scheme and an optional path
+                        in the format: <scheme>[:<path>]. E.g., harvest:11111111/22222222
+            <options>   Optional flags for the command and ARI
 
             #{formatted_examples(Docs.basic_examples)}
 
@@ -45,7 +45,7 @@ module Abt
         private
 
         def usage_line
-          'abt <command> [<scheme-argument>] [<options> --] [<scheme-argument>] ...'
+          'abt <command> [<ARI>] [<options> --] [<ARI>] ...'
         end
 
         def formatted_examples(example_groups)

data/lib/abt/docs/markdown.rb

@@ -15,27 +15,28 @@ module Abt
 
             ## How does abt work?
 
-            Abt uses a hybrid approach between having small scripts each doing one thing:
+            Abt is a hybrid of having small scripts each doing one thing:
             - `start-asana --project-gid xxxx --task-gid yyyy`
             - `start-harvest --project-id aaaa --task-id bbbb`
 
-            And having a single highly advanced script that does everything:
+            And having a single highly advanced script that does everything with a single command:
             - `start xxxx/yyyy aaaa/bbbb`
 
-            Abt looks like one script, but works like a bunch of light independent scripts:
+            Abt looks like one command, but works like a bunch of light scripts:
             - `abt start asana:xxxx/yyyy harvest:aaaa/bbbb`
 
             ## Usage
-            `abt <command> [<scheme-argument>] [<options> --] [<scheme-argument>] ...`
+            `abt <command> [<ARI>] [<options> --] [<ARI>] ...`
 
             Definitions:
             - `<command>`: Name of command to execute, e.g. `start`, `finalize` etc.
-            - `<scheme-argument>`: A URI-like identifier, `scheme:path`, pointing to a project/task etc. within a system.
-            - `<options>`: Optional flags for the command and scheme argument
+            - `<ARI>`: A URI-like resource identifier with a scheme and an optional path in the format: `<scheme>[:<path>]`. E.g., `harvest:11111111/22222222`
+            - `<options>`: Optional flags for the command and ARI
 
             #{example_commands}
 
-            ## Available commands:
+            ## Commands:
+
             Some commands have `[options]`. Run such a command with `--help` flag to view supported flags, e.g: `abt track harvest -h`
 
             #{provider_commands}

data/lib/abt/git_config.rb

@@ -6,21 +6,7 @@ module Abt
 
     class UnsafeNamespaceError < StandardError; end
 
-    LOCAL_CONFIG_AVAILABLE_CHECK_COMMAND = 'git config --local -l'
-
-    def self.local_available?
-      return @local_available if instance_variables.include?(:@local_available)
-
-      @local_available = begin
-        success = false
-        Open3.popen3(LOCAL_CONFIG_AVAILABLE_CHECK_COMMAND) do |_i, _o, _e, thread|
-          success = thread.value.success?
-        end
-        success
-      end
-    end
-
-    def initialize(namespace: '', scope: 'local')
+    def initialize(scope = 'local', namespace = '')
       @namespace = namespace
 
       unless %w[local global].include? scope
@@ -30,6 +16,20 @@ module Abt
       @scope = scope
     end
 
+    def available?
+      unless instance_variables.include?(:available)
+        @available = begin
+          success = false
+          Open3.popen3(availability_check_call) do |_i, _o, _e, thread|
+            success = thread.value.success?
+          end
+          success
+        end
+      end
+
+      @available
+    end
+
     def [](key)
       get(key)
     end
@@ -49,26 +49,6 @@ module Abt
       `git config --#{scope} --get-regexp --name-only ^#{namespace}`.lines.map(&:strip)
     end
 
-    def local
-      @local ||= begin
-        if scope == 'local'
-          self
-        else
-          self.class.new(namespace: namespace, scope: 'local')
-        end
-      end
-    end
-
-    def global
-      @global ||= begin
-        if scope == 'global'
-          self
-        else
-          self.class.new(namespace: namespace, scope: 'global')
-        end
-      end
-    end
-
     def clear(output: nil)
       raise UnsafeNamespaceError, 'Keys can only be cleared within a namespace' if namespace.empty?
 
@@ -80,8 +60,12 @@ module Abt
 
     private
 
+    def availability_check_call
+      "git config --#{scope} -l"
+    end
+
     def ensure_scope_available!
-      return if scope != 'local' || self.class.local_available?
+      return if available?
 
       raise StandardError, 'Local configuration is not available outside a git repository'
     end

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

@@ -3,63 +3,43 @@
 module Abt
   module Providers
     module Asana
-      class BaseCommand < Abt::Cli::BaseCommand
-        attr_reader :project_gid, :task_gid, :config
+      class BaseCommand < Abt::BaseCommand
+        extend Forwardable
 
-        def initialize(path:, cli:, **)
+        attr_reader :path, :config
+
+        def_delegators(:@path, :project_gid, :task_gid)
+
+        def initialize(ari:, cli:)
           super
 
           @config = Configuration.new(cli: cli)
 
-          if path.nil?
-            use_current_path
-          else
-            use_path(path)
-          end
+          @path = ari.path ? Path.new(ari.path) : config.path
         end
 
         private
 
         def require_project!
-          cli.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?
-            cli.abort 'No current/specified project. Did you initialize Asana and pick a task?'
+            abort 'No current/specified project. Did you initialize Asana and pick a task?'
           end
-          cli.abort 'No current/specified task. Did you pick an Asana task?' if task_gid.nil?
-        end
-
-        def same_args_as_config?
-          project_gid == config.project_gid && task_gid == config.task_gid
+          abort 'No current/specified task. Did you pick an Asana task?' if task_gid.nil?
         end
 
         def print_project(project)
-          cli.print_scheme_argument('asana', project['gid'], project['name'])
-          cli.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_scheme_argument('asana', "#{project['gid']}/#{task['gid']}", task['name'])
-          cli.warn task['permalink_url'] if task.key?('permalink_url') && cli.output.isatty
-        end
-
-        def use_current_path
-          @project_gid = config.project_gid
-          @task_gid = config.task_gid
-        end
-
-        def use_path(path)
-          args = path.to_s.split('/')
-          @project_gid = args[0].to_s
-          @project_gid = nil if project_gid.empty?
-
-          return if project_gid.nil?
-
-          @task_gid = args[1].to_s
-          @task_gid = nil if @task_gid.empty?
+          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

@@ -17,9 +17,14 @@ module Abt
             require_project!
 
             task
-            print_task(project, task)
+            warn 'Task created'
+
+            if section
+              move_task
+              warn "Moved to section: #{section['name']}"
+            end
 
-            move_task if section
+            print_task(project, task)
           end
 
           private
@@ -33,7 +38,6 @@ module Abt
                   projects: [project_gid]
                 }
               }
-              cli.warn 'Creating task'
               api.post('tasks', Oj.dump(body, mode: :json))
             end
           end
@@ -53,7 +57,7 @@ module Abt
           end
 
           def project
-            @project ||= api.get("projects/#{project_gid}")
+            @project ||= api.get("projects/#{project_gid}", opt_fields: 'name')
           end
 
           def section
@@ -62,10 +66,8 @@ module Abt
 
           def sections
             @sections ||= begin
-              cli.warn 'Fetching sections...'
+              warn 'Fetching sections...'
               api.get_paged("projects/#{project_gid}/sections", opt_fields: 'name')
-                          rescue Abt::HttpError::HttpError
-                            []
             end
           end
         end

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

@@ -17,7 +17,7 @@ module Abt
             require_task!
             ensure_current_is_valid!
 
-            cli.puts name
+            puts name
           end
 
           private
@@ -27,15 +27,20 @@ module Abt
           end
 
           def ensure_current_is_valid!
-            cli.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 }
 
-            cli.abort "Invalid project gid: #{project_gid}"
+            abort "Invalid or unmatching project gid: #{project_gid}"
           end
 
           def task
-            @task ||= api.get("tasks/#{task_gid}", opt_fields: 'name,memberships.project')
+            @task ||= begin
+              warn 'Fetching task...'
+              api.get("tasks/#{task_gid}", opt_fields: 'name,memberships.project')
+            rescue Abt::HttpError::NotFoundError
+              nil
+            end
           end
         end
       end

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

@@ -27,6 +27,8 @@ module Abt
 
             config.clear_local unless flags[:global]
             config.clear_global if flags[:global] || flags[:all]
+
+            warn 'Configuration cleared'
           end
         end
       end

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

@@ -14,60 +14,45 @@ module Abt
           end
 
           def perform
+            abort 'Must be run inside a git repository' unless config.local_available?
+
             require_project!
+            ensure_valid_configuration!
 
-            if same_args_as_config? || !config.local_available?
-              show_current_configuration
-            else
-              cli.warn 'Updating configuration'
-              update_configuration
+            if path != config.path
+              config.path = path
+              warn 'Configuration updated'
             end
-          end
 
-          private
-
-          def show_current_configuration
-            if task_gid.nil?
-              print_project(project)
-            else
-              print_task(project, task)
-            end
+            print_configuration
           end
 
-          def update_configuration
-            ensure_project_is_valid!
-            config.project_gid = project_gid
-
-            if task_gid.nil?
-              print_project(project)
-              config.task_gid = nil
-            else
-              ensure_task_is_valid!
-              config.task_gid = task_gid
-
-              print_task(project, task)
-            end
-          end
+          private
 
-          def ensure_project_is_valid!
-            cli.abort "Invalid project: #{project_gid}" if project.nil?
+          def print_configuration
+            task_gid.nil? ? print_project(project) : print_task(project, task)
           end
 
-          def ensure_task_is_valid!
-            cli.abort "Invalid task: #{task_gid}" if task.nil?
+          def ensure_valid_configuration!
+            abort "Invalid project: #{project_gid}" if project.nil?
+            abort "Invalid task: #{task_gid}" if task_gid && task.nil?
           end
 
           def project
             @project ||= begin
-              cli.warn 'Fetching project...'
+              warn 'Fetching project...'
               api.get("projects/#{project_gid}", opt_fields: 'name,permalink_url')
+                         rescue Abt::HttpError::NotFoundError
+                           nil
             end
           end
 
           def task
             @task ||= begin
-              cli.warn 'Fetching task...'
+              warn 'Fetching task...'
               api.get("tasks/#{task_gid}", opt_fields: 'name,permalink_url')
+                      rescue Abt::HttpError::NotFoundError
+                        nil
             end
           end
         end