hanami-utils 1.3.5 → 2.0.0.alpha2

data/lib/hanami/utils/file_list.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Hanami
   module Utils
     # Ordered file list, consistent across operating systems
     #
     # @since 0.9.0
     module FileList
-      # Return an ordered list of files, consistent across operating systems
+      # Returns an ordered list of files, consistent across operating systems
       #
       # It has the same signature of <tt>Dir.glob</tt>, it just guarantees to
       # order the results before to return them.
@@ -12,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pathname"
 require "fileutils"
 require "hanami/utils/deprecation"
@@ -32,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.
@@ -163,7 +147,7 @@ module Hanami
         mkdir_p(path)
 
         content = ::File.readlines(path)
-        content << "\n" unless content.last.end_with?("\n")
+        content << "\n" if _append_newline?(content)
         content << "#{contents}\n"
 
         write(path, content)
@@ -324,13 +308,13 @@ module Hanami
       #
       #   # class App
       #   # end
-      def self.remove_block(path, target) # rubocop:disable Metrics/AbcSize
+      def self.remove_block(path, target)
         content  = ::File.readlines(path)
         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)
@@ -452,6 +436,16 @@ module Hanami
       end
 
       private_class_method :line_number
+
+      # @since 1.3.6
+      # @api private
+      def self._append_newline?(content)
+        return false if content.empty?
+
+        !content.last.end_with?("\n")
+      end
+
+      private_class_method :_append_newline?
     end
   end
 end

data/lib/hanami/utils/hash.rb

@@ -1,29 +1,14 @@
-require 'hanami/utils/duplicable'
-require 'transproc'
+# frozen_string_literal: true
+
+require "dry-transformer"
 
 module Hanami
   module Utils
-    # Hash on steroids
+    # Hash transformations
     # @since 0.1.0
-    #
-    # rubocop:disable Metrics/ClassLength
-    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
-
-      extend Transproc::Registry
-      import Transproc::HashTransformations
+    module Hash
+      extend Dry::Transformer::Registry
+      import Dry::Transformer::HashTransformations
 
       # Symbolize the given hash
       #
@@ -47,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
       #
@@ -69,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
       #
@@ -89,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
       #
@@ -105,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
       #
@@ -159,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
-                        Duplicable.dup(v)
-                      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.
       #
@@ -193,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
@@ -208,318 +181,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
-
-      # Convert 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
-
-      # Convert 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
-
-      # Convert 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
-
-      # Return 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 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 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
-
-      # Override 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)
-        raise NoMethodError.new(%(undefined method `#{method_name}' for #{@hash}:#{self.class})) unless respond_to?(method_name)
-
-        h = @hash.__send__(method_name, *args, &blk)
-        h = self.class.new(h) if h.is_a?(::Hash)
-        h
-      end
-
-      # Override 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
-    # rubocop:enable Metrics/ClassLength
   end
 end