hanami-utils 1.3.2 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab3141a4fd9052c6472d5bfd820eca5be30a9be7e3f8c7a8c5039ca14ff8a44e
-  data.tar.gz: c6b7581c887b4c7dafe0834a5ee045eaef17d1ed9a82aeffd5e6de2c995093d6
+  metadata.gz: '02818d90409ea03d89ca587c97fe418bbf17a8694662a2313609c0710466b0f9'
+  data.tar.gz: 973ef420992dd9ea30ab880d43e8cc70eee59cae6fb7b1ba17038c5ce8d536a4
 SHA512:
-  metadata.gz: e05b9c87e1e3206ba379a7f4d09fcae6602049d36548306ccec1abf89f7a2e2271ab995e2afa9702411062f3fd0f2e13e1bcdcd69868a63e05517fc36bf1c020
-  data.tar.gz: 55e117ed1367cdd8791531e42b7da858641a6e36f24cd5d440371e006a704ffa53dd0e01d352e306dd6be1eedb4ba0ffd728228e01dfab0a9de9e6e3814cbd04
+  metadata.gz: d49d6ad21aa25f285c9165c4619d6b2d7fe348513481bf30b8f231211d4e270f7502e2e3594f082789fdf32e9170a33e038329394ae5f43170ab778ebe01892f
+  data.tar.gz: 8b8832a39855525d6818de385212fb1c9d7c5c0f79874f60ead95ee1c592377f6bfec0ade5701a4340b87fe920c495889a9586d81fe2091d8691b52b14f297fa

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v1.3.7 - 2021-01-04
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 3.0
+- [Khai Le] Allow `Hanami::Logger` to filter sensitive data for an array of hashes
+
+### Fixed
+- [Hiếu Nguyễn] Ensure `Hanami::Logger` to not mutate `Hash` input when filtering sensitive data
+
+## v1.3.6 - 2020-01-07
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 2.7
+
+### Fixed
+- [ippachi] `Utils::Files.append`: don't check breakline if file is empty
+
+## v1.3.5 - 2019-10-25
+### Fixed
+- [Ivan Kabluchkov] Ensure `Hanami::Logger` filters to not crash when logger stream is a closed tempfile
+- [Luca Guidi] Ensure `Utils::Files.append` to append contents properly when existing file doesn't end with a newline
+
+## v1.3.4 - 2019-09-27
+### Added
+- [Luca Guidi] Let `Utils::BasicObject` to lookup constants at the top-level namespace
+
+## v1.3.3 - 2019-09-13
+### Fixed
+- [Mauro Morales] Ensure `Utils::Inflector.pluralize` and `.singularize` to work with words that contain an underscore (`_`)
+
 ## v1.3.2 - 2019-06-21
 ### Added
 - [Vladislav Yashin & Luca Guidi] Added `Utils::BasicObject#instance_of?`, `#is_a?`, and `#kind_of`

data/README.md

@@ -5,8 +5,7 @@ Ruby core extensions and class utilities for [Hanami](http://hanamirb.org)
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/hanami-utils.svg)](https://badge.fury.io/rb/hanami-utils)
-[![TravisCI](https://travis-ci.org/hanami/utils.svg?branch=master)](https://travis-ci.org/hanami/utils)
-[![CircleCI](https://circleci.com/gh/hanami/utils/tree/master.svg?style=svg)](https://circleci.com/gh/hanami/utils/tree/master)
+[![CI](https://github.com/hanami/utils/workflows/ci/badge.svg?branch=master)](https://github.com/hanami/utils/actions?query=workflow%3Aci+branch%3Amaster)
 [![Test Coverage](https://codecov.io/gh/hanami/utils/branch/master/graph/badge.svg)](https://codecov.io/gh/hanami/utils)
 [![Depfu](https://badges.depfu.com/badges/a8545fb67cf32a2c75b6227bc0821027/overview.svg)](https://depfu.com/github/hanami/utils?project=Bundler)
 [![Inline Docs](http://inch-ci.org/github/hanami/utils.svg)](http://inch-ci.org/github/hanami/utils)
@@ -150,6 +149,6 @@ __Hanami::Utils__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2017 Luca Guidi – Released under MIT License
+Copyright © 2014-2021 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-utils`).

data/hanami-utils.gemspec

@@ -1,27 +1,30 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hanami/utils/version'
+require "hanami/utils/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'hanami-utils'
+  spec.name          = "hanami-utils"
   spec.version       = Hanami::Utils::VERSION
-  spec.authors       = ['Luca Guidi']
-  spec.email         = ['me@lucaguidi.com']
-  spec.description   = 'Hanami utilities'
-  spec.summary       = 'Ruby core extentions and Hanami utilities'
-  spec.homepage      = 'http://hanamirb.org'
-  spec.license       = 'MIT'
+  spec.authors       = ["Luca Guidi"]
+  spec.email         = ["me@lucaguidi.com"]
+  spec.description   = "Hanami utilities"
+  spec.summary       = "Ruby core extentions and Hanami utilities"
+  spec.homepage      = "http://hanamirb.org"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-utils.gemspec`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_dependency 'transproc',       '~> 1.0'
-  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_dependency "transproc",       "~> 1.0"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
 
-  spec.add_development_dependency 'bundler', '>= 1.6', '< 3'
-  spec.add_development_dependency 'rake',    '~> 12'
-  spec.add_development_dependency 'rspec',   '~> 3.7'
+  spec.add_development_dependency "bundler", ">= 1.6", "< 3"
+  spec.add_development_dependency "rake",    "~> 13"
+  spec.add_development_dependency "rspec",   "~> 3.9"
+  spec.add_development_dependency "rubocop", "0.81" # rubocop 0.81+ removed support for Ruby 2.3
 end

data/lib/hanami-utils.rb

@@ -1 +1,3 @@
-require 'hanami/utils'
+# frozen_string_literal: true
+
+require "hanami/utils"

data/lib/hanami/interactor.rb

@@ -1,6 +1,8 @@
-require 'hanami/utils/basic_object'
-require 'hanami/utils/class_attribute'
-require 'hanami/utils/hash'
+# frozen_string_literal: true
+
+require "hanami/utils/basic_object"
+require "hanami/utils/class_attribute"
+require "hanami/utils/hash"
 
 module Hanami
   # Hanami Interactor
@@ -17,14 +19,14 @@ module Hanami
       # @api private
       #
       # @see Hanami::Interactor::Result#respond_to_missing?
-      METHODS = ::Hash[initialize:  true,
-                       success?:    true,
+      METHODS = ::Hash[initialize: true,
+                       success?: true,
                        successful?: true,
-                       failure?:    true,
-                       fail!:       true,
-                       prepare!:    true,
-                       errors:      true,
-                       error:       true].freeze
+                       failure?: true,
+                       fail!: true,
+                       prepare!: true,
+                       errors: true,
+                       error: true].freeze
 
       # Initialize a new result
       #
@@ -40,7 +42,7 @@ module Hanami
         @success = true
       end
 
-      # Check if the current status is successful
+      # Checks if the current status is successful
       #
       # @return [TrueClass,FalseClass] the result of the check
       #
@@ -50,9 +52,9 @@ module Hanami
       end
 
       # @since 0.3.5
-      alias success? successful?
+      alias_method :success?, :successful?
 
-      # Check if the current status is not successful
+      # Checks if the current status is not successful
       #
       # @return [TrueClass,FalseClass] the result of the check
       #
@@ -61,7 +63,7 @@ module Hanami
         !successful?
       end
 
-      # Force the status to be a failure
+      # Forces the status to be a failure
       #
       # @since 0.3.5
       def fail!
@@ -104,7 +106,7 @@ module Hanami
         errors.first
       end
 
-      # Prepare the result before to be returned
+      # Prepares the result before to be returned
       #
       # @param payload [Hash] an updated payload
       #
@@ -351,33 +353,57 @@ module Hanami
       #   end
       #
       #   Signup.new.call # => NoMethodError
-      def call(*args)
-        @__result = ::Hanami::Interactor::Result.new
-        _call(*args) { super }
+      if RUBY_VERSION >= "3.0"
+        def call(*args, **kwargs)
+          @__result = ::Hanami::Interactor::Result.new
+          _call(*args, **kwargs) { super }
+        end
+      else
+        def call(*args)
+          @__result = ::Hanami::Interactor::Result.new
+          _call(*args) { super }
+        end
       end
 
       private
 
       # @api private
       # @since 1.1.0
-      def _call(*args)
-        catch :fail do
-          validate!(*args)
-          yield
+      if RUBY_VERSION >= "3.0"
+        def _call(*args, **kwargs)
+          catch :fail do
+            validate!(*args, **kwargs)
+            yield
+          end
+
+          _prepare!
         end
+      else
+        def _call(*args)
+          catch :fail do
+            validate!(*args)
+            yield
+          end
 
-        _prepare!
+          _prepare!
+        end
       end
 
       # @since 1.1.0
-      def validate!(*args)
-        fail! unless valid?(*args)
+      if RUBY_VERSION >= "3.0"
+        def validate!(*args, **kwargs)
+          fail! unless valid?(*args, **kwargs)
+        end
+      else
+        def validate!(*args)
+          fail! unless valid?(*args)
+        end
       end
     end
 
     private
 
-    # Check if proceed with <tt>#call</tt> invokation.
+    # Checks if proceed with <tt>#call</tt> invocation.
     # By default it returns <tt>true</tt>.
     #
     # Developers can override it.
@@ -389,7 +415,7 @@ module Hanami
       true
     end
 
-    # Fail and interrupt the current flow.
+    # Fails and interrupts the current flow.
     #
     # @since 0.3.5
     #
@@ -428,7 +454,7 @@ module Hanami
       throw :fail
     end
 
-    # Log an error without interrupting the flow.
+    # Logs an error without interrupting the flow.
     #
     # When used, the returned result won't be successful.
     #
@@ -483,7 +509,7 @@ module Hanami
       false
     end
 
-    # Log an error AND interrupting the flow.
+    # Logs an error and interrupts the flow.
     #
     # When used, the returned result won't be successful.
     #
@@ -579,7 +605,7 @@ module Hanami
       end
     end
 
-    # Expose local instance variables into the returning value of <tt>#call</tt>
+    # Exposes local instance variables into the returning value of <tt>#call</tt>
     #
     # @param instance_variable_names [Symbol,Array<Symbol>] one or more instance
     #   variable names
@@ -588,7 +614,7 @@ module Hanami
     #
     # @see Hanami::Interactor::Result
     #
-    # @example Expose instance variable
+    # @example Exposes instance variable
     #
     #   class Signup
     #     include Hanami::Interactor

data/lib/hanami/logger.rb

@@ -7,7 +7,7 @@ require "hanami/utils/files"
 module Hanami
   # Hanami logger
   #
-  # Implement with the same interface of Ruby std lib `Logger`.
+  # Implementation with the same interface of Ruby std lib `Logger`.
   # It uses `STDOUT`, `STDERR`, file name or open file as output stream.
   #
   #
@@ -16,7 +16,7 @@ module Hanami
   #
   # This is useful for auto-tagging the output. Eg (`app=Booshelf`).
   #
-  # When used stand alone (eg. `Hanami::Logger.info`), it tags lines with `app=Shared`.
+  # When used standalone (eg. `Hanami::Logger.info`), it tags lines with `app=Shared`.
   #
   #
   # The available severity levels are the same of `Logger`:
@@ -30,7 +30,7 @@ module Hanami
   #
   # Those levels are available both as class and instance methods.
   #
-  # Also Hanami::Logger support different formatters. Now available only two:
+  # Also Hanami::Logger supports different formatters. Now available only two:
   #
   #   * Formatter (default)
   #   * JSONFormatter
@@ -132,11 +132,11 @@ module Hanami
     # @since 0.8.0
     # @api private
     LEVELS = ::Hash[
-      "debug"   => DEBUG,
-      "info"    => INFO,
-      "warn"    => WARN,
-      "error"   => ERROR,
-      "fatal"   => FATAL,
+      "debug" => DEBUG,
+      "info" => INFO,
+      "warn" => WARN,
+      "error" => ERROR,
+      "fatal" => FATAL,
       "unknown" => UNKNOWN
     ].freeze
 
@@ -279,9 +279,9 @@ module Hanami
     #   logger.info "Hello World"
     #
     #   # => {"app":"Hanami","severity":"DEBUG","time":"2017-03-30T13:57:59Z","message":"Hello World"}
-    # rubocop:disable Lint/HandleExceptions
+    # rubocop:disable Lint/SuppressedException
     # rubocop:disable Metrics/ParameterLists
-    def initialize(application_name = nil, *args, stream: $stdout, level: DEBUG, formatter: nil, filter: [], colorizer: nil)
+    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
@@ -296,7 +296,7 @@ module Hanami
     end
 
     # rubocop:enable Metrics/ParameterLists
-    # rubocop:enable Lint/HandleExceptions
+    # rubocop:enable Lint/SuppressedException
 
     # Returns the current application name, this is used for tagging purposes
     #
@@ -313,7 +313,7 @@ module Hanami
       super _level(value)
     end
 
-    # Close the logging stream if this stream isn't an STDOUT
+    # Closes the logging stream if this stream isn't an STDOUT
     #
     # @since 0.8.0
     def close

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)
@@ -42,7 +63,7 @@ module Hanami
       # @api private
       def _key_paths(hash, base = nil)
         hash.inject([]) do |results, (k, v)|
-          results + (v.respond_to?(:each) ? _key_paths(v, _build_path(base, k)) : [_build_path(base, k)])
+          results + (_key_paths?(v) ? _key_paths(v, _build_path(base, k)) : [_build_path(base, k)])
         end
       end
 
@@ -63,6 +84,64 @@ module Hanami
           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.map do |key, value|
+          [
+            key,
+            if value.is_a?(Hash)
+              _deep_dup(value)
+            else
+              _key_paths?(value) ? value.dup : value
+            end
+          ]
+        end.to_h
+      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