hanami-cli 2.1.1 → 2.2.0.beta2

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

@@ -1,24 +1,30 @@
 # frozen_string_literal: true
 
-require_relative "../../app/command"
-
 module Hanami
   module CLI
     module Commands
       module App
         module DB
           # @api private
-          class Version < App::Command
+          class Version < DB::Command
             desc "Print schema version"
 
-            option :target, desc: "Target migration number", aliases: ["-t"]
+            option :gateway, required: false, desc: "Use database for gateway"
 
             # @api private
-            def call(target: nil, **) # rubocop:disable Lint/UnusedMethodArgument
-              migration = database.applied_migrations.last
-              version = migration ? File.basename(migration, ".*") : "not available"
+            def call(app: false, slice: nil, gateway: nil, **)
+              databases(app: app, slice: slice, gateway: gateway).each do |database|
+                unless database.migrations_dir?
+                  relative_migrations_path = database.migrations_path.relative_path_from(database.slice.app.root)
+                  out.puts "=> Cannot find version for database #{database.name}: no migrations directory at #{relative_migrations_path}/"
+                  return
+                end
+
+                migration = database.applied_migrations.last
+                version = migration ? File.basename(migration, ".*") : "not available"
 
-              out.puts "=> current schema version is #{version}"
+                out.puts "=> #{database.name} current schema version is #{version}"
+              end
             end
           end
         end

data/lib/hanami/cli/commands/app/generate/action.rb

@@ -32,13 +32,13 @@ module Hanami
             option \
               :skip_view,
               required: false,
-              type: :boolean,
+              type: :flag,
               default: DEFAULT_SKIP_VIEW,
               desc: "Skip view and template generation"
             option \
               :skip_tests,
               required: false,
-              type: :boolean,
+              type: :flag,
               default: DEFAULT_SKIP_TESTS,
               desc: "Skip test generation"
             option :slice, required: false, desc: "Slice name"
@@ -85,7 +85,8 @@ module Hanami
               skip_view: DEFAULT_SKIP_VIEW,
               skip_tests: DEFAULT_SKIP_TESTS, # rubocop:disable Lint/UnusedMethodArgument
               slice: nil,
-              context: nil, **
+              context: nil,
+              **
             )
               slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
               name = naming.action_name(name)

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "dry/inflector"
+require "dry/files"
+require "shellwords"
+require_relative "../../../naming"
+require_relative "../../../errors"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @since 2.2.0
+          # @api private
+          class Command < App::Command
+            option :slice, required: false, desc: "Slice name"
+
+            attr_reader :generator
+            private :generator
+
+            # @since 2.2.0
+            # @api private
+            def initialize(
+              fs:,
+              inflector:,
+              **opts
+            )
+              super
+              @generator = generator_class.new(fs: fs, inflector: inflector, out: out)
+            end
+
+            def generator_class
+              # Must be implemented by subclasses, with class that takes:
+              # fs:, inflector:, out:
+            end
+
+            # @since 2.2.0
+            # @api private
+            def call(name:, slice: nil, **)
+              if slice
+                generator.call(
+                  key: name,
+                  namespace: slice,
+                  base_path: fs.join("slices", inflector.underscore(slice))
+                )
+              else
+                generator.call(
+                  key: name,
+                  namespace: app.namespace,
+                  base_path: "app"
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/component.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "dry/inflector"
+require "dry/files"
+require "shellwords"
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @api private
+          # @since 2.2.0
+          class Component < App::Command
+            argument :name, required: true, desc: "Component name"
+            option :slice, required: false, desc: "Slice name"
+
+            example [
+              %(operations.create_user               (MyApp::Operations::CreateUser)),
+              %(operations.user.create               (MyApp::Operations::Create::User)),
+              %(operations.create_user               --slice=admin (Admin::Operations::CreateUser)),
+              %(Operations::CreateUser               (MyApp::Operations::CreateUser)),
+            ]
+            attr_reader :generator
+            private :generator
+
+            # @api private
+            # @since 2.2.0
+            def initialize(
+              fs:, inflector:,
+              generator: Generators::App::Component.new(fs: fs, inflector: inflector),
+              **opts
+            )
+              @generator = generator
+              super(fs: fs, inflector: inflector, **opts)
+            end
+
+            # @api private
+            # @since 2.2.0
+            def call(name:, slice: nil, **)
+              slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
+
+              generator.call(app.namespace, name, slice)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/migration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @since 2.2.0
+          # @api private
+          class Migration < Command
+            argument :name, required: true, desc: "Migration name"
+            option :gateway, desc: "Generate migration for gateway"
+
+            example [
+              %(create_posts),
+              %(add_published_at_to_posts),
+              %(create_users --slice=admin),
+              %(create_comments --slice=admin --gateway=extra),
+            ]
+
+            def generator_class
+              Generators::App::Migration
+            end
+
+            def call(name:, slice: nil, gateway: nil)
+              if slice
+                generator.call(
+                  key: name,
+                  namespace: slice,
+                  base_path: fs.join("slices", inflector.underscore(slice)),
+                  gateway: gateway
+                )
+              else
+                generator.call(
+                  key: name,
+                  namespace: app.namespace,
+                  base_path: "app",
+                  gateway: gateway
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/operation.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @since 2.2.0
+          # @api private
+          class Operation < Command
+            argument :name, required: true, desc: "Operation name"
+
+            example [
+              %(books.add               (MyApp::Books::Add)),
+              %(books.add --slice=admin (Admin::Books::Add)),
+            ]
+
+            def generator_class
+              Generators::App::Operation
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/part.rb

@@ -20,7 +20,7 @@ module Hanami
             option \
               :skip_tests,
               required: false,
-              type: :boolean,
+              type: :flag,
               default: DEFAULT_SKIP_TESTS,
               desc: "Skip test generation"
 

data/lib/hanami/cli/commands/app/generate/relation.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @since 2.2.0
+          # @api private
+          class Relation < Command
+            argument :name, required: true, desc: "Relation name"
+
+            example [
+              %(books               (MyApp::Relation::Book)),
+              %(books/drafts        (MyApp::Relations::Books::Drafts)),
+              %(books --slice=admin (Admin::Relations::Books)),
+            ]
+
+            # @since 2.2.0
+            # @api private
+            def generator_class
+              Generators::App::Relation
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/repo.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "dry/inflector"
+require "dry/files"
+require "shellwords"
+require_relative "../../../naming"
+require_relative "../../../errors"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @since 2.2.0
+          # @api private
+          class Repo < Command
+            argument :name, required: true, desc: "Repo name"
+
+            example [
+              %(books               (MyApp::Repos::BooksRepo)),
+              %(books/drafts_repo   (MyApp::Repos::Books::DraftsRepo)),
+              %(books --slice=admin (Admin::Repos::BooksRepo)),
+            ]
+
+            # @since 2.2.0
+            # @api private
+            def generator_class
+              Generators::App::Repo
+            end
+
+            # @since 2.2.0
+            # @api private
+            def call(name:, **opts)
+              name = "#{inflector.singularize(name)}_repo" unless name.end_with?("_repo")
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/slice.rb

@@ -12,10 +12,23 @@ module Hanami
         module Generate
           # @since 2.0.0
           # @api private
-          class Slice < Command
+          class Slice < App::Command
             argument :name, required: true, desc: "The slice name"
             option :url, required: false, type: :string, desc: "The slice URL prefix"
 
+            # @since 2.2.0
+            # @api private
+            SKIP_DB_DEFAULT = false
+            private_constant :SKIP_DB_DEFAULT
+
+            # @since 2.2.0
+            # @api private
+            option :skip_db,
+              type: :boolean,
+              required: false,
+              default: SKIP_DB_DEFAULT,
+              desc: "Skip database"
+
             example [
               "admin          # Admin slice (/admin URL prefix)",
               "users --url=/u # Users slice (/u URL prefix)",
@@ -34,14 +47,18 @@ module Hanami
 
             # @since 2.0.0
             # @api private
-            def call(name:, url: nil, **)
+            def call(
+              name:,
+              url: nil,
+              skip_db: SKIP_DB_DEFAULT
+            )
               require "hanami/setup"
 
               app = inflector.underscore(Hanami.app.namespace)
               name = inflector.underscore(Shellwords.shellescape(name))
               url = sanitize_url_prefix(name, url)
 
-              generator.call(app, name, url)
+              generator.call(app, name, url, skip_db: skip_db)
             end
 
             private

data/lib/hanami/cli/commands/app/generate/struct.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @since 2.2.0
+          # @api private
+          class Struct < Command
+            argument :name, required: true, desc: "Struct name"
+
+            example [
+              %(book                (MyApp::Structs::Book)),
+              %(book/published_book (MyApp::Structs::Book::PublishedBook)),
+              %(book --slice=admin  (Admin::Structs::Book)),
+            ]
+
+            def generator_class
+              Generators::App::Struct
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -31,7 +31,7 @@ module Hanami
 
           # @since 2.1.0
           # @api private
-          option :head, type: :boolean, desc: "Install head deps", default: DEFAULT_HEAD
+          option :head, type: :flag, desc: "Install head deps", default: DEFAULT_HEAD
 
           # @since 2.0.0
           # @api private

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

@@ -34,7 +34,7 @@ module Hanami
           private_constant :DEFAULT_WITH_ARGUMENTS
 
           option :with_arguments, default: DEFAULT_WITH_ARGUMENTS, required: false,
-                                  desc: "Include inspected arguments", type: :boolean
+                                  desc: "Include inspected arguments", type: :flag
 
           example [
             "middleware                  # Print app Rack middleware stack",

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

@@ -41,8 +41,8 @@ module Hanami
           option :port, default: Hanami::Port::DEFAULT, required: false,
                         desc: "The port to run the server on (falls back to the rack handler)"
           option :config, default: DEFAULT_CONFIG_PATH, required: false, desc: "Rack configuration file"
-          option :debug, default: false, required: false, desc: "Turn on/off debug output", type: :boolean
-          option :warn, default: false, required: false, desc: "Turn on/off warnings", type: :boolean
+          option :debug, default: false, required: false, desc: "Turn on/off debug output", type: :flag
+          option :warn, default: false, required: false, desc: "Turn on/off warnings", type: :flag
 
           # @since 2.0.0
           # @api private

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

@@ -27,11 +27,30 @@ module Hanami
               end
             end
 
+            if Hanami.bundled?("hanami-db")
+              register "db" do |db|
+                db.register "create", DB::Create
+                db.register "drop", DB::Drop
+                db.register "migrate", DB::Migrate
+                db.register "structure dump", DB::Structure::Dump
+                db.register "structure load", DB::Structure::Load
+                db.register "seed", DB::Seed
+                db.register "prepare", DB::Prepare
+                db.register "version", DB::Version
+              end
+            end
+
             register "generate", aliases: ["g"] do |prefix|
-              prefix.register "slice", Generate::Slice
               prefix.register "action", Generate::Action
-              prefix.register "view", Generate::View
+              prefix.register "component", Generate::Component
+              prefix.register "migration", Generate::Migration
+              prefix.register "operation", Generate::Operation
               prefix.register "part", Generate::Part
+              prefix.register "relation", Generate::Relation
+              prefix.register "repo", Generate::Repo
+              prefix.register "slice", Generate::Slice
+              prefix.register "struct", Generate::Struct
+              prefix.register "view", Generate::View
             end
           end
         end

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

@@ -25,6 +25,27 @@ module Hanami
           SKIP_ASSETS_DEFAULT = false
           private_constant :SKIP_ASSETS_DEFAULT
 
+          # @since 2.2.0
+          # @api private
+          SKIP_DB_DEFAULT = false
+          private_constant :SKIP_DB_DEFAULT
+
+          # @since 2.2.0
+          # @api private
+          DATABASE_SQLITE = "sqlite"
+
+          # @since 2.2.0
+          # @api private
+          DATABASE_POSTGRES = "postgres"
+
+          # @since 2.2.0
+          # @api private
+          DATABASE_MYSQL = "mysql"
+
+          # @since 2.2.0
+          # @api private
+          SUPPORTED_DATABASES = [DATABASE_SQLITE, DATABASE_POSTGRES, DATABASE_MYSQL].freeze
+
           desc "Generate a new Hanami app"
 
           # @since 2.0.0
@@ -33,28 +54,42 @@ module Hanami
 
           # @since 2.0.0
           # @api private
-          option :skip_install, type: :boolean, required: false,
+          option :skip_install, type: :flag, required: false,
                                 default: SKIP_INSTALL_DEFAULT,
                                 desc: "Skip app installation (Bundler, third-party Hanami plugins)"
 
           # @since 2.1.0
           # @api private
-          option :head, type: :boolean, required: false,
+          option :head, type: :flag, required: false,
                         default: HEAD_DEFAULT,
                         desc: "Use Hanami HEAD version (from GitHub `main` branches)"
 
           # @since 2.1.0
           # @api private
-          option :skip_assets, type: :boolean, required: false,
+          option :skip_assets, type: :flag, required: false,
                                default: SKIP_ASSETS_DEFAULT,
-                               desc: "Skip assets"
+                               desc: "Skip including hanami-assets"
+
+          # @since 2.2.0
+          # @api private
+          option :skip_db, type: :flag, required: false,
+                           default: SKIP_DB_DEFAULT,
+                           desc: "Skip including hanami-db"
+
+          # @since 2.2.0
+          # @api private
+          option :database, type: :string, required: false,
+                            default: DATABASE_SQLITE,
+                            desc: "Database adapter (supported: sqlite, mysql, postgres)"
 
           # rubocop:disable Layout/LineLength
           example [
-            "bookshelf                # Generate a new Hanami app in `bookshelf/' directory, using `Bookshelf' namespace",
-            "bookshelf --head         # Generate a new Hanami app, using Hanami HEAD version from GitHub `main' branches",
-            "bookshelf --skip-install # Generate a new Hanami app, but it skips Hanami installation",
-            "bookshelf --skip-assets  # Generate a new Hanami app without assets"
+            "bookshelf                                    # Generate a new Hanami app in `bookshelf/' directory, using `Bookshelf' namespace",
+            "bookshelf --head                             # Generate a new Hanami app, using Hanami HEAD version from GitHub `main' branches",
+            "bookshelf --skip-install                     # Generate a new Hanami app, but it skips Hanami installation",
+            "bookshelf --skip-assets                      # Generate a new Hanami app without hanmai-assets",
+            "bookshelf --skip-db                          # Generate a new Hanami app without hanami-db",
+            "bookshelf --database={sqlite|postgres|mysql} # Generate a new Hanami app with a specified database (default: sqlite)",
           ]
           # rubocop:enable Layout/LineLength
 
@@ -75,20 +110,36 @@ module Hanami
             @system_call = system_call
           end
 
-          # rubocop:enable Metrics/ParameterLists
-
-          # rubocop:disable Metrics/AbcSize
+          # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
 
           # @since 2.0.0
           # @api private
-          def call(app:, head: HEAD_DEFAULT, skip_install: SKIP_INSTALL_DEFAULT, skip_assets: SKIP_ASSETS_DEFAULT, **)
+          def call(
+            app:,
+            head: HEAD_DEFAULT,
+            skip_install: SKIP_INSTALL_DEFAULT,
+            skip_assets: SKIP_ASSETS_DEFAULT,
+            skip_db: SKIP_DB_DEFAULT,
+            database: nil
+          )
+            # rubocop:enable Metrics/ParameterLists
             app = inflector.underscore(app)
 
             raise PathAlreadyExistsError.new(app) if fs.exist?(app)
+            raise ConflictingOptionsError.new("--skip-db", "--database") if skip_db && database
+
+            normalized_database ||= normalize_database(database)
 
             fs.mkdir(app)
             fs.chdir(app) do
-              context = Generators::Context.new(inflector, app, head: head, skip_assets: skip_assets)
+              context = Generators::Context.new(
+                inflector,
+                app,
+                head: head,
+                skip_assets: skip_assets,
+                skip_db: skip_db,
+                database: normalized_database
+              )
               generator.call(app, context: context) do
                 if skip_install
                   out.puts "Skipping installation, please enter `#{app}' directory and run `bundle exec hanami install'"
@@ -112,7 +163,7 @@ module Hanami
               end
             end
           end
-          # rubocop:enable Metrics/AbcSize
+          # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
 
           private
 
@@ -120,6 +171,19 @@ module Hanami
           attr_reader :generator
           attr_reader :system_call
 
+          def normalize_database(database)
+            case database
+            when nil, "sqlite", "sqlite3"
+              DATABASE_SQLITE
+            when "mysql", "mysql2"
+              DATABASE_MYSQL
+            when "postgres", "postgresql", "pg"
+              DATABASE_POSTGRES
+            else
+              raise DatabaseNotSupportedError.new(database, SUPPORTED_DATABASES)
+            end
+          end
+
           def run_install_command!(head:)
             head_flag = head ? " --head" : ""
             bundler.exec("hanami install#{head_flag}").tap do |result|

data/lib/hanami/cli/errors.rb

@@ -91,5 +91,33 @@ module Hanami
         super("`#{scheme}' is not a supported db scheme")
       end
     end
+
+    # @since 2.2.0
+    # @api public
+    class DatabaseNotSupportedError < Error
+      def initialize(invalid_database, supported_databases)
+        super("`#{invalid_database}' is not a supported database. Supported databases are: #{supported_databases.join(', ')}")
+      end
+    end
+
+    # @since 2.2.0
+    # @api public
+    class ConflictingOptionsError < Error
+      def initialize(option1, option2)
+        super("`#{option1}' and `#{option2}' cannot be used together")
+      end
+    end
+
+    # @since 2.2.0
+    # @api public
+    class InvalidMigrationNameError < Error
+      def initialize(name)
+        super(<<~TEXT)
+          Invalid migration name: #{name}
+
+          Name must contain only letters, numbers, and underscores.
+        TEXT
+      end
+    end
   end
 end