hanami-cli 2.0.0.beta4 → 2.0.0

data/lib/hanami/cli/server.rb

@@ -2,25 +2,36 @@
 
 module Hanami
   module CLI
+    # @since 2.0.0
     # @api private
     class Server
+      # @since 2.0.0
+      # @api private
       attr_reader :rack_server
 
+      # @since 2.0.0
+      # @api private
       RACK_FALLBACK_OPTIONS = {
         host: :Host,
         port: :Port
       }.freeze
 
+      # @since 2.0.0
+      # @api private
       OVERRIDING_OPTIONS = {
         config: :config,
         debug: :debug,
         warn: :warn
       }.freeze
 
+      # @since 2.0.0
+      # @api private
       def initialize(rack_server: Rack::Server)
         @rack_server = rack_server
       end
 
+      # @since 2.0.0
+      # @api private
       def call(**options)
         rack_server.start(Hash[
           extract_rack_fallback_options(options) + extract_overriding_options(options)

data/lib/hanami/cli/system_call.rb

@@ -1,33 +1,90 @@
 # frozen_string_literal: true
 
+# SystemCall#call is adapted from hanami-devtools as well as the Bundler source code. Bundler is
+# released under the MIT license: https://github.com/bundler/bundler/blob/master/LICENSE.md.
+#
+# Thank you to the Bundler maintainers and contributors.
+
 module Hanami
   module CLI
+    # Facility for making convenient system calls and returning their results.
+    #
+    # @since 2.0.0
+    # @api public
     class SystemCall
+      # The result of a system call. Provides access to its standard out and error streams, plus
+      # whether the command executed successfully.
+      #
+      # @since 2.0.0
+      # @api public
       class Result
         SUCCESSFUL_EXIT_CODE = 0
         private_constant :SUCCESSFUL_EXIT_CODE
 
-        attr_reader :exit_code, :out, :err
+        # Returns the command's exit code
+        #
+        # @return [Integer]
+        #
+        # @since 2.0.0
+        # @api public
+        attr_reader :exit_code
+
+        # Returns the command's standard output stream
+        #
+        # @return [IO]
+        #
+        # @since 2.0.0
+        # @api public
+        attr_reader :out
+
+        # Returns the command's error ouptut stream
+        #
+        # @return [IO]
+        #
+        # @since 2.0.0
+        # @api public
+        attr_reader :err
 
+        # @since 2.0.0
+        # @api private
         def initialize(exit_code:, out:, err:)
           @exit_code = exit_code
           @out = out
           @err = err
         end
 
+        # Returns true if the command executed successfully (if its {#exit_code} is 0).
+        #
+        # @return [Boolean]
+        #
+        # @since 2.0.0
+        # @api public
         def successful?
           exit_code == SUCCESSFUL_EXIT_CODE
         end
       end
 
-      # Adapted from Bundler source code
+      # Executes the given system command and returns the result.
       #
-      # Bundler is released under MIT license
-      # https://github.com/bundler/bundler/blob/master/LICENSE.md
+      # @param cmd [String] the system command to execute
+      # @param env [Hash<String, String>] an optional hash of environment variables to set before
+      #   executing the command
       #
-      # A special "thank you" goes to Bundler maintainers and contributors.
+      # @overload call(cmd, env: {})
       #
-      # Also adapted from `hanami-devtools` source code
+      # @overload call(cmd, env: {}, &blk)
+      #   Executes the command and passes the given block to the `Open3.popen3` method called
+      #   internally.
+      #
+      #   @example
+      #     call("info") do |stdin, stdout, stderr, wait_thread|
+      #       # ...
+      #     end
+      #
+      # @return [Result]
+      #
+      # @since 2.0.0
+      # @api public
       def call(cmd, env: {})
         exitstatus = nil
         out = nil
@@ -35,7 +92,8 @@ module Hanami
 
         ::Bundler.with_unbundled_env do
           Open3.popen3(env, cmd) do |stdin, stdout, stderr, wait_thr|
-            yield stdin, stdout, wait_thr if block_given?
+            yield stdin, stdout, stderr, wait_thr if block_given?
+
             stdin.close
 
             exitstatus = wait_thr&.value&.exitstatus

data/lib/hanami/cli/url.rb

@@ -1,28 +1,35 @@
 # frozen_string_literal: true
 
 require "uri"
+require_relative "./errors"
 
 module Hanami
   module CLI
+    # @since 2.0.0
+    # @api private
     module URL
       DEFAULT_URL_PREFIX = "/"
       private_constant :DEFAULT_URL_PREFIX
 
       class << self
+        # @since 2.0.0
+        # @api private
         def call(url)
           result = url
           result = URI.parse(result).path
 
           unless valid?(result)
-            raise ArgumentError.new("invalid URL: `#{url}'")
+            raise InvalidURLError.new(url)
           end
 
           result
         rescue URI::InvalidURIError
-          raise ArgumentError.new("invalid URL: `#{url}'")
+          raise InvalidURLError.new(url)
         end
         alias_method :[], :call
 
+        # @since 2.0.0
+        # @api private
         def valid?(url)
           return false if url.nil?
 

data/lib/hanami/cli/version.rb

@@ -2,6 +2,10 @@
 
 module Hanami
   module CLI
-    VERSION = "2.0.0.beta4"
+    # The current hanami-cli version.
+    #
+    # @api public
+    # @since 2.0.0
+    VERSION = "2.0.0"
   end
 end

data/lib/hanami/cli.rb

@@ -1,13 +1,36 @@
 # frozen_string_literal: true
 
 require "dry/cli"
+require "zeitwerk"
 
 module Hanami
+  # Extensible command line interface for Hanami.
+  #
+  # @api public
+  # @since 2.0.0
   module CLI
-    require_relative "cli/version"
-    require_relative "cli/error"
-    require_relative "cli/bundler"
+    # @api private
+    # @since 2.0.0
+    def self.gem_loader
+      @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+        loader.tag = "hanami-cli"
+        loader.inflector = Zeitwerk::GemInflector.new("#{root}/hanami-cli.rb")
+        loader.push_dir(root)
+        loader.ignore(
+          "#{root}/hanami-cli.rb",
+          "#{root}/hanami/cli/{errors,version}.rb"
+        )
+        loader.inflector.inflect("cli" => "CLI")
+        loader.inflector.inflect("db" => "DB")
+        loader.inflector.inflect("url" => "URL")
+      end
+    end
+
+    gem_loader.setup
     require_relative "cli/commands"
+    require_relative "cli/errors"
+    require_relative "cli/version"
 
     extend Dry::CLI::Registry
 

data/lib/hanami/console/context.rb

@@ -3,15 +3,17 @@
 require_relative "plugins/slice_readers"
 
 module Hanami
+  # @since 2.0.0
+  # @api private
   module Console
     # Hanami app console context
     #
-    # @api private
     # @since 2.0.0
+    # @api private
     class Context < Module
-      # @api private
       attr_reader :app
 
+      # @since 2.0.0
       # @api private
       def initialize(app)
         super()

data/lib/hanami/console/plugins/slice_readers.rb

@@ -8,6 +8,7 @@ module Hanami
       # @api private
       # @since 2.0.0
       class SliceReaders < Module
+        # @since 2.0.0
         # @api private
         def initialize(app)
           super()

data/lib/hanami-cli.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "hanami/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-cli
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,67 +25,99 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dry-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: dry-cli
+  name: dry-files
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: dry-files
+  name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: dry-inflector
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +174,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -152,10 +185,10 @@ files:
 - bin/setup
 - exe/hanami
 - hanami-cli.gemspec
+- lib/hanami-cli.rb
 - lib/hanami/cli.rb
 - lib/hanami/cli/bundler.rb
 - lib/hanami/cli/command.rb
-- lib/hanami/cli/command_line.rb
 - lib/hanami/cli/commands.rb
 - lib/hanami/cli/commands/app.rb
 - lib/hanami/cli/commands/app/command.rb
@@ -170,6 +203,11 @@ files:
 - lib/hanami/cli/commands/app/db/seed.rb
 - lib/hanami/cli/commands/app/db/setup.rb
 - lib/hanami/cli/commands/app/db/structure/dump.rb
+- lib/hanami/cli/commands/app/db/utils/database.rb
+- lib/hanami/cli/commands/app/db/utils/database_config.rb
+- lib/hanami/cli/commands/app/db/utils/mysql.rb
+- lib/hanami/cli/commands/app/db/utils/postgres.rb
+- lib/hanami/cli/commands/app/db/utils/sqlite.rb
 - lib/hanami/cli/commands/app/db/version.rb
 - lib/hanami/cli/commands/app/generate.rb
 - lib/hanami/cli/commands/app/generate/action.rb
@@ -179,15 +217,10 @@ files:
 - lib/hanami/cli/commands/app/routes.rb
 - lib/hanami/cli/commands/app/server.rb
 - lib/hanami/cli/commands/app/version.rb
-- lib/hanami/cli/commands/db/utils/database.rb
-- lib/hanami/cli/commands/db/utils/database_config.rb
-- lib/hanami/cli/commands/db/utils/mysql.rb
-- lib/hanami/cli/commands/db/utils/postgres.rb
-- lib/hanami/cli/commands/db/utils/sqlite.rb
 - lib/hanami/cli/commands/gem.rb
 - lib/hanami/cli/commands/gem/new.rb
 - lib/hanami/cli/commands/gem/version.rb
-- lib/hanami/cli/error.rb
+- lib/hanami/cli/errors.rb
 - lib/hanami/cli/files.rb
 - lib/hanami/cli/generators/app/action.rb
 - lib/hanami/cli/generators/app/action/action.erb
@@ -253,9 +286,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key:

data/lib/hanami/cli/command_line.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./bundler"
-
-module Hanami
-  module CLI
-    class CommandLine
-      def initialize(bundler: CLI::Bundler.new)
-        @bundler = bundler
-      end
-
-      def call(command)
-        @bundler.exec(command)
-      end
-    end
-  end
-end

data/lib/hanami/cli/commands/db/utils/database.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "database_config"
-
-module Hanami
-  module CLI
-    module Commands
-      module DB
-        module Utils
-          class Database
-            attr_reader :app, :config
-
-            SCHEME_MAP = {
-              "sqlite" => -> {
-                require_relative("sqlite")
-                Sqlite
-              },
-              "postgres" => -> {
-                require_relative("postgres")
-                Postgres
-              },
-              "postgresql" => -> {
-                require_relative("postgres")
-                Postgres
-              },
-              "mysql" => -> {
-                require_relative("mysql")
-                Mysql
-              }
-            }.freeze
-
-            def self.[](app)
-              database_url =
-                if app.key?(:settings) && app[:settings].respond_to?(:database_url)
-                  app[:settings].database_url
-                else
-                  ENV.fetch("DATABASE_URL")
-                end
-
-              config = DatabaseConfig.new(database_url)
-
-              resolver = SCHEME_MAP.fetch(config.db_type) do
-                raise "#{config.db_type} is not a supported db scheme"
-              end
-
-              klass = resolver.()
-
-              klass.new(app: app, config: config)
-            end
-
-            def initialize(app:, config:)
-              @app = app
-              @config = config
-            end
-
-            def create_command
-              raise NotImplementedError
-            end
-
-            def drop_command
-              raise NotImplementedError
-            end
-
-            def dump_command
-              raise NotImplementedError
-            end
-
-            def load_command
-              raise NotImplementedError
-            end
-
-            def root_path
-              app.root
-            end
-
-            def rom_config
-              @rom_config ||=
-                begin
-                  app.prepare(:persistence)
-                  app.container["persistence.config"]
-                end
-            end
-
-            def name
-              config.db_name
-            end
-
-            def gateway
-              rom_config.gateways[:default]
-            end
-
-            def connection
-              gateway.connection
-            end
-
-            def run_migrations(**options)
-              require "rom/sql"
-              ROM::SQL.with_gateway(gateway) do
-                migrator.run(options)
-              end
-            end
-
-            def migrator
-              @migrator ||=
-                begin
-                  require "rom/sql"
-                  ROM::SQL::Migration::Migrator.new(connection, path: File.join(root_path, "db/migrate"))
-                end
-            end
-
-            def applied_migrations
-              sequel_migrator.applied_migrations
-            end
-
-            private
-
-            def sequel_migrator
-              @sequel_migrator ||= begin
-                require "sequel"
-                Sequel.extension :migration
-                Sequel::TimestampMigrator.new(migrator.connection, migrations_path, {})
-              end
-            end
-
-            def migrations_path
-              File.join(root_path, "db/migrate")
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hanami/cli/commands/db/utils/database_config.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require "uri"
-
-module Hanami
-  module CLI
-    module Commands
-      module DB
-        module Utils
-          class DatabaseConfig
-            attr_reader :uri
-
-            def initialize(database_url)
-              @uri = URI(database_url)
-            end
-
-            def hostname
-              uri.hostname
-            end
-            alias_method :host, :hostname
-
-            def user
-              uri.user
-            end
-            alias_method :username, :user
-
-            def password
-              uri.password
-            end
-            alias_method :pass, :password
-
-            def port
-              uri.port
-            end
-
-            def db_name
-              @db_name ||= uri.path.gsub(/\A\//, "")
-            end
-
-            def db_type
-              uri.scheme
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hanami/cli/commands/db/utils/mysql.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "database"
-
-module Hanami
-  module CLI
-    module Commands
-      module DB
-        module Utils
-          class Mysql < Database
-            def create_command
-              raise "Not Implemented Yet"
-            end
-
-            def dump_command
-              raise "Not Implemented Yet"
-            end
-
-            def load_command
-              raise "Not Implemented Yet"
-            end
-          end
-        end
-      end
-    end
-  end
-end