hanami-utils 1.3.5 → 2.0.0.alpha2

data/lib/hanami/logger/colorizer.rb

@@ -14,9 +14,9 @@ module Hanami
       # @api private
       def call(app, severity, datetime, _progname)
         ::Hash[
-          app:      app,
+          app: app,
           severity: severity,
-          time:     datetime,
+          time: datetime,
         ]
       end
     end
@@ -44,9 +44,9 @@ module Hanami
       # @return [::Hash] an Hash containing the keys `:app`, `:severity`, and `:time`
       def call(app, severity, datetime, _progname)
         ::Hash[
-          app:      app(app),
+          app: app(app),
           severity: severity(severity),
-          time:     datetime(datetime),
+          time: datetime(datetime),
         ]
       end
 
@@ -57,18 +57,18 @@ module Hanami
       # @since 1.2.0
       # @api private
       COLORS = ::Hash[
-        app:      :blue,
+        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::DEBUG => :cyan,
+        Hanami::Logger::INFO => :magenta,
+        Hanami::Logger::WARN => :yellow,
+        Hanami::Logger::ERROR => :red,
+        Hanami::Logger::FATAL => :red,
         Hanami::Logger::UNKNOWN => :blue,
       ].freeze
 

data/lib/hanami/logger/filter.rb

@@ -9,21 +9,19 @@ module Hanami
     # @since 1.1.0
     # @api private
     class Filter
-      # @since 1.1.0
+      # @since 1.3.7
       # @api private
-      def initialize(filters = [])
+      FILTERED_VALUE = "[FILTERED]"
+
+      def initialize(filters = [], mask: FILTERED_VALUE)
         @filters = filters
+        @mask = mask
       end
 
       # @since 1.1.0
       # @api private
-      def call(hash)
-        _filtered_keys(hash).each do |key|
-          *keys, last = _actual_keys(hash, key.split("."))
-          keys.inject(hash, :fetch)[last] = "[FILTERED]"
-        end
-
-        hash
+      def call(params)
+        _filter(_copy_params(params))
       end
 
       private
@@ -32,6 +30,29 @@ module Hanami
       # @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)
@@ -74,6 +95,50 @@ module Hanami
       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

@@ -103,25 +103,25 @@ module Hanami
 
       # @since 0.8.0
       # @api private
-      def _message_hash(message) # rubocop:disable Metrics/MethodLength
+      def _message_hash(message)
         case message
-        when Hash
+        when ::Hash
           @filter.call(message)
         when Exception
-          Hash[
-            message:   message.message,
+          ::Hash[
+            message: message.message,
             backtrace: message.backtrace || [],
-            error:     message.class
+            error: message.class
           ]
         else
-          Hash[message: message]
+          ::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)}"
+        "#{_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

data/lib/hanami/middleware.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Middleware
+    # Hanami middleware utils
+
+    # @since 2.0.0
+    class Error < ::StandardError
+    end
+  end
+end

data/lib/hanami/utils.rb

@@ -1,11 +1,13 @@
-require 'pathname'
+# frozen_string_literal: true
+
+require "pathname"
 
 # Hanami - The web, with simplicity
 #
 # @since 0.1.0
 module Hanami
-  require 'hanami/utils/version'
-  require 'hanami/utils/file_list'
+  require "hanami/utils/version"
+  require "hanami/utils/file_list"
 
   # Ruby core extentions and Hanami utilities
   #
@@ -13,15 +15,15 @@ module Hanami
   module Utils
     # @since 0.3.1
     # @api private
-    HANAMI_JRUBY = 'java'.freeze
+    HANAMI_JRUBY = "java"
 
     # @since 0.3.1
     # @api private
-    HANAMI_RUBINIUS = 'rbx'.freeze
+    HANAMI_RUBINIUS = "rbx"
 
     # Checks if the current VM is JRuby
     #
-    # @return [TrueClass,FalseClass] return if the VM is JRuby or not
+    # @return [TrueClass,FalseClass] info whether the VM is JRuby or not
     #
     # @since 0.3.1
     # @api private
@@ -31,7 +33,7 @@ module Hanami
 
     # Checks if the current VM is Rubinius
     #
-    # @return [TrueClass,FalseClass] return if the VM is Rubinius or not
+    # @return [TrueClass,FalseClass] info whether the VM is Rubinius or not
     #
     # @since 0.3.1
     # @api private
@@ -39,7 +41,7 @@ module Hanami
       RUBY_ENGINE == HANAMI_RUBINIUS
     end
 
-    # Recursively require Ruby files under the given directory.
+    # Recursively requires Ruby files under the given directory.
     #
     # If the directory is relative, it implies it's the path from current directory.
     # If the directory is absolute, it uses as it is.
@@ -54,22 +56,6 @@ module Hanami
       for_each_file_in(directory) { |file| require_relative(file) }
     end
 
-    # Recursively reload Ruby files under the given directory.
-    #
-    # If the directory is relative, it implies it's the path from current directory.
-    # If the directory is absolute, it uses as it is.
-    #
-    # It respects file separator of the current operating system.
-    # A pattern like <tt>"path/to/files"</tt> will work both on *NIX and Windows machines.
-    #
-    # @param directory [String, Pathname] the directory
-    #
-    # @since 1.0.0
-    # @api private
-    def self.reload!(directory)
-      for_each_file_in(directory) { |file| load(file) }
-    end
-
     # Recursively scans through the given directory and yields the given block
     # for each Ruby source file.
     #
@@ -85,9 +71,9 @@ module Hanami
     # @since 1.0.0
     # @api private
     def self.for_each_file_in(directory, &blk)
-      directory = directory.to_s.gsub(%r{(\/|\\)}, File::SEPARATOR)
+      directory = directory.to_s.gsub(%r{(/|\\)}, File::SEPARATOR)
       directory = Pathname.new(Dir.pwd).join(directory).to_s
-      directory = File.join(directory, '**', '*.rb') unless directory =~ /(\*\*)/
+      directory = File.join(directory, "**", "*.rb") unless directory =~ /(\*\*)/
 
       FileList[directory].each(&blk)
     end

data/lib/hanami/utils/basic_object.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Hanami
   module Utils
     # BasicObject
     #
     # @since 0.3.5
     class BasicObject < ::BasicObject
-      # Lookup constants at the top-level namespace, if they are missing in the
+      # Lookups constants at the top-level namespace, if they are missing in the
       # current context.
       #
       # @param name [Symbol] the constant name
@@ -21,7 +23,7 @@ module Hanami
         ::Object.const_get(name)
       end
 
-      # Return the class for debugging purposes.
+      # Returns the class for debugging purposes.
       #
       # @since 0.3.5
       #
@@ -38,17 +40,15 @@ module Hanami
       #
       # @see http://ruby-doc.org/core/Object.html#method-i-inspect
       #
-      # rubocop:disable Style/FormatString
       # rubocop:disable Style/FormatStringToken
       def inspect
         "#<#{self.class}:#{'0x0000%x' % (__id__ << 1)}#{__inspect}>"
       end
       # rubocop:enable Style/FormatStringToken
-      # rubocop:enable Style/FormatString
 
       # @!macro [attach] instance_of?(class)
       #
-      # Determine if self is an instance of given class or module
+      # Determines if self is an instance of given class or module
       #
       # @param class [Class,Module] the class of module to verify
       #
@@ -63,7 +63,7 @@ module Hanami
 
       # @!macro [attach] is_a?(class)
       #
-      # Determine if self is of the type of the object class or module
+      # Determines if self is of the type of the object class or module
       #
       # @param class [Class,Module] the class of module to verify
       #
@@ -78,7 +78,7 @@ module Hanami
 
       # @!macro [attach] kind_of?(class)
       #
-      # Determine if self is of the kind of the object class or module
+      # Determines if self is of the kind of the object class or module
       #
       # @param class [Class,Module] the class of module to verify
       #

data/lib/hanami/utils/blank.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Utils
     # Checks for blank
@@ -11,7 +13,7 @@ module Hanami
       # @api private
       STRING_MATCHER = /\A[[:space:]]*\z/.freeze
 
-      # Checks object is blank
+      # Checks if object is blank
       #
       # @example Basic Usage
       #   require 'hanami/utils/blank'
@@ -19,21 +21,20 @@ module Hanami
       #   Hanami::Utils::Blank.blank?(Hanami::Utils::String.new('')) # => true
       #   Hanami::Utils::Blank.blank?('  ')                          # => true
       #   Hanami::Utils::Blank.blank?(nil)                           # => true
-      #   Hanami::Utils::Blank.blank?(Hanami::Utils::Hash.new({}))   # => true
       #   Hanami::Utils::Blank.blank?(true)                          # => false
       #   Hanami::Utils::Blank.blank?(1)                             # => false
       #
       # @param object the argument
       #
-      # @return [TrueClass,FalseClass]
+      # @return [TrueClass,FalseClass] info, whether object is blank
       #
       # @since 0.8.0
       # @api private
-      def self.blank?(object) # rubocop:disable Metrics/MethodLength
+      def self.blank?(object)
         case object
         when String, ::String
-          STRING_MATCHER === object # rubocop:disable Style/CaseEquality
-        when Hash, ::Hash, ::Array
+          STRING_MATCHER === object
+        when ::Hash, ::Array
           object.empty?
         when TrueClass, Numeric
           false
@@ -44,7 +45,7 @@ module Hanami
         end
       end
 
-      # Checks object is filled
+      # Checks if object is filled
       #
       # @example Basic Usage
       #   require 'hanami/utils/blank'
@@ -54,11 +55,10 @@ module Hanami
       #   Hanami::Utils::Blank.filled?(Hanami::Utils::String.new('')) # => false
       #   Hanami::Utils::Blank.filled?('  ')                          # => false
       #   Hanami::Utils::Blank.filled?(nil)                           # => false
-      #   Hanami::Utils::Blank.filled?(Hanami::Utils::Hash.new({}))   # => false
       #
       # @param object the argument
       #
-      # @return [TrueClass,FalseClass]
+      # @return [TrueClass,FalseClass] whether the object is filled
       #
       # @since 1.0.0
       # @api private

data/lib/hanami/utils/callbacks.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "concurrent/array"
+
 module Hanami
   module Utils
     # Before and After callbacks
@@ -10,13 +14,13 @@ module Hanami
       # @since 0.1.0
       # @private
       class Chain
-        # Return a new chain
+        # Returns a new chain
         #
         # @return [Hanami::Utils::Callbacks::Chain]
         #
         # @since 0.2.0
         def initialize
-          @chain = []
+          @chain = Concurrent::Array.new
         end
 
         # Appends the given callbacks to the end of the chain.
@@ -148,6 +152,17 @@ module Hanami
           end
         end
 
+        # Return a duplicate callbacks chain
+        #
+        # @return [Hanami::Utils::Callbacks] the duplicated chain
+        #
+        # @since 2.0.0
+        def dup
+          super.tap do |instance|
+            instance.instance_variable_set(:@chain, instance.chain.dup)
+          end
+        end
+
         # It freezes the object by preventing further modifications.
         #
         # @since 0.2.0
@@ -168,6 +183,10 @@ module Hanami
           @chain.freeze
         end
 
+        protected
+
+        attr_reader :chain
+
         private
 
         # @api private
@@ -248,7 +267,9 @@ module Hanami
       end
 
       # Method callback
-      # It wraps a symbol or a string representing a method name that is implemented by the context within it will be called.
+      #
+      # It wraps a symbol or a string representing a method name that is
+      # implemented by the context within it will be called.
       #
       # @since 0.1.0
       # @api private