dry-cli 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d37c32bb092f046364d8537259aec4a8f3e233fe57167b8d19c667f8c3421a7
-  data.tar.gz: dcab3ac00499da55cad199c0ca98854e16109f23d0d257ffa9a0c826c765e476
+  metadata.gz: 816b3ffdbf5a84ad4ce91ff6be0bba9424141a7b28b880accb087ba65b63e36d
+  data.tar.gz: 6ca3a54ff35dcb634acf68ff6472ddc8737cc15f99d6f7f860ac89e491759cd4
 SHA512:
-  metadata.gz: 1e29fb0c9aa6672108b1c4afc8629ab9274655675c95a04cf85503824c1565dcef22fe2da20f6ca8a6a65d8b4b07e626f3c793fbede40a10f7a645cfaf1f7421
-  data.tar.gz: 8d65f61919776a08c9d6519cf2e6d47c85ec5c4e723234dcee2159b5a3fa6c99d2ecb754299dcd74f9f767e3c0d9e710f099ed16b347571256af082967d8e5cb
+  metadata.gz: e1b289e4571b3b658ff402f1c8dd2fa8c7746fc3a17293f2a3316961622adc1570c76b82dfbcf4c74c6510f1994952928d64eb56e99284acfae797f6adeb8037
+  data.tar.gz: 4739d57ca298e1c85afcd5d0c499a56ca04db8e802d4c84be905a674e884599d4b2dbedca66927d9ed9a0467a5b1468c063bd57b25109c6a7e1c69068b113b59

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 1.2.0 2024-10-15
+
+
+### Added
+
+- Added `:hidden` option to register commands that should not be shown in the help output. (@benoittgt in #137)
+- Provide suggestions when there is a typo in a command name. (@benoittgt in #138)
+
+
+[Compare v1.1.0...v1.2.0](https://github.com/dry-rb/dry-cli/compare/v1.1.0...v1.2.0)
+
+## 1.1.0 2024-07-14
+
+
+### Added
+
+- Added `:flag` option type. This acts like a `:boolean` that can only be set to true, so has no `--no-` prefix to disable it. (@Billiam in #117)
+
+
+[Compare v1.0.0...v1.1.0](https://github.com/dry-rb/dry-cli/compare/v1.0.0...v1.1.0)
+
 ## 1.0.0 2022-11-05
 
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 dry-rb team
+Copyright (c) 2015-2023 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,29 +1,21 @@
 <!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-cli
 [actions]: https://github.com/dry-rb/dry-cli/actions
-[codacy]: https://www.codacy.com/gh/dry-rb/dry-cli
-[chat]: https://dry-rb.zulipchat.com
-[inchpages]: http://inch-ci.org/github/dry-rb/dry-cli
 
-# dry-cli [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
-
-[![Gem Version](https://badge.fury.io/rb/dry-cli.svg)][gem]
-[![CI Status](https://github.com/dry-rb/dry-cli/workflows/ci/badge.svg)][actions]
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/61dd5d070fc74f0cacf575b19d4930e1)][codacy]
-[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/61dd5d070fc74f0cacf575b19d4930e1)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-cli.svg?branch=main)][inchpages]
+# dry-cli [![Gem Version](https://badge.fury.io/rb/dry-cli.svg)][gem] [![CI Status](https://github.com/dry-rb/dry-cli/workflows/ci/badge.svg)][actions]
 
 ## Links
 
 * [User documentation](https://dry-rb.org/gems/dry-cli)
 * [API documentation](http://rubydoc.info/gems/dry-cli)
+* [Forum](https://discourse.dry-rb.org)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
 * MRI `>= 2.4.0`
-* jruby `>= 9.3` (postponed until 2.7 is supported)
+* jruby `>= 9.4` (not tested on CI)
 
 ## License
 

data/dry-cli.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-cli"
   spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-cli/issues"
 
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
   # to update dependencies edit project.yml
 

data/lib/dry/cli/banner.rb

@@ -86,8 +86,8 @@ 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 Layout/LineLength
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any? # rubocop:disable Layout/LineLength
         result = [required, optional].compact
 
         " #{result.join(" ")}" unless result.empty?
@@ -97,7 +97,7 @@ module Dry
       # @api private
       def self.extended_command_arguments(command)
         command.arguments.map do |argument|
-          "  #{argument.name.to_s.upcase.ljust(32)}  # #{"REQUIRED " if argument.required?}#{argument.desc}" # rubocop:disable Metrics/LineLength
+          "  #{argument.name.to_s.upcase.ljust(32)}  # #{"REQUIRED " if argument.required?}#{argument.desc}" # rubocop:disable Layout/LineLength
         end.join("\n")
       end
 
@@ -109,6 +109,8 @@ module Dry
           name = Inflector.dasherize(option.name)
           name = if option.boolean?
                    "[no-]#{name}"
+                 elsif option.flag?
+                   name
                  elsif option.array?
                    "#{name}=VALUE1,VALUE2,.."
                  else

data/lib/dry/cli/command.rb

@@ -45,11 +45,7 @@ module Dry
 
         # @since 0.7.0
         # @api private
-        attr_reader :subcommands
-
-        # @since 0.7.0
-        # @api private
-        attr_writer :subcommands
+        attr_accessor :subcommands
       end
 
       # Set the description of the command

data/lib/dry/cli/command_registry.rb

@@ -18,7 +18,7 @@ module Dry
 
       # @since 0.1.0
       # @api private
-      def set(name, command, aliases)
+      def set(name, command, aliases, hidden)
         @_mutex.synchronize do
           node = @root
           name.split(/[[:space:]]/).each do |token|
@@ -26,6 +26,7 @@ module Dry
           end
 
           node.aliases!(aliases)
+          node.hidden!(hidden)
           if command
             node.leaf!(command)
             node.subcommands!(command)
@@ -37,7 +38,7 @@ module Dry
 
       # @since 0.1.0
       # @api private
-      #
+      # rubocop:disable Metrics/AbcSize
       def get(arguments)
         @_mutex.synchronize do
           node   = @root
@@ -56,7 +57,7 @@ module Dry
               result = LookupResult.new(node, args, names, false)
               break
             elsif tmp.leaf?
-              args   = arguments[i + 1..-1]
+              args   = arguments[i + 1..]
               names  = arguments[0..i]
               node   = tmp
               result = LookupResult.new(node, args, names, true)
@@ -72,6 +73,7 @@ module Dry
           result
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Node of the registry
       #
@@ -90,6 +92,10 @@ module Dry
         # @api private
         attr_reader :aliases
 
+        # @since 1.1.1
+        # @api private
+        attr_reader :hidden
+
         # @since 0.1.0
         # @api private
         attr_reader :command
@@ -108,6 +114,7 @@ module Dry
           @parent   = parent
           @children = {}
           @aliases  = {}
+          @hidden   = hidden
           @command  = nil
 
           @before_callbacks = Chain.new
@@ -153,6 +160,12 @@ module Dry
           end
         end
 
+        # @since 1.1.1
+        # @api private
+        def hidden!(hidden)
+          @hidden = hidden
+        end
+
         # @since 0.1.0
         # @api private
         def leaf?

data/lib/dry/cli/option.rb

@@ -59,6 +59,11 @@ module Dry
         type == :boolean
       end
 
+      # @api private
+      def flag?
+        type == :flag
+      end
+
       # @since 0.3.0
       # @api private
       def array?
@@ -92,6 +97,8 @@ module Dry
 
         if boolean?
           parser_options << "--[no-]#{dasherized_name}"
+        elsif flag?
+          parser_options << "--#{dasherized_name}"
         else
           parser_options << "--#{dasherized_name}=#{name}"
           parser_options << "--#{dasherized_name} #{name}"
@@ -112,7 +119,7 @@ module Dry
           .compact
           .uniq
           .map { |name| name.size == 1 ? "-#{name}" : "--#{name}" }
-          .map { |name| boolean? ? name : "#{name} VALUE" }
+          .map { |name| boolean? || flag? ? name : "#{name} VALUE" }
       end
     end
 

data/lib/dry/cli/parser.rb

@@ -32,24 +32,24 @@ module Dry
         parsed_options = command.default_params.merge(parsed_options)
         parse_required_params(command, arguments, prog_name, parsed_options)
       rescue ::OptionParser::ParseError
-        Result.failure("ERROR: \"#{prog_name}\" was called with arguments \"#{original_arguments.join(" ")}\"") # rubocop:disable Metrics/LineLength
+        Result.failure("ERROR: \"#{prog_name}\" was called with arguments \"#{original_arguments.join(" ")}\"") # rubocop:disable Layout/LineLength
       end
 
       # @since 0.1.0
       # @api private
       #
-      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
       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
+        all_required_params_satisfied = command.required_arguments.all? { |param| !parsed_required_params[param.name].nil? } # rubocop:disable Layout/LineLength
 
         unused_arguments = arguments.drop(command.required_arguments.length)
 
         unless all_required_params_satisfied
           parsed_required_params_values = parsed_required_params.values.compact
 
-          usage = "\nUsage: \"#{prog_name} #{command.required_arguments.map(&:description_name).join(" ")}" # rubocop:disable Metrics/LineLength
+          usage = "\nUsage: \"#{prog_name} #{command.required_arguments.map(&:description_name).join(" ")}" # rubocop:disable Layout/LineLength
 
           usage += " | #{prog_name} SUBCOMMAND" if command.subcommands.any?
 
@@ -58,7 +58,7 @@ module Dry
           if parsed_required_params_values.empty?
             return Result.failure("ERROR: \"#{prog_name}\" was called with no arguments#{usage}")
           else
-            return Result.failure("ERROR: \"#{prog_name}\" 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 Layout/LineLength
           end
         end
 
@@ -67,14 +67,14 @@ module Dry
         parsed_options = parsed_options.merge(args: unused_arguments) if unused_arguments.any?
         Result.success(parsed_options)
       end
-      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
 
       def self.match_arguments(command_arguments, arguments)
         result = {}
 
         command_arguments.each_with_index do |cmd_arg, index|
           if cmd_arg.array?
-            result[cmd_arg.name] = arguments[index..-1]
+            result[cmd_arg.name] = arguments[index..]
             break
           else
             result[cmd_arg.name] = arguments.at(index)

data/lib/dry/cli/registry.rb

@@ -75,11 +75,11 @@ module Dry
       #       end
       #     end
       #   end
-      def register(name, command = nil, aliases: [], &block)
-        @commands.set(name, command, aliases)
+      def register(name, command = nil, aliases: [], hidden: false, &block)
+        @commands.set(name, command, aliases, hidden)
 
         if block_given?
-          prefix = Prefix.new(@commands, name, aliases)
+          prefix = Prefix.new(@commands, name, aliases, hidden)
           if block.arity.zero?
             prefix.instance_eval(&block)
           else
@@ -308,19 +308,19 @@ module Dry
       class Prefix
         # @since 0.1.0
         # @api private
-        def initialize(registry, prefix, aliases)
+        def initialize(registry, prefix, aliases, hidden)
           @registry = registry
           @prefix   = prefix
 
-          registry.set(prefix, nil, aliases)
+          registry.set(prefix, nil, aliases, hidden)
         end
 
         # @since 0.1.0
         #
         # @see Dry::CLI::Registry#register
-        def register(name, command, aliases: [])
+        def register(name, command, aliases: [], hidden: false)
           command_name = "#{prefix} #{name}"
-          registry.set(command_name, command, aliases)
+          registry.set(command_name, command, aliases, hidden)
         end
 
         private

data/lib/dry/cli/spell_checker.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "dry/cli/program_name"
+require "did_you_mean"
+
+module Dry
+  class CLI
+    # Command(s) usage
+    #
+    # @since 1.1.1
+    # @api private
+    module SpellChecker
+      # @since 1.1.1
+      # @api private
+      def self.call(result, arguments)
+        commands = result.children.keys
+        cmd = cmd_to_spell(arguments, result.names)
+
+        suggestions = DidYouMean::SpellChecker.new(dictionary: commands).correct(cmd.first)
+        if suggestions.any?
+          "I don't know how to '#{cmd.join(" ")}'. Did you mean: '#{suggestions.first}' ?"
+        end
+      end
+
+      # @since 1.1.1
+      # @api private
+      def self.cmd_to_spell(arguments, result_names)
+        arguments - result_names
+      end
+
+      # @since 1.1.1
+      # @api private
+      def self.ignore?(cmd)
+        cmd.empty? || cmd.first.start_with?("-")
+      end
+    end
+  end
+end

data/lib/dry/cli/usage.rb

@@ -21,9 +21,11 @@ module Dry
         max_length, commands = commands_and_arguments(result)
 
         commands.map do |banner, node|
+          next if node.hidden
+
           usage = description(node.command) if node.leaf?
           "#{justify(banner, max_length, usage)}#{usage}"
-        end.unshift(header).join("\n")
+        end.compact.unshift(header).join("\n")
       end
 
       # @since 0.1.0
@@ -55,8 +57,8 @@ 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 Layout/LineLength
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any? # rubocop:disable Layout/LineLength
         result = [required, optional].compact
 
         " #{result.join(" ")}" unless result.empty?

data/lib/dry/cli/version.rb

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

data/lib/dry/cli.rb

@@ -14,6 +14,7 @@ module Dry
     require "dry/cli/registry"
     require "dry/cli/parser"
     require "dry/cli/usage"
+    require "dry/cli/spell_checker"
     require "dry/cli/banner"
     require "dry/cli/inflector"
 
@@ -108,7 +109,7 @@ module Dry
     # @api private
     def perform_registry(arguments)
       result = registry.get(arguments)
-      return usage(result) unless result.found?
+      return spell_checker(result, arguments) unless result.found?
 
       command, args = parse(result.command, result.arguments, result.names)
 
@@ -161,9 +162,11 @@ module Dry
       exit(1)
     end
 
-    # @since 0.1.0
-    # @api private
-    def usage(result)
+    # @since 1.1.1
+    def spell_checker(result, arguments)
+      spell_checker = SpellChecker.call(result, arguments)
+      err.puts spell_checker if spell_checker
+      puts
       err.puts Usage.call(result)
       exit(1)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Luca Guidi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,7 @@ files:
 - lib/dry/cli/parser.rb
 - lib/dry/cli/program_name.rb
 - lib/dry/cli/registry.rb
+- lib/dry/cli/spell_checker.rb
 - lib/dry/cli/usage.rb
 - lib/dry/cli/version.rb
 homepage: https://dry-rb.org/gems/dry-cli
@@ -118,7 +119,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,15 +127,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Common framework to build command line interfaces with Ruby
 test_files: []