hanami-cli 2.3.5 → 3.0.0.rc1

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

@@ -16,6 +16,7 @@ module Hanami
             base_path:,
             extra_namespace: nil,
             auto_register: nil,
+            requires: [],
             body: [],
             **_opts
           )
@@ -26,12 +27,13 @@ module Hanami
             @base_path = base_path
             @extra_namespace = extra_namespace&.downcase
             @auto_register = auto_register
+            @requires = requires
             @body = body
           end
 
           # @api private
-          def create
-            fs.create(path, file_contents)
+          def create(force: false)
+            fs.create(path, file_contents, force:)
           end
 
           # @api private
@@ -42,7 +44,7 @@ module Hanami
           # @api private
           def fully_qualified_name
             inflector.camelize(
-              [namespace, extra_namespace, *key_segments].join("/")
+              [namespace, extra_namespace, *key_segments].compact.join("/")
             )
           end
 
@@ -62,6 +64,7 @@ module Hanami
             :namespace,
             :extra_namespace,
             :auto_register,
+            :requires,
             :body
           )
 
@@ -108,7 +111,8 @@ module Hanami
             [
               # Intentional ternary logic. Skip if nil, else 'true' or 'false'
               ("# auto_register: #{auto_register}" unless auto_register.nil?),
-              "# frozen_string_literal: true"
+              "# frozen_string_literal: true",
+              *(requires.any? ? ["", *requires.map { |name| %(require "#{name}") }] : [])
             ].compact
           end
 

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

@@ -19,7 +19,7 @@ module Hanami
 
           # @since 2.0.0
           # @api private
-          def call(app, slice, url, **opts) # rubocop:disable Metrics/AbcSize
+          def call(app, slice, url, force: false, **opts) # rubocop:disable Metrics/AbcSize
             skip_route = opts.fetch(:skip_route, false)
 
             unless skip_route
@@ -44,7 +44,7 @@ module Hanami
               base_path: directory,
               parent_class_name: "#{Hanami.app.namespace}::Action",
               auto_register: false
-            ).create
+            ).create(force:)
 
             RubyClassFile.new(
               fs: fs,
@@ -54,7 +54,21 @@ module Hanami
               base_path: directory,
               parent_class_name: "#{Hanami.app.namespace}::View",
               auto_register: false
-            ).create
+            ).create(force:)
+
+            if Hanami.bundled?("hanami-mailer")
+              RubyClassFile.new(
+                fs:, inflector:,
+                namespace: slice,
+                key: "mailer",
+                base_path: directory,
+                parent_class_name: "#{Hanami.app.namespace}::Mailer",
+                auto_register: false,
+                body: ["# Add common mailer behavior here. See https://hanakai.org/learn/hanami/mailers for details."]
+              ).create(force:)
+
+              fs.touch(fs.join(directory, "mailers/.keep"))
+            end
 
             RubyModuleFile.new(
               fs: fs,
@@ -64,7 +78,7 @@ module Hanami
               base_path: directory,
               auto_register: false,
               body: ["# Add your view helpers here"]
-            ).create
+            ).create(force:)
 
             RubyClassFile.new(
               fs: fs,
@@ -74,14 +88,21 @@ module Hanami
               base_path: directory,
               parent_class_name: "#{Hanami.app.namespace}::View::Context",
               auto_register: false,
-              body: ["# Define your view context here. See https://guides.hanamirb.org/views/context/ for details."]
-            ).create
+              body: ["# Define your view context here. See https://hanakai.org/learn/hanami/views/context/ for details."] # rubocop:disable Layout/LineLength
+            ).create(force:)
 
             fs.create(
               fs.join(directory, "templates", "layouts", "app.html.erb"),
               app_layout_template(
                 page_title: "#{inflector.humanize(app)} - #{inflector.humanize(slice)}"
-              )
+              ),
+              force:
+            )
+
+            fs.create(
+              fs.join(directory, "config", "i18n", "en.yml"),
+              File.read(File.join(__dir__, "..", "i18n.yml")),
+              force:
             )
 
             if Hanami.bundled?("dry-operation")
@@ -93,25 +114,27 @@ module Hanami
                 base_path: directory,
                 parent_class_name: "#{Hanami.app.namespace}::Operation",
                 auto_register: false
-              ).create
+              ).create(force:)
             end
 
             if Hanami.bundled?("hanami-assets")
               fs.create(
                 fs.join(directory, "assets", "js", "app.js"),
-                %(import "../css/app.css";\n)
+                %(import "../css/app.css";\n),
+                force:
               )
               fs.create(
                 fs.join(directory, "assets", "css", "app.css"),
-                <<~CSS
+                <<~CSS,
                   body {
                     background-color: #fff;
                     color: #000;
                     font-family: sans-serif;
                   }
                 CSS
+                force:
               )
-              fs.create(fs.join(directory, "assets", "images", "favicon.ico"), file("favicon.ico"))
+              fs.create(fs.join(directory, "assets", "images", "favicon.ico"), file("favicon.ico"), force:)
             end
 
             if Hanami.bundled?("hanami-db") && !opts.fetch(:skip_db, false)
@@ -122,7 +145,7 @@ module Hanami
                 key: "db.relation",
                 base_path: directory,
                 parent_class_name: "#{Hanami.app.namespace}::DB::Relation"
-              ).create
+              ).create(force:)
 
               RubyClassFile.new(
                 fs: fs,
@@ -131,7 +154,7 @@ module Hanami
                 key: "db.repo",
                 base_path: directory,
                 parent_class_name: "#{Hanami.app.namespace}::DB::Repo"
-              ).create
+              ).create(force:)
 
               RubyClassFile.new(
                 fs: fs,
@@ -140,7 +163,7 @@ module Hanami
                 key: "db.struct",
                 base_path: directory,
                 parent_class_name: "#{Hanami.app.namespace}::DB::Struct"
-              ).create
+              ).create(force:)
 
               fs.touch(fs.join(directory, "relations", ".keep"))
               fs.touch(fs.join(directory, "repos", ".keep"))

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

@@ -17,7 +17,7 @@ module Hanami
 
           # @since 2.2.0
           # @api private
-          def call(key:, namespace:, base_path:)
+          def call(key:, namespace:, base_path:, force: false)
             RubyClassFile.new(
               fs: fs,
               inflector: inflector,
@@ -26,7 +26,7 @@ module Hanami
               base_path: base_path,
               extra_namespace: "Structs",
               parent_class_name: "#{inflector.camelize(namespace)}::DB::Struct"
-            ).create
+            ).create(force:)
           end
 
           private

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

@@ -17,6 +17,9 @@ module Hanami
           TEMPLATES_FOLDER = "templates"
           private_constant :TEMPLATES_FOLDER
 
+          DEFAULT_TEMPLATE_ENGINE = "erb"
+          private_constant :DEFAULT_TEMPLATE_ENGINE
+
           # @since 2.0.0
           # @api private
           def initialize(fs:, inflector:, out: $stdout)
@@ -27,11 +30,11 @@ module Hanami
 
           # @since 2.0.0
           # @api private
-          def call(key:, namespace:, base_path:)
+          def call(key:, namespace:, base_path:, template_engine: DEFAULT_TEMPLATE_ENGINE, force: false)
             view_class_file(key:, namespace:, base_path:).then do |view_class|
-              view_class.create
+              view_class.create(force:)
               view_class_name = view_class.fully_qualified_name
-              create_template_file(key:, base_path:, view_class_name:)
+              create_template_file(key:, base_path:, view_class_name:, template_engine:, force:)
             end
           end
 
@@ -51,7 +54,7 @@ module Hanami
             )
           end
 
-          def create_template_file(key:, base_path:, view_class_name:)
+          def create_template_file(key:, base_path:, view_class_name:, template_engine:, force: false)
             key_parts = key.split(KEY_SEPARATOR)
             class_name_from_key = key_parts.pop # takes last segment as the class name
             module_names_from_key = key_parts # the rest of the segments are the module names
@@ -60,23 +63,30 @@ module Hanami
               base_path,
               TEMPLATES_FOLDER,
               module_names_from_key,
-              template_file_name(class_name_from_key, DEFAULT_FORMAT)
+              template_file_name(class_name_from_key, DEFAULT_FORMAT, template_engine)
             )
-            body = "<h1>#{view_class_name}</h1>\n"
-            fs.create(file_path, body)
+            fs.create(file_path, body_for_engine(view_class_name, template_engine), force:)
           end
 
-          def template_file_name(name, format)
+          def template_file_name(name, format, engine)
             ext =
               case format.to_sym
               when :html
-                ".html.erb"
+                ".html.#{engine}"
               else
-                ".erb"
+                ".#{engine}"
               end
 
             "#{name}#{ext}"
           end
+
+          def body_for_engine(view_class_name, engine)
+            case engine
+            when "erb" then "<h1>#{view_class_name}</h1>\n"
+            when "haml" then "%h1 #{view_class_name}\n"
+            when "slim" then "h1 #{view_class_name}\n"
+            end
+          end
         end
       end
     end

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

@@ -4,22 +4,15 @@ 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, **options)
           @inflector = inflector
           @app = app
           @options = options
         end
 
-        # @since 2.0.0
-        # @api private
         def ctx
           binding
         end
@@ -30,8 +23,6 @@ module Hanami
           %(gem "#{gem_name}", #{hanami_gem_version(name)})
         end
 
-        # @since 2.0.0
-        # @api private
         def hanami_gem_version(name)
           gem_name = name == "hanami" ? "hanami" : "hanami-#{name}"
 
@@ -42,8 +33,9 @@ module Hanami
           end
         end
 
-        # @since 2.1.0
-        # @api private
+        # Minimum esbuild version. Keep this in with the hanami-assets peer dependency.
+        ESBUILD_NPM_REQUIREMENT = "^0.28.1"
+
         def hanami_assets_npm_package
           if hanami_head?
             %("hanami-assets": "hanami/assets-js#main")
@@ -52,32 +44,26 @@ module Hanami
           end
         end
 
-        # @since 2.0.0
-        # @api private
+        def esbuild_npm_package
+          %("esbuild": "#{ESBUILD_NPM_REQUIREMENT}")
+        end
+
         def camelized_app_name
           inflector.camelize(app).gsub(/[^\p{Alnum}]/, "")
         end
 
-        # @since 2.0.0
-        # @api private
         def underscored_app_name
           inflector.underscore(app)
         end
 
-        # @since 2.1.0
-        # @api private
         def humanized_app_name
           inflector.humanize(app)
         end
 
-        # @since 2.1.0
-        # @api private
         def hanami_head?
           options.fetch(:head)
         end
 
-        # @since 2.3.0
-        # @api private
         def gem_source
           value = options.fetch(:gem_source)
           return value if value.match? %r{\A\w+://}
@@ -85,44 +71,39 @@ module Hanami
           "https://#{value}"
         end
 
-        # @since 2.1.0
-        # @api private
+        def gem_coop?
+          value = options.fetch(:gem_source)
+          value.match? %r{(\A\w+://)?gem.coop}
+        end
+
         def generate_assets?
           !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_view?
           !options.fetch(:skip_view, false)
         end
 
-        # @since 2.2.0
-        # @api private
+        def generate_mailer?
+          !options.fetch(:skip_mailer, false)
+        end
+
         def generate_sqlite?
           generate_db? && database_option == Commands::Gem::New::DATABASE_SQLITE
         end
 
-        # @since 2.2.0
-        # @api private
         def generate_postgres?
           generate_db? && database_option == Commands::Gem::New::DATABASE_POSTGRES
         end
 
-        # @since 2.2.0
-        # @api private
         def generate_mysql?
           generate_db? && database_option == Commands::Gem::New::DATABASE_MYSQL
         end
 
-        # @since 2.2.0
-        # @api private
         def database_url
           if generate_sqlite?
             "sqlite://db/#{app}.sqlite"
@@ -135,48 +116,47 @@ module Hanami
           end
         end
 
-        # @since 2.1.0
-        # @api private
         def bundled_views?
           Hanami.bundled?("hanami-view")
         end
 
-        # @since 2.1.0
-        # @api private
         def bundled_assets?
           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
-        #
         # @see https://rubyreferences.github.io/rubychanges/3.1.html#values-in-hash-literals-and-keyword-arguments-can-be-omitted
         def ruby_omit_hash_values?
           RUBY_VERSION >= "3.1"
         end
 
+        def template_engine
+          options.fetch(:template_engine)
+        end
+
+        def generate_rspec?
+          test_framework_option == "rspec"
+        end
+
+        def generate_minitest?
+          test_framework_option == "minitest"
+        end
+
         private
 
         def database_option
           options.fetch(:database, Commands::Gem::New::DATABASE_SQLITE)
         end
 
-        # @since 2.0.0
-        # @api private
-        attr_reader :inflector
+        def test_framework_option
+          options.fetch(:test_framework, Commands::Gem::New::TEST_FRAMEWORK_DEFAULT)
+        end
 
-        # @since 2.0.0
-        # @api private
+        attr_reader :inflector
         attr_reader :app
-
-        # @since 2.1.0
-        # @api private
         attr_reader :options
       end
     end

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

@@ -4,5 +4,8 @@ require "hanami"
 
 module <%= camelized_app_name %>
   class App < Hanami::App
+    <%- if generate_view? && template_engine != "erb" -%>
+    config.views.default_template_engine = "<%= template_engine %>"
+    <%- end -%>
   end
 end

data/lib/hanami/cli/generators/gem/app/app_layout.haml.erb

@@ -0,0 +1,15 @@
+!!!
+%html{:lang => "en"}
+  %head
+    %meta{:charset => "UTF-8"}/
+    %meta{:content => "width=device-width, initial-scale=1.0", :name => "viewport"}/
+    %title <%= humanized_app_name %>
+    <%- if generate_assets? -%>
+    = favicon_tag
+    = stylesheet_tag "app"
+    <%- end -%>
+  %body
+    = yield
+    <%- if generate_assets? -%>
+    = javascript_tag "app"
+    <%- end -%>

data/lib/hanami/cli/generators/gem/app/app_layout.slim.erb

@@ -0,0 +1,15 @@
+doctype html
+html lang="en"
+  head
+    meta charset="UTF-8"
+    meta name="viewport" content="width=device-width, initial-scale=1.0"
+    title <%= humanized_app_name %>
+    <%- if generate_assets? -%>
+    = favicon_tag
+    = stylesheet_tag "app"
+    <%- end -%>
+  body
+    = yield
+    <%- if generate_assets? -%>
+    = javascript_tag "app"
+    <%- end -%>

data/lib/hanami/cli/generators/gem/app/assets.js

@@ -3,7 +3,7 @@ import * as assets from "hanami-assets";
 // Assets are managed by esbuild (https://esbuild.github.io), and can be
 // customized below.
 //
-// Learn more at https://guides.hanamirb.org/assets/customization/.
+// Learn more at https://hanakai.org/learn/hanami/assets/customization/.
 
 await assets.run({
   esbuildOptionsFn: (args, esbuildOptions) => {

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

@@ -4,7 +4,7 @@
 module <%= camelized_app_name %>
   module Views
     class Context < Hanami::View::Context
-      # Define your view context here. See https://guides.hanamirb.org/views/context/ for details.
+      # Define your view context here. See https://hanakai.org/learn/hanami/views/context/ for details.
     end
   end
 end

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

@@ -1,4 +1,21 @@
-# This is checked into source control, so put sensitive values into `.env.local`
+# This is checked into source control, so put sensitive values into `.env.local`.
+#
+# See https://hanakai.org/learn/hanami/app/settings for how `.env` files are loaded.
 <%- if generate_db? -%>
+
 DATABASE_URL=<%= database_url %>
 <%- end -%>
+<%- if generate_mailer? -%>
+
+# SMTP delivery for Hanami Mailer (in development and production envs only).
+#
+# See https://hanakai.org/learn/hanami/mailers for details.
+#
+# Set these in `.env.local` or another `.env` file not checked into source control.
+#
+# SMTP_ADDRESS=smtp.example.com
+# SMTP_PORT=587
+# SMTP_USERNAME=mailer@example.com
+# SMTP_PASSWORD=s3cr3t
+# SMTP_AUTHENTICATION=plain
+<%- end -%>

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

@@ -2,6 +2,22 @@
 
 source "<%= gem_source %>"
 
+<%- if gem_coop? and !hanami_head? -%>
+source "https://gem.coop/@hanami" do
+  <%= hanami_gem("hanami") %>
+  <%- if generate_assets? -%>
+  <%= hanami_gem("assets") %>
+  <%- end -%>
+  <%= hanami_gem("action") %>
+  <%- if generate_db? -%>
+  <%= hanami_gem("db") %>
+  <%- end -%>
+  <%= hanami_gem("router") %>
+  <%- if generate_view? -%>
+  <%= hanami_gem("view") %>
+  <%- end -%>
+end
+<%- else -%>
 <%= hanami_gem("hanami") %>
 <%- if hanami_head? -%>
 <%= hanami_gem("cli") %>
@@ -10,19 +26,33 @@ source "<%= gem_source %>"
 <%- if generate_assets? -%>
 <%= hanami_gem("assets") %>
 <%- end -%>
-<%= hanami_gem("controller") %>
+<%= hanami_gem("action") %>
 <%- if generate_db? -%>
 <%= hanami_gem("db") %>
 <%- end -%>
+<%- if generate_mailer? -%>
+<%= hanami_gem("mailer") %>
+<%- end -%>
 <%= hanami_gem("router") %>
-<%= hanami_gem("validations") %>
 <%- if generate_view? -%>
 <%= hanami_gem("view") %>
 <%- end -%>
+<%- end -%>
+
+<%- if gem_coop? -%>
+source "https://gem.coop/@dry" do
+  gem "dry-types", "~> 1.7"
+  gem "dry-operation", ">= 1.0.1"
+  gem "dry-validation", "~> 1.11"
+end
 
+<%- else -%>
 gem "dry-types", "~> 1.7"
 gem "dry-operation", ">= 1.0.1"
-gem "puma"
+gem "dry-validation", "~> 1.11"
+<%- end -%>
+gem "i18n", "~> 1.14"
+gem "puma", ">= 7.1"
 gem "rake"
 <%- if generate_sqlite? -%>
 gem "sqlite3"
@@ -31,19 +61,33 @@ gem "pg"
 <%- elsif generate_mysql? -%>
 gem "mysql2"
 <%- end -%>
+<%- if generate_view? && template_engine == "haml" -%>
+gem "haml"
+<%- end -%>
+<%- if generate_view? && template_engine == "slim" -%>
+gem "slim"
+<%- end -%>
 
 group :development do
-  <%= hanami_gem("webconsole") %>
+  <%= hanami_gem("webconsole") %><%- if gem_coop? -%>, source: "https://gem.coop/@hanami"<% end %>
 end
 
 group :development, :test do
   gem "dotenv"
+  <%- if generate_db? -%>
+  # Syntax highlighting SQL logs
+  gem "rouge"
+  <%- end -%>
 end
 
 group :cli, :development do
-  <%= hanami_gem("reloader") %>
+  <%= hanami_gem("reloader") %><%- if gem_coop? -%>, source: "https://gem.coop/@hanami"<% end %>
 end
 
 group :cli, :development, :test do
-  <%= hanami_gem("rspec") %>
+<%- if generate_rspec? -%>
+  <%= hanami_gem("rspec") %><%- if gem_coop? -%>, source: "https://gem.coop/@hanami"<% end %>
+<%- elsif generate_minitest? -%>
+  <%= hanami_gem("minitest") %><%- if gem_coop? -%>, source: "https://gem.coop/@hanami"<% end %>
+<%- end -%>
 end

data/lib/hanami/cli/generators/gem/app/package.json.erb

@@ -3,6 +3,7 @@
   "private": true,
   "type": "module",
   "dependencies": {
+    <%= esbuild_npm_package %>,
     <%= hanami_assets_npm_package %>
   }
 }

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

@@ -32,9 +32,6 @@ workers puma_concurrency
 #
 
 if puma_cluster_mode
-  # Preload the application before starting the workers. Only in cluster mode.
-  preload_app!
-
   # Code to run immediately before master process forks workers (once on boot).
   #
   # These hooks can block if necessary to wait for background operations unknown

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

@@ -11,5 +11,5 @@
 
 ## Useful links
 
-- [Hanami](http://hanamirb.org)
-- [Hanami guides](https://guides.hanamirb.org/)
+- [Hanami](https://hanakai.org/hanami)
+- [Hanami guides](https://hanakai.org/learn#hanami)