dry-cli 0.5.0 → 0.5.1

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.byebug_history
-.rubocop-*

data/.rspec

@@ -1,4 +0,0 @@
---color
---require spec_helper
---order random
-

data/.rubocop.yml

@@ -1,95 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/EachWithObject:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/Alias:
-  Enabled: false
-
-Style/LambdaCall:
-  Enabled: false
-
-Style/StabbyLambdaParentheses:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Max: 22
-
-Metrics/ClassLength:
-  Max: 150
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: true
-  Max: 10
-
-Lint/BooleanSymbol:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Lint/HandleExceptions:
-  Exclude:
-    - "spec/spec_helper.rb"
-
-Naming/FileName:
-  Exclude:
-    - "lib/dry-*.rb"
-
-Style/SymbolArray:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/DateTime:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -1,29 +0,0 @@
-# Issue Guidelines
-
-## Reporting bugs
-
-If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
-
-## Reporting feature requests
-
-Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
-
-## Reporting questions, support requests, ideas, concerns etc.
-
-**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
-
-# Pull Request Guidelines
-
-A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
-
-Other requirements:
-
-1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
-2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
-3) Add API documentation if it's a new feature
-4) Update API documentation if it changes an existing feature
-5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
-
-# Asking for help
-
-If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-git_source(:github) do |repo_name| "https://github.com/#{repo_name}" end
-
-unless ENV['CI']
-  gem 'byebug', require: false, platforms: :mri
-  gem 'yard',   require: false
-end
-
-gem 'ossy', github: 'solnic/ossy', branch: 'master', platform: :mri

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'rake'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-namespace :spec do
-  RSpec::Core::RakeTask.new(:unit) do |task|
-    file_list = FileList['spec/**/*_spec.rb']
-    file_list = file_list.exclude('spec/{integration,isolation}/**/*_spec.rb')
-
-    task.pattern = file_list
-  end
-end
-
-task default: 'spec:unit'

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'dry/cli'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docsite/source/index.html.md

@@ -1,588 +0,0 @@
----
-title: Introduction
-description: General purpose Command Line Interface (CLI) framework
-layout: gem-single
-type: gem
-name: dry-cli
----
-
-## Table of Contents
-
-  - [Features](#features)
-    - [Registration](#registration)
-    - [Commands as objects](#commands-as-objects)
-    - [Subcommands](#subcommands)
-    - [Arguments](#arguments)
-    - [Option](#option)
-    - [Variadic arguments](#variadic-arguments)
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [Available commands](#available-commands)
-    - [Help](#help)
-    - [Optional arguments](#optional-arguments)
-    - [Required arguments](#required-arguments)
-    - [Options](#options)
-    - [Boolean options](#boolean-options)
-    - [Array options](#array-options)
-    - [Subcommands](#subcommands-1)
-    - [Aliases](#aliases)
-    - [Subcommand aliases](#subcommand-aliases)
-    - [Callbacks](#callbacks)
-    - [File Utils](#file-utils)
-  - [Development](#development)
-  - [Contributing](#contributing)
-  - [Alternatives](#alternatives)
-  - [Copyright](#copyright)
-
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
-
-## Features
-
-### Registration
-
-For a given _command name_, you can register a corresponding _command object_ (aka command).
-
-Example: for `foo hi` _command name_ there is the corresponding `Foo::CLI::Hello` _command object_.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "dry/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Dry::CLI::Registry
-
-      class Hello < Dry::CLI::Command
-        def call(*)
-        end
-      end
-    end
-  end
-end
-
-class Version < Dry::CLI::Command
-  def call(*)
-  end
-end
-
-Foo::CLI::Commands.register "hi", Foo::CLI::Commands::Hello
-Foo::CLI::Commands.register "v",  Version
-
-Dry::CLI.new(Foo::CLI::Commands).call
-```
-
-**Please note:** there is NOT a convention between the _command name_ and the _command object_ class.
-The manual _registration_ assigns a _command object_ to a _command name_.
-
-### Commands as objects
-
-A command is a subclass of `Dry::CLI::Command` and it MUST respond to `#call(*)`.
-
-### Subcommands
-
-There is nothing special in subcommands: they are just _command objects_ registered under a **nested** _command name_.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "dry/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Dry::CLI::Registry
-
-      module Generate
-        class Configuration < Dry::CLI::Command
-          def call(*)
-          end
-        end
-      end
-    end
-  end
-end
-
-Foo::CLI::Commands.register "generate configuration", Foo::CLI::Commands::Generate::Configuration
-
-Dry::CLI.new(Foo::CLI::Commands).call
-```
-
-### Arguments
-
-An argument is a token passed after the _command name_.
-For instance, given the `foo greet` command, when an user types `foo greet Luca`, then `Luca` is considered an argument.
-A command can accept none or many arguments.
-An argument can be declared as _required_.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "dry/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Dry::CLI::Registry
-
-      class Greet < Dry::CLI::Command
-        argument :name, required: true, desc: "The name of the person to greet"
-        argument :age, desc: "The age of the person to greet"
-
-        def call(name:, age: nil, **)
-          result = "Hello, #{name}."
-          result = "#{result} You are #{age} years old." unless age.nil?
-
-          puts result
-        end
-      end
-
-      register "greet", Greet
-    end
-  end
-end
-
-Dry::CLI.new(Foo::CLI::Commands).call
-```
-
-```shell
-% foo greet Luca
-Hello, Luca.
-```
-
-```shell
-% foo greet Luca 35
-Hello, Luca. You are 35 years old.
-```
-
-```shell
-% foo greet
-ERROR: "foo greet" was called with no arguments
-Usage: "foo greet NAME"
-```
-
-### Option
-
-An option is a named argument that is passed after the _command name_ **and** the arguments.
-
-For instance, given the `foo request` command, when an user types `foo request --mode=http2`, then `--mode=http2` is considered an option.
-A command can accept none or many options.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "dry/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Dry::CLI::Registry
-
-      class Request < Dry::CLI::Command
-        option :mode, default: "http", values: %w[http http2], desc: "The request mode"
-
-        def call(**options)
-          puts "Performing a request (mode: #{options.fetch(:mode)})"
-        end
-      end
-
-      register "request", Request
-    end
-  end
-end
-
-Dry::CLI.new(Foo::CLI::Commands).call
-```
-
-```shell
-% foo request
-Performing a request (mode: http)
-```
-
-```shell
-% foo request --mode=http2
-Performing a request (mode: http2)
-```
-
-```shell
-% foo request --mode=unknown
-Error: "request" was called with arguments "--mode=unknown"
-```
-
-### Variadic arguments
-
-Sometimes we need extra arguments because those will be forwarded to a sub-command like `ssh`, `docker` or `cat`.
-
-By using `--` (double dash, aka hypen), the user indicates the end of the arguments and options belonging to the main command, and the beginning of the variadic arguments that can be forwarded to the sub-command.
-These extra arguments are included as `:args` in the keyword arguments available for each command.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "dry/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Dry::CLI::Registry
-
-      class Runner < Dry::CLI::Command
-        argument :image, required: true, desc: "Docker image"
-
-        def call(image:, args: [], **)
-          puts `docker run -it --rm #{image} #{args.join(" ")}`
-        end
-      end
-
-      register "run", Runner
-    end
-  end
-end
-
-Dry::CLI.new(Foo::CLI::Commands).call
-```
-
-```shell
-% foo run ruby:latest -- ruby -v
-ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux]
-```
-
-The user separates via `--` the arguments for `foo` and the command has to be run by the Docker container.
-In this specific case, `ruby:latest` corresponds to the `image` mandatory argument for `foo`, whereas `ruby -v` is the variadic argument that is passed to Docker via `args`.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "dry-cli"
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install dry-cli
-
-## Usage
-
-Imagine to build a CLI executable `foo` for your Ruby project.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "dry/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Dry::CLI::Registry
-
-      class Version < Dry::CLI::Command
-        desc "Print version"
-
-        def call(*)
-          puts "1.0.0"
-        end
-      end
-
-      class Echo < Dry::CLI::Command
-        desc "Print input"
-
-        argument :input, desc: "Input to print"
-
-        example [
-          "             # Prints 'wuh?'",
-          "hello, folks # Prints 'hello, folks'"
-        ]
-
-        def call(input: nil, **)
-          if input.nil?
-            puts "wuh?"
-          else
-            puts input
-          end
-        end
-      end
-
-      class Start < Dry::CLI::Command
-        desc "Start Foo machinery"
-
-        argument :root, required: true, desc: "Root directory"
-
-        example [
-          "path/to/root # Start Foo at root directory"
-        ]
-
-        def call(root:, **)
-          puts "started - root: #{root}"
-        end
-      end
-
-      class Stop < Dry::CLI::Command
-        desc "Stop Foo machinery"
-
-        option :graceful, type: :boolean, default: true, desc: "Graceful stop"
-
-        def call(**options)
-          puts "stopped - graceful: #{options.fetch(:graceful)}"
-        end
-      end
-
-      class Exec < Dry::CLI::Command
-        desc "Execute a task"
-
-        argument :task, type: :string, required: true,  desc: "Task to be executed"
-        argument :dirs, type: :array,  required: false, desc: "Optional directories"
-
-        def call(task:, dirs: [], **)
-          puts "exec - task: #{task}, dirs: #{dirs.inspect}"
-        end
-      end
-
-      module Generate
-        class Configuration < Dry::CLI::Command
-          desc "Generate configuration"
-
-          option :apps, type: :array, default: [], desc: "Generate configuration for specific apps"
-
-          def call(apps:, **)
-            puts "generated configuration for apps: #{apps.inspect}"
-          end
-        end
-
-        class Test < Dry::CLI::Command
-          desc "Generate tests"
-
-          option :framework, default: "minitest", values: %w[minitest rspec]
-
-          def call(framework:, **)
-            puts "generated tests - framework: #{framework}"
-          end
-        end
-      end
-
-      register "version", Version, aliases: ["v", "-v", "--version"]
-      register "echo",    Echo
-      register "start",   Start
-      register "stop",    Stop
-      register "exec",    Exec
-
-      register "generate", aliases: ["g"] do |prefix|
-        prefix.register "config", Generate::Configuration
-        prefix.register "test",   Generate::Test
-      end
-    end
-  end
-end
-
-Dry::CLI.new(Foo::CLI::Commands).call
-```
-
-Let's have a look at the command line usage.
-
-### Available commands
-
-```shell
-% foo
-Commands:
-  foo echo [INPUT]                       # Print input
-  foo exec TASK [DIRS]                   # Execute a task
-  foo generate [SUBCOMMAND]
-  foo start ROOT                         # Start Foo machinery
-  foo stop                               # Stop Foo machinery
-  foo version                            # Print version
-```
-
-### Help
-
-```shell
-% foo echo --help
-Command:
-  foo echo
-
-Usage:
-  foo echo [INPUT]
-
-Description:
-  Print input
-
-Arguments:
-  INPUT               	# Input to print
-
-Options:
-  --help, -h                      	# Print this help
-
-Examples:
-  foo echo              # Prints 'wuh?'
-  foo echo hello, folks # Prints 'hello, folks'
-```
-
-### Optional arguments
-
-```shell
-% foo echo
-wuh?
-
-% foo echo hello
-hello
-```
-
-### Required arguments
-
-```shell
-% foo start .
-started - root: .
-```
-
-```shell
-% foo start
-ERROR: "foo start" was called with no arguments
-Usage: "foo start ROOT"
-```
-
-### Array arguments
-
-Captures all the remaining arguments in a single array.
-Please note that `array` argument must be used as last argument as it works as a _"catch-all"_.
-
-```shell
-% foo exec test
-exec - task: test, dirs: []
-```
-
-```shell
-% foo exec test spec/bookshelf/entities spec/bookshelf/repositories
-exec - task: test, dirs: ["spec/bookshelf/entities", "spec/bookshelf/repositories"]
-```
-
-### Options
-
-```shell
-% foo generate test
-generated tests - framework: minitest
-```
-
-```shell
-% foo generate test --framework=rspec
-generated tests - framework: rspec
-```
-
-```shell
-% foo generate test --framework=unknown
-Error: "test" was called with arguments "--framework=unknown"
-```
-
-### Boolean options
-
-```shell
-% foo stop
-stopped - graceful: true
-```
-
-```shell
-% foo stop --no-graceful
-stopped - graceful: false
-```
-
-### Array options
-
-```shell
-% foo generate config --apps=web,api
-generated configuration for apps: ["web", "api"]
-```
-
-### Subcommands
-
-```shell
-% foo generate
-Commands:
-  foo generate config           # Generate configuration
-  foo generate test             # Generate tests
-```
-
-### Aliases
-
-```shell
-% foo version
-1.0.0
-```
-
-```shell
-% foo v
-1.0.0
-```
-
-```shell
-% foo -v
-1.0.0
-```
-
-```shell
-% foo --version
-1.0.0
-```
-
-### Subcommand aliases
-
-```shell
-% foo g config
-generated configuration for apps: []
-```
-
-### Callbacks
-
-Third party gems can register _before_ and _after_ callbacks to enhance a command.
-
-From the `foo` gem we have a command `hello`.
-
-```ruby
-#!/usr/bin/env ruby
-require "dry/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Dry::CLI::Registry
-
-      class Hello < Dry::CLI::Command
-        argument :name, required: true
-
-        def call(name:, **)
-          puts "hello #{name}"
-        end
-      end
-    end
-  end
-end
-
-Foo::CLI::Commands.register "hello", Foo::CLI::Commands::Hello
-
-cli = Dry::CLI.new(Foo::CLI::Commands)
-cli.call
-```
-
-The `foo-bar` gem enhances `hello` command with callbacks:
-
-```ruby
-Foo::CLI::Commands.before("hello") { |args| puts "debug: #{args.inspect}" } # syntax 1
-Foo::CLI::Commands.after "hello", &->(args) { puts "bye, #{args.fetch(:name)}" } # syntax 2
-```
-
-```shell
-% foo hello Anton
-debug: {:name=>"Anton"}
-hello Anton
-bye, Anton
-```
-
-### File Utilities
-
-File utilities is a set of useful methods to manipulate files and directories, which is opted to be required. [API doc](http://www.rubydoc.info/gems/dry-cli/Dry/CLI/Utils/Files)
-
-```ruby
-require 'dry/cli/utils/files'
-```