declutter 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 607c7167c298669ff221cbd00d7d8d984f1a1c936e2fbf2e5ae74cd4903cdfef
+  data.tar.gz: 654e400b781e186c44477c88f547c06935d4f733c41685524c6896d5b7e953b3
+SHA512:
+  metadata.gz: b32c7fda4d2420cf4bc7a0cc99b8016d70638ef3773e4297e0419b9773a4974ac00552a729726cadb120ebc09f0ca7f3b1917c02084bb0555d33bf661b18cfe1
+  data.tar.gz: 96acb8ef11156a427bc1447099acfa2273b302e0f020321ee6c35dd1b4ff8f5b2693b7d0b869f70741494594deb0dffed41f439fde32743bff14e615daf97253

data/README.md

@@ -0,0 +1,133 @@
+# declutter
+Declutters your Ruby hashes and arrays by removing empty arrays and hashes.
+Also has options for removing nils, redundancies and falses.
+
+In this simple example, we create a hash structure that contains an empty array:
+
+```ruby
+#!/usr/bin/ruby -w
+require 'declutter'
+
+myhash = { 'title' => 'Titus Andronicus', 'episodes' => [] }
+puts myhash # => {"title"=>"Titus Andronicus", "episodes"=>[]}
+Declutter.process myhash
+puts myhash # => {"title"=>"Titus Andronicus"}
+```
+
+By running the hash through `Declutter.process`, we remove the empty array. If
+an array contains only an empty array, then the whole array structure is
+removed:
+
+```ruby
+myhash = { 'title' => 'Titus Andronicus', 'episodes' => ['scenes'=>[]] };
+puts myhash # => {"title"=>"Titus Andronicus", "episodes"=>[{"scenes"=>[]}]}
+Declutter.process myhash
+puts myhash # => {"title"=>"Titus Andronicus"}
+```
+
+The same concept goes for empty hashes:
+
+```ruby
+myhash = {'title' => 'Titus Andronicus', 'notes' => {'ideas'=>{}} }
+puts myhash # => {"title"=>"Titus Andronicus", "notes"=>{}}
+Declutter.process myhash
+puts myhash # => {"title"=>"Titus Andronicus"}
+```
+
+## Object oriented approach
+
+To refine what elements are deleted, instantiate `Declutter` to set what type of
+elements are deleted.
+
+### nil
+
+To delete nils, set `declutter.delete_nils` to true:
+
+```ruby
+myhash = { 'episodes'=>['pilot', nil, 'transition'] }
+puts myhash # => {"episodes"=>["pilot", nil, "transition"]}
+
+declutter = Declutter.new()
+declutter.delete_nils = true
+declutter.process myhash
+
+puts myhash # => {"episodes"=>["pilot", "transition"]}
+```
+
+If deleting the nil values results in an empty array, then the array is deleted.
+
+```ruby
+myhash = { 'episodes'=>[nil] }
+puts myhash # => { 'episodes'=>[nil] }
+
+declutter = Declutter.new()
+declutter.delete_nils = true
+declutter.process myhash
+
+puts myhash # => {}
+```
+
+### redundancies
+
+To delete redundant elements in arrays, set `declutter.delete_redundancies` to
+true.
+
+```ruby
+myhash = { 'episodes'=>['pilot', 'pilot'] }
+puts myhash # => { 'episodes'=>['pilot', 'pilot'] }
+
+declutter = Declutter.new()
+declutter.delete_redundancies = true
+declutter.process myhash
+
+puts myhash # => { 'episodes'=>['pilot'] }
+```
+
+### false
+
+To delete false values, set `declutter.delete_falses` to true:
+
+```ruby
+myhash = { 'episodes'=>['pilot', false] }
+puts myhash # => {"episodes"=>["pilot", false]}
+
+declutter = Declutter.new()
+declutter.delete_falses = true
+declutter.process myhash
+
+puts myhash # => {"episodes"=>["pilot"]}
+```
+
+### keep empty hashes and/or arrays
+
+To keep empty hashes, set `declutter.delete_empty_hashes` to false:
+
+```ruby
+myhash = { 'episodes'=>[], 'notes'=>{} }
+puts myhash # => {"episodes"=>[], "notes"=>{}}
+
+declutter = Declutter.new()
+declutter.delete_empty_hashes = false
+declutter.process myhash
+
+puts myhash # => {"notes"=>{}}
+```
+
+To keep empty arrays, set `declutter.delete_empty_arrays` to false:
+
+```ruby
+myhash = { 'episodes'=>[], 'notes'=>{} }
+puts myhash # => {"episodes"=>[], "notes"=>{}}
+
+declutter = Declutter.new()
+declutter.delete_empty_arrays = false
+declutter.process myhash
+
+puts myhash # => {"episodes"=>[]}
+```
+
+## History
+
+| date         | version | notes           |
+|--------------|---------|-----------------|
+| May 23, 2023 | 1.0     | Initial upload. |

data/lib/declutter.rb

@@ -0,0 +1,132 @@
+#===============================================================================
+# 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
+	#---------------------------------------------------------------------------
+end
+#
+# Declutter
+#===============================================================================

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: declutter
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Mike O'Sullivan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-23 00:00:00.000000000 Z
+dependencies: []
+description: Declutter your Ruby objects by removing empty hashes and arrays
+email: mike@idocs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/declutter.rb
+homepage: https://github.com/mikosullivan/declutter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Declutter
+test_files: []