declutter 1.0 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607c7167c298669ff221cbd00d7d8d984f1a1c936e2fbf2e5ae74cd4903cdfef
-  data.tar.gz: 654e400b781e186c44477c88f547c06935d4f733c41685524c6896d5b7e953b3
+  metadata.gz: 405d0434633c9cbad8fb8618c6120342e441910fad8134878f5c6bf320ac340c
+  data.tar.gz: 828c40921b050e099a612485de9179cd029a0d1d2311109d5fb6c8892412d94c
 SHA512:
-  metadata.gz: b32c7fda4d2420cf4bc7a0cc99b8016d70638ef3773e4297e0419b9773a4974ac00552a729726cadb120ebc09f0ca7f3b1917c02084bb0555d33bf661b18cfe1
-  data.tar.gz: 96acb8ef11156a427bc1447099acfa2273b302e0f020321ee6c35dd1b4ff8f5b2693b7d0b869f70741494594deb0dffed41f439fde32743bff14e615daf97253
+  metadata.gz: 9e386bd19f6a3a63f5742f84da21f4debf70f89bbdc67d41777bd0e0504ad87f8fce080d3fc6be40815c0b7faabdb20220b44cf3a9209060dc9b073b05eb65a6
+  data.tar.gz: 67bb244674d0bdc11ffa59eac0b847082888a9190b452326a4b35e0ecd59a35aff247ad6fda6286a41cfbcb9dc68daff17e8de17a1e87900d769e6f1c5716bc3

data/README.md

@@ -1,6 +1,8 @@
-# declutter
+# Declutter
+
 Declutters your Ruby hashes and arrays by removing empty arrays and hashes.
-Also has options for removing nils, redundancies and falses.
+Also has options for removing nils, redundancies and falses, and objects that
+respond to `#declutter`.
 
 In this simple example, we create a hash structure that contains an empty array:
 
@@ -126,8 +128,61 @@ declutter.process myhash
 puts myhash # => {"episodes"=>[]}
 ```
 
+### objects of other classes
+
+Objects of your own custom class can be decluttered if they have a `#declutter`
+method. Consider these two classes.
+
+```ruby
+class KeepMe
+   def declutter
+      return true
+   end
+end
+
+class DeleteMe
+   def declutter
+      return false
+   end
+end
+```
+
+Both classes have declutter methods. `KeepMe#declutter` returns true and
+`DeleteMe#declutter` returns false. In this first example, we use the default
+settings to declutter the hash.
+
+```ruby
+hsh = {}
+hsh['keep-it'] = KeepMe.new
+hsh['delete-it'] = DeleteMe.new
+
+Declutter.process hsh
+
+puts hsh # => {"keep-it"=>#<KeepMe:0x0000559f8574b718>}
+```
+
+The `keep-it` element was kept because `KeepMe#declutter` returns true. However,
+the `delete-it` element was deleted because `DeleteMe#declutter` returns false.
+
+To bypass decluttering objects that have a `#declutter` method, use the object
+oriented approach and set `process_others` to false:
+
+```ruby
+hsh = {}
+hsh['keep-it'] = KeepMe.new
+hsh['delete-it'] = DeleteMe.new
+
+declutter = Declutter.new
+declutter.process_others = false
+declutter.process hsh
+
+puts hsh # => {"keep-it"=>#<KeepMe:0x000055e5ffd46f80>, "delete-it"=>#<DeleteMe:0x000055e5ffd46f30>}
+```
+
 ## History
 
 | date         | version | notes           |
 |--------------|---------|-----------------|
-| May 23, 2023 | 1.0     | Initial upload. |
+| May 23, 2023 | 1.0     | Initial upload. |
+| May 29, 2023 | 1.1     | Added ability to call #declutter on any object that responds to that method. |
+| June 9, 2023 | 1.2     | Changed tests to Minitest. No change to functionality. |

data/lib/declutter.rb

@@ -2,130 +2,165 @@
 # Declutter
 #
 class Declutter
-	attr_accessor :delete_empty_hashes
-	attr_accessor :delete_empty_arrays
-	attr_accessor :delete_redundancies
-	attr_accessor :delete_nils
-	attr_accessor :delete_falses
-	
-	#---------------------------------------------------------------------------
-	# initialize
-	#
-	def initialize
-		@delete_empty_hashes = true
-		@delete_empty_arrays = true
-		@delete_redundancies = false
-		@delete_nils = false
-		@delete_falses = false
-	end
-	#
-	# initialize
-	#---------------------------------------------------------------------------
-	
-	
-	#---------------------------------------------------------------------------
-	# process
-	# Process hash or array. Anything else is left as is.
-	#
-	def process(obj)
-		if obj.is_a?(Hash)
-			process_hash obj
-		elsif obj.is_a?(Array)
-			process_array obj
-		end
-	end
-	#
-	# process
-	#---------------------------------------------------------------------------
-	
-	
-	#---------------------------------------------------------------------------
-	# self.process
-	#
-	def self.process(obj)
-		self.new.process obj
-	end
-	#
-	# self.process
-	#---------------------------------------------------------------------------
-	
-	
-	#---------------------------------------------------------------------------
-	# process_hash
-	#
-	def process_hash(hsh)
-		hsh.keys.each do |k|
-			v = hsh[k]
-			process v
-			
-			# delete or process element
-			if not keep_element?(v)
-				hsh.delete k
-			end
-		end
-	end
-	#
-	# process_hash
-	#---------------------------------------------------------------------------
-	
-	
-	#---------------------------------------------------------------------------
-	# process_array
-	#
-	def process_array(arr)
-		hold = arr.clone
-		arr.clear
-		
-		# add back elements that are acceptable
-		hold.each do |child|
-			process child
-			
-			if keep_element?(child)
-				arr.push child
-			end
-		end
-		
-		# uniq array if necessary
-		if @delete_redundancies
-			arr.uniq!
-		end
-	end
-	#
-	# process_array
-	#---------------------------------------------------------------------------
-	
-	
-	#---------------------------------------------------------------------------
-	# keep_element
-	#
-	def keep_element?(v)
-		# hash
-		if v.is_a?(Hash)
-			if @delete_empty_hashes and v.empty?
-				return false
-			end
-			
-		# array
-		elsif v.is_a?(Array)
-			if @delete_empty_arrays and v.empty?
-				return false
-			end
-			
-		# nil
-		elsif v.nil?
-			return !@delete_nils
-			
-		# false
-		elsif not v
-			return !@delete_falses
-		end
-		
-		# if we get this far then we're keeping the element
-		return true
-	end
-	#
-	# keep_element
-	#---------------------------------------------------------------------------
+  # If empty hashes should be deleted. True by default.
+  attr_accessor :delete_empty_hashes
+  
+  # If empty arrays should be deleted. True by default.
+  attr_accessor :delete_empty_arrays
+  
+  # If redundant array elements should be deleted. False by default.
+  attr_accessor :delete_redundancies
+  
+  # If nils should be deleted. False by default.
+  attr_accessor :delete_nils
+  
+  # If falses should be deleted. False by default.
+  attr_accessor :delete_falses
+  
+  # If objects that respond to #declutter should be processed. Defaults
+  # to true.
+  attr_accessor :process_others
+  
+  #---------------------------------------------------------------------------
+  # initialize
+  #
+  
+  # Creates a new Declutter object. Takes no params.
+  
+  def initialize
+    @delete_empty_hashes = true
+    @delete_empty_arrays = true
+    @delete_redundancies = false
+    @delete_nils = false
+    @delete_falses = false
+    @process_others = true
+  end
+  #
+  # initialize
+  #---------------------------------------------------------------------------
+  
+  
+  #---------------------------------------------------------------------------
+  # process
+  #
+  
+  # Declutter a hash or array.
+  
+  def process(obj)
+    # declutter hash
+    if obj.is_a?(Hash)
+      process_hash obj
+    
+    # declutter array
+    elsif obj.is_a?(Array)
+      process_array obj
+    end
+  end
+  #
+  # process
+  #---------------------------------------------------------------------------
+  
+  
+  #---------------------------------------------------------------------------
+  # self.process
+  #
+  
+  # Shortcut for decluttering with default settings.
+  
+  def self.process(obj)
+    self.new.process obj
+  end
+  #
+  # self.process
+  #---------------------------------------------------------------------------
+  
+  
+  # private
+  private
+  
+  
+  #---------------------------------------------------------------------------
+  # process_hash
+  #
+  def process_hash(hsh)
+    hsh.keys.each do |k|
+      v = hsh[k]
+      process v
+      
+      # delete or process element
+      if not keep_element?(v)
+          hsh.delete k
+      end
+    end
+  end
+  #
+  # process_hash
+  #---------------------------------------------------------------------------
+  
+  
+  #---------------------------------------------------------------------------
+  # process_array
+  #
+  def process_array(arr)
+    hold = arr.clone
+    arr.clear
+    
+    # add back elements that are acceptable
+    hold.each do |child|
+      process child
+      
+      if keep_element?(child)
+        arr.push child
+      end
+    end
+    
+    # uniq array if necessary
+    if @delete_redundancies
+      arr.uniq!
+    end
+  end
+  #
+  # process_array
+  #---------------------------------------------------------------------------
+  
+  
+  #---------------------------------------------------------------------------
+  # keep_element
+  #
+  def keep_element?(v)
+    # hash
+    if v.is_a?(Hash)
+      if @delete_empty_hashes and v.empty?
+          return false
+      end
+        
+    # array
+    elsif v.is_a?(Array)
+      if @delete_empty_arrays and v.empty?
+          return false
+      end
+        
+    # nil
+    elsif v.nil?
+      return !@delete_nils
+        
+    # false
+    elsif not v
+      return !@delete_falses
+        
+    # other class
+    elsif @process_others and v.respond_to?('declutter')
+      if not v.declutter
+        return false
+      end
+    end
+    
+    # if we get this far then we're keeping the element
+    return true
+  end
+  #
+  # keep_element
+  #---------------------------------------------------------------------------
 end
 #
 # Declutter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declutter
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.2'
 platform: ruby
 authors:
 - Mike O'Sullivan
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies: []
 description: Declutter your Ruby objects by removing empty hashes and arrays
 email: mike@idocs.com
@@ -22,7 +22,7 @@ homepage: https://github.com/mikosullivan/declutter
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -37,8 +37,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Declutter
 test_files: []