dry-cli 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10c2bb5f82ae29dc19f705e9caee094e6e756e6de6a110e7ad82a540a98f08fa
-  data.tar.gz: 9ecf08520054dae86e45f61abcaf653d0da1eb6ee3b3c1907cf2fd44706b3a4c
+  metadata.gz: '0976875bf08ad159133d9c103dccf46df45551875fe368d24aca74bc11263b6e'
+  data.tar.gz: 68d06b56349cc86c74812b1226d221cf11ad97c132ab836ea2161add4e8867d5
 SHA512:
-  metadata.gz: c37d5cfb952cb82bb591ce4fd584675e117e76e73f2b5c65990b321de7b156cb56df55554caab94666c370c97d896602043edd39f5ac9e0a53cf33ada678d82e
-  data.tar.gz: ca346d815e518cb1306a4ddf1c9d178494bd0b1ba61024f65fe0eff282e3dac2caf57070439da99840ee719f38bcc30d6cda00158f4151001fde82c8a7ab4d40
+  metadata.gz: 9577fd903c55e544fe062aac19cf9226d3474a298299a8f30ce2ed58be60a9833e6b7d7ca56acfc33ec31b9899275a6ccaafa4aa732187987d0a72f3df0ab6f6
+  data.tar.gz: e3842ccf475c1a82fb53fb71dfa9deb96a28d23ca20ff25860f49a3db07fcaf1f2d0cd5cd0454afb41ca3b924475f190c091c1bc8e4182eb9981a24449f425ed

data/CHANGELOG.md

@@ -1,70 +1,159 @@
-# Dry::CLI
-General purpose Command Line Interface (CLI) framework for Ruby
+## 0.5.1 2020-01-23
+
+
+### Fixed
+
+- 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)
+
+## 0.5.0 2019-12-21
+
 
-## v0.5.0 - 2019-12-21
 ### Added
+
 - [Ivan Shamatov, Piotr Solnica, Luca Guidi] [Internal] removed runtime and development dependency against `hanami-utils`
 
-## v0.4.0 - 2019-12-10
+
+[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-cli/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2019-12-10
+
+
 ### Added
+
 - [Ivan Shamatov, Piotr Solnica, Luca Guidi] `hanami-cli` => `dry-cli`
 
-## v0.3.1 - 2019-01-18
+
+[Compare v0.3.1...v0.4.0](https://github.com/dry-rb/dry-cli/compare/v0.3.1...v0.4.0)
+
+## 0.3.1 2019-01-18
+
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 2.6
 - [Luca Guidi] Support `bundler` 2.0+
 
-## v0.3.0 - 2018-10-24
 
-## v0.3.0.beta1 - 2018-08-08
+[Compare v0.3.0...v0.3.1](https://github.com/dry-rb/dry-cli/compare/v0.3.0...v0.3.1)
+
+## 0.3.0 2018-10-24
+
+
+
+[Compare v0.3.0.beta1...v0.3.0](https://github.com/dry-rb/dry-cli/compare/v0.3.0.beta1...v0.3.0)
+
+## 0.3.0.beta1 2018-08-08
+
+
 ### 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
 
 ### Fixed
+
 - [Anton Davydov] Print informative message when unknown or wrong option is passed (`"test" was called with arguments "--framework=unknown"`)
 
-## v0.2.0 - 2018-04-11
 
-## v0.2.0.rc2 - 2018-04-06
+[Compare v0.2.0...v0.3.0.beta1](https://github.com/dry-rb/dry-cli/compare/v0.2.0...v0.3.0.beta1)
+
+## 0.2.0 2018-04-11
+
+
+
+[Compare v0.2.0.rc2...v0.2.0](https://github.com/dry-rb/dry-cli/compare/v0.2.0.rc2...v0.2.0)
+
+## 0.2.0.rc2 2018-04-06
+
+
+
+[Compare v0.2.0.rc1...v0.2.0.rc2](https://github.com/dry-rb/dry-cli/compare/v0.2.0.rc1...v0.2.0.rc2)
+
+## 0.2.0.rc1 2018-03-30
+
+
+
+[Compare v0.2.0.beta2...v0.2.0.rc1](https://github.com/dry-rb/dry-cli/compare/v0.2.0.beta2...v0.2.0.rc1)
+
+## 0.2.0.beta2 2018-03-23
 
-## v0.2.0.rc1 - 2018-03-30
 
-## v0.2.0.beta2 - 2018-03-23
 ### Added
+
 - [Anton Davydov & Luca Guidi] Support objects as callbacks
 
 ### Fixed
+
 - [Anton Davydov & Luca Guidi] Ensure callbacks' context of execution (aka `self`) to be the command that is being executed
 
-## v0.2.0.beta1 - 2018-02-28
+
+[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)
+
+## 0.2.0.beta1 2018-02-28
+
+
 ### Added
+
 - [Anton Davydov] Register `before`/`after` callbacks for commands
 
-## v0.1.1 - 2018-02-27
+
+[Compare v0.1.1...v0.2.0.beta1](https://github.com/dry-rb/dry-cli/compare/v0.1.1...v0.2.0.beta1)
+
+## 0.1.1 2018-02-27
+
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 2.5
 
 ### 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
 
-## v0.1.0 - 2017-10-25
 
-## v0.1.0.rc1 - 2017-10-16
+[Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-cli/compare/v0.1.0...v0.1.1)
+
+## 0.1.0 2017-10-25
+
+
+
+[Compare v0.1.0.rc1...v0.1.0](https://github.com/dry-rb/dry-cli/compare/v0.1.0.rc1...v0.1.0)
+
+## 0.1.0.rc1 2017-10-16
+
+
+
+[Compare v0.1.0.beta3...v0.1.0.rc1](https://github.com/dry-rb/dry-cli/compare/v0.1.0.beta3...v0.1.0.rc1)
+
+## 0.1.0.beta3 2017-10-04
+
+
+
+[Compare v0.1.0.beta2...v0.1.0.beta3](https://github.com/dry-rb/dry-cli/compare/v0.1.0.beta2...v0.1.0.beta3)
+
+## 0.1.0.beta2 2017-10-03
 
-## v0.1.0.beta3 - 2017-10-04
 
-## v0.1.0.beta2 - 2017-10-03
 ### Added
-- [Alfonso Uceda] Allow default value for arguments
 
-## v0.1.0.beta1 - 2017-08-11
+-  [Alfonso Uceda] Allow default value for arguments
+
+
+[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)
+
+## 0.1.0.beta1 2017-08-11
+
+
 ### Added
-- [Alfonso Uceda, Luca Guidi] Commands banner and usage
-- [Alfonso Uceda] Added support for subcommands
+
+-  [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

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 dry-rb team
+Copyright (c) 2015-2020 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,31 +1,29 @@
 [gem]: https://rubygems.org/gems/dry-cli
-[ci]: https://github.com/dry-rb/dry-cli/actions?query=workflow%3Aci
-[codeclimate]: https://codeclimate.com/github/dry-rb/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 (formerly known as hanami-cli)[![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
+# 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]
-[![Build Status](https://github.com/dry-rb/dry-cli/workflows/ci/badge.svg)][ci]
-[![Code Climate](https://codeclimate.com/github/dry-rb/dry-cli/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/dry-rb/dry-cli/badges/coverage.svg)][codeclimate]
+[![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=master)][inchpages]
 
 ## Links
 
-- [User documentation](https://dry-rb.org/gems/dry-cli)
-- [API documentation](http://rubydoc.info/gems/dry-cli)
-- [Guidelines for contributing](CONTRIBUTING.md)
+* [User documentation](http://dry-rb.org/gems/dry-cli)
+* [API documentation](http://rubydoc.info/gems/dry-cli)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-- MRI >= `2.3`
-- jruby >= `9.2`
+* MRI >= `2.4`
+* jruby >= `9.2`
 
 ## License
 
 See `LICENSE` file.
-

data/dry-cli.gemspec

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# this file is managed by dry-rb/devtools project
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -6,30 +7,29 @@ require 'dry/cli/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'dry-cli'
-  spec.version       = Dry::CLI::VERSION
-  spec.authors       = ['Luca Guidi']
-  spec.email         = ['me@lucaguidi.com']
-  spec.licenses      = ['MIT']
-
-  spec.summary       = 'Dry CLI'
-  spec.description   = 'Common framework to build command line interfaces with Ruby'
-  spec.homepage      = 'http://dry-rb.org'
+  spec.authors       = ["Luca Guidi"]
+  spec.email         = ["me@lucaguidi.com"]
+  spec.license       = 'MIT'
+  spec.version       = Dry::CLI::VERSION.dup
+
+  spec.summary       = "Common framework to build command line interfaces with Ruby"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://dry-rb.org/gems/dry-cli'
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-cli.gemspec", "lib/**/*"]
+  spec.require_paths = ['lib']
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['source_code_uri'] = 'https://github.com/dry-rb/dry-cli'
-
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-cli/blob/master/CHANGELOG.md'
+  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.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_dependency 'concurrent-ruby', '~> 1.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 'simplecov', '~> 0.17.1'
+  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 "simplecov", "~> 0.17.1"
 end

data/lib/dry/cli.rb

@@ -36,12 +36,17 @@ module Dry
 
     # Create a new instance
     #
-    # @param registry [Dry::CLI::Registry] a registry
+    # @param registry [Dry::CLI::Registry, Block] a registry or a configuration block
     #
     # @return [Dry::CLI] the new instance
-    # @since 0.1.0
-    def initialize(registry)
-      @commands = registry
+    # @since 0.4.0
+    def initialize(registry = nil, &block)
+      @commands =
+        if block_given?
+          anonymous_registry(&block)
+        else
+          registry
+        end
     end
 
     # Invoke the CLI
@@ -84,12 +89,13 @@ module Dry
     # @api private
     def parse(result, out)
       command = result.command
+      names = result.names
       return [command, result.arguments] unless command?(command)
 
       result = Parser.call(command, result.arguments, result.names)
 
       if result.help?
-        Banner.call(command, out)
+        Banner.call(command, out, names)
         exit(0)
       end
 
@@ -126,5 +132,33 @@ module Dry
     def command?(command)
       CLI.command?(command)
     end
+
+    # Generates registry in runtime
+    #
+    # @param &block [Block] configuration for the registry
+    #
+    # @return [Module] module extended with registry abilities and configured with a block
+    #
+    # @since 0.4.0
+    # @api private
+    def anonymous_registry(&block)
+      registry = Module.new { extend(Dry::CLI::Registry) }
+      if block.arity.zero?
+        registry.instance_eval(&block)
+      else
+        yield(registry)
+      end
+      registry
+    end
+  end
+
+  # Create a new instance
+  #
+  # @param registry [Dry::CLI::Registry, Block] a registry or a configuration block
+  #
+  # @return [Dry::CLI] the new instance
+  # @since 0.4.0
+  def self.CLI(registry = nil, &block)
+    CLI.new(registry, &block)
   end
 end

data/lib/dry/cli/banner.rb

@@ -16,14 +16,15 @@ module Dry
       #
       # @since 0.1.0
       # @api private
-      def self.call(command, out)
+      def self.call(command, out, names)
+        full_command_name = full_command_name(names)
         output = [
-          command_name(command),
-          command_name_and_arguments(command),
+          command_name(full_command_name),
+          command_name_and_arguments(command, full_command_name),
           command_description(command),
           command_arguments(command),
           command_options(command),
-          command_examples(command)
+          command_examples(command, full_command_name)
         ].compact.join("\n")
 
         out.puts output
@@ -31,22 +32,22 @@ module Dry
 
       # @since 0.1.0
       # @api private
-      def self.command_name(command)
-        "Command:\n  #{full_command_name(command)}"
+      def self.command_name(name)
+        "Command:\n  #{name}"
       end
 
       # @since 0.1.0
       # @api private
-      def self.command_name_and_arguments(command)
-        "\nUsage:\n  #{full_command_name(command)}#{arguments(command)}"
+      def self.command_name_and_arguments(command, name)
+        "\nUsage:\n  #{name}#{arguments(command)}"
       end
 
       # @since 0.1.0
       # @api private
-      def self.command_examples(command)
+      def self.command_examples(command, name)
         return if command.examples.empty?
 
-        "\nExamples:\n#{command.examples.map { |example| "  #{full_command_name(command)} #{example}" }.join("\n")}" # rubocop:disable Metrics/LineLength
+        "\nExamples:\n#{command.examples.map { |example| "  #{name} #{example}" }.join("\n")}" # rubocop:disable Metrics/LineLength
       end
 
       # @since 0.1.0
@@ -73,8 +74,8 @@ module Dry
 
       # @since 0.1.0
       # @api private
-      def self.full_command_name(command)
-        ProgramName.call(command.command_name)
+      def self.full_command_name(names)
+        ProgramName.call(names)
       end
 
       # @since 0.1.0
@@ -101,7 +102,6 @@ module Dry
       # @since 0.1.0
       # @api private
       #
-      # rubocop:disable Metrics/AbcSize
       def self.extended_command_options(command)
         result = command.options.map do |option|
           name = Inflector.dasherize(option.name)
@@ -110,8 +110,7 @@ module Dry
                  else
                    "#{name}=VALUE"
                  end
-
-          name = "#{name}, #{option.aliases.map { |a| a.start_with?('--') ? "#{a}=VALUE" : "#{a} VALUE" }.join(', ')}" unless option.aliases.empty? # rubocop:disable Metrics/LineLength
+          name = "#{name}, #{option.alias_names.join(', ')}" if option.aliases.any?
           name = "  --#{name.ljust(30)}"
           name = "#{name}\t# #{option.desc}"
           name = "#{name}, default: #{option.default.inspect}" unless option.default.nil?
@@ -121,7 +120,6 @@ module Dry
         result << "  --#{'help, -h'.ljust(30)}\t# Print this help"
         result.join("\n")
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end