commander-tool 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fe0b76d088b96fcd3e9a46d540f79ff38d10bb49d1f35c8ed4d2b1f9bd26ddb
-  data.tar.gz: 2c349bc20037922113ea90e74a00c6688495f1950bebe67c505d502c6bffff4d
+  metadata.gz: 5496f2b9238097da058b066f97a541fff53522c6121de06cc0b1571bdd494e19
+  data.tar.gz: 4a3f35031685414b72c956c7bb78e32fd3bace54909e3694ae417159802b0723
 SHA512:
-  metadata.gz: 4c20b7c34bcdb2663ee7f4554ac25b1c41c8910fe62d21e9e91b60b47f651c54fdfc7aa0e7f529db11e6a1e27e26d61ba12bc40c5f08ff8ad8fbd7fe8679b4fa
-  data.tar.gz: 3bd9b6f788e3b2bb33e714520db2b57eb299cce3d95670b15dfb6a203cac16acc233a5c5b908647d1f3a2e5d9e2118fc32a4ca60d79a7f095afade07fe90734b
+  metadata.gz: 29c6b2246ef33bf14e01048d7f3a7df42da6d36080c33a00ba9834936a2c91e9d78214d3dc75590706265f066270db42293499245cc1f21460d1afa0871d2022
+  data.tar.gz: b4270d0872210a3287049f7a41de8d743859e30ccf2406d26471183dae922daba1809b78abe06856e3154a5ab21c3f88abcbc586bb705a1b1b7b9cdfaa656a2c

data/lib/commander-tool.rb

@@ -1,32 +1,45 @@
-require 'did_you_mean'
+require "did_you_mean"
 
 class Commander
+  VERSION = "1.0.1"
+
   class Command
-    attr_reader :name, :description, :options, :block
+    attr_reader :name, :description, :options, :block, :subcommands
 
-    def initialize(name, description = '', &block)
+    def initialize(name, description = "", &block)
       @name = name.to_s
       @description = description
       @options = []
+      @subcommands = {}
       @block = block
     end
 
-    def add_option(switches, description = '')
+    def add_option(switches, description = "")
       @options << Option.new(switches, description)
       self
     end
+
+    def add_subcommand(name, description = "", &block)
+      command = Command.new(name, description, &block)
+      @subcommands[command.name] = command
+      command
+    end
+
+    def has_subcommands?
+      !@subcommands.empty?
+    end
   end
 
   class Option
     attr_reader :switches, :description, :key
 
-    def initialize(switches, description = '')
+    def initialize(switches, description = "")
       @switches = switches
       @description = description
 
       @key =
-        switches.find { |s| s.start_with?('--') }&.sub(/^--/, '')&.tr('-', '_') ||
-        switches.find { |s| s.start_with?('-') }&.sub(/^-/, '')
+        switches.find { |s| s.start_with?("--") }&.sub(/^--/, "")&.tr("-", "_") ||
+        switches.find { |s| s.start_with?("-") }&.sub(/^-/, "")
     end
 
     def matches?(arg)
@@ -34,10 +47,9 @@ class Commander
     end
 
     def value_required?
-      description.include?('<') ||
-        description.include?('argument') ||
-        description.include?('value') ||
-        description.include?('VALUE')
+      @description.include?("<") ||
+        @description.include?("argument") ||
+        @description.include?("value")
     end
   end
 
@@ -46,45 +58,97 @@ class Commander
     @global_options = []
   end
 
-  def add_command(name, description = '', &block)
-    cmd = Command.new(name, description, &block)
-    @commands[cmd.name] = cmd
-    cmd
+  def add_command(name, description = "", &block)
+    command = Command.new(name, description, &block)
+    @commands[command.name] = command
+    command
   end
 
-  def add_option(switches, description = '')
+  def add_option(switches, description = "")
     @global_options << Option.new(switches, description)
     self
   end
 
   def parse(args = ARGV)
-    global_parsed, remaining_args =
-      parse_options(args, @global_options)
+    global_options, remaining = parse_options(
+      args,
+      @global_options
+    )
 
-    command_name = remaining_args.shift
+    command_name = remaining.shift
 
     if command_name.nil?
-      handle_no_command(global_parsed)
+      handle_no_command(global_options)
       return
     end
 
-    if @commands.key?(command_name)
-      command = @commands[command_name]
+    command = @commands[command_name]
 
-      cmd_parsed, command_args =
-        parse_options(remaining_args, command.options)
-
-      # Merge global and command options for execution
-      combined_options = global_parsed.merge(cmd_parsed)
-
-      command.block.call(combined_options, command_args) if command.block
-    else
+    unless command
       raise_unknown_command(command_name)
     end
+
+    parse_command(
+      command,
+      remaining,
+      global_options
+    )
   end
 
   private
 
+  def parse_command(command, args, inherited_options)
+    if command.has_subcommands?
+      subcommand_name = args.shift
+
+      if subcommand_name.nil?
+        print_command_help(command)
+        return
+      end
+
+      subcommand = command.subcommands[subcommand_name]
+
+      unless subcommand
+        raise_unknown_subcommand(
+          subcommand_name,
+          command
+        )
+      end
+
+      command_options, command_args =
+        parse_options(args, command.options)
+
+      combined_options =
+        inherited_options.merge(command_options)
+
+      if subcommand.has_subcommands?
+        parse_command(
+          subcommand,
+          command_args,
+          combined_options
+        )
+      elsif subcommand.block
+        subcommand.block.call(
+          combined_options,
+          command_args
+        )
+      end
+
+      return
+    end
+
+    command_options, command_args =
+      parse_options(args, command.options)
+
+    combined_options =
+      inherited_options.merge(command_options)
+
+    command.block.call(
+      combined_options,
+      command_args
+    ) if command.block
+  end
+
   def parse_options(args, available_options)
     parsed = {}
     remaining = []
@@ -93,23 +157,33 @@ class Commander
     while i < args.length
       arg = args[i]
 
-      if arg.start_with?('-')
-        option = available_options.find { |opt| opt.matches?(arg) }
+      if arg == "--"
+        remaining.concat(args[(i + 1)..] || [])
+        break
+      end
 
-        unless option
-          raise_unknown_option(arg, available_options)
+      if arg.start_with?("-")
+        option = available_options.find do |opt|
+          opt.matches?(arg)
         end
 
+        raise_unknown_option(
+          arg,
+          available_options
+        ) unless option
+
         next_arg = args[i + 1]
 
         if option.value_required?
-          if next_arg.nil? || next_arg.start_with?('-')
+          if next_arg.nil? ||
+             next_arg.start_with?("-")
             raise_missing_argument(arg)
           end
 
           parsed[option.key.to_sym] = next_arg
           i += 2
-        elsif next_arg && !next_arg.start_with?('-')
+        elsif next_arg &&
+              !next_arg.start_with?("-")
           parsed[option.key.to_sym] = next_arg
           i += 2
         else
@@ -125,62 +199,80 @@ class Commander
     [parsed, remaining]
   end
 
-  def raise_missing_argument(option_name)
-    abort "error: flag '#{option_name}' needs an argument"
+  def raise_missing_argument(option)
+    abort "error: flag '#{option}' needs an argument"
   end
 
-  def raise_unknown_command(command_name)
+  def raise_unknown_command(name)
     corrector = DidYouMean::SpellChecker.new(
       dictionary: @commands.keys
     )
 
-    suggestions = corrector.correct(command_name)
+    suggestions = corrector.correct(name)
 
-    msg = "error: unknown command '#{command_name}'"
+    message = "error: unknown command '#{name}'"
 
     unless suggestions.empty?
-      msg += "\n\nDid you mean?\n"
-      msg += suggestions.map { |s| "\t#{s}" }.join("\n")
+      message += "\n\nDid you mean?\n"
+      message += suggestions.map { |s| "\t#{s}" }.join("\n")
     end
 
-    abort msg
+    abort message
   end
 
-  def raise_unknown_option(option_name, available_options)
-    all_switches = available_options.flat_map(&:switches)
+  def raise_unknown_subcommand(name, command)
+    corrector = DidYouMean::SpellChecker.new(
+      dictionary: command.subcommands.keys
+    )
+
+    suggestions = corrector.correct(name)
+
+    message =
+      "error: unknown command '#{name}'"
+
+    unless suggestions.empty?
+      message += "\n\nDid you mean?\n"
+      message += suggestions.map { |s| "\t#{s}" }.join("\n")
+    end
+
+    abort message
+  end
+
+  def raise_unknown_option(name, options)
+    switches = options.flat_map(&:switches)
 
     corrector = DidYouMean::SpellChecker.new(
-      dictionary: all_switches
+      dictionary: switches
     )
 
-    suggestions = corrector.correct(option_name)
+    suggestions = corrector.correct(name)
 
-    msg = "error: unknown option '#{option_name}'"
+    message = "error: unknown option '#{name}'"
 
     unless suggestions.empty?
-      msg += "\n\nDid you mean?\n"
-      msg += suggestions.map { |s| "\t#{s}" }.join("\n")
+      message += "\n\nDid you mean?\n"
+      message += suggestions.map { |s| "\t#{s}" }.join("\n")
     end
 
-    abort msg
+    abort message
   end
 
   def handle_no_command(options)
     if options[:version] || options[:v]
-      puts "Commander CLI v1.0.0"
+      puts "Commander CLI v#{VERSION}"
       return
     end
 
+    print_usage
+  end
+
+  def print_usage
     puts "Usage: <command> [options]"
     puts
     puts "Commands:"
 
-    if @commands.empty?
-      puts "  No commands available."
-    else
-      @commands.each_value do |command|
-        puts "  #{command.name.ljust(20)} #{command.description}"
-      end
+    @commands.each_value do |command|
+      puts "  #{command.name.ljust(20)} #{command.description}"
     end
 
     unless @global_options.empty?
@@ -188,8 +280,20 @@ class Commander
       puts "Options:"
 
       @global_options.each do |option|
-        puts "  #{option.switches.join(', ').ljust(20)} #{option.description}"
+        puts "  #{option.switches.join(", ").ljust(20)} #{option.description}"
       end
     end
   end
+
+  def print_command_help(command)
+    puts "Usage: #{command.name} <subcommand> [options]"
+    puts
+    puts command.description unless command.description.empty?
+    puts
+    puts "Commands:"
+
+    command.subcommands.each_value do |subcommand|
+      puts "  #{subcommand.name.ljust(20)} #{subcommand.description}"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander-tool
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jjjm