simple-cli 0.2.28 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba16419e4dc2f0fe2dc47fe0a5cb29a6de15a57d2b221ef3aa8c3ed7455c0556
-  data.tar.gz: 6293877fe62faaaf2718745c94ebb1ea798e1500330f75095c0363f151047fe4
+  metadata.gz: 1fdfd698a5315891e4d5dd96e5d3ce07fc075d17d5ced10eb06a9cb5733b4a8a
+  data.tar.gz: 9000f43f3dfceb572aae61b8907216c3dd7c9c4c468374587f56d5c433d84ecd
 SHA512:
-  metadata.gz: 1dc54fc73aa56d28485023047df277663cdf0b0edeaacde994c772fd908934e7994bf84d4f9e216cc55573df2b3ad128d800ab217f268dfdbee731fd48e0db93
-  data.tar.gz: b9ee91e8c0aae8d0586b90dcbebe7476d9c34338ecc45bbdd08a685548f539c519db6412e99de13a65acac5538d0c151fe2dd76b9c3966126d1c91b910ada533
+  metadata.gz: 82f219944dc7ffecac5cae4975749732a6741ee676f5ffd8b4ca862c48717d20a56dfc363dbf7c486e5cb9d48ba376eecb67a7185557547da7824bd201fd524f
+  data.tar.gz: ee581a7eb68e35c9cc8a2560538f709a1c9ce8a90457338c14ef9446875563f6e9f9f4012844c5ada1f96486ef0945e9917cdda0434972b078c9dc22c5f2c9d1

data/lib/simple/cli/adapter.rb

@@ -1,8 +1,24 @@
 module Simple::CLI::Adapter
-  def run!(*args)
-    args = ARGV if args.empty?
-
-    Simple::CLI::Runner.run(self, *args)
+  # Run a Simple::CLI application
+  #
+  # This is usually called with as either
+  #
+  # - Application::CLI.run!: runs the Application's CLI with subcommand support.
+  # 
+  # or
+  #
+  # - Application::CLI.run!("main"): runs the Application's CLI without subcommand support.
+  #
+  def run!(main_command = nil)
+    runner = Simple::CLI::Runner.new(self)
+    
+    if main_command && (ARGV.include?("--help") || ARGV.include?("-h"))
+      runner.help(main_command)
+    elsif main_command
+      runner.run(main_command, *ARGV)
+    else
+      runner.run(*ARGV)
+    end
   end
 
   def logger=(logger)

data/lib/simple/cli/logger/colored_logger.rb

@@ -56,6 +56,11 @@ module Simple::CLI::Logger::ColoredLogger
     log :error, *args, &block
   end
 
+  def fatal(*args, &block)
+    log :error, *args, &block
+    exit 1
+  end
+
   def success(*args, &block)
     log :success, *args, &block
   end
@@ -118,25 +123,10 @@ module Simple::CLI::Logger::ColoredLogger
     STDERR.puts msg
   end
 
-  # [TODO] The heuristic used to determine the caller is not perfect.
-  # Maybe we'll find a better solution; but for now this has to do.
+  # The heuristic used to determine the caller is not perfect, but should
+  # do well in most cases.
   def source_from_caller
-    source = caller.find do |loc|
-      # skip this gem
-      next false if loc =~ /\/lib\/simple\/cli\//
-
-      # skip forwardable from Ruby stdlib
-      next false if loc =~ /\/forwardable.rb\:/
-
-      # skip simple-sql
-      next false if loc =~ /\/lib\/simple\/sql\b/
-
-      # skip lib/postjob/queue/postgres/checked_sql.rb
-      next false if loc =~ %r{lib/postjob/queue/postgres/checked_sql.rb}
-
-      true
-    end
-
+    source = caller.find { |loc| loc !~ /simple-cli.*\/lib\/simple\/cli/ }
     source ||= caller[2]
     source = source[(wd.length + 1)..-1] if source.start_with?(wd)
     source

data/lib/simple/cli/runner/command_help.rb

@@ -43,7 +43,7 @@ class Simple::CLI::Runner::CommandHelp
   end
 
   # A help string constructed from the commands method signature.
-  def interface(binary_name, command_name)
+  def interface(binary_name, command_name, include_subcommand: false)
     args = @method_parameters_ex.map do |mode, name|
       case mode
       when :req   then "<#{name}>"
@@ -66,7 +66,8 @@ class Simple::CLI::Runner::CommandHelp
       end
     end.compact
 
-    help = "#{binary_name} #{command_to_string(command_name)}"
+    help = "#{binary_name}"
+    help << " #{command_to_string(command_name)}" if include_subcommand
     help << " #{options.join(' ')}" unless options.empty?
     help << " #{args.join(' ')}" unless args.empty?
     help

data/lib/simple/cli/runner.rb

@@ -8,13 +8,10 @@ class Simple::CLI::Runner
 end
 
 require_relative "runner/command_help"
-require_relative "runner/autocompletion"
 
 # A Runner object manages running a CLI application module with a set
 # of string arguments (usually taken from ARGV)
 class Simple::CLI::Runner
-  include Autocompletion
-
   def self.run(app, *args)
     new(app).run(*args)
   end
@@ -34,6 +31,14 @@ class Simple::CLI::Runner
 
   attr_accessor :subcommand
 
+  def help(command)
+    if command
+      run "help", command
+    else
+      run "help"
+    end
+  end
+
   def run(*args)
     extract_default_flags!(args)
 
@@ -43,10 +48,6 @@ class Simple::CLI::Runner
 
     if command == :help
       do_help!(*args)
-    elsif command == :autocomplete
-      autocomplete(*args)
-    elsif command == :autocomplete_bash
-      autocomplete_bash(*args)
     elsif commands.include?(command)
       self.subcommand = command
       @instance.run! command, *args_with_options(args)
@@ -57,6 +58,10 @@ class Simple::CLI::Runner
     on_exception(e)
   end
 
+  def has_subcommands?
+    commands.length > 1
+  end
+
   def do_help!(subcommand = nil)
     if !subcommand
       help!
@@ -72,8 +77,19 @@ class Simple::CLI::Runner
       #{help_for_command(subcommand)}
 
       #{edoc.full}
-     MSG
+    MSG
 
+    unless has_subcommands?
+
+      STDERR.puts <<~MSG
+
+        Default options include:
+
+        #{binary_name} [ --help | -h ]                  ... print this help
+        #{binary_name} [ --verbose | -v ]               ... run on DEBUG log level
+        #{binary_name} [ --quiet | -q ]                 ... run on WARN log level
+      MSG
+    end
     exit 1
   end
 
@@ -133,13 +149,8 @@ class Simple::CLI::Runner
   end
 
   def help_for_command(sym)
-    if sym == "autocomplete"
-      autocomplete_help
-      return
-    end
-
     cmd = string_to_command(sym)
-    CommandHelp.new(@app, cmd).interface(binary_name, cmd)
+    CommandHelp.new(@app, cmd).interface(binary_name, cmd, include_subcommand: has_subcommands?)
   end
 
   def binary_name
@@ -194,7 +205,6 @@ class Simple::CLI::Runner
 
     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"
 

data/lib/simple/cli/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module CLI
-    VERSION = "0.2.28"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simple-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.28
+  version: 0.3.0
 platform: ruby
 authors:
 - radiospiel
 - mediapeers GmbH
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2019-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,13 +75,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby-version"
 - Gemfile
-- README.md
 - Rakefile
 - bin/rake
-- doc/examples/ex1/ex1
-- doc/examples/ex1/ex1.rb
 - lib/simple-cli.rb
 - lib/simple/cli.rb
 - lib/simple/cli/adapter.rb
@@ -91,7 +87,6 @@ files:
 - lib/simple/cli/logger/colored_logger.rb
 - lib/simple/cli/pp.rb
 - lib/simple/cli/runner.rb
-- lib/simple/cli/runner/autocompletion.rb
 - lib/simple/cli/runner/command_help.rb
 - lib/simple/cli/runner/module_ex.rb
 - lib/simple/cli/version.rb
@@ -103,7 +98,7 @@ files:
 homepage: http://github.com/radiospiel/simple-cli
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -118,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.4
+signing_key: 
 specification_version: 4
 summary: Simple CLI builder for ruby
 test_files:

data/.ruby-version

@@ -1 +0,0 @@
-2.7.2

data/README.md

@@ -1,32 +0,0 @@
-# simple-cli
-
-Building Ruby CLIs with easy.
-
-## Philosophy
-
-Building a command line could be much easier than what ruby provides with its standard library. In general, between the invocation of a tool from the command line and the actual running of whatever code the user intends to run really should disappear.
-
-Ideally a developer would only have to build the implementation of whatever logic should be provided by the tool; everything else - parsing arguments, calling the tool's implementation, printing help - should happen automatically.
-
-This is roughly what sinmple-sql provides. 
-
-## On versions
-
-`simple-cli` is still on a 0.x.x version, and, generally, a 0.x.y version is not compatible with a 0.x+1.y version.
-
-These are the follow
-
-- The 0.2.x versions are tracked in the [`stable`](https://github.com/radiospiel/simple-cli/tree/stable) branch
-- The 0.3.x versions are tracked in the [`master`](https://github.com/radiospiel/simple-cli/tree/stable) branch
-
-## Basic features
-
-- build command line features in a number of modules;
-- public methods in these modules provide a subcommand for the CLI;
-- `"_"` in the method name are being mapped to `":"` in the CLI;
-- CLI provides a help subcommand. help texts are derived from the methods over a subcommand implementation:
-  - The first line determines the "short help" message, to be included in the `$CMD help` command list;
-  - The remaining lines determines the full help message, to be included in the `$CMD help subcommand` message.
-  
-## Example
-

data/doc/examples/ex1/ex1

@@ -1,2 +0,0 @@
-#!/bin/sh
-exec $0.rb "$@"

data/doc/examples/ex1/ex1.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/env ruby
-require 'bundler/inline'
-
-gemfile do
-  source 'https://rubygems.org'
-  gem "simple-cli", '~> 0.2', path: "../../.."
-end
-
-module Ex1; end
-module Ex1::CLI
-  include Simple::CLI
-
-  # Command without arguments
-  #
-  # Example:
-  #
-  #    ./ex1 hello:world
-  #
-  def hello_world
-    puts "Hello from #{__FILE__}"
-  end
-
-  # Command with arguments
-  #
-  # This implements a command with arguments
-  #
-  # Examples:
-  #
-  #    ./ex1 hello --name=user "what's up"
-  # 
-  def hello(message, name: nil)
-    if name
-      puts "Hello #{name}: #{message}!"
-    else
-      puts "Hello, #{message}!"
-    end
-  end
-end
-
-Ex1::CLI.run!(*ARGV)

data/lib/simple/cli/runner/autocompletion.rb

@@ -1,91 +0,0 @@
-module Simple::CLI::Runner::Autocompletion
-  CommandHelp = Simple::CLI::Runner::CommandHelp
-
-  def autocomplete(subcommand = nil, cur = nil)
-    puts completions(subcommand, cur).join("\n")
-  end
-
-  def completions(subcommand = nil, cur = nil)
-    if !cur
-      autocomplete_subcommands(subcommand)
-    else
-      autocomplete_subcommand_options(subcommand, cur)
-    end
-  end
-
-  def filter_completions(completions, prefix:)
-    completions.select do |completion|
-      !prefix || completion.start_with?(prefix)
-    end
-  end
-
-  def autocomplete_subcommands(cur)
-    commands = self.commands.map { |cmd| cmd.to_s.tr("_", ":") }
-    commands << "help"
-    completions = filter_completions commands, prefix: cur
-    if completions == [cur]
-      autocomplete_subcommand_options(cur, nil)
-    else
-      completions
-    end
-  end
-
-  DEFAULT_OPTIONS = %w(--verbose -v --quiet -q)
-
-  def autocomplete_subcommand_options(subcommand, cur)
-    if subcommand == "help"
-      completions = commands.map(&:to_s).map { |s| s.tr("_", ":") } + ["autocomplete"]
-      filter_completions completions, prefix: cur
-    elsif cur && cur[0, 1] == "-"
-      completions = CommandHelp.option_names(@app, string_to_command(subcommand))
-      completions += DEFAULT_OPTIONS
-
-      filter_completions completions, prefix: cur
-    else
-      Dir.glob "#{cur}*"
-    end
-  end
-
-  def autocomplete_help
-    STDERR.puts <<~DOC
-      #{binary_name} supports autocompletion. To enable autocompletion please run
-
-          eval "$(#{$0} autocomplete:bash)"
-    DOC
-
-    exit 1
-  end
-
-  def autocomplete_bash
-    puts AUTOCOMPLETE_SHELL_CODE.gsub(/{{BINARY}}/, binary_name)
-  end
-
-  # The shell function function is executed in the current shell environment.
-  # When it is executed,
-  #
-  # - $1 is the name of the command whose arguments are being completed,
-  # - $2 is the word being completed, and
-  # - $3 is the word preceding the word being completed
-  #
-  # When it finishes, the possible completions are retrieved from the value of the COMPREPLY array variable.
-  #
-  # see https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html
-  #
-  AUTOCOMPLETE_SHELL_CODE = <<~BASH
-    _{{BINARY}}()
-    {
-      local cmd=$1
-      local cur=$2
-
-      if [[ $COMP_CWORD == 1 ]]; then
-        COMPREPLY=( $("$cmd" autocomplete "$cur" ))
-      else
-        local subcommand=${COMP_WORDS[1]}
-        COMPREPLY=( $("$cmd" autocomplete "$subcommand" "$cur" ))
-      fi
-
-      return 0
-    }
-    complete -F _{{BINARY}} {{BINARY}}
-  BASH
-end