hanami-utils 2.0.0.alpha1 → 2.0.0

data/lib/hanami/utils/hash.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "transproc"
+require "dry/transformer"
 
 module Hanami
   module Utils
     # Hash transformations
     # @since 0.1.0
     module Hash
-      extend Transproc::Registry
-      import Transproc::HashTransformations
+      extend Dry::Transformer::Registry
+      import Dry::Transformer::HashTransformations
 
       # Symbolize the given hash
       #
@@ -32,7 +32,7 @@ module Hanami
         self[:symbolize_keys].call(input)
       end
 
-      # Deep symbolize the given hash
+      # Performs deep symbolize on the given hash
       #
       # @param input [::Hash] the input
       #
@@ -54,7 +54,7 @@ module Hanami
         self[:deep_symbolize_keys].call(input)
       end
 
-      # Stringify the given hash
+      # Stringifies the given hash
       #
       # @param input [::Hash] the input
       #
@@ -74,7 +74,7 @@ module Hanami
         self[:stringify_keys].call(input)
       end
 
-      # Deeply stringify the given hash
+      # Deeply stringifies the given hash
       #
       # @param input [::Hash] the input
       #
@@ -90,31 +90,19 @@ module Hanami
       #
       #   hash.class
       #     # => Hash
-      def self.deep_stringify(input) # rubocop:disable Metrics/MethodLength
-        input.each_with_object({}) do |(key, value), output|
-          output[key.to_s] =
-            case value
-            when ::Hash
-              deep_stringify(value)
-            when Array
-              value.map do |item|
-                item.is_a?(::Hash) ? deep_stringify(item) : item
-              end
-            else
-              value
-            end
-        end
+      def self.deep_stringify(input)
+        self[:deep_stringify_keys].call(input)
       end
 
-      # Deep duplicate hash values
+      # Deep duplicates hash values
       #
-      # The output of this function is a shallow duplicate of the input.
+      # The output of this function is a deep duplicate of the input.
       # Any further modification on the input, won't be reflected on the output
       # and viceversa.
       #
       # @param input [::Hash] the input
       #
-      # @return [::Hash] the shallow duplicate of input
+      # @return [::Hash] the deep duplicate of input
       #
       # @since 1.0.1
       #
@@ -144,17 +132,17 @@ module Hanami
       #   input
       #     # => {"a"=>{"b"=>{"c"=>[1,2,3,4]}}}
       def self.deep_dup(input)
-        input.each_with_object({}) do |(k, v), result|
-          result[k] = case v
-                      when ::Hash
-                        deep_dup(v)
-                      else
-                        v.dup
-                      end
+        input.transform_values do |v|
+          case v
+          when ::Hash
+            deep_dup(v)
+          else
+            v.dup
+          end
         end
       end
 
-      # Deep serialize given object into a `Hash`
+      # Deep serializes given object into a `Hash`
       #
       # Please note that the returning `Hash` will use symbols as keys.
       #
@@ -178,7 +166,7 @@ module Hanami
       #
       #   Hanami::Utils::Hash.deep_serialize(input)
       #     # => {:foo=>"bar", :baz=>[{:hello=>"world"}]}
-      def self.deep_serialize(input) # rubocop:disable Metrics/MethodLength
+      def self.deep_serialize(input)
         input.to_hash.each_with_object({}) do |(key, value), output|
           output[key.to_sym] =
             case value

data/lib/hanami/utils/json.rb

@@ -35,15 +35,25 @@ module Hanami
 
       # rubocop:disable Style/ClassVars
       if defined?(MultiJson)
+        # @since 0.8.0
+        # @api private
         @@engine    = MultiJsonAdapter.new
+
+        # @since 0.8.0
+        # @api private
         ParserError = MultiJson::ParseError
       else
+        # @since 0.8.0
+        # @api private
         @@engine    = ::JSON
+
+        # @since 0.8.0
+        # @api private
         ParserError = ::JSON::ParserError
       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

@@ -5,11 +5,12 @@ require "date"
 require "time"
 require "pathname"
 require "bigdecimal"
+require "bigdecimal/util"
 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
@@ -28,7 +29,7 @@ module Hanami
       # @api private
       #
       # @see Hanami::Utils::Kernel.Integer
-      NUMERIC_MATCHER = %r{\A([\d\/\.\+iE]+|NaN|Infinity)\z}.freeze
+      NUMERIC_MATCHER = %r{\A([\d/.+iE]+|NaN|Infinity)\z}
 
       # @since 0.8.0
       # @api private
@@ -327,7 +328,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
@@ -418,7 +419,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
@@ -435,7 +435,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.
       #
@@ -549,7 +548,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
@@ -738,7 +737,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)>
@@ -898,7 +898,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
@@ -1016,14 +1016,14 @@ module Hanami
         case arg
         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
+        else # rubocop:disable Lint/DuplicateBranch
           raise TypeError.new "can't convert #{inspect_type_error(arg)}into Symbol"
         end
       rescue NoMethodError
         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
       #
@@ -1044,11 +1044,11 @@ module Hanami
       # @since 0.4.3
       # @api private
       def self.inspect_type_error(arg)
-        (arg.respond_to?(:inspect) ? arg.inspect : arg.to_s) << " "
-      rescue NoMethodError => _
+        "#{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
@@ -1057,7 +1057,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

@@ -50,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.
       #
@@ -117,7 +117,7 @@ module Hanami
         self
       end
 
-      alias << push
+      alias_method :<<, :push
 
       # It freezes the object by preventing further modifications.
       #
@@ -158,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,6 +1,5 @@
 # frozen_string_literal: true
 
-require "hanami/utils/string"
 require "hanami/utils/kernel"
 
 module Hanami
@@ -8,7 +7,7 @@ module Hanami
     # Prefixed string
     #
     # @since 0.1.0
-    class PathPrefix < Hanami::Utils::String
+    class PathPrefix
       # Path separator
       #
       # @since 0.3.1
@@ -26,7 +25,7 @@ module Hanami
       #
       # @see Hanami::Utils::PathPrefix::DEFAULT_SEPARATOR
       def initialize(string = nil, separator = DEFAULT_SEPARATOR)
-        super(string)
+        @string = string.to_s
         @separator = separator
       end
 
@@ -93,6 +92,37 @@ module Hanami
         ).relative!
       end
 
+      # Returns the hash of the internal string
+      #
+      # @return [Integer]
+      #
+      # @since 0.3.0
+      def hash
+        @string.hash
+      end
+
+      # Returns a string representation
+      #
+      # @return [::String]
+      #
+      # @since 0.3.0
+      def to_s
+        @string
+      end
+
+      alias_method :to_str, :to_s
+
+      # Equality
+      #
+      # @return [TrueClass,FalseClass]
+      #
+      # @since 0.3.0
+      def ==(other)
+        to_s == other
+      end
+
+      alias_method :eql?, :==
+
       protected
 
       # Modifies the path prefix to have a prepended separator.

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

@@ -7,33 +7,37 @@ module Hanami
     # It doesn't check if you're writing to a file or anything, so you have to
     # check that yourself before using this module.
     #
+    # @api public
     # @since 1.2.0
     module ShellColor
-      # Unknown color code error
+      # Error raised for unknown color codes.
       #
       # @since 1.2.0
+      # @api public
       class UnknownColorCodeError < ::StandardError
+        # @since 1.2.0
+        # @api private
         def initialize(code)
           super("unknown color code: `#{code.inspect}'")
         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