simple-cli 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2bbb7f97dbbfd4da167b579db74edf64e58f696
-  data.tar.gz: 3fa71c9effb4830a2542d11562767c67da9f2f95
+  metadata.gz: d679f9697e51d2d91312bfe3eaac0a6cb577019a
+  data.tar.gz: 0a7cce907a747c8a0b0c44a1c2d4f5e45701f59c
 SHA512:
-  metadata.gz: dbf7773b19c487d395706b84b9ea35d59ff9fd11b63b2adf2624375d0212d9ceec8ea55b154f68be4e71fb16ec06f9d177ad178f15a34b464298c5908e1ab0b7
-  data.tar.gz: f6ee3a7d40c9dd6eb3849625294b17c2cbe5f096b5d7c78a34b0292a67af436fefb12e60b6997acddd3c0f9d36d66d4218064690413ac8495acd9bb0c5511497
+  metadata.gz: 18fdd30d1a31e77da83a3e549c43d2712f0912121becf6240c528cb8686e3059899d15a06602237bd986493f0d0764eba4edce24c19aa358346ef4be5d3a0bb2
+  data.tar.gz: 0e53ca862abac7db8120d1ec922fe0310f8fcd02f99d5efd09e528565bcd775e171cf91bcff7ee97a22b97844a41f2f2bd9fc8d69ec393924341a08850736308

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple-cli (0.2.3)
+    simple-cli (0.2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -55,4 +55,4 @@ DEPENDENCIES
   simplecov (~> 0)
 
 BUNDLED WITH
-   1.13.6
+   1.16.1

data/lib/simple/cli/runner.rb

@@ -134,34 +134,57 @@ class Simple::CLI::Runner
   end
 
   def help!
-    STDERR.puts "Usage:\n\n"
+    # collect help information on individual comments; when not on DEBUG
+    # level skipping the commands that don't jave a command help.
     command_helps = commands.inject({}) do |hsh, sym|
+      edoc = CommandHelp.new(@app, sym)
+      next hsh if !edoc.head && logger.level != ::Logger::DEBUG
+
       hsh.update sym => help_for_command(sym)
     end
-    max_command_helps_length = command_helps.values.map(&:length).max
 
-    commands.sort.each do |sym|
-      command_help = command_helps.fetch(sym)
-      command_help = format("%-#{max_command_helps_length}s", command_help)
+    # build a lambda which prints a help line with nice formatting
+    max_length = command_helps.values.map(&:length).max
+    print_help_line = lambda do |cmd, description|
+      if description
+        STDERR.puts format("    %-#{max_length}s    # %s", cmd, description)
+      else
+        STDERR.puts format("    %-#{max_length}s", cmd)
+      end
+    end
+
+    # print help for commands
+    STDERR.puts "Usage:\n\n"
+
+    command_helps.keys.sort.each do |sym|
+      command_help = command_helps[sym]
       edoc = CommandHelp.new(@app, sym)
-      next if !edoc.head && logger.level != ::Logger::DEBUG
-      head = "# #{edoc.head}" if edoc.head
-      STDERR.puts "    #{command_help}    #{head}"
+      print_help_line.call command_help, edoc.head
     end
 
-    STDERR.puts "\n"
+    # print help for default commands
 
     STDERR.puts <<~DOC
+
       Default options include:
 
-          #{binary_name} [ --verbose | -v ]                                                                       # run on DEBUG log level
-          #{binary_name} [ --quiet | -q ]                                                                         # run on WARN log level
-          #{binary_name} help [ subcommand ]                                                                      # print help on a specific subcommand
-          #{binary_name} help autocomplete                                                                        # print information on autocompletion.
-          #{binary_name} help -v                                                                                  # show help for internal commands as well
+    DOC
+
+    print_help_line.call "#{binary_name} [ --verbose | -v ]", "run on DEBUG log level"
+    print_help_line.call "#{binary_name} [ --quiet | -q ]", "run on WARN log level"
+
+    STDERR.puts <<~DOC
+
+      Other commands:
 
     DOC
 
+    print_help_line.call "#{binary_name} help [ subcommand ]", "print help on a specific subcommand"
+    print_help_line.call "#{binary_name} help -v", "show help for internal commands as well"
+    print_help_line.call "#{binary_name} help autocomplete", "print information on autocompletion."
+
+    STDERR.puts "\n"
+
     exit 1
   end
 end

data/lib/simple/cli/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module CLI
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-18 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake