Merge branch 'main' into 2.1.x

Author: jodosha

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 Hanami Command Line Interface
 
+## v2.1.0.rc1 - 2023-11-01
+
+### Added
+
+- [Tim Riley] `hanami new` to generate `bin/dev` as configuration for `hanami dev`
+- [Luca Guidi] Introducing `hanami generate part` to generate view parts
+
+### Fixed
+
+- [Luca Guidi] `hanami new` generates a fully documented Puma configuration in `config/puma.rb`
+
+### Changed
+
+- [Tim Riley] `hanami new` generates a `config/assets.mjs` as Assets configuration
+- [Tim Riley] `hanami new` generates a leaner `package.json`
+- [Tim Riley] `hanami new` doesn't generate a default root route anymore
+- [Aaron Moodie & Tim Riley] `hanami new` to generate a redesigned 404 and 500 error pages
+- [Luca Guidi] When generating a RESTful action, skip `create`, if `new` is present, and `update`, if `edit` is present
+
 ## v2.1.0.beta2 - 2023-10-04
 
 ### Added

Gemfile

@@ -15,6 +15,8 @@ gem "hanami-controller", github: "hanami/controller", branch: "main"
 gem "hanami-router", github: "hanami/router", branch: "main"
 gem "hanami-utils", github: "hanami/utils", branch: "main"
 
+gem "dry-files", github: "dry-rb/dry-files", branch: "main"
+
 gem "rack"
 
 group :test do

lib/hanami/cli/commands/app.rb

@@ -31,6 +31,7 @@ def self.extended(base)
               prefix.register "slice", Generate::Slice
               prefix.register "action", Generate::Action
               prefix.register "view", Generate::View
+              prefix.register "part", Generate::Part
             end
           end
         end

lib/hanami/cli/commands/app/assets/command.rb

@@ -23,7 +23,7 @@ def initialize(config: app.config.assets, system_call: SystemCall.new, **)
             def call(**)
               cmd, *args = cmd_with_args
 
-              system_call.call(cmd, *args, env: env)
+              system_call.call(cmd, *args)
             end
 
             private
@@ -39,20 +39,7 @@ def call(**)
             # @since 2.1.0
             # @api private
             def cmd_with_args
-              [
-                config.package_manager_executable,
-                config.package_manager_command,
-                config.executable
-              ]
-            end
-
-            # @since 2.1.0
-            # @api private
-            def env
-              ENV.to_h.merge(
-                "ESBUILD_ENTRY_POINTS" => entry_points,
-                "ESBUILD_OUTDIR" => destination
-              )
+              [config.package_manager_run_command, "assets"]
             end
 
             # @since 2.1.0

lib/hanami/cli/commands/app/assets/watch.rb

@@ -22,11 +22,7 @@ def initialize(config: app.config.assets, system_call: InteractiveSystemCall.new
             # @since 2.1.0
             # @api private
             def cmd_with_args
-              super +
-                [
-                  "--",
-                  "--watch"
-                ]
+              super + ["--", "--watch"]
             end
           end
         end

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

@@ -13,16 +13,6 @@ class Dev < App::Command
           # @api private
           desc "Start the application in development mode"
 
-          # @since 2.1.0
-          # @api private
-          option :procfile, type: :string, desc: "Path to Procfile", aliases: ["-f"]
-
-          # @since 2.1.0
-          # @api private
-          example [
-            "-f /path/to/Procfile",
-          ]
-
           # @since 2.1.0
           # @api private
           def initialize(interactive_system_call: InteractiveSystemCall.new, **)
@@ -32,8 +22,8 @@ def initialize(interactive_system_call: InteractiveSystemCall.new, **)
 
           # @since 2.1.0
           # @api private
-          def call(procfile: nil, **)
-            bin, args = executable(procfile: procfile)
+          def call(**)
+            bin, args = executable
             interactive_system_call.call(bin, *args)
           end
 
@@ -45,10 +35,8 @@ def call(procfile: nil, **)
 
           # @since 2.1.0
           # @api private
-          def executable(procfile: nil)
-            # TODO: support other implementations of Foreman
-            # See: https://github.com/ddollar/foreman#ports
-            ["foreman", ["start", "-f", procfile || "Procfile.dev"]]
+          def executable
+            [::File.join("bin", "dev")]
           end
         end
       end

lib/hanami/cli/commands/app/generate/part.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
+          # @since 2.1.0
+          # @api private
+          class Part < App::Command
+            argument :name, required: true, desc: "Part name"
+            option :slice, required: false, desc: "Slice name"
+
+            example [
+              %(book               (MyApp::Views::Parts::Book)),
+              %(book --slice=admin (Admin::Views::Parts::Book)),
+            ]
+            attr_reader :generator
+            private :generator
+
+            # @since 2.0.0
+            # @api private
+            def initialize(
+              fs: Hanami::CLI::Files.new,
+              inflector: Dry::Inflector.new,
+              generator: Generators::App::Part.new(fs: fs, inflector: inflector),
+              **
+            )
+              @generator = generator
+              super(fs: fs)
+            end
+
+            # @since 2.0.0
+            # @api private
+            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

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

@@ -33,37 +33,9 @@ class Install < Command
           # @api private
           option :head, type: :boolean, desc: "Install head deps", default: DEFAULT_HEAD
 
-          # @since 2.1.0
-          # @api private
-          def initialize(system_call: SystemCall.new, **)
-            @system_call = system_call
-            super()
-          end
-
           # @since 2.0.0
           # @api private
           def call(head: DEFAULT_HEAD, **)
-            install_hanami_assets!(head: head)
-          end
-
-          private
-
-          # @since 2.1.0
-          # @api private
-          attr_reader :system_call
-
-          # @since 2.1.0
-          # @api private
-          def install_hanami_assets!(head:)
-            return unless Hanami.bundled?("hanami-assets")
-
-            system_call.call("npm", ["init", "-y"])
-
-            if head
-              system_call.call("npm", %w[install https://github.com/hanami/assets-js])
-            else
-              system_call.call("npm", %w[install hanami-assets])
-            end
           end
         end
       end

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

@@ -58,20 +58,28 @@ class New < Command
           ]
           # rubocop:enable Layout/LineLength
 
+          # 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),
             generator: Generators::Gem::App.new(fs: fs, inflector: inflector),
+            system_call: SystemCall.new,
             **other
           )
             @bundler = bundler
             @generator = generator
+            @system_call = system_call
             super(fs: fs, inflector: inflector, **other)
           end
 
+          # rubocop:enable Metrics/ParameterLists
+
+          # rubocop:disable Metrics/AbcSize
+
           # @since 2.0.0
           # @api private
           def call(app:, head: HEAD_DEFAULT, skip_install: SKIP_INSTALL_DEFAULT, skip_assets: SKIP_ASSETS_DEFAULT, **)
@@ -88,17 +96,25 @@ def call(app:, head: HEAD_DEFAULT, skip_install: SKIP_INSTALL_DEFAULT, skip_asse
                 else
                   out.puts "Running Bundler install..."
                   bundler.install!
+
+                  unless skip_assets
+                    out.puts "Running npm install..."
+                    system_call.call("npm", ["install"])
+                  end
+
                   out.puts "Running Hanami install..."
                   run_install_commmand!(head: head)
                 end
               end
             end
           end
+          # rubocop:enable Metrics/AbcSize
 
           private
 
           attr_reader :bundler
           attr_reader :generator
+          attr_reader :system_call
 
           def run_install_commmand!(head:)
             head_flag = head ? " --head" : ""

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

@@ -56,6 +56,14 @@ def call(app, controller, action, url, http, format, skip_view, slice, context:
           }.freeze
           private_constant :ROUTE_RESTFUL_URL_SUFFIXES
 
+          # @api private
+          # @since 2.1.0
+          RESTFUL_COUNTERPART_VIEWS = {
+            "create" => "new",
+            "update" => "edit"
+          }.freeze
+          private_constant :RESTFUL_COUNTERPART_VIEWS
+
           PATH_SEPARATOR = "/"
           private_constant :PATH_SEPARATOR
 
@@ -77,7 +85,7 @@ def generate_for_slice(controller, action, url, http, format, skip_view, slice,
             fs.mkdir(directory = fs.join(slice_directory, "actions", controller))
             fs.write(fs.join(directory, "#{action}.rb"), t("slice_action.erb", context))
 
-            unless skip_view
+            if generate_view?(skip_view, action, directory)
               fs.mkdir(directory = fs.join(slice_directory, "views", controller))
               fs.write(fs.join(directory, "#{action}.rb"), t("slice_view.erb", context))
 
@@ -97,12 +105,15 @@ def generate_for_app(controller, action, url, http, format, skip_view, context)
             fs.mkdir(directory = fs.join("app", "actions", controller))
             fs.write(fs.join(directory, "#{action}.rb"), t("action.erb", context))
 
-            unless skip_view
-              fs.mkdir(directory = fs.join("app", "views", controller))
-              fs.write(fs.join(directory, "#{action}.rb"), t("view.erb", context))
+            view = action
+            view_directory = fs.join("app", "views", controller)
 
-              fs.mkdir(directory = fs.join("app", "templates", controller))
-              fs.write(fs.join(directory, "#{action}.#{format}.erb"),
+            if generate_view?(skip_view, view, view_directory)
+              fs.mkdir(view_directory)
+              fs.write(fs.join(view_directory, "#{view}.rb"), t("view.erb", context))
+
+              fs.mkdir(template_directory = fs.join("app", "templates", controller))
+              fs.write(fs.join(template_directory, "#{view}.#{format}.erb"),
                        t(template_with_format_ext("template", format), context))
             end
           end
@@ -117,6 +128,35 @@ def route(controller, action, url, http)
                            http)} "#{route_url(controller, action, url)}", to: "#{controller.join('.')}.#{action}")
           end
 
+          # @api private
+          # @since 2.1.0
+          def generate_view?(skip_view, view, directory)
+            return false if skip_view
+            return generate_restful_view?(view, directory) if rest_view?(view)
+
+            true
+          end
+
+          # @api private
+          # @since 2.1.0
+          def generate_restful_view?(view, directory)
+            corresponding_action = corresponding_restful_view(view)
+
+            !fs.exist?(fs.join(directory, "#{corresponding_action}.rb"))
+          end
+
+          # @api private
+          # @since 2.1.0
+          def rest_view?(view)
+            RESTFUL_COUNTERPART_VIEWS.keys.include?(view)
+          end
+
+          # @api private
+          # @since 2.1.0
+          def corresponding_restful_view(view)
+            RESTFUL_COUNTERPART_VIEWS.fetch(view, nil)
+          end
+
           def template_with_format_ext(name, format)
             ext =
               case format.to_sym