abt-cli 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90cf28ee322298a2c1f7c99cf91ea0f820dd1fc0636a13d6dfe4c1f3db8e9ba1
-  data.tar.gz: 4d63e302def09512a225593952bd29e2de2ffde5387a4f3af4da59a7ec8ecadf
+  metadata.gz: df400d04c979d979ab2ead353d68374b8266c0fff678103991cc6443512b703b
+  data.tar.gz: 0345141c38eae6904d11f40a3045fccd048d8009b70fe9714f5e0986f1779861
 SHA512:
-  metadata.gz: b11c12bcc780bb2725b7c088f8ecf8fb2e47af767b9d906c042020bb999d427ef97a5fb8fc0151038590fe25ae0ba2aa69d4ec7e42758df1d03fbdf0c276870c
-  data.tar.gz: 62a3d10d11a58c879c31173ae393af393f0c841b9c99589a54d84b29177869686251d37ea6babf114dc7280a4a5a620fe13dbe3efbc5f324037b2556358d9737
+  metadata.gz: 1979110cbd58f0bc71b83ad7211b86e17c5b078e842d4f99ca839c88a88d627ab92506736cd83b6e414cbea2ec2a82592f6e8b3f1effdbd2b57df7decd63793e
+  data.tar.gz: 6af0e9bb436b304cda9d3acf6c86733050c9a7acffb691017d968e89e3f4e8e51b9fa4cdf5e3a85373ff2f684fa61e41afce0c1b9011d2e6b5551935b40530ea

data/lib/abt/cli.rb

@@ -9,7 +9,7 @@ module Abt
     class Abort < StandardError; end
     class Exit < StandardError; end
 
-    attr_reader :command, :scheme_arguments, :input, :output, :err_output, :prompt
+    attr_reader :command, :aris, :input, :output, :err_output, :prompt
 
     def initialize(argv: ARGV, input: STDIN, output: STDOUT, err_output: STDERR)
       (@command, *remaining_args) = argv
@@ -18,18 +18,18 @@ module Abt
       @err_output = err_output
       @prompt = Abt::Cli::Prompt.new(output: err_output)
 
-      @scheme_arguments = ArgumentsParser.new(sanitized_piped_args + remaining_args).parse
+      @aris = ArgumentsParser.new(sanitized_piped_args + remaining_args).parse
     end
 
     def perform
       return if handle_global_commands!
 
-      abort('No scheme arguments') if scheme_arguments.empty?
+      abort('No ARIs') if aris.empty?
 
-      process_scheme_arguments
+      process_aris
     end
 
-    def print_scheme_argument(scheme, path, description = nil)
+    def print_ari(scheme, path, description = nil)
       command = "#{scheme}:#{path}"
       command += " # #{description}" unless description.nil?
       output.puts command
@@ -96,30 +96,30 @@ module Abt
           line.split(' # ').first
         end
 
-        # Allow multiple scheme arguments on a single piped input line
-        # TODO: Force the user to pick a single scheme argument
+        # Allow multiple ARIs on a single piped input line
+        # TODO: Force the user to pick a single ARI
         joined_lines = lines_without_comments.join(' ').strip
         joined_lines.split(/\s+/)
       end
     end
 
-    def process_scheme_arguments
+    def process_aris
       used_schemes = []
-      scheme_arguments.each do |scheme_argument|
-        scheme = scheme_argument.scheme
-        path = scheme_argument.path
+      aris.each do |ari|
+        scheme = ari.scheme
+        path = ari.path
 
         if used_schemes.include?(scheme)
-          warn "Dropping command for already used scheme: #{scheme_argument}"
+          warn "Dropping command for already used scheme: #{ari}"
           next
         end
 
         command_class = get_command_class(scheme)
         next if command_class.nil?
 
-        print_command(command, scheme_argument) if output.isatty
+        print_command(command, ari) if output.isatty
         begin
-          command_class.new(path: path, cli: self, flags: scheme_argument.flags).perform
+          command_class.new(path: path, cli: self, flags: ari.flags).perform
         rescue Exit => e
           puts e.message
         end
@@ -129,7 +129,7 @@ module Abt
 
       return unless used_schemes.empty? && output.isatty
 
-      abort 'No providers found for command and scheme argument(s)'
+      abort 'No providers found for command and ARI(s)'
     end
 
     def get_command_class(scheme)
@@ -139,8 +139,8 @@ module Abt
       provider.command_class(command)
     end
 
-    def print_command(name, scheme_argument)
-      warn "===== #{name} #{scheme_argument} =====".upcase
+    def print_command(name, ari)
+      warn "===== #{name} #{ari} =====".upcase
     end
   end
 end

data/lib/abt/cli/arguments_parser.rb

@@ -3,7 +3,7 @@
 module Abt
   class Cli
     class ArgumentsParser
-      class SchemeArgument
+      class Ari
         attr_reader :scheme, :path, :flags
 
         def initialize(scheme:, path:, flags:)
@@ -19,7 +19,7 @@ module Abt
           [str, *flags].join(' ')
         end
       end
-      class SchemeArguments < Array
+      class Aris < Array
         def to_s
           map(&:to_s).join(' -- ')
         end
@@ -32,14 +32,14 @@ module Abt
       end
 
       def parse
-        result = SchemeArguments.new
+        result = Aris.new
         rest = arguments.dup
 
         until rest.empty?
           (scheme, path) = rest.shift.split(':')
           flags = take_flags(rest)
 
-          result << SchemeArgument.new(scheme: scheme, path: path, flags: flags)
+          result << Ari.new(scheme: scheme, path: path, flags: flags)
         end
 
         result

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,11 +22,11 @@ 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.:' => {
+          'Command output can be piped:' => {
             'abt tasks asana | grep -i <name of task>' => nil,
             'abt tasks asana | grep -i <name of task> | abt start' => nil
           },
@@ -36,9 +36,9 @@ module Abt
             'abt start <shared configuration>' => 'Start a shared configuration'
           },
           '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

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 af 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/providers/asana/base_command.rb

@@ -36,13 +36,13 @@ module Abt
         end
 
         def print_project(project)
-          cli.print_scheme_argument('asana', project['gid'], project['name'])
+          cli.print_ari('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_scheme_argument('asana', "#{project['gid']}/#{task['gid']}", task['name'])
+          cli.print_ari('asana', "#{project['gid']}/#{task['gid']}", task['name'])
           cli.warn task['permalink_url'] if task.key?('permalink_url') && cli.output.isatty
         end
 

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

@@ -31,7 +31,7 @@ module Abt
 
             return if flags[:"dry-run"]
 
-            config.project_gid = project_gid # We might have gotten the project ID as an argument
+            config.project_gid = project_gid # We might have gotten the project ID from a path
             config.task_gid = task['gid']
           end
 

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

@@ -17,9 +17,9 @@ module Abt
             require_project!
 
             if task_gid.nil?
-              cli.print_scheme_argument('asana', project_gid)
+              cli.print_ari('asana', project_gid)
             else
-              cli.print_scheme_argument('asana', "#{project_gid}/#{task_gid}")
+              cli.print_ari('asana', "#{project_gid}/#{task_gid}")
             end
           end
         end

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

@@ -56,14 +56,14 @@ module Abt
         def print_board(organization_name, project_name, board)
           path = "#{organization_name}/#{project_name}/#{board['id']}"
 
-          cli.print_scheme_argument('devops', path, board['name'])
+          cli.print_ari('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)
           path = "#{organization}/#{project}/#{board['id']}/#{work_item['id']}"
 
-          cli.print_scheme_argument('devops', path, work_item['name'])
+          cli.print_ari('devops', path, work_item['name'])
           cli.warn work_item['url'] if work_item.key?('url') && cli.output.isatty
         end
 

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

@@ -17,7 +17,7 @@ module Abt
             require_work_item!
 
             args = [organization_name, project_name, board_id, work_item_id].compact
-            cli.print_scheme_argument('devops', args.join('/'))
+            cli.print_ari('devops', args.join('/'))
           end
         end
       end

data/lib/abt/providers/git/commands/branch.rb

@@ -39,29 +39,29 @@ module Abt
 
           def branch_name # rubocop:disable Metrics/MethodLength
             @branch_name ||= begin
-              if branch_names_from_scheme_arguments.empty?
+              if branch_names_from_aris.empty?
                 cli.abort [
-                  'None of the specified scheme arguments responded to `branch-name`.',
+                  'None of the specified ARIs responded to `branch-name`.',
                   'Did you add compatible scheme? e.g.:',
                   '   abt branch git asana',
                   '   abt branch git devops'
                 ].join("\n")
               end
 
-              if branch_names_from_scheme_arguments.length > 1
+              if branch_names_from_aris.length > 1
                 cli.abort [
-                  'Got branch names from multiple scheme arguments, only one is supported',
+                  'Got branch names from multiple ARIs, only one is supported',
                   'Branch names were:',
-                  *branch_names_from_scheme_arguments.map { |name| "   #{name}" }
+                  *branch_names_from_aris.map { |name| "   #{name}" }
                 ].join("\n")
               end
 
-              branch_names_from_scheme_arguments.first
+              branch_names_from_aris.first
             end
           end
 
-          def branch_names_from_scheme_arguments
-            input = StringIO.new(cli.scheme_arguments.to_s)
+          def branch_names_from_aris
+            input = StringIO.new(cli.aris.to_s)
             output = StringIO.new
             Abt::Cli.new(argv: ['branch-name'], output: output, input: input).perform
 

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

@@ -36,7 +36,7 @@ module Abt
         end
 
         def print_project(project)
-          cli.print_scheme_argument(
+          cli.print_ari(
             'harvest',
             project['id'],
             "#{project['client']['name']} > #{project['name']}"
@@ -44,7 +44,7 @@ module Abt
         end
 
         def print_task(project, task)
-          cli.print_scheme_argument(
+          cli.print_ari(
             'harvest',
             "#{project['id']}/#{task['id']}",
             "#{project['name']} > #{task['name']}"

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

@@ -30,7 +30,7 @@ module Abt
 
             return if flags[:"dry-run"]
 
-            config.project_id = project_id # We might have gotten the project ID as an argument
+            config.project_id = project_id # We might have gotten the project ID as a path
             config.task_id = task['id']
           end
 

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

@@ -17,9 +17,9 @@ module Abt
             if project_id.nil?
               cli.warn 'No project selected'
             elsif task_id.nil?
-              cli.print_scheme_argument('harvest', project_id)
+              cli.print_ari('harvest', project_id)
             else
-              cli.print_scheme_argument('harvest', "#{project_id}/#{task_id}")
+              cli.print_ari('harvest', "#{project_id}/#{task_id}")
             end
           end
         end

data/lib/abt/providers/harvest/commands/start.rb

@@ -12,7 +12,7 @@ module Abt
           end
 
           def self.description
-            'Alias for: `abt track harvest`. Meant to used in combination with other scheme arguments, e.g. `abt start harvest asana`'
+            'Alias for: `abt track harvest`. Meant to used in combination with other ARIs, e.g. `abt start harvest asana`'
           end
         end
       end

data/lib/abt/providers/harvest/commands/track.rb

@@ -10,7 +10,7 @@ module Abt
           end
 
           def self.description
-            'Start tracker for current or specified task. Add a relevant scheme argument to link the time entry, e.g. `abt track harvest asana`'
+            'Start tracker for current or specified task. Add a relevant ARI to link the time entry, e.g. `abt track harvest asana`'
           end
 
           def self.flags
@@ -77,7 +77,7 @@ module Abt
 
           def external_link_data
             @external_link_data ||= begin
-              input = StringIO.new(cli.scheme_arguments.to_s)
+              input = StringIO.new(cli.aris.to_s)
               output = StringIO.new
               Abt::Cli.new(argv: ['harvest-time-entry-data'], output: output, input: input).perform
 

data/lib/abt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Abt
-  VERSION = '0.0.17'
+  VERSION = '0.0.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abt-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Jesper Sørensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector