hanami-utils 1.3.7 → 2.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02818d90409ea03d89ca587c97fe418bbf17a8694662a2313609c0710466b0f9'
-  data.tar.gz: 973ef420992dd9ea30ab880d43e8cc70eee59cae6fb7b1ba17038c5ce8d536a4
+  metadata.gz: a34d2521940dfea9fb6d12a6cf65022aa340567e741801e3740d06e0e620d1f3
+  data.tar.gz: d7396f0786283c15a398e41a1c3b62659be3d786b2df295733bca55253cb7def
 SHA512:
-  metadata.gz: d49d6ad21aa25f285c9165c4619d6b2d7fe348513481bf30b8f231211d4e270f7502e2e3594f082789fdf32e9170a33e038329394ae5f43170ab778ebe01892f
-  data.tar.gz: 8b8832a39855525d6818de385212fb1c9d7c5c0f79874f60ead95ee1c592377f6bfec0ade5701a4340b87fe920c495889a9586d81fe2091d8691b52b14f297fa
+  metadata.gz: 15f71cb5b8f88f6bb0ac02dce471120115923d8dff3676a5ed12860bc743d7d20ce9e6ad8ef5a29e233f63dbe5299510757c0f25b25d75c6818e8e72d9f7407c
+  data.tar.gz: 85d58a5238393e7647a3b5dac295182619ae7f583c96d53c2928a8f79d3cee8cb0a5a7e306fc7e8705b884b76cb305e37e55afa3a9b9bb1122b049fb6776400a

data/CHANGELOG.md

@@ -1,6 +1,35 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v2.0.0.alpha3 - 2021-11-09
+No changes.
+
+## 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
@@ -179,7 +208,7 @@ Ruby core extentions and class utilities for Hanami
 - [Grachev Mikhail] Introduced `Hanami::Interactor::Result#failure?`
 
 ### Fixed
-- [Paweł Świątkowski] `Utils::Inflector.pluralize` Pluralize -en to -ens instead of -ina 
+- [Paweł Świątkowski] `Utils::Inflector.pluralize` Pluralize -en to -ens instead of -ina
 
 ### Changed
 - [Grachev Mikhail] Deprecate `Hanami::Interactor::Result#failing?` in favor of `#failure?`
@@ -199,7 +228,7 @@ Ruby core extentions and class utilities for Hanami
 ### Added
 – [Luca Guidi] Introduced `Utils.require!` to recursively require Ruby files with an order that is consistent across platforms
 – [Luca Guidi] Introduced `Utils::FileList` as cross-platform ordered list of files, alternative to `Dir.glob`
-- [Luca Guidi] Make `Utils::BasicObject` pretty printable 
+- [Luca Guidi] Make `Utils::BasicObject` pretty printable
 - [Grachev Mikhail] Added `Interactor::Result#successful?` and `#failing?`
 
 ### Fixed
@@ -403,7 +432,7 @@ Ruby core extentions and class utilities for Hanami
 ## v0.1.0 - 2014-01-23
 ### Added
 - [Luca Guidi] Introduced `Lotus::Utils::String#demodulize`
-- [Luca Guidi] Introduced `Lotus::Utils::IO.silence_warnings` 
+- [Luca Guidi] Introduced `Lotus::Utils::IO.silence_warnings`
 - [Luca Guidi] Introduced class loading mechanism from a string: `Utils::Class.load!`
 - [Luca Guidi] Introduced callbacks support for classes
 - [Luca Guidi] Introduced inheritable class level attributes

data/README.md

@@ -5,11 +5,16 @@ 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)
-[![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=main)](https://github.com/hanami/utils/actions?query=workflow%3Aci+branch%3Amain)
+[![Test Coverage](https://codecov.io/gh/hanami/utils/branch/main/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)
 
+
+## Version
+
+**This branch contains the code for `hanami-utils` 2.x.**
+
 ## Contact
 
 * Home page: http://hanamirb.org
@@ -21,7 +26,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
 
@@ -78,11 +83,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 +97,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)]

data/hanami-utils.gemspec

@@ -18,13 +18,13 @@ 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.6.0"
 
-  spec.add_dependency "transproc",       "~> 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.9"
-  spec.add_development_dependency "rubocop", "0.81" # rubocop 0.81+ removed support for Ruby 2.3
+  spec.add_development_dependency "rubocop", "0.91"
 end

data/lib/hanami/interactor.rb

@@ -181,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.
@@ -572,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

data/lib/hanami/logger/filter.rb

@@ -99,16 +99,13 @@ module Hanami
       # @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
+        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

data/lib/hanami/logger/formatter.rb

@@ -105,16 +105,16 @@ module Hanami
       # @api private
       def _message_hash(message)
         case message
-        when Hash
+        when ::Hash
           @filter.call(message)
         when Exception
-          Hash[
+          ::Hash[
             message: message.message,
             backtrace: message.backtrace || [],
             error: message.class
           ]
         else
-          Hash[message: message]
+          ::Hash[message: message]
         end
       end
 

data/lib/hanami/logger.rb

@@ -317,7 +317,7 @@ module Hanami
     #
     # @since 0.8.0
     def close
-      super unless [STDOUT, $stdout].include?(@stream)
+      super unless [STDOUT, $stdout].include?(@stream) # rubocop:disable Style/GlobalStdStream
     end
 
     private

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/blank.rb

@@ -21,7 +21,6 @@ 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
       #
@@ -34,8 +33,8 @@ module Hanami
       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
@@ -56,7 +55,6 @@ 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
       #

data/lib/hanami/utils/callbacks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "concurrent/array"
+
 module Hanami
   module Utils
     # Before and After callbacks
@@ -18,7 +20,7 @@ module Hanami
         #
         # @since 0.2.0
         def initialize
-          @chain = []
+          @chain = Concurrent::Array.new
         end
 
         # Appends the given callbacks to the end of the chain.
@@ -150,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
@@ -170,6 +183,10 @@ module Hanami
           @chain.freeze
         end
 
+        protected
+
+        attr_reader :chain
+
         private
 
         # @api private

data/lib/hanami/utils/class.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "hanami/utils/deprecation"
-
 module Hanami
   module Utils
     # Class utilities
@@ -74,57 +72,6 @@ module Hanami
         load!(name, namespace) if namespace.const_defined?(name.to_s, false)
       end
 
-      # Loads a class from the given pattern name and namespace
-      #
-      # @param pattern [String] the class name pattern
-      # @param namespace [Class, Module] the Ruby namespace where we want to perform the lookup.
-      # @return [Class, Module] the found Ruby constant.
-      #
-      # @raise [NameError] if no constant can be found.
-      #
-      # @since 0.3.1
-      #
-      # @see Hanami::Utils::String#tokenize
-      #
-      # @example
-      #   require 'hanami/utils/class'
-      #
-      #   module App
-      #     module Service
-      #       class Endpoint
-      #       end
-      #     end
-      #
-      #     class ServiceEndpoint
-      #     end
-      #   end
-      #
-      #   # basic usage
-      #   Hanami::Utils::Class.load_from_pattern!('App::Service') # => App::Service
-      #
-      #   # with explicit namespace
-      #   Hanami::Utils::Class.load_from_pattern!('Service', App) # => App::Service
-      #
-      #   # with pattern
-      #   Hanami::Utils::Class.load_from_pattern!('App::Service(::Endpoint|Endpoint)') # => App::Service::Endpoint
-      #   Hanami::Utils::Class.load_from_pattern!('App::Service(Endpoint|::Endpoint)') # => App::ServiceEndpoint
-      #
-      #   # with missing constant
-      #   Hanami::Utils::Class.load_from_pattern!('Unknown') # => raises NameError
-      def self.load_from_pattern!(pattern, namespace = Object)
-        Deprecation.new("Hanami::Utils::Class.load_from_pattern! is deprecated, please use Hanami::Utils::Class.load! instead") # rubocop:disable Layout/LineLength
-
-        tokenize(pattern) do |token|
-          begin
-            return namespace.const_get(token, false)
-          rescue NameError # rubocop:disable Lint/SuppressedException
-          end
-        end
-
-        full_name = [(namespace == Object ? nil : namespace), pattern].compact.join("::")
-        raise NameError.new("uninitialized constant #{full_name}")
-      end
-
       def self.tokenize(pattern)
         if match = TOKENIZE_REGEXP.match(pattern)
           pre  = match.pre_match

data/lib/hanami/utils/class_attribute/attributes.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "concurrent/map"
+
+module Hanami
+  module Utils
+    module ClassAttribute
+      # Class attributes set
+      #
+      # @since 2.0.0
+      # @api private
+      class Attributes
+        # @since 2.0.0
+        # @api private
+        def initialize(attributes: Concurrent::Map.new)
+          @attributes = attributes
+        end
+
+        # @since 2.0.0
+        # @api private
+        def []=(key, value)
+          @attributes[key.to_sym] = value
+        end
+
+        # @since 2.0.0
+        # @api private
+        def [](key)
+          @attributes.fetch(key, nil)
+        end
+
+        # @since 2.0.0
+        # @api private
+        def dup
+          attributes = Concurrent::Map.new.tap do |attrs|
+            @attributes.each do |key, value|
+              attrs[key.to_sym] = value.dup
+            end
+          end
+
+          self.class.new(attributes: attributes)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/utils/class_attribute.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-require "hanami/utils/duplicable"
-
 module Hanami
   module Utils
     # Inheritable class level variable accessors.
@@ -10,6 +7,8 @@ module Hanami
     #
     # @see Hanami::Utils::ClassAttribute::ClassMethods
     module ClassAttribute
+      require "hanami/utils/class_attribute/attributes"
+
       # @api private
       def self.included(base)
         base.extend ClassMethods
@@ -18,6 +17,12 @@ module Hanami
       # @since 0.1.0
       # @api private
       module ClassMethods
+        def self.extended(base)
+          base.class_eval do
+            @__class_attributes = Attributes.new unless defined?(@__class_attributes)
+          end
+        end
+
         # Defines a class level accessor for the given attribute(s).
         #
         # A value set for a superclass is automatically available by their
@@ -68,11 +73,17 @@ module Hanami
         #   SmallAirplane.engines # => 2
         #   SmallAirplane.wheels  # => 8
         def class_attribute(*attributes)
-          singleton_class.class_eval do
-            attr_accessor(*attributes)
-          end
+          attributes.each do |attr|
+            singleton_class.class_eval %(
+              def #{attr}
+                class_attributes[:#{attr}]
+              end
 
-          class_attributes.merge(attributes)
+              def #{attr}=(value)
+                class_attributes[:#{attr}] = value
+              end
+            ), __FILE__, __LINE__ - 8
+          end
         end
 
         protected
@@ -80,11 +91,9 @@ module Hanami
         # @see Class#inherited
         # @api private
         def inherited(subclass)
-          class_attributes.each do |attr|
-            value = send(attr)
-            value = Duplicable.dup(value)
-            subclass.class_attribute attr
-            subclass.send("#{attr}=", value)
+          ca = class_attributes.dup
+          subclass.class_eval do
+            @__class_attributes = ca
           end
 
           super
@@ -95,7 +104,7 @@ module Hanami
         # Class accessor for class attributes.
         # @api private
         def class_attributes
-          @class_attributes ||= Set.new
+          @__class_attributes
         end
       end
     end

data/lib/hanami/utils/file_list.rb

@@ -14,8 +14,28 @@ module Hanami
       # @since 0.9.0
       #
       # @see https://ruby-doc.org/core/Dir.html#method-c-glob
+      #
+      # @example simple usage
+      #   require "hanami/utils/file_list"
+      #
+      #   Hanami::Utils::FileList["spec/support/fixtures/file_list/*.rb"]
+      #   # => [
+      #     "spec/support/fixtures/file_list/a.rb",
+      #     "spec/support/fixtures/file_list/aa.rb",
+      #     "spec/support/fixtures/file_list/ab.rb"
+      #   ]
+      #
+      # @example token usage
+      #   require "hanami/utils/file_list"
+      #
+      #   Hanami::Utils::FileList["spec", "support", "fixtures", "file_list", "*.rb"]
+      #   # => [
+      #     "spec/support/fixtures/file_list/a.rb",
+      #     "spec/support/fixtures/file_list/aa.rb",
+      #     "spec/support/fixtures/file_list/ab.rb"
+      #   ]
       def self.[](*args)
-        Dir.glob(*args).sort!
+        Dir.glob(::File.join(*args)).sort!
       end
     end
   end

data/lib/hanami/utils/files.rb

@@ -34,24 +34,6 @@ module Hanami
         open(path, ::File::CREAT | ::File::WRONLY | ::File::TRUNC, *content) # rubocop:disable Security/Open - this isn't a call to `::Kernel.open`, but to `self.open`
       end
 
-      # Rewrites the contents of an existing file.
-      # If the path already exists, it replaces the contents.
-      #
-      # @param path [String,Pathname] the path to file
-      # @param content [String, Array<String>] the content to write
-      #
-      # @raise [Errno::ENOENT] if the path doesn't exist
-      #
-      # @since 1.1.0
-      def self.rewrite(path, *content)
-        Hanami::Utils::Deprecation.new(
-          "`.rewrite' is deprecated, please use `.write'"
-        )
-        raise Errno::ENOENT unless File.exist?(path)
-
-        write(path, *content)
-      end
-
       # Copies source into destination.
       # All the intermediate directories are created.
       # If the destination already exists, it overrides the contents.
@@ -331,8 +313,8 @@ module Hanami
         starting = index(content, path, target)
         line     = content[starting]
         size     = line[/\A[[:space:]]*/].bytesize
-        closing  = (" " * size) + (target =~ /{/ ? "}" : "end")
-        ending   = starting + index(content[starting..-1], path, closing)
+        closing  = (" " * size) + (/{/.match?(target) ? "}" : "end")
+        ending   = starting + index(content[starting..], path, closing)
 
         content.slice!(starting..ending)
         write(path, content)