dry-cli 0.6.0 → 1.0.0

data/lib/dry/cli/command_registry.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'concurrent/hash'
+require "set"
 
 module Dry
   class CLI
@@ -13,52 +12,65 @@ module Dry
       # @since 0.1.0
       # @api private
       def initialize
+        @_mutex = Mutex.new
         @root = Node.new
       end
 
       # @since 0.1.0
       # @api private
       def set(name, command, aliases)
-        node = @root
-        name.split(/[[:space:]]/).each do |token|
-          node = node.put(node, token)
-        end
+        @_mutex.synchronize do
+          node = @root
+          name.split(/[[:space:]]/).each do |token|
+            node = node.put(node, token)
+          end
 
-        node.aliases!(aliases)
-        node.leaf!(command) if command
+          node.aliases!(aliases)
+          if command
+            node.leaf!(command)
+            node.subcommands!(command)
+          end
 
-        nil
+          nil
+        end
       end
 
       # @since 0.1.0
       # @api private
       #
       def get(arguments)
-        node   = @root
-        args   = []
-        names  = []
-        result = LookupResult.new(node, args, names, node.leaf?)
-
-        arguments.each_with_index do |token, i|
-          tmp = node.lookup(token)
-
-          if tmp.nil?
-            result = LookupResult.new(node, args, names, false)
-            break
-          elsif tmp.leaf?
-            args   = arguments[i + 1..-1]
-            names  = arguments[0..i]
-            node   = tmp
-            result = LookupResult.new(node, args, names, true)
-            break
-          else
-            names  = arguments[0..i]
-            node   = tmp
-            result = LookupResult.new(node, args, names, node.leaf?)
+        @_mutex.synchronize do
+          node   = @root
+          args   = []
+          names  = []
+          valid_leaf = nil
+          result = LookupResult.new(node, args, names, node.leaf?)
+
+          arguments.each_with_index do |token, i|
+            tmp = node.lookup(token)
+
+            if tmp.nil? && valid_leaf
+              result = valid_leaf
+              break
+            elsif tmp.nil?
+              result = LookupResult.new(node, args, names, false)
+              break
+            elsif tmp.leaf?
+              args   = arguments[i + 1..-1]
+              names  = arguments[0..i]
+              node   = tmp
+              result = LookupResult.new(node, args, names, true)
+              valid_leaf = result
+              break unless tmp.children?
+            else
+              names  = arguments[0..i]
+              node   = tmp
+              result = LookupResult.new(node, args, names, node.leaf?)
+            end
           end
-        end
 
-        result
+          result
+        end
       end
 
       # Node of the registry
@@ -94,8 +106,8 @@ module Dry
         # @api private
         def initialize(parent = nil)
           @parent   = parent
-          @children = Concurrent::Hash.new
-          @aliases  = Concurrent::Hash.new
+          @children = {}
+          @aliases  = {}
           @command  = nil
 
           @before_callbacks = Chain.new
@@ -120,6 +132,13 @@ module Dry
           @command = command
         end
 
+        # @since 0.7.0
+        # @api private
+        def subcommands!(command)
+          command_class = command.is_a?(Class) ? command : command.class
+          command_class.subcommands = children
+        end
+
         # @since 0.1.0
         # @api private
         def alias!(key, child)
@@ -139,6 +158,12 @@ module Dry
         def leaf?
           !command.nil?
         end
+
+        # @since 0.7.0
+        # @api private
+        def children?
+          children.any?
+        end
       end
 
       # Result of a registry lookup

data/lib/dry/cli/inflector.rb

@@ -10,7 +10,7 @@ module Dry
       def self.dasherize(input)
         return nil unless input
 
-        input.to_s.downcase.gsub(/[[[:space:]]_]/, '-')
+        input.to_s.downcase.gsub(/[[[:space:]]_]/, "-")
       end
     end
   end

data/lib/dry/cli/inline.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'backports/2.5.0/module/define_method' if RUBY_VERSION < '2.5'
+require "backports/2.5.0/module/define_method" if RUBY_VERSION < "2.5"
 
 module Dry
   class CLI
-    require 'dry/cli'
+    require "dry/cli"
     # Inline Syntax (aka DSL) to implement one-file applications
     #
     # `dry/cli/inline` is not required by default
@@ -62,8 +62,8 @@ module Dry
       # @since 0.6.0
       def run(arguments: ARGV, out: $stdout)
         command = AnonymousCommand
-        command.define_method(:call) do |*args|
-          yield(*args)
+        command.define_method(:call) do |**args|
+          yield(**args)
         end
 
         Dry.CLI(command).call(arguments: arguments, out: out)

data/lib/dry/cli/option.rb

@@ -32,7 +32,7 @@ module Dry
       # @api private
       def desc
         desc = options[:desc]
-        values ? "#{desc}: (#{values.join('/')})" : desc
+        values ? "#{desc}: (#{values.join("/")})" : desc
       end
 
       # @since 0.1.0
@@ -108,7 +108,7 @@ module Dry
       # @api private
       def alias_names
         aliases
-          .map { |name| name.gsub(/^-{1,2}/, '') }
+          .map { |name| name.gsub(/^-{1,2}/, "") }
           .compact
           .uniq
           .map { |name| name.size == 1 ? "-#{name}" : "--#{name}" }

data/lib/dry/cli/parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require 'dry/cli/program_name'
+require "optparse"
+require "dry/cli/program_name"
 
 module Dry
   class CLI
@@ -13,7 +13,7 @@ module Dry
       # @since 0.1.0
       # @api private
       #
-      def self.call(command, arguments, names)
+      def self.call(command, arguments, prog_name)
         original_arguments = arguments.dup
         parsed_options = {}
 
@@ -24,28 +24,22 @@ module Dry
             end
           end
 
-          opts.on_tail('-h', '--help') do
+          opts.on_tail("-h", "--help") do
             return Result.help
           end
         end.parse!(arguments)
 
         parsed_options = command.default_params.merge(parsed_options)
-        parse_required_params(command, arguments, names, parsed_options)
+        parse_required_params(command, arguments, prog_name, parsed_options)
       rescue ::OptionParser::ParseError
-        Result.failure("Error: \"#{names.last}\" was called with arguments \"#{original_arguments.join(' ')}\"") # rubocop:disable Metrics/LineLength
-      end
-
-      # @since 0.1.0
-      # @api private
-      def self.full_command_name(names)
-        ProgramName.call(names)
+        Result.failure("ERROR: \"#{prog_name}\" was called with arguments \"#{original_arguments.join(" ")}\"") # rubocop:disable Metrics/LineLength
       end
 
       # @since 0.1.0
       # @api private
       #
       # rubocop:disable Metrics/AbcSize
-      def self.parse_required_params(command, arguments, names, parsed_options)
+      def self.parse_required_params(command, arguments, prog_name, parsed_options)
         parsed_params          = match_arguments(command.arguments, arguments)
         parsed_required_params = match_arguments(command.required_arguments, arguments)
         all_required_params_satisfied = command.required_arguments.all? { |param| !parsed_required_params[param.name].nil? } # rubocop:disable Metrics/LineLength
@@ -55,12 +49,16 @@ module Dry
         unless all_required_params_satisfied
           parsed_required_params_values = parsed_required_params.values.compact
 
-          usage = "\nUsage: \"#{full_command_name(names)} #{command.required_arguments.map(&:description_name).join(' ')}\"" # rubocop:disable Metrics/LineLength
+          usage = "\nUsage: \"#{prog_name} #{command.required_arguments.map(&:description_name).join(" ")}" # rubocop:disable Metrics/LineLength
+
+          usage += " | #{prog_name} SUBCOMMAND" if command.subcommands.any?
+
+          usage += '"'
 
-          if parsed_required_params_values.empty? # rubocop:disable Style/GuardClause
-            return Result.failure("ERROR: \"#{full_command_name(names)}\" was called with no arguments#{usage}") # rubocop:disable Metrics/LineLength
+          if parsed_required_params_values.empty?
+            return Result.failure("ERROR: \"#{prog_name}\" was called with no arguments#{usage}")
           else
-            return Result.failure("ERROR: \"#{full_command_name(names)}\" was called with arguments #{parsed_required_params_values}#{usage}") # rubocop:disable Metrics/LineLength
+            return Result.failure("ERROR: \"#{prog_name}\" was called with arguments #{parsed_required_params_values}#{usage}") # rubocop:disable Metrics/LineLength
           end
         end
 
@@ -103,7 +101,7 @@ module Dry
 
         # @since 0.1.0
         # @api private
-        def self.failure(error = 'Error: Invalid param provided')
+        def self.failure(error = "Error: Invalid param provided")
           new(error: error)
         end
 

data/lib/dry/cli/program_name.rb

@@ -9,7 +9,7 @@ module Dry
     module ProgramName
       # @since 0.1.0
       # @api private
-      SEPARATOR = ' '
+      SEPARATOR = " "
 
       # @since 0.1.0
       # @api private

data/lib/dry/cli/registry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/cli/command_registry'
+require "dry/cli/command_registry"
 
 module Dry
   class CLI
@@ -12,6 +12,7 @@ module Dry
       # @api private
       def self.extended(base)
         base.class_eval do
+          @_mutex = Mutex.new
           @commands = CommandRegistry.new
         end
       end
@@ -75,6 +76,8 @@ module Dry
       #     end
       #   end
       def register(name, command = nil, aliases: [], &block)
+        @commands.set(name, command, aliases)
+
         if block_given?
           prefix = Prefix.new(@commands, name, aliases)
           if block.arity.zero?
@@ -82,8 +85,6 @@ module Dry
           else
             yield(prefix)
           end
-        else
-          @commands.set(name, command, aliases)
         end
       end
 
@@ -170,7 +171,9 @@ module Dry
       #     end
       #   end
       def before(command_name, callback = nil, &blk)
-        command(command_name).before_callbacks.append(&_callback(callback, blk))
+        @_mutex.synchronize do
+          command(command_name).before_callbacks.append(&_callback(callback, blk))
+        end
       end
 
       # Register an after callback.
@@ -256,7 +259,9 @@ module Dry
       #     end
       #   end
       def after(command_name, callback = nil, &blk)
-        command(command_name).after_callbacks.append(&_callback(callback, blk))
+        @_mutex.synchronize do
+          command(command_name).after_callbacks.append(&_callback(callback, blk))
+        end
       end
 
       # @since 0.1.0
@@ -267,7 +272,7 @@ module Dry
 
       private
 
-      COMMAND_NAME_SEPARATOR = ' '
+      COMMAND_NAME_SEPARATOR = " "
 
       # @since 0.2.0
       # @api private

data/lib/dry/cli/usage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/cli/program_name'
+require "dry/cli/program_name"
 
 module Dry
   class CLI
@@ -11,12 +11,13 @@ module Dry
     module Usage
       # @since 0.1.0
       # @api private
-      SUBCOMMAND_BANNER = ' [SUBCOMMAND]'
+      SUBCOMMAND_BANNER = " [SUBCOMMAND]"
+      ROOT_COMMAND_WITH_SUBCOMMANDS_BANNER = " [ARGUMENT|SUBCOMMAND]"
 
       # @since 0.1.0
       # @api private
       def self.call(result)
-        header = 'Commands:'
+        header = "Commands:"
         max_length, commands = commands_and_arguments(result)
 
         commands.map do |banner, node|
@@ -30,7 +31,9 @@ module Dry
       def self.commands_and_arguments(result)
         max_length = 0
         ret        = commands(result).each_with_object({}) do |(name, node), memo|
-          args = if node.leaf?
+          args = if node.command && node.leaf? && node.children?
+                   ROOT_COMMAND_WITH_SUBCOMMANDS_BANNER
+                 elsif node.leaf?
                    arguments(node.command)
                  else
                    SUBCOMMAND_BANNER
@@ -52,11 +55,11 @@ module Dry
         required_arguments = command.required_arguments
         optional_arguments = command.optional_arguments
 
-        required = required_arguments.map { |arg| arg.name.upcase }.join(' ') if required_arguments.any? # rubocop:disable Metrics/LineLength
-        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(' ') if optional_arguments.any? # rubocop:disable Metrics/LineLength
+        required = required_arguments.map { |arg| arg.name.upcase }.join(" ") if required_arguments.any? # rubocop:disable Metrics/LineLength
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any? # rubocop:disable Metrics/LineLength
         result = [required, optional].compact
 
-        " #{result.join(' ')}" unless result.empty?
+        " #{result.join(" ")}" unless result.empty?
       end
 
       # @since 0.1.0
@@ -70,7 +73,7 @@ module Dry
       # @since 0.1.0
       # @api private
       def self.justify(string, padding, usage)
-        return string.chomp(' ') if usage.nil?
+        return string.chomp(" ") if usage.nil?
 
         string.ljust(padding + padding / 2)
       end

data/lib/dry/cli/version.rb

@@ -3,6 +3,6 @@
 module Dry
   class CLI
     # @since 0.1.0
-    VERSION = '0.6.0'
+    VERSION = "1.0.0"
   end
 end

data/lib/dry/cli.rb

@@ -8,14 +8,14 @@ module Dry
   #
   # @since 0.1.0
   class CLI
-    require 'dry/cli/version'
-    require 'dry/cli/errors'
-    require 'dry/cli/command'
-    require 'dry/cli/registry'
-    require 'dry/cli/parser'
-    require 'dry/cli/usage'
-    require 'dry/cli/banner'
-    require 'dry/cli/inflector'
+    require "dry/cli/version"
+    require "dry/cli/errors"
+    require "dry/cli/command"
+    require "dry/cli/registry"
+    require "dry/cli/parser"
+    require "dry/cli/usage"
+    require "dry/cli/banner"
+    require "dry/cli/inflector"
 
     # Check if command
     #
@@ -62,9 +62,11 @@ module Dry
     # @since 0.1.0
     def call(arguments: ARGV, out: $stdout, err: $stderr)
       @out, @err = out, err
-      return perform_command(arguments) if kommand
-
-      perform_registry(arguments)
+      kommand ? perform_command(arguments) : perform_registry(arguments)
+    rescue SignalException => e
+      signal_exception(e)
+    rescue Errno::EPIPE
+      # no op
     end
 
     private
@@ -106,16 +108,13 @@ module Dry
     # @api private
     def perform_registry(arguments)
       result = registry.get(arguments)
+      return usage(result) unless result.found?
 
-      if result.found?
-        command, args = parse(result.command, result.arguments, result.names)
+      command, args = parse(result.command, result.arguments, result.names)
 
-        result.before_callbacks.run(command, args)
-        command.call(**args)
-        result.after_callbacks.run(command, args)
-      else
-        usage(result)
-      end
+      result.before_callbacks.run(command, args)
+      command.call(**args)
+      result.after_callbacks.run(command, args)
     end
 
     # Parse arguments for a command.
@@ -131,26 +130,37 @@ module Dry
     # @since 0.6.0
     # @api private
     def parse(command, arguments, names)
-      result = Parser.call(command, arguments, names)
+      prog_name = ProgramName.call(names)
 
-      if result.help?
-        out.puts Banner.call(command, names)
-        exit(0)
-      end
+      result = Parser.call(command, arguments, prog_name)
 
-      if result.error?
-        err.puts(result.error)
-        exit(1)
-      end
+      return help(command, prog_name) if result.help?
+
+      return error(result) if result.error?
 
-      [command.new, result.arguments]
+      [build_command(command), result.arguments]
+    end
+
+    # @since 0.6.0
+    # @api private
+    def build_command(command)
+      command.is_a?(Class) ? command.new : command
+    end
+
+    # @since 0.6.0
+    # @api private
+    def help(command, prog_name)
+      out.puts Banner.call(command, prog_name)
+      exit(0) # Successful exit
+    end
+
+    # @since 0.6.0
+    # @api private
+    def error(result)
+      err.puts(result.error)
+      exit(1)
     end
 
-    # Prints the command usage and exit.
-    #
-    # @param result [Dry::CLI::CommandRegistry::LookupResult]
-    # @param out [IO] sta output
-    #
     # @since 0.1.0
     # @api private
     def usage(result)
@@ -158,6 +168,15 @@ module Dry
       exit(1)
     end
 
+    # Handles Exit codes for signals
+    # Fatal error signal "n". Say 130 = 128 + 2 (SIGINT) or 137 = 128 + 9 (SIGKILL)
+    #
+    # @since 0.7.0
+    # @api private
+    def signal_exception(exception)
+      exit(128 + exception.signo)
+    end
+
     # Check if command
     #
     # @param command [Object] the command to check

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dry-cli
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -109,14 +109,13 @@ files:
 - lib/dry/cli/program_name.rb
 - lib/dry/cli/registry.rb
 - lib/dry/cli/usage.rb
-- lib/dry/cli/utils/files.rb
 - lib/dry/cli/version.rb
 homepage: https://dry-rb.org/gems/dry-cli
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/dry-rb/dry-cli/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/dry-rb/dry-cli/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-cli
   bug_tracker_uri: https://github.com/dry-rb/dry-cli/issues
 post_install_message: 
@@ -127,14 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Common framework to build command line interfaces with Ruby