dry-cli 0.6.0 → 0.7.0

data/lib/dry/cli/command.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'concurrent/array'
-require 'dry/cli/option'
+require "forwardable"
+require "dry/cli/option"
 
 module Dry
   class CLI
@@ -14,25 +13,20 @@ module Dry
       # @api private
       def self.inherited(base)
         super
+        base.class_eval do
+          @_mutex       = Mutex.new
+          @description  = nil
+          @examples     = []
+          @subcommands  = []
+          @arguments = base.superclass_arguments || []
+          @options = base.superclass_options || []
+        end
         base.extend ClassMethods
       end
 
       # @since 0.1.0
       # @api private
       module ClassMethods
-        # @since 0.1.0
-        # @api private
-        def self.extended(base)
-          super
-
-          base.class_eval do
-            @description  = nil
-            @examples     = Concurrent::Array.new
-            @arguments    = Concurrent::Array.new
-            @options      = Concurrent::Array.new
-          end
-        end
-
         # @since 0.1.0
         # @api private
         attr_reader :description
@@ -48,6 +42,14 @@ module Dry
         # @since 0.1.0
         # @api private
         attr_reader :options
+
+        # @since 0.7.0
+        # @api private
+        attr_reader :subcommands
+
+        # @since 0.7.0
+        # @api private
+        attr_writer :subcommands
       end
 
       # Set the description of the command
@@ -103,7 +105,7 @@ module Dry
       #   #     foo server --port=2306         # Bind to a port
       #   #     foo server --no-code-reloading # Disable code reloading
       def self.example(*examples)
-        @examples += examples.flatten
+        @examples += examples.flatten(1)
       end
 
       # Specify an argument
@@ -242,7 +244,7 @@ module Dry
       #   # starting console (engine: pry)
       #
       #   # $ foo console --engine=foo
-      #   # Error: Invalid param provided
+      #   # ERROR: Invalid param provided
       #
       # @example Description
       #   require "dry/cli"
@@ -317,7 +319,9 @@ module Dry
       # @since 0.1.0
       # @api private
       def self.params
-        (@arguments + @options).uniq
+        @_mutex.synchronize do
+          (@arguments + @options).uniq
+        end
       end
 
       # @since 0.1.0
@@ -340,6 +344,32 @@ module Dry
         arguments.reject(&:required?)
       end
 
+      # @since 0.7.0
+      # @api private
+      def self.subcommands
+        subcommands
+      end
+
+      # @since 0.7.0
+      # @api private
+      def self.superclass_variable_dup(var)
+        if superclass.instance_variable_defined?(var)
+          superclass.instance_variable_get(var).dup
+        end
+      end
+
+      # @since 0.7.0
+      # @api private
+      def self.superclass_arguments
+        superclass_variable_dup(:@arguments)
+      end
+
+      # @since 0.7.0
+      # @api private
+      def self.superclass_options
+        superclass_variable_dup(:@options)
+      end
+
       extend Forwardable
 
       delegate %i[
@@ -351,7 +381,8 @@ module Dry
         default_params
         required_arguments
         optional_arguments
-      ] => 'self.class'
+        subcommands
+      ] => "self.class"
     end
   end
 end

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