hanami-cli 2.1.0.rc2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa0dbea6bc97ed3a7d08b703e7fd9091def9a8326196d36c071fb8e3e9be654b
-  data.tar.gz: dc27646ce5d395932bd2fbddef1678cb5445959494270b8d5f149462a8648e90
+  metadata.gz: f0885d4f1e10f7f8bd8691c04524be0f6353de0b0a7ce19c2ecf42ae31c8f8cd
+  data.tar.gz: d6c27d7571896e9f93d2ab41206e50f922fdfecc892ccf3d2328f9123c6d2348
 SHA512:
-  metadata.gz: ac1ab34a920c7fea44106a75c8c7e8d1bb0e475ff1e48ce2ef9b87912e9da6c83aa847ddf56661db13a01551fd58e098245b6d8ac277ca7143c69681d97d5ece
-  data.tar.gz: 706d1bb79523ba8a7efd9281267de12a0f275be0b60374c619b132371e0339335e6a4112b7a53ed5951e57293799aea1b4a89ac5bf6f9ee718daec4e1c44ee45
+  metadata.gz: 74180e374ac3836550e622af10dc998bc5356d3a745c2b0731ef2f03e2bc06f639ab5c375d7d53e7dc67fe40672eb80c38b77bb5cc6111d52d9a20da415de222
+  data.tar.gz: 94596b8dd6f53f2dc6d53f37bfcec37b5002324ef85715c9791b94ebb0fa198884c8acf7d339752e9bb11b0da9f8fbddb4fa5f89ec62fb49944af8cc8732087d

data/.github/workflows/ci.yml

@@ -24,6 +24,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - "3.3"
           - "3.2"
           - "3.1"
           - "3.0"

data/.rubocop.yml

@@ -13,6 +13,8 @@ Lint/DuplicateBranch:
 Lint/EmptyFile:
   Exclude:
     - 'spec/fixtures/**/*.rb'
+Lint/NonLocalExitFromIterator:
+  Enabled: false
 Naming/HeredocDelimiterNaming:
   Enabled: false
 Naming/MethodParameterName:

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 Hanami Command Line Interface
 
+## v2.1.0 - 2024-02-27
+
+### Changed
+
+- [Tim Riley] Underscore slice names in `public/assets/` to avoid naming conflicts with nested asset entry points. In this arrangement, an "admin" slice will have its assets compiled into `public/assets/_admin/`.
+
+## v2.1.0.rc3 - 2024-02-16
+
+### Changed
+
+- [Tim Riley] For `hanami assets` commands, run a separate assets compilation process per slice (in parallel).
+- [Tim Riley] Generate compiled assets into separate folders per slice, each with its own `assets.js` manifest file: `public/assets/` for the app, and `public/assets/[slice_name]/` for each slice.
+- [Tim Riley] For `hanami assets` commands, directly detect and invoke the `config/assets.js` files. Look for this file within each slice, and fall back to the app-level file.
+- [Tim Riley] Do not generate `"scripts": {"assets": "..."}` section in new app's `package.json`.
+- [Tim Riley] Subclasses of `Hanami::CLI::Command` receive default args to their `#initialize` methods, and do not need to re-declare default args themselves.
+- [Philip Arndt] Alphabetically sort hanami gems in the new app `Gemfile`.
+
+### Fixed
+
+- [Nishiki (錦華)] Strip invalid characters from module name when generating new app.
+
 ## v2.1.0.rc2 - 2023-11-08
 
 ### Added

data/Gemfile

@@ -19,6 +19,8 @@ gem "dry-files", github: "dry-rb/dry-files", branch: "main"
 
 gem "rack"
 
+gem "hanami-devtools", github: "hanami/devtools", branch: "main"
+
 group :test do
   gem "pry"
 end

data/lib/hanami/cli/command.rb

@@ -13,18 +13,40 @@ module Hanami
     class Command < Dry::CLI::Command
       # Returns a new command.
       #
-      # This method does not need to be called directly when creating comments for the CLI. Commands
+      # Provides default values so they can be available to any subclasses defining their own
+      # {#initialize} methods.
+      #
+      # @see #initialize
+      #
+      # @since 2.1.0
+      # @api public
+      def self.new(
+        out: $stdout,
+        err: $stderr,
+        fs: Hanami::CLI::Files.new,
+        inflector: Dry::Inflector.new,
+        **opts
+      )
+        super(out: out, err: err, fs: fs, inflector: inflector, **opts)
+      end
+
+      # Returns a new command.
+      #
+      # This method does not need to be called directly when creating commands for the CLI. Commands
       # are registered as classes, and the CLI framework will initialize the command when needed.
-      # This means that all parameters for `#initialize` should also be given default arguments.
+      # This means that all parameters for `#initialize` should also be given default arguments. See
+      # {.new} for the standard default arguments for all commands.
       #
       # @param out [IO] I/O stream for standard command output
       # @param err [IO] I/O stream for comment errror output
       # @param fs [Hanami::CLI::Files] object for managing file system interactions
       # @param inflector [Dry::Inflector] inflector for any command-level inflections
       #
+      # @see .new
+      #
       # @since 2.0.0
       # @api public
-      def initialize(out: $stdout, err: $stderr, fs: Hanami::CLI::Files.new, inflector: Dry::Inflector.new)
+      def initialize(out:, err:, fs:, inflector:)
         super()
         @out = out
         @err = err

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

@@ -2,28 +2,71 @@
 
 require "shellwords"
 require_relative "../command"
-require_relative "../../../system_call"
+require_relative "../../../interactive_system_call"
 
 module Hanami
   module CLI
     module Commands
       module App
         module Assets
+          # Base class for assets commands.
+          #
+          # Finds slices with assets present (anything in an `assets/` dir), then forks a child
+          # process for each slice to run the assets command (`config/assets.js`) for the slice.
+          #
+          # Prefers the slice's own `config/assets.js` if present, otherwise falls back to the
+          # app-level file.
+          #
+          # Passes `--path` and `--dest` arguments to this command to compile assets for the given
+          # slice only and save them into a dedicated directory (`public/assets/` for the app,
+          # `public/[slice_name]/` for slices).
+          #
+          # @see Watch
+          # @see Compile
+          #
           # @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
+            # @since 2.1.0
+            # @api private
+            def initialize(
+              out:, err:,
+              config: app.config.assets,
+              system_call: InteractiveSystemCall.new(out: out, err: err, exit_after: false),
+              **opts
+            )
+              super(out: out, err: err, **opts)
+
               @config = config
+              @system_call = system_call
             end
 
             # @since 2.1.0
             # @api private
             def call(**)
-              cmd, *args = cmd_with_args
+              slices = slices_with_assets
+
+              if slices.empty?
+                out.puts "No assets found."
+                return
+              end
+
+              slices.each do |slice|
+                unless assets_config(slice)
+                  out.puts "No assets config found for #{slice}. Please create a config/assets.js."
+                  return
+                end
+              end
+
+              pids = slices_with_assets.map { |slice| fork_child_assets_command(slice) }
 
-              system_call.call(cmd, *args)
+              Signal.trap("INT") do
+                pids.each do |pid|
+                  Process.kill(sig, pid)
+                end
+              end
+
+              Process.waitall
             end
 
             private
@@ -38,8 +81,65 @@ module Hanami
 
             # @since 2.1.0
             # @api private
-            def cmd_with_args
-              [config.package_manager_run_command, "assets"]
+            def fork_child_assets_command(slice)
+              Process.fork do
+                cmd, *args = assets_command(slice)
+                system_call.call(cmd, *args, out_prefix: "[#{slice.slice_name}] ")
+              rescue Interrupt
+                # When this has been interrupted (by the Signal.trap handler in #call), catch the
+                # interrupt and exit cleanly, without showing the default full backtrace.
+              end
+            end
+
+            # @since 2.1.0
+            # @api private
+            def assets_command(slice)
+              cmd = [config.node_command, assets_config(slice).to_s, "--"]
+
+              if slice.eql?(slice.app)
+                cmd << "--path=app"
+                cmd << "--dest=public/assets"
+              else
+                cmd << "--path=#{slice.root.relative_path_from(slice.app.root)}"
+                cmd << "--dest=public/assets/#{Hanami::Assets.public_assets_dir(slice)}"
+              end
+
+              cmd
+            end
+
+            # @since 2.1.0
+            # @api private
+            def slices_with_assets
+              slices = app.slices.with_nested + [app]
+              slices.select { |slice| slice_assets?(slice) }
+            end
+
+            # @since 2.1.0
+            # @api private
+            def slice_assets?(slice)
+              assets_path =
+                if slice.app.eql?(slice)
+                  slice.root.join("app", "assets")
+                else
+                  slice.root.join("assets")
+                end
+
+              assets_path.directory?
+            end
+
+            # Returns the path to the assets config (`config/assets.js`) for the given slice.
+            #
+            # Prefers a config file local to the slice, otherwise falls back to app-level config.
+            # Returns nil if no config can be found.
+            #
+            # @since 2.1.0
+            # @api private
+            def assets_config(slice)
+              config = slice.root.join("config", "assets.js")
+              return config if config.exist?
+
+              config = slice.app.root.join("config", "assets.js")
+              config if config.exist?
             end
 
             # @since 2.1.0

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

@@ -7,22 +7,25 @@ module Hanami
     module Commands
       module App
         module Assets
+          # Compiles assets for each slice.
+          #
           # @since 2.1.0
           # @api private
           class Compile < Assets::Command
             desc "Compile assets for deployments"
 
+            private
+
             # @since 2.1.0
             # @api private
-            def cmd_with_args
-              result = super
+            def assets_command(slice)
+              cmd = super
 
               if config.subresource_integrity.any?
-                result << "--"
-                result << "--sri=#{escape(config.subresource_integrity.join(','))}"
+                cmd << "--sri=#{escape(config.subresource_integrity.join(','))}"
               end
 
-              result
+              cmd
             end
           end
         end

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

@@ -1,28 +1,25 @@
 # frozen_string_literal: true
 
 require_relative "command"
-require_relative "../../../interactive_system_call"
 
 module Hanami
   module CLI
     module Commands
       module App
         module Assets
+          # Watches for asset changes within each slice.
+          #
           # @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"]
+            def assets_command(slice)
+              super + ["--watch"]
             end
           end
         end

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

@@ -15,23 +15,28 @@ module Hanami
 
           # @since 2.1.0
           # @api private
-          def initialize(interactive_system_call: InteractiveSystemCall.new, **)
-            @interactive_system_call = interactive_system_call
-            super()
+          def initialize(
+            out:, err:,
+            system_call: InteractiveSystemCall.new(out: out, err: err),
+            **opts
+          )
+            super(out: out, err: err, **opts)
+
+            @system_call = system_call
           end
 
           # @since 2.1.0
           # @api private
           def call(**)
             bin, args = executable
-            interactive_system_call.call(bin, *args)
+            system_call.call(bin, *args)
           end
 
           private
 
           # @since 2.1.0
           # @api private
-          attr_reader :interactive_system_call
+          attr_reader :system_call
 
           # @since 2.1.0
           # @api private

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

@@ -61,12 +61,16 @@ module Hanami
 
             # @since 2.0.0
             # @api private
-            def initialize(fs: Hanami::CLI::Files.new, inflector: Dry::Inflector.new,
-                           naming: Naming.new(inflector: inflector),
-                           generator: Generators::App::Action.new(fs: fs, inflector: inflector), **)
+            def initialize(
+              fs:, inflector:,
+              naming: Naming.new(inflector: inflector),
+              generator: Generators::App::Action.new(fs: fs, inflector: inflector),
+              **opts
+            )
+              super(fs: fs, inflector: inflector, **opts)
+
               @naming = naming
               @generator = generator
-              super(fs: fs)
             end
 
             # rubocop:disable Metrics/ParameterLists

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

@@ -34,13 +34,12 @@ module Hanami
             # @since 2.0.0
             # @api private
             def initialize(
-              fs: Hanami::CLI::Files.new,
-              inflector: Dry::Inflector.new,
+              fs:, inflector:,
               generator: Generators::App::Part.new(fs: fs, inflector: inflector),
-              **
+              **opts
             )
+              super(fs: fs, inflector: inflector, **opts)
               @generator = generator
-              super(fs: fs)
             end
 
             # @since 2.0.0

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

@@ -23,10 +23,13 @@ module Hanami
 
             # @since 2.0.0
             # @api private
-            def initialize(fs: Hanami::CLI::Files.new, inflector: Dry::Inflector.new,
-                           generator: Generators::App::Slice.new(fs: fs, inflector: inflector), **)
+            def initialize(
+              fs:, inflector:,
+              generator: Generators::App::Slice.new(fs: fs, inflector: inflector),
+              **opts
+            )
+              super(fs: fs, inflector: inflector, **opts)
               @generator = generator
-              super(fs: fs)
             end
 
             # @since 2.0.0

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

@@ -33,13 +33,12 @@ module Hanami
             # @since 2.0.0
             # @api private
             def initialize(
-              fs: Hanami::CLI::Files.new,
-              inflector: Dry::Inflector.new,
+              fs:, inflector:,
               generator: Generators::App::View.new(fs: fs, inflector: inflector),
-              **
+              **opts
             )
+              super(fs: fs, inflector: inflector, **opts)
               @generator = generator
-              super(fs: fs)
             end
 
             # @since 2.0.0

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

@@ -46,8 +46,8 @@ module Hanami
 
           # @since 2.0.0
           # @api private
-          def initialize(server: Hanami::CLI::Server.new)
-            super()
+          def initialize(server: Hanami::CLI::Server.new, **opts)
+            super(**opts)
             @server = server
           end
 

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

@@ -63,17 +63,16 @@ module Hanami
           # @since 2.0.0
           # @api private
           def initialize(
-            fs: Hanami::CLI::Files.new,
-            inflector: Dry::Inflector.new,
+            fs:, inflector:,
             bundler: CLI::Bundler.new(fs: fs),
             generator: Generators::Gem::App.new(fs: fs, inflector: inflector),
             system_call: SystemCall.new,
-            **other
+            **opts
           )
+            super(fs: fs, inflector: inflector, **opts)
             @bundler = bundler
             @generator = generator
             @system_call = system_call
-            super(fs: fs, inflector: inflector, **other)
           end
 
           # rubocop:enable Metrics/ParameterLists
@@ -98,7 +97,7 @@ module Hanami
                   bundler.install!
 
                   unless skip_assets
-                    out.puts "Running npm install..."
+                    out.puts "Running NPM install..."
                     system_call.call("npm", ["install"]).tap do |result|
                       unless result.successful?
                         puts "NPM ERROR:"

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

@@ -35,6 +35,7 @@ module Hanami
             if context.bundled_assets?
               fs.write(fs.join(directory, "assets", "js", "app.js"), t("app_js.erb", context))
               fs.write(fs.join(directory, "assets", "css", "app.css"), t("app_css.erb", context))
+              fs.write(fs.join(directory, "assets", "images", "favicon.ico"), file("favicon.ico"))
             end
 
             # fs.write(fs.join(directory, "/entities.rb"), t("entities.erb", context))
@@ -64,6 +65,10 @@ module Hanami
           end
 
           alias_method :t, :template
+
+          def file(path)
+            File.read(File.join(__dir__, "slice", path))
+          end
         end
       end
     end

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

@@ -38,13 +38,13 @@ module Hanami
           # @since 2.1.0
           # @api private
           def stylesheet_erb_tag
-            %(<%= stylesheet_tag "#{slice}/app" %>)
+            %(<%= stylesheet_tag "app" %>)
           end
 
           # @since 2.1.0
           # @api private
           def javascript_erb_tag
-            %(<%= javascript_tag "#{slice}/app" %>)
+            %(<%= javascript_tag "app" %>)
           end
 
           private

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

@@ -53,7 +53,7 @@ module Hanami
         # @since 2.0.0
         # @api private
         def camelized_app_name
-          inflector.camelize(app)
+          inflector.camelize(app).gsub(/[^\p{Alnum}]/, "")
         end
 
         # @since 2.0.0

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

@@ -4,6 +4,8 @@ await assets.run();
 
 // To provide additional esbuild (https://esbuild.github.io) options, use the following:
 //
+// Read more at: https://guides.hanamirb.org/assets/customization/
+//
 // await assets.run({
 //   esbuildOptionsFn: (args, esbuildOptions) => {
 //     // Add to esbuildOptions here. Use `args.watch` as a condition for different options for

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

@@ -3,13 +3,13 @@
 source "https://rubygems.org"
 
 <%= hanami_gem("hanami") %>
-<%= hanami_gem("router") %>
-<%= hanami_gem("controller") %>
-<%= hanami_gem("validations") %>
-<%= hanami_gem("view") %>
 <%- if generate_assets? -%>
 <%= hanami_gem("assets") %>
 <%- end -%>
+<%= hanami_gem("controller") %>
+<%= hanami_gem("router") %>
+<%= hanami_gem("validations") %>
+<%= hanami_gem("view") %>
 
 gem "dry-types", "~> 1.0", ">= 1.6.1"
 gem "puma"

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

@@ -2,9 +2,6 @@
   "name": "<%= underscored_app_name %>",
   "private": true,
   "type": "module",
-  "scripts": {
-    "assets": "node config/assets.js"
-  },
   "dependencies": {
     <%= hanami_assets_npm_package %>
   }

data/lib/hanami/cli/interactive_system_call.rb

@@ -9,15 +9,16 @@ module Hanami
     class InteractiveSystemCall
       # @api private
       # @since 2.1.0
-      def initialize(out: $stdout, err: $stderr)
+      def initialize(out: $stdout, err: $stderr, exit_after: true)
         @out = out
         @err = err
+        @exit_after = exit_after
         super()
       end
 
       # @api private
       # @since 2.1.0
-      def call(cmd, *args, env: {})
+      def call(cmd, *args, env: {}, out_prefix: "")
         ::Bundler.with_unbundled_env do
           threads = []
           exit_status = 0
@@ -26,14 +27,14 @@ module Hanami
           Open3.popen3(env, command(cmd, *args)) do |_stdin, stdout, stderr, wait_thr|
             threads << Thread.new do
               stdout.each_line do |line|
-                out.puts(line)
+                out.puts("#{out_prefix}#{line}")
               end
             rescue IOError # FIXME: Check if this is legit
             end
 
             threads << Thread.new do
               stderr.each_line do |line|
-                err.puts(line)
+                err.puts("#{out_prefix}#{line}")
               end
             rescue IOError # FIXME: Check if this is legit
             end
@@ -44,7 +45,7 @@ module Hanami
           end
           # rubocop:enable Lint/SuppressedException
 
-          exit(exit_status.exitstatus)
+          exit(exit_status.exitstatus) if @exit_after
         end
       end
 

data/lib/hanami/cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-cli
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc2
+  version: 2.1.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -250,6 +250,7 @@ files:
 - lib/hanami/cli/generators/app/slice/app_js.erb
 - lib/hanami/cli/generators/app/slice/app_layout.erb
 - lib/hanami/cli/generators/app/slice/entities.erb
+- 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
@@ -326,11 +327,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Hanami CLI