dry-cli 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448f01b536f8cc664a86d2b4e558e8db6062c6ac31256c32d507828f1d3b7519
-  data.tar.gz: 254448f2e0b031cfc0077021ca3d0876b81b5eb9c7b1a7e51afce0d9524c95cc
+  metadata.gz: acfd9b78000e6f3ecef16d4eee260eee84bb4661251966e367e4f9a2001d3dac
+  data.tar.gz: df37074af2d1ed387d24ab90ed37920247cc40dc4c508c1325f08e9cb395c277
 SHA512:
-  metadata.gz: b114fa6217a59fdca38df56819e016a47337843ad357a52cd0f006bac2048dc2ee9253439a0353721412edac8e3a4d1f3c9601e7b3ccb729c86f5899d53fc2d6
-  data.tar.gz: 1edf50dce27e4d1cc9e9cc868c14d18e9399e62b0edcebf5a3166559bc8ef66a7fa79a04d0ac0c2ef5c6ffa1384aecb80ca967c16136f9dceb3721123e9c53a4
+  metadata.gz: c2b0035c9df7cbe7cf01fabd69a0207aaab945a13debf8b4a1441d764853343ac2a2dd1264c395aeda3296957870fcdcd87fa44041f6948d490afde897f2d837
+  data.tar.gz: c74d981d7c23200a652f75013977a9ea3b720c1264e184fd93af83fcb33995ec00c6284021a7e29b3ea215e9ac5c51aaccbf2ff03c821f215aa52d433bf1fd62

data/CHANGELOG.md

@@ -1,17 +1,46 @@
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.7.0 2020-05-08
+
+
+### Added
+
+- Inheritable attributes for subclasses of commands (@IvanShamatov)
+- Ability to register instances, not only classes as Commands (@IvanShamatov)
+- Add support for subcommands with a parent command (@unrooty)
+
+### Fixed
+
+- Safely rescue pipe exception, when you CLI app is producing output for piped CLI app (IvanShamatov)
+- Safely rescue keyboard interrupts (@IvanShamatov)
+- [Internal] Don't run specs twice (@jodosha)
+- Update inline call with keyward arguments (@flash-gordon)
+
+### Changed
+
+- Extracted Dry::CLI::Utils::Files into dry-files (@jodosha)
+- Drop 2.3 ruby support (@IvanShamatov)
+- [Internal] Changelog, issue templates (@solnic)
+- Documentation updates (@davydovanton)
+- Remove concurrent-ruby as runtime dependency (@jodosha)
+- [Internal] Banner and Parses refactoring (@IvanShamatov)
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-cli/compare/v0.6.0...v0.7.0)
+
 ## 0.6.0 2020-03-06
 
 
 ### Added
 
-- [Ivan Shamatov] Ability to pass command along with registry (for a singular command case)
-- [Nikita Shilnikov] [Internal] Backported ability to run gem's CI against ruby 2.3
-- [Ivan Shamatov] Inline syntax for commands
-- [Ivan Shamatov] Introduced stderr to any diagnostic output
+- Ability to pass command along with registry (for a singular command case) (@IvanShamatov)
+- [Internal] Backported ability to run gem's CI against ruby 2.3 (@flash-gordon)
+- Inline syntax for commands (@IvanShamatov)
+- Introduced stderr to any diagnostic output (@IvanShamatov)
 
 ### Fixed
 
-- [John Ledbetter & Luca Guidi] Fix ruby 2.7 warnings
-- [Ivan Shamatov] Fix banner, when option is a type of Array
+- [John Ledbetter & Luca Guidi] Fix ruby 2.7 warnings (@jodosha)
+- Fix banner, when option is a type of Array (@IvanShamatov)
 
 
 [Compare v0.5.1...v0.6.0](https://github.com/dry-rb/dry-cli/compare/v0.5.1...v0.6.0)
@@ -21,15 +50,15 @@
 
 ### Added
 
-- [Ivan Shamatov] Anonymous Registry sintax
-- [Ivan Shamatov] [Internal] Specs refactored, more unit specs added
-- [Luca Guidi] [Internal] removed `dry-inflector` as runtime dependency
-- [Ivan Shamatov] [Internal] Refactored Command class (command_name property removed)
-- [Piotr Solnica, Luca Guidi, Nikita Shilnikov & Christian Georgii] [Internal] Adapt gem to dry-rb style
+- Anonymous Registry sintax (@IvanShamatov)
+- [Internal] Specs refactored, more unit specs added (@IvanShamatov)
+- [Internal] removed `dry-inflector` as runtime dependency (@jodosha)
+- [Internal] Refactored Command class (command_name property removed) (@IvanShamatov)
+- [Internal] Adapt gem to dry-rb style (@jodosha, @flash-gordon, @solnic, @cgeorgii)
 
 ### Fixed
 
-- [Piotr Solnica] Added missing 'set' require
+- Added missing 'set' require (@solnic)
 
 
 [Compare v0.5.0...v0.5.1](https://github.com/dry-rb/dry-cli/compare/v0.5.0...v0.5.1)
@@ -39,7 +68,7 @@
 
 ### Added
 
-- [Ivan Shamatov, Piotr Solnica, Luca Guidi] [Internal] removed runtime and development dependency against `hanami-utils`
+- [Internal] removed runtime and development dependency against `hanami-utils` (@jodosha, @IvanShamatov, @solnic)
 
 
 [Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-cli/compare/v0.4.0...v0.5.0)
@@ -49,7 +78,7 @@
 
 ### Added
 
-- [Ivan Shamatov, Piotr Solnica, Luca Guidi] `hanami-cli` => `dry-cli`
+- `hanami-cli` => `dry-cli` (@jodosha, @IvanShamatov, @solnic)
 
 
 [Compare v0.3.1...v0.4.0](https://github.com/dry-rb/dry-cli/compare/v0.3.1...v0.4.0)
@@ -59,8 +88,8 @@
 
 ### Added
 
-- [Luca Guidi] Official support for Ruby: MRI 2.6
-- [Luca Guidi] Support `bundler` 2.0+
+- Official support for Ruby: MRI 2.6 (@jodosha)
+- Support `bundler` 2.0+ (@jodosha)
 
 
 [Compare v0.3.0...v0.3.1](https://github.com/dry-rb/dry-cli/compare/v0.3.0...v0.3.1)
@@ -76,14 +105,14 @@
 
 ### Added
 
-- [Anton Davydov & Alfonso Uceda] Introduce array type for arguments (`foo exec test spec/bookshelf/entities spec/bookshelf/repositories`)
-- [Anton Davydov & Alfonso Uceda] Introduce array type for options (`foo generate config --apps=web,api`)
-- [Alfonso Uceda] Introduce variadic arguments (`foo run ruby:latest -- ruby -v`)
-- [Luca Guidi] Official support for JRuby 9.2.0.0
+- Introduce array type for arguments (`foo exec test spec/bookshelf/entities spec/bookshelf/repositories`) (@davydovanton, @AlfonsoUceda)
+- Introduce array type for options (`foo generate config --apps=web,api`) (@davydovanton, @AlfonsoUceda)
+- Introduce variadic arguments (`foo run ruby:latest -- ruby -v`)
+- Official support for JRuby 9.2.0.0 (@jodosha, @AlfonsoUceda)
 
 ### Fixed
 
-- [Anton Davydov] Print informative message when unknown or wrong option is passed (`"test" was called with arguments "--framework=unknown"`)
+- Print informative message when unknown or wrong option is passed (`"test" was called with arguments "--framework=unknown"`) (@davydovanton)
 
 
 [Compare v0.2.0...v0.3.0.beta1](https://github.com/dry-rb/dry-cli/compare/v0.2.0...v0.3.0.beta1)
@@ -111,11 +140,11 @@
 
 ### Added
 
-- [Anton Davydov & Luca Guidi] Support objects as callbacks
+- Support objects as callbacks (@jodosha, @davydovanton)
 
 ### Fixed
 
-- [Anton Davydov & Luca Guidi] Ensure callbacks' context of execution (aka `self`) to be the command that is being executed
+- Ensure callbacks' context of execution (aka `self`) to be the command that is being executed (@jodosha, @davydovanton)
 
 
 [Compare v0.2.0.beta1...v0.2.0.beta2](https://github.com/dry-rb/dry-cli/compare/v0.2.0.beta1...v0.2.0.beta2)
@@ -125,7 +154,7 @@
 
 ### Added
 
-- [Anton Davydov] Register `before`/`after` callbacks for commands
+- Register `before`/`after` callbacks for commands (@davydovanton)
 
 
 [Compare v0.1.1...v0.2.0.beta1](https://github.com/dry-rb/dry-cli/compare/v0.1.1...v0.2.0.beta1)
@@ -135,12 +164,12 @@
 
 ### Added
 
-- [Luca Guidi] Official support for Ruby: MRI 2.5
+- Official support for Ruby: MRI 2.5 (@jodosha)
 
 ### Fixed
 
-- [Alfonso Uceda] Ensure default values for arguments to be sent to commands
-- [Alfonso Uceda] Ensure to fail when a missing required argument isn't provider, but an option is provided instead
+- Ensure default values for arguments to be sent to commands (@AlfonsoUceda)
+- Ensure to fail when a missing required argument isn't provider, but an option is provided instead (@AlfonsoUceda)
 
 
 [Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-cli/compare/v0.1.0...v0.1.1)
@@ -168,7 +197,7 @@
 
 ### Added
 
--  [Alfonso Uceda] Allow default value for arguments
+- Allow default value for arguments (@AlfonsoUceda)
 
 
 [Compare v0.1.0.beta1...v0.1.0.beta2](https://github.com/dry-rb/dry-cli/compare/v0.1.0.beta1...v0.1.0.beta2)
@@ -178,12 +207,12 @@
 
 ### Added
 
--  [Alfonso Uceda, Luca Guidi] Commands banner and usage
--  [Alfonso Uceda] Added support for subcommands
-- [Alfonso Uceda] Validations for arguments and options
-- [Alfonso Uceda] Commands arguments and options
-- [Alfonso Uceda] Commands description
-- [Alfonso Uceda, Oana Sipos] Commands aliases
-- [Luca Guidi] Exit on unknown command
-- [Luca Guidi, Alfonso Uceda, Oana Sipos] Command lookup
-- [Luca Guidi, Tim Riley] Trie based registry to register commands and allow third-parties to override/add commands
+- Commands banner and usage (@jodosha, @AlfonsoUceda)
+- Added support for subcommands (@AlfonsoUceda)
+- Validations for arguments and options (@AlfonsoUceda)
+- Commands arguments and options (@AlfonsoUceda)
+- Commands description (@AlfonsoUceda)
+- Commands aliases (@AlfonsoUceda, @oana-sipos)
+- Exit on unknown command (@jodosha)
+- Command lookup (@AlfonsoUceda, @oana-sipos)
+- Trie based registry to register commands and allow third-parties to override/add commands (@jodosha, @timriley)

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2021 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

@@ -21,7 +21,7 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
+* MRI >= `2.5`
 * jruby >= `9.2`
 
 ## License

data/dry-cli.gemspec

@@ -25,13 +25,12 @@ 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.3.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
-
   spec.add_development_dependency "bundler", ">= 1.6", "< 3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rubocop", "~> 0.82"
   spec.add_development_dependency "simplecov", "~> 0.17.1"
 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

data/lib/dry/cli/banner.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/cli/program_name'
+require "dry/cli/program_name"
 
 module Dry
   class CLI
@@ -16,15 +16,15 @@ module Dry
       #
       # @since 0.1.0
       # @api private
-      def self.call(command, names)
-        full_command_name = full_command_name(names)
+      def self.call(command, name)
         [
-          command_name(full_command_name),
-          command_name_and_arguments(command, full_command_name),
+          command_name(name),
+          command_name_and_arguments(command, name),
           command_description(command),
+          command_subcommands(command),
           command_arguments(command),
           command_options(command),
-          command_examples(command, full_command_name)
+          command_examples(command, name)
         ].compact.join("\n")
       end
 
@@ -37,7 +37,11 @@ module Dry
       # @since 0.1.0
       # @api private
       def self.command_name_and_arguments(command, name)
-        "\nUsage:\n  #{name}#{arguments(command)}"
+        usage = "\nUsage:\n  #{name}#{arguments(command)}"
+
+        return usage + " | #{name} SUBCOMMAND" if command.subcommands.any?
+
+        usage
       end
 
       # @since 0.1.0
@@ -45,7 +49,7 @@ module Dry
       def self.command_examples(command, name)
         return if command.examples.empty?
 
-        "\nExamples:\n#{command.examples.map { |example| "  #{name} #{example}" }.join("\n")}" # rubocop:disable Metrics/LineLength
+        "\nExamples:\n#{command.examples.map { |example| "  #{name} #{example}" }.join("\n")}"
       end
 
       # @since 0.1.0
@@ -56,6 +60,12 @@ module Dry
         "\nDescription:\n  #{command.description}"
       end
 
+      def self.command_subcommands(command)
+        return if command.subcommands.empty?
+
+        "\nSubcommands:\n#{build_subcommands_list(command.subcommands)}"
+      end
+
       # @since 0.1.0
       # @api private
       def self.command_arguments(command)
@@ -70,30 +80,24 @@ module Dry
         "\nOptions:\n#{extended_command_options(command)}"
       end
 
-      # @since 0.1.0
-      # @api private
-      def self.full_command_name(names)
-        ProgramName.call(names)
-      end
-
       # @since 0.1.0
       # @api private
       def self.arguments(command)
         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
       # @api private
       def self.extended_command_arguments(command)
         command.arguments.map do |argument|
-          "  #{argument.name.to_s.upcase.ljust(20)}\t# #{'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 Metrics/LineLength
         end.join("\n")
       end
 
@@ -110,16 +114,22 @@ module Dry
                  else
                    "#{name}=VALUE"
                  end
-          name = "#{name}, #{option.alias_names.join(', ')}" if option.aliases.any?
+          name = "#{name}, #{option.alias_names.join(", ")}" if option.aliases.any?
           name = "  --#{name.ljust(30)}"
-          name = "#{name}\t# #{option.desc}"
+          name = "#{name}  # #{option.desc}"
           name = "#{name}, default: #{option.default.inspect}" unless option.default.nil?
           name
         end
 
-        result << "  --#{'help, -h'.ljust(30)}\t# Print this help"
+        result << "  --#{"help, -h".ljust(30)}  # Print this help"
         result.join("\n")
       end
+
+      def self.build_subcommands_list(subcommands)
+        subcommands.map do |subcommand_name, subcommand|
+          "  #{subcommand_name.ljust(32)}  # #{subcommand.command.description}"
+        end.join("\n")
+      end
     end
   end
 end