hanami 2.0.0.alpha4 → 2.0.0.alpha7

data/lib/hanami/configuration/source_dirs.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+require "dry/system/config/component_dirs"
+
+module Hanami
+  class Configuration
+    # Configuration for slice source dirs
+    #
+    # @since 2.0.0
+    class SourceDirs
+      DEFAULT_COMPONENT_DIR_PATHS = %w[lib actions repositories views].freeze
+      private_constant :DEFAULT_COMPONENT_DIR_PATHS
+
+      include Dry::Configurable
+
+      setting :component_dirs,
+        default: Dry::System::Config::ComponentDirs.new.tap { |dirs|
+          DEFAULT_COMPONENT_DIR_PATHS.each do |path|
+            dirs.add path
+          end
+        },
+        cloneable: true
+
+      setting :autoload_paths, default: %w[entities]
+
+      private
+
+      def method_missing(name, *args, &block)
+        if config.respond_to?(name)
+          config.public_send(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, _include_all = false)
+        config.respond_to?(name) || super
+      end
+    end
+  end
+end

data/lib/hanami/configuration.rb

@@ -12,6 +12,8 @@ require_relative "configuration/logger"
 require_relative "configuration/middleware"
 require_relative "configuration/router"
 require_relative "configuration/sessions"
+require_relative "configuration/source_dirs"
+require_relative "constants"
 
 module Hanami
   # Hanami application configuration
@@ -25,6 +27,8 @@ module Hanami
     DEFAULT_ENVIRONMENTS = Concurrent::Hash.new { |h, k| h[k] = Concurrent::Array.new }
     private_constant :DEFAULT_ENVIRONMENTS
 
+    attr_reader :env
+
     attr_reader :actions
     attr_reader :middleware
     attr_reader :router
@@ -33,15 +37,19 @@ module Hanami
     attr_reader :environments
     private :environments
 
-    def initialize(env:)
+    def initialize(application_name:, env:)
+      @namespace = application_name.split(MODULE_DELIMITER)[0..-2].join(MODULE_DELIMITER)
+
       @environments = DEFAULT_ENVIRONMENTS.clone
-      config.env = env
+      @env = env
 
       # Some default setting values must be assigned at initialize-time to ensure they
       # have appropriate values for the current application
       self.root = Dir.pwd
       self.settings_store = Application::Settings::DotenvStore.new.with_dotenv_loaded
 
+      config.logger = Configuration::Logger.new(env: env, application_name: method(:application_name))
+
       @assets = begin
         require_path = "hanami/assets/application_configuration"
         require require_path
@@ -101,29 +109,30 @@ module Hanami
       super
     end
 
-    setting :env
+    def namespace
+      inflector.constantize(@namespace)
+    end
 
-    def env=(new_env)
-      config.env = env
-      apply_env_config(new_env)
+    def application_name
+      inflector.underscore(@namespace).to_sym
     end
 
     setting :root, constructor: -> path { Pathname(path) }
 
-    setting :inflector, default: Dry::Inflector.new, cloneable: true
+    setting :inflector, default: Dry::Inflector.new
 
     def inflections(&block)
       self.inflector = Dry::Inflector.new(&block)
     end
 
-    setting :logger, default: Configuration::Logger.new, cloneable: true
+    setting :logger, cloneable: true
 
     def logger=(logger_instance)
       @logger_instance = logger_instance
     end
 
     def logger_instance
-      @logger_instance || logger.logger_class.new(**logger.options)
+      @logger_instance || logger.instance
     end
 
     setting :settings_path, default: File.join("config", "settings")
@@ -132,21 +141,7 @@ module Hanami
 
     setting :settings_store, default: Application::Settings::DotenvStore
 
-    setting :slices_dir, default: "slices"
-
-    setting :slices_namespace, default: Object
-
-    # TODO: convert into a dedicated object with explicit behaviour around blocks per
-    # slice, etc.
-    setting :slices, default: {}, constructor: :dup.to_proc
-
-    # TODO: turn this into a richer "source dirs" setting that can support enabling
-    # of container component loading as an opt in behvior
-    setting :component_dir_paths, default: %w[actions repositories views]
-
-    def slice(slice_name, &block)
-      slices[slice_name] = block
-    end
+    setting :source_dirs, default: Configuration::SourceDirs.new, cloneable: true
 
     setting :base_url, default: "http://0.0.0.0:2300", constructor: -> url { URI(url) }
 

data/lib/hanami/constants.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Hanami
+  # @api private
+  MODULE_DELIMITER = "::"
+  private_constant :MODULE_DELIMITER
+
+  # @api private
+  CONFIG_DIR = "config"
+  private_constant :CONFIG_DIR
+
+  # @api private
+  SLICES_DIR = "slices"
+  private_constant :SLICES_DIR
+
+  # @api private
+  LIB_DIR = "lib"
+  private_constant :LIB_DIR
+
+  # @api private
+  RB_EXT = ".rb"
+  private_constant :RB_EXT
+end

data/lib/hanami/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Hanami
+  # @since 2.0.0
+  Error = Class.new(StandardError)
+
+  # @since 2.0.0
+  ApplicationLoadError = Class.new(Error)
+
+  # @since 2.0.0
+  SliceLoadError = Class.new(Error)
+end

data/lib/hanami/{init.rb → prepare.rb}

@@ -2,4 +2,4 @@
 
 require_relative "setup"
 
-Hanami.init
+Hanami.prepare

data/lib/hanami/slice.rb

@@ -1,167 +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?
+
+        ensure_slice_name
+        ensure_slice_consts
 
-    def import(*slice_names)
-      raise "Cannot import after booting" if booted?
+        prepare_all
 
-      slice_names.each do |slice_name|
-        container.import slice_name.to_sym => application.slices.fetch(slice_name.to_sym).container
+        @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 the "lib" component dir; all slices will load components from lib
-          if root.join("lib").directory?
-            config.component_dirs.add("lib") do |component_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, and will be
-              # registered as "foo"
-              component_dir.namespaces.root(key: nil, const: namespace_path)
+      def [](...)
+        container.[](...)
+      end
 
-              application.autoloader.push_dir(root.join("lib"), namespace: namespace)
-            end
+      def resolve(...)
+        container.resolve(...)
+      end
+
+      def export(keys)
+        container.config.exports = keys
+      end
+
+      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 = self.application
+
+        container.after(:configure) do
+          if from.is_a?(Symbol) || from.is_a?(String)
+            slice_name = from
+            from = application.slices[from.to_sym].container
           end
 
-          # Add component dirs for each configured component path
-          application.configuration.component_dir_paths.each do |slice_dir|
-            next unless root.join(slice_dir).directory?
+          as = kwargs[:as] || slice_name
+
+          import(from: from, as: as, **kwargs)
+        end
+      end
+
+      private
+
+      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
 
-            config.component_dirs.add(slice_dir) do |component_dir|
-              # Expect component files in the root of these component dirs to define
-              # classes inside a namespace matching the dir.
-              #
-              # e.g. "actions/foo.rb" should define SliceNamespace::Actions::Foo, and
-              # will be registered as "actions.foo"
+          container.config.component_dirs.add(component_dir)
+        end
+      end
 
-              dir_namespace_path = File.join(namespace_path, slice_dir)
+      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(slice_dir), 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?
 
-              component_dir.namespaces.root(const: dir_namespace_path, key: slice_dir)
+          dir_namespace_path = File.join(namespace_path, autoload_path)
 
-              application.autoloader.push_dir(
-                container.root.join(slice_dir),
-                namespace: autoloader_namespace
-              )
-            end
+          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.alpha4"
+    VERSION = "2.0.0.alpha7"
 
     # @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