hanami-cli 2.0.3 → 2.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bcebd7bee28802b90462073bbc9def8c6f1c13b7fc032cc8f20859b082310a4
-  data.tar.gz: fd38025e1fa7a2b5c6650710e16076fefa8f8697a1b3bba3035eedaa9ce612b4
+  metadata.gz: 85a528645e9205c15ccdf4b81cc32a3fb0789a8a7f07c56554c1b8b0e66b9e91
+  data.tar.gz: 5937fd333d11a7f5131d0298dc609c8a92e233249bc0b2e9e8f28705977f20b4
 SHA512:
-  metadata.gz: bdebf6ac07bfad66d9a7d37050ce6b91c7d29abc781c44807a0efdc8c7085db42ed7afcbf5b5b32f264213499e59d31754823a670eb43d71acee1be39dd0b5c2
-  data.tar.gz: 56a41e42c83896516b0b20d7aea8864743c9a96508fd520d226de683d59de612a85cd99e83f7ed50bf39cfa87564152afb903bbfdc6d4d8e48ed9eb1904705e1
+  metadata.gz: df19a905d03fec4665ce80dd89730dee6337312e32e0e923e9424a387d66b8f9605e8392a5a73bd4627251b96c57b4a95f4df32062d8a53d42041d69841c10d6
+  data.tar.gz: e4931266c0517de1bb33bc0f862c73da58366d6d5707c0eacf48fd38b08b8d7ae767e8fd7c81f1f048b96ffda5977674e556e281c51ab1f2a4eb30c6ceaa7ade

data/CHANGELOG.md

@@ -2,6 +2,39 @@
 
 Hanami Command Line Interface
 
+## 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

data/Gemfile

@@ -10,9 +10,10 @@ 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 "rack"
 

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

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,82 @@
+# 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, env: env)
+            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_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
+              )
+            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,36 @@
+# 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/db/rollback.rb

@@ -20,12 +20,20 @@ module Hanami
               migration_code, migration_name = find_migration(target)
 
               if migration_name.nil?
-                out.puts "==> migration file for target #{target} was not found"
+                output = if target
+                           "==> migration file for target #{target} was not found"
+                         else
+                           "==> no migrations to rollback"
+                         end
+
+                out.puts output
                 return
               end
 
               measure "database #{database.name} rolled back to #{migration_name}" do
                 database.run_migrations(target: Integer(migration_code))
+
+                true
               end
 
               run_command Structure::Dump if dump
@@ -33,14 +41,30 @@ module Hanami
 
             private
 
-            def find_migration(code)
-              migration = database.applied_migrations.then { |migrations|
+            def find_migration(code) # rubocop:disable Metrics/PerceivedComplexity
+              applied_migrations = database.applied_migrations
+
+              return if applied_migrations.empty?
+
+              # Rollback to initial state if we have only one migration and
+              # no target is specified. In this case the rollback target
+              # will be the current migration timestamp minus 1
+              if applied_migrations.one? && code.nil?
+                migration = applied_migrations.first
+
+                migration_code = Integer(migration.split("_").first) - 1
+                migration_name = "initial state"
+
+                return [migration_code, migration_name]
+              end
+
+              # Otherwise rollback to target or to previous migration
+              migration =
                 if code
-                  migrations.detect { |m| m.split("_").first == code }
+                  applied_migrations.detect { |m| m.split("_").first == code }
                 else
-                  migrations.last
+                  applied_migrations[-2]
                 end
-              }
 
               return unless migration
 

data/lib/hanami/cli/commands/app/db/utils/database.rb

@@ -139,7 +139,11 @@ module Hanami
                 @sequel_migrator ||= begin
                   require "sequel"
                   Sequel.extension :migration
-                  Sequel::TimestampMigrator.new(migrator.connection, migrations_path, {})
+
+                  require "rom/sql"
+                  ROM::SQL.with_gateway(gateway) do
+                    Sequel::TimestampMigrator.new(migrator.connection, migrations_path, {})
+                  end
                 end
               end
 

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

@@ -0,0 +1,57 @@
+# 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
+          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, **)
+            @interactive_system_call = interactive_system_call
+            super()
+          end
+
+          # @since 2.1.0
+          # @api private
+          def call(procfile: nil, **)
+            bin, args = executable(procfile: procfile)
+            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(procfile: nil)
+            # TODO: support other implementations of Foreman
+            # See: https://github.com/ddollar/foreman#ports
+            ["foreman", ["start", "-f", procfile || "Procfile.dev"]]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -26,8 +26,8 @@ module Hanami
             option :url, required: false, type: :string, desc: "Action URL"
             option :http, required: false, type: :string, desc: "Action HTTP method"
             # option :format, required: false, type: :string, default: DEFAULT_FORMAT, desc: "Template format"
-            # option :skip_view, required: false, type: :boolean, default: DEFAULT_SKIP_VIEW,
-            #                    desc: "Skip view and template generation"
+            option :skip_view, required: false, type: :boolean, default: DEFAULT_SKIP_VIEW,
+                               desc: "Skip view and template generation"
             option :slice, required: false, desc: "Slice name"
 
             # rubocop:disable Layout/LineLength
@@ -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/view.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "dry/inflector"
+require "dry/files"
+require "shellwords"
+require_relative "../../../naming"
+require_relative "../../../errors"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @since 2.0.0
+          # @api private
+          class View < App::Command
+            # TODO: make this configurable
+            DEFAULT_FORMAT = "html"
+            private_constant :DEFAULT_FORMAT
+
+            # TODO: make engine configurable
+
+            argument :name, required: true, desc: "View name"
+            option :slice, required: false, desc: "Slice name"
+
+            example [
+              %(books.index               (MyApp::Actions::Books::Index)),
+              %(books.index --slice=admin (Admin::Actions::Books::Index)),
+            ]
+            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::View.new(fs: fs, inflector: inflector),
+              **
+            )
+              @generator = generator
+              super(fs: fs)
+            end
+
+            # @since 2.0.0
+            # @api private
+            def call(name:, format: DEFAULT_FORMAT, slice: nil, **)
+              slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
+
+              generator.call(app.namespace, name, format, slice)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,8 +7,8 @@ module Hanami
         # @since 2.0.0
         # @api private
         module Generate
-          require_relative "./generate/slice"
-          require_relative "./generate/action"
+          require_relative "generate/slice"
+          require_relative "generate/action"
         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,50 @@ 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.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