hanami 2.0.0.alpha5 → 2.0.0.alpha7.1

data/lib/hanami/slice.rb

@@ -1,189 +1,253 @@
 # frozen_string_literal: true
 
 require "dry/system/container"
-require "dry/system/loader/autoloading"
+require "hanami/errors"
 require "pathname"
+require_relative "constants"
 
 module Hanami
   # Distinct area of concern within an Hanami application
   #
   # @since 2.0.0
   class Slice
-    attr_reader :application, :name, :namespace, :root
-
-    def initialize(application, name:, namespace: nil, root: nil, container: nil)
-      @application = application
-      @name = name.to_sym
-      @namespace = namespace
-      @root = root ? Pathname(root) : root
-      @container = container || define_container
-    end
+    def self.inherited(klass)
+      super
 
-    def inflector
-      application.inflector
-    end
+      klass.extend(ClassMethods)
 
-    def namespace_path
-      @namespace_path ||= inflector.underscore(namespace.to_s)
+      # Eagerly initialize any variables that may be accessed inside the subclass body
+      klass.instance_variable_set(:@application, Hanami.application)
+      klass.instance_variable_set(:@container, Class.new(Dry::System::Container))
     end
 
-    def init
-      container.import application: application.container
+    # rubocop:disable Metrics/ModuleLength
+    module ClassMethods
+      attr_reader :application, :container
 
-      slice_block = application.configuration.slices[name]
-      instance_eval(&slice_block) if slice_block
-    end
+      def slice_name
+        inflector.underscore(name.split(MODULE_DELIMITER)[-2]).to_sym
+      end
 
-    def boot
-      container.finalize! do
-        container.config.env = application.container.config.env
+      def namespace
+        inflector.constantize(name.split(MODULE_DELIMITER)[0..-2].join(MODULE_DELIMITER))
       end
 
-      @booted = true
-      self
-    end
+      def namespace_path
+        inflector.underscore(namespace)
+      end
 
-    # rubocop:disable Style/DoubleNegation
-    def booted?
-      !!@booted
-    end
-    # rubocop:enable Style/DoubleNegation
+      def root
+        application.root.join(SLICES_DIR, slice_name.to_s)
+      end
 
-    def container
-      @container ||= define_container
-    end
+      def inflector
+        application.inflector
+      end
+
+      def prepare(provider_name = nil)
+        container.prepare(provider_name) and return self if provider_name
+
+        return self if prepared?
 
-    def import(*slice_names)
-      raise "Cannot import after booting" if booted?
+        ensure_slice_name
+        ensure_slice_consts
 
-      slice_names.each do |slice_name|
-        container.import slice_name.to_sym => application.slices.fetch(slice_name.to_sym).container
+        prepare_all
+
+        @prepared = true
+        self
       end
-    end
 
-    def register(*args, &block)
-      container.register(*args, &block)
-    end
+      def prepare_container(&block)
+        @prepare_container_block = block
+      end
 
-    def register_bootable(*args, &block)
-      container.boot(*args, &block)
-    end
+      def boot
+        return self if booted?
 
-    def init_bootable(*args)
-      container.init(*args)
-    end
+        container.finalize!
 
-    def start_bootable(*args)
-      container.start(*args)
-    end
+        @booted = true
 
-    def key?(*args)
-      container.key?(*args)
-    end
+        self
+      end
 
-    def keys
-      container.keys
-    end
+      def shutdown
+        container.shutdown!
+        self
+      end
 
-    def [](*args)
-      container[*args]
-    end
+      def prepared?
+        !!@prepared
+      end
 
-    def resolve(*args)
-      container.resolve(*args)
-    end
+      def booted?
+        !!@booted
+      end
 
-    private
+      def register(...)
+        container.register(...)
+      end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def define_container
-      container = Class.new(Dry::System::Container)
-      container.use :env
+      def register_provider(...)
+        container.register_provider(...)
+      end
 
-      container.configure do |config|
-        config.name = name
-        config.inflector = application.configuration.inflector
+      def start(...)
+        container.start(...)
+      end
 
-        config.component_dirs.loader = Dry::System::Loader::Autoloading
-        config.component_dirs.add_to_load_path = false
+      def key?(...)
+        container.key?(...)
+      end
 
-        if root&.directory?
-          config.root = root
-          config.bootable_dirs = ["config/boot"]
+      def keys
+        container.keys
+      end
 
-          # Add component dirs for each configured component path
-          application.configuration.source_dirs.component_dirs.each do |component_dir|
-            next unless root.join(component_dir.path).directory?
+      def [](...)
+        container.[](...)
+      end
 
-            component_dir = component_dir.dup
+      def resolve(...)
+        container.resolve(...)
+      end
 
-            # TODO: this `== "lib"` check should be codified into a method somewhere
-            if component_dir.path == "lib"
-              # Expect component files in the root of the lib/ component dir to define
-              # classes inside the slice's namespace.
-              #
-              # e.g. "lib/foo.rb" should define SliceNamespace::Foo, to be registered as
-              # "foo"
-              component_dir.namespaces.delete_root
-              component_dir.namespaces.add_root(key: nil, const: namespace_path)
+      def export(keys)
+        container.config.exports = keys
+      end
 
-              config.component_dirs.add(component_dir)
+      def import(from:, **kwargs)
+        # TODO: This should be handled via dry-system (see dry-rb/dry-system#228)
+        raise "Cannot import after booting" if booted?
 
-              application.autoloader.push_dir(root.join("lib"), namespace: namespace)
-            else
-              # Expect component files in the root of non-lib/ component dirs to define
-              # classes inside a namespace matching that dir.
-              #
-              # e.g. "actions/foo.rb" should define SliceNamespace::Actions::Foo, to be
-              # registered as "actions.foo"
+        application = self.application
 
-              dir_namespace_path = File.join(namespace_path, component_dir.path)
+        container.after(:configure) do
+          if from.is_a?(Symbol) || from.is_a?(String)
+            slice_name = from
+            from = application.slices[from.to_sym].container
+          end
 
-              autoloader_namespace = begin
-                inflector.constantize(inflector.camelize(dir_namespace_path))
-              rescue NameError
-                namespace.const_set(inflector.camelize(component_dir.path), Module.new)
-              end
+          as = kwargs[:as] || slice_name
 
-              component_dir.namespaces.delete_root
-              component_dir.namespaces.add_root(const: dir_namespace_path, key: component_dir.path) # TODO: do we need to swap path delimiters for key delimiters here?
+          import(from: from, as: as, **kwargs)
+        end
+      end
 
-              config.component_dirs.add(component_dir)
+      private
 
-              application.autoloader.push_dir(
-                container.root.join(component_dir.path),
-                namespace: autoloader_namespace
-              )
-            end
+      def ensure_slice_name
+        unless name
+          raise SliceLoadError, "Slice must have a class name before it can be prepared"
+        end
+      end
+
+      def ensure_slice_consts
+        if namespace.const_defined?(:Container) || namespace.const_defined?(:Deps)
+          raise(
+            SliceLoadError,
+            "#{namespace}::Container and #{namespace}::Deps constants must not already be defined"
+          )
+        end
+      end
+
+      def prepare_all
+        prepare_container_plugins
+        prepare_container_base_config
+        prepare_container_component_dirs
+        prepare_autoloader
+        prepare_container_imports
+        prepare_container_consts
+        instance_exec(container, &@prepare_container_block) if @prepare_container_block
+        container.configured!
+      end
+
+      def prepare_container_plugins
+        container.use(:env, inferrer: -> { Hanami.env })
+
+        container.use(
+          :zeitwerk,
+          loader: application.autoloader,
+          run_setup: false,
+          eager_load: false
+        )
+      end
+
+      def prepare_container_base_config
+        container.config.name = slice_name
+        container.config.root = root
+        container.config.provider_dirs = [File.join("config", "providers")]
+
+        container.config.env = application.configuration.env
+        container.config.inflector = application.configuration.inflector
+      end
+
+      def prepare_container_component_dirs # rubocop:disable Metrics/AbcSize
+        return unless root&.directory?
+
+        # Add component dirs for each configured component path
+        application.configuration.source_dirs.component_dirs.each do |component_dir|
+          next unless root.join(component_dir.path).directory?
+
+          component_dir = component_dir.dup
+
+          if component_dir.path == LIB_DIR
+            # Expect component files in the root of the lib/ component dir to define
+            # classes inside the slice's namespace.
+            #
+            # e.g. "lib/foo.rb" should define SliceNamespace::Foo, to be registered as
+            # "foo"
+            component_dir.namespaces.delete_root
+            component_dir.namespaces.add_root(key: nil, const: namespace_path)
+          else
+            # Expect component files in the root of non-lib/ component dirs to define
+            # classes inside a namespace matching that dir.
+            #
+            # e.g. "actions/foo.rb" should define SliceNamespace::Actions::Foo, to be
+            # registered as "actions.foo"
+
+            dir_namespace_path = File.join(namespace_path, component_dir.path)
+
+            component_dir.namespaces.delete_root
+            component_dir.namespaces.add_root(const: dir_namespace_path, key: component_dir.path)
           end
 
-          # Pass configured autoload dirs to the autoloader
-          application.configuration.source_dirs.autoload_paths.each do |autoload_path|
-            next unless root.join(autoload_path).directory?
+          container.config.component_dirs.add(component_dir)
+        end
+      end
 
-            dir_namespace_path = File.join(namespace_path, autoload_path)
+      def prepare_autoloader # rubocop:disable Metrics/AbcSize
+        return unless root&.directory?
 
-            autoloader_namespace = begin
-              inflector.constantize(inflector.camelize(dir_namespace_path))
-            rescue NameError
-              namespace.const_set(inflector.camelize(autoload_path), Module.new)
-            end
+        # Pass configured autoload dirs to the autoloader
+        application.configuration.source_dirs.autoload_paths.each do |autoload_path|
+          next unless root.join(autoload_path).directory?
 
-            application.autoloader.push_dir(
-              container.root.join(autoload_path),
-              namespace: autoloader_namespace
-            )
+          dir_namespace_path = File.join(namespace_path, autoload_path)
+
+          autoloader_namespace = begin
+            inflector.constantize(inflector.camelize(dir_namespace_path))
+          rescue NameError
+            namespace.const_set(inflector.camelize(autoload_path), Module.new)
           end
+
+          container.config.autoloader.push_dir(
+            container.root.join(autoload_path),
+            namespace: autoloader_namespace
+          )
         end
       end
 
-      if namespace
+      def prepare_container_imports
+        container.import from: application.container, as: :application
+      end
+
+      def prepare_container_consts
         namespace.const_set :Container, container
         namespace.const_set :Deps, container.injector
       end
-
-      container
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/hanami/version.rb

@@ -8,7 +8,7 @@ module Hanami
   module Version
     # @since 0.9.0
     # @api private
-    VERSION = "2.0.0.alpha5"
+    VERSION = "2.0.0.alpha7.1"
 
     # @since 0.9.0
     # @api private

data/lib/hanami/web/rack_logger.rb

@@ -1,19 +1,32 @@
 # frozen_string_literal: true
 
-require "json"
-require "rack/request"
-require "hanami/utils/hash"
-
 module Hanami
   module Web
     # Rack logger for Hanami applications
     class RackLogger
-      attr_reader :logger
-      attr_reader :filter_params
+      REQUEST_METHOD = "REQUEST_METHOD"
+      private_constant :REQUEST_METHOD
+
+      HTTP_X_FORWARDED_FOR = "HTTP_X_FORWARDED_FOR"
+      private_constant :HTTP_X_FORWARDED_FOR
+
+      REMOTE_ADDR = "REMOTE_ADDR"
+      private_constant :REMOTE_ADDR
+
+      SCRIPT_NAME = "SCRIPT_NAME"
+      private_constant :SCRIPT_NAME
+
+      PATH_INFO = "PATH_INFO"
+      private_constant :PATH_INFO
+
+      ROUTER_PARAMS = "router.params"
+      private_constant :ROUTER_PARAMS
+
+      CONTENT_LENGTH = "Content-Length"
+      private_constant :CONTENT_LENGTH
 
-      def initialize(logger, filter_params: [])
+      def initialize(logger)
         @logger = logger
-        @filter_params = filter_params
       end
 
       def attach(rack_monitor)
@@ -26,22 +39,20 @@ module Hanami
         end
       end
 
-      # rubocop:disable Metrics/MethodLength
-      def log_request(env, status, time)
+      def log_request(env, status, elapsed)
         data = {
-          http: env[HTTP_VERSION],
           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: extract_params(env),
-          elapsed: time,
+          params: env[ROUTER_PARAMS],
+          time: Time.now,
         }
 
-        logger.info JSON.generate(data)
+        logger.info(data)
       end
-      # rubocop:enable Metrics/MethodLength
 
       def log_exception(exception)
         logger.error exception.message
@@ -50,47 +61,12 @@ module Hanami
 
       private
 
-      HTTP_VERSION = "HTTP_VERSION"
-      REQUEST_METHOD = "REQUEST_METHOD"
-      HTTP_X_FORWARDED_FOR = "HTTP_X_FORWARDED_FOR"
-      REMOTE_ADDR = "REMOTE_ADDR"
-      SCRIPT_NAME = "SCRIPT_NAME"
-      PATH_INFO = "PATH_INFO"
-      RACK_ERRORS = "rack.errors"
-      QUERY_HASH = "rack.request.query_hash"
-      FORM_HASH = "rack.request.form_hash"
-      ROUTER_PARAMS = "router.params"
-      CONTENT_LENGTH = "Content-Length"
+      attr_reader :logger
 
       def extract_content_length(env)
         value = env[CONTENT_LENGTH]
         !value || value.to_s == "0" ? "-" : value
       end
-
-      def extract_params(env)
-        result = env.fetch(QUERY_HASH, {})
-        result.merge!(env.fetch(FORM_HASH, {}))
-        result.merge!(Hanami::Utils::Hash.deep_stringify(env.fetch(ROUTER_PARAMS, {})))
-        result
-      end
-
-      FILTERED = "[FILTERED]"
-
-      # rubocop:disable Metrics/MethodLength
-      def filter(params)
-        params.each_with_object({}) do |(k, v), h|
-          if filter_params.include?(k)
-            h.update(k => FILTERED)
-          elsif v.is_a?(Hash)
-            h.update(k => filter(v))
-          elsif v.is_a?(Array)
-            h.update(k => v.map { |m| m.is_a?(Hash) ? filter(m) : m })
-          else
-            h[k] = v
-          end
-        end
-      end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/hanami.rb

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
+require_relative "hanami/application"
+require_relative "hanami/errors"
+require_relative "hanami/version"
+
+
 # A complete web framework for Ruby
 #
 # @since 0.1.0
 #
 # @see http://hanamirb.org
 module Hanami
-  require "hanami/version"
-  require "hanami/application"
-
   @_mutex = Mutex.new
 
   def self.application
     @_mutex.synchronize do
-      raise "Hanami.application not configured" unless defined?(@_application)
+      unless defined?(@_application)
+        raise ApplicationLoadError,
+          "Hanami.application is not yet configured. " \
+          "You may need to `require \"hanami/setup\"` to load your config/application.rb file."
+      end
 
       @_application
     end
@@ -25,7 +31,9 @@ module Hanami
 
   def self.application=(klass)
     @_mutex.synchronize do
-      raise "Hanami.application already configured" if defined?(@_application)
+      if defined?(@_application)
+        raise ApplicationLoadError, "Hanami.application is already configured."
+      end
 
       @_application = klass unless klass.name.nil?
     end
@@ -47,8 +55,8 @@ module Hanami
     application[:logger]
   end
 
-  def self.init
-    application.init
+  def self.prepare
+    application.prepare
   end
 
   def self.boot

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha5
+  version: 2.0.0.alpha7.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,20 +104,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.23'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.23'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: hanami-cli
   requirement: !ruby/object:Gem::Requirement
@@ -217,13 +217,12 @@ files:
 - hanami.gemspec
 - lib/hanami.rb
 - lib/hanami/application.rb
-- lib/hanami/application/autoloader/inflector_adapter.rb
-- lib/hanami/application/container/boot/inflector.rb
-- lib/hanami/application/container/boot/logger.rb
-- lib/hanami/application/container/boot/rack_logger.rb
-- lib/hanami/application/container/boot/rack_monitor.rb
-- lib/hanami/application/container/boot/routes_helper.rb
-- lib/hanami/application/container/boot/settings.rb
+- lib/hanami/application/container/providers/inflector.rb
+- lib/hanami/application/container/providers/logger.rb
+- lib/hanami/application/container/providers/rack_logger.rb
+- lib/hanami/application/container/providers/rack_monitor.rb
+- lib/hanami/application/container/providers/routes_helper.rb
+- lib/hanami/application/container/providers/settings.rb
 - lib/hanami/application/router.rb
 - lib/hanami/application/routes.rb
 - lib/hanami/application/routes_helper.rb
@@ -234,6 +233,7 @@ files:
 - lib/hanami/application/routing/router.rb
 - lib/hanami/application/settings.rb
 - lib/hanami/application/settings/dotenv_store.rb
+- lib/hanami/application/slice_registrar.rb
 - lib/hanami/assets/application_configuration.rb
 - lib/hanami/assets/configuration.rb
 - lib/hanami/boot.rb
@@ -247,13 +247,16 @@ files:
 - lib/hanami/cli/commands/command.rb
 - lib/hanami/cli/commands/server.rb
 - lib/hanami/configuration.rb
+- lib/hanami/configuration/actions.rb
 - lib/hanami/configuration/logger.rb
 - lib/hanami/configuration/middleware.rb
 - lib/hanami/configuration/null_configuration.rb
 - lib/hanami/configuration/router.rb
 - lib/hanami/configuration/sessions.rb
 - lib/hanami/configuration/source_dirs.rb
-- lib/hanami/init.rb
+- lib/hanami/constants.rb
+- lib/hanami/errors.rb
+- lib/hanami/prepare.rb
 - lib/hanami/server.rb
 - lib/hanami/setup.rb
 - lib/hanami/slice.rb
@@ -263,6 +266,7 @@ homepage: http://hanamirb.org
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   allowed_push_host: https://rubygems.org
 post_install_message:
 rdoc_options: []
@@ -272,14 +276,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: The web, with simplicity