hanami-utils 1.3.6 → 2.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e6573938b28f1b4f3b8f46aebec53e487d0af4e85087a65d5e081c4fdc2f030
-  data.tar.gz: e2d13a7d2a675633a7b984882d7c01c5963b3933f1d9339b871ed20838b630c9
+  metadata.gz: 2d4523d52299280469a80451592c55d5771aeaf8e0f93644291f5e9d7a66237a
+  data.tar.gz: 27c144da73fcbd992b4fefdddb9dc1b5be1e58b5abff3fd4078c67f8ec561d43
 SHA512:
-  metadata.gz: f8255168597fd310d075400c0a926b28f7bea6dd2025b1572d065e8df7e7ecfa76f991dc88afa1be37b3dfa57b06e70332015018e724ad7731184329a1cab559
-  data.tar.gz: 4ff3e862379db3b02d1fecace8336ed0f44df2b98c9588f807f46883b3b0e7a862beac8119da7428b07484802842b09aca509e1d01ee9dc25360438847d94f63
+  metadata.gz: e0e48686597a78927e05bff5da29e0ba0db65f8a03796b36046bb6f84cf35bf964662a87a73bad88bca47096b2b51e737bee0b0545f7341cbbd3579c4e74d4bf
+  data.tar.gz: ebf2deed3ccf571a88ffd151d544254d483f65f26c5bf027c78cbe31220b22afc6b0c9f5b7a6223dd685c553b41fb80c2fe4a7b2a3629d4ab1cdfc5f9293e038

data/CHANGELOG.md

@@ -1,29 +1,22 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
-## v1.3.6 - 2020-01-07
+## v2.0.0.alpha1 - 2019-01-30
 ### Added
-- [Luca Guidi] Official support for Ruby: MRI 2.7
+- [Gustavo Caso] Introduce `Hanami::Middleware` namespace
+- [Luca Guidi] Introduce `Callbacks::Chain#dup`
 
-### 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,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)
-[![Build Status](https://ci.hanamirb.org/api/badges/hanami/utils/status.svg)](https://ci.hanamirb.org/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)
 [![Depfu](https://badges.depfu.com/badges/a8545fb67cf32a2c75b6227bc0821027/overview.svg)](https://depfu.com/github/hanami/utils?project=Bundler)
@@ -22,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
 
@@ -79,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)]
@@ -98,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)]
@@ -150,6 +141,6 @@ __Hanami::Utils__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2017 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

@@ -1,27 +1,29 @@
-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.5.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',    '~> 13'
-  spec.add_development_dependency 'rspec',   '~> 3.7'
+  spec.add_development_dependency "bundler", ">= 1.6", "< 3"
+  spec.add_development_dependency "rake",    "~> 12"
+  spec.add_development_dependency "rspec",   "~> 3.7"
 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
@@ -40,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,7 +54,7 @@ module Hanami
       # @since 0.3.5
       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
       #
@@ -61,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!
@@ -104,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
       #
@@ -377,7 +379,7 @@ module Hanami
 
     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.
@@ -389,7 +391,7 @@ module Hanami
       true
     end
 
-    # Fails and interrupts the current flow.
+    # Fail and interrupt the current flow.
     #
     # @since 0.3.5
     #
@@ -428,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.
     #
@@ -483,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.
     #
@@ -546,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
@@ -579,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
@@ -588,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
@@ -279,7 +279,7 @@ 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)
       begin
@@ -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/filter.rb

@@ -42,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
 
@@ -63,17 +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
     end
   end
 end

data/lib/hanami/logger/formatter.rb

@@ -105,16 +105,16 @@ module Hanami
       # @api private
       def _message_hash(message) # rubocop:disable Metrics/MethodLength
         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/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] info whether the VM is JRuby or not
+    # @return [TrueClass,FalseClass] return if 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] info whether the VM is Rubinius or not
+    # @return [TrueClass,FalseClass] return if the VM is Rubinius or not
     #
     # @since 0.3.1
     # @api private
@@ -39,7 +41,7 @@ module Hanami
       RUBY_ENGINE == HANAMI_RUBINIUS
     end
 
-    # Recursively requires Ruby files under the given directory.
+    # Recursively require 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 reloads 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.
     #
@@ -87,7 +73,7 @@ module Hanami
     def self.for_each_file_in(directory, &blk)
       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