hanami-cli 1.0.0.alpha1 → 2.0.0.alpha6

data/README.md

@@ -1,30 +1,6 @@
 # Hanami::CLI
 
-General purpose Command Line Interface (CLI) framework for Ruby.
-
-:warning: **This is a general framework for Ruby (aka `thor` gem replacement), NOT the implementation of the `hanami` CLI commands** :warning:
-
-## Status
-
-[![Gem Version](https://badge.fury.io/rb/hanami-cli.svg)](https://badge.fury.io/rb/hanami-cli)
-[![TravisCI](https://travis-ci.org/hanami/cli.svg?branch=master)](https://travis-ci.org/hanami/cli)
-[![CircleCI](https://circleci.com/gh/hanami/cli/tree/master.svg?style=svg)](https://circleci.com/gh/hanami/cli/tree/master)
-[![Test Coverage](https://codecov.io/gh/hanami/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/hanami/cli)
-[![Depfu](https://badges.depfu.com/badges/2c1bc076f16c6b5508334c44b5800362/overview.svg)](https://depfu.com/github/hanami/cli?project=Bundler)
-[![Inline Docs](http://inch-ci.org/github/hanami/cli.svg)](http://inch-ci.org/github/hanami/cli)
-
-## Contact
-
-* Home page: http://hanamirb.org
-* Mailing List: http://hanamirb.org/mailing-list
-* API Doc: http://rdoc.info/gems/hanami-cli
-* Bugs/Issues: https://github.com/hanami/cli/issues
-* Support: http://stackoverflow.com/questions/tagged/hanami
-* Chat: http://chat.hanamirb.org
-
-## Rubies
-
-__Hanami::CLI__ supports Ruby (MRI) 2.5+
+[Hanami](http://hanamirb.org) command line
 
 ## Installation
 
@@ -36,269 +12,7 @@ gem 'hanami-cli'
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install hanami-cli
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-## 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)
-  - [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 "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Hello < Hanami::CLI::Command
-        def call(*)
-        end
-      end
-    end
-  end
-end
-
-class Version < Hanami::CLI::Command
-  def call(*)
-  end
-end
-
-Foo::CLI::Commands.register "hi", Foo::CLI::Commands::Hello
-Foo::CLI::Commands.register "v",  Version
-
-Hanami::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 `Hanami::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 "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      module Generate
-        class Configuration < Hanami::CLI::Command
-          def call(*)
-          end
-        end
-      end
-    end
-  end
-end
-
-Foo::CLI::Commands.register "generate configuration", Foo::CLI::Commands::Generate::Configuration
-
-Hanami::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 "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Greet < Hanami::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
-
-Hanami::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 "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Request < Hanami::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
-
-Hanami::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 "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Runner < Hanami::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
-
-Hanami::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 "hanami-cli"
-```
-
-And then execute:
-
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -306,331 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-Imagine to build a CLI executable `foo` for your Ruby project.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Version < Hanami::CLI::Command
-        desc "Print version"
-
-        def call(*)
-          puts "1.0.0"
-        end
-      end
-
-      class Echo < Hanami::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 < Hanami::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 < Hanami::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 < Hanami::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 < Hanami::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 < Hanami::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
-
-Hanami::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 "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Hello < Hanami::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 = Hanami::CLI.new(Foo::CLI::Commands)
-cli.call
-```
-
-The `foo-bar` gem enhances `hello` command with callbacks:
-
-```
-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
-```
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/hanami/cli.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hanami/cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hanami/cli/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Alternatives
+## Code of Conduct
 
-  * [thor](http://whatisthor.com/)
-  * [clamp](https://github.com/mdub/clamp)
+Everyone interacting in the `Hanami::CLI` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hanami/cli/blob/main/CODE_OF_CONDUCT.md).
 
 ## Copyright
 
-Copyright © 2017-2019 Luca Guidi – Released under MIT License
+Copyright © 2014-2022 Hanami Team – Released under MIT License

data/Rakefile

@@ -1,17 +1,12 @@
 # frozen_string_literal: true
 
-require "rake"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require "hanami/devtools/rake_tasks"
 
-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")
+RSpec::Core::RakeTask.new(:spec)
 
-    task.pattern = file_list
-  end
-end
+require "rubocop/rake_task"
 
-task default: "spec:unit"
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/hanami

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hanami/cli"
+
+cli = Dry::CLI.new(Hanami::CLI)
+Hanami::CLI::Bundler.require(:cli)
+
+cli.call