hanami 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a1a430f511f0bda44248e88d4fb2c87d10dc3d8fbabf092b895ff2a3bbb78db
-  data.tar.gz: 75c6e767584d34103505eb3637fc0fb72dde6118b35fa5f4a76a186681031e7a
+  metadata.gz: 2ff0a8cf3ce1df8c90acbb5feb8352cc0f05d0981ad9b08ac4f6f62351e8d775
+  data.tar.gz: ec3ca71f07e1f4120fb6c4792163a2ffbf926de2160264a294563b6d2a6c77d1
 SHA512:
-  metadata.gz: 306e3261fb72d114ddcb9128de3a3c9a499bff57f1b2c51fd3cee54e644248c3bd981f54b626d7e5549e1fa9c467d86156a7c2c3e4c14c869501e698d07f6423
-  data.tar.gz: a59bf43bf07700e282abe6e83919fd53a5e277b7efa5706b743a25537006eef76b49409bedf0af49cae8122bd39d5c396f705f1e148a01367565e1accb46d9a6
+  metadata.gz: ce1c3e798ba14c6ec3778beb25b47feaf87bc32dd995797836cdb8a7af9b8e13a6d401e7005f8ec78cf3da4ec5cc5be086f0ff2763eb2082939900ede5f4bae3
+  data.tar.gz: eb4f586e78f1afa3f674ca3e9f7499d7699e4d0c432aef744f98d788a8a77398f11ee27bd9619ed98463bc8065a28d35e9cb8e73b41b18c4044aaab7c9549507

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 The web, with simplicity.
 
+## v2.0.0 - 2022-11-22
+
+### Added
+
+- [Tim Riley] Allow custom code from Hanami app `lib/` to be required before to load the app
+- [Tim Riley] Support the new `Hanami::Action::Config#formats` config from hanami-controller 2.0.0
+- [Tim Riley] Automatically use body_parser middleware when actions `:json` format is configured
+
+### Fixed
+
+- [Luca Guidi] Ensure Hanami app to not crash when `hanami-controller` isn't bundled
+- [Piotr Solnica] Several logger fixes
+
+### Changed
+
+- [Tim Riley] Don't assign a default MIME Type for Hanami apps
+
 ## v2.0.0.rc1 - 2022-11-08
 
 ### Added

data/FEATURES.md

@@ -4,27 +4,21 @@
 
 ## Features
 
-## v2.0.0.beta1 - 2021-07-20
-
-- Generate new apps using `app/` directory
-
-## v2.0.0.alpha8 - 2021-05-19
-
-## v2.0.0.alpha7.1 - 2021-03-09
-
-## v2.0.0.alpha7 - 2021-03-08
-
-## v2.0.0.alpha6 - 2021-02-10
-
-## v2.0.0.alpha5 - 2021-01-12
-
-## v2.0.0.alpha4 - 2021-12-07
-
-## v2.0.0.alpha3 - 2021-11-09
-
-## v2.0.0.alpha2 - 2021-05-04
-
-## v2.0.0.alpha1 - 2019-01-30
+## v2.0.0 - 2021-11-22
+
+- Renamed _apps_ into _slices_, and _project_ into _app_
+- The core of new applications is going to be `app/`. Slices are now optional.
+- App class built around a container for managing app components; code from `app/` is loaded into the app
+- Apps may have multiple Slices; code from `slices/[slice_name]/` is loaded into the corresponding slice
+- `MyApp::Deps` or `MySlice::Deps` mixin for auto-registering dependencies from the app or a slice
+- Code autoloading using Zeitwerk
+- Code reloading via Guard
+- Providers for setting up and managing the lifecycle of your app's critical components and integrations
+- Type-safe app settings
+- Rebuilt high-performance router
+- Redesigned stateless `Hamami::Action` classes supporting the Deps mixin; add your behavior to `#handle(request, response)`
+- Simplified action format configuration via `config.format` and `config.formats`
+- Rewritten CLI and console
 
 ## v1.3.3 - 2019-09-20
 

data/README.md

@@ -8,19 +8,16 @@ The web, with simplicity.
 
 ## Frameworks
 
-Hanami is a **full-stack** Ruby web framework.
-It's made up of smaller, single-purpose libraries.
+Hanami is a **full-stack** Ruby web framework. It's made up of smaller, single-purpose libraries.
 
-This repository is for the full-stack framework,
-which provides the glue that ties all the parts together:
+This repository is for the full-stack framework, which provides the glue that ties all the parts together:
 
-* [**Hanami::View**](https://github.com/hanami/view) - Presentation with a separation between views and templates
-* [**Hanami::Controller**](https://github.com/hanami/controller) - Full featured, fast and testable actions for Rack
 * [**Hanami::Router**](https://github.com/hanami/router) - Rack compatible HTTP router for Ruby
+* [**Hanami::Controller**](https://github.com/hanami/controller) - Full featured, fast and testable actions for Rack
+* [**Hanami::View**](https://github.com/hanami/view) - Presentation with a separation between views and templates
 * [**Hanami::Helpers**](https://github.com/hanami/helpers) - View helpers for Ruby applications
 * [**Hanami::Mailer**](https://github.com/hanami/mailer) - Mail for Ruby applications
 * [**Hanami::Assets**](https://github.com/hanami/assets) - Assets management for Ruby
-* [**Hanami::Utils**](https://github.com/hanami/utils) - Ruby core extensions and class utilities
 
 These components are designed to be used independently or together in a Hanami application.
 
@@ -28,9 +25,7 @@ These components are designed to be used independently or together in a Hanami a
 
 [![Gem Version](https://badge.fury.io/rb/hanami.svg)](https://badge.fury.io/rb/hanami)
 [![CI](https://github.com/hanami/hanami/workflows/ci/badge.svg?branch=main)](https://github.com/hanami/hanami/actions?query=workflow%3Aci+branch%3Amain)
-[![Test Coverage](https://codecov.io/gh/hanami/hanami/branch/main/graph/badge.svg)](https://codecov.io/gh/hanami/hanami)
 [![Depfu](https://badges.depfu.com/badges/ba000e0f69e6ef1c44cd3038caaa1841/overview.svg)](https://depfu.com/github/hanami/hanami?project=Bundler)
-[![Inline Docs](http://inch-ci.org/github/hanami/hanami.svg)](http://inch-ci.org/github/hanami/hanami)
 
 ## Installation
 
@@ -75,10 +70,7 @@ You can give back to Open Source, by supporting Hanami development via [GitHub S
 
 ## Community
 
-We strive for an inclusive and helpful community.
-We have a [Code of Conduct](http://hanamirb.org/community/#code-of-conduct) to handle controversial cases.
-In general, we expect **you** to be **nice** with other people.
-Our hope is for a great software and a great Community.
+We strive for an inclusive and helpful community. We have a [Code of Conduct](http://hanamirb.org/community/#code-of-conduct) to handle controversial cases. In general, we expect **you** to be **nice** with other people. Our hope is for a great software and a great Community.
 
 ## Contributing [![Open Source Helpers](https://www.codetriage.com/hanami/hanami/badges/users.svg)](https://www.codetriage.com/hanami/hanami)
 
@@ -90,44 +82,22 @@ Our hope is for a great software and a great Community.
 
 In addition to contributing code, you can help to triage issues. This can include reproducing bug reports, or asking for vital information such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to [subscribe to hanami on CodeTriage](https://www.codetriage.com/hanami/hanami).
 
-### How To Use Hanami HEAD
-
-If you want to test Hanami's HEAD to try a new feature or to test a bug fix, here's how to do:
-
-```
-git clone https://github.com/hanami/hanami.git
-cd hanami && bundle
-bundle exec hanami new bookshelf --hanami-head
-cd bookshelf
-vim Gemfile # edit with: gem 'hanami', path: '..'
-bundle
-```
-
 ### Development Requirements
 
-  * Ruby 2.3+ / JRuby 9.1.5.0+
+  * Ruby >= 3.0
   * Bundler
-  * [PhantomJS](http://phantomjs.org/download.html)
   * Node.js (MacOS)
 
 ### Testing
 
-In order to simulate installed gems on developers' computers, the build installs
-all the gems locally in `vendor/cache`, including `hanami` code from `lib/`.
+In order to simulate installed gems on developers' computers, the build installs all the gems locally in `vendor/cache`, including `hanami` code from `lib/`.
 
 **Before running a test, please make sure you have a fresh version of the code:**
 
 ```shell
-./script/setup
 bundle exec rspec spec/path/to/file_spec.rb
 ```
 
-To run all the tests, please use:
-
-```shell
-./script/ci
-```
-
 ## Versioning
 
 __Hanami__ uses [Semantic Versioning 2.0.0](http://semver.org)

data/hanami.gemspec

@@ -35,11 +35,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-configurable", "~> 1.0", "< 2"
   spec.add_dependency "dry-core",         "~> 1.0", "< 2"
   spec.add_dependency "dry-inflector",    "~> 1.0", "< 2"
-  spec.add_dependency "dry-monitor",      "~> 1.0", "< 2"
-  spec.add_dependency "dry-system",       "~> 1.0.rc"
-  spec.add_dependency "dry-logger",       "~> 1.0.rc"
-  spec.add_dependency "hanami-cli",       "~> 2.0.rc"
-  spec.add_dependency "hanami-utils",     "~> 2.0.rc"
+  spec.add_dependency "dry-monitor",      "~> 1.0", ">= 1.0.1", "< 2"
+  spec.add_dependency "dry-system",       "~> 1.0", "< 2"
+  spec.add_dependency "dry-logger",       "~> 1.0", "< 2"
+  spec.add_dependency "hanami-cli",       "~> 2.0"
+  spec.add_dependency "hanami-utils",     "~> 2.0"
   spec.add_dependency "zeitwerk",         "~> 2.6"
 
   spec.add_development_dependency "rspec",     "~> 3.8"

data/lib/hanami/app.rb

@@ -29,11 +29,6 @@ module Hanami
         subclass.class_eval do
           @config = Hanami::Config.new(app_name: slice_name, env: Hanami.env)
 
-          # Prepare the load path (based on the default root of `Dir.pwd`) as early as possible, so
-          # you can make a `require` inside the body of an `App` subclass, which may be useful for
-          # certain kinds of app configuration.
-          prepare_load_path
-
           load_dotenv
         end
       end

data/lib/hanami/config/actions.rb

@@ -136,9 +136,6 @@ module Hanami
 
       # Apply defaults for base config
       def configure_defaults
-        self.default_request_format = :html
-        self.default_response_format = :html
-
         self.default_headers = {
           "X-Frame-Options" => "DENY",
           "X-Content-Type-Options" => "nosniff",

data/lib/hanami/config/logger.rb

@@ -15,9 +15,15 @@ module Hanami
       # @return [Hanami::SliceName]
       #
       # @api private
-      # @since 2.0.o
+      # @since 2.0.0
       attr_reader :app_name
 
+      # @return [Symbol]
+      #
+      # @api private
+      # @since 2.0.0
+      attr_reader :env
+
       # @!attribute [rw] level
       #   Sets or returns the logger level.
       #
@@ -40,7 +46,7 @@ module Hanami
       #
       #   @api public
       #   @since 2.0.0
-      setting :stream
+      setting :stream, default: $stdout
 
       # @!attribute [rw] formatter
       #   Sets or returns the logger's formatter.
@@ -57,7 +63,7 @@ module Hanami
       #
       #   @api public
       #   @since 2.0.0
-      setting :formatter
+      setting :formatter, default: :string
 
       # @!attribute [rw] template
       #   Sets or returns log entry string template
@@ -68,7 +74,7 @@ module Hanami
       #
       #   @api public
       #   @since 2.0.0
-      setting :template, default: "[%<progname>s] [%<severity>s] [%<time>s] %<message>s"
+      setting :template, default: :details
 
       # @!attribute [rw] filters
       #   Sets or returns an array of attribute names to filter from logs.
@@ -85,11 +91,11 @@ module Hanami
       # @!attribute [rw] logger_constructor
       #   Sets or returns the constructor proc to use for the logger instantiation.
       #
-      #   Defaults to `Dry.method(:Logger)`.
+      #   Defaults to either `Config#production_logger` or `Config#development_logger`
       #
       #   @api public
       #   @since 2.0.0
-      setting :logger_constructor, default: Dry.method(:Logger)
+      setting :logger_constructor
 
       # @!attribute [rw] options
       #   Sets or returns a hash of options to pass to the {logger_constructor} when initializing
@@ -113,27 +119,18 @@ module Hanami
       # @api private
       def initialize(env:, app_name:)
         @app_name = app_name
-
-        config.level = case env
-                       when :production
-                         :info
-                       else
-                         :debug
-                       end
-
-        config.stream = case env
-                        when :test
-                          File.join("log", "#{env}.log")
-                        else
-                          $stdout
-                        end
-
-        config.formatter = case env
-                           when :production
-                             :json
-                           else
-                             :rack
-                           end
+        @env = env
+
+        case env
+        when :development, :test
+          config.level = :debug
+          config.stream = File.join("log", "#{env}.log") if env == :test
+          config.logger_constructor = method(:development_logger)
+        when :production
+          config.level = :info
+          config.formatter = :json
+          config.logger_constructor = method(:production_logger)
+        end
       end
 
       # Returns a new instance of the logger.
@@ -143,13 +140,39 @@ module Hanami
       # @api public
       # @since 2.0.0
       def instance
-        logger_constructor.call(app_name.name, **logger_constructor_opts)
+        logger_constructor.call(env, app_name.name, **logger_constructor_options)
+      end
+
+      # Build an instance of a development logger
+      #
+      # This logger is used in both development and test
+      #
+      # @return [Dry::Logger::Dispatcher]
+      # @since 2.0.0
+      # @api private
+      def development_logger(_env, app_name, **options)
+        Dry.Logger(app_name, **options) do |setup|
+          setup
+            .add_backend(log_if: -> entry { !entry.tag?(:rack) })
+            .add_backend(formatter: :rack, log_if: -> entry { entry.tag?(:rack) })
+        end
+      end
+
+      # Build an instance of a production logger
+      #
+      # This logger is used in both development and test
+      #
+      # @return [Dry::Logger::Dispatcher]
+      # @since 2.0.0
+      # @api private
+      def production_logger(_env, app_name, **options)
+        Dry.Logger(app_name, **options)
       end
 
       private
 
       # @api private
-      def logger_constructor_opts
+      def logger_constructor_options
         {stream: stream,
           level: level,
           formatter: formatter,

data/lib/hanami/config.rb

@@ -274,6 +274,8 @@ module Hanami
       logger.finalize!
       router.finalize!
 
+      use_body_parser_middleware
+
       super
     end
 
@@ -371,7 +373,26 @@ module Hanami
       self.slices = ENV["HANAMI_SLICES"]&.split(",")&.map(&:strip)
     end
 
-    # @api private
+    SUPPORTED_MIDDLEWARE_PARSERS = %i[json].freeze
+    private_constant :SUPPORTED_MIDDLEWARE_PARSERS
+
+    def use_body_parser_middleware
+      return unless Hanami.bundled?("hanami-controller")
+
+      return if actions.formats.empty?
+      return if middleware.stack["/"].map(&:first).any? { |klass| klass == "Hanami::Middleware::BodyParser" }
+
+      parsers = SUPPORTED_MIDDLEWARE_PARSERS & actions.formats.values
+      return if parsers.empty?
+
+      middleware.use(
+        :body_parser,
+        [parsers.to_h { |parser_format|
+          [parser_format, actions.formats.mime_types_for(parser_format)]
+        }]
+      )
+    end
+
     def load_dependent_config(gem_name)
       if Hanami.bundled?(gem_name)
         yield

data/lib/hanami/extensions/action/slice_configured_action.rb

@@ -60,7 +60,7 @@ module Hanami
             #
             #   module MyApp
             #     class Action < Hanami::Action
-            #       config.default_response_format = :json
+            #       config.format :json
             #     end
             #   end
             #
@@ -91,7 +91,10 @@ module Hanami
 
             next if slice.parent && slice_value == parent_value
 
-            action_class.config.public_send(:"#{setting.name}=", slice_value)
+            action_class.config.public_send(
+              :"#{setting.name}=",
+              setting.mutable? ? slice_value.dup : slice_value
+            )
           end
         end
 

data/lib/hanami/extensions/view/slice_configured_view.rb

@@ -77,7 +77,10 @@ module Hanami
 
             next if slice.parent && slice_value == parent_value
 
-            view_class.config.public_send(:"#{setting.name}=", slice_value)
+            view_class.config.public_send(
+              :"#{setting.name}=",
+              setting.mutable? ? slice_value.dup : slice_value
+            )
           end
 
           view_class.config.inflector = inflector

data/lib/hanami/providers/rack.rb

@@ -27,9 +27,10 @@ module Hanami
 
         notifications = target[:notifications]
 
-        monitor_middleware = Dry::Monitor::Rack::Middleware.new(notifications)
+        clock = Dry::Monitor::Clock.new(unit: :microsecond)
+        monitor_middleware = Dry::Monitor::Rack::Middleware.new(notifications, clock: clock)
 
-        rack_logger = Hanami::Web::RackLogger.new(target[:logger])
+        rack_logger = Hanami::Web::RackLogger.new(target[:logger], env: target.env)
         rack_logger.attach(monitor_middleware)
 
         register "monitor", monitor_middleware

data/lib/hanami/rake_tasks.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
-require "hanami/cli/rake_tasks"
-require "hanami/cli/command_line"
+require "hanami/cli"
 
 Hanami::CLI::RakeTasks.register_tasks do
-  @_hanami_command_line = Hanami::CLI::CommandLine.new
-
   desc "Load the app environment"
   task :environment do
     require "hanami/prepare"
@@ -53,8 +50,10 @@ Hanami::CLI::RakeTasks.register_tasks do
 
   private
 
+  @_hanami_cli_bundler = Hanami::CLI::Bundler.new
+
   def run_hanami_command(command)
-    @_hanami_command_line.call(command)
+    @_hanami_cli_bundler.exec(command)
   end
 end
 

data/lib/hanami/slice.rb

@@ -957,7 +957,9 @@ module Hanami
           **config.router.options
         ) do
           use(rack_monitor)
-          use(*config.actions.sessions.middleware) if config.actions.sessions.enabled?
+          if Hanami.bundled?("hanami-controller")
+            use(*config.actions.sessions.middleware) if config.actions.sessions.enabled?
+          end
 
           middleware_stack.update(config.middleware_stack)
         end

data/lib/hanami/version.rb

@@ -7,7 +7,7 @@ module Hanami
   # @api private
   module Version
     # @api public
-    VERSION = "2.0.0.rc1"
+    VERSION = "2.0.0"
 
     # @since 0.9.0
     # @api private

data/lib/hanami/web/rack_logger.rb

@@ -8,6 +8,9 @@ module Hanami
     # @api private
     # @since 2.0.0
     class RackLogger
+      EMPTY_PARAMS = {}.freeze
+      private_constant :EMPTY_PARAMS
+
       REQUEST_METHOD = "REQUEST_METHOD"
       private_constant :REQUEST_METHOD
 
@@ -29,10 +32,46 @@ module Hanami
       CONTENT_LENGTH = "Content-Length"
       private_constant :CONTENT_LENGTH
 
+      MILISECOND = "ms"
+      private_constant :MILISECOND
+
+      MICROSECOND = "µs"
+      private_constant :MICROSECOND
+
+      # Dynamic extension used in production environments
+      # @api private
+      module Production
+        private
+
+        # @since 1.0.0
+        # @api private
+        def data(env, status:, elapsed:)
+          payload = super
+          payload[:elapsed] = elapsed
+          payload[:elapsed_unit] = MICROSECOND
+          payload
+        end
+      end
+
+      # Dynamic extension used in non-production environments
+      # @api private
+      module Development
+        private
+
+        # @since 1.0.0
+        # @api private
+        def data(env, status:, elapsed:)
+          payload = super
+          payload[:elapsed] = elapsed > 1000 ? "#{elapsed / 1000}ms" : "#{elapsed}#{MICROSECOND}"
+          payload
+        end
+      end
+
       # @api private
       # @since 2.0.0
-      def initialize(logger)
+      def initialize(logger, env: :development)
         @logger = logger
+        extend(env == :production ? Production : Development)
       end
 
       # @api private
@@ -43,36 +82,46 @@ module Hanami
         end
 
         rack_monitor.on :error do |event|
-          log_exception event[:exception]
+          # TODO: why we don't provide time on error?
+          log_exception event[:env], event[:exception], 500, 0
         end
       end
 
       # @api private
       # @since 2.0.0
       def log_request(env, status, elapsed)
-        data = {
-          verb: env[REQUEST_METHOD],
-          status: status,
-          elapsed: "#{elapsed}ms",
-          ip: env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR],
-          path: env[SCRIPT_NAME] + env[PATH_INFO].to_s,
-          length: extract_content_length(env),
-          params: env[ROUTER_PARAMS]
-        }
-
-        logger.info(data)
+        logger.tagged(:rack) do
+          logger.info(data(env, status: status, elapsed: elapsed))
+        end
       end
 
       # @api private
       # @since 2.0.0
-      def log_exception(exception)
-        logger.error(exception)
+      def log_exception(env, exception, status, elapsed)
+        logger.tagged(:rack) do
+          logger.error(exception, **data(env, status: status, elapsed: elapsed))
+        end
       end
 
       private
 
       attr_reader :logger
 
+      # @api private
+      # @since 2.0.0
+      def data(env, status:, elapsed:)
+        {
+          verb: env[REQUEST_METHOD],
+          status: status,
+          ip: env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR],
+          path: "#{env[SCRIPT_NAME]}#{env[PATH_INFO]}",
+          length: extract_content_length(env),
+          params: env.fetch(ROUTER_PARAMS, EMPTY_PARAMS)
+        }
+      end
+
+      # @api private
+      # @since 2.0.0
       def extract_content_length(env)
         value = env[CONTENT_LENGTH]
         !value || value.to_s == "0" ? "-" : value

data/lib/hanami.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "zeitwerk"
 require_relative "hanami/constants"
 
@@ -36,7 +37,8 @@ module Hanami
     app_path = self.app_path
 
     if app_path
-      require(app_path)
+      prepare_load_path
+      require(app_path.to_s)
       app
     elsif raise_exception
       raise(
@@ -47,6 +49,23 @@ module Hanami
     end
   end
 
+  # Prepare the load path as early as possible (based on the default root inferred from the location
+  # of `config/app.rb`), so `require` can work at the top of `config/app.rb`. This may be useful
+  # when external classes are needed for configuring certain aspects of the app.
+  #
+  # @api private
+  # @since 2.0.0
+  private_class_method def self.prepare_load_path
+    lib_path = app_path&.join("..", "..", LIB_DIR)
+
+    if lib_path&.directory?
+      path = lib_path.realpath.to_s
+      $LOAD_PATH.prepend(path) unless $LOAD_PATH.include?(path)
+    end
+
+    lib_path
+  end
+
   # Returns the Hamami app class.
   #
   # To ensure your Hanami app is loaded, run {.setup} (or `require "hanami/setup"`) first.
@@ -98,10 +117,10 @@ module Hanami
   # Searches within the given directory, then searches upwards through parent directories until the
   # app file can be found.
   #
-  # @param dir [String] The directory from which to start searching. Defaults to the current
-  #   directory.
+  # @param dir [String, Pathname] The directory from which to start searching. Defaults to the
+  #   current directory.
   #
-  # @return [String, nil] the app file path, or nil if not found.
+  # @return [Pathname, nil] the app file path, or nil if not found.
   #
   # @api public
   # @since 2.0.0
@@ -110,7 +129,7 @@ module Hanami
     path = dir.join(APP_PATH)
 
     if path.file?
-      path.to_s
+      path
     elsif !dir.root?
       app_path(dir.parent)
     end