declutter 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607c7167c298669ff221cbd00d7d8d984f1a1c936e2fbf2e5ae74cd4903cdfef
-  data.tar.gz: 654e400b781e186c44477c88f547c06935d4f733c41685524c6896d5b7e953b3
+  metadata.gz: f9dbc1622dadba96ab55c42f8e7a477dac2ed481557703e074b096b6c4fffaa5
+  data.tar.gz: d147bd94493a740d1854a94bed6adb1d09891217ff60637b8c4d75dbc331e5a7
 SHA512:
-  metadata.gz: b32c7fda4d2420cf4bc7a0cc99b8016d70638ef3773e4297e0419b9773a4974ac00552a729726cadb120ebc09f0ca7f3b1917c02084bb0555d33bf661b18cfe1
-  data.tar.gz: 96acb8ef11156a427bc1447099acfa2273b302e0f020321ee6c35dd1b4ff8f5b2693b7d0b869f70741494594deb0dffed41f439fde32743bff14e615daf97253
+  metadata.gz: 6c08b8c3c36da7bd3b3af62eded77f0843b4af7f8b77ce01c12d5af248e6584cc3daf5942568c617b7a4c2bba75e736420dc1490b3bfb71e770fa65885118677
+  data.tar.gz: 47d13c23af1e61d2e4d2c2b7809c175fc61e194dd86ddf3d57ee7a748548fb65efcd50527374d11ed38af99c031034840ac00a44ca15ed5ca174dc01a0446780

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,60 @@ 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. |

data/lib/declutter.rb

@@ -2,21 +2,38 @@
 # Declutter
 #
 class Declutter
+	# 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
@@ -25,11 +42,16 @@ class Declutter
 	
 	#---------------------------------------------------------------------------
 	# process
-	# Process hash or array. Anything else is left as is.
 	#
+	
+	# 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
@@ -42,6 +64,9 @@ class Declutter
 	#---------------------------------------------------------------------------
 	# self.process
 	#
+	
+	# Shortcut for decluttering with default settings.
+	
 	def self.process(obj)
 		self.new.process obj
 	end
@@ -50,6 +75,10 @@ class Declutter
 	#---------------------------------------------------------------------------
 	
 	
+	# private
+	private
+	
+	
 	#---------------------------------------------------------------------------
 	# process_hash
 	#
@@ -118,6 +147,12 @@ class Declutter
 		# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declutter
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Mike O'Sullivan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies: []
 description: Declutter your Ruby objects by removing empty hashes and arrays
 email: mike@idocs.com