hanami-cli 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1351e33232b164c6e82ac6148e95eac2562e43dcd36f1a1d11aad61307f32da
-  data.tar.gz: 647213baac46e31addb957a6ce4d3f8b11e28e64ddb02d3cfe1569ce49015ed6
+  metadata.gz: f0885d4f1e10f7f8bd8691c04524be0f6353de0b0a7ce19c2ecf42ae31c8f8cd
+  data.tar.gz: d6c27d7571896e9f93d2ab41206e50f922fdfecc892ccf3d2328f9123c6d2348
 SHA512:
-  metadata.gz: cb27cd6155cd93c1783402e32992104d32a41da98397ef57c0dc1b0b72edf0cb76c9203d48dc925c352f9742a16c274cf0679dc9e431c12d83ad69508478786d
-  data.tar.gz: 04cc7a076b6a66d30729ebaa28b9108cb41bd7515cd538d5a81a350b22850ff3fbefd27a0a9044130ed50bfa8dc34562ab6e32e57834924cc7c3e51a13468708
+  metadata.gz: 74180e374ac3836550e622af10dc998bc5356d3a745c2b0731ef2f03e2bc06f639ab5c375d7d53e7dc67fe40672eb80c38b77bb5cc6111d52d9a20da415de222
+  data.tar.gz: 94596b8dd6f53f2dc6d53f37bfcec37b5002324ef85715c9791b94ebb0fa198884c8acf7d339752e9bb11b0da9f8fbddb4fa5f89ec62fb49944af8cc8732087d

data/.github/workflows/ci.yml

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

data/{.action_hero.yml → .repobot.yml}

@@ -3,9 +3,7 @@
 sources:
   - repo: hanami/template-gem
     sync:
-      - ".action_hero.yml.erb"
+      - ".repobot.yml.erb"
       - ".github/FUNDING.yml"
-      - ".rspec"
-      - ".rubocop.yml"
       - "CODE_OF_CONDUCT.md"
       - "LICENSE.md.erb"

data/.rubocop.yml

@@ -8,9 +8,13 @@ Layout/LineLength:
   Exclude:
     - Gemfile
     - 'spec/**/*.rb'
+Lint/DuplicateBranch:
+  Enabled: false
 Lint/EmptyFile:
   Exclude:
     - 'spec/fixtures/**/*.rb'
+Lint/NonLocalExitFromIterator:
+  Enabled: false
 Naming/HeredocDelimiterNaming:
   Enabled: false
 Naming/MethodParameterName:
@@ -26,6 +30,8 @@ Style/CommentedKeyword:
   Enabled: false
 Style/EmptyHeredoc:
   Enabled: false
+Style/IdenticalConditionalBranches:
+  Enabled: false
 Style/LambdaCall:
   Enabled: false
 Style/TrailingCommaInArguments:

data/CHANGELOG.md

@@ -2,6 +2,121 @@
 
 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
+
+- [Tim Riley] Add `--skip-tests` for `hanami generate` commands. This CLI option will skip tests generation.
+
+### Changed
+
+- [Tim Riley] Set `"type": "module"` in package.json, enabling ES modules by default
+- [Tim Riley] Rename `config/assets.mjs` to `config/assets.js` (use a plain `.js` file extension)
+
+### Fixed
+
+- [Tim Riley] Use correct helper names in generated app layout
+- [Luca Guidi] Ensure to generate apps with correct pre-release version of `hanami-assets` NPM package
+- [Sean Collins] Print to stderr NPM installation errors when running `hanami install`
+- [Sean Collins] Ensure to install missing gems after `hanami install` is ran
+
+## 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
+
+- [Tim Riley] `hanami new` to generate default views, templates, and helpers
+- [Tim Riley] `hanami generate slice` to generate default views, templates, and helpers
+- [Tim Riley] `hanami generate action` to generate associated view and template
+- [Tim Riley] Introduced `hanami generate view`
+- [Tim Riley] `hanami new` to generate `Gemfile` with `hanami-view` and `hanami-webconsole` gems
+- [Tim Riley] `hanami new` to generate default error pages for `404` and `500` HTTP errors
+
+### Fixed
+
+- [Philip Arndt] `hanami server` to start only one Puma worker by default
+
+## v2.0.3 - 2023-02-01
+
+### Added
+
+- [Luca Guidi] Generate a default `.gitignore` when using `hanami new`
+
+### Fixed
+
+- [dsisnero] Ensure to run automatically bundle gems when using `hanami new` on Windows
+- [Luca Guidi] Ensure to generate the correct action identifier in routes when using `hanami generate action` with deeply nested action name
+
+## v2.0.2 - 2022-12-25
+
+### Added
+
+- [Luca Guidi] Official support for Ruby 3.2
+
+## v2.0.1 - 2022-12-06
+
+### Fixed
+
+- [Luca Guidi] Ensure to load `.env` files during CLI commands execution
+- [Luca Guidi] Ensure `hanami server` to respect HTTP port used in `.env` or the value given as CLI argument (`--port`)
+
 ## v2.0.0 - 2022-11-22
 
 ### Added

data/Gemfile

@@ -10,12 +10,17 @@ 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"
 
+gem "hanami-devtools", github: "hanami/devtools", branch: "main"
+
 group :test do
   gem "pry"
 end

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2022 Luca Guidi
+Copyright © 2014 Hanami Team
 
 MIT License
 

data/README.md

@@ -44,4 +44,4 @@ Everyone interacting in the `Hanami::CLI` project's codebases, issue trackers, c
 
 ## Copyright
 
-Copyright © 2014-2022 Hanami Team – Released under MIT License
+Copyright © 2014 Hanami Team – Released under MIT License

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,9 +3,9 @@
 require "bundler"
 require "open3"
 require "etc"
-require "dry/files"
-require_relative "./system_call"
-require_relative "./errors"
+require_relative "files"
+require_relative "system_call"
+require_relative "errors"
 
 module Hanami
   module CLI
@@ -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
@@ -146,10 +160,13 @@ module Hanami
       # @since 2.0.0
       # @api private
       def which(cmd)
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
         # Adapted from https://stackoverflow.com/a/5471032/498386
         ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
-          exe = fs.join(path, cmd)
-          return exe if fs.executable?(exe) && !fs.directory?(exe)
+          exts.each do |ext|
+            exe = fs.join(path, "#{cmd}#{ext}")
+            return exe if fs.executable?(exe) && !fs.directory?(exe)
+          end
         end
 
         nil

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
@@ -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 [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
       #
+      # @see .new
+      #
       # @since 2.0.0
       # @api public
-      def initialize(out: $stdout, err: $stderr, fs: Dry::Files.new, inflector: Dry::Inflector.new)
+      def initialize(out:, err:, fs:, inflector:)
         super()
         @out = out
         @err = err
@@ -52,7 +74,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,155 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require_relative "../command"
+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
+            # @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(**)
+              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) }
+
+              Signal.trap("INT") do
+                pids.each do |pid|
+                  Process.kill(sig, pid)
+                end
+              end
+
+              Process.waitall
+            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 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
+            # @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,35 @@
+# frozen_string_literal: true
+
+require_relative "command"
+
+module Hanami
+  module CLI
+    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 assets_command(slice)
+              cmd = super
+
+              if config.subresource_integrity.any?
+                cmd << "--sri=#{escape(config.subresource_integrity.join(','))}"
+              end
+
+              cmd
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "command"
+
+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"
+
+            private
+
+            # @since 2.1.0
+            # @api private
+            def assets_command(slice)
+              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,7 +1,8 @@
 # frozen_string_literal: true
 
-require "dry/files"
+require "hanami/env"
 require_relative "db/utils/database"
+require_relative "../../files"
 
 module Hanami
   module CLI
@@ -34,6 +35,7 @@ module Hanami
               hanami_env = env ? env.to_s : ENV.fetch("HANAMI_ENV", "development")
 
               ENV["HANAMI_ENV"] = hanami_env
+              Hanami::Env.load
 
               super(*args, **opts)
             end
@@ -73,7 +75,7 @@ module Hanami
             klass.new(
               out: out,
               inflector: app.inflector,
-              fs: Dry::Files
+              fs: Hanami::CLI::Files,
             ).call(*args)
           end
 
@@ -114,7 +116,7 @@ module Hanami
           #
           # @api private
           def database
-            @database ||= Commands::DB::Utils::Database[app]
+            @database ||= Commands::App::DB::Utils::Database[app]
           end
 
           # This is NOT AVAILABLE as of the 2.0.0 release.