hanami-cli 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4242a606852c7a1d6973b79de436a19560975ccedaa454fe0512baaae8d0d56
-  data.tar.gz: c84a8624b6488184eca17bcec24f4d875017593b901f4f9d05e8eaf3d5417db6
+  metadata.gz: a1351e33232b164c6e82ac6148e95eac2562e43dcd36f1a1d11aad61307f32da
+  data.tar.gz: 647213baac46e31addb957a6ce4d3f8b11e28e64ddb02d3cfe1569ce49015ed6
 SHA512:
-  metadata.gz: 285b881fbca99506d4d6d4d3e926f595030cfa2f86b47e078a432ed5b2c9a8e59a1c3b556bfd4a019843bdfb3f34ccd8a170371cc8ab82492a402045a16fa00a
-  data.tar.gz: 0d46f76cdb8c67263a60682ce3d216dbf57efce57a12fd0c363fe2e1cf43bc7217c7de36d604a1698e38e9e14ddbde1cc8290da2ba97d5abbb731026c3ccd823
+  metadata.gz: cb27cd6155cd93c1783402e32992104d32a41da98397ef57c0dc1b0b72edf0cb76c9203d48dc925c352f9742a16c274cf0679dc9e431c12d83ad69508478786d
+  data.tar.gz: 04cc7a076b6a66d30729ebaa28b9108cb41bd7515cd538d5a81a350b22850ff3fbefd27a0a9044130ed50bfa8dc34562ab6e32e57834924cc7c3e51a13468708

data/.rubocop.yml

@@ -16,6 +16,8 @@ Naming/HeredocDelimiterNaming:
 Naming/MethodParameterName:
   AllowedNames:
     - fs
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
 Style/AccessorGrouping:
   Enabled: false
 Style/BlockDelimiters:

data/.yardopts

@@ -0,0 +1,3 @@
+--markup=markdown
+
+--plugin junk

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 Hanami Command Line Interface
 
+## v2.0.0 - 2022-11-22
+
+### Added
+
+- [Tim Riley] Use Zeitwerk to autoload the gem
+
+### Fixed
+
+- [Luca Guidi] In case of internal exception, don't print the stack trace to stderr, print the error message, exit with 1.
+- [Tim Riley] Ensure to be able to run `hanami` CLI in Hanami app subdirectories.
+- [Sean Collins] Return an error when trying to run `hanami new` with an existing target path (file or directory)
+
 ## v2.0.0.rc1 - 2022-11-08
 
 ## v2.0.0.beta4 - 2022-10-24

data/Gemfile

@@ -4,12 +4,11 @@ source "https://rubygems.org"
 gemspec
 
 unless ENV["CI"]
-  gem "byebug", require: false, platforms: :mri
-  gem "yard",   require: false
+  gem "byebug", platforms: :mri
+  gem "yard"
+  gem "yard-junk"
 end
 
-gem "dry-system", "~> 1.0.0.rc1"
-
 gem "hanami", github: "hanami/hanami", branch: "main"
 gem "hanami-utils", github: "hanami/utils", branch: "main"
 gem "hanami-router", github: "hanami/router", branch: "main"

data/exe/hanami

@@ -7,4 +7,9 @@ require "hanami/cli"
 cli = Dry::CLI.new(Hanami::CLI)
 Hanami::CLI::Bundler.require(:cli)
 
-cli.call
+begin
+  cli.call
+rescue Hanami::CLI::Error => exception
+  $stderr.puts(exception.message) # rubocop:disable Style/StderrPuts
+  exit(1)
+end

data/hanami-cli.gemspec

@@ -31,10 +31,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.0"
 
   spec.add_dependency "bundler", "~> 2.1"
-  spec.add_dependency "rake", "~> 13.0"
   spec.add_dependency "dry-cli", "~> 1.0", "< 2"
-  spec.add_dependency "dry-files", "~> 1.0", "< 2"
+  spec.add_dependency "dry-files", "~> 1.0", ">= 1.0.1", "< 2"
   spec.add_dependency "dry-inflector", "~> 1.0", "< 2"
+  spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rubocop", "~> 1.0"

data/lib/hanami/cli/bundler.rb

@@ -5,58 +5,148 @@ require "open3"
 require "etc"
 require "dry/files"
 require_relative "./system_call"
+require_relative "./errors"
 
 module Hanami
   module CLI
+    # Conveniences for running `bundler` from CLI commands.
+    #
+    # @since 2.0.0
+    # @api public
     class Bundler
+      # @since 2.0.0
+      # @api private
       BUNDLE_GEMFILE = "BUNDLE_GEMFILE"
       private_constant :BUNDLE_GEMFILE
 
+      # @since 2.0.0
+      # @api private
       DEFAULT_GEMFILE_PATH = "Gemfile"
       private_constant :DEFAULT_GEMFILE_PATH
 
+      # If a `Gemfile` exists, sets up the Bundler environment and loads all the gems from the given
+      # groups.
+      #
+      # This can be called multiple times with different groups.
+      #
+      # This is a convenience wrapper for `Bundler.require`.
+      #
+      # @see https://rubydoc.info/gems/bundler/Bundler#require-class_method
+      #
+      # @return [void]
+      #
+      # @since 2.0.0
+      # @api public
       def self.require(*groups)
         return unless File.exist?(ENV.fetch(BUNDLE_GEMFILE) { DEFAULT_GEMFILE_PATH })
 
         ::Bundler.require(*groups)
       end
 
+      # Returns a new bundler.
+      #
+      # @param fs [Dry::Files] the filesystem interaction object
+      # @param system_call [SystemCall] convenience object for making system calls
+      #
+      # @since 2.0.0
+      # @api public
       def initialize(fs: Dry::Files.new, system_call: SystemCall.new)
         @fs = fs
         @system_call = system_call
       end
 
+      # Runs `bundle install` for the Hanami app.
+      #
+      # @return [SystemCall::Result] the result of the `bundle` command execution
+      #
+      # @since 2.0.0
+      # @api public
       def install
         parallelism_level = Etc.nprocessors
         bundle "install --jobs=#{parallelism_level} --quiet --no-color"
       end
 
+      # Runs `bundle install` for the Hanami app and raises an error if the command does not execute
+      # successfully.
+      #
+      # @return [SystemCall::Result] the result of the `bundle` command execution
+      #
+      # @raise [StandardError] if the `bundle` command does not execute successfully
+      #
+      # @since 2.0.0
+      # @api public
       def install!
         install.tap do |result|
-          raise "Bundle install failed\n\n\n#{result.err.inspect}" unless result.successful?
+          raise BundleInstallError.new(result.err) unless result.successful?
         end
       end
 
+      # Executes the given command prefixed by `bundle exec`.
+      #
+      # @return [SystemCall::Result] the result of the command execution
+      #
+      # @since 2.0.0
+      # @api public
       def exec(cmd, env: nil, &blk)
         bundle("exec #{cmd}", env: env, &blk)
       end
 
-      def bundle(cmd, env: nil, &blk)
+      # Executes the given command prefixed by `bundle`.
+      #
+      # This is how you should execute all bundle subcommands.
+      #
+      # @param cmd [String] the commands to prefix with `bundle`
+      # @param env [Hash<String, String>] an optional hash of environment variables to set before
+      #   executing the command
+      #
+      # @overload bundle(cmd, env: nil)
+      #
+      # @overload bundle(cmd, env: nil, &blk)
+      #   Executes the command and passes the given block to the `Open3.popen3` method called
+      #   internally.
+      #
+      #   @example
+      #     bundle("info") do |stdin, stdout, stderr, wait_thread|
+      #       # ...
+      #     end
+      #
+      # @see SystemCall#call
+      #
+      # @since 2.0.0
+      # @api public
+      def bundle(cmd, env: nil, &block)
         bundle_bin = which("bundle")
         hanami_env = "HANAMI_ENV=#{env} " unless env.nil?
 
-        system_call.call("#{hanami_env}#{bundle_bin} #{cmd}",
-                         env: {BUNDLE_GEMFILE => fs.expand_path(DEFAULT_GEMFILE_PATH)}, &blk)
+        system_call.call(
+          "#{hanami_env}#{bundle_bin} #{cmd}",
+          env: {BUNDLE_GEMFILE => fs.expand_path(DEFAULT_GEMFILE_PATH)},
+          &block
+        )
       end
 
       private
 
+      # @return [Dry::Files]
+      #
+      # @since 2.0.0
+      # @api public
       attr_reader :fs
 
+      # @return [SystemCall]
+      #
+      # @since 2.0.0
+      # @api public
       attr_reader :system_call
 
-      # Adapted from https://stackoverflow.com/a/5471032/498386
+      # Returns the full path to the given executable, or nil if not found in the path.
+      #
+      # @return [Pathname, nil]
+      #
+      # @since 2.0.0
+      # @api private
       def which(cmd)
+        # Adapted from https://stackoverflow.com/a/5471032/498386
         ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
           exe = fs.join(path, cmd)
           return exe if fs.executable?(exe) && !fs.directory?(exe)

data/lib/hanami/cli/command.rb

@@ -6,7 +6,24 @@ require "dry/inflector"
 
 module Hanami
   module CLI
+    # Base class for `hanami` CLI commands.
+    #
+    # @api public
+    # @since 2.0.0
     class Command < Dry::CLI::Command
+      # Returns a new command.
+      #
+      # This method does not need to be called directly when creating comments for the CLI. Commands
+      # are registered as classes, and the CLI framework will initialize the command when needed.
+      # This means that all parameters for `#initialize` should also be given default arguments.
+      #
+      # @param out [IO] I/O stream for standard command output
+      # @param err [IO] I/O stream for comment errror output
+      # @param fs [Dry::Files] object for managing file system interactions
+      # @param inflector [Dry::Inflector] inflector for any command-level inflections
+      #
+      # @since 2.0.0
+      # @api public
       def initialize(out: $stdout, err: $stderr, fs: Dry::Files.new, inflector: Dry::Inflector.new)
         super()
         @out = out
@@ -17,12 +34,36 @@ module Hanami
 
       private
 
+      # Returns the I/O stream for standard command output.
+      #
+      # @return [IO]
+      #
+      # @since 2.0.0
+      # @api public
       attr_reader :out
 
+      # Returns the I/O stream for command error output.
+      #
+      # @return [IO]
+      #
+      # @since 2.0.0
+      # @api public
       attr_reader :err
 
+      # Returns the object for managing file system interactions.
+      #
+      # @return [Dry::Files]
+      #
+      # @since 2.0.0
+      # @api public
       attr_reader :fs
 
+      # Returns the inflector.
+      #
+      # @return [Dry::Inflector]
+      #
+      # @since 2.0.0
+      # @api public
       attr_reader :inflector
     end
   end

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

@@ -1,16 +1,33 @@
 # frozen_string_literal: true
 
 require "dry/files"
-require_relative "../db/utils/database"
+require_relative "db/utils/database"
 
 module Hanami
   module CLI
     module Commands
       module App
+        # Base class for `hanami` CLI commands intended to be executed within an existing Hanami
+        # app.
+        #
+        # @since 2.0.0
+        # @api public
         class Command < Hanami::CLI::Command
-          ACTION_SEPARATOR = "."
+          # @since 2.0.0
+          # @api private
+          ACTION_SEPARATOR = "." # TODO: rename to container key separator
 
+          # Overloads {Hanami::CLI::Commands::App::Command#call} to ensure an appropriate `HANAMI_ENV`
+          # environment variable is set.
+          #
+          # Uses an `--env` option if provided, then falls back to an already-set `HANAMI_ENV`
+          # environment variable, and defaults to "development" in the absence of both.
+          #
+          # @since 2.0.0
+          # @api private
           module Environment
+            # @since 2.0.0
+            # @api private
             def call(*args, **opts)
               env = opts[:env]
 
@@ -22,11 +39,21 @@ module Hanami
             end
           end
 
+          # @since 2.0.0
+          # @api private
           def self.inherited(klass)
             super
             klass.prepend(Environment)
           end
 
+          # Returns the Hanami app class.
+          #
+          # @return [Hanami::App] the Hanami app
+          #
+          # @raise [Hanami::AppLoadError] if the app has not been loaded
+          #
+          # @since 2.0.0
+          # @api public
           def app
             @app ||=
               begin
@@ -35,6 +62,13 @@ module Hanami
               end
           end
 
+          # Runs another CLI command via its command class.
+          #
+          # @param klass [Hanami::CLI::Command]
+          # @param args [Array] any additional arguments to pass to the command's `#call` method.
+          #
+          # @since 2.0.0
+          # @api public
           def run_command(klass, *args)
             klass.new(
               out: out,
@@ -43,6 +77,27 @@ module Hanami
             ).call(*args)
           end
 
+          # Executes a given block and prints string to the `out` stream with details of the time
+          # taken to execute.
+          #
+          # If the block returns a falsey value, then a failure message is printed.
+          #
+          # @example
+          #   measure("Reverse the polarity of the neutron flow") do
+          #     # reverses the polarity, returns a truthy value
+          #   end
+          #   # printed to `out`:
+          #   # => Reverse the polarity of the neutron flow in 2s
+          #
+          # @example
+          #   measure("Disable the time dilation device") do
+          #     # attempts to disable the device, returns a falsey favlue
+          #   end
+          #   # printed to `out`:
+          #   # !!! => Disable the time dilation device FAILED
+          #
+          # @since 2.0.0
+          # @api public
           def measure(desc)
             start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             result = yield
@@ -55,10 +110,16 @@ module Hanami
             end
           end
 
+          # This is NOT AVAILABLE as of the 2.0.0 release.
+          #
+          # @api private
           def database
             @database ||= Commands::DB::Utils::Database[app]
           end
 
+          # This is NOT AVAILABLE as of the 2.0.0 release.
+          #
+          # @api private
           def database_config
             database.config
           end

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

@@ -8,23 +8,26 @@ module Hanami
   module CLI
     module Commands
       module App
-        # @api public
+        # @since 2.0.0
+        # @api private
         class Console < App::Command
+          # @since 2.0.0
+          # @api private
           ENGINES = {
             "pry" => -> (*args) {
               begin
-                require "hanami/cli/repl/pry"
                 Repl::Pry.new(*args)
               rescue LoadError # rubocop:disable Lint/SuppressedException
               end
             },
             "irb" => -> (*args) {
-              require "hanami/cli/repl/irb"
               Repl::Irb.new(*args)
             },
           }.freeze
           private_constant :ENGINES
 
+          # @since 2.0.0
+          # @api private
           DEFAULT_ENGINE = "irb"
           private_constant :DEFAULT_ENGINE
 
@@ -32,6 +35,7 @@ module Hanami
 
           option :engine, required: false, desc: "Console engine", values: ENGINES.keys
 
+          # @since 2.0.0
           # @api private
           def call(engine: nil, **opts)
             console_engine = resolve_engine(engine, opts)

data/lib/hanami/cli/commands/app/db/create.rb

@@ -7,9 +7,11 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class Create < App::Command
             desc "Create database"
 
+            # @api private
             def call(**)
               if database.create_command
                 out.puts "=> database #{database.name} created"

data/lib/hanami/cli/commands/app/db/create_migration.rb

@@ -7,12 +7,15 @@ module Hanami
   module CLI
     module Commands
       module App
+        # @api private
         module DB
+          # @api private
           class CreateMigration < App::Command
             desc "Create new migration file"
 
             argument :name, desc: "Migration file name"
 
+            # @api private
             def call(name:, **)
               migrator = database.migrator
               version = migrator.generate_version

data/lib/hanami/cli/commands/app/db/drop.rb

@@ -7,9 +7,11 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class Drop < App::Command
             desc "Delete database"
 
+            # @api private
             def call(**)
               if database.drop_command
                 out.puts "=> database #{database.name} dropped"

data/lib/hanami/cli/commands/app/db/migrate.rb

@@ -8,11 +8,13 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class Migrate < App::Command
             desc "Migrates database"
 
             option :target, desc: "Target migration number", aliases: ["-t"]
 
+            # @api private
             def call(target: nil, **)
               return true if Dir[File.join(app.root, "db/migrate/*.rb")].empty?
 

data/lib/hanami/cli/commands/app/db/reset.rb

@@ -10,9 +10,11 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class Reset < App::Command
             desc "Drop, create, and migrate database"
 
+            # @api private
             def call(**)
               run_command Drop
               run_command Create

data/lib/hanami/cli/commands/app/db/rollback.rb

@@ -8,12 +8,14 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class Rollback < App::Command
             desc "Rollback database to a previous migration"
 
             option :target, desc: "Target migration number", aliases: ["-t"]
             option :dump, desc: "Dump structure after rolling back"
 
+            # @api private
             def call(target: nil, dump: true, **)
               migration_code, migration_name = find_migration(target)
 

data/lib/hanami/cli/commands/app/db/sample_data.rb

@@ -8,11 +8,13 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class SampleData < App::Command
             FILE_PATH = "db/sample_data.rb"
 
             desc "Load sample data"
 
+            # @api private
             def call(**)
               if has_file?
                 measure "sample data loaded from #{FILE_PATH}" do

data/lib/hanami/cli/commands/app/db/seed.rb

@@ -8,11 +8,13 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class Seed < App::Command
             FILE_PATH = "db/seeds.rb"
 
             desc "Load seed data"
 
+            # @api private
             def call(**)
               if has_file?
                 measure "seed data loaded from #{FILE_PATH}" do

data/lib/hanami/cli/commands/app/db/setup.rb

@@ -9,9 +9,11 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           class Setup < App::Command
             desc "Setup database"
 
+            # @api private
             def call(**)
               run_command Create
               run_command Migrate

data/lib/hanami/cli/commands/app/db/structure/dump.rb

@@ -7,10 +7,13 @@ module Hanami
     module Commands
       module App
         module DB
+          # @api private
           module Structure
+            # @api private
             class Dump < App::Command
               desc "Dumps database structure to db/structure.sql file"
 
+              # @api private
               def call(*)
                 measure("#{database.name} structure dumped to db/structure.sql") do
                   database.dump_command