simple-cli 0.3.11 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc691567bf3582bb69161dbb06a43e0de48ef933d21d7b56023799faf4b29396
-  data.tar.gz: 552cc00e73471be8ada665440cc2821a75f7b71897dfc1cde47d216aa7561ce2
+  metadata.gz: dcf0aaedcec401d2a1d7b28d2463aa6b331626c3d75b22b9d8e2c9251c489370
+  data.tar.gz: 7c45a6520ea7d7f8812e4f66a6acd2c57c107866527b578c279a06fb58ce0ed7
 SHA512:
-  metadata.gz: 5203645bb10980c42223ed37ea70825d06224f95a4dd5372e145eca00d6a89bbf1548d403c10e0e02b5c60661cbe8cf5a65325deacb62558241d78e27e3564bb
-  data.tar.gz: c794abd7680ae85694104792c2a96d940483263f170b3706b0136a8795edb7ad49199e8ed67ea12dad39405a8df6df97ddb719e20f83a8158e88feb508bde3bc
+  metadata.gz: 65eb1d3681b02768d7f0b24805dd8f7c730cdb9cafefb9154b4990607b6d0760d671995fbedb27f36c411b7202a373036e6b09df55bbe6ff293757c1a98a1edf
+  data.tar.gz: d67979bd430b4b2d7854e789029ef14dcc42138195d9b1520904a1ddf92bf2bfc1c21feec2bbbca3517ff6122f1a7cab98ea871a4e36d3d61d93ec3478ebf849

data/.ruby-version

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

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.11
+0.4.0

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/deprecations.rb

@@ -0,0 +1,19 @@
+module ::Simple::CLI::Deprecations
+  SELF = self
+
+  def logger
+    SELF.deprecated! "Simple::CLI#logger", alternative: "Simple::CLI.logger"
+  end
+
+  def run!(*_)
+    SELF.deprecated! "Simple::CLI#run!", alternative: "Simple::CLI.run!(Your::CLI)"
+  end
+
+  def self.deprecated!(what, alternative: nil)
+    Simple::CLI.logger.error "'#{what}' was removed."
+    if alternative
+      Simple::CLI.logger.info "You probably want to use '#{alternative}' instead."
+    end
+    exit 1
+  end  
+end

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/lib/simple/cli/runner.rb

@@ -10,10 +10,8 @@ module Simple::CLI
       _ = verbose
 
       action_name = H.command_to_action(command)
-      Simple::Service.with_context do
-        flags = extract_flags!(args)
-        ::Simple::Service.invoke(service, action_name, args: args, flags: flags)
-      end
+      flags = extract_flags!(args)
+      ::Simple::Service.invoke(service, action_name, args: args, flags: flags)
     end
 
     private

data/lib/simple/cli.rb

@@ -13,6 +13,7 @@ require_relative "cli/adapter"
 require_relative "cli/logger"
 require_relative "cli/on_exception"
 require_relative "cli/helpers"
+require_relative "cli/deprecations"
 
 require "simple/service"
 
@@ -29,6 +30,11 @@ module Simple::CLI
   def self.included(base)
     base.include(::Simple::Service)
     base.include(::Simple::CLI::Helpers)
+    
+    # When going from 0.2 to 0.3 we removed some helpers that originally had been
+    # mixed into the target CLI module. The ::Simple::CLI::Deprecations module
+    # makes sure to print deprecation warnings.
+    base.extend(::Simple::CLI::Deprecations)
   end
 
   # Runs the service with the current command line arguments.
@@ -81,6 +87,7 @@ module Simple::CLI
     # Run service.
     Runner.run! service, options.command, *args, verbose: options.verbose?
   rescue ::Simple::Service::ArgumentError
+    STDERR.puts "#{$!}\n\n"
     Helper.help_on_command! service, options.command, verbose: false
   rescue StandardError => e
     on_exception(e)

data/simple-cli.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '~> 2.3'
 
   # optional gems (required by some of the parts)
-  gem.add_dependency "simple-service", "~> 0.1.5"
+  gem.add_dependency "simple-service", "~> 0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.0
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-service
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.1
 description: Simple CLI builder
 email: eno@radiospiel.org
 executables: []
@@ -33,14 +33,19 @@ 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
 - lib/simple/cli/default_options.rb
+- lib/simple/cli/deprecations.rb
 - lib/simple/cli/helper.rb
 - lib/simple/cli/helper/help.rb
 - lib/simple/cli/helper/help_on_command.rb
@@ -77,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Simple CLI builder for ruby