abt-cli 0.0.15 → 0.0.16

data/lib/abt/docs/cli.rb

@@ -4,23 +4,54 @@ module Abt
   module Docs
     module Cli
       class << self
-        def content
+        def help
           <<~TXT
-            Usage: abt <command> [<provider[:<arguments>]>...]
+            Usage: #{usage_line}
 
-            #{example_commands}
+            <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
 
-            Available commands:
-            #{providers_commands}
+            #{formatted_examples(Docs.basic_examples)}
+
+            For detailed examples/commands try:
+               abt examples
+               abt commands
+          TXT
+        end
+
+        def examples
+          <<~TXT
+            Printing examples
+
+            #{formatted_examples(Docs.basic_examples)}
+
+            #{formatted_examples(Docs.extended_examples)}
+          TXT
+        end
+
+        def commands
+          <<~TXT
+            Printing commands
+
+            Run commands with --help flag to see detailed usage and flags, e.g.:
+               abt track harvest -h
+
+            #{commands_per_provider}
           TXT
         end
 
         private
 
-        def example_commands
+        def usage_line
+          'abt <command> [<scheme-argument>] [<options> --] [<scheme-argument>] ...'
+        end
+
+        def formatted_examples(example_groups)
           lines = []
 
-          Docs.examples.each_with_index do |(title, examples), index|
+          example_groups.each_with_index do |(title, examples), index|
             lines << '' unless index.zero?
             lines << title
 
@@ -33,16 +64,16 @@ module Abt
           lines.join("\n")
         end
 
-        def providers_commands
+        def commands_per_provider
           lines = []
 
-          Docs.providers.each_with_index do |(provider_name, commands_definition), index|
+          Docs.providers.each_with_index do |(scheme, commands_definition), index|
             lines << '' unless index.zero?
-            lines << "#{inflector.humanize(provider_name)}:"
+            lines << "#{inflector.humanize(scheme)}:"
 
             max_length = commands_definition.keys.map(&:length).max
 
-            commands_definition.each do |(command, description)|
+            commands_definition.each do |(command, (_usage, description))|
               lines << "   #{command.ljust(max_length)}   #{description}"
             end
           end

data/lib/abt/docs/markdown.rb

@@ -4,18 +4,43 @@ module Abt
   module Docs
     module Markdown
       class << self
-        def content
+        def readme
           <<~MD
             # Abt
-            This readme was generated with `abt help-md > README.md`
+
+            Abt makes re-occuring tasks easily accessible from the terminal:
+            - Moving asana tasks around
+            - Tracking work/meetings in harvest
+            - Consistently naming branches
+
+            ## How does abt work?
+
+            Abt uses a hybrid approach between 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:
+            - `start xxxx/yyyy aaaa/bbbb`
+
+            Abt looks like one script, but works like a bunch of light independent scripts:
+            - `abt start asana:xxxx/yyyy harvest:aaaa/bbbb`
 
             ## Usage
-            `abt <command> [<provider[:<arguments>]>...]`
+            `abt <command> [<scheme-argument>] [<options> --] [<scheme-argument>] ...`
+
+            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
 
             #{example_commands}
 
             ## Available commands:
+            Some commands have `[options]`. Run such a command with `--help` flag to view supported flags, e.g: `abt track harvest -h`
+
             #{provider_commands}
+
+            #### This readme was generated with `abt readme > README.md`
           MD
         end
 
@@ -24,7 +49,8 @@ module Abt
         def example_commands
           lines = []
 
-          Docs.examples.each_with_index do |(title, commands), index|
+          examples = Docs.basic_examples.merge(Docs.extended_examples)
+          examples.each_with_index do |(title, commands), index|
             lines << '' unless index.zero?
             lines << title
 
@@ -40,17 +66,17 @@ module Abt
         def provider_commands # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           lines = []
 
-          Docs.providers.each_with_index do |(provider_name, commands), index|
+          Docs.providers.each_with_index do |(scheme, commands), index|
             lines << '' unless index.zero?
-            lines << "### #{inflector.humanize(provider_name)}"
+            lines << "### #{inflector.humanize(scheme)}"
             lines << '| Command | Description |'
             lines << '| :------ | :---------- |'
 
-            max_length = commands.keys.map(&:length).max
+            max_length = commands.values.map(&:first).map(&:length).max
 
-            commands.each do |(command, description)|
-              adjusted_command = "`#{command}`".ljust(max_length + 2)
-              lines << "| #{adjusted_command} | #{description} |"
+            commands.each do |(_command, (usage, description))|
+              adjusted_usage = "`#{usage}`".ljust(max_length + 2)
+              lines << "| #{adjusted_usage} | #{description} |"
             end
           end
 

data/lib/abt/git_config.rb

@@ -4,6 +4,8 @@ module Abt
   class GitConfig
     attr_reader :namespace, :scope
 
+    class UnsafeNamespaceError < StandardError; end
+
     LOCAL_CONFIG_AVAILABLE_CHECK_COMMAND = 'git config --local -l'
 
     def self.local_available?
@@ -67,6 +69,15 @@ module Abt
       end
     end
 
+    def clear(output: nil)
+      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)}"
+        self[key] = nil
+      end
+    end
+
     private
 
     def ensure_scope_available!

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

@@ -3,19 +3,19 @@
 module Abt
   module Providers
     module Asana
-      class BaseCommand
-        attr_reader :arg_str, :project_gid, :task_gid, :cli, :config
+      class BaseCommand < Abt::Cli::BaseCommand
+        attr_reader :project_gid, :task_gid, :config
+
+        def initialize(path:, cli:, **)
+          super
 
-        def initialize(arg_str:, cli:)
-          @arg_str = arg_str
           @config = Configuration.new(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
-          @cli = cli
         end
 
         private
@@ -36,23 +36,23 @@ module Abt
         end
 
         def print_project(project)
-          cli.print_provider_command('asana', project['gid'], project['name'])
+          cli.print_scheme_argument('asana', project['gid'], project['name'])
           cli.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_provider_command('asana', "#{project['gid']}/#{task['gid']}", task['name'])
+          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_args
+        def use_current_path
           @project_gid = config.project_gid
           @task_gid = config.task_gid
         end
 
-        def use_arg_str(arg_str)
-          args = arg_str.to_s.split('/')
+        def use_path(path)
+          args = path.to_s.split('/')
           @project_gid = args[0].to_s
           @project_gid = nil if project_gid.empty?
 

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

@@ -5,15 +5,15 @@ module Abt
     module Asana
       module Commands
         class Add < BaseCommand
-          def self.command
-            'add asana[:<project-gid>]'
+          def self.usage
+            'abt add asana[:<project-gid>]'
           end
 
           def self.description
             'Create a new task for the current/specified Asana project'
           end
 
-          def call
+          def perform
             require_project!
 
             task

data/lib/abt/providers/asana/commands/{branch-name.rb → branch_name.rb}

@@ -5,15 +5,15 @@ module Abt
     module Asana
       module Commands
         class BranchName < BaseCommand
-          def self.command
-            'branch-name asana[:<project-gid>/<task-gid>]'
+          def self.usage
+            'abt branch-name asana[:<project-gid>/<task-gid>]'
           end
 
           def self.description
             'Suggest a git branch name for the current/specified task.'
           end
 
-          def call
+          def perform
             require_task!
             ensure_current_is_valid!
 

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

@@ -5,17 +5,28 @@ module Abt
     module Asana
       module Commands
         class Clear < BaseCommand
-          def self.command
-            'clear asana'
+          def self.usage
+            'abt clear asana'
           end
 
           def self.description
-            'Clear project/task for current git repository'
+            'Clear asana configuration'
           end
 
-          def call
-            cli.warn 'Clearing Asana project configuration'
-            config.clear_local
+          def self.flags
+            [
+              ['-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
+
+            config.clear_local unless flags[:global]
+            config.clear_global if flags[:global] || flags[:all]
           end
         end
       end

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

@@ -5,15 +5,15 @@ module Abt
     module Asana
       module Commands
         class Current < BaseCommand
-          def self.command
-            'current asana[:<project-gid>[/<task-gid>]]'
+          def self.usage
+            'abt current asana[:<project-gid>[/<task-gid>]]'
           end
 
           def self.description
             'Get or set project and or task for current git repository'
           end
 
-          def call
+          def perform
             require_project!
 
             if same_args_as_config? || !config.local_available?

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

@@ -5,15 +5,15 @@ module Abt
     module Asana
       module Commands
         class Finalize < BaseCommand
-          def self.command
-            'finalize asana[:<project-gid>/<task-gid>]'
+          def self.usage
+            'abt finalize asana[:<project-gid>/<task-gid>]'
           end
 
           def self.description
             'Move current/specified task to section (column) for finalized tasks'
           end
 
-          def call
+          def perform
             unless config.local_available?
               cli.abort 'This is a no-op for tasks outside the current project'
             end

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

@@ -5,15 +5,15 @@ module Abt
     module Asana
       module Commands
         class HarvestTimeEntryData < BaseCommand
-          def self.command
-            'harvest-time-entry-data asana[:<project-gid>/<task-gid>]'
+          def self.usage
+            'abt harvest-time-entry-data asana[:<project-gid>/<task-gid>]'
           end
 
           def self.description
             'Print Harvest time entry data for Asana task as json. Used by harvest start script.'
           end
 
-          def call
+          def perform
             require_task!
             ensure_current_is_valid!
 

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

@@ -5,8 +5,8 @@ module Abt
     module Asana
       module Commands
         class Init < BaseCommand
-          def self.command
-            'init asana'
+          def self.usage
+            'abt init asana'
           end
 
           def self.description
@@ -18,7 +18,7 @@ module Abt
             @cli = cli
           end
 
-          def call
+          def perform
             cli.abort 'Must be run inside a git repository' unless config.local_available?
 
             projects # Load projects up front to make it obvious that searches are instant

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

@@ -5,15 +5,21 @@ module Abt
     module Asana
       module Commands
         class Pick < BaseCommand
-          def self.command
-            'pick asana[:<project-gid>]'
+          def self.usage
+            'abt pick asana[:<project-gid>]'
           end
 
           def self.description
             'Pick task 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_project!
 
@@ -21,10 +27,12 @@ module Abt
 
             task = select_task
 
+            print_task(project, task)
+
+            return if flags[:"dry-run"]
+
             config.project_gid = project_gid # We might have gotten the project ID as an argument
             config.task_gid = task['gid']
-
-            print_task(project, task)
           end
 
           private

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

@@ -5,15 +5,15 @@ module Abt
     module Asana
       module Commands
         class Projects < BaseCommand
-          def self.command
-            'projects asana'
+          def self.usage
+            'abt projects asana'
           end
 
           def self.description
             'List all available projects - useful for piping into grep etc.'
           end
 
-          def call
+          def perform
             projects.map do |project|
               print_project(project)
             end