hanami-cli 2.0.0.alpha8.1 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26744ec7cba96a8251cd90d9589a9d0f0e291b4221af53ce951f584ced1b00c6
-  data.tar.gz: 68c47e62e9c8fc493beee084c2815b57f9b57605bcd9bba7762a124cf16a0ba3
+  metadata.gz: 8d2d0f04510c5ac3d7c729c2830997ec692f9d9be7161b199cf87fcfd1284cf3
+  data.tar.gz: 970de26f0dfdaba799141c24b72ea84ab94721d378f62c3bbbfe494e9a63c3bd
 SHA512:
-  metadata.gz: c2a419226b3050ef5fa6dc9281e3d81e16c19e905de8148f4c560fcc47687ee0e872b448a61f07b72c460bf8f993b66f4fcddec8b1d3915afd4a3129f79e6c82
-  data.tar.gz: edfbff76a5d55b406b3d3886e5f5a315716044c6ac59bbe132dda837dcf8ad8df3ce4f98110ff0c72af1c9458ba8a870e95e3ac204a6021ccf791311384d5fd5
+  metadata.gz: 5dab4fa87022146327320394b66cdd8efb18ca9c2f98eb743bc65f38017a5904a0f06db3d45aca5990e51fac27868f0e9c026feab80639bf97791353670a219b
+  data.tar.gz: 594c4c1f6fa03910543700dbcfa0ff16f5be462cc4f39b19c9918d66de3b071beeb9e8b187ae39d3f55285296126d1378a188cd87b08d575d00d9ef1a0b21ffd

data/CHANGELOG.md

@@ -1,46 +1,71 @@
 # Hanami::CLI
+
 Hanami Command Line Interface
 
-## v2.0.0.alpha8.1 - 2020-05-23
+## v2.0.0.beta1 - 2022-07-20
+
+### Added
+
+- [Luca Guidi] Implemented `hanami new` to generate a new Hanami app
+- [Piotr Solnica] Implemented `hanami console` to start an interactive console (REPL)
+- [Marc Busque] Implemented `hanami server` to start a HTTP server based on Rack
+- [Marc Busque] Implemented `hanami routes` to print app routes
+- [Luca Guidi] Implemented `hanami version` to print app Hanami version
+
+## v2.0.0.alpha8.1 - 2022-05-23
 
 ### Fixed
+
 - [Tim Riley] Ensure CLI starts properly by fixing use of `Slice.slice_name`
 
-## v2.0.0.alpha8 - 2020-05-19
+## v2.0.0.alpha8 - 2022-05-19
 
 ### Fixed
+
 - [Andrew Croome] Respect HANAMI_ENV env var to set Hanami env if no `--env` option is supplied
 - [Lucas Mendelowski] Ensure Sequel migrations extension is loaded before related `db` commands are run
 
 ## v2.0.0.alpha7 - 2022-03-11
 
 ### Changed
+
 - [Tim Riley] [Internal] Update console slice readers to work with new `Hanami::Application.slices` API
 
 ## v2.0.0.alpha6.1 - 2022-02-11
+
 ### Fixed
+
 - [Viet Tran] Ensure `hanami db` commands to work with `hanami` `v2.0.0.alpha6`
 
 ## v2.0.0.alpha6 - 2022-02-10
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 3.1
 
 ### Changed
+
 - [Luca Guidi] Drop support for Ruby: MRI 2.6, and 2.7
 
 ## v2.0.0.alpha4 - 2021-12-07
+
 ### Added
+
 - [Tim Riley] Display a custom prompt when using irb-based console (consistent with pry-based console)
 - [Phil Arndt] Support `postgresql://` URL schemes (in addition to existing `postgres://` support) for `db` subcommands
 
 ### Fixed
+
 - [Tim Riley] Ensure slice helper methods work in console (e.g. top-level `main` method will return `Main::Slice` if an app has a "main" slice defined)
 
 ## v2.0.0.alpha3 - 2021-11-09
+
 No changes.
 
 ## v2.0.0.alpha2 - 2021-05-04
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 3.0
 - [Luca Guidi] Dynamically change the set of available commands depending on the context (outside or inside an Hanami app)
 - [Luca Guidi] Dynamically change the set of available commands depending on Hanami app architecture
@@ -49,32 +74,41 @@ No changes.
 - [Piotr Solnica] Implemented `console` command with support for `IRB` and `Pry` (`pry` is auto-detected)
 
 ### Changed
+
 - [Luca Guidi] Changed the purpose of this gem: the CLI Ruby framework has been extracted into `dry-cli` gem. `hanami-cli` is now the `hanami` command line.
 - [Luca Guidi] Drop support for Ruby: MRI 2.5.
 
 ## v1.0.0.alpha1 - 2019-01-30
+
 ### Added
+
 - [Luca Guidi] Inheritng from subclasses of `Hanami::CLI::Command`, allows to inherit arguments, options, description, and examples.
 - [Luca Guidi] Allow to use `super` from `#call`
 
 ### Changed
+
 - [Luca Guidi] Drop support for Ruby: MRI 2.3, and 2.4.
 
 ## v0.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
+
 ### 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
@@ -84,21 +118,29 @@ No changes.
 ## 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
+
 ### Added
+
 - [Anton Davydov] Register `before`/`after` callbacks for commands
 
 ## v0.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
 
@@ -109,13 +151,18 @@ No changes.
 ## 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
+
 ### 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

data/Gemfile

@@ -8,9 +8,8 @@ unless ENV["CI"]
   gem "yard",   require: false
 end
 
-gem "hanami", require: false, git: "https://github.com/hanami/hanami.git", branch: "main"
-gem "hanami-router", require: false, git: "https://github.com/hanami/router.git", branch: "main"
-gem "hanami-view", require: false, git: "https://github.com/hanami/view.git", branch: "main"
+gem "hanami", require: false, github: "hanami/hanami", branch: :main
+gem "hanami-router", github: "hanami/router", branch: :main
 
 gem "rack"
 

data/README.md

@@ -2,23 +2,25 @@
 
 CLI commands for [full-stack Hanami applications](`https://github.com/hanami/hanami`).
 
-**NOTE**: For versions 0.4 and below, there was a general purpose CLI utility library with this same name. That library has since been renamed to [dry-rb/cli](https://github.com/dry-rb/dry-cli). Please update your Gemfiles accordingly.
+**NOTE**: For versions 0.4 and below, there was a general purpose CLI utility library with this same name. That library has since been renamed to [dry-rb/dry-cli](https://github.com/dry-rb/dry-cli). Please update your Gemfiles accordingly.
 
-## Installation
+## Status
 
-Add this line to your application's Gemfile:
+[![Gem Version](https://badge.fury.io/rb/hanami-cli.svg)](https://badge.fury.io/rb/hanami-cli)
+[![CI](https://github.com/hanami/cli/workflows/ci/badge.svg?branch=main)](https://github.com/hanami/cli/actions?query=workflow%3Aci+branch%3Amain)
+[![Depfu](https://badges.depfu.com/badges/a8545fb67cf32a2c75b6227bc0821027/overview.svg)](https://depfu.com/github/hanami/cli?project=Bundler)
 
-```ruby
-gem 'hanami-cli'
-```
+## Contact
 
-And then execute:
+- Home page: http://hanamirb.org
+- Mailing List: http://hanamirb.org/mailing-list
+- Bugs/Issues: https://github.com/hanami/cli/issues
+- Support: http://stackoverflow.com/questions/tagged/hanami
+- Chat: http://chat.hanamirb.org
 
-    $ bundle install
+## Rubies
 
-Or install it yourself as:
-
-    $ gem install hanami-cli
+**Hanami::RSpec** supports Ruby (MRI) 3.0+
 
 ## Usage
 

data/hanami-cli.gemspec

@@ -32,10 +32,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bundler", "~> 2.1"
   spec.add_dependency "rake", "~> 13.0"
-  spec.add_dependency "dry-cli", "~> 0.6"
-  spec.add_dependency "dry-files", "~> 0.1"
+  spec.add_dependency "dry-cli", "~> 0.7"
+  spec.add_dependency "dry-files", "~> 0.2", ">= 0.2.0"
   spec.add_dependency "dry-inflector", "~> 0.2"
 
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "puma"
 end

data/lib/hanami/cli/bundler.rb

@@ -16,7 +16,7 @@ module Hanami
       private_constant :DEFAULT_GEMFILE_PATH
 
       def self.require(*groups)
-        return unless File.exist?(ENV[BUNDLE_GEMFILE] || DEFAULT_GEMFILE_PATH)
+        return unless File.exist?(ENV.fetch(BUNDLE_GEMFILE) { DEFAULT_GEMFILE_PATH })
 
         ::Bundler.require(*groups)
       end
@@ -57,13 +57,9 @@ module Hanami
 
       # Adapted from https://stackoverflow.com/a/5471032/498386
       def which(cmd)
-        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
-
         ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
-          exts.each do |ext|
-            exe = fs.join(path, "#{cmd}#{ext}")
-            return exe if fs.executable?(exe) && !fs.directory?(exe)
-          end
+          exe = fs.join(path, cmd)
+          return exe if fs.executable?(exe) && !fs.directory?(exe)
         end
 
         nil

data/lib/hanami/cli/commands/app/command.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "dry/files"
+require_relative "../db/utils/database"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        class Command < Hanami::CLI::Command
+          module Environment
+            def call(**opts)
+              env = opts[:env]
+
+              hanami_env = env ? env.to_s : ENV.fetch("HANAMI_ENV", "development")
+
+              ENV["HANAMI_ENV"] = hanami_env
+
+              super(**opts)
+            end
+          end
+
+          def self.inherited(klass)
+            super
+            klass.option(:env, required: false, desc: "App's environment")
+            klass.prepend(Environment)
+          end
+
+          def app
+            @app ||=
+              begin
+                require "hanami/prepare"
+                Hanami.app
+              end
+          end
+
+          def run_command(klass, *args)
+            klass.new(
+              out: out,
+              inflector: app.inflector,
+              fs: Dry::Files
+            ).call(*args)
+          end
+
+          def measure(desc)
+            start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            result = yield
+            stop = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+            if result
+              out.puts "=> #{desc} in #{(stop - start).round(4)}s"
+            else
+              out.puts "!!! => #{desc.inspect} FAILED"
+            end
+          end
+
+          def database
+            @database ||= Commands::DB::Utils::Database[app]
+          end
+
+          def database_config
+            database.config
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/{monolith → app}/console.rb

@@ -2,14 +2,14 @@
 
 require "hanami/console/context"
 
-require_relative "../application"
+require_relative "../app/command"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         # @api public
-        class Console < Application
+        class Console < App::Command
           REPLS = {
             "pry" => -> (*args) {
               begin
@@ -23,7 +23,7 @@ module Hanami
             },
           }.freeze
 
-          desc "Application REPL"
+          desc "App REPL"
 
           option :repl, required: false, desc: "REPL gem that should be used ('pry' or 'irb')"
 
@@ -37,9 +37,9 @@ module Hanami
 
           def resolve_engine(repl, opts)
             if repl
-              REPLS.fetch(repl).(application, opts)
+              REPLS.fetch(repl).(app, opts)
             else
-              REPLS.map { |(_, loader)| loader.(application, opts) }.compact.first
+              REPLS.map { |(_, loader)| loader.(app, opts) }.compact.first
             end
           end
         end

data/lib/hanami/cli/commands/{monolith → app}/db/create.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Create < Application
+          class Create < App::Command
             desc "Create database"
 
             def call(**)

data/lib/hanami/cli/commands/{monolith → app}/db/create_migration.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 require_relative "structure/dump"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class CreateMigration < Application
+          class CreateMigration < App::Command
             desc "Create new migration file"
 
             argument :name, desc: "Migration file name"

data/lib/hanami/cli/commands/{monolith → app}/db/drop.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Drop < Application
+          class Drop < App::Command
             desc "Delete database"
 
             def call(**)

data/lib/hanami/cli/commands/{monolith → app}/db/migrate.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 require_relative "structure/dump"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Migrate < Application
+          class Migrate < App::Command
             desc "Migrates database"
 
             option :target, desc: "Target migration number", aliases: ["-t"]
 
             def call(target: nil, **)
-              return true if Dir[File.join(application.root, "db/migrate/*.rb")].empty?
+              return true if Dir[File.join(app.root, "db/migrate/*.rb")].empty?
 
               measure "database #{database.name} migrated" do
                 if target

data/lib/hanami/cli/commands/{monolith → app}/db/reset.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 require_relative "create"
 require_relative "drop"
 require_relative "migrate"
@@ -8,9 +8,9 @@ require_relative "migrate"
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Reset < Application
+          class Reset < App::Command
             desc "Drop, create, and migrate database"
 
             def call(**)

data/lib/hanami/cli/commands/{monolith → app}/db/rollback.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 require_relative "structure/dump"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Rollback < Application
+          class Rollback < App::Command
             desc "Rollback database to a previous migration"
 
             option :target, desc: "Target migration number", aliases: ["-t"]
@@ -32,7 +32,7 @@ module Hanami
             private
 
             def find_migration(code)
-              migration = database.applied_migrations.yield_self { |migrations|
+              migration = database.applied_migrations.then { |migrations|
                 if code
                   migrations.detect { |m| m.split("_").first == code }
                 else

data/lib/hanami/cli/commands/{monolith → app}/db/sample_data.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 require_relative "structure/dump"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class SampleData < Application
+          class SampleData < App::Command
             FILE_PATH = "db/sample_data.rb"
 
             desc "Load sample data"
@@ -26,7 +26,7 @@ module Hanami
             private
 
             def full_file_path
-              File.join(application.root, FILE_PATH)
+              File.join(app.root, FILE_PATH)
             end
 
             def has_file?

data/lib/hanami/cli/commands/{monolith → app}/db/seed.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 require_relative "structure/dump"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Seed < Application
+          class Seed < App::Command
             FILE_PATH = "db/seeds.rb"
 
             desc "Load seed data"
@@ -26,7 +26,7 @@ module Hanami
             private
 
             def full_file_path
-              File.join(application.root, FILE_PATH)
+              File.join(app.root, FILE_PATH)
             end
 
             def has_file?

data/lib/hanami/cli/commands/{monolith → app}/db/setup.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 require_relative "create"
 require_relative "migrate"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Setup < Application
+          class Setup < App::Command
             desc "Setup database"
 
             def call(**)

data/lib/hanami/cli/commands/{monolith → app}/db/structure/dump.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "../../../application"
+require_relative "../../../app/command"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
           module Structure
-            class Dump < Application
+            class Dump < App::Command
               desc "Dumps database structure to db/structure.sql file"
 
               def call(*)

data/lib/hanami/cli/commands/{monolith → app}/db/version.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "../../application"
+require_relative "../../app/command"
 
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module DB
-          class Version < Application
+          class Version < App::Command
             desc "Print schema version"
 
             option :target, desc: "Target migration number", aliases: ["-t"]

data/lib/hanami/cli/commands/{monolith → app}/generate/action.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "hanami/cli/command"
-require "hanami/cli/generators/monolith/action"
+require "hanami/cli/generators/app/action"
 require "dry/inflector"
 require "dry/files"
 require "shellwords"
@@ -9,7 +9,7 @@ require "shellwords"
 module Hanami
   module CLI
     module Commands
-      module Monolith
+      module App
         module Generate
           class Action < Command
             # TODO: ideally the default format should lookup
@@ -29,7 +29,7 @@ module Hanami
                                desc: "Skip view and template generation"
 
             def initialize(fs: Dry::Files.new, inflector: Dry::Inflector.new,
-                           generator: Generators::Monolith::Action.new(fs: fs, inflector: inflector), **)
+                           generator: Generators::App::Action.new(fs: fs, inflector: inflector), **)
               @generator = generator
               super(fs: fs)
             end