hanami-utils 1.3.5 → 2.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4939f478fe78b3060ebf7f744977332a2dea527f84bcd4ba809cf2fc6b9c02d
-  data.tar.gz: 9b291ed5abecc39bd86da3605699b2770fa6f17f16d382802d3691ce4545bd42
+  metadata.gz: c8c15a181f268ff9117c181bfccc23c3fb63f31cbe38590f2d0b9f925e0fa9d1
+  data.tar.gz: bfdcc4baf599cd58adeb870ef700d705ec4cc58fdb58377f0028db177b3c431d
 SHA512:
-  metadata.gz: 39cc6955396c483181fb2ee9aa520fc862fe9a8a8e40bbe248302bda58053f71009ebe143a9d403f27da12236aa6d3e607876c3a5d29b8de97b8b7cbb4fb6e3b
-  data.tar.gz: b789c74a652f67bfa79c6dd349ee77d03af433850cd11e268abf3e1a9050da6bbab9227f48d1b6a61454f9e384662e0d7d8c400c7cf6c4734bf0430594d1a78a
+  metadata.gz: 3099871c8e61b12217e0c9d5d2a5668daddcaf8d439190c2fb1a356a2b92d02859a1f258ba8b7517b3be8b3685664be1dd68676ecb7ae5f7f809e3a5371d1182
+  data.tar.gz: 3a7b06f9f9c7eda2f716f9e0fc77a9e4a97f5a5e6e6137b7dd6eb1e77b4f57a48249a364ea6a35712753582de244bc81e7978ac4c95bde7b2d8c86566a07c3c5

data/CHANGELOG.md

@@ -1,6 +1,47 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v2.0.0.alpha2 - 2021-05-04
+### Changed
+- [Luca Guidi] Drop support for Ruby: MRI 2.5.
+- [Luca Guidi] Transform `Utils::String` from class to module
+
+## v2.0.0.alpha1 - 2019-01-30
+### Added
+- [Gustavo Caso] Introduce `Hanami::Middleware` namespace
+- [Luca Guidi] Introduce `Callbacks::Chain#dup`
+
+### 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.8 - 2021-05-03
+### Fixed
+- [Hiếu Nguyễn] Ensure `Hanami::Interactor#initialize` to accept keyword arguments while working with Ruby 3
+
+## 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

data/README.md

@@ -5,9 +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)
-[![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)
+[![CI](https://github.com/hanami/utils/workflows/ci/badge.svg?branch=unstable)](https://github.com/hanami/utils/actions?query=workflow%3Aci+branch%3Aunstable)
+[![Test Coverage](https://codecov.io/gh/hanami/utils/branch/unstable/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)
 
@@ -22,7 +21,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.6+
 
 ## Installation
 
@@ -79,11 +78,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)]
@@ -98,16 +92,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)]
@@ -150,6 +140,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.6.0"
 
-  spec.add_dependency 'transproc',       '~> 1.0'
-  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_dependency "dry-transformer", "~> 0.1"
+  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.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.91"
 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
       #
@@ -179,10 +181,18 @@ module Hanami
       #       # ...
       #     end
       #   end
-      def initialize(*args)
-        super
-      ensure
-        @__result = ::Hanami::Interactor::Result.new
+      if RUBY_VERSION >= "3.0"
+        def initialize(*args, **kwargs)
+          super
+        ensure
+          @__result = ::Hanami::Interactor::Result.new
+        end
+      else
+        def initialize(*args)
+          super
+        ensure
+          @__result = ::Hanami::Interactor::Result.new
+        end
       end
 
       # Triggers the operation and return a result.
@@ -351,33 +361,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 +423,7 @@ module Hanami
       true
     end
 
-    # Fail and interrupt the current flow.
+    # Fails and interrupts the current flow.
     #
     # @since 0.3.5
     #
@@ -428,7 +462,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 +517,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.
     #
@@ -546,7 +580,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
@@ -579,7 +613,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 +622,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,11 +313,11 @@ 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
-      super unless [STDOUT, $stdout].include?(@stream)
+      super unless [STDOUT, $stdout].include?(@stream) # rubocop:disable Style/GlobalStdStream
     end
 
     private