hanami-cli 2.1.0.beta1 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '078a7a10f1196ed8635a9c27ee48ac10178cdcff50d2646138f61b55f79f86a7'
-  data.tar.gz: 870c056fc5da9f5952daf357ca2861f0e276510c6ca1e63a2f821af76ebdd09a
+  metadata.gz: '054178514bf7e420e00cd8da8a148cd4d479609668c180507fadbcd7a086f15d'
+  data.tar.gz: 3ef8c388ad8c8734179ce042d3eb966dea6df881b72e7615f0b104a1890106a5
 SHA512:
-  metadata.gz: d70ee9d87779f442c25517abfefde102460848e8a29ba9ef30ae28cc2b2593f73027dad42b99e5617820952a84fd22013a8de5d039fb2e6161a64fd2eef706a1
-  data.tar.gz: 815418cd1c416bea1f7a77c56dff20ed143b582795bbcd79904260509c8c62c7d62a7be76c11305d26dc793dd2c2a13fcba0532c365ad47278212159e40eff69
+  metadata.gz: c8e1abc0ded22d56ee2acd5dec6d9f7079c0331d187b1d4ff4b26858faf50ff870016e1adfa6b785673d39b6d0dcf097dca7c1b0526da442e1939ce0952f3799
+  data.tar.gz: 8ecc3ceefc10856cbd2f60ec24bd1ecde442764610dbb7d179f064080ac434fa4829374efb05513c67420ab8b76b0280ad594fd566824fdfba0e8d14afc209fb

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 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
+
+- [Luca Guidi] `hanami new` generates `Procfile.dev`
+- [Luca Guidi] `hanami new` generates basic app assets, if `hanami-assets` is bundled by the app
+- [Luca Guidi] `hanami new` accepts `--head` to generate the app using Hanami HEAD version from GitHub
+- [Luca Guidi] `hanami generate slice` generates basic slice assets, if `hanami-assets` is bundled by the app
+- [Ryan Bigg] `hanami generate action` generates corresponding view, if `hanami-view` is bundled by the app
+- [Luca Guidi] `hanami assets compile` to compile assets at the deploy time
+- [Luca Guidi] `hanami assets watch` to watch and compile assets at the development time
+- [Luca Guidi] `hanami dev` to start the processes in `Procfile.dev`
+
+### Fixed
+
+- [Luca Guidi] `hanami new` generates a `Gemfile` with `hanami-webconsole` in `:development` group
+- [Luca Guidi] `hanami new` generates a `Gemfile` with versioned `hanami-webconsole`, `hanami-rspec`, and `hanami-reloader`
+
 ## v2.1.0.beta1 - 2023-06-29
 
 ### Added

data/Gemfile

@@ -10,9 +10,12 @@ unless ENV["CI"]
 end
 
 gem "hanami", github: "hanami/hanami", branch: "main"
-gem "hanami-utils", github: "hanami/utils", branch: "main"
-gem "hanami-router", github: "hanami/router", branch: "main"
+gem "hanami-assets", github: "hanami/assets", branch: "main"
 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"
 

data/hanami-cli.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bundler", "~> 2.1"
   spec.add_dependency "dry-cli", "~> 1.0", "< 2"
-  spec.add_dependency "dry-files", "~> 1.0", ">= 1.0.1", "< 2"
+  spec.add_dependency "dry-files", "~> 1.0", ">= 1.0.2", "< 2"
   spec.add_dependency "dry-inflector", "~> 1.0", "< 2"
   spec.add_dependency "rake", "~> 13.0"
   spec.add_dependency "zeitwerk", "~> 2.6"

data/lib/hanami/cli/bundler.rb

@@ -3,7 +3,7 @@
 require "bundler"
 require "open3"
 require "etc"
-require "dry/files"
+require_relative "files"
 require_relative "system_call"
 require_relative "errors"
 
@@ -45,12 +45,12 @@ module Hanami
 
       # Returns a new bundler.
       #
-      # @param fs [Dry::Files] the filesystem interaction object
+      # @param fs [Hanami::CLI::Files] the filesystem interaction object
       # @param system_call [SystemCall] convenience object for making system calls
       #
       # @since 2.0.0
       # @api public
-      def initialize(fs: Dry::Files.new, system_call: SystemCall.new)
+      def initialize(fs: Hanami::CLI::Files.new, system_call: SystemCall.new)
         @fs = fs
         @system_call = system_call
       end
@@ -71,7 +71,7 @@ module Hanami
       #
       # @return [SystemCall::Result] the result of the `bundle` command execution
       #
-      # @raise [StandardError] if the `bundle` command does not execute successfully
+      # @raise [Hanami::CLI::BundleInstallError] if the `bundle` command does not execute successfully
       #
       # @since 2.0.0
       # @api public
@@ -81,6 +81,20 @@ module Hanami
         end
       end
 
+      # Runs the given Hanami CLI command via `bundle exec hanami`
+      #
+      # @return [SystemCall::Result] the result of the command execution
+      #
+      # @raise [Hanami::CLI::HanamiExecError] if the does not execute successfully
+      #
+      # @since 2.1.0
+      # @api public
+      def hanami_exec(cmd, env: nil, &blk)
+        exec("hanami #{cmd}", env: env, &blk).tap do |result|
+          raise HanamiExecError.new(cmd, result.err) unless result.successful?
+        end
+      end
+
       # Executes the given command prefixed by `bundle exec`.
       #
       # @return [SystemCall::Result] the result of the command execution
@@ -127,7 +141,7 @@ module Hanami
 
       private
 
-      # @return [Dry::Files]
+      # @return [Hanami::CLI::Files]
       #
       # @since 2.0.0
       # @api public

data/lib/hanami/cli/command.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require "dry/cli"
-require "dry/files"
 require "dry/inflector"
+require_relative "files"
 
 module Hanami
   module CLI
@@ -19,12 +19,12 @@ module Hanami
       #
       # @param out [IO] I/O stream for standard command output
       # @param err [IO] I/O stream for comment errror output
-      # @param fs [Dry::Files] object for managing file system interactions
+      # @param fs [Hanami::CLI::Files] object for managing file system interactions
       # @param inflector [Dry::Inflector] inflector for any command-level inflections
       #
       # @since 2.0.0
       # @api public
-      def initialize(out: $stdout, err: $stderr, fs: Dry::Files.new, inflector: Dry::Inflector.new)
+      def initialize(out: $stdout, err: $stderr, fs: Hanami::CLI::Files.new, inflector: Dry::Inflector.new)
         super()
         @out = out
         @err = err
@@ -52,7 +52,7 @@ module Hanami
 
       # Returns the object for managing file system interactions.
       #
-      # @return [Dry::Files]
+      # @return [Hanami::CLI::Files]
       #
       # @since 2.0.0
       # @api public

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require_relative "../command"
+require_relative "../../../system_call"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Assets
+          # @since 2.1.0
+          # @api private
+          class Command < App::Command
+            def initialize(config: app.config.assets, system_call: SystemCall.new, **)
+              super()
+              @system_call = system_call
+              @config = config
+            end
+
+            # @since 2.1.0
+            # @api private
+            def call(**)
+              cmd, *args = cmd_with_args
+
+              system_call.call(cmd, *args)
+            end
+
+            private
+
+            # @since 2.1.0
+            # @api private
+            attr_reader :config
+
+            # @since 2.1.0
+            # @api private
+            attr_reader :system_call
+
+            # @since 2.1.0
+            # @api private
+            def cmd_with_args
+              [config.package_manager_run_command, "assets"]
+            end
+
+            # @since 2.1.0
+            # @api private
+            def entry_points
+              config.entry_points.map do |entry_point|
+                escape(entry_point)
+              end.join(" ")
+            end
+
+            # @since 2.1.0
+            # @api private
+            def destination
+              escape(config.destination)
+            end
+
+            # @since 2.1.0
+            # @api private
+            def escape(str)
+              Shellwords.shellescape(str)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "command"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Assets
+          # @since 2.1.0
+          # @api private
+          class Compile < Assets::Command
+            desc "Compile assets for deployments"
+
+            # @since 2.1.0
+            # @api private
+            def cmd_with_args
+              result = super
+
+              if config.subresource_integrity.any?
+                result << "--"
+                result << "--sri=#{config.subresource_integrity.join(',')}"
+              end
+
+              result
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "command"
+require_relative "../../../interactive_system_call"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Assets
+          # @since 2.1.0
+          # @api private
+          class Watch < Assets::Command
+            desc "Start assets watch mode"
+
+            def initialize(config: app.config.assets, system_call: InteractiveSystemCall.new, **)
+              super(config: config, system_call: system_call)
+            end
+
+            private
+
+            # @since 2.1.0
+            # @api private
+            def cmd_with_args
+              super + ["--", "--watch"]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        # @since 2.1.0
+        # @api private
+        module Assets
+          require_relative "assets/compile"
+          require_relative "assets/watch"
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "dry/files"
 require "hanami/env"
 require_relative "db/utils/database"
+require_relative "../../files"
 
 module Hanami
   module CLI
@@ -75,7 +75,7 @@ module Hanami
             klass.new(
               out: out,
               inflector: app.inflector,
-              fs: Dry::Files
+              fs: Hanami::CLI::Files,
             ).call(*args)
           end
 

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "../../interactive_system_call"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        # @since 2.1.0
+        # @api private
+        class Dev < App::Command
+          # @since 2.1.0
+          # @api private
+          desc "Start the application in development mode"
+
+          # @since 2.1.0
+          # @api private
+          def initialize(interactive_system_call: InteractiveSystemCall.new, **)
+            @interactive_system_call = interactive_system_call
+            super()
+          end
+
+          # @since 2.1.0
+          # @api private
+          def call(**)
+            bin, args = executable
+            interactive_system_call.call(bin, *args)
+          end
+
+          private
+
+          # @since 2.1.0
+          # @api private
+          attr_reader :interactive_system_call
+
+          # @since 2.1.0
+          # @api private
+          def executable
+            [::File.join("bin", "dev")]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -60,7 +60,8 @@ module Hanami
 
             # @since 2.0.0
             # @api private
-            def call(name:, url: nil, http: nil, format: DEFAULT_FORMAT, skip_view: DEFAULT_SKIP_VIEW, slice: nil, **)
+            def call(name:, url: nil, http: nil, format: DEFAULT_FORMAT, skip_view: DEFAULT_SKIP_VIEW, slice: nil,
+                     context: nil, **)
               slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
               name = naming.action_name(name)
               *controller, action = name.split(ACTION_SEPARATOR)
@@ -69,7 +70,7 @@ module Hanami
                 raise InvalidActionNameError.new(name)
               end
 
-              generator.call(app.namespace, controller, action, url, http, format, skip_view, slice)
+              generator.call(app.namespace, controller, action, url, http, format, skip_view, slice, context: context)
             end
 
             # rubocop:enable Metrics/ParameterLists

data/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

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../../system_call"
+
 module Hanami
   module CLI
     module Commands
@@ -18,9 +20,22 @@ module Hanami
         # @since 2.0.0
         # @api private
         class Install < Command
+          # @since 2.1.0
+          # @api private
+          DEFAULT_HEAD = false
+          private_constant :DEFAULT_HEAD
+
+          # @since 2.1.0
+          # @api private
           desc "Install Hanami third-party plugins"
 
-          def call(*)
+          # @since 2.1.0
+          # @api private
+          option :head, type: :boolean, desc: "Install head deps", default: DEFAULT_HEAD
+
+          # @since 2.0.0
+          # @api private
+          def call(head: DEFAULT_HEAD, **)
           end
         end
       end

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

@@ -14,15 +14,24 @@ module Hanami
           base.module_eval do
             register "version", Commands::App::Version, aliases: ["v", "-v", "--version"]
             register "install", Commands::App::Install
+            register "dev", Commands::App::Dev
             register "console", Commands::App::Console, aliases: ["c"]
             register "server", Commands::App::Server, aliases: ["s"]
             register "routes", Commands::App::Routes
             register "middleware", Commands::App::Middleware
 
+            if Hanami.bundled?("hanami-assets")
+              register "assets" do |prefix|
+                prefix.register "compile", Assets::Compile
+                prefix.register "watch", Assets::Watch
+              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 "part", Generate::Part
             end
           end
         end

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

@@ -10,21 +10,55 @@ module Hanami
         # @since 2.0.0
         # @api private
         class New < Command
+          # @since 2.0.0
+          # @api private
           SKIP_INSTALL_DEFAULT = false
           private_constant :SKIP_INSTALL_DEFAULT
 
+          # @since 2.1.0
+          # @api private
+          HEAD_DEFAULT = false
+          private_constant :HEAD_DEFAULT
+
+          # @since 2.1.0
+          # @api private
+          SKIP_ASSETS_DEFAULT = false
+          private_constant :SKIP_ASSETS_DEFAULT
+
           desc "Generate a new Hanami app"
 
+          # @since 2.0.0
+          # @api private
           argument :app, required: true, desc: "App name"
 
+          # @since 2.0.0
+          # @api private
           option :skip_install, type: :boolean, 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,
+                        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,
+                               default: SKIP_ASSETS_DEFAULT,
+                               desc: "Skip assets"
+
+          # rubocop:disable Layout/LineLength
           example [
-            "bookshelf                # Generate a new Hanami app in `bookshelf/' directory, using `Bookshelf' namespace", # rubocop:disable Layout/LineLength
-            "bookshelf --skip-install # Generate a new Hanami app, but it skips Hanami installation"
+            "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"
           ]
+          # rubocop:enable Layout/LineLength
+
+          # rubocop:disable Metrics/ParameterLists
 
           # @since 2.0.0
           # @api private
@@ -33,42 +67,58 @@ module Hanami
             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:, skip_install: SKIP_INSTALL_DEFAULT, **)
+          def call(app:, head: HEAD_DEFAULT, skip_install: SKIP_INSTALL_DEFAULT, skip_assets: SKIP_ASSETS_DEFAULT, **)
             app = inflector.underscore(app)
 
             raise PathAlreadyExistsError.new(app) if fs.exist?(app)
 
             fs.mkdir(app)
             fs.chdir(app) do
-              generator.call(app) do
+              context = Generators::Context.new(inflector, app, head: head, skip_assets: skip_assets)
+              generator.call(app, context: context) do
                 if skip_install
                   out.puts "Skipping installation, please enter `#{app}' directory and run `bundle exec hanami install'"
                 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!
+                  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!
-            bundler.exec("hanami install").tap do |result|
+          def run_install_commmand!(head:)
+            head_flag = head ? " --head" : ""
+            bundler.exec("hanami install#{head_flag}").tap do |result|
               raise HanamiInstallError.new(result.err) unless result.successful?
             end
           end