hanami-utils 1.3.7 → 2.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02818d90409ea03d89ca587c97fe418bbf17a8694662a2313609c0710466b0f9'
-  data.tar.gz: 973ef420992dd9ea30ab880d43e8cc70eee59cae6fb7b1ba17038c5ce8d536a4
+  metadata.gz: 2d4523d52299280469a80451592c55d5771aeaf8e0f93644291f5e9d7a66237a
+  data.tar.gz: 27c144da73fcbd992b4fefdddb9dc1b5be1e58b5abff3fd4078c67f8ec561d43
 SHA512:
-  metadata.gz: d49d6ad21aa25f285c9165c4619d6b2d7fe348513481bf30b8f231211d4e270f7502e2e3594f082789fdf32e9170a33e038329394ae5f43170ab778ebe01892f
-  data.tar.gz: 8b8832a39855525d6818de385212fb1c9d7c5c0f79874f60ead95ee1c592377f6bfec0ade5701a4340b87fe920c495889a9586d81fe2091d8691b52b14f297fa
+  metadata.gz: e0e48686597a78927e05bff5da29e0ba0db65f8a03796b36046bb6f84cf35bf964662a87a73bad88bca47096b2b51e737bee0b0545f7341cbbd3579c4e74d4bf
+  data.tar.gz: ebf2deed3ccf571a88ffd151d544254d483f65f26c5bf027c78cbe31220b22afc6b0c9f5b7a6223dd685c553b41fb80c2fe4a7b2a3629d4ab1cdfc5f9293e038

data/CHANGELOG.md

@@ -1,37 +1,22 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
-## v1.3.7 - 2021-01-04
+## v2.0.0.alpha1 - 2019-01-30
 ### Added
-- [Luca Guidi] Official support for Ruby: MRI 3.0
-- [Khai Le] Allow `Hanami::Logger` to filter sensitive data for an array of hashes
+- [Gustavo Caso] Introduce `Hanami::Middleware` namespace
+- [Luca Guidi] Introduce `Callbacks::Chain#dup`
 
-### 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`
+### Changed
+- [Luca Guidi] Drop support for Ruby: MRI 2.3, and 2.4.
+- [Luca Guidi] Remove `Utils::Duplicable`
+- [Luca Guidi] Remove `Utils::Inflector`
+- [Luca Guidi] Remove `Utils::String.singularize`, and `.pluralize`
+- [Luca Guidi] Remove `Utils::String#singularize`, and `#pluralize`
+- [Luca Guidi] Remove instance level interface for `Utils::Hash`
+- [Luca Guidi] Transform `Utils::Hash` from class to module
+- [Luca Guidi] Remove `Utils.reload!`
+- [Gustavo Caso] Remove `Utils::File.rewrite`
+- [Vladimir Suvorov] Remove `Utils::Class.load_from_pattern!`
 
 ## v1.3.1 - 2019-01-18
 ### Added

data/README.md

@@ -5,7 +5,8 @@ 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)
-[![CI](https://github.com/hanami/utils/workflows/ci/badge.svg?branch=master)](https://github.com/hanami/utils/actions?query=workflow%3Aci+branch%3Amaster)
+[![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)
 [![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)
@@ -21,7 +22,7 @@ Ruby core extensions and class utilities for [Hanami](http://hanamirb.org)
 
 ## Rubies
 
-__Hanami::Utils__ supports Ruby (MRI) 2.3+, JRuby 9.1.5.0+
+__Hanami::Utils__ supports Ruby (MRI) 2.5+
 
 ## Installation
 
@@ -78,11 +79,6 @@ Inheritable class attributes. [[API doc](http://www.rubydoc.info/gems/hanami-uti
 
 Deprecate Hanami features. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Deprecation)]
 
-### Hanami::Utils::Duplicable
-
-Safe `#dup` logic for Ruby objects. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Duplicable)]
-
-
 ### Hanami::Utils::Escape
 
 Safe and fast escape for URLs, HTML content and attributes. Based on OWASP/ESAPI code. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Escape)]
@@ -97,16 +93,12 @@ File utilities to manipulate files and directories. [[API doc](http://www.rubydo
 
 ### Hanami::Utils::Hash
 
-Enhanced version of Ruby's `Hash`. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Hash)]
+`Hash` transformations. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Hash)]
 
 ### Hanami::Utils::IO
 
 Silence Ruby warnings. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/IO)]
 
-### Hanami::Utils::Inflector
-
-Complete and customizable english inflections (pluralization and singularization). [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Inflector)]
-
 ### Hanami::Utils::Json
 
 JSON engine with swappable backends (via optional `multi_json` gem) or powered by Ruby's `json` (default). [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Json)]
@@ -149,6 +141,6 @@ __Hanami::Utils__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2021 Luca Guidi – Released under MIT License
+Copyright © 2014-2019 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-utils`).

data/hanami-utils.gemspec

@@ -18,13 +18,12 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = ">= 2.5.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",    "~> 13"
-  spec.add_development_dependency "rspec",   "~> 3.9"
-  spec.add_development_dependency "rubocop", "0.81" # rubocop 0.81+ removed support for Ruby 2.3
+  spec.add_development_dependency "rake",    "~> 12"
+  spec.add_development_dependency "rspec",   "~> 3.7"
 end

data/lib/hanami/interactor.rb

@@ -19,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
       #
@@ -42,7 +42,7 @@ module Hanami
         @success = true
       end
 
-      # Checks if the current status is successful
+      # Check if the current status is successful
       #
       # @return [TrueClass,FalseClass] the result of the check
       #
@@ -52,9 +52,9 @@ module Hanami
       end
 
       # @since 0.3.5
-      alias_method :success?, :successful?
+      alias success? successful?
 
-      # Checks if the current status is not successful
+      # Check if the current status is not successful
       #
       # @return [TrueClass,FalseClass] the result of the check
       #
@@ -63,7 +63,7 @@ module Hanami
         !successful?
       end
 
-      # Forces the status to be a failure
+      # Force the status to be a failure
       #
       # @since 0.3.5
       def fail!
@@ -106,7 +106,7 @@ module Hanami
         errors.first
       end
 
-      # Prepares the result before to be returned
+      # Prepare the result before to be returned
       #
       # @param payload [Hash] an updated payload
       #
@@ -353,57 +353,33 @@ module Hanami
       #   end
       #
       #   Signup.new.call # => NoMethodError
-      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
+      def call(*args)
+        @__result = ::Hanami::Interactor::Result.new
+        _call(*args) { super }
       end
 
       private
 
       # @api private
       # @since 1.1.0
-      if RUBY_VERSION >= "3.0"
-        def _call(*args, **kwargs)
-          catch :fail do
-            validate!(*args, **kwargs)
-            yield
-          end
-
-          _prepare!
+      def _call(*args)
+        catch :fail do
+          validate!(*args)
+          yield
         end
-      else
-        def _call(*args)
-          catch :fail do
-            validate!(*args)
-            yield
-          end
 
-          _prepare!
-        end
+        _prepare!
       end
 
       # @since 1.1.0
-      if RUBY_VERSION >= "3.0"
-        def validate!(*args, **kwargs)
-          fail! unless valid?(*args, **kwargs)
-        end
-      else
-        def validate!(*args)
-          fail! unless valid?(*args)
-        end
+      def validate!(*args)
+        fail! unless valid?(*args)
       end
     end
 
     private
 
-    # Checks if proceed with <tt>#call</tt> invocation.
+    # Check if proceed with <tt>#call</tt> invokation.
     # By default it returns <tt>true</tt>.
     #
     # Developers can override it.
@@ -415,7 +391,7 @@ module Hanami
       true
     end
 
-    # Fails and interrupts the current flow.
+    # Fail and interrupt the current flow.
     #
     # @since 0.3.5
     #
@@ -454,7 +430,7 @@ module Hanami
       throw :fail
     end
 
-    # Logs an error without interrupting the flow.
+    # Log an error without interrupting the flow.
     #
     # When used, the returned result won't be successful.
     #
@@ -509,7 +485,7 @@ module Hanami
       false
     end
 
-    # Logs an error and interrupts the flow.
+    # Log an error AND interrupting the flow.
     #
     # When used, the returned result won't be successful.
     #
@@ -572,7 +548,7 @@ module Hanami
     # @since 0.5.0
     # @api private
     def _exposures
-      Hash[].tap do |result|
+      ::Hash[].tap do |result|
         self.class.exposures.each do |name, ivar|
           result[name] = instance_variable_defined?(ivar) ? instance_variable_get(ivar) : nil
         end
@@ -605,7 +581,7 @@ module Hanami
       end
     end
 
-    # Exposes local instance variables into the returning value of <tt>#call</tt>
+    # Expose local instance variables into the returning value of <tt>#call</tt>
     #
     # @param instance_variable_names [Symbol,Array<Symbol>] one or more instance
     #   variable names
@@ -614,7 +590,7 @@ module Hanami
     #
     # @see Hanami::Interactor::Result
     #
-    # @example Exposes instance variable
+    # @example Expose instance variable
     #
     #   class Signup
     #     include Hanami::Interactor

data/lib/hanami/logger.rb

@@ -7,7 +7,7 @@ require "hanami/utils/files"
 module Hanami
   # Hanami logger
   #
-  # Implementation with the same interface of Ruby std lib `Logger`.
+  # Implement 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 standalone (eg. `Hanami::Logger.info`), it tags lines with `app=Shared`.
+  # When used stand alone (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 supports different formatters. Now available only two:
+  # Also Hanami::Logger support 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/SuppressedException
+    # rubocop:disable Lint/HandleExceptions
     # rubocop:disable Metrics/ParameterLists
-    def initialize(application_name = nil, *args, stream: $stdout, level: DEBUG, formatter: nil, filter: [], colorizer: nil) # rubocop:disable Layout/LineLength
+    def initialize(application_name = nil, *args, stream: $stdout, level: DEBUG, formatter: nil, filter: [], colorizer: nil)
       begin
         Utils::Files.mkdir_p(stream)
       rescue TypeError
@@ -296,7 +296,7 @@ module Hanami
     end
 
     # rubocop:enable Metrics/ParameterLists
-    # rubocop:enable Lint/SuppressedException
+    # rubocop:enable Lint/HandleExceptions
 
     # Returns the current application name, this is used for tagging purposes
     #
@@ -313,7 +313,7 @@ module Hanami
       super _level(value)
     end
 
-    # Closes the logging stream if this stream isn't an STDOUT
+    # Close 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,19 +9,21 @@ module Hanami
     # @since 1.1.0
     # @api private
     class Filter
-      # @since 1.3.7
+      # @since 1.1.0
       # @api private
-      FILTERED_VALUE = "[FILTERED]"
-
-      def initialize(filters = [], mask: FILTERED_VALUE)
+      def initialize(filters = [])
         @filters = filters
-        @mask = mask
       end
 
       # @since 1.1.0
       # @api private
-      def call(params)
-        _filter(_copy_params(params))
+      def call(hash)
+        _filtered_keys(hash).each do |key|
+          *keys, last = _actual_keys(hash, key.split("."))
+          keys.inject(hash, :fetch)[last] = "[FILTERED]"
+        end
+
+        hash
       end
 
       private
@@ -30,29 +32,6 @@ 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)
@@ -63,7 +42,7 @@ module Hanami
       # @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)])
+          results + (v.respond_to?(:each) ? _key_paths(v, _build_path(base, k)) : [_build_path(base, k)])
         end
       end
 
@@ -84,64 +63,6 @@ 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