hanami-cli 2.1.0 → 2.2.0.beta1

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

@@ -80,6 +80,44 @@ module Hanami
           !options.fetch(:skip_assets, false)
         end
 
+        # @since 2.2.0
+        # @api private
+        def generate_db?
+          !options.fetch(:skip_db, false)
+        end
+
+        # @since 2.2.0
+        # @api private
+        def generate_sqlite?
+          database_option == Commands::Gem::New::DATABASE_SQLITE
+        end
+
+        # @since 2.2.0
+        # @api private
+        def generate_postgres?
+          database_option == Commands::Gem::New::DATABASE_POSTGRES
+        end
+
+        # @since 2.2.0
+        # @api private
+        def generate_mysql?
+          database_option == Commands::Gem::New::DATABASE_MYSQL
+        end
+
+        # @since 2.2.0
+        # @api private
+        def database_url
+          if generate_sqlite?
+            "sqlite://db/#{app}.sqlite"
+          elsif generate_postgres?
+            "postgres://localhost/#{app}"
+          elsif generate_mysql?
+            "mysql://localhost/#{app}"
+          else
+            raise "Unknown database option: #{database_option}"
+          end
+        end
+
         # @since 2.1.0
         # @api private
         def bundled_views?
@@ -92,6 +130,12 @@ module Hanami
           Hanami.bundled?("hanami-assets")
         end
 
+        # @since 2.2.0
+        # @api private
+        def bundled_dry_monads?
+          Hanami.bundled?("dry-monads")
+        end
+
         # @since 2.1.0
         # @api private
         #
@@ -102,6 +146,10 @@ module Hanami
 
         private
 
+        def database_option
+          options.fetch(:database, Commands::Gem::New::DATABASE_SQLITE)
+        end
+
         # @since 2.0.0
         # @api private
         attr_reader :inflector

data/lib/hanami/cli/generators/gem/app/action.erb

@@ -2,8 +2,11 @@
 # frozen_string_literal: true
 
 require "hanami/action"
+require "dry/monads"
 
 module <%= camelized_app_name %>
   class Action < Hanami::Action
+    # Provide `Success` and `Failure` for pattern matching on operation results
+    include Dry::Monads[:result]
   end
 end

data/lib/hanami/cli/generators/gem/app/env.erb

@@ -0,0 +1,4 @@
+# This is checked into source control, so put sensitive values into `.env.local`
+<%- if generate_db? -%>
+DATABASE_URL=<%= database_url %>
+<%- end -%>

data/lib/hanami/cli/generators/gem/app/gemfile.erb

@@ -7,13 +7,24 @@ source "https://rubygems.org"
 <%= hanami_gem("assets") %>
 <%- end -%>
 <%= hanami_gem("controller") %>
+<%- if generate_db? -%>
+<%= hanami_gem("db") %>
+<%- end -%>
 <%= hanami_gem("router") %>
 <%= hanami_gem("validations") %>
 <%= hanami_gem("view") %>
 
 gem "dry-types", "~> 1.0", ">= 1.6.1"
+gem "dry-operation", github: "dry-rb/dry-operation"
 gem "puma"
 gem "rake"
+<%- if generate_sqlite? -%>
+gem "sqlite3"
+<%- elsif generate_postgres? -%>
+gem "pg"
+<%- elsif generate_mysql? -%>
+gem "mysql2"
+<%- end -%>
 
 group :development do
   <%= hanami_gem("webconsole") %>

data/lib/hanami/cli/generators/gem/app/gitignore.erb

@@ -1,4 +1,4 @@
-.env
+.env*.local
 log/*
 <%- if generate_assets? -%>
 public/

data/lib/hanami/cli/generators/gem/app/operation.erb

@@ -0,0 +1,13 @@
+# auto_register: false
+# frozen_string_literal: true
+
+require "dry/operation"
+
+module <%= camelized_app_name %>
+  class Operation < Dry::Operation
+    <%- if generate_db? -%>
+    # Provide `transaction do ... end` method for database transactions
+    include Dry::Operation::Extensions::ROM
+    <%- end -%>
+  end
+end

data/lib/hanami/cli/generators/gem/app/relation.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "hanami/db/relation"
+
+module <%= camelized_app_name %>
+  module DB
+    class Relation < Hanami::DB::Relation
+    end
+  end
+end

data/lib/hanami/cli/generators/gem/app/repo.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "hanami/db/repo"
+
+module <%= camelized_app_name %>
+  module DB
+    class Repo < Hanami::DB::Repo
+    end
+  end
+end

data/lib/hanami/cli/generators/gem/app/struct.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "hanami/db/struct"
+
+module <%= camelized_app_name %>
+  module DB
+    class Struct < Hanami::DB::Struct
+    end
+  end
+end

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

@@ -68,6 +68,25 @@ module Hanami
               fs.write("app/assets/images/favicon.ico", file("favicon.ico"))
             end
 
+            if context.generate_db?
+              fs.write("app/db/relation.rb", t("relation.erb", context))
+              fs.write("app/relations/.keep", t("keep.erb", context))
+
+              fs.write("app/db/repo.rb", t("repo.erb", context))
+              fs.write("app/repos/.keep", t("keep.erb", context))
+
+              fs.write("app/db/struct.rb", t("struct.erb", context))
+              fs.write("app/structs/.keep", t("keep.erb", context))
+
+              fs.write("config/db/migrate/.keep" , t("keep.erb", context))
+
+              if context.generate_sqlite?
+                fs.write("db/.keep" , t("keep.erb", context))
+              end
+            end
+
+            fs.write("app/operation.rb", t("operation.erb", context))
+
             fs.write("public/404.html", file("404.html"))
             fs.write("public/500.html", file("500.html"))
           end

data/lib/hanami/cli/ruby_file_generator.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "ripper"
+
+module Hanami
+  module CLI
+    class RubyFileGenerator
+      # @api private
+      # @since 2.2.0
+      class GeneratedUnparseableCodeError < Error
+        def initialize(source_code)
+          super(
+            <<~ERROR_MESSAGE
+              Sorry, the code we generated is not valid Ruby.
+
+              Here's what we got:
+
+              #{source_code}
+
+              Please fix the errors and try again.
+            ERROR_MESSAGE
+          )
+        end
+      end
+
+      INDENT = "  "
+
+      def self.class(class_name, **args)
+        new(class_name: class_name, **args).to_s
+      end
+
+      def self.module(*names, **args)
+        module_names = if names.first.is_a?(Array)
+                         names.first
+                       else
+                         names
+                       end
+
+        new(modules: module_names, class_name: nil, parent_class: nil, **args).to_s
+      end
+
+      def initialize(
+        class_name: nil,
+        parent_class: nil,
+        modules: [],
+        header: [],
+        body: []
+      )
+        @class_name = class_name
+        @parent_class = parent_class
+        @modules = modules
+        @header = header.any? ? (header + [""]) : []
+        @body = body
+      end
+
+      def to_s
+        definition = lines(modules).map { |line| "#{line}\n" }.join
+        source_code = [header, definition].flatten.join("\n")
+        ensure_parseable!(source_code)
+        source_code
+      end
+
+      private
+
+      attr_reader(
+        :class_name,
+        :parent_class,
+        :modules,
+        :header,
+        :body
+      )
+
+      def lines(remaining_modules)
+        this_module, *rest_modules = remaining_modules
+        if this_module
+          with_module_lines(this_module, lines(rest_modules))
+        elsif class_name
+          class_lines
+        else
+          body
+        end
+      end
+
+      def with_module_lines(module_name, contents_lines)
+        [
+          "module #{module_name}",
+          *contents_lines.map { |line| indent(line) },
+          "end"
+        ]
+      end
+
+      def class_lines
+        [
+          class_definition,
+          *body.map { |line| indent(line) },
+          "end"
+        ].compact
+      end
+
+      def class_definition
+        if parent_class
+          "class #{class_name} < #{parent_class}"
+        else
+          "class #{class_name}"
+        end
+      end
+
+      def indent(line)
+        if line.strip.empty?
+          ""
+        else
+          INDENT + line
+        end
+      end
+
+      def ensure_parseable!(source_code)
+        unless Ripper.sexp(source_code)
+          raise GeneratedUnparseableCodeError.new(source_code)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/version.rb

@@ -6,6 +6,6 @@ module Hanami
     #
     # @api public
     # @since 2.0.0
-    VERSION = "2.1.0"
+    VERSION = "2.2.0.beta1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-cli
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,9 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: dry-files
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +183,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - exe/hanami
 - hanami-cli.gemspec
 - lib/hanami-cli.rb
@@ -197,18 +198,15 @@ files:
 - lib/hanami/cli/commands/app/assets/watch.rb
 - lib/hanami/cli/commands/app/command.rb
 - lib/hanami/cli/commands/app/console.rb
+- lib/hanami/cli/commands/app/db/command.rb
 - lib/hanami/cli/commands/app/db/create.rb
-- lib/hanami/cli/commands/app/db/create_migration.rb
 - lib/hanami/cli/commands/app/db/drop.rb
 - lib/hanami/cli/commands/app/db/migrate.rb
-- lib/hanami/cli/commands/app/db/reset.rb
-- lib/hanami/cli/commands/app/db/rollback.rb
-- lib/hanami/cli/commands/app/db/sample_data.rb
+- lib/hanami/cli/commands/app/db/prepare.rb
 - 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/structure/load.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
@@ -216,8 +214,15 @@ files:
 - lib/hanami/cli/commands/app/dev.rb
 - lib/hanami/cli/commands/app/generate.rb
 - lib/hanami/cli/commands/app/generate/action.rb
+- lib/hanami/cli/commands/app/generate/command.rb
+- lib/hanami/cli/commands/app/generate/component.rb
+- lib/hanami/cli/commands/app/generate/migration.rb
+- lib/hanami/cli/commands/app/generate/operation.rb
 - lib/hanami/cli/commands/app/generate/part.rb
+- lib/hanami/cli/commands/app/generate/relation.rb
+- lib/hanami/cli/commands/app/generate/repo.rb
 - lib/hanami/cli/commands/app/generate/slice.rb
+- lib/hanami/cli/commands/app/generate/struct.rb
 - lib/hanami/cli/commands/app/generate/view.rb
 - lib/hanami/cli/commands/app/install.rb
 - lib/hanami/cli/commands/app/middleware.rb
@@ -238,12 +243,21 @@ files:
 - lib/hanami/cli/generators/app/action/template.html.erb
 - lib/hanami/cli/generators/app/action/view.erb
 - lib/hanami/cli/generators/app/action_context.rb
+- lib/hanami/cli/generators/app/component.rb
+- lib/hanami/cli/generators/app/component/component.erb
+- lib/hanami/cli/generators/app/component/slice_component.erb
+- lib/hanami/cli/generators/app/component_context.rb
+- lib/hanami/cli/generators/app/migration.rb
+- lib/hanami/cli/generators/app/operation.rb
 - lib/hanami/cli/generators/app/part.rb
 - lib/hanami/cli/generators/app/part/app_base_part.erb
 - lib/hanami/cli/generators/app/part/app_part.erb
 - lib/hanami/cli/generators/app/part/slice_base_part.erb
 - lib/hanami/cli/generators/app/part/slice_part.erb
 - lib/hanami/cli/generators/app/part_context.rb
+- lib/hanami/cli/generators/app/relation.rb
+- lib/hanami/cli/generators/app/repo.rb
+- lib/hanami/cli/generators/app/ruby_file_writer.rb
 - lib/hanami/cli/generators/app/slice.rb
 - lib/hanami/cli/generators/app/slice/action.erb
 - lib/hanami/cli/generators/app/slice/app_css.erb
@@ -253,17 +267,21 @@ files:
 - lib/hanami/cli/generators/app/slice/favicon.ico
 - lib/hanami/cli/generators/app/slice/helpers.erb
 - lib/hanami/cli/generators/app/slice/keep.erb
-- lib/hanami/cli/generators/app/slice/repository.erb
+- lib/hanami/cli/generators/app/slice/operation.erb
+- lib/hanami/cli/generators/app/slice/relation.erb
+- lib/hanami/cli/generators/app/slice/repo.erb
 - lib/hanami/cli/generators/app/slice/routes.erb
-- lib/hanami/cli/generators/app/slice/slice.erb
+- lib/hanami/cli/generators/app/slice/struct.erb
 - lib/hanami/cli/generators/app/slice/view.erb
 - lib/hanami/cli/generators/app/slice_context.rb
+- lib/hanami/cli/generators/app/struct.rb
 - lib/hanami/cli/generators/app/view.rb
 - lib/hanami/cli/generators/app/view/app_template.html.erb
 - lib/hanami/cli/generators/app/view/app_view.erb
 - lib/hanami/cli/generators/app/view/slice_template.html.erb
 - lib/hanami/cli/generators/app/view/slice_view.erb
 - lib/hanami/cli/generators/app/view_context.rb
+- lib/hanami/cli/generators/constants.rb
 - lib/hanami/cli/generators/context.rb
 - lib/hanami/cli/generators/gem/app.rb
 - lib/hanami/cli/generators/gem/app/404.html
@@ -282,13 +300,17 @@ files:
 - lib/hanami/cli/generators/gem/app/gitignore.erb
 - lib/hanami/cli/generators/gem/app/helpers.erb
 - lib/hanami/cli/generators/gem/app/keep.erb
+- lib/hanami/cli/generators/gem/app/operation.erb
 - lib/hanami/cli/generators/gem/app/package.json.erb
 - lib/hanami/cli/generators/gem/app/procfile.erb
 - lib/hanami/cli/generators/gem/app/puma.erb
 - lib/hanami/cli/generators/gem/app/rakefile.erb
 - lib/hanami/cli/generators/gem/app/readme.erb
+- lib/hanami/cli/generators/gem/app/relation.erb
+- lib/hanami/cli/generators/gem/app/repo.erb
 - lib/hanami/cli/generators/gem/app/routes.erb
 - lib/hanami/cli/generators/gem/app/settings.erb
+- lib/hanami/cli/generators/gem/app/struct.erb
 - lib/hanami/cli/generators/gem/app/types.erb
 - lib/hanami/cli/generators/gem/app/validator.erb
 - lib/hanami/cli/generators/gem/app/view.erb
@@ -300,6 +322,7 @@ files:
 - lib/hanami/cli/repl/core.rb
 - lib/hanami/cli/repl/irb.rb
 - lib/hanami/cli/repl/pry.rb
+- lib/hanami/cli/ruby_file_generator.rb
 - lib/hanami/cli/server.rb
 - lib/hanami/cli/system_call.rb
 - lib/hanami/cli/url.rb
@@ -324,14 +347,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Hanami CLI

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../app/command"
-require_relative "structure/dump"
-
-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
-
-              measure "migration #{version}_#{name} created" do
-                migrator.create_file(name, version)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../app/command"
-require_relative "create"
-require_relative "drop"
-require_relative "migrate"
-
-module Hanami
-  module CLI
-    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
-              run_command Migrate
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../app/command"
-require_relative "structure/dump"
-
-module Hanami
-  module CLI
-    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)
-
-              if migration_name.nil?
-                output = if target
-                           "==> migration file for target #{target} was not found"
-                         else
-                           "==> no migrations to rollback"
-                         end
-
-                out.puts output
-                return
-              end
-
-              measure "database #{database.name} rolled back to #{migration_name}" do
-                database.run_migrations(target: Integer(migration_code))
-
-                true
-              end
-
-              run_command Structure::Dump if dump
-            end
-
-            private
-
-            def find_migration(code) # rubocop:disable Metrics/PerceivedComplexity
-              applied_migrations = database.applied_migrations
-
-              return if applied_migrations.empty?
-
-              # Rollback to initial state if we have only one migration and
-              # no target is specified. In this case the rollback target
-              # will be the current migration timestamp minus 1
-              if applied_migrations.one? && code.nil?
-                migration = applied_migrations.first
-
-                migration_code = Integer(migration.split("_").first) - 1
-                migration_name = "initial state"
-
-                return [migration_code, migration_name]
-              end
-
-              # Otherwise rollback to target or to previous migration
-              migration =
-                if code
-                  applied_migrations.detect { |m| m.split("_").first == code }
-                else
-                  applied_migrations[-2]
-                end
-
-              return unless migration
-
-              migration_code = code || migration.split("_").first
-              migration_name = File.basename(migration, ".*")
-
-              [migration_code, migration_name]
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../app/command"
-require_relative "structure/dump"
-
-module Hanami
-  module CLI
-    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
-                  load full_file_path
-                end
-              else
-                out.puts "=> #{FILE_PATH} not found"
-              end
-            end
-
-            private
-
-            def full_file_path
-              File.join(app.root, FILE_PATH)
-            end
-
-            def has_file?
-              File.exist?(full_file_path)
-            end
-          end
-        end
-      end
-    end
-  end
-end