hanami-utils 2.0.0.beta1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c3da2c837516bf458d208681a9183b4ce2255d4015d1ef436344b951f72127
-  data.tar.gz: 1dd912dfe51da2149599514b70c1d1893651d09e2a2c6f65ffdce4b5142c7132
+  metadata.gz: 2575ff2a640a9ffcddf8a9930a887d536ec9da4b64bc4a2883849ed261f57b43
+  data.tar.gz: 70fbfe55f826d940c0f5decad39840990925e061de975e53d2b672fdae9873df
 SHA512:
-  metadata.gz: d1fb0f77574208374688089528fc4e9479f17fe514d795c0407fd6cb65c3c14cd64aa5956bf90f9e29692042c784845ea3f27c0c6c0fc5fbcf52fb439f6ba557
-  data.tar.gz: 5e5dd4627115e3d92f8fa5c19a323e645b5bc245e72a6156c40b449af68eed08b42148639f25a5cee98e5d2739504d9cb0bfb6dd7781f54e1ae554b77955bbd9
+  metadata.gz: 73d5a9fade1cb961ac4be22b8967507fceebde1a9d8edb33d71634b06ef6c06538c8d0ef2b1a32a33e8442c7609b675ae99bd63780c353c6db02485ddbfd3432
+  data.tar.gz: 368ffe941852e67432d9574b79220b1807b1529cbdf4289fb2fd2db92299888617bc3779bd6e0c3f03b81d5fbcb9725b8b36364733d262a3c5fa2cb257db91b1

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 Ruby core extensions and class utilities for Hanami
 
+## v2.0.0 - 2022-11-22
+
+## v2.0.0.rc1 - 2022-11-08
+
+### Fixed
+
+- [Benjamin Klotz] Ensure `Hanami::Utils::String.underscore` to replace `"."` (dot character) into underscore
+
+### Changed
+
+- [Luca Guidi] Removed `Hanami::Logger` in favor of `Dry::Logger`
+
 ## v2.0.0.beta1 - 2022-07-20
 
 ### Changed

data/hanami-utils.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.required_ruby_version = ">= 3.0"
 
-  spec.add_dependency "dry-transformer", "~> 0.1"
+  spec.add_dependency "dry-transformer", "~> 1.0", "< 2"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
 
   spec.add_development_dependency "bundler", ">= 1.6", "< 3"

data/lib/hanami/middleware.rb

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
 module Hanami
+  # Shared Rack middleware for Hanami apps.
+  #
+  # This module is defined in hanami-utils so that any gem providing middleware can use its
+  # resources.
+  #
+  # @since 2.0.0
   module Middleware
-    # Hanami middleware utils
-
+    # Base class for all errors raised during middleware loading.
+    #
     # @since 2.0.0
-    class Error < ::StandardError
+    # @api public
+    class Error < StandardError
     end
   end
 end

data/lib/hanami/utils/class.rb

@@ -71,33 +71,6 @@ module Hanami
       def self.load(name, namespace = Object)
         load!(name, namespace) if namespace.const_defined?(name.to_s, false)
       end
-
-      def self.tokenize(pattern)
-        if match = TOKENIZE_REGEXP.match(pattern)
-          pre  = match.pre_match
-          post = match.post_match
-          tokens = match[1].split(TOKENIZE_SEPARATOR)
-          tokens.each do |token|
-            yield("#{pre}#{token}#{post}")
-          end
-        else
-          yield(pattern)
-        end
-
-        nil
-      end
-
-      # Regexp for .tokenize
-      #
-      # @since 1.3.0
-      # @api private
-      TOKENIZE_REGEXP = /\((.*)\)/
-
-      # Separator for .tokenize
-      #
-      # @since 1.3.0
-      # @api private
-      TOKENIZE_SEPARATOR = "|"
     end
   end
 end

data/lib/hanami/utils/hash.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "dry-transformer"
+require "dry/transformer"
 
 module Hanami
   module Utils

data/lib/hanami/utils/json.rb

@@ -35,10 +35,20 @@ module Hanami
 
       # rubocop:disable Style/ClassVars
       if defined?(MultiJson)
+        # @since 0.8.0
+        # @api private
         @@engine    = MultiJsonAdapter.new
+
+        # @since 0.8.0
+        # @api private
         ParserError = MultiJson::ParseError
       else
+        # @since 0.8.0
+        # @api private
         @@engine    = ::JSON
+
+        # @since 0.8.0
+        # @api private
         ParserError = ::JSON::ParserError
       end
       # rubocop:enable Style/ClassVars

data/lib/hanami/utils/kernel.rb

@@ -5,6 +5,7 @@ require "date"
 require "time"
 require "pathname"
 require "bigdecimal"
+require "bigdecimal/util"
 require "hanami/utils"
 require "hanami/utils/string"
 

data/lib/hanami/utils/shell_color.rb

@@ -7,12 +7,16 @@ module Hanami
     # It doesn't check if you're writing to a file or anything, so you have to
     # check that yourself before using this module.
     #
+    # @api public
     # @since 1.2.0
     module ShellColor
-      # Unknown color code error
+      # Error raised for unknown color codes.
       #
       # @since 1.2.0
+      # @api public
       class UnknownColorCodeError < ::StandardError
+        # @since 1.2.0
+        # @api private
         def initialize(code)
           super("unknown color code: `#{code.inspect}'")
         end

data/lib/hanami/utils/string.rb

@@ -231,7 +231,7 @@ module Hanami
         string.gsub!(NAMESPACE_SEPARATOR, UNDERSCORE_SEPARATOR)
         string.gsub!(/([A-Z\d]+)([A-Z][a-z])/, UNDERSCORE_DIVISION_TARGET)
         string.gsub!(/([a-z\d])([A-Z])/, UNDERSCORE_DIVISION_TARGET)
-        string.gsub!(/[[:space:]]|-/, UNDERSCORE_DIVISION_TARGET)
+        string.gsub!(/[[:space:]]|-|\./, UNDERSCORE_DIVISION_TARGET)
         string.downcase
       end
 

data/lib/hanami/utils/version.rb

@@ -2,9 +2,10 @@
 
 module Hanami
   module Utils
-    # Defines the version
+    # The current hanami-utils version.
     #
     # @since 0.1.0
-    VERSION = "2.0.0.beta1"
+    # @api public
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-utils
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-transformer
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -112,10 +118,6 @@ files:
 - README.md
 - hanami-utils.gemspec
 - lib/hanami-utils.rb
-- lib/hanami/logger.rb
-- lib/hanami/logger/colorizer.rb
-- lib/hanami/logger/filter.rb
-- lib/hanami/logger/formatter.rb
 - lib/hanami/middleware.rb
 - lib/hanami/utils.rb
 - lib/hanami/utils/blank.rb
@@ -153,11 +155,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby core extentions and Hanami utilities

data/lib/hanami/logger/colorizer.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-require "hanami/utils/shell_color"
-
-module Hanami
-  class Logger < ::Logger
-    # Null colorizer for logger streams that aren't a TTY (eg. files)
-    #
-    # @since 1.2.0
-    # @api private
-    class NullColorizer
-      # @since 1.2.0
-      # @api private
-      def call(app, severity, datetime, _progname)
-        ::Hash[
-          app: app,
-          severity: severity,
-          time: datetime,
-        ]
-      end
-    end
-
-    # Hanami::Logger Default Colorizer
-    #
-    # This colorizer takes in parts of the log message and returns them with
-    # proper shellcode to colorize when displayed to a tty.
-    #
-    # @since 1.2.0
-    # @api private
-    class Colorizer < NullColorizer
-      def initialize(colors: COLORS)
-        @colors = colors
-      end
-
-      # Colorize the inputs
-      #
-      # @param app [#to_s] the app name
-      # @param severity [#to_s] log severity
-      # @param datetime [#to_s] timestamp
-      # @param _progname [#to_s] program name - ignored, accepted for
-      #   compatibility with Ruby's Logger
-      #
-      # @return [::Hash] an Hash containing the keys `:app`, `:severity`, and `:time`
-      def call(app, severity, datetime, _progname)
-        ::Hash[
-          app: app(app),
-          severity: severity(severity),
-          time: datetime(datetime),
-        ]
-      end
-
-      private
-
-      # The colors defined for the three parts of the log message
-      #
-      # @since 1.2.0
-      # @api private
-      COLORS = ::Hash[
-        app: :blue,
-        datetime: :cyan,
-      ].freeze
-
-      # @since 1.2.0
-      # @api private
-      LEVELS = ::Hash[
-        Hanami::Logger::DEBUG => :cyan,
-        Hanami::Logger::INFO => :magenta,
-        Hanami::Logger::WARN => :yellow,
-        Hanami::Logger::ERROR => :red,
-        Hanami::Logger::FATAL => :red,
-        Hanami::Logger::UNKNOWN => :blue,
-      ].freeze
-
-      attr_reader :colors
-
-      # @since 1.2.0
-      # @api private
-      def app(input)
-        colorize(input, color: colors.fetch(:app, nil))
-      end
-
-      # @since 1.2.0
-      # @api private
-      def severity(input)
-        color = LEVELS.fetch(Hanami::Logger.level(input), :gray)
-        colorize(input, color: color)
-      end
-
-      # @since 1.2.0
-      # @api private
-      def datetime(input)
-        colorize(input, color: colors.fetch(:datetime, nil))
-      end
-
-      # @since 1.2.0
-      # @api private
-      def colorize(message, color:)
-        return message if color.nil?
-
-        Hanami::Utils::ShellColor.call(message, color: color)
-      end
-    end
-  end
-end

data/lib/hanami/logger/filter.rb

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-
-module Hanami
-  class Logger < ::Logger
-    # Filtering logic
-    #
-    # @since 1.1.0
-    # @api private
-    class Filter
-      # @since 1.3.7
-      # @api private
-      FILTERED_VALUE = "[FILTERED]"
-
-      def initialize(filters = [], mask: FILTERED_VALUE)
-        @filters = filters
-        @mask = mask
-      end
-
-      # @since 1.1.0
-      # @api private
-      def call(params)
-        _filter(_copy_params(params))
-      end
-
-      private
-
-      # @since 1.1.0
-      # @api private
-      attr_reader :filters
-
-      # @since 1.3.7
-      # @api private
-      attr_reader :mask
-
-      # This is a simple deep merge to merge the original input
-      # with the filtered hash which contains '[FILTERED]' string.
-      #
-      # It only deep-merges if the conflict values are both hashes.
-      #
-      # @since 1.3.7
-      # @api private
-      def _deep_merge(original_hash, filtered_hash)
-        original_hash.merge(filtered_hash) do |_key, original_item, filtered_item|
-          if original_item.is_a?(Hash) && filtered_item.is_a?(Hash)
-            _deep_merge(original_item, filtered_item)
-          elsif filtered_item == FILTERED_VALUE
-            filtered_item
-          else
-            original_item
-          end
-        end
-      end
-
-      # @since 1.1.0
-      # @api private
-      def _filtered_keys(hash)
-        _key_paths(hash).select { |key| filters.any? { |filter| key =~ %r{(\.|\A)#{filter}(\.|\z)} } }
-      end
-
-      # @since 1.1.0
-      # @api private
-      def _key_paths(hash, base = nil)
-        hash.inject([]) do |results, (k, v)|
-          results + (_key_paths?(v) ? _key_paths(v, _build_path(base, k)) : [_build_path(base, k)])
-        end
-      end
-
-      # @since 1.1.0
-      # @api private
-      def _build_path(base, key)
-        [base, key.to_s].compact.join(".")
-      end
-
-      # @since 1.1.0
-      # @api private
-      def _actual_keys(hash, keys)
-        search_in = hash
-
-        keys.inject([]) do |res, key|
-          correct_key = search_in.key?(key.to_sym) ? key.to_sym : key
-          search_in = search_in[correct_key]
-          res + [correct_key]
-        end
-      end
-
-      # Check if the given value can be iterated (`Enumerable`) and that isn't a `File`.
-      # This is useful to detect closed `Tempfiles`.
-      #
-      # @since 1.3.5
-      # @api private
-      #
-      # @see https://github.com/hanami/utils/pull/342
-      def _key_paths?(value)
-        value.is_a?(Enumerable) && !value.is_a?(File)
-      end
-
-      # @since 1.3.7
-      # @api private
-      def _deep_dup(hash)
-        hash.transform_values do |value|
-          if value.is_a?(Hash)
-            _deep_dup(value)
-          else
-            _key_paths?(value) ? value.dup : value
-          end
-        end
-      end
-
-      # @since 1.3.7
-      # @api private
-      def _copy_params(params)
-        case params
-        when Hash
-          _deep_dup(params)
-        when Array
-          params.map { |hash| _deep_dup(hash) }
-        end
-      end
-
-      # @since 1.3.7
-      # @api private
-      def _filter_hash(hash)
-        _filtered_keys(hash).each do |key|
-          *keys, last = _actual_keys(hash, key.split("."))
-          keys.inject(hash, :fetch)[last] = mask
-        end
-        hash
-      end
-
-      # @since 1.3.7
-      # @api private
-      def _filter(params)
-        case params
-        when Hash
-          _filter_hash(params)
-        when Array
-          params.map { |hash| _filter_hash(hash) }
-        end
-      end
-    end
-  end
-end

data/lib/hanami/logger/formatter.rb

@@ -1,183 +0,0 @@
-# frozen_string_literal: true
-
-require "set"
-require "json"
-require "logger"
-require "hanami/utils/json"
-require "hanami/utils/class_attribute"
-require "hanami/utils/query_string"
-
-module Hanami
-  class Logger < ::Logger
-    # Hanami::Logger default formatter.
-    # This formatter returns string in key=value format.
-    #
-    # @since 0.5.0
-    # @api private
-    #
-    # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html
-    class Formatter < ::Logger::Formatter
-      require "hanami/logger/filter"
-      require "hanami/logger/colorizer"
-
-      # @since 0.8.0
-      # @api private
-      SEPARATOR = " "
-
-      # @since 0.8.0
-      # @api private
-      NEW_LINE = $/
-
-      # @since 1.0.0
-      # @api private
-      RESERVED_KEYS = %i[app severity time].freeze
-
-      include Utils::ClassAttribute
-
-      class_attribute :subclasses
-      self.subclasses = Set.new
-
-      def self.fabricate(formatter, application_name, filters, colorizer)
-        fabricated_formatter = _formatter_instance(formatter)
-
-        fabricated_formatter.application_name = application_name
-        fabricated_formatter.filter           = Filter.new(filters)
-        fabricated_formatter.colorizer        = colorizer
-
-        fabricated_formatter
-      end
-
-      # @api private
-      def self.inherited(subclass)
-        super
-        subclasses << subclass
-      end
-
-      # @api private
-      def self.eligible?(name)
-        name == :default
-      end
-
-      # @api private
-      # @since 1.1.0
-      def self._formatter_instance(formatter)
-        case formatter
-        when Symbol
-          (subclasses.find { |s| s.eligible?(formatter) } || self).new
-        when nil
-          new
-        else
-          formatter
-        end
-      end
-      private_class_method :_formatter_instance
-
-      # @since 0.5.0
-      # @api private
-      attr_writer :application_name
-
-      # @since 1.0.0
-      # @api private
-      attr_reader :application_name
-
-      # @since 1.2.0
-      # @api private
-      attr_writer :filter
-
-      # @since 1.2.0
-      # @api private
-      attr_writer :colorizer
-
-      # @since 0.5.0
-      # @api private
-      #
-      # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html#method-i-call
-      def call(severity, time, progname, msg)
-        colorized = @colorizer.call(application_name, severity, time, progname)
-        colorized.merge!(_message_hash(msg))
-
-        _format(colorized)
-      end
-
-      private
-
-      # @since 0.8.0
-      # @api private
-      def _message_hash(message)
-        case message
-        when ::Hash
-          @filter.call(message)
-        when Exception
-          ::Hash[
-            message: message.message,
-            backtrace: message.backtrace || [],
-            error: message.class
-          ]
-        else
-          ::Hash[message: message]
-        end
-      end
-
-      # @since 0.8.0
-      # @api private
-      def _format(hash)
-        "#{_line_front_matter(hash.delete(:app), hash.delete(:severity), hash.delete(:time))}#{SEPARATOR}#{_format_message(hash)}" # rubocop:disable Layout/LineLength
-      end
-
-      # @since 1.2.0
-      # @api private
-      def _line_front_matter(*args)
-        args.map { |string| "[#{string}]" }.join(SEPARATOR)
-      end
-
-      # @since 1.2.0
-      # @api private
-      def _format_message(hash)
-        if hash.key?(:error)
-          _format_error(hash)
-        elsif hash.key?(:params)
-          "#{hash.values.join(SEPARATOR)}#{NEW_LINE}"
-        else
-          "#{Utils::QueryString.call(hash[:message] || hash)}#{NEW_LINE}"
-        end
-      end
-
-      # @since 1.2.0
-      # @api private
-      def _format_error(hash)
-        result = [hash[:error], hash[:message]].compact.join(": ").concat(NEW_LINE)
-        hash[:backtrace].each do |line|
-          result << "from #{line}#{NEW_LINE}"
-        end
-
-        result
-      end
-    end
-
-    # Hanami::Logger JSON formatter.
-    # This formatter returns string in JSON format.
-    #
-    # @since 0.5.0
-    # @api private
-    class JSONFormatter < Formatter
-      # @api private
-      def self.eligible?(name)
-        name == :json
-      end
-
-      # @api private
-      def colorizer=(*)
-        @colorizer = NullColorizer.new
-      end
-
-      private
-
-      # @since 0.8.0
-      # @api private
-      def _format(hash)
-        hash[:time] = hash[:time].utc.iso8601
-        Hanami::Utils::Json.generate(hash) + NEW_LINE
-      end
-    end
-  end
-end

data/lib/hanami/logger.rb

@@ -1,362 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-require "hanami/utils/string"
-require "hanami/utils/files"
-
-module Hanami
-  # Hanami logger
-  #
-  # Implementation with the same interface of Ruby std lib `Logger`.
-  # It uses `STDOUT`, `STDERR`, file name or open file as output stream.
-  #
-  #
-  # When a Hanami application is initialized, it creates a logger for that specific application.
-  # For instance for a `Bookshelf::Application` a `Bookshelf::Logger` will be available.
-  #
-  # This is useful for auto-tagging the output. Eg (`app=Booshelf`).
-  #
-  # When used standalone (eg. `Hanami::Logger.info`), it tags lines with `app=Shared`.
-  #
-  #
-  # The available severity levels are the same of `Logger`:
-  #
-  #   * DEBUG
-  #   * INFO
-  #   * WARN
-  #   * ERROR
-  #   * FATAL
-  #   * UNKNOWN
-  #
-  # Those levels are available both as class and instance methods.
-  #
-  # Also Hanami::Logger supports different formatters. Now available only two:
-  #
-  #   * Formatter (default)
-  #   * JSONFormatter
-  #
-  # And if you want to use custom formatter you need create new class inherited from
-  # `Formatter` class and define `_format` private method like this:
-  #
-  #     class CustomFormatter < Formatter
-  #       private
-  #       def _format(hash)
-  #         # ...
-  #       end
-  #     end
-  #
-  # @since 0.5.0
-  #
-  # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html
-  # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Severity.html
-  #
-  # @example Basic usage
-  #   require 'hanami'
-  #
-  #   module Bookshelf
-  #     class Application < Hanami::Application
-  #     end
-  #   end
-  #
-  #   # Initialize the application with the following code:
-  #   Bookshelf::Application.load!
-  #   # or
-  #   Bookshelf::Application.new
-  #
-  #   Bookshelf::Logger.new.info('Hello')
-  #   # => app=Bookshelf severity=INFO time=1988-09-01 00:00:00 UTC message=Hello
-  #
-  # @example Standalone usage
-  #   require 'hanami/logger'
-  #
-  #   Hanami::Logger.new.info('Hello')
-  #   # => app=Hanami severity=INFO time=2016-05-27 10:14:42 UTC message=Hello
-  #
-  # @example Custom tagging
-  #   require 'hanami/logger'
-  #
-  #   Hanami::Logger.new('FOO').info('Hello')
-  #   # => app=FOO severity=INFO time=2016-05-27 10:14:42 UTC message=Hello
-  #
-  # @example Write to file
-  #   require 'hanami/logger'
-  #
-  #   Hanami::Logger.new(stream: 'logfile.log').info('Hello')
-  #   # in logfile.log
-  #   # => app=FOO severity=INFO time=2016-05-27 10:14:42 UTC message=Hello
-  #
-  # @example Use JSON formatter
-  #   require 'hanami/logger'
-  #
-  #   Hanami::Logger.new(formatter: Hanami::Logger::JSONFormatter).info('Hello')
-  #   # => "{\"app\":\"Hanami\",\"severity\":\"INFO\",\"time\":\"1988-09-01 00:00:00 UTC\",\"message\":\"Hello\"}"
-  #
-  # @example Disable colorization
-  #   require 'hanami/logger'
-  #
-  #   Hanami::Logger.new(colorizer: false)
-  #
-  # @example Use custom colors
-  #   require 'hanami/logger'
-  #
-  #   Hanami::Logger.new(colorizer: Hanami::Logger::Colorizer.new(colors: { app: :red }))
-  #
-  # @example Use custom colorizer
-  #   require "hanami/logger"
-  #   require "paint" # gem install paint
-  #
-  #   class LogColorizer < Hanami::Logger::Colorizer
-  #     def initialize(colors: { app: [:red, :bright], severity: [:red, :blue], datetime: [:italic, :yellow] })
-  #       super
-  #     end
-  #
-  #     private
-  #
-  #     def colorize(message, color:)
-  #       Paint[message, *color]
-  #     end
-  #   end
-  #
-  #   Hanami::Logger.new(colorizer: LogColorizer.new)
-  class Logger < ::Logger
-    require "hanami/logger/formatter"
-    require "hanami/logger/colorizer"
-
-    # Default application name.
-    # This is used as a fallback for tagging purposes.
-    #
-    # @since 0.5.0
-    # @api private
-    DEFAULT_APPLICATION_NAME = "hanami"
-
-    # @since 0.8.0
-    # @api private
-    LEVELS = ::Hash[
-      "debug" => DEBUG,
-      "info" => INFO,
-      "warn" => WARN,
-      "error" => ERROR,
-      "fatal" => FATAL,
-      "unknown" => UNKNOWN
-    ].freeze
-
-    # @since 1.2.0
-    # @api private
-    def self.level(level)
-      case level
-      when DEBUG..UNKNOWN
-        level
-      else
-        LEVELS.fetch(level.to_s.downcase, DEBUG)
-      end
-    end
-
-    # @since 0.5.0
-    # @api private
-    attr_writer :application_name
-
-    # Initialize a logger
-    #
-    # @param application_name [String] an optional application name used for
-    #   tagging purposes
-    #
-    # @param args [Array<Object>] an optional set of arguments to honor Ruby's
-    #   `Logger#initialize` arguments. See Ruby documentation for details.
-    #
-    # @param stream [String, IO, StringIO, Pathname] an optional log stream.
-    #   This is a filename (`String`) or `IO` object (typically `$stdout`,
-    #   `$stderr`, or an open file). It defaults to `$stderr`.
-    #
-    # @param level [Integer,String] logging level. It can be expressed as an
-    #   integer, according to Ruby's `Logger` from standard library or as a
-    #   string with the name of the level
-    #
-    # @param formatter [Symbol,#_format] a formatter - We support `:json` as
-    #   JSON formatter or an object that respond to `#_format(data)`
-    #
-    # @since 0.5.0
-    #
-    # @see https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html#class-Logger-label-How+to+create+a+logger
-    #
-    # @example Basic usage
-    #   require 'hanami/logger'
-    #
-    #   logger = Hanami::Logger.new
-    #   logger.info "Hello World"
-    #
-    #   # => [Hanami] [DEBUG] [2017-03-30 15:41:01 +0200] Hello World
-    #
-    # @example Custom application name
-    #   require 'hanami/logger'
-    #
-    #   logger = Hanami::Logger.new('bookshelf')
-    #   logger.info "Hello World"
-    #
-    #   # => [bookshelf] [DEBUG] [2017-03-30 15:44:23 +0200] Hello World
-    #
-    # @example Logger level (Integer)
-    #   require 'hanami/logger'
-    #
-    #   logger = Hanami::Logger.new(level: 2) # WARN
-    #   logger.info "Hello World"
-    #   # => true
-    #
-    #   logger.info "Hello World"
-    #   # => true
-    #
-    #   logger.warn "Hello World"
-    #   # => [Hanami] [WARN] [2017-03-30 16:00:48 +0200] Hello World
-    #
-    # @example Logger level (Constant)
-    #   require 'hanami/logger'
-    #
-    #   logger = Hanami::Logger.new(level: Hanami::Logger::WARN)
-    #   logger.info "Hello World"
-    #   # => true
-    #
-    #   logger.info "Hello World"
-    #   # => true
-    #
-    #   logger.warn "Hello World"
-    #   # => [Hanami] [WARN] [2017-03-30 16:00:48 +0200] Hello World
-    #
-    # @example Logger level (String)
-    #   require 'hanami/logger'
-    #
-    #   logger = Hanami::Logger.new(level: 'warn')
-    #   logger.info "Hello World"
-    #   # => true
-    #
-    #   logger.info "Hello World"
-    #   # => true
-    #
-    #   logger.warn "Hello World"
-    #   # => [Hanami] [WARN] [2017-03-30 16:00:48 +0200] Hello World
-    #
-    # @example Use a file
-    #   require 'hanami/logger'
-    #
-    #   logger = Hanami::Logger.new(stream: "development.log")
-    #   logger.info "Hello World"
-    #
-    #   # => true
-    #
-    #   File.read("development.log")
-    #   # =>
-    #   #  # Logfile created on 2017-03-30 15:52:48 +0200 by logger.rb/56815
-    #   #  [Hanami] [DEBUG] [2017-03-30 15:52:54 +0200] Hello World
-    #
-    # @example Period rotation
-    #   require 'hanami/logger'
-    #
-    #   # Rotate daily
-    #   logger = Hanami::Logger.new('bookshelf', 'daily', stream: 'development.log')
-    #
-    # @example File size rotation
-    #   require 'hanami/logger'
-    #
-    #   # leave 10 old log files where the size is about 1,024,000 bytes
-    #   logger = Hanami::Logger.new('bookshelf', 10, 1024000, stream: 'development.log')
-    #
-    # @example Use a StringIO
-    #   require 'hanami/logger'
-    #
-    #   stream = StringIO.new
-    #   logger = Hanami::Logger.new(stream: stream)
-    #   logger.info "Hello World"
-    #
-    #   # => true
-    #
-    #   stream.rewind
-    #   stream.read
-    #
-    #   # => "[Hanami] [DEBUG] [2017-03-30 15:55:22 +0200] Hello World\n"
-    #
-    # @example JSON formatter
-    #   require 'hanami/logger'
-    #
-    #   logger = Hanami::Logger.new(formatter: :json)
-    #   logger.info "Hello World"
-    #
-    #   # => {"app":"Hanami","severity":"DEBUG","time":"2017-03-30T13:57:59Z","message":"Hello World"}
-    # rubocop:disable Lint/SuppressedException
-    # rubocop:disable Metrics/ParameterLists
-    def initialize(application_name = nil, *args, stream: $stdout, level: DEBUG, formatter: nil, filter: [], colorizer: nil) # rubocop:disable Layout/LineLength
-      begin
-        Utils::Files.mkdir_p(stream)
-      rescue TypeError
-      end
-
-      super(stream, *args)
-
-      @level            = _level(level)
-      @stream           = stream
-      @application_name = application_name
-      @formatter        = Formatter.fabricate(formatter, self.application_name, filter, lookup_colorizer(colorizer))
-    end
-
-    # rubocop:enable Metrics/ParameterLists
-    # rubocop:enable Lint/SuppressedException
-
-    # Returns the current application name, this is used for tagging purposes
-    #
-    # @return [String] the application name
-    #
-    # @since 0.5.0
-    def application_name
-      @application_name || _application_name_from_namespace || _default_application_name
-    end
-
-    # @since 0.8.0
-    # @api private
-    def level=(value)
-      super _level(value)
-    end
-
-    # Closes the logging stream if this stream isn't an STDOUT
-    #
-    # @since 0.8.0
-    def close
-      super unless [STDOUT, $stdout].include?(@stream) # rubocop:disable Style/GlobalStdStream
-    end
-
-    private
-
-    # @since 0.5.0
-    # @api private
-    def _application_name_from_namespace
-      class_name = self.class.name
-      namespace  = Utils::String.namespace(class_name)
-
-      class_name != namespace and return namespace
-    end
-
-    # @since 0.5.0
-    # @api private
-    def _default_application_name
-      DEFAULT_APPLICATION_NAME
-    end
-
-    # @since 0.8.0
-    # @api private
-    def _level(level)
-      self.class.level(level)
-    end
-
-    # @since 1.2.0
-    # @api private
-    def lookup_colorizer(colorizer)
-      return NullColorizer.new if colorizer == false
-
-      colorizer || (tty? ? Colorizer : NullColorizer).new
-    end
-
-    # @since 1.2.0
-    # @api private
-    def tty?
-      return false if @logdev.nil?
-
-      @logdev.dev.tty?
-    end
-  end
-end