array_utils 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d956d55c007e0d1ea35d91c3d08abbb73cb24245f48bc180b732fee2d4240e3d
-  data.tar.gz: c5ada0a36e1b7f5d5c449db8bf57e1c27cc93903ed57b8ca2316f7243cf493ad
+  metadata.gz: 9328e017c9d5987494e2d6de4ef7c2fdc626c0b351ea7cddaa9a55e6482ec1bc
+  data.tar.gz: 06dd470410326a939e0ee7f5cafe7e7c8e6c8985df17334a65a0875b03c36662
 SHA512:
-  metadata.gz: e217bc0f93e6bf34e584c4a780c4800d4dd23b4778e1284a3d8ceba2af898c4b4ecb1a60547249a58e5678d51eb53ae8c0fb4be02c7adda13651a0a69f759442
-  data.tar.gz: 8209e03eae1a309aebbfaa72b25c698d96413c27722299a20b066cebeb24a2ec2c62d5724f6fc087465a5413b65b4c2195d3488809af9c31a0d89718e13aab43
+  metadata.gz: 4af0682ffe381b43b60d824a1e45ddfdb0c0990707c3c638c3eb5ce79972332e2bbef39d6b610d80dd100e679a329535795dcfc09da1be1e0e622efefbcb3fd4
+  data.tar.gz: ae6be72e010f74407247aceadfb17ae93b1b2bf23c560da8be5d65ef2800130b9f4a37b8faf0e0ae6a5df0e3e403626e816b12d400df32de53126396468e5762

data/lib/array_utils.rb

@@ -25,4 +25,62 @@ class Array
 
     partition(&:odd?)
   end
+
+  # Determines whether an array is "sparse," meaning it contains a significant
+  # proportion
+  # of `nil` values compared to its size.
+  #
+  # @param threshold [Float] The threshold ratio (default: 0.5).
+  #   If the proportion of `nil` values to the array's size exceeds this
+  #   threshold, the array is considered sparse.
+  #
+  # @return [Boolean] `true` if the array is sparse, `false` otherwise.
+  #
+  # @example Basic usage:
+  #   [1, nil, nil, 4, nil].sparse? # => true (more than 50% nil values)
+  #
+  # @example Custom threshold:
+  #   [1, nil, nil, 4, 5].sparse?(0.8) # => false (less than 80% nil values)
+  #
+  # @example Non-sparse array:
+  #   [1, 2, 3, 4, 5].sparse? # => false (no nil values)
+  def sparse?(threshold = 0.5)
+    flatten.count(nil).to_f / flatten.size > threshold
+  end
+
+  # Returns a new array where all `nil` values are removed.
+  #
+  # If an element is an array, it is compacted (removing `nil` values)
+  # before being added. This makes it more effective than the default `#compact`
+  # method which only works with 1D arrays.
+  #
+  # @return [Array] A new array with `nil` values removed.
+  def densify
+    densified_array = []
+
+    each do |elem|
+      next unless elem
+
+      if elem.is_a? Array
+        nested = elem.densify
+        # skip empty arrays after removing nil values
+        densified_array << nested unless nested.empty?
+      else
+        densified_array << elem
+      end
+    end
+
+    densified_array
+  end
+
+  # Modifies the array in place by removing all `nil` values.
+  #
+  # If an element is an array, it is compacted (removing `nil` values)
+  # before being added. This makes it more effective than the default `#compact`
+  # method which only works with 1D arrays.
+  #
+  # @return [self] The modified array.
+  def densify!
+    replace(densify)
+  end
 end

metadata

@@ -1,24 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: array_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Maxwell Nana Forson
 bindir: bin
 cert_chain: []
-date: 2025-03-23 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies: []
-description: |
-  The default Ruby Array class allows inserting into an array at an that
-  doesn't exist. For example, a user may do this `array[2938] = 48` when the
-  array contains only about six (6) elements. This causes the the array to now
-  contain 2,000 plus of nil elements. The goal is to avoid this by intelligently
-  appending to the end of the array when such action is performed.
+description: |2
+      A simple Ruby gem that handles the issue with Ruby’s Array class when
+      inserting an element at an index greater than the current array size.
+      It handles this by intelligently appending the result to the end of the
+      array instead of creating a sparse array.
 
-  Also, invalid negative indexes will throw an `IndexError` exception as usual.
-
-  There are other useful methods added on top of the Array class for common tasks.
+      It also includes some other useful Array methods for common uses.
 email: maxwellnanaforson@gmail.com
 executables: []
 extensions: []