dry-cli 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0976875bf08ad159133d9c103dccf46df45551875fe368d24aca74bc11263b6e'
-  data.tar.gz: 68d06b56349cc86c74812b1226d221cf11ad97c132ab836ea2161add4e8867d5
+  metadata.gz: 448f01b536f8cc664a86d2b4e558e8db6062c6ac31256c32d507828f1d3b7519
+  data.tar.gz: 254448f2e0b031cfc0077021ca3d0876b81b5eb9c7b1a7e51afce0d9524c95cc
 SHA512:
-  metadata.gz: 9577fd903c55e544fe062aac19cf9226d3474a298299a8f30ce2ed58be60a9833e6b7d7ca56acfc33ec31b9899275a6ccaafa4aa732187987d0a72f3df0ab6f6
-  data.tar.gz: e3842ccf475c1a82fb53fb71dfa9deb96a28d23ca20ff25860f49a3db07fcaf1f2d0cd5cd0454afb41ca3b924475f190c091c1bc8e4182eb9981a24449f425ed
+  metadata.gz: b114fa6217a59fdca38df56819e016a47337843ad357a52cd0f006bac2048dc2ee9253439a0353721412edac8e3a4d1f3c9601e7b3ccb729c86f5899d53fc2d6
+  data.tar.gz: 1edf50dce27e4d1cc9e9cc868c14d18e9399e62b0edcebf5a3166559bc8ef66a7fa79a04d0ac0c2ef5c6ffa1384aecb80ca967c16136f9dceb3721123e9c53a4

data/CHANGELOG.md

@@ -1,9 +1,35 @@
+## 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
+
+### Fixed
+
+- [John Ledbetter & Luca Guidi] Fix ruby 2.7 warnings
+- [Ivan Shamatov] Fix banner, when option is a type of Array
+
+
+[Compare v0.5.1...v0.6.0](https://github.com/dry-rb/dry-cli/compare/v0.5.1...v0.6.0)
+
 ## 0.5.1 2020-01-23
 
 
+### 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
+
 ### Fixed
 
-- Added missing 'set' require (@solnic)
+- [Piotr Solnica] Added missing 'set' require
 
 
 [Compare v0.5.0...v0.5.1](https://github.com/dry-rb/dry-cli/compare/v0.5.0...v0.5.1)

data/dry-cli.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |spec|
   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.bindir        = 'bin'
+  spec.executables   = []
   spec.require_paths = ['lib']
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
@@ -23,7 +25,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.4.0'
+  spec.required_ruby_version = ">= 2.3.0"
 
   # to update dependencies edit project.yml
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"

data/lib/dry/cli.rb

@@ -36,16 +36,20 @@ module Dry
 
     # Create a new instance
     #
-    # @param registry [Dry::CLI::Registry, Block] a registry or a configuration block
+    # @param command_or_registry [Dry::CLI::Registry, Dry::CLI::Command]
+    #   a registry or singular command
+    # @param &block [Block] a configuration block for registry
     #
     # @return [Dry::CLI] the new instance
-    # @since 0.4.0
-    def initialize(registry = nil, &block)
-      @commands =
+    # @since 0.1.0
+    def initialize(command_or_registry = nil, &block)
+      @kommand = command_or_registry if command?(command_or_registry)
+
+      @registry =
         if block_given?
           anonymous_registry(&block)
         else
-          registry
+          command_or_registry
         end
     end
 
@@ -53,28 +57,67 @@ module Dry
     #
     # @param arguments [Array<string>] the command line arguments (defaults to `ARGV`)
     # @param out [IO] the standard output (defaults to `$stdout`)
+    # @param err [IO] the error output (defaults to `$stderr`)
     #
     # @since 0.1.0
-    def call(arguments: ARGV, out: $stdout)
-      result = commands.get(arguments)
+    def call(arguments: ARGV, out: $stdout, err: $stderr)
+      @out, @err = out, err
+      return perform_command(arguments) if kommand
+
+      perform_registry(arguments)
+    end
+
+    private
+
+    # @since 0.6.0
+    # @api private
+    attr_reader :registry
+
+    # @since 0.6.0
+    # @api private
+    attr_reader :kommand
+
+    # @since 0.6.0
+    # @api private
+    attr_reader :out
+
+    # @since 0.6.0
+    # @api private
+    attr_reader :err
+
+    # Invoke the CLI if singular command passed
+    #
+    # @param arguments [Array<string>] the command line arguments
+    # @param out [IO] the standard output (defaults to `$stdout`)
+    #
+    # @since 0.6.0
+    # @api private
+    def perform_command(arguments)
+      command, args = parse(kommand, arguments, [])
+      command.call(**args)
+    end
+
+    # Invoke the CLI if registry passed
+    #
+    # @param arguments [Array<string>] the command line arguments
+    # @param out [IO] the standard output (defaults to `$stdout`)
+    #
+    # @since 0.6.0
+    # @api private
+    def perform_registry(arguments)
+      result = registry.get(arguments)
 
       if result.found?
-        command, args = parse(result, out)
+        command, args = parse(result.command, result.arguments, result.names)
 
         result.before_callbacks.run(command, args)
-        command.call(args)
+        command.call(**args)
         result.after_callbacks.run(command, args)
       else
-        usage(result, out)
+        usage(result)
       end
     end
 
-    private
-
-    # @since 0.1.0
-    # @api private
-    attr_reader :commands
-
     # Parse arguments for a command.
     #
     # It may exit in case of error, or in case of help.
@@ -85,26 +128,22 @@ module Dry
     # @return [Array<Dry:CLI::Command, Array>] returns an array where the
     #   first element is a command and the second one is the list of arguments
     #
-    # @since 0.1.0
+    # @since 0.6.0
     # @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)
+    def parse(command, arguments, names)
+      result = Parser.call(command, arguments, names)
 
       if result.help?
-        Banner.call(command, out, names)
+        out.puts Banner.call(command, names)
         exit(0)
       end
 
       if result.error?
-        out.puts(result.error)
+        err.puts(result.error)
         exit(1)
       end
 
-      [command, result.arguments]
+      [command.new, result.arguments]
     end
 
     # Prints the command usage and exit.
@@ -114,8 +153,8 @@ module Dry
     #
     # @since 0.1.0
     # @api private
-    def usage(result, out)
-      Usage.call(result, out)
+    def usage(result)
+      err.puts Usage.call(result)
       exit(1)
     end
 
@@ -154,11 +193,13 @@ module Dry
 
   # Create a new instance
   #
-  # @param registry [Dry::CLI::Registry, Block] a registry or a configuration block
+  # @param registry_or_command [Dry::CLI::Registry, Dry::CLI::Command]
+  #   a registry or singular command
+  # @param &block [Block] a configuration block for registry
   #
   # @return [Dry::CLI] the new instance
   # @since 0.4.0
-  def self.CLI(registry = nil, &block)
-    CLI.new(registry, &block)
+  def self.CLI(registry_or_command = nil, &block)
+    CLI.new(registry_or_command, &block)
   end
 end

data/lib/dry/cli/banner.rb

@@ -16,9 +16,9 @@ module Dry
       #
       # @since 0.1.0
       # @api private
-      def self.call(command, out, names)
+      def self.call(command, names)
         full_command_name = full_command_name(names)
-        output = [
+        [
           command_name(full_command_name),
           command_name_and_arguments(command, full_command_name),
           command_description(command),
@@ -26,8 +26,6 @@ module Dry
           command_options(command),
           command_examples(command, full_command_name)
         ].compact.join("\n")
-
-        out.puts output
       end
 
       # @since 0.1.0
@@ -107,6 +105,8 @@ module Dry
           name = Inflector.dasherize(option.name)
           name = if option.boolean?
                    "[no-]#{name}"
+                 elsif option.array?
+                   "#{name}=VALUE1,VALUE2,.."
                  else
                    "#{name}=VALUE"
                  end

data/lib/dry/cli/command_registry.rb

@@ -20,13 +20,12 @@ module Dry
       # @api private
       def set(name, command, aliases)
         node = @root
-        command = command.new if command
         name.split(/[[:space:]]/).each do |token|
           node = node.put(node, token)
         end
 
         node.aliases!(aliases)
-        node.leaf!(command) unless command.nil?
+        node.leaf!(command) if command
 
         nil
       end

data/lib/dry/cli/inline.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'backports/2.5.0/module/define_method' if RUBY_VERSION < '2.5'
+
+module Dry
+  class CLI
+    require 'dry/cli'
+    # Inline Syntax (aka DSL) to implement one-file applications
+    #
+    # `dry/cli/inline` is not required by default
+    # and explicit requirement of this file means that
+    # it is expected of abusing global namespace with
+    # methods below
+    #
+    # DSL consists of 5 methods:
+    # `desc`, `example`, `argument`, `option` 
+    # — are similar to methods from Command class
+    #
+    # `run` accepts a block to execute
+    #
+    # @example
+    #   require 'bundler/inline'
+    #   gemfile { gem 'dry/cli', require: 'dry/cli/inline' }
+    #
+    #   desc 'List files in a directory'
+    #   argument :path, required: false, desc: '[DIR]'
+    #   option :all, aliases: ['a'], type: :boolean
+    #
+    #   run do |path: '.', **options|
+    #     puts options.key?(:all) ? Dir.entries(path) : Dir.children(path)
+    #   end
+    #
+    #   # $ ls -a
+    #   # $ ls somepath
+    #   # $ ls somepath --all
+    # @since 0.6.0
+    module Inline
+      extend Forwardable
+
+      # AnonymousCommand
+      #
+      # @since 0.6.0
+      AnonymousCommand = Class.new(Dry::CLI::Command)
+
+      # @since 0.6.0
+      delegate %i[desc example argument option] => AnonymousCommand
+
+      # The rule of thumb for implementation of run block
+      # is that for every argument from your CLI
+      # you need to specify that as an mandatory argument for a block.
+      # Optional arguments have to have default value as ruby syntax expect them
+      #
+      # @example
+      #   argument :one
+      #   argument :two, required: false
+      #   option :three
+      #
+      #   run do |one:, two: 'default', **options|
+      #     puts one, two, options.inspect
+      #   end
+      #
+      # @since 0.6.0
+      def run(arguments: ARGV, out: $stdout)
+        command = AnonymousCommand
+        command.define_method(:call) do |*args|
+          yield(*args)
+        end
+
+        Dry.CLI(command).call(arguments: arguments, out: out)
+      end
+    end
+  end
+end
+
+include Dry::CLI::Inline # rubocop:disable Style/MixinUsage

data/lib/dry/cli/usage.rb

@@ -15,14 +15,14 @@ module Dry
 
       # @since 0.1.0
       # @api private
-      def self.call(result, out)
-        out.puts 'Commands:'
+      def self.call(result)
+        header = 'Commands:'
         max_length, commands = commands_and_arguments(result)
 
-        commands.each do |banner, node|
+        commands.map do |banner, node|
           usage = description(node.command) if node.leaf?
-          out.puts "#{justify(banner, max_length, usage)}#{usage}"
-        end
+          "#{justify(banner, max_length, usage)}#{usage}"
+        end.unshift(header).join("\n")
       end
 
       # @since 0.1.0

data/lib/dry/cli/utils/files.rb

@@ -2,6 +2,7 @@
 
 require 'pathname'
 require 'fileutils'
+require 'backports/2.4.0/string/match' if RUBY_VERSION < '2.4'
 
 module Dry
   class CLI

data/lib/dry/cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-cli
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -103,6 +103,7 @@ files:
 - lib/dry/cli/command_registry.rb
 - lib/dry/cli/errors.rb
 - lib/dry/cli/inflector.rb
+- lib/dry/cli/inline.rb
 - lib/dry/cli/option.rb
 - lib/dry/cli/parser.rb
 - lib/dry/cli/program_name.rb
@@ -126,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="