abt-cli 0.0.18 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df400d04c979d979ab2ead353d68374b8266c0fff678103991cc6443512b703b
-  data.tar.gz: 0345141c38eae6904d11f40a3045fccd048d8009b70fe9714f5e0986f1779861
+  metadata.gz: 0a7665ad954a2011f10df120e0dd6ca13a0ab4ef9e0aea0338be4ec2e6cc62a3
+  data.tar.gz: 7c50793f7c8cf9d3d4fb88090dec2803691a4acfc931d39135aed85d0226b00f
 SHA512:
-  metadata.gz: 1979110cbd58f0bc71b83ad7211b86e17c5b078e842d4f99ca839c88a88d627ab92506736cd83b6e414cbea2ec2a82592f6e8b3f1effdbd2b57df7decd63793e
-  data.tar.gz: 6af0e9bb436b304cda9d3acf6c86733050c9a7acffb691017d968e89e3f4e8e51b9fa4cdf5e3a85373ff2f684fa61e41afce0c1b9011d2e6b5551935b40530ea
+  metadata.gz: 1db215088d055c4857f37ac01295afa0551d9ed88b11917971ff64ff8b8761db833422b9a52f83751e3b6cf476813fff205160d04443d7a8d7b0af21ce4d755c
+  data.tar.gz: 1e89308cc2a26401cfb5e06fd37dc2a80aef260a5bad6c0da0473e61d1469b92457bf14299dc823eca526326c3239ef1b060f0fd747d206ca55eb25a9ad6cf52

data/bin/abt

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/abt.rb'
+require_relative "../lib/abt"
 
 begin
   Abt::Cli.new.perform
 rescue Abt::Cli::Abort => e
-  abort e.message
+  abort(e.message.strip)
 rescue Interrupt
-  abort 'Aborted'
+  abort("Aborted")
 end

data/lib/abt.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'dry-inflector'
-require 'faraday'
-require 'oj'
-require 'open3'
-require 'stringio'
-require 'optparse'
+require "dry-inflector"
+require "faraday"
+require "oj"
+require "open3"
+require "stringio"
+require "optparse"
 
 Dir.glob("#{File.dirname(File.absolute_path(__FILE__))}/abt/*.rb").sort.each do |file|
   require file

data/lib/abt/ari.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Abt
+  class Ari
+    attr_reader :scheme, :path, :flags
+
+    def initialize(scheme: nil, path: nil, flags: [])
+      @scheme = scheme
+      @path = path
+      @flags = flags
+    end
+
+    def to_s
+      str = scheme
+      str += ":#{path}" if path
+
+      [str, *flags].join(" ")
+    end
+  end
+end

data/lib/abt/ari_list.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Abt
+  class AriList < Array
+    def to_s
+      map(&:to_s).join(" -- ")
+    end
+
+    def -(other)
+      AriList.new(to_a - other)
+    end
+  end
+end

data/lib/abt/base_command.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Abt
+  class BaseCommand
+    extend Forwardable
+
+    def self.usage
+      raise NotImplementedError, "Command classes must implement .usage"
+    end
+
+    def self.description
+      raise NotImplementedError, "Command classes must implement .description"
+    end
+
+    def self.flags
+      []
+    end
+
+    attr_reader :ari, :cli, :flags
+
+    def_delegators(:@cli, :warn, :puts, :print, :abort, :exit_with_message)
+
+    def initialize(ari:, cli:)
+      @cli = cli
+      @ari = ari
+      @flags = parse_flags(ari.flags)
+    end
+
+    def perform
+      raise NotImplementedError, "Command classes must implement #perform"
+    end
+
+    private
+
+    def parse_flags(flags)
+      result = {}
+
+      flag_parser.parse!(flags.dup, into: result)
+
+      exit_with_message(flag_parser.help) if result[:help]
+
+      result
+    rescue OptionParser::InvalidOption => e
+      abort(e.message)
+    end
+
+    def flag_parser
+      @flag_parser ||= OptionParser.new do |opts|
+        opts.banner = <<~TXT
+          #{self.class.description.strip}
+
+          Usage: #{self.class.usage.strip}
+        TXT
+
+        opts.on("-h", "--help", "Display this help")
+
+        self.class.flags.each do |(*flag)|
+          opts.on(*flag)
+        end
+      end
+    end
+  end
+end

data/lib/abt/cli.rb

@@ -7,26 +7,31 @@ end
 module Abt
   class Cli
     class Abort < StandardError; end
+
     class Exit < StandardError; end
 
     attr_reader :command, :aris, :input, :output, :err_output, :prompt
 
-    def initialize(argv: ARGV, input: STDIN, output: STDOUT, err_output: STDERR)
+    def initialize(argv: ARGV, input: $stdin, output: $stdout, err_output: $stderr)
       (@command, *remaining_args) = argv
       @input = input
       @output = output
       @err_output = err_output
       @prompt = Abt::Cli::Prompt.new(output: err_output)
-
       @aris = ArgumentsParser.new(sanitized_piped_args + remaining_args).parse
     end
 
     def perform
-      return if handle_global_commands!
-
-      abort('No ARIs') if aris.empty?
+      if command.nil?
+        warn("No command specified, printing help\n\n")
+        @command = "help"
+      end
 
-      process_aris
+      if global_command?
+        process_global_command
+      else
+        process_aris
+      end
     end
 
     def print_ari(scheme, path, description = nil)
@@ -57,29 +62,23 @@ module Abt
 
     private
 
-    def handle_global_commands!
-      case command
-      when nil
-        warn("No command specified\n\n")
-        puts(Abt::Docs::Cli.help)
-        true
-      when '--version', '-v', 'version'
-        puts(Abt::VERSION)
-        true
-      when '--help', '-h', 'help'
-        puts(Abt::Docs::Cli.help)
-        true
-      when 'commands'
-        puts(Abt::Docs::Cli.commands)
-        true
-      when 'examples'
-        puts(Abt::Docs::Cli.examples)
-        true
-      when 'readme'
-        puts(Abt::Docs::Markdown.readme)
-        true
-      else
-        false
+    def global_command?
+      return true if aris.empty?
+      return true if aris.first.scheme.nil?
+
+      false
+    end
+
+    def process_global_command
+      command_class = GlobalCommands.command_class(command)
+
+      abort("No such global command: #{command}, perhaps you forgot to add an ARI?") if command_class.nil?
+
+      begin
+        ari = aris.first || Abt::Ari.new
+        command_class.new(cli: self, ari: ari).perform
+      rescue Exit => e
+        puts e.message
       end
     end
 
@@ -89,47 +88,47 @@ module Abt
       @sanitized_piped_args ||= begin
         input_string = input.read.strip
 
-        abort 'No input from pipe' if input_string.nil? || input_string.empty?
+        abort("No input from pipe") if input_string.nil? || input_string.empty?
 
         # Exclude comment part of piped input lines
-        lines_without_comments = input_string.lines.map do |line|
-          line.split(' # ').first
-        end
+        lines_without_comments = input_string.lines.map { |line| line.split(" # ").first }
 
         # 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 = lines_without_comments.join(" ").strip
         joined_lines.split(/\s+/)
       end
     end
 
     def process_aris
       used_schemes = []
-      aris.each do |ari|
-        scheme = ari.scheme
-        path = ari.path
 
-        if used_schemes.include?(scheme)
-          warn "Dropping command for already used scheme: #{ari}"
+      aris.each do |ari|
+        if used_schemes.include?(ari.scheme)
+          warn("Dropping command for already used scheme: #{ari}")
           next
         end
 
-        command_class = get_command_class(scheme)
-        next if command_class.nil?
-
-        print_command(command, ari) if output.isatty
-        begin
-          command_class.new(path: path, cli: self, flags: ari.flags).perform
-        rescue Exit => e
-          puts e.message
-        end
-
-        used_schemes << scheme
+        used_schemes << ari.scheme if process_ari(ari)
       end
 
       return unless used_schemes.empty? && output.isatty
 
-      abort 'No providers found for command and ARI(s)'
+      abort("No providers found for command and ARI(s)")
+    end
+
+    def process_ari(ari)
+      command_class = get_command_class(ari.scheme)
+      return false if command_class.nil?
+
+      print_command(command, ari) if output.isatty
+      begin
+        command_class.new(ari: ari, cli: self).perform
+      rescue Exit => e
+        puts e.message
+      end
+
+      true
     end
 
     def get_command_class(scheme)
@@ -140,7 +139,7 @@ module Abt
     end
 
     def print_command(name, ari)
-      warn "===== #{name} #{ari} =====".upcase
+      warn("===== #{name.upcase} #{ari} =====")
     end
   end
 end

data/lib/abt/cli/arguments_parser.rb

@@ -3,28 +3,6 @@
 module Abt
   class Cli
     class ArgumentsParser
-      class Ari
-        attr_reader :scheme, :path, :flags
-
-        def initialize(scheme:, path:, flags:)
-          @scheme = scheme
-          @path = path
-          @flags = flags
-        end
-
-        def to_s
-          str = scheme
-          str += ":#{path}" if path
-
-          [str, *flags].join(' ')
-        end
-      end
-      class Aris < Array
-        def to_s
-          map(&:to_s).join(' -- ')
-        end
-      end
-
       attr_reader :arguments
 
       def initialize(arguments)
@@ -32,11 +10,14 @@ module Abt
       end
 
       def parse
-        result = Aris.new
+        result = AriList.new
         rest = arguments.dup
 
+        # If the first arg is a flag, it's for a global command
+        result << Ari.new(flags: take_flags(rest)) if flag?(rest.first)
+
         until rest.empty?
-          (scheme, path) = rest.shift.split(':')
+          (scheme, path) = rest.shift.split(":")
           flags = take_flags(rest)
 
           result << Ari.new(scheme: scheme, path: path, flags: flags)
@@ -59,11 +40,11 @@ module Abt
       end
 
       def flag?(part)
-        part && part[0] == '-'
+        part && part[0] == "-"
       end
 
       def delimiter?(part)
-        part == '--'
+        part == "--"
       end
     end
   end

data/lib/abt/cli/global_commands.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.expand_path(__dir__)}/global_commands/*.rb").sort.each { |file| require file }
+
+module Abt
+  class Cli
+    module GlobalCommands
+      def self.command_names
+        constants.sort.map { |constant_name| Helpers.const_to_command(constant_name) }
+      end
+
+      def self.command_class(name)
+        name = "help" if [nil, "-h", "--help"].include?(name)
+        name = "version" if ["-v", "--version"].include?(name)
+
+        const_name = Helpers.command_to_const(name)
+        return unless const_defined?(const_name)
+
+        const_get(const_name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Abt
+  class Cli
+    module GlobalCommands
+      class Commands < Abt::BaseCommand
+        def self.usage
+          "abt commands"
+        end
+
+        def self.description
+          "List all abt commands"
+        end
+
+        attr_reader :cli
+
+        def perform
+          puts(Abt::Docs::Cli.commands)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Abt
+  class Cli
+    module GlobalCommands
+      class Examples < Abt::BaseCommand
+        def self.usage
+          "abt examples"
+        end
+
+        def self.description
+          "Print command examples"
+        end
+
+        attr_reader :cli
+
+        def perform
+          puts(Abt::Docs::Cli.examples)
+        end
+      end
+    end
+  end
+end