hanami-utils 1.3.2 → 1.3.7

data/lib/hanami/utils/io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Utils
     # IO utils

data/lib/hanami/utils/json.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 begin
-  require 'multi_json'
+  require "multi_json"
 rescue LoadError
-  require 'json'
+  require "json"
 end
 
 module Hanami
@@ -41,7 +43,7 @@ module Hanami
       end
       # rubocop:enable Style/ClassVars
 
-      # Parse the given JSON paylod
+      # Parses the given JSON paylod
       #
       # @param payload [String] a JSON payload
       #

data/lib/hanami/utils/kernel.rb

@@ -1,13 +1,15 @@
-require 'set'
-require 'date'
-require 'time'
-require 'pathname'
-require 'bigdecimal'
-require 'hanami/utils'
-require 'hanami/utils/string'
+# frozen_string_literal: true
+
+require "set"
+require "date"
+require "time"
+require "pathname"
+require "bigdecimal"
+require "hanami/utils"
+require "hanami/utils/string"
 
 unless defined?(Boolean)
-  # Define top level constant Boolean, so it can be easily used by other libraries
+  # Defines top level constant Boolean, so it can be easily used by other libraries
   # in coercions DSLs
   #
   # @since 0.3.0
@@ -30,7 +32,7 @@ module Hanami
 
       # @since 0.8.0
       # @api private
-      BOOLEAN_FALSE_STRING = '0'.freeze
+      BOOLEAN_FALSE_STRING = "0"
 
       # @since 0.8.0
       # @api private
@@ -325,7 +327,7 @@ module Hanami
       #   # big complex represented as a string
       #   input = Complex(2, 3)
       #   Hanami::Utils::Kernel.Integer(input) # => TypeError
-      def self.Integer(arg) # rubocop:disable Metrics/MethodLength
+      def self.Integer(arg)
         super(arg)
       rescue ArgumentError, TypeError, NoMethodError
         begin
@@ -416,7 +418,6 @@ module Hanami
       #   input = BasicObject.new
       #   Hanami::Utils::Kernel.BigDecimal(input) # => TypeError
       #
-      # rubocop:disable Metrics/MethodLength
       def self.BigDecimal(arg, precision = ::Float::DIG)
         case arg
         when NilClass # This is only needed by Ruby 2.6
@@ -433,7 +434,6 @@ module Hanami
       rescue NoMethodError
         raise TypeError.new "can't convert #{inspect_type_error(arg)}into BigDecimal"
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Coerces the argument to be a Float.
       #
@@ -547,7 +547,7 @@ module Hanami
       #   # big complex represented as a string
       #   input = Complex(2, 3)
       #   Hanami::Utils::Kernel.Float(input) # => TypeError
-      def self.Float(arg) # rubocop:disable Metrics/MethodLength
+      def self.Float(arg)
         super(arg)
       rescue ArgumentError, TypeError
         begin
@@ -736,7 +736,8 @@ module Hanami
       #   require 'hanami/utils/kernel'
       #
       #   Hanami::Utils::Kernel.DateTime(3483943)
-      #     # => Time.at(3483943).to_datetime #<DateTime: 1970-02-10T08:45:43+01:00 ((2440628j,27943s,0n),+3600s,2299161j)>
+      #     # => Time.at(3483943).to_datetime
+      #     # #<DateTime: 1970-02-10T08:45:43+01:00 ((2440628j,27943s,0n),+3600s,2299161j)>
       #
       #   Hanami::Utils::Kernel.DateTime(DateTime.now)
       #     # => #<DateTime: 2014-04-18T09:33:49+02:00 ((2456766j,27229s,690849000n),+7200s,2299161j)>
@@ -896,7 +897,7 @@ module Hanami
       #   # Missing #respond_to?
       #   input = BasicObject.new
       #   Hanami::Utils::Kernel.Boolean(input) # => TypeError
-      def self.Boolean(arg) # rubocop:disable Metrics/MethodLength
+      def self.Boolean(arg)
         case arg
         when Numeric
           arg.to_i == BOOLEAN_TRUE_INTEGER
@@ -1012,7 +1013,7 @@ module Hanami
       #   Hanami::Utils::Kernel.Symbol(input) # => TypeError
       def self.Symbol(arg)
         case arg
-        when '' then raise TypeError.new "can't convert #{inspect_type_error(arg)}into Symbol"
+        when "" then raise TypeError.new "can't convert #{inspect_type_error(arg)}into Symbol"
         when ->(a) { a.respond_to?(:to_sym) } then arg.to_sym
         else
           raise TypeError.new "can't convert #{inspect_type_error(arg)}into Symbol"
@@ -1021,7 +1022,7 @@ module Hanami
         raise TypeError.new "can't convert #{inspect_type_error(arg)}into Symbol"
       end
 
-      # Check if the given argument is a string representation of a number
+      # Checks if the given argument is a string representation of a number
       #
       # @param arg [Object] the input
       #
@@ -1042,11 +1043,11 @@ module Hanami
       # @since 0.4.3
       # @api private
       def self.inspect_type_error(arg)
-        (arg.respond_to?(:inspect) ? arg.inspect : arg.to_s) << ' '
+        (arg.respond_to?(:inspect) ? arg.inspect : arg.to_s) + " "
       rescue NoMethodError
         # missing the #respond_to? method, fall back to returning the class' name
         begin
-          arg.class.name << ' instance '
+          arg.class.name + " instance "
         rescue NoMethodError
           # missing the #class method, can't fall back to anything better than nothing
           # Callers will have to guess from their code
@@ -1055,7 +1056,7 @@ module Hanami
       end
 
       class << self
-        private :inspect_type_error # rubocop:disable Style/AccessModifierDeclarations
+        private :inspect_type_error
       end
     end
   end

data/lib/hanami/utils/load_paths.rb

@@ -1,4 +1,6 @@
-require 'hanami/utils/kernel'
+# frozen_string_literal: true
+
+require "hanami/utils/kernel"
 
 module Hanami
   module Utils
@@ -48,7 +50,7 @@ module Hanami
         @paths = original.instance_variable_get(:@paths).dup
       end
 
-      # Iterates thru the collection and yields the given block.
+      # Iterates through the collection and yields the given block.
       # It skips duplications and raises an error in case one of the paths
       # doesn't exist.
       #
@@ -115,7 +117,7 @@ module Hanami
         self
       end
 
-      alias << push
+      alias_method :<<, :push
 
       # It freezes the object by preventing further modifications.
       #
@@ -156,7 +158,7 @@ module Hanami
 
       private
 
-      # Allow subclasses to define their own policy to discover the realpath
+      # Allows subclasses to define their own policy to discover the realpath
       # of the given path.
       #
       # @since 0.2.0

data/lib/hanami/utils/path_prefix.rb

@@ -1,5 +1,7 @@
-require 'hanami/utils/string'
-require 'hanami/utils/kernel'
+# frozen_string_literal: true
+
+require "hanami/utils/string"
+require "hanami/utils/kernel"
 
 module Hanami
   module Utils
@@ -11,7 +13,7 @@ module Hanami
       #
       # @since 0.3.1
       # @api private
-      DEFAULT_SEPARATOR = '/'.freeze
+      DEFAULT_SEPARATOR = "/"
 
       # Initialize the path prefix
       #
@@ -133,7 +135,7 @@ module Hanami
       # @see #relative
       def relative!
         @string.gsub!(/(?<!:)#{separator * 2}/, separator)
-        @string[/\A#{separator}|^/] = ''
+        @string[/\A#{separator}|^/] = ""
 
         self
       end

data/lib/hanami/utils/query_string.rb

@@ -12,7 +12,7 @@ module Hanami
       # @api private
       HASH_SEPARATOR = ","
 
-      # Serialize input into a query string
+      # Serializes input into a query string
       #
       # @param input [Object] the input
       #

data/lib/hanami/utils/shell_color.rb

@@ -18,22 +18,22 @@ module Hanami
         end
       end
 
-      # Escape codes for terminals to output strings in colors
+      # Escapes codes for terminals to output strings in colors
       #
       # @since 1.2.0
       # @api private
       COLORS = ::Hash[
-        black:   30,
-        red:     31,
-        green:   32,
-        yellow:  33,
-        blue:    34,
+        black: 30,
+        red: 31,
+        green: 32,
+        yellow: 33,
+        blue: 34,
         magenta: 35,
-        cyan:    36,
-        gray:    37,
+        cyan: 36,
+        gray: 37,
       ].freeze
 
-      # Colorize output
+      # Colorizes output
       # 8 colors available: black, red, green, yellow, blue, magenta, cyan, and gray
       #
       # @param input [#to_s] the string to colorize

data/lib/hanami/utils/string.rb

@@ -1,30 +1,32 @@
-require 'hanami/utils/inflector'
-require 'transproc'
-require 'concurrent/map'
+# frozen_string_literal: true
+
+require "hanami/utils/inflector"
+require "transproc"
+require "concurrent/map"
 
 module Hanami
   module Utils
     # String on steroids
     #
     # @since 0.1.0
-    class String # rubocop:disable Metrics/ClassLength
+    class String
       # Empty string for #classify
       #
       # @since 0.6.0
       # @api private
-      EMPTY_STRING        = ''.freeze
+      EMPTY_STRING        = ""
 
       # Separator between Ruby namespaces
       #
       # @since 0.1.0
       # @api private
-      NAMESPACE_SEPARATOR = '::'.freeze
+      NAMESPACE_SEPARATOR = "::"
 
       # Separator for #classify
       #
       # @since 0.3.0
       # @api private
-      CLASSIFY_SEPARATOR  = '_'.freeze
+      CLASSIFY_SEPARATOR  = "_"
 
       # Regexp for #tokenize
       #
@@ -36,52 +38,53 @@ module Hanami
       #
       # @since 0.3.0
       # @api private
-      TOKENIZE_SEPARATOR  = '|'.freeze
+      TOKENIZE_SEPARATOR  = "|"
 
       # Separator for #underscore
       #
       # @since 0.3.0
       # @api private
-      UNDERSCORE_SEPARATOR = '/'.freeze
+      UNDERSCORE_SEPARATOR = "/"
 
       # gsub second parameter used in #underscore
       #
       # @since 0.3.0
       # @api private
-      UNDERSCORE_DIVISION_TARGET = '\1_\2'.freeze
+      UNDERSCORE_DIVISION_TARGET = '\1_\2'
 
       # Separator for #titleize
       #
       # @since 0.4.0
       # @api private
-      TITLEIZE_SEPARATOR = ' '.freeze
+      TITLEIZE_SEPARATOR = " "
 
       # Separator for #capitalize
       #
       # @since 0.5.2
       # @api private
-      CAPITALIZE_SEPARATOR = ' '.freeze
+      CAPITALIZE_SEPARATOR = " "
 
       # Separator for #dasherize
       #
       # @since 0.4.0
       # @api private
-      DASHERIZE_SEPARATOR = '-'.freeze
+      DASHERIZE_SEPARATOR = "-"
 
       # Regexp for #classify
       #
       # @since 0.3.4
       # @api private
-      CLASSIFY_WORD_SEPARATOR = /#{CLASSIFY_SEPARATOR}|#{NAMESPACE_SEPARATOR}|#{UNDERSCORE_SEPARATOR}|#{DASHERIZE_SEPARATOR}/.freeze
+      CLASSIFY_WORD_SEPARATOR = /#{CLASSIFY_SEPARATOR}|#{NAMESPACE_SEPARATOR}|#{UNDERSCORE_SEPARATOR}|#{DASHERIZE_SEPARATOR}/.freeze # rubocop:disable Layout/LineLength
 
       @__transformations__ = Concurrent::Map.new
 
       extend Transproc::Registry
       extend Transproc::Composer
 
-      # Apply the given transformation(s) to `input`
+      # Applies the given transformation(s) to `input`
       #
-      # It performs a pipeline of transformations, by applying the given functions from `Hanami::Utils::String` and `::String`.
+      # It performs a pipeline of transformations, by applying the given
+      # functions from `Hanami::Utils::String` and `::String`.
       # The transformations are applied in the given order.
       #
       # It doesn't mutate the input, unless you use destructive methods from `::String`
@@ -129,8 +132,6 @@ module Hanami
       #   Hanami::Utils::String.transform("Cherry", -> { "blossom" }))
       #     # => ArgumentError: wrong number of arguments (given 1, expected 0)
       #
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
       def self.transform(input, *transformations)
         fn = @__transformations__.fetch_or_store(transformations.hash) do
           compose do |fns|
@@ -142,7 +143,7 @@ module Hanami
                      elsif input.respond_to?(transformation)
                        t(:bind, input, ->(i) { i.public_send(transformation, *args) })
                      else
-                       raise NoMethodError.new(%(undefined method `#{transformation.inspect}' for #{input.inspect}:#{input.class}))
+                       raise NoMethodError.new(%(undefined method `#{transformation.inspect}' for #{input.inspect}:#{input.class})) # rubocop:disable Layout/LineLength
                      end
             end
           end
@@ -150,8 +151,6 @@ module Hanami
 
         fn.call(input)
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
       # Extracted from `transproc` source code
       #
@@ -164,7 +163,7 @@ module Hanami
         binding.instance_exec(value, &fun)
       end
 
-      # Return a titleized version of the string
+      # Returns a titleized version of the string
       #
       # @param input [::String] the input
       #
@@ -181,7 +180,7 @@ module Hanami
         underscore(string).split(CLASSIFY_SEPARATOR).map(&:capitalize).join(TITLEIZE_SEPARATOR)
       end
 
-      # Return a capitalized version of the string
+      # Returns a capitalized version of the string
       #
       # @param input [::String] the input
       #
@@ -208,7 +207,7 @@ module Hanami
         tail.unshift(head.capitalize).join(CAPITALIZE_SEPARATOR)
       end
 
-      # Return a CamelCase version of the string
+      # Returns a CamelCase version of the string
       #
       # @param input [::String] the input
       #
@@ -232,7 +231,7 @@ module Hanami
         words.zip(delimiters).join
       end
 
-      # Return a downcased and underscore separated version of the string
+      # Returns a downcased and underscore separated version of the string
       #
       # Revised version of `ActiveSupport::Inflector.underscore` implementation
       # @see https://github.com/rails/rails/blob/feaa6e2048fe86bcf07e967d6e47b865e42e055b/activesupport/lib/active_support/inflector/methods.rb#L90
@@ -257,7 +256,7 @@ module Hanami
         string.downcase
       end
 
-      # Return a downcased and dash separated version of the string
+      # Returns a downcased and dash separated version of the string
       #
       # @param input [::String] the input
       #
@@ -278,7 +277,7 @@ module Hanami
         underscore(string).split(CLASSIFY_SEPARATOR).join(DASHERIZE_SEPARATOR)
       end
 
-      # Return the string without the Ruby namespace of the class
+      # Returns the string without the Ruby namespace of the class
       #
       # @param input [::String] the input
       #
@@ -296,7 +295,7 @@ module Hanami
         ::String.new(input.to_s).split(NAMESPACE_SEPARATOR).last
       end
 
-      # Return the top level namespace name
+      # Returns the top level namespace name
       #
       # @param input [::String] the input
       #
@@ -314,7 +313,7 @@ module Hanami
         ::String.new(input.to_s).split(NAMESPACE_SEPARATOR).first
       end
 
-      # Return a pluralized version of self.
+      # Returns a pluralized version of self.
       #
       # @param input [::String] the input
       #
@@ -334,7 +333,7 @@ module Hanami
         Inflector.pluralize(string)
       end
 
-      # Return a singularized version of self.
+      # Returns a singularized version of self.
       #
       # @param input [::String] the input
       #
@@ -354,7 +353,7 @@ module Hanami
         Inflector.singularize(string)
       end
 
-      # Replace the rightmost match of `pattern` with `replacement`
+      # Replaces the rightmost match of `pattern` with `replacement`
       #
       # If the pattern cannot be matched, it returns the original string.
       #
@@ -375,7 +374,7 @@ module Hanami
       #     # => 'authors/books#index'
       def self.rsub(input, pattern, replacement)
         string = ::String.new(input.to_s)
-        if i = string.rindex(pattern) # rubocop:disable Lint/AssignmentInCondition
+        if i = string.rindex(pattern)
           s = string.dup
           s[i] = replacement
           s
@@ -396,7 +395,7 @@ module Hanami
         @string = string.to_s
       end
 
-      # Return a titleized version of the string
+      # Returns a titleized version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -412,7 +411,7 @@ module Hanami
         self.class.new underscore.split(CLASSIFY_SEPARATOR).map(&:capitalize).join(TITLEIZE_SEPARATOR)
       end
 
-      # Return a capitalized version of the string
+      # Returns a capitalized version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -444,7 +443,7 @@ module Hanami
         )
       end
 
-      # Return a CamelCase version of the string
+      # Returns a CamelCase version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -467,7 +466,7 @@ module Hanami
         self.class.new words.zip(delimiters).join
       end
 
-      # Return a downcased and underscore separated version of the string
+      # Returns a downcased and underscore separated version of the string
       #
       # Revised version of `ActiveSupport::Inflector.underscore` implementation
       # @see https://github.com/rails/rails/blob/feaa6e2048fe86bcf07e967d6e47b865e42e055b/activesupport/lib/active_support/inflector/methods.rb#L90
@@ -491,7 +490,7 @@ module Hanami
         self.class.new new_string
       end
 
-      # Return a downcased and dash separated version of the string
+      # Returns a downcased and dash separated version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -513,7 +512,7 @@ module Hanami
         self.class.new underscore.split(CLASSIFY_SEPARATOR).join(DASHERIZE_SEPARATOR)
       end
 
-      # Return the string without the Ruby namespace of the class
+      # Returns the string without the Ruby namespace of the class
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -532,7 +531,7 @@ module Hanami
         self.class.new split(NAMESPACE_SEPARATOR).last
       end
 
-      # Return the top level namespace name
+      # Returns the top level namespace name
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -573,9 +572,8 @@ module Hanami
       #     'Hanami::Utils'
       #     'Hanami::App'
       #
-      # rubocop:disable Metrics/MethodLength
       def tokenize
-        if match = TOKENIZE_REGEXP.match(@string) # rubocop:disable Lint/AssignmentInCondition
+        if match = TOKENIZE_REGEXP.match(@string)
           pre  = match.pre_match
           post = match.post_match
           tokens = match[1].split(TOKENIZE_SEPARATOR)
@@ -588,9 +586,8 @@ module Hanami
 
         nil
       end
-      # rubocop:enable Metrics/MethodLength
 
-      # Return a pluralized version of self.
+      # Returns a pluralized version of self.
       #
       # @return [Hanami::Utils::String] the pluralized string.
       #
@@ -603,7 +600,7 @@ module Hanami
         self.class.new Inflector.pluralize(self)
       end
 
-      # Return a singularized version of self.
+      # Returns a singularized version of self.
       #
       # @return [Hanami::Utils::String] the singularized string.
       #
@@ -636,7 +633,7 @@ module Hanami
         @string
       end
 
-      alias to_str to_s
+      alias_method :to_str, :to_s
 
       # Equality
       #
@@ -648,9 +645,9 @@ module Hanami
         to_s == other
       end
 
-      alias eql? ==
+      alias_method :eql?, :==
 
-      # Split the string with the given pattern
+      # Splits the string with the given pattern
       #
       # @return [Array<::String>]
       #
@@ -662,7 +659,7 @@ module Hanami
         @string.split(pattern, limit)
       end
 
-      # Replace the given pattern with the given replacement
+      # Replaces the given pattern with the given replacement
       #
       # @return [::String]
       #
@@ -678,7 +675,7 @@ module Hanami
         end
       end
 
-      # Iterate through the string, matching the pattern.
+      # Iterates through the string, matching the pattern.
       # Either return all those patterns, or pass them to the block.
       #
       # @return [Array<::String>]
@@ -691,7 +688,7 @@ module Hanami
         @string.scan(pattern, &blk)
       end
 
-      # Replace the rightmost match of `pattern` with `replacement`
+      # Replaces the rightmost match of `pattern` with `replacement`
       #
       # If the pattern cannot be matched, it returns the original string.
       #
@@ -717,7 +714,7 @@ module Hanami
       #   puts result
       #     # => #<Hanami::Utils::String:0x007fdb41232ed0 @string="authors/books#index">
       def rsub(pattern, replacement)
-        if i = rindex(pattern) # rubocop:disable Lint/AssignmentInCondition
+        if i = rindex(pattern)
           s    = @string.dup
           s[i] = replacement
           self.class.new s
@@ -726,21 +723,23 @@ module Hanami
         end
       end
 
-      # Override Ruby's method_missing in order to provide ::String interface
+      # Overrides Ruby's method_missing in order to provide ::String interface
       #
       # @api private
       # @since 0.3.0
       #
       # @raise [NoMethodError] If doesn't respond to the given method
       def method_missing(method_name, *args, &blk)
-        raise NoMethodError.new(%(undefined method `#{method_name}' for "#{@string}":#{self.class})) unless respond_to?(method_name)
+        unless respond_to?(method_name)
+          raise NoMethodError.new(%(undefined method `#{method_name}' for "#{@string}":#{self.class}))
+        end
 
         s = @string.__send__(method_name, *args, &blk)
         s = self.class.new(s) if s.is_a?(::String)
         s
       end
 
-      # Override Ruby's respond_to_missing? in order to support ::String interface
+      # Overrides Ruby's respond_to_missing? in order to support ::String interface
       #
       # @api private
       # @since 0.3.0