hanami-utils 1.3.7 → 2.0.0.alpha1

data/lib/hanami/utils/hash.rb

@@ -1,28 +1,12 @@
 # frozen_string_literal: true
 
-require "hanami/utils/duplicable"
 require "transproc"
 
 module Hanami
   module Utils
-    # Hash on steroids
+    # Hash transformations
     # @since 0.1.0
-    #
-    class Hash
-      # @since 0.6.0
-      # @api private
-      #
-      # @see Hanami::Utils::Hash#deep_dup
-      # @see Hanami::Utils::Duplicable
-      DUPLICATE_LOGIC = proc do |value|
-        case value
-        when Hash
-          value.deep_dup
-        when ::Hash
-          Hash.new(value).deep_dup.to_h
-        end
-      end.freeze
-
+    module Hash
       extend Transproc::Registry
       import Transproc::HashTransformations
 
@@ -48,7 +32,7 @@ module Hanami
         self[:symbolize_keys].call(input)
       end
 
-      # Performs deep symbolize on the given hash
+      # Deep symbolize the given hash
       #
       # @param input [::Hash] the input
       #
@@ -70,7 +54,7 @@ module Hanami
         self[:deep_symbolize_keys].call(input)
       end
 
-      # Stringifies the given hash
+      # Stringify the given hash
       #
       # @param input [::Hash] the input
       #
@@ -90,7 +74,7 @@ module Hanami
         self[:stringify_keys].call(input)
       end
 
-      # Deeply stringifies the given hash
+      # Deeply stringify the given hash
       #
       # @param input [::Hash] the input
       #
@@ -106,7 +90,7 @@ module Hanami
       #
       #   hash.class
       #     # => Hash
-      def self.deep_stringify(input)
+      def self.deep_stringify(input) # rubocop:disable Metrics/MethodLength
         input.each_with_object({}) do |(key, value), output|
           output[key.to_s] =
             case value
@@ -122,15 +106,15 @@ module Hanami
         end
       end
 
-      # Deep duplicates hash values
+      # Deep duplicate hash values
       #
-      # The output of this function is a deep duplicate of the input.
+      # The output of this function is a shallow 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 deep duplicate of input
+      # @return [::Hash] the shallow duplicate of input
       #
       # @since 1.0.1
       #
@@ -165,12 +149,12 @@ module Hanami
                       when ::Hash
                         deep_dup(v)
                       else
-                        Duplicable.dup(v)
+                        v.dup
                       end
         end
       end
 
-      # Deep serializes given object into a `Hash`
+      # Deep serialize given object into a `Hash`
       #
       # Please note that the returning `Hash` will use symbols as keys.
       #
@@ -194,7 +178,7 @@ module Hanami
       #
       #   Hanami::Utils::Hash.deep_serialize(input)
       #     # => {:foo=>"bar", :baz=>[{:hello=>"world"}]}
-      def self.deep_serialize(input)
+      def self.deep_serialize(input) # rubocop:disable Metrics/MethodLength
         input.to_hash.each_with_object({}) do |(key, value), output|
           output[key.to_sym] =
             case value
@@ -209,319 +193,6 @@ module Hanami
             end
         end
       end
-
-      # Initialize the hash
-      #
-      # @param hash [#to_h] the value we want to use to initialize this instance
-      # @param blk [Proc] define the default value
-      #
-      # @return [Hanami::Utils::Hash] self
-      #
-      # @since 0.1.0
-      # @deprecated
-      #
-      # @see http://www.ruby-doc.org/core/Hash.html#method-c-5B-5D
-      #
-      # @example Passing a Hash
-      #   require 'hanami/utils/hash'
-      #
-      #   hash = Hanami::Utils::Hash.new('l' => 23)
-      #   hash['l'] # => 23
-      #
-      # @example Passing a block for default
-      #   require 'hanami/utils/hash'
-      #
-      #   hash = Hanami::Utils::Hash.new {|h,k| h[k] = [] }
-      #   hash['foo'].push 'bar'
-      #
-      #   hash.to_h # => { 'foo' => ['bar'] }
-      def initialize(hash = {}, &blk)
-        @hash = hash.to_hash
-        @hash.default_proc = blk if blk
-      end
-
-      # Converts in-place all the keys to Symbol instances.
-      #
-      # @return [Hash] self
-      #
-      # @since 0.1.0
-      # @deprecated Use {Hanami::Utils::Hash.symbolize}
-      #
-      # @example
-      #   require 'hanami/utils/hash'
-      #
-      #   hash = Hanami::Utils::Hash.new 'a' => 23, 'b' => { 'c' => ['x','y','z'] }
-      #   hash.symbolize!
-      #
-      #   hash.keys    # => [:a, :b]
-      #   hash.inspect # => { :a => 23, :b => { 'c' => ["x", "y", "z"] } }
-      def symbolize!
-        keys.each do |k|
-          v = delete(k)
-          self[k.to_sym] = v
-        end
-
-        self
-      end
-
-      # Converts in-place all the keys to Symbol instances, nested hashes are converted too.
-      #
-      # @return [Hash] self
-      #
-      # @since 1.0.0
-      # @deprecated Use {Hanami::Utils::Hash.deep_symbolize}
-      #
-      # @example
-      #   require 'hanami/utils/hash'
-      #
-      #   hash = Hanami::Utils::Hash.new 'a' => 23, 'b' => { 'c' => ['x','y','z'] }
-      #   hash.deep_symbolize!
-      #
-      #   hash.keys    # => [:a, :b]
-      #   hash.inspect # => {:a=>23, :b=>{:c=>["x", "y", "z"]}}
-      def deep_symbolize!
-        keys.each do |k|
-          v = delete(k)
-          v = self.class.new(v).deep_symbolize! if v.respond_to?(:to_hash)
-
-          self[k.to_sym] = v
-        end
-
-        self
-      end
-
-      # Converts in-place all the keys to Symbol instances, nested hashes are converted too.
-      #
-      # @return [Hash] self
-      #
-      # @since 0.3.2
-      # @deprecated Use {Hanami::Utils::Hash.stringify}
-      #
-      # @example
-      #   require 'hanami/utils/hash'
-      #
-      #   hash = Hanami::Utils::Hash.new a: 23, b: { c: ['x','y','z'] }
-      #   hash.stringify!
-      #
-      #   hash.keys    # => [:a, :b]
-      #   hash.inspect # => {"a"=>23, "b"=>{"c"=>["x", "y", "z"]}}
-      def stringify!
-        keys.each do |k|
-          v = delete(k)
-          v = self.class.new(v).stringify! if v.respond_to?(:to_hash)
-
-          self[k.to_s] = v
-        end
-
-        self
-      end
-
-      # Returns a deep copy of the current Hanami::Utils::Hash
-      #
-      # @return [Hash] a deep duplicated self
-      #
-      # @since 0.3.1
-      # @deprecated Use {Hanami::Utils::Hash.deep_dup}
-      #
-      # @example
-      #   require 'hanami/utils/hash'
-      #
-      #   hash = Hanami::Utils::Hash.new(
-      #     'nil'        => nil,
-      #     'false'      => false,
-      #     'true'       => true,
-      #     'symbol'     => :foo,
-      #     'fixnum'     => 23,
-      #     'bignum'     => 13289301283 ** 2,
-      #     'float'      => 1.0,
-      #     'complex'    => Complex(0.3),
-      #     'bigdecimal' => BigDecimal('12.0001'),
-      #     'rational'   => Rational(0.3),
-      #     'string'     => 'foo bar',
-      #     'hash'       => { a: 1, b: 'two', c: :three },
-      #     'u_hash'     => Hanami::Utils::Hash.new({ a: 1, b: 'two', c: :three })
-      #   )
-      #
-      #   duped = hash.deep_dup
-      #
-      #   hash.class  # => Hanami::Utils::Hash
-      #   duped.class # => Hanami::Utils::Hash
-      #
-      #   hash.object_id  # => 70147385937100
-      #   duped.object_id # => 70147385950620
-      #
-      #   # unduplicated values
-      #   duped['nil']        # => nil
-      #   duped['false']      # => false
-      #   duped['true']       # => true
-      #   duped['symbol']     # => :foo
-      #   duped['fixnum']     # => 23
-      #   duped['bignum']     # => 176605528590345446089
-      #   duped['float']      # => 1.0
-      #   duped['complex']    # => (0.3+0i)
-      #   duped['bigdecimal'] # => #<BigDecimal:7f9ffe6e2fd0,'0.120001E2',18(18)>
-      #   duped['rational']   # => 5404319552844595/18014398509481984)
-      #
-      #   # it duplicates values
-      #   duped['string'].reverse!
-      #   duped['string'] # => "rab oof"
-      #   hash['string']  # => "foo bar"
-      #
-      #   # it deeply duplicates Hash, by preserving the class
-      #   duped['hash'].class # => Hash
-      #   duped['hash'].delete(:a)
-      #   hash['hash'][:a]    # => 1
-      #
-      #   duped['hash'][:b].upcase!
-      #   duped['hash'][:b] # => "TWO"
-      #   hash['hash'][:b]  # => "two"
-      #
-      #   # it deeply duplicates Hanami::Utils::Hash, by preserving the class
-      #   duped['u_hash'].class # => Hanami::Utils::Hash
-      def deep_dup
-        self.class.new.tap do |result|
-          @hash.each { |k, v| result[k] = Duplicable.dup(v, &DUPLICATE_LOGIC) }
-        end
-      end
-
-      # Returns a new array populated with the keys from this hash
-      #
-      # @return [Array] the keys
-      #
-      # @since 0.3.0
-      # @deprecated
-      #
-      # @see http://www.ruby-doc.org/core/Hash.html#method-i-keys
-      def keys
-        @hash.keys
-      end
-
-      # Deletes the key-value pair and returns the value from hsh whose key is
-      # equal to key.
-      #
-      # @param key [Object] the key to remove
-      #
-      # @return [Object,nil] the value hold by the given key, if present
-      #
-      # @since 0.3.0
-      # @deprecated
-      #
-      # @see http://www.ruby-doc.org/core/Hash.html#method-i-keys
-      def delete(key)
-        @hash.delete(key)
-      end
-
-      # Retrieves the value object corresponding to the key object.
-      #
-      # @param key [Object] the key
-      #
-      # @return [Object,nil] the correspoding value, if present
-      #
-      # @since 0.3.0
-      # @deprecated
-      #
-      # @see http://www.ruby-doc.org/core/Hash.html#method-i-5B-5D
-      def [](key)
-        @hash[key]
-      end
-
-      # Associates the value given by value with the key given by key.
-      #
-      # @param key [Object] the key to assign
-      # @param value [Object] the value to assign
-      #
-      # @since 0.3.0
-      # @deprecated
-      #
-      # @see http://www.ruby-doc.org/core/Hash.html#method-i-5B-5D-3D
-      def []=(key, value)
-        @hash[key] = value
-      end
-
-      # Returns a Ruby Hash as duplicated version of self
-      #
-      # @return [::Hash] the hash
-      #
-      # @since 0.3.0
-      # @deprecated
-      #
-      # @see http://www.ruby-doc.org/core/Hash.html#method-i-to_h
-      def to_h
-        @hash.each_with_object({}) do |(k, v), result|
-          v = v.to_h if v.respond_to?(:to_hash)
-          result[k] = v
-        end
-      end
-
-      alias_method :to_hash, :to_h
-
-      # Converts into a nested array of [ key, value ] arrays.
-      #
-      # @return [::Array] the array
-      #
-      # @since 0.3.0
-      # @deprecated
-      #
-      # @see http://www.ruby-doc.org/core/Hash.html#method-i-to_a
-      def to_a
-        @hash.to_a
-      end
-
-      # Equality
-      #
-      # @return [TrueClass,FalseClass]
-      #
-      # @since 0.3.0
-      # @deprecated
-      def ==(other)
-        @hash == other.to_h
-      end
-
-      alias_method :eql?, :==
-
-      # Returns the hash of the internal @hash
-      #
-      # @return [Fixnum]
-      #
-      # @since 0.3.0
-      # @deprecated
-      def hash
-        @hash.hash
-      end
-
-      # Returns a string describing the internal @hash
-      #
-      # @return [String]
-      #
-      # @since 0.3.0
-      # @deprecated
-      def inspect
-        @hash.inspect
-      end
-
-      # Overrides Ruby's method_missing in order to provide ::Hash interface
-      #
-      # @api private
-      # @since 0.3.0
-      #
-      # @raise [NoMethodError] If doesn't respond to the given method
-      def method_missing(method_name, *args, &blk)
-        unless respond_to?(method_name)
-          raise NoMethodError.new(%(undefined method `#{method_name}' for #{@hash}:#{self.class}))
-        end
-
-        h = @hash.__send__(method_name, *args, &blk)
-        h = self.class.new(h) if h.is_a?(::Hash)
-        h
-      end
-
-      # Overrides Ruby's respond_to_missing? in order to support ::Hash interface
-      #
-      # @api private
-      # @since 0.3.0
-      def respond_to_missing?(method_name, include_private = false)
-        @hash.respond_to?(method_name, include_private)
-      end
     end
   end
 end

data/lib/hanami/utils/json.rb

@@ -43,7 +43,7 @@ module Hanami
       end
       # rubocop:enable Style/ClassVars
 
-      # Parses the given JSON paylod
+      # Parse the given JSON paylod
       #
       # @param payload [String] a JSON payload
       #

data/lib/hanami/utils/kernel.rb

@@ -9,7 +9,7 @@ require "hanami/utils"
 require "hanami/utils/string"
 
 unless defined?(Boolean)
-  # Defines top level constant Boolean, so it can be easily used by other libraries
+  # Define top level constant Boolean, so it can be easily used by other libraries
   # in coercions DSLs
   #
   # @since 0.3.0
@@ -327,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)
+      def self.Integer(arg) # rubocop:disable Metrics/MethodLength
         super(arg)
       rescue ArgumentError, TypeError, NoMethodError
         begin
@@ -418,6 +418,7 @@ 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
@@ -434,6 +435,7 @@ 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 +549,7 @@ module Hanami
       #   # big complex represented as a string
       #   input = Complex(2, 3)
       #   Hanami::Utils::Kernel.Float(input) # => TypeError
-      def self.Float(arg)
+      def self.Float(arg) # rubocop:disable Metrics/MethodLength
         super(arg)
       rescue ArgumentError, TypeError
         begin
@@ -736,8 +738,7 @@ 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)>
@@ -897,7 +898,7 @@ module Hanami
       #   # Missing #respond_to?
       #   input = BasicObject.new
       #   Hanami::Utils::Kernel.Boolean(input) # => TypeError
-      def self.Boolean(arg)
+      def self.Boolean(arg) # rubocop:disable Metrics/MethodLength
         case arg
         when Numeric
           arg.to_i == BOOLEAN_TRUE_INTEGER
@@ -1022,7 +1023,7 @@ module Hanami
         raise TypeError.new "can't convert #{inspect_type_error(arg)}into Symbol"
       end
 
-      # Checks if the given argument is a string representation of a number
+      # Check if the given argument is a string representation of a number
       #
       # @param arg [Object] the input
       #
@@ -1043,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
@@ -1056,7 +1057,7 @@ module Hanami
       end
 
       class << self
-        private :inspect_type_error
+        private :inspect_type_error # rubocop:disable Style/AccessModifierDeclarations
       end
     end
   end