hanami-cli 2.0.0.rc1 → 2.0.0

data/lib/hanami/cli/commands/gem/new.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require "hanami/cli/command"
-require "hanami/cli/bundler"
-require "hanami/cli/command_line"
-require "hanami/cli/generators/gem/app"
-require "hanami/cli/files"
 require "dry/inflector"
+require_relative "../../errors"
 
 module Hanami
   module CLI
     module Commands
       module Gem
+        # @since 2.0.0
+        # @api private
         class New < Command
           SKIP_INSTALL_DEFAULT = false
           private_constant :SKIP_INSTALL_DEFAULT
@@ -28,25 +26,27 @@ module Hanami
             "bookshelf --skip-install # Generate a new Hanami app, but it skips Hanami installation"
           ]
 
-          # rubocop:disable Metrics/ParameterLists
+          # @since 2.0.0
+          # @api private
           def initialize(
             fs: Hanami::CLI::Files.new,
             inflector: Dry::Inflector.new,
             bundler: CLI::Bundler.new(fs: fs),
-            command_line: CLI::CommandLine.new(bundler: bundler),
-            generator: Generators::Gem::App.new(fs: fs, inflector: inflector, command_line: command_line),
+            generator: Generators::Gem::App.new(fs: fs, inflector: inflector),
             **other
           )
             @bundler = bundler
-            @command_line = command_line
             @generator = generator
             super(fs: fs, inflector: inflector, **other)
           end
-          # rubocop:enable Metrics/ParameterLists
 
+          # @since 2.0.0
+          # @api private
           def call(app:, skip_install: SKIP_INSTALL_DEFAULT, **)
             app = inflector.underscore(app)
 
+            raise PathAlreadyExistsError.new(app) if fs.exist?(app)
+
             fs.mkdir(app)
             fs.chdir(app) do
               generator.call(app) do
@@ -65,12 +65,11 @@ module Hanami
           private
 
           attr_reader :bundler
-          attr_reader :command_line
           attr_reader :generator
 
           def run_install_commmand!
-            command_line.call("hanami install").tap do |result|
-              raise "hanami install failed\n\n\n#{result.err.inspect}" unless result.successful?
+            bundler.exec("hanami install").tap do |result|
+              raise HanamiInstallError.new(result.err) unless result.successful?
             end
           end
         end

data/lib/hanami/cli/commands/gem/version.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
-require "hanami/cli/command"
-
 module Hanami
   module CLI
     module Commands
       module Gem
+        # @since 2.0.0
+        # @api private
         class Version < Command
           desc "Hanami version"
 
+          # @since 2.0.0
+          # @api private
           def call(*)
             version = detect_version
             out.puts "v#{version}"

data/lib/hanami/cli/commands/gem.rb

@@ -3,14 +3,17 @@
 module Hanami
   module CLI
     module Commands
+      # Commands made available when the `hanami` CLI is executed outside of an Hanami app.
+      #
+      # @since 2.0.0
+      # @api public
       module Gem
-        require_relative "gem/version"
-        require_relative "gem/new"
-
+        # @since 2.0.0
+        # @api private
         def self.extended(base)
           base.module_eval do
-            register "version", Version, aliases: ["v", "-v", "--version"]
-            register "new", New
+            register "version", Commands::Gem::Version, aliases: ["v", "-v", "--version"]
+            register "new", Commands::Gem::New
           end
         end
       end

data/lib/hanami/cli/commands.rb

@@ -7,13 +7,29 @@ module Hanami
     # This is typically used to determine whether to register commands that are applicable either
     # inside or outside an app.
     #
-    # @api public
+    # @return [Boolean]
+    #
+    # @api private
     # @since 2.0.0
     def self.within_hanami_app?
-      File.exist?("config/app.rb") ||
-        File.exist?("app.rb")
+      require "hanami"
+
+      !!Hanami.app_path
+    rescue LoadError => e
+      raise e unless e.path == "hanami"
+
+      # If for any reason the hanami gem isn't installed, make a simple best effort to determine
+      # whether we're inside an app.
+      File.exist?("config/app.rb") || File.exist?("app.rb")
     end
 
+    # Contains the commands available for the current `hanami` CLI execution, depending on whether
+    # the CLI is executed inside or outside an Hanami app.
+    #
+    # @see .within_hanami_app?
+    #
+    # @api public
+    # @since 2.0.0
     module Commands
     end
 

data/lib/hanami/cli/errors.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    class Error < StandardError
+    end
+
+    class NotImplementedError < Error
+    end
+
+    class BundleInstallError < Error
+      def initialize(message)
+        super("`bundle install' failed\n\n\n#{message.inspect}")
+      end
+    end
+
+    class HanamiInstallError < Error
+      def initialize(message)
+        super("`hanami install' failed\n\n\n#{message.inspect}")
+      end
+    end
+
+    class PathAlreadyExistsError < Error
+      def initialize(path)
+        super("Cannot create new Hanami app in an existing path: `#{path}'")
+      end
+    end
+
+    class MissingSliceError < Error
+      def initialize(slice)
+        super("slice `#{slice}' is missing, please generate with `hanami generate slice #{slice}'")
+      end
+    end
+
+    class InvalidURLError < Error
+      def initialize(url)
+        super("invalid URL: `#{url}'")
+      end
+    end
+
+    class InvalidURLPrefixError < Error
+      def initialize(url)
+        super("invalid URL prefix: `#{url}'")
+      end
+    end
+
+    class InvalidActionNameError < Error
+      def initialize(name)
+        super("cannot parse controller and action name: `#{name}'\n\texample: `hanami generate action users.show'")
+      end
+    end
+
+    class UnknownHTTPMethodError < Error
+      def initialize(name)
+        super("unknown HTTP method: `#{name}'")
+      end
+    end
+
+    class UnsupportedDatabaseSchemeError < Error
+      def initialize(scheme)
+        super("`#{scheme}' is not a supported db scheme")
+      end
+    end
+  end
+end

data/lib/hanami/cli/files.rb

@@ -2,12 +2,18 @@
 
 module Hanami
   module CLI
+    # @since 2.0.0
+    # @api private
     class Files < Dry::Files
+      # @since 2.0.0
+      # @api private
       def initialize(out: $stdout, **args)
         super(**args)
         @out = out
       end
 
+      # @since 2.0.0
+      # @api private
       def write(path, *content)
         already_exists = exist?(path)
         super
@@ -18,6 +24,8 @@ module Hanami
         end
       end
 
+      # @since 2.0.0
+      # @api private
       def mkdir(path)
         unless exist?(path)
           super
@@ -25,6 +33,8 @@ module Hanami
         end
       end
 
+      # @since 2.0.0
+      # @api private
       def chdir(path, &blk)
         within_folder(path)
         super

data/lib/hanami/cli/generators/app/action.rb

@@ -2,22 +2,27 @@
 
 require "erb"
 require "dry/files"
-require "hanami/cli/files"
-require "hanami/cli/generators/app/action_context"
-require "hanami/cli/url"
+require_relative "../../errors"
 
 # rubocop:disable Metrics/ParameterLists
 module Hanami
   module CLI
     module Generators
       module App
+        # @since 2.0.0
+        # @api private
         class Action
+          # @since 2.0.0
+          # @api private
           def initialize(fs:, inflector:)
             @fs = fs
             @inflector = inflector
           end
 
           # rubocop:disable Layout/LineLength
+
+          # @since 2.0.0
+          # @api private
           def call(app, controller, action, url, http, format, skip_view, slice, context: ActionContext.new(inflector, app, slice, controller, action))
             if slice
               generate_for_slice(controller, action, url, http, format, skip_view, slice, context)
@@ -25,6 +30,7 @@ module Hanami
               generate_for_app(controller, action, url, http, format, skip_view, context)
             end
           end
+
           # rubocop:enable Layout/LineLength
 
           private
@@ -62,7 +68,7 @@ module Hanami
 
           def generate_for_slice(controller, action, url, http, _format, _skip_view, slice, context)
             slice_directory = fs.join("slices", slice)
-            raise ArgumentError.new("slice not found `#{slice}'") unless fs.directory?(slice_directory)
+            raise MissingSliceError.new(slice) unless fs.directory?(slice_directory)
 
             fs.inject_line_at_block_bottom(
               fs.join("config", "routes.rb"),
@@ -132,7 +138,7 @@ module Hanami
             result = (http ||= ROUTE_RESTFUL_HTTP_METHODS.fetch(action, ROUTE_DEFAULT_HTTP_METHOD)).downcase
 
             unless ROUTE_HTTP_METHODS.include?(result)
-              raise ArgumentError.new("unknown HTTP method: `#{http}'")
+              raise UnknownHTTPMethodError.new(http)
             end
 
             result

data/lib/hanami/cli/generators/app/action_context.rb

@@ -6,50 +6,72 @@ require "dry/files/path"
 module Hanami
   module CLI
     module Generators
+      # @since 2.0.0
+      # @api private
       module App
+        # @since 2.0.0
+        # @api private
         class ActionContext < SliceContext
+          # @since 2.0.0
+          # @api private
           def initialize(inflector, app, slice, controller, action)
             @controller = controller
             @action = action
             super(inflector, app, slice, nil)
           end
 
+          # @since 2.0.0
+          # @api private
           def camelized_controller_name
             controller.map do |token|
               inflector.camelize(token)
             end.join(NAMESPACE_SEPARATOR)
           end
 
+          # @since 2.0.0
+          # @api private
           def camelized_action_name
             inflector.camelize(action)
           end
 
+          # @since 2.0.0
+          # @api private
           def underscored_controller_name
             controller.map do |token|
               inflector.underscore(token)
             end
           end
 
+          # @since 2.0.0
+          # @api private
           def underscored_action_name
             inflector.underscore(action)
           end
 
+          # @since 2.0.0
+          # @api private
           def module_controller_declaration
             controller.each_with_index.map do |token, i|
               "#{OFFSET}#{INDENTATION * i}module #{inflector.camelize(token)}"
             end.join($/)
           end
 
+          # @since 2.0.0
+          # @api private
           def module_controller_end
             controller.each_with_index.map do |_, i|
               "#{OFFSET}#{INDENTATION * i}end"
             end.reverse.join($/)
           end
 
+          # @since 2.0.0
+          # @api private
           def module_controller_offset
             "#{OFFSET}#{INDENTATION * controller.count}"
           end
 
+          # @since 2.0.0
+          # @api private
           def template_path
             Dry::Files::Path["slices", underscored_slice_name, "templates", *underscored_controller_name,
                              "#{underscored_action_name}.html.erb"]

data/lib/hanami/cli/generators/app/slice.rb

@@ -2,18 +2,23 @@
 
 require "erb"
 require "dry/files"
-require "hanami/cli/generators/app/slice_context"
 
 module Hanami
   module CLI
     module Generators
       module App
+        # @since 2.0.0
+        # @api private
         class Slice
+          # @since 2.0.0
+          # @api private
           def initialize(fs:, inflector:)
             @fs = fs
             @inflector = inflector
           end
 
+          # @since 2.0.0
+          # @api private
           def call(app, slice, url, context: SliceContext.new(inflector, app, slice, url))
             fs.inject_line_at_class_bottom(
               fs.join("config", "routes.rb"), "class Routes", t("routes.erb", context).chomp

data/lib/hanami/cli/generators/app/slice_context.rb

@@ -6,17 +6,25 @@ module Hanami
   module CLI
     module Generators
       module App
+        # @since 2.0.0
+        # @api private
         class SliceContext < Generators::Context
+          # @since 2.0.0
+          # @api private
           def initialize(inflector, app, slice, url)
             @slice = slice
             @url = url
             super(inflector, app)
           end
 
+          # @since 2.0.0
+          # @api private
           def camelized_slice_name
             inflector.camelize(slice)
           end
 
+          # @since 2.0.0
+          # @api private
           def underscored_slice_name
             inflector.underscore(slice)
           end

data/lib/hanami/cli/generators/context.rb

@@ -4,25 +4,39 @@ require_relative "./version"
 
 module Hanami
   module CLI
+    # @since 2.0.0
+    # @api private
     module Generators
+      # @since 2.0.0
+      # @api private
       class Context
+        # @since 2.0.0
+        # @api private
         def initialize(inflector, app)
           @inflector = inflector
           @app = app
         end
 
+        # @since 2.0.0
+        # @api private
         def ctx
           binding
         end
 
+        # @since 2.0.0
+        # @api private
         def hanami_version
           Version.gem_requirement
         end
 
+        # @since 2.0.0
+        # @api private
         def camelized_app_name
           inflector.camelize(app)
         end
 
+        # @since 2.0.0
+        # @api private
         def underscored_app_name
           inflector.underscore(app)
         end

data/lib/hanami/cli/generators/gem/app.rb

@@ -2,20 +2,26 @@
 
 require "erb"
 require "shellwords"
-require "hanami/cli/generators/context"
 
 module Hanami
   module CLI
     module Generators
+      # @since 2.0.0
+      # @api private
       module Gem
+        # @since 2.0.0
+        # @api private
         class App
-          def initialize(fs:, inflector:, command_line:)
+          # @since 2.0.0
+          # @api private
+          def initialize(fs:, inflector:)
             super()
             @fs = fs
             @inflector = inflector
-            @command_line = command_line
           end
 
+          # @since 2.0.0
+          # @api private
           def call(app, context: Context.new(inflector, app), &blk)
             generate_app(app, context)
             blk.call
@@ -27,8 +33,6 @@ module Hanami
 
           attr_reader :inflector
 
-          attr_reader :command_line
-
           def generate_app(app, context) # rubocop:disable Metrics/AbcSize
             fs.write(".env", t("env.erb", context))
 

data/lib/hanami/cli/generators/version.rb

@@ -3,6 +3,8 @@
 module Hanami
   module CLI
     module Generators
+      # @since 2.0.0
+      # @api private
       module Version
         # @since 2.0.0
         # @api private
@@ -30,22 +32,22 @@ module Hanami
           version =~ /alpha|beta|rc/
         end
 
-        # @since 2.0.0
-        # @api private
-        #
         # @example
         #   Hanami::VERSION # => 2.0.0
         #   Hanami::CLI::Generators::Version.stable_version # => "2.0"
+        #
+        # @since 2.0.0
+        # @api private
         def self.stable_version
           version.scan(/\A\d{1,2}\.\d{1,2}/).first
         end
 
-        # @since 2.0.0
-        # @api private
-        #
         # @example
         #   Hanami::VERSION # => 2.0.0.alpha8.1
         #   Hanami::CLI::Generators::Version.stable_version # => "2.0.0.alpha"
+        #
+        # @since 2.0.0
+        # @api private
         def self.prerelease_version
           version.sub(/[[[:digit:]].]*\Z/, "")
         end

data/lib/hanami/cli/middleware_stack_inspector.rb

@@ -2,12 +2,17 @@
 
 module Hanami
   module CLI
+    # @since 2.0.0
     # @api private
     class MiddlewareStackInspector
+      # @since 2.0.0
+      # @api private
       def initialize(stack:)
         @stack = stack
       end
 
+      # @since 2.0.0
+      # @api private
       def inspect(include_arguments: false)
         max_path_length = @stack.map { |(path)| path.length }.max
 

data/lib/hanami/cli/rake_tasks.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rake"
-require "hanami/cli/bundler"
 
 module Hanami
   module CLI

data/lib/hanami/cli/repl/core.rb

@@ -1,50 +1,58 @@
 # frozen_string_literal: true
 
 require "hanami/console/context"
+require_relative "../errors"
 
 module Hanami
   module CLI
+    # @since 2.0.0
+    # @api private
     module Repl
+      # @since 2.0.0
       # @api private
       class Core
-        # @api private
         attr_reader :app
-
-        # @api private
         attr_reader :opts
 
+        # @since 2.0.0
         # @api private
         def initialize(app, opts)
           @app = app
           @opts = opts
         end
 
+        # @since 2.0.0
         # @api private
         def start
-          raise NotImplementedError
+          raise Hanami::CLI::NotImplementedError
         end
 
+        # @since 2.0.0
         # @api private
         def context
           @context ||= Hanami::Console::Context.new(app)
         end
 
+        # @since 2.0.0
         # @api private
         def prompt
           "#{name}[#{env}]"
         end
 
+        # @since 2.0.0
         # @api private
         def name
           (app.container.config.name || inflector.underscore(app.name))
             .to_s.split("/")[0]
         end
 
+        # @since 2.0.0
         # @api private
         def env
           app.container.env
         end
 
+        # @since 2.0.0
         # @api private
         def inflector
           app.inflector

data/lib/hanami/cli/repl/irb.rb

@@ -7,9 +7,10 @@ module Hanami
   module CLI
     module Repl
       # @since 2.0.0
-      # @api public
+      # @api private
       class Irb < Core
-        # @api public
+        # @since 2.0.0
+        # @api private
         def start
           $stdout.sync = true
 

data/lib/hanami/cli/repl/pry.rb

@@ -7,13 +7,11 @@ module Hanami
   module CLI
     module Repl
       # @since 2.0.0
-      # @api public
+      # @api private
       class Pry < Core
-        # @api private
         class Context
         end
 
-        # @api public
         def start
           ::Pry.config.prompt = ::Pry::Prompt.new(
             "hanami",