commander-tool 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5496f2b9238097da058b066f97a541fff53522c6121de06cc0b1571bdd494e19
-  data.tar.gz: 4a3f35031685414b72c956c7bb78e32fd3bace54909e3694ae417159802b0723
+  metadata.gz: fc12456920e61c887d63c3224bbabe9b8c8850df925733a917c782da347ad2a6
+  data.tar.gz: fc30d88eac1a17c0effd957e5e1fc1cdcada2e83eda493087e2421b568e2ea88
 SHA512:
-  metadata.gz: 29c6b2246ef33bf14e01048d7f3a7df42da6d36080c33a00ba9834936a2c91e9d78214d3dc75590706265f066270db42293499245cc1f21460d1afa0871d2022
-  data.tar.gz: b4270d0872210a3287049f7a41de8d743859e30ccf2406d26471183dae922daba1809b78abe06856e3154a5ab21c3f88abcbc586bb705a1b1b7b9cdfaa656a2c
+  metadata.gz: f830e16aad8121ad5a59cf0a2f4ebf9ce8835e0c06ae2589e845137a06f4dc04f0bff5af628c467d25c04da944f11d393e9da67d025166035bb563819eccc24c
+  data.tar.gz: 759a7318b4a23153c992a3a5fb2422b3fd31efb6c2632cf38f2b279430aa92e7bf2fa539db240f07cceebe9fa4284d43dceeaf89c9325f51224001cdb49fc521

data/lib/commander-tool.rb

@@ -1,14 +1,14 @@
 require "did_you_mean"
 
 class Commander
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 
   class Command
     attr_reader :name, :description, :options, :block, :subcommands
 
     def initialize(name, description = "", &block)
       @name = name.to_s
-      @description = description
+      @description = description.to_s
       @options = []
       @subcommands = {}
       @block = block
@@ -34,12 +34,21 @@ class Commander
     attr_reader :switches, :description, :key
 
     def initialize(switches, description = "")
-      @switches = switches
-      @description = description
+      @switches = Array(switches).map(&:to_s)
+      @description = description.to_s
+
+      long =
+        @switches.find { |s| s.start_with?("--") }
+
+      short =
+        @switches.find { |s| s.start_with?("-") }
 
       @key =
-        switches.find { |s| s.start_with?("--") }&.sub(/^--/, "")&.tr("-", "_") ||
-        switches.find { |s| s.start_with?("-") }&.sub(/^-/, "")
+        if long
+          long.sub(/\A--/, "").tr("-", "_")
+        elsif short
+          short.sub(/\A-/, "").tr("-", "_")
+        end
     end
 
     def matches?(arg)
@@ -48,8 +57,8 @@ class Commander
 
     def value_required?
       @description.include?("<") ||
-        @description.include?("argument") ||
-        @description.include?("value")
+        @description.match?(/\bargument\b/i) ||
+        @description.match?(/\bvalue\b/i)
     end
   end
 
@@ -70,27 +79,61 @@ class Commander
   end
 
   def parse(args = ARGV)
-    global_options, remaining = parse_options(
-      args,
-      @global_options
-    )
+    args = Array(args).dup
+
+    if args.empty?
+      print_usage
+      return
+    end
 
-    command_name = remaining.shift
+    if args.first == "--version" || args.first == "-v"
+      puts "Commander CLI v#{VERSION}"
+      return
+    end
 
-    if command_name.nil?
-      handle_no_command(global_options)
+    if args.first == "--help" || args.first == "-h"
+      print_usage
       return
     end
 
-    command = @commands[command_name]
+    # Find the first registered top-level command.
+    command_index = nil
+    command = nil
+
+    args.each_with_index do |arg, index|
+      next if arg.start_with?("-")
+
+      if @commands.key?(arg)
+        command_index = index
+        command = @commands[arg]
+        break
+      end
+    end
 
     unless command
-      raise_unknown_command(command_name)
+      name = args.find { |arg| !arg.start_with?("-") }
+
+      if name
+        raise_unknown_command(name)
+      else
+        raise_unknown_option(args.first, @global_options)
+      end
     end
 
+    # Only arguments BEFORE the command belong to global options.
+    global_args = args[0...command_index]
+
+    # Everything AFTER the command belongs to that command.
+    command_args = args[(command_index + 1)..] || []
+
+    global_options, = parse_options(
+      global_args,
+      @global_options
+    )
+
     parse_command(
       command,
-      remaining,
+      command_args,
       global_options
     )
   end
@@ -98,6 +141,8 @@ class Commander
   private
 
   def parse_command(command, args, inherited_options)
+    args = args.dup
+
     if command.has_subcommands?
       subcommand_name = args.shift
 
@@ -106,6 +151,11 @@ class Commander
         return
       end
 
+      if subcommand_name == "--help" || subcommand_name == "-h"
+        print_command_help(command)
+        return
+      end
+
       subcommand = command.subcommands[subcommand_name]
 
       unless subcommand
@@ -116,7 +166,10 @@ class Commander
       end
 
       command_options, command_args =
-        parse_options(args, command.options)
+        parse_options(
+          args,
+          command.options
+        )
 
       combined_options =
         inherited_options.merge(command_options)
@@ -138,7 +191,10 @@ class Commander
     end
 
     command_options, command_args =
-      parse_options(args, command.options)
+      parse_options(
+        args,
+        command.options
+      )
 
     combined_options =
       inherited_options.merge(command_options)
@@ -152,6 +208,7 @@ class Commander
   def parse_options(args, available_options)
     parsed = {}
     remaining = []
+
     i = 0
 
     while i < args.length
@@ -162,37 +219,41 @@ class Commander
         break
       end
 
-      if arg.start_with?("-")
-        option = available_options.find do |opt|
-          opt.matches?(arg)
+      unless arg.start_with?("-")
+        remaining << arg
+        i += 1
+        next
+      end
+
+      option =
+        available_options.find do |candidate|
+          candidate.matches?(arg)
         end
 
+      unless option
         raise_unknown_option(
           arg,
           available_options
-        ) unless option
+        )
+      end
 
-        next_arg = args[i + 1]
+      next_arg = args[i + 1]
 
-        if option.value_required?
-          if next_arg.nil? ||
-             next_arg.start_with?("-")
-            raise_missing_argument(arg)
-          end
+      if option.value_required?
+        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?("-")
+        parsed[option.key.to_sym] = next_arg
+        i += 2
+      else
+        if next_arg && !next_arg.start_with?("-")
           parsed[option.key.to_sym] = next_arg
           i += 2
         else
           parsed[option.key.to_sym] = true
           i += 1
         end
-      else
-        remaining << arg
-        i += 1
       end
     end
 
@@ -204,26 +265,29 @@ class Commander
   end
 
   def raise_unknown_command(name)
-    corrector = DidYouMean::SpellChecker.new(
-      dictionary: @commands.keys
-    )
+    corrector =
+      DidYouMean::SpellChecker.new(
+        dictionary: @commands.keys
+      )
 
     suggestions = corrector.correct(name)
 
-    message = "error: unknown command '#{name}'"
+    message =
+      "error: unknown command '#{name}'"
 
     unless suggestions.empty?
-      message += "\n\nDid you mean?\n"
-      message += suggestions.map { |s| "\t#{s}" }.join("\n")
+      message << "\n\nDid you mean?\n"
+      message << suggestions.map { |s| "\t#{s}" }.join("\n")
     end
 
     abort message
   end
 
   def raise_unknown_subcommand(name, command)
-    corrector = DidYouMean::SpellChecker.new(
-      dictionary: command.subcommands.keys
-    )
+    corrector =
+      DidYouMean::SpellChecker.new(
+        dictionary: command.subcommands.keys
+      )
 
     suggestions = corrector.correct(name)
 
@@ -231,41 +295,35 @@ class Commander
       "error: unknown command '#{name}'"
 
     unless suggestions.empty?
-      message += "\n\nDid you mean?\n"
-      message += suggestions.map { |s| "\t#{s}" }.join("\n")
+      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)
+    switches =
+      options.flat_map(&:switches)
 
-    corrector = DidYouMean::SpellChecker.new(
-      dictionary: switches
-    )
+    corrector =
+      DidYouMean::SpellChecker.new(
+        dictionary: switches
+      )
 
     suggestions = corrector.correct(name)
 
-    message = "error: unknown option '#{name}'"
+    message =
+      "error: unknown option '#{name}'"
 
     unless suggestions.empty?
-      message += "\n\nDid you mean?\n"
-      message += suggestions.map { |s| "\t#{s}" }.join("\n")
+      message << "\n\nDid you mean?\n"
+      message << suggestions.map { |s| "\t#{s}" }.join("\n")
     end
 
     abort message
   end
 
-  def handle_no_command(options)
-    if options[:version] || options[:v]
-      puts "Commander CLI v#{VERSION}"
-      return
-    end
-
-    print_usage
-  end
-
   def print_usage
     puts "Usage: <command> [options]"
     puts
@@ -288,8 +346,12 @@ class Commander
   def print_command_help(command)
     puts "Usage: #{command.name} <subcommand> [options]"
     puts
-    puts command.description unless command.description.empty?
-    puts
+
+    unless command.description.empty?
+      puts command.description
+      puts
+    end
+
     puts "Commands:"
 
     command.subcommands.each_value do |subcommand|

metadata

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