hanami 1.3.5 → 2.0.0.alpha4

data/lib/hanami/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   # Hanami version
   #
@@ -6,7 +8,7 @@ module Hanami
   module Version
     # @since 0.9.0
     # @api private
-    VERSION = '1.3.5'.freeze
+    VERSION = "2.0.0.alpha4"
 
     # @since 0.9.0
     # @api private

data/lib/hanami/web/rack_logger.rb

@@ -0,0 +1,96 @@
+# 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
+
+      def initialize(logger, filter_params: [])
+        @logger = logger
+        @filter_params = filter_params
+      end
+
+      def attach(rack_monitor)
+        rack_monitor.on :stop do |event|
+          log_request event[:env], event[:status], event[:time]
+        end
+
+        rack_monitor.on :error do |event|
+          log_exception event[:exception]
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def log_request(env, status, time)
+        data = {
+          http: env[HTTP_VERSION],
+          verb: env[REQUEST_METHOD],
+          status: status,
+          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,
+        }
+
+        logger.info JSON.generate(data)
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def log_exception(exception)
+        logger.error exception.message
+        logger.error exception.backtrace.join("\n")
+      end
+
+      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"
+
+      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,4 +1,4 @@
-require 'thread'
+# frozen_string_literal: true
 
 # A complete web framework for Ruby
 #
@@ -6,277 +6,78 @@ require 'thread'
 #
 # @see http://hanamirb.org
 module Hanami
-  require 'hanami/version'
-  require 'hanami/frameworks'
-  require 'hanami/environment'
-  require 'hanami/app'
-  require 'hanami/application'
-  require 'hanami/components'
-  require 'hanami/configuration'
+  require "hanami/version"
+  require "hanami/application"
 
-  # @api private
-  # @since 0.6.0
-  DEFAULT_PUBLIC_DIRECTORY = 'public'.freeze
-
-  # @api private
-  # @since 0.9.0
   @_mutex = Mutex.new
-  @_plugins = Concurrent::Array.new
 
-  # Configure Hanami project
-  #
-  # Please note that the code for this method is generated by `hanami new`.
-  #
-  # @param blk [Proc] the configuration block
-  #
-  # @since 0.9.0
-  #
-  # @example
-  #   # config/environment.rb
-  #
-  #   # ...
-  #
-  #   Hanami.configure do
-  #     mount Admin::Application, at: "/admin"
-  #     mount Web::Application,   at: "/"
-  #
-  #     model do
-  #       adapter :sql, ENV['DATABASE_URL']
-  #
-  #       migrations "db/migrations"
-  #       schema     "db/schema.sql"
-  #     end
-  #
-  #     mailer do
-  #       root "lib/bookshelf/mailers"
-  #
-  #       delivery do
-  #         development :test
-  #         test        :test
-  #         # production :smtp, address: ENV['SMTP_HOST'], port: ENV['SMTP_PORT']
-  #       end
-  #     end
-  #   end
-  def self.configure(&blk)
+  def self.application
     @_mutex.synchronize do
-      @_configuration = Hanami::Configuration.new(&blk)
-    end
-  end
+      raise "Hanami.application not configured" unless defined?(@_application)
 
-  # Hanami configuration
-  #
-  # @return [Hanami::Configuration] the configuration
-  #
-  # @see Hanami.configure
-  #
-  # @since 0.9.0
-  # @api private
-  def self.configuration
-    @_mutex.synchronize do
-      raise "Hanami not configured" unless defined?(@_configuration)
-      @_configuration
+      @_application
     end
   end
 
-  # Configure a plugin
-  #
-  # @see Hanami.configure
-  #
-  # @since 1.2.0
-  def self.plugin(&blk)
-    @_plugins << blk
+  def self.application?
+    defined?(@_application)
   end
 
-  # Plugins registry
-  #
-  # NOTE: We can't use `Components` registry.
-  #
-  # Plugins are loaded when Bundler requires `Gemfile` gems.
-  # During this phase the `Components` that we can resolve are erased by the
-  # first incoming request in development.
-  # They are erased by a workaround that we had to put in place in `Hanami.boot`.
-  # This workaround is `Components.release` and it was introduced because
-  # `shotgun` failed to reload components, so we have to release for each
-  # incoming request.
-  # After the `Components` registry is cleared up, Hanami is able to resolve all
-  # the components from scratch.
-  #
-  # When we'll switch to `hanami-reloader` for development, we can remove
-  # `Components.release` and we'll be able to store plugins in `Components` and
-  # remove `Hanami.plugins` as well.
-  #
-  # @since 1.2.0
-  # @api private
-  def self.plugins
-    @_plugins
-  end
+  def self.application=(klass)
+    @_mutex.synchronize do
+      raise "Hanami.application already configured" if defined?(@_application)
 
-  # Boot your Hanami project
-  #
-  # NOTE: In case this is invoked many times, it guarantees that the boot
-  #   process happens only once.
-  #
-  # NOTE: This MUST NOT be wrapped by a Mutex, because it would cause a deadlock.
-  #
-  # @return [NilClass]
-  #
-  # @since 0.9.0
-  def self.boot
-    Components.release if code_reloading?
-    Components.resolve('all')
-    Hanami::Model.disconnect if defined?(Hanami::Model)
-    nil
+      @_application = klass unless klass.name.nil?
+    end
   end
 
-  # Main application that mounts many Rack and/or Hanami applications.
-  #
-  # This is used as integration point for:
-  #
-  #   * `config.ru` (`run Hanami.app`)
-  #   * Feature tests (`Capybara.app = Hanami.app`)
-  #
-  #
-  #
-  # It lazily loads your Hanami project, in case it wasn't booted on before.
-  # This is the case when `hanami server` isn't invoked, but we use different
-  # ways to run the project (eg. `rackup`).
-  #
-  # @return [Hanami::App] the app
-  #
-  # @since 0.9.0
-  # @api private
-  #
-  # @see Hanami.boot
   def self.app
-    boot
-    App.new(configuration, environment)
+    @_mutex.synchronize do
+      raise "Hanami.app not configured" unless defined?(@_app)
+
+      @_app
+    end
   end
 
-  # Check if an application is allowed to load.
-  #
-  # The list of applications to be loaded can be set via the `HANAMI_APPS`
-  # env variable. If the HANAMI_APPS env variable is not set, it defaults
-  # to loading all applications.
-  #
-  # @return [TrueClass,FalseClass] the result of the check
-  #
-  # @since 1.1.0
-  #
-  # @example
-  #
-  #   # Mount hanami app for specific app
-  #   Hanami.configure do
-  #     if Hanami.app?(:web)
-  #       require_relative '../apps/web/application'
-  #       mount Web::Application, at: '/'
-  #     end
-  #   end
-  #
-  def self.app?(app)
-    return true unless ENV.key?('HANAMI_APPS')
+  def self.app=(app)
+    @_mutex.synchronize do
+      raise "Hanami.app already configured" if defined?(@_app)
 
-    allowed_apps = ENV['HANAMI_APPS'].to_s.split(',')
-    allowed_apps.include?(app.to_s.downcase)
+      @_app = app
+    end
   end
 
-  # Return root of the project (top level directory).
-  #
-  # @return [Pathname] root path
-  #
-  # @since 0.3.2
-  #
-  # @example
-  #   Hanami.root # => #<Pathname:/Users/luca/Code/bookshelf>
-  def self.root
-    environment.root
+  def self.env
+    (ENV["HANAMI_ENV"] || "development").to_sym
   end
 
-  # Project public directory
-  #
-  # @return [Pathname] public directory
-  #
-  # @since 0.6.0
-  #
-  # @example
-  #   Hanami.public_directory # => #<Pathname:/Users/luca/Code/bookshelf/public>
-  def self.public_directory
-    root.join(DEFAULT_PUBLIC_DIRECTORY)
+  def self.env?(*names)
+    names.map(&:to_sym).include?(env)
   end
 
-  # Return the current environment
-  #
-  # @return [String] the current environment
-  #
-  # @since 0.3.1
-  #
-  # @see Hanami::Environment#environment
-  #
-  # @example
-  #   Hanami.env => "development"
-  def self.env
-    environment.environment
+  def self.logger
+    application[:logger]
   end
 
-  # Check to see if specified environment(s) matches the current environment.
-  #
-  # If multiple names are given, it returns true, if at least one of them
-  # matches the current environment.
-  #
-  # @return [TrueClass,FalseClass] the result of the check
-  #
-  # @since 0.3.1
-  #
-  # @see Hanami.env
-  #
-  # @example Single name
-  #   puts ENV['HANAMI_ENV'] # => "development"
-  #
-  #   Hanami.env?(:development)  # => true
-  #   Hanami.env?('development') # => true
-  #
-  #   Hanami.env?(:production)   # => false
-  #
-  # @example Multiple names
-  #   puts ENV['HANAMI_ENV'] # => "development"
-  #
-  #   Hanami.env?(:development, :test)   # => true
-  #   Hanami.env?(:production, :staging) # => false
-  def self.env?(*names)
-    environment.environment?(*names)
+  def self.init
+    application.init
   end
 
-  # Current environment
-  #
-  # @return [Hanami::Environment] environment
-  #
-  # @api private
-  # @since 0.3.2
-  def self.environment
-    Components.resolved('environment') do
-      Environment.new
+  def self.boot(web: true)
+    if defined?(@_app)
+      @_app
+    else
+      application.boot
+
+      @_app = application.new if web
     end
   end
 
-  # Check if code reloading is enabled.
-  #
-  # @return [TrueClass,FalseClass] the result of the check
-  #
-  # @since 1.0.0
-  # @api private
-  #
-  # @see https://guides.hanamirb.org/projects/code-reloading
-  def self.code_reloading?
-    environment
-    Components.resolve('code_reloading')
-    Components['code_reloading']
+  def self.shutdown
+    application.shutdown
   end
 
-  # Project logger
-  #
-  # @return [Hanami::Logger] the logger
-  #
-  # @since 1.0.0
-  def self.logger
-    Components['logger']
+  def self.bundler_groups
+    [:plugins]
   end
 end