simple-cli 0.3.8 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe90f1db0d7da40f484573c95ee3b534dcd2e60b1ffe33e12beef901f134a7c
-  data.tar.gz: 6f4d4c221df0642d2e9873770c75520ce2a629f41b2d64fb225c75f07f17948d
+  metadata.gz: 156fbfd11f78c47d66f43a6c6158377ec51f5f20061e16fa5c5b853a1d622fcc
+  data.tar.gz: aa0e7b9585e559377362197e6a094f8023a0e8293d6974d175f335bd99ed75ed
 SHA512:
-  metadata.gz: 8cf8cf8ab7e644dd633d60f0fb9bfd418453340f210a8b49ebd2713af589e472e052d39779f43e0adba3e11c4c7f2d311b6669acb3ed94fbe3a96f48bb5b093d
-  data.tar.gz: 1b0183a301605c9996efba79a8c2fb8f5fe2aacd241d074b97b5d5c9f367f0c45dc6566ba13f79b806f43c670f60471cb6b1d4264b6d444d76e311060d8afc0d
+  metadata.gz: fdb819a5b2fd0cebc5f3359ddbd18992b690779eee27fe673018c659372f232c8b70839f6dbdb33f71901bf9242da3a70e3792234df5e6d5e2aaab2d64949dd9
+  data.tar.gz: 1c81fd6b778df6e551a055074b7cb3c38cfb120d27f9f4e25cf74e17d6d33036f1663a0b8d611407efd719ab10c45730061bbab813a09a045c86ca078f7a38de

data/.ruby-version

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

data/Gemfile

@@ -3,4 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in {gemname}.gemspec
 gemspec
 
-# gem "simple-service", path: "../simple-service"
+# development gems
+gem 'rake', '~> 12'
+gem 'rspec', '~> 3.7'
+gem 'simplecov', '~> 0'
+gem 'rubocop', '= 0.52.1'

data/README.md

@@ -0,0 +1,51 @@
+# 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
+
+An example can be found in [./doc/examples/ex1](./doc/examples/ex1)
+
+## Use logging
+
+`Simple::CLI` provides a logger instance. This is configured to write to STDERR, and to use colors for different log levels. By default the logger is configured to run on INFO log levels. With the `--quiet` flag the logger is running at WARN log level; the `--verbose` command line flag runs the logger on DEBUG log level, and also includes the source position of calling log.
+
+## Updating to version 0.3
+
+While the 0.2 version is still perfectly functional, its last version was released on Jul 5th, 2019. Development on the 0.3 versions started with some refactoring: the logic that inspects a subcommand invocation and determines its argument names and default types has been moved to a `simple-services' gem.
+
+To upgrade from simple-cli version 0.2 to version 0.3 all you typically have to do is to replace the
+
+    YourApp::CLI.run!(*ARGV)
+
+invocation with
+
+    Simple::CLI.run!(YourApp::CLI)
+
+This [commit](https://github.com/radiospiel/simple-cli/commit/3e75bd6fb913a2b458269c91597c42cabac226b4) provides an example of doing that.

data/VERSION

@@ -1 +1 @@
-0.3.8
+0.3.12

data/doc/examples/ex1/ex1

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

data/doc/examples/ex1/ex1.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem "simple-cli", '~> 0.3', 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
+
+$0 = "ex1"
+Simple::CLI.run!(Ex1::CLI)

data/lib/simple/cli/helper/help.rb

@@ -2,13 +2,13 @@ module Simple::CLI
   module Helper
     def help!(service, verbose:)
       STDERR.puts <<~MSG
-        #{H.binary_name} <command> [ options... ]
+        #{H.binary_name} <subcommand> [ options... ]
 
-        Commands:
+        Subcommands:
 
         #{format_usages usages(service, verbose: verbose), prefix: "    "}
 
-        Default options and commands include:
+        Default options and subcommands include:
 
         #{format_usages default_usages(service, verbose: verbose), prefix: "    "}
 

data/lib/simple/cli/helper/help_on_command.rb

@@ -36,7 +36,7 @@ module Simple::CLI
 
       options = action.parameters.select(&:keyword?).map do |param|
         if param.required?
-          "--#{name}=<#{name}>"
+          "--#{param.name}=<#{param.name}>"
         else
           case param.default_value
           when false  then  "[ --#{param.name} ]"

data/lib/simple/cli/helper/short_help.rb

@@ -8,16 +8,32 @@ module Simple::CLI
       actions, hidden_actions = actions.partition(&:short_description)
 
       STDERR.puts <<~MSG
-        #{H.binary_name} <command> [ options... ]
+        #{H.binary_name} <subcommand> [ options... ]
 
       MSG
 
-      subcommands = actions.map { |action| "'" + H.action_to_command(action.name) + "'" }
-      msg = "Subcommands include #{subcommands.sort.join(", ")}"
-      msg += " (and an additional #{hidden_actions.count} internal commands)"
+      # if we don't have too many subcommands we print them here. If not, we only print their names
+      # and mention the help command.
+      if actions.count < 8
+        STDERR.puts <<~MSG
+          Subcommands:
+
+          #{format_usages usages(service, verbose: false), prefix: "    "}
+
+        MSG
+      else
+        subcommands = actions.map { |action| "'" + H.action_to_command(action.name) + "'" }
+        msg = "Subcommands include #{subcommands.sort.join(", ")}"
+        msg += " (and, in addition, #{hidden_actions.count} internal commands)" if hidden_actions.count > 0
+
+        STDERR.puts <<~MSG
+          #{msg}. Run with "-h" for more details.
+
+        MSG
+      end
 
       STDERR.puts <<~MSG
-        #{msg}. Default options and commands include:
+        Default options and subcommands include:
 
         #{format_usages default_usages(service, verbose: false), prefix: "    "}
 

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

@@ -152,10 +152,25 @@ module Simple::CLI::Logger::ColoredLogger
     Pathname.new(absolute_path).relative_path_from(@pwd_pathname).to_s
   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/simple-cli.gemspec

@@ -28,10 +28,4 @@ Gem::Specification.new do |gem|
 
   # optional gems (required by some of the parts)
   gem.add_dependency "simple-service", "~> 0.1.5"
-
-  # development gems
-  gem.add_development_dependency 'rake', '~> 12'
-  gem.add_development_dependency 'rspec', '~> 3.7'
-  gem.add_development_dependency 'simplecov', '~> 0'
-  gem.add_development_dependency 'rubocop', '= 0.52.1'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simple-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.12
 platform: ruby
 authors:
 - radiospiel
 - mediapeers GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-25 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-service
@@ -25,62 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.5
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.52.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.52.1
 description: Simple CLI builder
 email: eno@radiospiel.org
 executables: []
@@ -89,10 +33,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
+- README.md
 - Rakefile
 - VERSION
 - bin/rake
+- doc/examples/ex1/ex1
+- doc/examples/ex1/ex1.rb
 - lib/simple-cli.rb
 - lib/simple/cli.rb
 - lib/simple/cli/adapter.rb
@@ -118,7 +66,7 @@ files:
 homepage: http://github.com/radiospiel/simple-cli
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +81,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: