hanami 2.0.0.rc1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a1a430f511f0bda44248e88d4fb2c87d10dc3d8fbabf092b895ff2a3bbb78db
-  data.tar.gz: 75c6e767584d34103505eb3637fc0fb72dde6118b35fa5f4a76a186681031e7a
+  metadata.gz: feb360b6ea1b56e04569faecc65485d6bba65a6a59d4ef764830f0ae191fa62f
+  data.tar.gz: 420ee35b85415b3db8a8c55c7a09ca5bb4d2207f19dd8d1cd47ad767c6c5681c
 SHA512:
-  metadata.gz: 306e3261fb72d114ddcb9128de3a3c9a499bff57f1b2c51fd3cee54e644248c3bd981f54b626d7e5549e1fa9c467d86156a7c2c3e4c14c869501e698d07f6423
-  data.tar.gz: a59bf43bf07700e282abe6e83919fd53a5e277b7efa5706b743a25537006eef76b49409bedf0af49cae8122bd39d5c396f705f1e148a01367565e1accb46d9a6
+  metadata.gz: b85cb4483d1aff46916141a5802ac179f63603e124e10dc0ee71c3193e289becafec130fe67551ad6ca1da166611c91c2fcefd4aea636b84a79dfc129f9bb831
+  data.tar.gz: 19aab9a7f4d054ccca8d311cb077967b0d4fad48b55b86b5fbe8d367a43f86a17406ef21a2712597cc5f5e8344e0e0bbd2e55964b6bcae4e9e8ada25a85c1a11

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 The web, with simplicity.
 
+## v2.0.1 - 2022-12-06
+
+### Fixed
+
+- [Luca Guidi] Ensure `Content-Security-Policy` HTTP response header to be returned as a single line
+- [Tim Riley] Ensure Rack events are on internal notifications system
+
+## 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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "constants"
+require_relative "env"
 
 module Hanami
   # The Hanami app is a singular slice tasked with managing the core components of the app and
@@ -28,13 +29,7 @@ module Hanami
       @_mutex.synchronize do
         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
+          Hanami::Env.load
         end
       end
     end
@@ -102,32 +97,6 @@ module Hanami
 
       private
 
-      # Uses [dotenv](https://github.com/bkeepers/dotenv) (if available) to populate `ENV` from
-      # various `.env` files.
-      #
-      # For a given `HANAMI_ENV` environment, the `.env` files are looked up in the following order:
-      #
-      # - .env.{environment}.local
-      # - .env.local (unless the environment is `test`)
-      # - .env.{environment}
-      # - .env
-      #
-      # If dotenv is unavailable, the method exits and does nothing.
-      def load_dotenv
-        return unless Hanami.bundled?("dotenv")
-
-        hanami_env = Hanami.env
-        dotenv_files = [
-          ".env.#{hanami_env}.local",
-          (".env.local" unless hanami_env == :test),
-          ".env.#{hanami_env}",
-          ".env"
-        ].compact
-
-        require "dotenv"
-        Dotenv.load(*dotenv_files)
-      end
-
       def prepare_all
         prepare_load_path
 

data/lib/hanami/config/actions/content_security_policy.rb

@@ -102,7 +102,7 @@ module Hanami
         def to_s
           @policy.map do |key, value|
             "#{dasherize(key)} #{value}"
-          end.join(";\n")
+          end.join(";")
         end
 
         private

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/env.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Env
+    # @since 2.0.1
+    # @api private
+    @_loaded = false
+
+    # Uses [dotenv](https://github.com/bkeepers/dotenv) (if available) to populate `ENV` from
+    # various `.env` files.
+    #
+    # For a given `HANAMI_ENV` environment, the `.env` files are looked up in the following order:
+    #
+    # - .env.{environment}.local
+    # - .env.local (unless the environment is `test`)
+    # - .env.{environment}
+    # - .env
+    #
+    # If dotenv is unavailable, the method exits and does nothing.
+    #
+    # @since 2.0.1
+    # @api private
+    def self.load(env = Hanami.env)
+      return unless Hanami.bundled?("dotenv")
+      return if loaded?
+
+      dotenv_files = [
+        ".env.#{env}.local",
+        (".env.local" unless env == :test),
+        ".env.#{env}",
+        ".env"
+      ].compact
+
+      require "dotenv"
+      Dotenv.load(*dotenv_files)
+
+      loaded!
+    end
+
+    # @since 2.0.1
+    # @api private
+    def self.loaded?
+      @_loaded
+    end
+
+    # @since 2.0.1
+    # @api private
+    def self.loaded!
+      @_loaded = true
+    end
+  end
+end

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/port.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Hanami
+  # @since 2.0.1
+  # @api private
+  module Port
+    # @since 2.0.1
+    # @api private
+    DEFAULT = 2300
+
+    # @since 2.0.1
+    # @api private
+    ENV_VAR = "HANAMI_PORT"
+
+    # @since 2.0.1
+    # @api private
+    def self.call(value, env = ENV.fetch(ENV_VAR, nil))
+      return Integer(value) if !value.nil? && !default?(value)
+      return Integer(env) unless env.nil?
+      return Integer(value) unless value.nil?
+
+      DEFAULT
+    end
+
+    # @since 2.0.1
+    # @api private
+    def self.call!(value)
+      return if default?(value)
+
+      ENV[ENV_VAR] = value.to_s
+    end
+
+    # @since 2.0.1
+    # @api private
+    def self.default?(value)
+      value.to_i == DEFAULT
+    end
+
+    class << self
+      # @since 2.0.1
+      # @api private
+      alias_method :[], :call
+    end
+  end
+end

data/lib/hanami/providers/rack.rb

@@ -15,21 +15,29 @@ module Hanami
     class Rack < Dry::System::Provider::Source
       # @api private
       def prepare
-        require "dry/monitor"
-        require "hanami/web/rack_logger"
-
         Dry::Monitor.load_extensions(:rack)
+
+        # Explicitly register the Rack middleware events on our notifications bus. The Dry::Monitor
+        # rack extension (activated above) does register these globally, but if the notifications
+        # bus has been used before this provider loads, then it will have created its own separate
+        # locally copy of all registered events as of that moment in time, which will not included
+        # the Rack events globally reigstered above.
+        notifications = target["notifications"]
+        notifications.register_event(Dry::Monitor::Rack::Middleware::REQUEST_START)
+        notifications.register_event(Dry::Monitor::Rack::Middleware::REQUEST_STOP)
+        notifications.register_event(Dry::Monitor::Rack::Middleware::REQUEST_ERROR)
       end
 
       # @api private
       def start
         target.start :logger
 
-        notifications = target[:notifications]
-
-        monitor_middleware = Dry::Monitor::Rack::Middleware.new(notifications)
+        monitor_middleware = Dry::Monitor::Rack::Middleware.new(
+          target["notifications"],
+          clock: Dry::Monitor::Clock.new(unit: :microsecond)
+        )
 
-        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.1"
 
     # @since 0.9.0
     # @api private