abt-cli 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 929ab52c8ebd307b90ddb7daa14f2f63eeeebda8ed9905490a13dcd2f67770da
-  data.tar.gz: e2582299b29e39faa8d4baccaba42954e7140a447d30c3c56a92507ac00f4a09
+  metadata.gz: cd99c9123cfbd4222176495fd039015ad56ddaf0841350347169fa6809f8d6b2
+  data.tar.gz: 33d0adf3e73be8f5b2a6f52d61cea46285e0e2ab036b2d1b0e1b4fe1f2c0a27a
 SHA512:
-  metadata.gz: dec30158debfe3e97c4969d8724d5f56d04725f0cab1aedf79840bb01ef81d9f17c5245cc538c559e47bfa245f36c5aeed8d02dc6ff21fcbae46b30f79e88c5b
-  data.tar.gz: c74d6a7ae33ff5843385796cf21d764de61d0981501b5ac7e24691a7c61c85ae6f646abacd1f1b74417d29559ae022881969dd71598acf1190487c6b64c0af02
+  metadata.gz: 2ea6b3ea3f1f2056b9e7911144542f0d2f3b568544fcd68901299fb64c84414290d7cecfc884405bde0125b096bc7033b99d3c2eb87e0598f434de79cfa76ae3
+  data.tar.gz: 3c8ffb1c3ba6553d16611c0f55a1c1bae3cf97d156fc79242f66b2d0b2ac622b08ab4ef049b98299553c708dc36365fc4e6158e31b556d830d863019134f34eb

data/bin/abt

@@ -4,11 +4,14 @@
 require 'dry-inflector'
 require 'faraday'
 require 'oj'
+require 'open3'
 
 require_relative '../lib/abt.rb'
 
 begin
-  Abt::Cli.new(ARGV).perform
+  Abt::Cli.new.perform
+rescue Abt::Cli::AbortError => e
+  abort e.message
 rescue Interrupt
   abort 'Aborted'
 end

data/lib/abt.rb

@@ -3,3 +3,14 @@
 Dir.glob("#{File.dirname(File.absolute_path(__FILE__))}/abt/*.rb").sort.each do |file|
   require file
 end
+
+module Abt
+  def self.provider_names
+    Providers.constants.sort.map { |constant_name| Helpers.const_to_command(constant_name) }
+  end
+
+  def self.provider_module(name)
+    const_name = Helpers.command_to_const(name)
+    Providers.const_get(const_name) if Providers.const_defined?(const_name)
+  end
+end

data/lib/abt/cli.rb

@@ -6,26 +6,35 @@ end
 
 module Abt
   class Cli
+    class AbortError < StandardError; end
+
     include Dialogs
+    include Io
 
-    attr_reader :command, :args
+    attr_reader :command, :args, :input, :output, :err_output
 
-    def initialize(argv)
+    def initialize(argv: ARGV, input: STDIN, output: STDOUT, err_output: STDERR)
       (@command, *@args) = argv
 
-      @args += args_from_stdin unless STDIN.isatty # Add piped arguments
+      @input = input
+      @output = output
+      @err_output = err_output
+
+      @args += args_from_stdin unless input.isatty # Add piped arguments
     end
 
-    def perform(command: @command, args: @args)
+    def perform
       handle_global_commands!
 
       abort('No provider arguments') if args.empty?
 
-      process_providers(command: command, args: args)
+      process_providers
     end
 
-    def print_provider_command(provider, arg_str, description)
-      puts "#{provider}:#{arg_str} # #{description}"
+    def print_provider_command(provider, arg_str, description = nil)
+      command = "#{provider}:#{arg_str}"
+      command += " # #{description}" unless description.nil?
+      output.puts command
     end
 
     private
@@ -34,13 +43,13 @@ module Abt
       case command
       when nil
         warn("No command specified\n\n")
-        puts(Abt::Help::Cli.content)
+        puts(Abt::Docs::Cli.content)
         exit
       when '--help', '-h', 'help', 'commands'
-        puts(Abt::Help::Cli.content)
+        puts(Abt::Docs::Cli.content)
         exit
       when 'help-md'
-        puts(Abt::Help::Markdown.content)
+        puts(Abt::Docs::Markdown.content)
         exit
       when '--version', '-v', 'version'
         puts(Abt::VERSION)
@@ -53,12 +62,17 @@ module Abt
 
       return [] if input.nil?
 
-      input.split("\n").map do |line|
-        line.split(' # ').first # Exclude comment part of piped input lines
+      # Exclude comment part of piped input lines
+      lines_without_comments = input.lines.map do |line|
+        line.split(' # ').first
       end
+
+      # Allow multiple provider arguments on a single piped input line
+      joined_lines = lines_without_comments.join(' ').strip
+      joined_lines.split(/\s+/)
     end
 
-    def process_providers(command:, args:)
+    def process_providers
       used_providers = []
       args.each do |provider_args|
         (provider, arg_str) = provider_args.split(':')
@@ -71,33 +85,24 @@ module Abt
         used_providers << provider if process_provider_command(provider, command, arg_str)
       end
 
-      warn 'No matching providers found for command' if used_providers.empty?
+      warn 'No matching providers found for command' if used_providers.empty? && output.isatty
     end
 
-    def process_provider_command(provider, command, arg_str)
-      command_class = class_for_provider_and_command(provider, command)
+    def process_provider_command(provider_name, command_name, arg_str)
+      provider = Abt.provider_module(provider_name)
+      return false if provider.nil?
 
-      return false unless command_class
+      command = provider.command_class(command_name)
+      return false if command.nil?
 
-      if STDOUT.isatty
-        warn "===== #{command} #{provider}#{arg_str.nil? ? '' : ":#{arg_str}"} =====".upcase
-      end
+      print_command(command_name, provider_name, arg_str) if output.isatty
 
-      command_class.new(arg_str: arg_str, cli: self).call
+      command.new(arg_str: arg_str, cli: self).call
       true
     end
 
-    def class_for_provider_and_command(provider, command)
-      inflector = Dry::Inflector.new
-      provider_class_name = inflector.camelize(inflector.underscore(provider))
-
-      return unless Abt::Providers.const_defined? provider_class_name
-
-      provider_class = Abt::Providers.const_get provider_class_name
-      command_class_name = inflector.camelize(inflector.underscore(command))
-      return unless provider_class.const_defined? command_class_name
-
-      provider_class.const_get command_class_name
+    def print_command(name, provider, arg_str)
+      warn "===== #{name} #{provider}#{arg_str.nil? ? '' : ":#{arg_str}"} =====".upcase
     end
   end
 end

data/lib/abt/cli/dialogs.rb

@@ -4,10 +4,26 @@ module Abt
   class Cli
     module Dialogs
       def prompt(question)
-        STDERR.print "#{question}: "
+        err_output.print "#{question}: "
         read_user_input.strip
       end
 
+      def prompt_boolean(text)
+        warn text
+
+        loop do
+          err_output.print '(y / n): '
+
+          case read_user_input.strip
+          when 'y', 'Y' then return true
+          when 'n', 'N' then return false
+          else
+            warn 'Invalid choice'
+            next
+          end
+        end
+      end
+
       def prompt_choice(text, options, allow_back_option = false)
         if options.one?
           warn "Selected: #{options.first['name']}"
@@ -44,7 +60,7 @@ module Abt
       end
 
       def read_option_number(options_length, allow_back_option)
-        STDERR.print "(1-#{options_length}#{allow_back_option ? ', q: back' : ''}): "
+        err_output.print "(1-#{options_length}#{allow_back_option ? ', q: back' : ''}): "
 
         input = read_user_input
 

data/lib/abt/cli/io.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Abt
+  class Cli
+    module Io
+      def warn(*args)
+        err_output.puts(*args)
+      end
+
+      def puts(*args)
+        output.puts(*args)
+      end
+
+      def print(*args)
+        output.print(*args)
+      end
+
+      def abort(message)
+        raise AbortError, message
+      end
+    end
+  end
+end

data/lib/abt/docs.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.expand_path(__dir__)}/docs/*.rb").sort.each do |file|
+  require file
+end
+
+module Abt
+  module Docs
+    class << self
+      def examples # rubocop:disable Metrics/MethodLength
+        {
+          '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 stop harvest' => 'Stop time tracker',
+            'abt start asana harvest' => 'Continue working, e.g. after a break',
+            'abt finalize asana' => 'Finalize the selected asana task'
+          },
+          'Command output can be piped, e.g.:' => {
+            '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'
+          }
+        }
+      end
+
+      def providers
+        provider_definitions
+      end
+
+      private
+
+      def provider_definitions
+        Abt.provider_names.sort.each_with_object({}) do |name, definition|
+          provider_module = Abt.provider_module(name)
+
+          definition[name] = command_definitions(provider_module)
+        end
+      end
+
+      def command_definitions(provider_module)
+        provider_module.command_names.each_with_object({}) do |name, definition|
+          command_class = provider_module.command_class(name)
+
+          if command_class.respond_to?(:command) && command_class.respond_to?(:description)
+            definition[command_class.command] = command_class.description
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/{help → docs}/cli.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Abt
-  module Help
+  module Docs
     module Cli
       class << self
         def content
           <<~TXT
-            Usage: abt <command> [<provider:arguments>...]
+            Usage: abt <command> [<provider[:<arguments>]>...]
 
             #{example_commands}
 
@@ -20,7 +20,7 @@ module Abt
         def example_commands
           lines = []
 
-          Help.examples.each_with_index do |(title, examples), index|
+          Docs.examples.each_with_index do |(title, examples), index|
             lines << '' unless index.zero?
             lines << title
 
@@ -36,7 +36,7 @@ module Abt
         def providers_commands
           lines = []
 
-          Help.providers.each_with_index do |(provider_name, commands_definition), index|
+          Docs.providers.each_with_index do |(provider_name, commands_definition), index|
             lines << '' unless index.zero?
             lines << "#{inflector.humanize(provider_name)}:"
 

data/lib/abt/{help → docs}/markdown.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Abt
-  module Help
+  module Docs
     module Markdown
       class << self
         def content
@@ -10,7 +10,7 @@ module Abt
             This readme was generated with `abt help-md > README.md`
 
             ## Usage
-            `abt <command> [<provider:arguments>...]`
+            `abt <command> [<provider[:<arguments>]>...]`
 
             #{example_commands}
 
@@ -24,7 +24,7 @@ module Abt
         def example_commands
           lines = []
 
-          Help.examples.each_with_index do |(title, commands), index|
+          Docs.examples.each_with_index do |(title, commands), index|
             lines << '' unless index.zero?
             lines << title
 
@@ -40,7 +40,7 @@ module Abt
         def provider_commands # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           lines = []
 
-          Help.providers.each_with_index do |(provider_name, commands), index|
+          Docs.providers.each_with_index do |(provider_name, commands), index|
             lines << '' unless index.zero?
             lines << "### #{inflector.humanize(provider_name)}"
             lines << '| Command | Description |'

data/lib/abt/git_config.rb

@@ -2,76 +2,82 @@
 
 module Abt
   class GitConfig
-    class << self
-      def local(*args)
-        git_config(true, *args)
-      end
-
-      def global(*args)
-        git_config(false, *args)
-      end
+    attr_reader :namespace, :scope
 
-      def prompt_local(*args)
-        prompt_for_config(true, *args)
+    def self.local_available?
+      @local_available ||= begin
+        status = nil
+        Open3.popen3('git config --local -l') do |_i, _o, _e, thread|
+          status = thread.value
+        end
+        status.success?
       end
+    end
 
-      def prompt_global(*args)
-        prompt_for_config(false, *args)
-      end
+    def initialize(namespace: '', scope: 'local')
+      @namespace = namespace
 
-      def unset_local(key)
-        unset(true, key)
+      unless %w[local global].include? scope
+        raise ArgumentError, 'scope must be "local" or "global"'
       end
 
-      def unset_global(key)
-        unset(false, key)
-      end
+      @scope = scope
+    end
 
-      private
+    def [](key)
+      get(key)
+    end
 
-      def unset(local, key)
-        `git config --#{local ? 'local' : 'global'} --unset #{key.inspect}`
-      end
+    def []=(key, value)
+      set(key, value)
+    end
 
-      def git_config(local, key, value = nil)
-        if value
-          `git config --#{local ? 'local' : 'global'} --replace-all #{key.inspect} #{value.inspect}`
-          value
+    def local
+      @local ||= begin
+        if scope == 'local'
+          self
         else
-          git_value = `git config --get #{key.inspect}`.strip
-          git_value.empty? ? nil : git_value
+          self.class.new(namespace: namespace, scope: 'local')
         end
       end
+    end
 
-      def prompt(msg)
-        STDERR.print "#{msg} > "
-        value = read_user_input.strip
-        warn
-        value
+    def global
+      @global ||= begin
+        if scope == 'global'
+          self
+        else
+          self.class.new(namespace: namespace, scope: 'global')
+        end
       end
+    end
 
-      def prompt_for_config(local, key, prompt_msg, remedy = '') # rubocop:disable Metrics/MethodLength
-        value = git_config(local, key)
+    private
 
-        return value unless value == '' || value.nil?
+    def key_with_namespace(key)
+      namespace.empty? ? key : "#{namespace}.#{key}"
+    end
 
-        warn <<~TXT
-          Missing git config "#{key}":
-          To find this value:
-          #{remedy}
-        TXT
+    def get(key)
+      if scope == 'local' && !self.class.local_available?
+        raise StandardError, 'Local configuration is not available outside a git repository'
+      end
 
-        new_value = prompt(prompt_msg)
+      git_value = `git config --#{scope} --get #{key_with_namespace(key).inspect}`.strip
+      git_value.empty? ? nil : git_value
+    end
 
-        if new_value.empty?
-          abort 'Empty value, aborting'
-        else
-          git_config(local, key, new_value)
-        end
+    def set(key, value)
+      if scope == 'local' && !self.class.local_available?
+        raise StandardError, 'Local configuration is not available outside a git repository'
       end
 
-      def read_user_input
-        open('/dev/tty', &:gets)
+      if value.nil? || value.empty?
+        `git config --#{scope} --unset #{key_with_namespace(key).inspect}`
+        nil
+      else
+        `git config --#{scope} --replace-all #{key_with_namespace(key).inspect} #{value.inspect}`
+        value
       end
     end
   end