simple-cli 0.2.20 → 0.2.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d26ea250d929404c83f6c19ea9c0a188f53f18b67184305cdf21bb543ae68d6
-  data.tar.gz: 288e4524b2cef953b78be71745f9f41f3b1def3091f6780e6f137e4e7f4e855e
+  metadata.gz: ba16419e4dc2f0fe2dc47fe0a5cb29a6de15a57d2b221ef3aa8c3ed7455c0556
+  data.tar.gz: 6293877fe62faaaf2718745c94ebb1ea798e1500330f75095c0363f151047fe4
 SHA512:
-  metadata.gz: 44e5a83ad0ee46147c0c5c36cb68a424f5b132a215c1e3bc0f59198e2fd38edad1a6a67aed8a7d47a95951dcd59aef0636688257c3d9a0cef5a38c74c45ac6ce
-  data.tar.gz: 4d735d8b7b4a38c95c0ee923ab6695cff2b45ef641a28dd130598a78983785bd551f785d2d92d2f757ee8a927096b7e4d219b565e14099cbd3f82391f49bd144
+  metadata.gz: 1dc54fc73aa56d28485023047df277663cdf0b0edeaacde994c772fd908934e7994bf84d4f9e216cc55573df2b3ad128d800ab217f268dfdbee731fd48e0db93
+  data.tar.gz: b9ee91e8c0aae8d0586b90dcbebe7476d9c34338ecc45bbdd08a685548f539c519db6412e99de13a65acac5538d0c151fe2dd76b9c3966126d1c91b910ada533

data/.ruby-version

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

data/README.md

@@ -0,0 +1,32 @@
+# 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

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

data/doc/examples/ex1/ex1.rb

@@ -0,0 +1,40 @@
+#!/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/helpers.rb

@@ -18,14 +18,17 @@ module Simple::CLI::Helpers
     ::Simple::CLI.logger
   end
 
-  def confirm(msg)
+  def confirm!(msg)
     STDERR.puts <<~MSG
-      #{msg}
+      #{msg.chomp}
 
       Press return to continue, ^C to cancel...
     MSG
 
     STDIN.gets
+  rescue Interrupt
+    logger.error "Cancelled by user"
+    exit 1
   end
 
   SSH = "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"

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

@@ -118,10 +118,25 @@ module Simple::CLI::Logger::ColoredLogger
     STDERR.puts msg
   end
 
-  # The heuristic used to determine the caller is not perfect, but should
-  # do well in most cases.
+  # [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.
   def source_from_caller
-    source = caller.find { |loc| loc !~ /simple-cli.*\/lib\/simple\/cli/ }
+    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[2]
     source = source[(wd.length + 1)..-1] if source.start_with?(wd)
     source

data/lib/simple/cli/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simple-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.20
+  version: 0.2.28
 platform: ruby
 authors:
 - radiospiel
 - mediapeers GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,9 +75,13 @@ 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
@@ -99,7 +103,7 @@ files:
 homepage: http://github.com/radiospiel/simple-cli
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Simple CLI builder for ruby
 test_files: