simple-cli 0.2.18 → 0.2.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 878de3c5c0b5d23d08e6cfe44d511fd68b0e41493f44e056d2936e456f2d56cf
-  data.tar.gz: 69cabfc40adca2cc0a20a64dfe41f2feab5b892ad43dfe98ce84e3a60b21345d
+  metadata.gz: 7ad5562abdf4690d3ba8a6733c0669f42cdffe673c9a9833f1e4d8e43c4d048b
+  data.tar.gz: 1ab4c259ffb2372efd1caaf6aed9b5df6e634cfa849b7fd22d071c00e87179fc
 SHA512:
-  metadata.gz: 8ba516fa41c773609493db0b26aaca5074547e42c7b62db8aaf200165384c1134f25af92b08949dc4d945e5568b025db6ca0c25bea56b9497eaab6972e37d59d
-  data.tar.gz: 21c7e58196d8289c52119b32888bd505ceeef48b7233a8ed1b67f86963f5f2e713e3e0112b64943e2eacee425ee83f1dbedd74b3ba8c08e60681303290ebf72c
+  metadata.gz: 4d821d8d77506188106ad50627f7336569a61cd07dc60ace53697c6d7d2cd8ce6ce63a881b69454e0f791ae3c771dd91cf36a07e2e2b3b39c2e5da393f17093c
+  data.tar.gz: 7e2d94b98fa2f5e068a91869da0624891a271ea320845719b08196fd25b3f87137f6958cf3dba66fa8b24144daaff018e3c70a19d8d6144b34188bb06deffc1a

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

@@ -2,6 +2,8 @@
 # rubocop:disable Metrics/CyclomaticComplexity
 # rubocop:disable Metrics/MethodLength
 
+require_relative "./module_ex"
+
 class Simple::CLI::Runner::CommandHelp
   def self.option_names(app, subcommand)
     new(app, subcommand).option_names
@@ -9,10 +11,12 @@ class Simple::CLI::Runner::CommandHelp
     []
   end
 
-  def initialize(mod, method)
-    raise(ArgumentError, "#{method.inspect} should be a Symbol") unless method.is_a?(Symbol)
-    @mod = mod
-    @method = method
+  def initialize(mod, method_id)
+    raise(ArgumentError, "#{method_id.inspect} should be a Symbol") unless method_id.is_a?(Symbol)
+
+    @method_id            = method_id
+    @method               = mod.instance_method(@method_id)
+    @method_parameters_ex = mod.method_parameters_ex(@method_id)
   end
 
   # First line of the help as read from the method comments.
@@ -26,9 +30,7 @@ class Simple::CLI::Runner::CommandHelp
   end
 
   def option_names
-    method = @mod.instance_method(@method)
-
-    option_names = method.parameters.map do |mode, name|
+    option_names = @method_parameters_ex.map do |mode, name, _|
       case mode
       when :key     then name
       when :keyreq  then name
@@ -42,20 +44,27 @@ class Simple::CLI::Runner::CommandHelp
 
   # A help string constructed from the commands method signature.
   def interface(binary_name, command_name)
-    method = @mod.instance_method(@method)
-
-    options = []
-    args = []
+    args = @method_parameters_ex.map do |mode, name|
+      case mode
+      when :req   then "<#{name}>"
+      when :opt   then "[ <#{name}> ]"
+      when :rest  then "[ <#{name}> .. ]"
+      end
+    end.compact
 
-    method.parameters.each do |mode, name|
+    options = @method_parameters_ex.map do |mode, name, default_value|
       case mode
-      when :req     then args << "<#{name}>"
-      when :key     then options << "[ --#{name}[=<#{name}>] ]"
-      when :keyreq  then options << "--#{name}[=<#{name}>]"
-      when :opt     then args << "[ <#{name}> ]"
-      when :rest    then args << "[ <#{name}> .. ]"
+      when :key     then
+        case default_value
+        when false  then  "[ --#{name} ]"
+        when true   then  "[ --no-#{name} ]"
+        when nil    then  "[ --#{name}=<#{name}> ]"
+        else              "[ --#{name}=#{default_value} ]"
+        end
+      when :keyreq  then
+        "--#{name}=<#{name}>"
       end
-    end
+    end.compact
 
     help = "#{binary_name} #{command_to_string(command_name)}"
     help << " #{options.join(' ')}" unless options.empty?
@@ -71,7 +80,7 @@ class Simple::CLI::Runner::CommandHelp
 
   def comments
     @comments ||= begin
-      file, line = @mod.instance_method(@method).source_location
+      file, line = @method.source_location
       extract_comments(from: parsed_source(file), before_line: line)
     end
   end

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

@@ -0,0 +1,69 @@
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/AbcSize
+
+class Module
+  #
+  # returns an array with entries like the following:
+  #
+  #  [ :key, name, default_value ]
+  #  [ :keyreq, name [, nil ] ]
+  #  [ :req, name [, nil ] ]
+  #  [ :opt, name [, nil ] ]
+  #  [ :rest, name [, nil ] ]
+  #
+  def method_parameters_ex(method_id)
+    method = instance_method(method_id)
+    parameters = method.parameters
+
+    # method parameters with a :key mode are optional keyword arguments. We only
+    # support defaults for those - if there are none we abort here already.
+    keys = parameters.map { |mode, name| name if mode == :key }.compact
+    return parameters if keys.empty?
+
+    # We are now doing a fake call to the method, with a minimal viable set of
+    # arguments, to let the ruby runtime fill in default values for arguments.
+    # We do not, however, let the call complete. Instead we use a TracePoint to
+    # abort as soon as the method is called, and use the its binding to determine
+    # the default values.
+
+    fake_recipient = Object.new.extend(self)
+    fake_call_args = minimal_arguments(method)
+
+    trace_point = TracePoint.trace(:call) do |tp|
+      throw :received_fake_call, tp.binding if tp.defined_class == self && tp.method_id == method_id
+    end
+
+    bnd = catch(:received_fake_call) do
+      fake_recipient.send(method_id, *fake_call_args)
+    end
+
+    trace_point.disable
+
+    # extract default values from the received binding, and merge with the
+    # parameters array.
+    default_values = keys.each_with_object({}) do |key_parameter, hsh|
+      hsh[key_parameter] = bnd.local_variable_get(key_parameter)
+    end
+
+    parameters.map do |mode, name|
+      [mode, name, default_values[name]]
+    end
+  end
+
+  private
+
+  # returns a minimal Array of arguments, which is suitable for a call to the method
+  def minimal_arguments(method)
+    # Build an arguments array with holds all required parameters. The actual
+    # values for these arguments doesn't matter at all.
+    args = method.parameters.select { |mode, _name| mode == :req }
+
+    # Add a hash with all required keyword arguments
+    required_keyword_args = method.parameters.each_with_object({}) do |(mode, name), hsh|
+      hsh[name] = :anything if mode == :keyreq
+    end
+    args << required_keyword_args if required_keyword_args
+
+    args
+  end
+end

data/lib/simple/cli/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module CLI
-    VERSION = "0.2.18"
+    VERSION = "0.2.19"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.18
+  version: 0.2.19
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-08 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,6 +89,7 @@ files:
 - 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
 - log/.gitkeep
 - simple-cli.gemspec
@@ -113,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Simple CLI builder for ruby